@temporalio/testing 0.23.1 → 1.0.0-rc.0

package/README.md

@@ -0,0 +1,9 @@
+# `@temporalio/testing`
+
+[![NPM](https://img.shields.io/npm/v/@temporalio/testing?style=for-the-badge)](https://www.npmjs.com/package/@temporalio/testing)
+
+Part of [Temporal](https://temporal.io)'s [TypeScript SDK](https://docs.temporal.io/typescript/introduction/).
+
+- [Testing docs](https://docs.temporal.io/typescript/testing)
+- [API reference](https://typescript.temporal.io/api/namespaces/testing)
+- [Sample projects](https://github.com/temporalio/samples-typescript)

package/lib/assert-to-failure-interceptor.d.ts

@@ -0,0 +1,7 @@
+import { WorkflowInterceptors } from '@temporalio/workflow';
+/**
+ * Simple interceptor that transforms {@link assert.AssertionError} into non retryable failures.
+ *
+ * This allows conveniently using `assert` directly from Workflows.
+ */
+export declare function interceptors(): WorkflowInterceptors;

package/lib/assert-to-failure-interceptor.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.interceptors = void 0;
+const assert_1 = __importDefault(require("assert"));
+const workflow_1 = require("@temporalio/workflow");
+/**
+ * Simple interceptor that transforms {@link assert.AssertionError} into non retryable failures.
+ *
+ * This allows conveniently using `assert` directly from Workflows.
+ */
+function interceptors() {
+    return {
+        inbound: [
+            {
+                async handleSignal(input, next) {
+                    try {
+                        return await next(input);
+                    }
+                    catch (err) {
+                        if (err instanceof assert_1.default.AssertionError) {
+                            const appErr = workflow_1.ApplicationFailure.nonRetryable(err.message);
+                            appErr.stack = err.stack;
+                            throw appErr;
+                        }
+                    }
+                },
+                async execute(input, next) {
+                    try {
+                        return await next(input);
+                    }
+                    catch (err) {
+                        if (err instanceof assert_1.default.AssertionError) {
+                            const appErr = workflow_1.ApplicationFailure.nonRetryable(err.message);
+                            appErr.stack = err.stack;
+                            throw appErr;
+                        }
+                    }
+                },
+            },
+        ],
+    };
+}
+exports.interceptors = interceptors;
+//# sourceMappingURL=assert-to-failure-interceptor.js.map

package/lib/assert-to-failure-interceptor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert-to-failure-interceptor.js","sourceRoot":"","sources":["../src/assert-to-failure-interceptor.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAC5B,mDAAgF;AAEhF;;;;GAIG;AACH,SAAgB,YAAY;IAC1B,OAAO;QACL,OAAO,EAAE;YACP;gBACE,KAAK,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI;oBAC5B,IAAI;wBACF,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC;qBAC1B;oBAAC,OAAO,GAAG,EAAE;wBACZ,IAAI,GAAG,YAAY,gBAAM,CAAC,cAAc,EAAE;4BACxC,MAAM,MAAM,GAAG,6BAAkB,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;4BAC5D,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;4BACzB,MAAM,MAAM,CAAC;yBACd;qBACF;gBACH,CAAC;gBACD,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI;oBACvB,IAAI;wBACF,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC;qBAC1B;oBAAC,OAAO,GAAG,EAAE;wBACZ,IAAI,GAAG,YAAY,gBAAM,CAAC,cAAc,EAAE;4BACxC,MAAM,MAAM,GAAG,6BAAkB,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;4BAC5D,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;4BACzB,MAAM,MAAM,CAAC;yBACd;qBACF;gBACH,CAAC;aACF;SACF;KACF,CAAC;AACJ,CAAC;AA7BD,oCA6BC"}

package/lib/child-process.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="node" />
+import { ChildProcess } from 'child_process';
+export declare class ChildProcessError extends Error {
+    readonly code: number | null;
+    readonly signal: NodeJS.Signals | null;
+    readonly name = "ChildProcessError";
+    constructor(message: string, code: number | null, signal: NodeJS.Signals | null);
+}
+export interface WaitOptions {
+    validReturnCodes: number[];
+}
+export declare function waitOnChild(child: ChildProcess, opts?: WaitOptions): Promise<void>;
+export declare function kill(child: ChildProcess, signal?: NodeJS.Signals, opts?: WaitOptions): Promise<void>;
+export declare function killIfExists(child: ChildProcess, signal?: NodeJS.Signals, opts?: WaitOptions): Promise<void>;
+export declare const shell: boolean;

package/lib/child-process.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shell = exports.killIfExists = exports.kill = exports.waitOnChild = exports.ChildProcessError = void 0;
+class ChildProcessError extends Error {
+    constructor(message, code, signal) {
+        super(message);
+        this.code = code;
+        this.signal = signal;
+        this.name = 'ChildProcessError';
+    }
+}
+exports.ChildProcessError = ChildProcessError;
+async function waitOnChild(child, opts) {
+    return new Promise((resolve, reject) => {
+        child.on('exit', (code, signal) => {
+            if (code !== null && (opts?.validReturnCodes ?? [0]).includes(code)) {
+                resolve();
+            }
+            else {
+                reject(new ChildProcessError('Process failed', code, signal));
+            }
+        });
+        child.on('error', reject);
+    });
+}
+exports.waitOnChild = waitOnChild;
+async function kill(child, signal = 'SIGINT', opts) {
+    if (child.pid === undefined) {
+        throw new TypeError('Expected child with pid');
+    }
+    process.kill(child.pid, signal);
+    try {
+        await waitOnChild(child, opts);
+    }
+    catch (err) {
+        // Should error if the error is not a child process error or it is a child
+        // process and either the platform is Windows or the signal matches.
+        const shouldError = !(err instanceof ChildProcessError) || (process.platform !== 'win32' && err.signal !== signal);
+        if (shouldError) {
+            throw err;
+        }
+    }
+}
+exports.kill = kill;
+async function killIfExists(child, signal = 'SIGINT', opts) {
+    try {
+        await kill(child, signal, opts);
+    }
+    catch (err) {
+        if (err.code !== 'ESRCH') {
+            throw err;
+        }
+    }
+}
+exports.killIfExists = killIfExists;
+exports.shell = process.platform === 'win32';
+//# sourceMappingURL=child-process.js.map

package/lib/child-process.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"child-process.js","sourceRoot":"","sources":["../src/child-process.ts"],"names":[],"mappings":";;;AAGA,MAAa,iBAAkB,SAAQ,KAAK;IAG1C,YAAY,OAAe,EAAkB,IAAmB,EAAkB,MAA6B;QAC7G,KAAK,CAAC,OAAO,CAAC,CAAC;QAD4B,SAAI,GAAJ,IAAI,CAAe;QAAkB,WAAM,GAAN,MAAM,CAAuB;QAF/F,SAAI,GAAG,mBAAmB,CAAC;IAI3C,CAAC;CACF;AAND,8CAMC;AAMM,KAAK,UAAU,WAAW,CAAC,KAAmB,EAAE,IAAkB;IACvE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;YAChC,IAAI,IAAI,KAAK,IAAI,IAAI,CAAC,IAAI,EAAE,gBAAgB,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBACnE,OAAO,EAAE,CAAC;aACX;iBAAM;gBACL,MAAM,CAAC,IAAI,iBAAiB,CAAC,gBAAgB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;aAC/D;QACH,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;AACL,CAAC;AAXD,kCAWC;AAEM,KAAK,UAAU,IAAI,CAAC,KAAmB,EAAE,SAAyB,QAAQ,EAAE,IAAkB;IACnG,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,EAAE;QAC3B,MAAM,IAAI,SAAS,CAAC,yBAAyB,CAAC,CAAC;KAChD;IACD,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAChC,IAAI;QACF,MAAM,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;KAChC;IAAC,OAAO,GAAG,EAAE;QACZ,0EAA0E;QAC1E,oEAAoE;QACpE,MAAM,WAAW,GAAG,CAAC,CAAC,GAAG,YAAY,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,OAAO,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;QACnH,IAAI,WAAW,EAAE;YACf,MAAM,GAAG,CAAC;SACX;KACF;AACH,CAAC;AAfD,oBAeC;AAEM,KAAK,UAAU,YAAY,CAChC,KAAmB,EACnB,SAAyB,QAAQ,EACjC,IAAkB;IAElB,IAAI;QACF,MAAM,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;KACjC;IAAC,OAAO,GAAQ,EAAE;QACjB,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,EAAE;YACxB,MAAM,GAAG,CAAC;SACX;KACF;AACH,CAAC;AAZD,oCAYC;AAEY,QAAA,KAAK,GAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC"}

package/lib/index-for-docs.d.ts

@@ -0,0 +1 @@
+export * as testing from './index';

package/lib/index-for-docs.js

@@ -0,0 +1,29 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testing = void 0;
+// Reexports the contents of this package under the "testing" namespace for better docs generation
+exports.testing = __importStar(require("./index"));
+//# sourceMappingURL=index-for-docs.js.map

package/lib/index-for-docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-for-docs.js","sourceRoot":"","sources":["../src/index-for-docs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kGAAkG;AAClG,mDAAmC"}

package/lib/index.d.ts

@@ -0,0 +1,181 @@
+/// <reference types="node" />
+import * as activity from '@temporalio/activity';
+import { AsyncCompletionClient, WorkflowClient as BaseWorkflowClient, WorkflowClientOptions as BaseWorkflowClientOptions, WorkflowResultOptions as BaseWorkflowResultOptions, WorkflowStartOptions as BaseWorkflowStartOptions } from '@temporalio/client';
+import { ActivityFunction, Workflow, WorkflowResultType } from '@temporalio/common';
+import { NativeConnection, Logger } from '@temporalio/worker';
+import { ChildProcess, StdioOptions } from 'child_process';
+import events from 'events';
+import { Connection, TestService } from './test-service-client';
+export declare const DEFAULT_TEST_SERVER_PATH: string;
+/**
+ * Options passed to {@link WorkflowClient.result}, these are the same as the
+ * {@link BaseWorkflowResultOptions} with an additional option that controls
+ * whether to toggle time skipping in the Test server while waiting on a
+ * Workflow's result.
+ */
+export interface WorkflowResultOptions extends BaseWorkflowResultOptions {
+    /**
+     * If set to `true`, waiting for the result does not enable time skipping
+     */
+    runInNormalTime?: boolean;
+}
+/**
+ * Options passed to {@link WorkflowClient.execute}, these are the same as the
+ * {@link BaseWorkflowStartOptions} with an additional option that controls
+ * whether to toggle time skipping in the Test server while waiting on a
+ * Workflow's result.
+ */
+export declare type WorkflowStartOptions<T extends Workflow> = BaseWorkflowStartOptions<T> & {
+    /**
+     * If set to `true`, waiting for the result does not enable time skipping
+     */
+    runInNormalTime?: boolean;
+};
+export interface WorkflowClientOptions extends BaseWorkflowClientOptions {
+    connection: Connection;
+}
+/**
+ * A client with the exact same API as the "normal" client with 1 exception,
+ * When this client waits on a Workflow's result, it will enable time skipping
+ * in the test server.
+ */
+export declare class WorkflowClient extends BaseWorkflowClient {
+    protected readonly testService: TestService;
+    constructor(options: WorkflowClientOptions);
+    /**
+     * Execute a Workflow and wait for completion.
+     *
+     * @see {@link BaseWorkflowClient.execute}
+     */
+    execute<T extends Workflow>(workflowTypeOrFunc: string | T, options: WorkflowStartOptions<T>): Promise<WorkflowResultType<T>>;
+    /**
+     * Gets the result of a Workflow execution.
+     *
+     * @see {@link BaseWorkflowClient.result}
+     */
+    result<T>(workflowId: string, runId?: string | undefined, opts?: WorkflowResultOptions | undefined): Promise<T>;
+}
+/**
+ * Convenience workflow interceptors
+ *
+ * Contains a single interceptor for transforming `AssertionError`s into non
+ * retryable `ApplicationFailure`s.
+ */
+export declare const workflowInterceptorModules: string[];
+export interface TestServerSpawnerOptions {
+    /**
+     * @default {@link DEFAULT_TEST_SERVER_PATH}
+     */
+    path?: string;
+    /**
+     * @default ignore
+     */
+    stdio?: StdioOptions;
+}
+/**
+ * A generic callback that returns a child process
+ */
+export declare type TestServerSpawner = (port: number) => ChildProcess;
+/**
+ * Options for {@link TestWorkflowEnvironment.create}
+ */
+export interface TestWorkflowEnvironmentOptions {
+    testServer?: TestServerSpawner | TestServerSpawnerOptions;
+    logger?: Logger;
+}
+/**
+ * An execution environment for running Workflow integration tests.
+ *
+ * Runs an external server.
+ * By default, the Java test server is used which supports time skipping.
+ */
+export declare class TestWorkflowEnvironment {
+    protected readonly serverProc: ChildProcess;
+    /**
+     * Get an extablished {@link Connection} to the test server
+     */
+    readonly connection: Connection;
+    /**
+     * An {@link AsyncCompletionClient} for interacting with the test server
+     */
+    readonly asyncCompletionClient: AsyncCompletionClient;
+    /**
+     * A {@link WorkflowClient} for interacting with the test server
+     */
+    readonly workflowClient: WorkflowClient;
+    /**
+     * A {@link NativeConnection} for interacting with the test server.
+     *
+     * Use this connection when creating Workers for testing.
+     */
+    readonly nativeConnection: NativeConnection;
+    protected constructor(serverProc: ChildProcess, connection: Connection, nativeConnection: NativeConnection);
+    /**
+     * Create a new test environment
+     */
+    static create(opts?: TestWorkflowEnvironmentOptions): Promise<TestWorkflowEnvironment>;
+    /**
+     * Kill the test server process and close the connection to it
+     */
+    teardown(): Promise<void>;
+    /**
+     * Wait for `durationMs` in "test server time".
+     *
+     * The test server toggles between skipped time and normal time depending on what it needs to execute.
+     *
+     * This method is likely to resolve in less than `durationMs` of "real time".
+     *
+     * Useful for simulating events far into the future like completion of long running activities.
+     *
+     * @param durationMs {@link https://www.npmjs.com/package/ms | ms} formatted string or number of milliseconds
+     *
+     * @example
+     *
+     * `workflow.ts`
+     *
+     * ```ts
+     * const activities = proxyActivities({ startToCloseTimeout: 2_000_000 });
+     *
+     * export async function raceActivityAndTimer(): Promise<string> {
+     *   return await Promise.race([
+     *     wf.sleep(500_000).then(() => 'timer'),
+     *     activities.longRunning().then(() => 'activity'),
+     *   ]);
+     * }
+     * ```
+     *
+     * `test.ts`
+     *
+     * ```ts
+     * const worker = await Worker.create({
+     *   connection: testEnv.nativeConnection,
+     *   activities: {
+     *     async longRunning() {
+     *       await testEnv.sleep(1_000_000); // <-- sleep called here
+     *     },
+     *   },
+     *   // ...
+     * });
+     * ```
+     */
+    sleep: (durationMs: number | string) => Promise<void>;
+}
+/**
+ * Used as the default activity info for Activities executed in the {@link MockActivityEnvironment}
+ */
+export declare const defaultActivityInfo: activity.Info;
+/**
+ * An execution environment for testing Activities.
+ *
+ * Mocks Activity {@link Context | activity.Context} and exposes hooks for
+ * cancellation and heartbeats.
+ */
+export declare class MockActivityEnvironment extends events.EventEmitter {
+    cancel: (reason?: any) => void;
+    readonly context: activity.Context;
+    constructor(info?: Partial<activity.Info>);
+    /**
+     * Run a function in Activity Context
+     */
+    run<P extends any[], R, F extends ActivityFunction<P, R>>(fn: F, ...args: P): Promise<R>;
+}

package/lib/index.js

@@ -0,0 +1,247 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MockActivityEnvironment = exports.defaultActivityInfo = exports.TestWorkflowEnvironment = exports.workflowInterceptorModules = exports.WorkflowClient = exports.DEFAULT_TEST_SERVER_PATH = void 0;
+const activity = __importStar(require("@temporalio/activity"));
+const client_1 = require("@temporalio/client");
+const common_1 = require("@temporalio/common");
+const worker_1 = require("@temporalio/worker");
+const path_1 = __importDefault(require("path"));
+const os_1 = __importDefault(require("os"));
+const abort_controller_1 = require("abort-controller");
+const child_process_1 = require("child_process");
+const events_1 = __importDefault(require("events"));
+const child_process_2 = require("./child-process");
+const test_service_client_1 = require("./test-service-client");
+const TEST_SERVER_EXECUTABLE_NAME = os_1.default.platform() === 'win32' ? 'test-server.exe' : 'test-server';
+exports.DEFAULT_TEST_SERVER_PATH = path_1.default.join(__dirname, `../${TEST_SERVER_EXECUTABLE_NAME}`);
+/**
+ * A client with the exact same API as the "normal" client with 1 exception,
+ * When this client waits on a Workflow's result, it will enable time skipping
+ * in the test server.
+ */
+class WorkflowClient extends client_1.WorkflowClient {
+    constructor(options) {
+        super(options);
+        this.testService = options.connection.testService;
+    }
+    /**
+     * Execute a Workflow and wait for completion.
+     *
+     * @see {@link BaseWorkflowClient.execute}
+     */
+    async execute(workflowTypeOrFunc, options) {
+        return super.execute(workflowTypeOrFunc, options);
+    }
+    /**
+     * Gets the result of a Workflow execution.
+     *
+     * @see {@link BaseWorkflowClient.result}
+     */
+    async result(workflowId, runId, opts) {
+        if (opts?.runInNormalTime) {
+            return await super.result(workflowId, runId, opts);
+        }
+        await this.testService.unlockTimeSkipping({});
+        try {
+            return await super.result(workflowId, runId, opts);
+        }
+        finally {
+            await this.testService.lockTimeSkipping({});
+        }
+    }
+}
+exports.WorkflowClient = WorkflowClient;
+/**
+ * Convenience workflow interceptors
+ *
+ * Contains a single interceptor for transforming `AssertionError`s into non
+ * retryable `ApplicationFailure`s.
+ */
+exports.workflowInterceptorModules = [path_1.default.join(__dirname, 'assert-to-failure-interceptor')];
+function addDefaults({ testServer, logger, }) {
+    return {
+        testServerSpawner: typeof testServer === 'function'
+            ? testServer
+            : (port) => (0, child_process_1.spawn)(testServer?.path || exports.DEFAULT_TEST_SERVER_PATH, [`${port}`], {
+                stdio: testServer?.stdio || 'ignore',
+            }),
+        logger: logger ?? new worker_1.DefaultLogger('INFO'),
+    };
+}
+// TS transforms `import` statements into `require`s, this is a workaround until
+// tsconfig module nodenext is stable.
+const _importDynamic = new Function('modulePath', 'return import(modulePath)');
+/**
+ * An execution environment for running Workflow integration tests.
+ *
+ * Runs an external server.
+ * By default, the Java test server is used which supports time skipping.
+ */
+class TestWorkflowEnvironment {
+    constructor(serverProc, connection, nativeConnection) {
+        this.serverProc = serverProc;
+        /**
+         * Wait for `durationMs` in "test server time".
+         *
+         * The test server toggles between skipped time and normal time depending on what it needs to execute.
+         *
+         * This method is likely to resolve in less than `durationMs` of "real time".
+         *
+         * Useful for simulating events far into the future like completion of long running activities.
+         *
+         * @param durationMs {@link https://www.npmjs.com/package/ms | ms} formatted string or number of milliseconds
+         *
+         * @example
+         *
+         * `workflow.ts`
+         *
+         * ```ts
+         * const activities = proxyActivities({ startToCloseTimeout: 2_000_000 });
+         *
+         * export async function raceActivityAndTimer(): Promise<string> {
+         *   return await Promise.race([
+         *     wf.sleep(500_000).then(() => 'timer'),
+         *     activities.longRunning().then(() => 'activity'),
+         *   ]);
+         * }
+         * ```
+         *
+         * `test.ts`
+         *
+         * ```ts
+         * const worker = await Worker.create({
+         *   connection: testEnv.nativeConnection,
+         *   activities: {
+         *     async longRunning() {
+         *       await testEnv.sleep(1_000_000); // <-- sleep called here
+         *     },
+         *   },
+         *   // ...
+         * });
+         * ```
+         */
+        this.sleep = async (durationMs) => {
+            await this.connection.testService.unlockTimeSkippingWithSleep({ duration: (0, common_1.msToTs)(durationMs) });
+        };
+        this.connection = connection;
+        this.nativeConnection = nativeConnection;
+        this.workflowClient = new WorkflowClient({ connection });
+        this.asyncCompletionClient = new client_1.AsyncCompletionClient({ connection });
+    }
+    /**
+     * Create a new test environment
+     */
+    static async create(opts) {
+        // No, we're not going to compile this to ESM for one dependency
+        const getPort = (await _importDynamic('get-port')).default;
+        const port = await getPort();
+        const { testServerSpawner, logger } = addDefaults(opts ?? {});
+        const child = testServerSpawner(port);
+        const address = `127.0.0.1:${port}`;
+        const connPromise = test_service_client_1.Connection.connect({ address });
+        try {
+            await Promise.race([
+                connPromise,
+                (0, child_process_2.waitOnChild)(child).then(() => {
+                    throw new Error('Test server child process exited prematurely');
+                }),
+            ]);
+        }
+        catch (err) {
+            try {
+                await (0, child_process_2.kill)(child);
+            }
+            catch (error) {
+                logger.error('Failed to kill test server child process', { error });
+            }
+            throw err;
+        }
+        const conn = await connPromise;
+        const nativeConnection = await worker_1.NativeConnection.connect({ address });
+        return new this(child, conn, nativeConnection);
+    }
+    /**
+     * Kill the test server process and close the connection to it
+     */
+    async teardown() {
+        await this.connection.close();
+        await this.nativeConnection.close();
+        // TODO: the server should return exit code 0
+        await (0, child_process_2.kill)(this.serverProc, 'SIGINT', { validReturnCodes: [0, 130] });
+    }
+}
+exports.TestWorkflowEnvironment = TestWorkflowEnvironment;
+/**
+ * Used as the default activity info for Activities executed in the {@link MockActivityEnvironment}
+ */
+exports.defaultActivityInfo = {
+    attempt: 1,
+    isLocal: false,
+    taskToken: Buffer.from('test'),
+    activityId: 'test',
+    activityType: 'unknown',
+    workflowType: 'test',
+    base64TaskToken: Buffer.from('test').toString('base64'),
+    heartbeatDetails: undefined,
+    activityNamespace: 'default',
+    workflowNamespace: 'default',
+    workflowExecution: { workflowId: 'test', runId: 'dead-beef' },
+    scheduledTimestampMs: 1,
+    startToCloseTimeoutMs: 1000,
+    scheduleToCloseTimeoutMs: 1000,
+};
+/**
+ * An execution environment for testing Activities.
+ *
+ * Mocks Activity {@link Context | activity.Context} and exposes hooks for
+ * cancellation and heartbeats.
+ */
+class MockActivityEnvironment extends events_1.default.EventEmitter {
+    constructor(info) {
+        super();
+        this.cancel = () => undefined;
+        const abortController = new abort_controller_1.AbortController();
+        const promise = new Promise((_, reject) => {
+            this.cancel = (reason) => {
+                abortController.abort();
+                reject(new common_1.CancelledFailure(reason));
+            };
+        });
+        const heartbeatCallback = (details) => this.emit('heartbeat', details);
+        this.context = new activity.Context({ ...exports.defaultActivityInfo, ...info }, promise, abortController.signal, heartbeatCallback);
+    }
+    /**
+     * Run a function in Activity Context
+     */
+    run(fn, ...args) {
+        return activity.asyncLocalStorage.run(this.context, fn, ...args);
+    }
+}
+exports.MockActivityEnvironment = MockActivityEnvironment;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+DAAiD;AACjD,+CAM4B;AAC5B,+CAA8G;AAC9G,+CAA6E;AAC7E,gDAAwB;AACxB,4CAAoB;AACpB,uDAAmD;AACnD,iDAAkE;AAClE,oDAA4B;AAC5B,mDAAoD;AAEpD,+DAAgE;AAEhE,MAAM,2BAA2B,GAAG,YAAE,CAAC,QAAQ,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,aAAa,CAAC;AAErF,QAAA,wBAAwB,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,2BAA2B,EAAE,CAAC,CAAC;AAgClG;;;;GAIG;AACH,MAAa,cAAe,SAAQ,uBAAkB;IAGpD,YAAY,OAA8B;QACxC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAClB,kBAA8B,EAC9B,OAAgC;QAEhC,OAAO,KAAK,CAAC,OAAO,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACM,KAAK,CAAC,MAAM,CACnB,UAAkB,EAClB,KAA0B,EAC1B,IAAwC;QAExC,IAAI,IAAI,EAAE,eAAe,EAAE;YACzB,OAAO,MAAM,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;SACpD;QACD,MAAM,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;QAC9C,IAAI;YACF,OAAO,MAAM,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;SACpD;gBAAS;YACR,MAAM,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;SAC7C;IACH,CAAC;CACF;AAxCD,wCAwCC;AAED;;;;;GAKG;AACU,QAAA,0BAA0B,GAAG,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,+BAA+B,CAAC,CAAC,CAAC;AA+BlG,SAAS,WAAW,CAAC,EACnB,UAAU,EACV,MAAM,GACyB;IAC/B,OAAO;QACL,iBAAiB,EACf,OAAO,UAAU,KAAK,UAAU;YAC9B,CAAC,CAAC,UAAU;YACZ,CAAC,CAAC,CAAC,IAAY,EAAE,EAAE,CACf,IAAA,qBAAK,EAAC,UAAU,EAAE,IAAI,IAAI,gCAAwB,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE;gBAC/D,KAAK,EAAE,UAAU,EAAE,KAAK,IAAI,QAAQ;aACrC,CAAC;QACV,MAAM,EAAE,MAAM,IAAI,IAAI,sBAAa,CAAC,MAAM,CAAC;KAC5C,CAAC;AACJ,CAAC;AAED,gFAAgF;AAChF,sCAAsC;AACtC,MAAM,cAAc,GAAG,IAAI,QAAQ,CAAC,YAAY,EAAE,2BAA2B,CAAC,CAAC;AAE/E;;;;;GAKG;AACH,MAAa,uBAAuB;IAuBlC,YACqB,UAAwB,EAC3C,UAAsB,EACtB,gBAAkC;QAFf,eAAU,GAAV,UAAU,CAAc;QAyD7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAuCG;QACH,UAAK,GAAG,KAAK,EAAE,UAA2B,EAAiB,EAAE;YAC3D,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,2BAA2B,CAAC,EAAE,QAAQ,EAAE,IAAA,eAAM,EAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAClG,CAAC,CAAC;QA/FA,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,CAAC,cAAc,GAAG,IAAI,cAAc,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,qBAAqB,GAAG,IAAI,8BAAqB,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAqC;QACvD,gEAAgE;QAChE,MAAM,OAAO,GAAG,CAAC,MAAM,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,OAA6B,CAAC;QACjF,MAAM,IAAI,GAAG,MAAM,OAAO,EAAE,CAAC;QAE7B,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;QAE9D,MAAM,KAAK,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAEtC,MAAM,OAAO,GAAG,aAAa,IAAI,EAAE,CAAC;QACpC,MAAM,WAAW,GAAG,gCAAU,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QAEpD,IAAI;YACF,MAAM,OAAO,CAAC,IAAI,CAAC;gBACjB,WAAW;gBACX,IAAA,2BAAW,EAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;oBAC3B,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;gBAClE,CAAC,CAAC;aACH,CAAC,CAAC;SACJ;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI;gBACF,MAAM,IAAA,oBAAI,EAAC,KAAK,CAAC,CAAC;aACnB;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,CAAC,KAAK,CAAC,0CAA0C,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;aACrE;YACD,MAAM,GAAG,CAAC;SACX;QAED,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC;QAC/B,MAAM,gBAAgB,GAAG,MAAM,yBAAgB,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QAErE,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ;QACZ,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QAC9B,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;QACpC,6CAA6C;QAC7C,MAAM,IAAA,oBAAI,EAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;IACxE,CAAC;CA6CF;AA5HD,0DA4HC;AAED;;GAEG;AACU,QAAA,mBAAmB,GAAkB;IAChD,OAAO,EAAE,CAAC;IACV,OAAO,EAAE,KAAK;IACd,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;IAC9B,UAAU,EAAE,MAAM;IAClB,YAAY,EAAE,SAAS;IACvB,YAAY,EAAE,MAAM;IACpB,eAAe,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACvD,gBAAgB,EAAE,SAAS;IAC3B,iBAAiB,EAAE,SAAS;IAC5B,iBAAiB,EAAE,SAAS;IAC5B,iBAAiB,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE;IAC7D,oBAAoB,EAAE,CAAC;IACvB,qBAAqB,EAAE,IAAI;IAC3B,wBAAwB,EAAE,IAAI;CAC/B,CAAC;AAEF;;;;;GAKG;AACH,MAAa,uBAAwB,SAAQ,gBAAM,CAAC,YAAY;IAI9D,YAAY,IAA6B;QACvC,KAAK,EAAE,CAAC;QAJH,WAAM,GAA2B,GAAG,EAAE,CAAC,SAAS,CAAC;QAKtD,MAAM,eAAe,GAAG,IAAI,kCAAe,EAAE,CAAC;QAC9C,MAAM,OAAO,GAAG,IAAI,OAAO,CAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;YAC/C,IAAI,CAAC,MAAM,GAAG,CAAC,MAAY,EAAE,EAAE;gBAC7B,eAAe,CAAC,KAAK,EAAE,CAAC;gBACxB,MAAM,CAAC,IAAI,yBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;YACvC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,MAAM,iBAAiB,GAAG,CAAC,OAAiB,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QACjF,IAAI,CAAC,OAAO,GAAG,IAAI,QAAQ,CAAC,OAAO,CACjC,EAAE,GAAG,2BAAmB,EAAE,GAAG,IAAI,EAAE,EACnC,OAAO,EACP,eAAe,CAAC,MAAM,EACtB,iBAAiB,CAClB,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,GAAG,CAAuD,EAAK,EAAE,GAAG,IAAO;QAChF,OAAO,QAAQ,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACnE,CAAC;CACF;AA5BD,0DA4BC"}

package/lib/test-service-client.d.ts

@@ -0,0 +1,21 @@
+import * as grpc from '@grpc/grpc-js';
+import { Connection as BaseConnection, ConnectionOptions } from '@temporalio/client';
+import { ConnectionCtorOptions as BaseConnectionCtorOptions } from '@temporalio/client/lib/connection';
+import { temporal } from '../generated-protos';
+export declare type TestService = temporal.api.testservice.v1.TestService;
+export declare const TestService: typeof temporal.api.testservice.v1.TestService;
+interface ConnectionCtorOptions extends BaseConnectionCtorOptions {
+    testService: TestService;
+}
+/**
+ * A Connection class that can be used to interact with both the test server's TestService and WorkflowService
+ */
+export declare class Connection extends BaseConnection {
+    static readonly TestServiceClient: grpc.ServiceClientConstructor;
+    readonly testService: TestService;
+    protected static createCtorOptions(options?: ConnectionOptions): ConnectionCtorOptions;
+    static lazy(options?: ConnectionOptions): Connection;
+    static connect(options?: ConnectionOptions): Promise<Connection>;
+    protected constructor(options: ConnectionCtorOptions);
+}
+export {};

package/lib/test-service-client.js

@@ -0,0 +1,62 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Connection = exports.TestService = void 0;
+const grpc = __importStar(require("@grpc/grpc-js"));
+const client_1 = require("@temporalio/client");
+const generated_protos_1 = require("../generated-protos");
+exports.TestService = generated_protos_1.temporal.api.testservice.v1.TestService;
+/**
+ * A Connection class that can be used to interact with both the test server's TestService and WorkflowService
+ */
+class Connection extends client_1.Connection {
+    constructor(options) {
+        super(options);
+        this.testService = options.testService;
+    }
+    static createCtorOptions(options) {
+        const ctorOptions = client_1.Connection.createCtorOptions(options);
+        const rpcImpl = this.generateRPCImplementation({
+            serviceName: 'temporal.api.testservice.v1.TestService',
+            client: ctorOptions.client,
+            callContextStorage: ctorOptions.callContextStorage,
+            interceptors: ctorOptions.options.interceptors,
+        });
+        const testService = exports.TestService.create(rpcImpl, false, false);
+        return { ...ctorOptions, testService };
+    }
+    static lazy(options) {
+        const ctorOptions = this.createCtorOptions(options);
+        return new this(ctorOptions);
+    }
+    static async connect(options) {
+        const ret = this.lazy(options);
+        await ret.ensureConnected();
+        return ret;
+    }
+}
+exports.Connection = Connection;
+Connection.TestServiceClient = grpc.makeGenericClientConstructor({}, 'TestService', {});
+//# sourceMappingURL=test-service-client.js.map

package/lib/test-service-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-service-client.js","sourceRoot":"","sources":["../src/test-service-client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAsC;AACtC,+CAAqF;AAErF,0DAA+C;AAGhC,mBAAW,GAAK,2BAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,aAAC;AAM3D;;GAEG;AACH,MAAa,UAAW,SAAQ,mBAAc;IA2B5C,YAAsB,OAA8B;QAClD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IACzC,CAAC;IA1BS,MAAM,CAAC,iBAAiB,CAAC,OAA2B;QAC5D,MAAM,WAAW,GAAG,mBAAc,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC9D,MAAM,OAAO,GAAG,IAAI,CAAC,yBAAyB,CAAC;YAC7C,WAAW,EAAE,yCAAyC;YACtD,MAAM,EAAE,WAAW,CAAC,MAAM;YAC1B,kBAAkB,EAAE,WAAW,CAAC,kBAAkB;YAClD,YAAY,EAAE,WAAW,CAAC,OAAO,CAAC,YAAY;SAC/C,CAAC,CAAC;QACH,MAAM,WAAW,GAAG,mBAAW,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAC9D,OAAO,EAAE,GAAG,WAAW,EAAE,WAAW,EAAE,CAAC;IACzC,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,OAA2B;QACrC,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QACpD,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,OAA2B;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/B,MAAM,GAAG,CAAC,eAAe,EAAE,CAAC;QAC5B,OAAO,GAAG,CAAC;IACb,CAAC;;AAzBH,gCA+BC;AA9BwB,4BAAiB,GAAG,IAAI,CAAC,4BAA4B,CAAC,EAAE,EAAE,aAAa,EAAE,EAAE,CAAC,CAAC"}

package/lib/utils.d.ts

@@ -0,0 +1,3 @@
+import { Connection } from '@temporalio/client';
+export declare function waitOnNamespace(connection: Connection, namespace: string, maxAttempts?: number, retryIntervalSecs?: number): Promise<void>;
+export declare function createNamespace(connection: Connection, namespace: string, maxAttempts?: number, retryIntervalSecs?: number): Promise<void>;

package/lib/utils.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNamespace = exports.waitOnNamespace = void 0;
+const internal_workflow_common_1 = require("@temporalio/internal-workflow-common");
+async function waitOnNamespace(connection, namespace, maxAttempts = 100, retryIntervalSecs = 1) {
+    const runId = '12345678-dead-beef-1234-1234567890ab';
+    for (let attempt = 1; attempt <= maxAttempts; ++attempt) {
+        try {
+            await connection.workflowService.getWorkflowExecutionHistory({
+                namespace,
+                execution: { workflowId: 'fake', runId },
+            });
+        }
+        catch (err) {
+            if (err.details.includes('workflow history not found') || err.details.includes(runId)) {
+                break;
+            }
+            if (attempt === maxAttempts) {
+                throw err;
+            }
+            await new Promise((resolve) => setTimeout(resolve, retryIntervalSecs * 1000));
+        }
+    }
+}
+exports.waitOnNamespace = waitOnNamespace;
+async function createNamespace(connection, namespace, maxAttempts = 100, retryIntervalSecs = 1) {
+    for (let attempt = 1; attempt <= maxAttempts; ++attempt) {
+        try {
+            await connection.workflowService.registerNamespace({
+                namespace,
+                workflowExecutionRetentionPeriod: (0, internal_workflow_common_1.msToTs)('1 day'),
+            });
+            break;
+        }
+        catch (err) {
+            if (err.details === 'Namespace already exists.') {
+                break;
+            }
+            if (attempt === maxAttempts) {
+                throw err;
+            }
+            await new Promise((resolve) => setTimeout(resolve, retryIntervalSecs * 1000));
+        }
+    }
+}
+exports.createNamespace = createNamespace;
+//# sourceMappingURL=utils.js.map

package/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AACA,mFAA8D;AAEvD,KAAK,UAAU,eAAe,CACnC,UAAsB,EACtB,SAAiB,EACjB,WAAW,GAAG,GAAG,EACjB,iBAAiB,GAAG,CAAC;IAErB,MAAM,KAAK,GAAG,sCAAsC,CAAC;IACrD,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,WAAW,EAAE,EAAE,OAAO,EAAE;QACvD,IAAI;YACF,MAAM,UAAU,CAAC,eAAe,CAAC,2BAA2B,CAAC;gBAC3D,SAAS;gBACT,SAAS,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE;aACzC,CAAC,CAAC;SACJ;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,4BAA4B,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBACrF,MAAM;aACP;YACD,IAAI,OAAO,KAAK,WAAW,EAAE;gBAC3B,MAAM,GAAG,CAAC;aACX;YACD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAC;SAC/E;KACF;AACH,CAAC;AAvBD,0CAuBC;AAEM,KAAK,UAAU,eAAe,CACnC,UAAsB,EACtB,SAAiB,EACjB,WAAW,GAAG,GAAG,EACjB,iBAAiB,GAAG,CAAC;IAErB,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,WAAW,EAAE,EAAE,OAAO,EAAE;QACvD,IAAI;YACF,MAAM,UAAU,CAAC,eAAe,CAAC,iBAAiB,CAAC;gBACjD,SAAS;gBACT,gCAAgC,EAAE,IAAA,iCAAM,EAAC,OAAO,CAAC;aAClD,CAAC,CAAC;YACH,MAAM;SACP;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,GAAG,CAAC,OAAO,KAAK,2BAA2B,EAAE;gBAC/C,MAAM;aACP;YACD,IAAI,OAAO,KAAK,WAAW,EAAE;gBAC3B,MAAM,GAAG,CAAC;aACX;YACD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAC;SAC/E;KACF;AACH,CAAC;AAvBD,0CAuBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temporalio/testing",
-  "version": "0.23.1",
+  "version": "1.0.0-rc.0",
   "description": "Temporal.io SDK Testing sub-package",
   "main": "lib/index.js",
   "types": "./lib/index.d.ts",
@@ -18,10 +18,10 @@
   "license": "MIT",
   "dependencies": {
     "@grpc/grpc-js": "^1.5.7",
-    "@temporalio/activity": "^0.23.0",
-    "@temporalio/client": "^0.23.0",
-    "@temporalio/common": "^0.23.0",
-    "@temporalio/worker": "^0.23.1",
+    "@temporalio/activity": "^1.0.0-rc.0",
+    "@temporalio/client": "^1.0.0-rc.0",
+    "@temporalio/common": "^1.0.0-rc.0",
+    "@temporalio/worker": "^1.0.0-rc.0",
     "@types/long": "^4.0.1",
     "abort-controller": "^3.0.0",
     "get-port": "^6.1.2",
@@ -37,10 +37,11 @@
   "homepage": "https://github.com/temporalio/sdk-typescript/tree/main/packages/testing",
   "files": [
     "lib",
-    "generated-protos"
+    "generated-protos",
+    "scripts"
   ],
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "02f84f02cf2b28df57dd77f02514976a1ce83822"
+  "gitHead": "c25e91309b980f2118df4048d760306982019871"
 }

package/scripts/common.mjs

@@ -0,0 +1,18 @@
+import os from 'node:os';
+import { URL, fileURLToPath } from 'node:url';
+
+const platformMapping = { darwin: 'macOS', linux: 'linux', win32: 'windows' };
+const archAlias = { x64: 'amd64', arm64: 'aarch64' };
+
+export const systemPlatform = platformMapping[os.platform()];
+if (!systemPlatform) {
+  throw new Error(`Unsupported platform ${os.platform()}`);
+}
+
+export const systemArch = archAlias[os.arch()];
+if (!systemArch) {
+  throw new Error(`Unsupported architecture ${os.arch()}`);
+}
+
+const ext = systemPlatform === 'windows' ? '.exe' : '';
+export const outputPath = fileURLToPath(new URL(`../test-server${ext}`, import.meta.url));

package/scripts/compile-proto.mjs

@@ -0,0 +1,81 @@
+import { resolve, dirname } from 'path';
+import { fileURLToPath } from 'url';
+import { promisify } from 'util';
+import dedent from 'dedent';
+import glob from 'glob';
+import { statSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
+import pbjs from 'protobufjs/cli/pbjs.js';
+import pbts from 'protobufjs/cli/pbts.js';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const outputDir = resolve(__dirname, '../generated-protos');
+const outputFile = resolve(outputDir, 'index.js');
+const protoBaseDir = resolve(__dirname, '../proto');
+
+const serviceProtoPath = resolve(protoBaseDir, 'temporal/api/testservice/v1/service.proto');
+
+function mtime(path) {
+  try {
+    return statSync(path).mtimeMs;
+  } catch (err) {
+    if (err.code === 'ENOENT') {
+      return 0;
+    }
+    throw err;
+  }
+}
+
+async function compileProtos(protoPath, jsOutputFile, dtsOutputFile, ...args) {
+  console.log(`Creating protobuf JS definitions from ${protoPath}`);
+
+  const pbjsArgs = [
+    ...args,
+    '--wrap',
+    'commonjs',
+    '--target',
+    'static-module',
+    '--force-long',
+    '--no-verify',
+    '--root',
+    '__temporal_testing',
+    '--out',
+    jsOutputFile,
+    protoPath,
+  ];
+  await promisify(pbjs.main)(pbjsArgs);
+
+  console.log(`Creating protobuf TS definitions from ${protoPath}`);
+  await promisify(pbts.main)(['--out', dtsOutputFile, jsOutputFile]);
+
+  // Fix issue where Long is not found in TS definitions (https://github.com/protobufjs/protobuf.js/issues/1533)
+  const pbtsOutput = readFileSync(dtsOutputFile, 'utf8');
+  writeFileSync(
+    dtsOutputFile,
+    dedent`
+  import Long from "long";
+  ${pbtsOutput}
+  `
+  );
+}
+
+async function main() {
+  mkdirSync(outputDir, { recursive: true });
+
+  const protoFiles = glob.sync(resolve(protoBaseDir, '**/*.proto'));
+  const protosMTime = Math.max(...protoFiles.map(mtime));
+  const genMTime = mtime(outputFile);
+
+  if (protosMTime < genMTime) {
+    console.log('Assuming protos are up to date');
+    return;
+  }
+
+  await compileProtos(serviceProtoPath, outputFile, resolve(outputDir, 'index.d.ts'), '--path', resolve(protoBaseDir));
+
+  console.log('Done');
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

package/scripts/download-test-server.mjs

@@ -0,0 +1,91 @@
+import stream from 'node:stream';
+import util from 'node:util';
+import zlib from 'node:zlib';
+import fs from 'node:fs';
+import got from 'got';
+import tar from 'tar-stream';
+import unzipper from 'unzipper';
+import { outputPath, systemArch, systemPlatform } from './common.mjs';
+
+try {
+  if (fs.statSync(outputPath).isFile) {
+    console.log('Found existing test server executable', { path: outputPath });
+    process.exit(0);
+  }
+} catch (err) {
+  if (err.code !== 'ENOENT') {
+    throw err;
+  }
+}
+
+const pipeline = util.promisify(stream.pipeline);
+
+const defaultHeaders = {
+  'User-Agent': '@temporalio/testing installer',
+};
+
+const { GITHUB_TOKEN } = process.env;
+
+if (GITHUB_TOKEN) {
+  console.log(`Using GITHUB_TOKEN`);
+  defaultHeaders['Authorization'] = `Bearer ${GITHUB_TOKEN}`;
+}
+
+const latestReleaseRes = await got('https://api.github.com/repos/temporalio/sdk-java/releases/latest', {
+  headers: {
+    ...defaultHeaders,
+    Accept: 'application/vnd.github.v3+json',
+  },
+}).json();
+
+function findTestServerAsset(assets) {
+  for (const asset of assets) {
+    const m = asset.name.match(/^temporal-test-server_[^_]+_([^_]+)_([^.]+)\.(?:zip|tar.gz)$/);
+    if (m) {
+      const [_, assetPlatform, _assetArch] = m;
+      if (assetPlatform === systemPlatform) {
+        // TODO: assetArch === systemArch (no arm builds for test server yet)
+        return asset;
+      }
+    }
+  }
+  throw new Error(`No prebuilt test server for ${systemPlatform}-${systemArch}`);
+}
+
+const asset = findTestServerAsset(latestReleaseRes.assets);
+console.log('Downloading test server', { asset: asset.name, outputPath });
+
+if (asset.content_type === 'application/x-gzip' || asset.content_type === 'application/x-gtar') {
+  const extract = tar.extract();
+  extract.on('entry', (_headers, stream, next) => {
+    stream.pipe(fs.createWriteStream(outputPath));
+    next();
+  });
+  await pipeline(
+    got.stream(asset.browser_download_url, {
+      headers: {
+        ...defaultHeaders,
+      },
+    }),
+    zlib.createGunzip(),
+    extract
+  );
+  await fs.promises.chmod(outputPath, 0o755);
+} else if (asset.content_type === 'application/zip') {
+  got
+    .stream(asset.browser_download_url, {
+      headers: {
+        ...defaultHeaders,
+      },
+    })
+    .pipe(unzipper.Parse())
+    .on('entry', (entry) => {
+      if (entry.type === 'File') {
+        entry.pipe(fs.createWriteStream(outputPath));
+      } else {
+        entry.autodrain();
+      }
+    });
+} else {
+  throw new Error(`Unexpected content type for Test server download: ${asset.content_type}`);
+}