Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions packages/common/src/__tests__/test-failure.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import test from 'ava';
import { defaultFailureConverter } from '../converter/data-converter';
import { defaultPayloadConverter } from '../converter/payload-converter';
import { ensureApplicationFailure } from '../failure';

test('preserves Error.cause when converting an application failure', (t) => {
const cause = new Error('connection terminated');
const error = new Error('query failed', { cause });

const applicationFailure = ensureApplicationFailure(error);
const failure = defaultFailureConverter.errorToFailure(applicationFailure, defaultPayloadConverter);

t.is(applicationFailure.cause, cause);
t.is(failure.cause?.message, cause.message);
});
4 changes: 3 additions & 1 deletion packages/common/src/failure.ts
Original file line number Diff line number Diff line change
Expand Up @@ -427,6 +427,7 @@ export class WorkflowExecutionAlreadyStartedError extends TemporalFailure {
* - `message`: `error.message` or `String(error)`
* - `type`: `error.constructor.name` or `error.name`
* - `stack`: `error.stack` or `''`
* - `cause`: `error.cause` when it is an `Error`
*/
export function ensureApplicationFailure(error: unknown): ApplicationFailure {
if (error instanceof ApplicationFailure) {
Expand All @@ -435,7 +436,8 @@ export function ensureApplicationFailure(error: unknown): ApplicationFailure {

const message = (isRecord(error) && String(error.message)) || String(error);
const type = (isRecord(error) && (error.constructor?.name ?? error.name)) || undefined;
const failure = ApplicationFailure.create({ message, type, nonRetryable: false });
const cause = isRecord(error) && error.cause instanceof Error ? error.cause : undefined;
Comment thread
mohan-garimella marked this conversation as resolved.
const failure = ApplicationFailure.create({ message, type, nonRetryable: false, cause });
Comment on lines +439 to +440

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Guard serialization against cyclic error causes

When an Activity throws an Error whose cause graph is cyclic (for example, error.cause = error, which is permitted because cause is mutable), retaining that cause makes DefaultFailureConverter.errorToFailureInner recurse indefinitely through optionalErrorToOptionalFailure. Instead of returning an Activity failure, the worker hits a RangeError while encoding it; detect cycles before attaching or serializing the cause.

Useful? React with 👍 / 👎.

failure.stack = (isRecord(error) && String(error.stack)) || '';
return failure;
}
Expand Down