fix: Preserve original gRPC error cause in rewindInstance and restartOrchestration#200
Open
YunchuWang wants to merge 1 commit intomainfrom
Open
fix: Preserve original gRPC error cause in rewindInstance and restartOrchestration#200YunchuWang wants to merge 1 commit intomainfrom
YunchuWang wants to merge 1 commit intomainfrom
Conversation
…tion
The rewindInstance and restartOrchestration methods in TaskHubGrpcClient
catch gRPC errors and rethrow new Error objects with user-friendly
messages, but discard the original error. This loses valuable debugging
information (gRPC metadata, status details, and stack traces).
Changes:
- Add { cause: e } to all rethrown errors in rewindInstance, preserving
the original gRPC ServiceError for debugging
- Add { cause: e } to all rethrown errors in restartOrchestration
- Standardize gRPC error detection in rewindInstance to use
'instanceof Error' (consistent with restartOrchestration) instead of
duck-typing with 'typeof e === "object"'
- Add comprehensive unit tests verifying error cause preservation for
all handled gRPC status codes (NOT_FOUND, FAILED_PRECONDITION,
UNIMPLEMENTED, CANCELLED) and passthrough of unrecognized errors
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes loss of diagnostic information in the DurableTask JS SDK client by preserving the original gRPC ServiceError as the cause when TaskHubGrpcClient.rewindInstance() and TaskHubGrpcClient.restartOrchestration() wrap errors, aligning with existing error-wrapping patterns in the repo.
Changes:
- Preserve original caught gRPC errors via
new Error(message, { cause: e })inrewindInstanceandrestartOrchestration. - Standardize
rewindInstancegRPC error detection to usee instanceof Error && "code" in e. - Add Jest coverage to validate
causepreservation and wrapping behavior for key gRPC status codes.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| packages/durabletask-js/src/client/client.ts | Preserves original gRPC error as cause when rethrowing user-friendly errors in rewind/restart operations. |
| packages/durabletask-js/test/client-error-cause.spec.ts | Adds tests ensuring wrapped errors preserve cause and unrecognized gRPC errors are rethrown unchanged. |
| package-lock.json | Lockfile metadata update (removal of several "peer": true entries). |
| } | ||
| if (grpcError.code === grpc.status.CANCELLED) { | ||
| throw new Error(`The rewind operation for '${instanceId}' was cancelled.`); | ||
| throw new Error(`The rewind operation for '${instanceId}' was cancelled.`, { cause: e }); |
There was a problem hiding this comment.
In this file, cancellation is spelled both as "canceled" (e.g., restartOrchestration/getOrchestrationHistory) and "cancelled" (rewindInstance). Since these are user-facing error messages, please standardize on a single spelling for consistency (and update the corresponding test expectation).
Suggested change
| throw new Error(`The rewind operation for '${instanceId}' was cancelled.`, { cause: e }); | |
| throw new Error(`The rewind operation for '${instanceId}' was canceled.`, { cause: e }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #185
Problem
rewindInstance and restartOrchestration in TaskHubGrpcClient catch gRPC errors and rethrow new Error objects with user-friendly messages, but discard the original error. Users cannot access the original gRPC ServiceError details (metadata, status details, stack trace).
Changes