Review comments

Author: Sushisource

packages/common/src/workflow-definition-options.ts

@@ -11,6 +11,8 @@ type AsyncFunction<Args extends any[], ReturnType> = (...args: Args) => Promise<
 export type WorkflowDefinitionOptionsOrGetter = WorkflowDefinitionOptions | (() => WorkflowDefinitionOptions);
 
 /**
+ * @internal
+ * @hidden
  * A workflow function that has been defined with options from {@link WorkflowDefinitionOptions}.
  */
 export interface WorkflowFunctionWithOptions<Args extends any[], ReturnType> extends AsyncFunction<Args, ReturnType> {

packages/common/src/workflow-options.ts

@@ -256,9 +256,3 @@ export function extractWorkflowType<T extends Workflow>(
     `Invalid workflow type: expected either a string or a function, got '${typeof workflowTypeOrFunc}'`
   );
 }
-
-/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
-export function isWorkflowFunctionWithOptions(obj: any): obj is WorkflowFunctionWithOptions<any[], any> {
-  if (obj == null) return false;
-  return Object.hasOwn(obj, 'workflowDefinitionOptions');
-}

packages/test/src/test-worker-deployment-versioning.ts

@@ -46,7 +46,7 @@ test('Worker deployment based versioning', async (t) => {
   });
   const worker1Promise = worker1.run();
   worker1Promise.catch((err) => {
-    t.fail('Worker 1.0 run error: ' + JSON.stringify(err));
+    t.fail('Worker 1.0 run error: ' + err);
   });
 
   const worker2 = await Worker.create({
@@ -61,7 +61,7 @@ test('Worker deployment based versioning', async (t) => {
   });
   const worker2Promise = worker2.run();
   worker2Promise.catch((err) => {
-    t.fail('Worker 2.0 run error: ' + JSON.stringify(err));
+    t.fail('Worker 2.0 run error: ' + err);
   });
 
   const worker3 = await Worker.create({
@@ -76,7 +76,7 @@ test('Worker deployment based versioning', async (t) => {
   });
   const worker3Promise = worker3.run();
   worker3Promise.catch((err) => {
-    t.fail('Worker 3.0 run error: ' + JSON.stringify(err));
+    t.fail('Worker 3.0 run error: ' + err);
   });
 
   // Wait for worker 1 to be visible and set as current version
@@ -163,7 +163,7 @@ test('Worker deployment based versioning with ramping', async (t) => {
   });
   const worker1Promise = worker1.run();
   worker1Promise.catch((err) => {
-    t.fail('Worker 1.0 run error: ' + JSON.stringify(err));
+    t.fail('Worker 1.0 run error: ' + err);
   });
 
   const worker2 = await Worker.create({
@@ -178,7 +178,7 @@ test('Worker deployment based versioning with ramping', async (t) => {
   });
   const worker2Promise = worker2.run();
   worker2Promise.catch((err) => {
-    t.fail('Worker 2.0 run error: ' + JSON.stringify(err));
+    t.fail('Worker 2.0 run error: ' + err);
   });
 
   // Wait for worker deployments to be visible
@@ -275,7 +275,7 @@ async function testWorkerDeploymentWithDynamicBehavior(
 
   const workerPromise = worker.run();
   workerPromise.catch((err) => {
-    t.fail('Worker run error: ' + JSON.stringify(err));
+    t.fail('Worker run error: ' + err);
   });
 
   const describeResp = await waitUntilWorkerDeploymentVisible(client, version);
@@ -334,7 +334,7 @@ test('Workflows can use default versioning behavior', async (t) => {
 
   const workerPromise = worker.run();
   workerPromise.catch((err) => {
-    t.fail('Worker run error: ' + JSON.stringify(err));
+    t.fail('Worker run error: ' + err);
   });
 
   const describeResp = await waitUntilWorkerDeploymentVisible(client, workerV1);

packages/test/src/test-worker-tuner.ts

@@ -207,7 +207,7 @@ class MySS<SI extends SlotInfo> implements CustomSlotSupplier<SI> {
     this.seenSlotTypes.add(ctx.slotType);
     this.t.truthy(ctx.taskQueue);
     this.t.truthy(ctx.workerIdentity);
-    this.t.truthy(ctx.workerBuildId);
+    this.t.truthy(ctx.workerBuildId); // eslint-disable-line deprecation/deprecation
     this.t.not(ctx.isSticky, undefined);
     this.seenStickyFlags.add(ctx.isSticky);
     this.reserved++;

packages/testing/src/testing-workflow-environment.ts

@@ -1,5 +1,5 @@
 import 'abort-controller/polyfill'; // eslint-disable-line import/no-unassigned-import
-import { AsyncCompletionClient, Client, WorkflowClient, ClientOptions } from '@temporalio/client';
+import { AsyncCompletionClient, Client, WorkflowClient } from '@temporalio/client';
 import { Duration, TypedSearchAttributes } from '@temporalio/common';
 import { msToNumber, msToTs, tsToMs } from '@temporalio/common/lib/time';
 import { NativeConnection, Runtime } from '@temporalio/worker';
@@ -31,7 +31,9 @@ export type TimeSkippingTestWorkflowEnvironmentOptions = {
 export type ExistingServerTestWorkflowEnvironmentOptions = {
   /** If not set, defaults to localhost:7233 */
   address?: string;
-  client?: ClientOptions;
+  /** If not set, defaults to default */
+  namespace?: string;
+  client?: ClientOptionsForTestEnv;
 };
 
 /**
@@ -177,7 +179,7 @@ export class TestWorkflowEnvironment {
     return await this.create({
       server: { type: 'existing' },
       client: opts?.client,
-      namespace: opts?.client?.namespace ?? 'default',
+      namespace: opts?.namespace ?? 'default',
       supportsTimeSkipping: false,
       address: opts?.address,
     });

packages/worker/src/worker-tuner.ts

@@ -233,11 +233,15 @@ export interface SlotReserveContext {
 
   /**
    * The build id of the worker that is requesting the reservation
+   *
+   * @deprecated Use {@link workerDeploymentVersion} instead.
    */
   workerBuildId: string;
 
   /**
    * The deployment version of the worker that is requesting the reservation
+   *
+   * @experimental Worker deployments are an experimental feature and may be subject to change.
    */
   workerDeploymentVersion?: WorkerDeploymentVersion;
 

packages/workflow/src/worker-interface.ts

@@ -3,7 +3,7 @@
  *
  * @module
  */
-import { encodeVersioningBehavior, IllegalStateError, isWorkflowFunctionWithOptions } from '@temporalio/common';
+import { encodeVersioningBehavior, IllegalStateError, WorkflowFunctionWithOptions } from '@temporalio/common';
 import { composeInterceptors } from '@temporalio/common/lib/interceptors';
 import { coresdk } from '@temporalio/proto';
 import { disableStorage } from './cancellation-scope';
@@ -276,3 +276,8 @@ export function dispose(): void {
     activator.rethrowSynchronously = false;
   }
 }
+
+function isWorkflowFunctionWithOptions(obj: any): obj is WorkflowFunctionWithOptions<any[], any> {
+  if (obj == null) return false;
+  return Object.hasOwn(obj, 'workflowDefinitionOptions');
+}