Skip to content

[BREAKING CHANGE] Change RawValue API - create RawValue directly from Payload #1805

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[BREAKING CHANGE] Change RawValue API - create RawValue directly from Payload #1805

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions packages/common/src/converter/payload-converter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,12 @@ export class RawValue<T = unknown> {
private readonly _payload: Payload;
private readonly [rawPayloadTypeBrand]: T = undefined as T;

constructor(value: T, payloadConverter: PayloadConverter = defaultPayloadConverter) {
this._payload = payloadConverter.toPayload(value);
private constructor(payload: Payload) {
this._payload = payload;
}

static fromValue<T>(value: T, converter: PayloadConverter = defaultPayloadConverter): RawValue<T> {
return new RawValue<T>(converter.toPayload(value));
}

get payload(): Payload {
Expand Down
6 changes: 3 additions & 3 deletions packages/test/src/test-integration-workflows.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1320,22 +1320,22 @@ test.serial('can register search attributes to dev server', async (t) => {

export async function rawValueWorkflow(value: unknown): Promise<RawValue> {
const { rawValueActivity } = workflow.proxyActivities({ startToCloseTimeout: '10s' });
return await rawValueActivity(new RawValue(value));
return await rawValueActivity(RawValue.fromValue(value));
}

test('workflow and activity can receive/return RawValue', async (t) => {
const { executeWorkflow, createWorker } = helpers(t);
const worker = await createWorker({
activities: {
async rawValueActivity(value: unknown): Promise<RawValue> {
return new RawValue(value);
return RawValue.fromValue(value);
},
},
});

await worker.runUntil(async () => {
const testValue = 'test';
const rawValue = new RawValue(testValue);
const rawValue = RawValue.fromValue(testValue);
const res = await executeWorkflow(rawValueWorkflow, {
args: [rawValue],
});
Expand Down
6 changes: 3 additions & 3 deletions packages/workflow/src/internals.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
} from '@temporalio/common/lib/converter/payload-search-attributes';
import { composeInterceptors } from '@temporalio/common/lib/interceptors';
import { makeProtoEnumConverters } from '@temporalio/common/lib/internal-workflow';
import type { coresdk, temporal } from '@temporalio/proto';

Check warning on line 34 in packages/workflow/src/internals.ts

View workflow job for this annotation

GitHub Actions / Lint and Prune / Lint and Prune 

'temporal' is defined but never used. Allowed unused vars must match /^_/u
import {
TEMPORAL_RESERVED_PREFIX,
STACK_TRACE_QUERY_NAME,
Expand Down Expand Up @@ -60,7 +60,7 @@
ActivationCompletion,
DefaultUpdateHandler,
DefaultQueryHandler,
EnhancedStackTrace,

Check warning on line 63 in packages/workflow/src/internals.ts

View workflow job for this annotation

GitHub Actions / Lint and Prune / Lint and Prune 

'EnhancedStackTrace' is defined but never used. Allowed unused vars must match /^_/u
} from './interfaces';
import { type SinkCall } from './sinks';
import { untrackPromise } from './stack-helpers';
Expand Down Expand Up @@ -280,7 +280,7 @@
STACK_TRACE_QUERY_NAME,
{
handler: () => {
return new RawValue<string>(
return RawValue.fromValue(
this.getStackTraces()
.map((s) => s.formatted)
.join('\n\n')
Expand Down Expand Up @@ -312,7 +312,7 @@
}
}
}
return new RawValue<EnhancedStackTrace>({ sdk, stacks, sources });
return RawValue.fromValue({ sdk, stacks, sources });
},
description: 'Returns a stack trace annotated with source information.',
},
Expand All @@ -334,7 +334,7 @@
name,
description: value.description,
}));
return new RawValue<temporal.api.sdk.v1.IWorkflowMetadata>({
return RawValue.fromValue({
definition: {
type: workflowType,
queryDefinitions,
Expand Down
Loading