Phase 13 · Lesson 08

Safe Production Error Exposure

≈ 2 min core reading · 276 source/companion words
Learning contract

What you should be able to do after this

  • Explain Safe Production Error Exposure without relying on framework buzzwords.
  • Connect the lesson to the phase outcome: Create a stable application error model that separates expected domain/transport failures from unexpected faults and keeps diagnostics observable.
  • Reproduce the relevant behavior and verify it with evidence.
  • Diagnose at least one representative failure instead of guessing.
Figure 13.8 — TaskFlow boundary map
failure occurs
typed/application error
exception mapping
structured log
safe HTTP error
frontend recovery
This lesson belongs to Phase 13. Keep the full request/data path visible even when today's code changes only one box.
Instructor workflow: predict first → implement the smallest slice → run it → inspect evidence → break one assumption → diagnose → explain it back. Do not copy the whole code block before understanding the first failing boundary.

Safe Production Error Exposure Sanitized client responses, protected diagnostics, logging hygiene, and privacy-aware failure handling

Phase 13 - Professional Error Handling Volume 04 - Professional Backend

Architecture milestone client-safe response

↓

requestId

↓

private structured diagnostic log

Phase 13 creates one professional exception boundary and a correlation story that spans client response and server logs.

Production errors should be boring to clients and rich to engineers The client needs a safe message, stable code, and requestId. Engineers need internal context such as exception name, stack, method, path, status, and timing. These are different audiences.

Information Public response Protected server log

status / code Yes Yes

human-safe message Yes Yes

requestId Yes Yes

stack trace No Yes for unexpected faults

raw SQL No Usually no; only under controlled diagnostics

DATABASE_URL / credentials Never Never

request password/token Never Never

Prisma raw error text Usually no May be logged carefully if sanitized

Structured logging example this.logger.error("Unhandled request failure", { requestId, method: request.method, path, statusCode: 500, exceptionName: exception.name, stack: exception.stack, });

Do not log request bodies by default Bodies can contain passwords, tokens, personal data, payroll values, applicant information, employee records, or uploaded document metadata in future TaskFlow-derived systems. Logging everything because it is convenient is not professional observability.

Security and privacy rule

Error handling is also data-handling design. Decide what logs are allowed to contain before production, who can read them, and how long they are retained.

Unknown 500 workflow Figure 1 - Safe 500 lifecycle Unexpected exception occurs

↓

Filter creates INTERNAL_ERROR response

↓

Client receives requestId

↓

Server logs requestId + private diagnostic context

↓

Engineer correlates without exposing internals

A secure system does not need to choose between debuggability and safe client responses.

Executable lesson studio · deployment

Now turn the explanation into engineering skill.

Deployment is the controlled movement of a versioned artifact into a configured runtime with evidence of health and a credible rollback path.

By the end, you should be able to

  • Explain Safe Production Error Exposure in terms of concrete inputs, ownership, outputs, and evidence.
  • Implement or reproduce the smallest TaskFlow slice that demonstrates this deployment concept.
  • Diagnose one representative deployment failure using observable evidence instead of trial-and-error.
Figure 13.8B — Mental model
versioned artifact
production config
runtime
health/smoke test
rollback path
Read left-to-right while implementing. When debugging, walk right-to-left until the first observed fact differs from your prediction.
Code-along sequence

One coherent change at a time

  1. 01

    Restate the goal of “Safe Production Error Exposure” as one observable behavior. Write the success signal before touching code.

  2. 02

    Trace the boundary map: versioned artifact → production config → runtime → health/smoke test → rollback path. Mark the one boundary this lesson changes.

  3. 03

    Inspect the current repository state and record the exact files, route, table, or runtime involved. Avoid creating an abstraction before you can name the existing owner.

  4. 04

    Implement the smallest vertical slice. Add one coherent change, run the narrowest verification command, and read the output before continuing.

  5. 05

    Connect the slice to TaskFlow’s phase artifact: Error taxonomy + NestJS mapping layer/filters + structured error response with request IDs.. Verify behavior from the outside as a user or API client would.

  6. 06

    Create one controlled failure that is safe to reproduce. Predict the symptom first, capture evidence, locate the earliest broken boundary, then fix only that cause.

  7. 07

    Close the reference and rebuild or explain the core change from memory. Record what you would monitor or test before trusting the same change in production.

txtRelease runbook, not a vague deploy button
1. Build an immutable artifact.
2. Apply production configuration/secrets.
3. Run compatible migrations.
4. Start the new version.
5. Check readiness and smoke tests.
6. Observe errors/latency.
7. Promote or execute rollback.

Do not copy this as a finished answer. Predict what each boundary does, type the smallest useful slice, run it, then compare the result with your prediction.

Verification

Prove the happy path

  1. Run the narrowest relevant command or request and require a clean exit/status.
  2. Inspect the boundary-specific evidence: terminal output, Network panel, database row/query plan, test report, container health, or deployment logs.
  3. Repeat the behavior once after the change so a one-off cached or stale result cannot masquerade as success.
Break it on purpose

Build debugging memory

  1. Logging secrets/tokens with error context
  2. Change one assumption in the deployment example—identity, input, configuration, ordering, connectivity, or state—and predict the exact symptom before running it.
SymptomInvestigation path
Deployment is green but app fails

Separate platform deploy status from application readiness; run smoke tests against real routes and dependencies.

New release breaks schema compatibility

Use expand/contract migrations and keep rollback compatibility explicit before release.

Closed-reference challenge

Can you transfer the idea?

Without copying the final source, create a second small scenario that applies “Safe Production Error Exposure” to a different TaskFlow resource or input. Write the acceptance criteria first, implement it, and provide the evidence that each criterion is satisfied.

Explain-back

Answer these without reopening the solution

  1. What problem does Safe Production Error Exposure solve in TaskFlow, and what would be observably wrong without it?
  2. Which part of the deployment boundary owns the decision, and which neighboring layer must not own it?
  3. What evidence proves the happy path instead of merely suggesting it worked?
  4. Name one realistic failure or abuse case and the first place you would inspect.
  5. If requirements doubled tomorrow, which part of this design should stay stable and which part is allowed to change?
Lesson studio

Turn the reading into skill

01

Do it

Create explicit application errors for expected business outcomes rather than throwing arbitrary strings.

Use the smallest change that demonstrates this lesson. Stop after it works and capture evidence.
02

Break it safely

Logging secrets/tokens with error context

Predict the symptom before causing the failure. Then locate the earliest boundary where reality diverges from expectation.
03

Explain it back

Why does this responsibility live here, what input does it trust, what output proves success, and what would go wrong if another layer owned it?

If your explanation is vague, repeat the boundary trace before moving on.
Exit ticket

Before marking complete

Close the reference. Reproduce the core idea from memory or explain the exact request/data flow aloud. Then check your diff or notes for accidental shortcuts that bypass validation, authorization, error handling, or verification earned in earlier phases.