temporalio / temporalio/temporal
Clarify scope of "redact certain errors" TODOs in history Nexus handler
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 23.2k
- Forks
- 1.9k
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 228
Description
Summary
service/history/handler.go has two TODO comments (lines 2523
and 2588) noting that certain errors should be redacted before
being returned:
// TODO: redact certain errors
return nil, err
This occurs in StartNexusOperation and CancelNexusOperation,
in the fallback path when err is not a *nexus.OperationError.
Investigation
service/history/handler.go implements historyservice.HistoryServiceServer,
which is the internal gRPC service between frontend and history —
not the externally-facing Nexus endpoint.
I checked service/frontend/nexus_handler.go, which appears to
already redact unexpected errors before returning to external
Nexus callers:
oc.logger.Error("error converting Nexus failure to Nexus HandlerError",
tag.Error(err), ...)
return nil, nexus.NewHandlerErrorf(nexus.HandlerErrorTypeInternal, "internal error")
Question for the team
Given that frontend already redacts errors before they reach
external callers, is the history-layer TODO about:
- Defense-in-depth — redacting at the history layer too,
in case frontend's redaction is bypassed or incomplete, or - A specific code path where history's response could reach
external callers directly without going through frontend's
redaction logic?
If (1), the fix would follow the same pattern as frontend —
catching unexpected errors and returning
nexus.NewHandlerErrorf(nexus.HandlerErrorTypeInternal, "internal error")
while logging the original error server-side.
If (2), I'd need guidance on which code path that is to ensure
the fix covers the actual gap.
Happy to implement once the intended scope is clarified.
References
service/history/handler.go:2523(StartNexusOperation)service/history/handler.go:2588(CancelNexusOperation)service/frontend/nexus_handler.go:467-472(existing redaction pattern)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the TODOs in service/history/handler.go at lines 2523 and 2588, then compare the existing handling in service/frontend/nexus_handler.go at lines 467-472. Trace whether history responses can reach external Nexus callers without frontend redaction. Done means the team has confirmed the intended scope and identified the specific path and behavior to implement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, grpc
- Domain
- api, backend, distributed-systems
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 42/100