Skip to content

Commit e1431f2

Browse files
committed
address review suggestions
1 parent d62e139 commit e1431f2

File tree

3 files changed

+17
-8
lines changed

3 files changed

+17
-8
lines changed

packages/activity/src/index.ts

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,11 @@ import {
7777
LogMetadata,
7878
MetricMeter,
7979
Priority,
80-
ActivityCancellationDetailsHolder,
8180
ActivityCancellationDetails,
8281
} from '@temporalio/common';
8382
import { msToNumber } from '@temporalio/common/lib/time';
8483
import { SymbolBasedInstanceOfError } from '@temporalio/common/lib/type-helpers';
84+
import { ActivityCancellationDetailsHolder } from '@temporalio/common/lib/activity-cancellation-details';
8585

8686
export {
8787
ActivityFunction,
@@ -364,7 +364,13 @@ export class Context {
364364
return Promise.race([this.cancelled.finally(() => clearTimeout(handle)), timer]);
365365
};
366366

367-
public cancellationDetails(): ActivityCancellationDetails | undefined {
367+
/**
368+
* Return the cancellation details for this activity, if any.
369+
* @returns an object with boolean properties that describes the reason for cancellation, or undefined if not cancelled.
370+
*
371+
* @experimental Activity cancellation details include usage of experimental features such as activity pause, and may be subject to change.
372+
*/
373+
public get cancellationDetails(): ActivityCancellationDetails | undefined {
368374
return this._cancellationDetails.details;
369375
}
370376
}
@@ -448,10 +454,13 @@ export function cancelled(): Promise<never> {
448454
}
449455

450456
/**
451-
* Returns the cancellation details for this activity, if any.
457+
* Return the cancellation details for this activity, if any.
458+
* @returns an object with boolean properties that describes the reason for cancellation, or undefined if not cancelled.
459+
*
460+
* @experimental Activity cancellation details include usage of experimental features such as activity pause, and may be subject to change.
452461
*/
453462
export function cancellationDetails(): ActivityCancellationDetails | undefined {
454-
return Context.current().cancellationDetails();
463+
return Context.current().cancellationDetails;
455464
}
456465

457466
/**

packages/common/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import * as encoding from './encoding';
88
import * as helpers from './type-helpers';
99

1010
export * from './activity-options';
11-
export * from './activity-cancellation-details';
11+
export { ActivityCancellationDetailsOptions, ActivityCancellationDetails } from './activity-cancellation-details';
1212
export * from './converter/data-converter';
1313
export * from './converter/failure-converter';
1414
export * from './converter/payload-codec';

packages/worker/src/activity.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ import 'abort-controller/polyfill'; // eslint-disable-line import/no-unassigned-
22
import { asyncLocalStorage, CompleteAsyncError, Context, Info } from '@temporalio/activity';
33
import {
44
ActivityCancellationDetails,
5-
ActivityCancellationDetailsHolder,
65
ActivityFunction,
76
ApplicationFailure,
87
ApplicationFailureCategory,
@@ -21,6 +20,7 @@ import { isAbortError } from '@temporalio/common/lib/type-helpers';
2120
import { Logger, LoggerWithComposedMetadata } from '@temporalio/common/lib/logger';
2221
import { MetricMeterWithComposedTags } from '@temporalio/common/lib/metrics';
2322
import { coresdk } from '@temporalio/proto';
23+
import { ActivityCancellationDetailsHolder } from '@temporalio/common/lib/activity-cancellation-details';
2424
import {
2525
ActivityExecuteInput,
2626
ActivityInboundCallsInterceptor,
@@ -144,7 +144,7 @@ export class Activity {
144144
(error instanceof CancelledFailure || isAbortError(error)) &&
145145
this.context.cancellationSignal.aborted
146146
) {
147-
if (this.context.cancellationDetails()?.paused) {
147+
if (this.context.cancellationDetails?.paused) {
148148
this.workerLogger.debug('Activity paused', { durationMs });
149149
} else {
150150
this.workerLogger.debug('Activity completed as cancelled', { durationMs });
@@ -187,7 +187,7 @@ export class Activity {
187187
// Either a CancelledFailure that we threw or AbortError from AbortController
188188
if (err instanceof CancelledFailure) {
189189
// If cancel due to activity pause, emit an application failure for the pause.
190-
if (this.context.cancellationDetails()?.paused) {
190+
if (this.context.cancellationDetails?.paused) {
191191
return {
192192
failed: {
193193
failure: await encodeErrorToFailure(

0 commit comments

Comments
 (0)