@tsed/temporal 7.37.0

package/lib/types/TemporalModule.d.ts

@@ -0,0 +1,12 @@
+import { Logger } from "@tsed/common";
+import { InjectorService } from "@tsed/di";
+import { TemporalClient } from "./services/TemporalFactory";
+export declare class TemporalModule {
+    private temporalServices;
+    protected logger: Logger;
+    protected injector: InjectorService;
+    protected client: TemporalClient;
+    constructor(temporalServices: any[]);
+    getActivities(): object;
+    protected getActivitiesFromInstance(instance: any): {};
+}

package/lib/types/constants.d.ts

@@ -0,0 +1 @@
+export declare const PROVIDER_TYPE_TEMPORAL = "PROVIDER_TYPE_TEMPORAL";

package/lib/types/decorators/activity.d.ts

@@ -0,0 +1,2 @@
+import { ActivityOptions } from "../interfaces/TemporalStore";
+export declare function Activity(options?: ActivityOptions): MethodDecorator;

package/lib/types/decorators/temporal.d.ts

@@ -0,0 +1 @@
+export declare function Temporal(): ClassDecorator;

package/lib/types/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+export * from "./TemporalModule";
+export * from "./constants";
+export * from "./decorators/activity";
+export * from "./decorators/temporal";
+export * from "./interfaces/TemporalStore";
+export * from "./interfaces/interfaces";
+export * from "./services/TemporalFactory";
+export * from "./utils/worker";

package/lib/types/interfaces/TemporalStore.d.ts

@@ -0,0 +1,9 @@
+export declare const TEMPORAL_STORE_KEY = "temporal";
+export interface ActivityOptions {
+    name?: string;
+}
+export interface TemporalStore {
+    activities?: {
+        [propertyKey: string]: ActivityOptions;
+    };
+}

package/lib/types/interfaces/interfaces.d.ts

@@ -0,0 +1,12 @@
+import { ClientOptions, ConnectionOptions } from "@temporalio/client";
+declare global {
+    namespace TsED {
+        interface Configuration {
+            temporal?: {
+                enabled?: boolean;
+                connection?: ConnectionOptions;
+                client?: Omit<ClientOptions, "connection">;
+            };
+        }
+    }
+}

package/lib/types/services/TemporalFactory.d.ts

@@ -0,0 +1,5 @@
+import { Client, Connection } from "@temporalio/client";
+export declare const TemporalConnection: typeof Connection;
+export type TemporalConnection = Connection;
+export declare const TemporalClient: typeof Client;
+export type TemporalClient = Client;

package/lib/types/utils/worker.d.ts

@@ -0,0 +1,9 @@
+import { PlatformBuilderSettings } from "@tsed/common";
+import { NativeConnection, NativeConnectionOptions, Worker, WorkerOptions } from "@temporalio/worker";
+type BootstrapWorkerOptions = {
+    platform?: PlatformBuilderSettings;
+    worker: Omit<WorkerOptions, "activities">;
+    connection?: NativeConnection | NativeConnectionOptions;
+};
+export declare function bootstrapWorker(mod: any, settings: BootstrapWorkerOptions): Promise<Worker>;
+export {};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@tsed/temporal",
+  "version": "7.37.0",
+  "description": "Temporal.io package for Ts.ED framework",
+  "source": "./src/index.ts",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "typings": "./lib/types/index.d.ts",
+  "exports": {
+    "types": "./lib/types/index.d.ts",
+    "import": "./lib/esm/index.js",
+    "require": "./lib/cjs/index.js",
+    "default": "./lib/esm/index.js"
+  },
+  "scripts": {
+    "build": "yarn barrels && yarn build:ts",
+    "barrels": "yarn barrelsby --delete -d ./src -e \"\\.spec\\.ts\" -e \"__mock__\" -e \".benchmark.ts\"",
+    "test": "cross-env NODE_ENV=test yarn jest --runInBand --forceExit && jest-coverage-thresholds-bumper ",
+    "build:ts": "tsc --build tsconfig.json && tsc --build tsconfig.esm.json",
+    "lint": "eslint '**/*.{ts,js}'",
+    "lint:fix": "eslint '**/*.{ts,js}' --fix"
+  },
+  "dependencies": {
+    "tslib": "2.5.0"
+  },
+  "private": false,
+  "devDependencies": {
+    "@temporalio/client": "^1.8.4",
+    "@temporalio/testing": "^1.8.4",
+    "@temporalio/worker": "^1.8.4",
+    "@tsed/common": "7.37.0",
+    "@tsed/core": "7.37.0",
+    "@tsed/di": "7.37.0",
+    "@tsed/eslint": "7.37.0",
+    "@tsed/typescript": "7.37.0",
+    "eslint": "^8.12.0"
+  },
+  "peerDependencies": {
+    "@temporalio/client": "^1.8.4",
+    "@temporalio/worker": "^1.8.4"
+  },
+  "repository": "https://github.com/tsedio/tsed",
+  "bugs": {
+    "url": "https://github.com/tsedio/tsed/issues"
+  },
+  "homepage": "https://github.com/tsedio/tsed/tree/production/packages/third-parties/temporal",
+  "author": "Romain Lenzotti",
+  "license": "MIT"
+}

package/readme.md

@@ -0,0 +1,256 @@
+<p style="text-align: center" align="center">
+ <a href="https://tsed.io" target="_blank"><img src="https://tsed.io/tsed-og.png" width="200" alt="Ts.ED logo"/></a>
+</p>
+
+<div align="center">
+ 
+   <h1>Temporal</h1>
+ 
+[![Build & Release](https://github.com/tsedio/tsed/workflows/Build%20&%20Release/badge.svg)](https://github.com/tsedio/tsed/actions?query=workflow%3A%22Build+%26+Release%22)
+[![PR Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/tsedio/tsed/blob/master/CONTRIBUTING.md)
+[![Coverage Status](https://coveralls.io/repos/github/tsedio/tsed/badge.svg?branch=production)](https://coveralls.io/github/tsedio/tsed?branch=production)
+[![npm version](https://badge.fury.io/js/%40tsed%2Fcommon.svg)](https://badge.fury.io/js/%40tsed%2Fcommon)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![github](https://img.shields.io/static/v1?label=Github%20sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/romakita)
+[![opencollective](https://img.shields.io/static/v1?label=OpenCollective%20sponsor&message=%E2%9D%A4&logo=OpenCollective&color=%23fe8e86)](https://opencollective.com/tsed)
+
+</div>
+
+<div align="center">
+  <a href="https://tsed.io/">Website</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://tsed.io/getting-started/">Getting started</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://api.tsed.io/rest/slack/tsedio/tsed">Slack</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href="https://twitter.com/TsED_io">Twitter</a>
+</div>
+
+<hr />
+
+A package of Ts.ED framework. See website: https://tsed.io
+
+## Feature
+
+[Temporal](https://temporal.io) lets you write complex asynchronous distributed workflows using easy to read linear code. For more information about Temporal take a look at the documentation [here](https://docs.temporal.io/).
+
+The `@tsed/temporal` module allows you to decorate classes with `@Temporal` and
+corresponding methods with `@Activity` to write and start asynchronous workflows.
+
+Inject the `TemporalClient` to start/schedule and query workflows or to send signals to them.
+
+Use the `bootstrapWorker` helper to start a queue that executes your workflows and activities.
+
+## Installation
+
+To begin, install the Temporal module for Ts.ED:
+
+```bash
+npm install --save @tsed/temporal
+npm install --save @temporalio/client @temporalio/worker
+```
+
+## Configure your server
+
+Import `@tsed/temporal` in your Server:
+
+```typescript
+import {Configuration} from "@tsed/common";
+import "@tsed/temporal"; // import temporal ts.ed module
+
+@Configuration({
+  temporal: {
+    enabled: true,
+    connection: {
+      /* optional: see ConnectionOptions of @temporalio/client */
+    },
+    client: {
+      /* optional: see ClientOptions of @temporalio/client */
+    }
+  }
+})
+export class Server {}
+```
+
+## Create a new Service
+
+Decorate the class with `@Temporal`.
+
+Use the `@Activity` decorator to define activities.
+
+```typescript
+import {Temporal, Activity} from "@tsed/temporal";
+
+@Temporal()
+export class UserOnboardingActivities {
+  constructor(private userService: UserService, private emailService: EmailService) {}
+
+  @Activity()
+  async sendVerificationEmail(email: string) {
+    return this.emailService.sendVerificationEmail(email);
+  }
+
+  @Activity()
+  async activateUser(email: string) {
+    return this.userService.activateUser(email);
+  }
+
+  @Activity()
+  async sendWelcomeEmail(email: string) {
+    return this.emailService.sendWelcomeEmail(email);
+  }
+
+  @Activity()
+  async sendFollowUpEmail(email: string) {
+    return this.emailService.sendFollowUpEmail(email);
+  }
+
+  @Activity()
+  async deleteUser(email: string) {
+    return this.userService.deleteUser(email);
+  }
+}
+```
+
+Optional, create an interface for your activities to use it later for your [workflows](https://docs.temporal.io/workflows).
+
+```ts
+interface IUserOnboardingActivities {
+  sendVerificationEmail(email: string): Promise<void>;
+  activateUser(email: string): Promise<void>;
+  sendWelcomeEmail(email: string): Promise<void>;
+  sendFollowUpEmail(email: string): Promise<void>;
+  deleteUser(email: string): Promise<void>;
+}
+
+export type Activities = IGreetingActivity;
+```
+
+### Write Workflows
+
+Workflows are regular functions that cannot interact directly with Ts.ED or other packages. Just the earlier created interface is used for type-safety.
+
+::: warning
+Do not import any non temporal packages here. The workflows are bundled internally by the worker and won't have access to anything else.
+:::
+
+```ts
+import {proxyActivities, defineSignal, setHandler, condition, sleep} from "@temporalio/workflow";
+import {Activities} from "../activities";
+
+export const isVerifiedSignal = defineSignal("verificationSignal");
+
+export async function onboardUser(email: string): Promise<string> {
+  const {sendVerificationEmail, activateUser, sendWelcomeEmail, sendFollowUpEmail, deleteUser} = proxyActivities<Activities>({
+    startToCloseTimeout: "1 minute"
+  });
+
+  let isVerified = false;
+  setHandler(isVerifiedSignal, () => {
+    isVerified = true;
+  });
+
+  // 1. Send verification email
+  await sendVerificationEmail(email);
+
+  // 2. Wait for verification ...
+  const verifiedInTime = await condition(() => isVerified, "1w" /* or for a timeout */);
+  if (!verifiedInTime) {
+    // 3a. If not verified in time, delete user
+    await deleteUserAndTenant(email);
+    return false;
+  }
+
+  // 3b. If verified in time, send welcome email
+  await sendWelcomeEmail(email);
+
+  // 4. Send follow up email after one day
+  await sleep("1d"); // special sleep function by temporal
+  await sendFollowUpEmail(email);
+}
+```
+
+## Inject TemporalClient
+
+Inject the TemporalClient instance to interact with it directly, e.g. to start a workflow.
+
+```typescript
+import {Service, AfterRoutesInit} from "@tsed/common";
+import {TemporalClient} from "@tsed/temporal";
+import {onboardUser} from "../workflows";
+
+@Service()
+export class UsersService implements AfterRoutesInit {
+  @Inject()
+  private temporalClient: TemporalClient;
+
+  async create(user: User): Promise<User> {
+    // ...
+    await this.temporalClient.workflow.start(onboardUser, {
+      args: [user.email],
+      taskQueue: "onboarding",
+      workflowId: `onboarding-${user.id}`
+    });
+  }
+}
+```
+
+### Start a worker
+
+The workflows and activities won't get executed until you start a worker. This module provides a helper function to bootstrap a worker based on your Ts.ED server class that is aware of all your activities.
+
+The most tricky part is the `workflowsPath` parameter. This is the path of the file/folder where the workflows are exported. The file is automatically loaded when the worker is started and internally bundled with webpack. The path is highly dependent on your project structure and build process.
+
+Read more about it [here](https://docs.temporal.io/typescript/troubleshooting/#webpack-errors).
+
+```ts
+import {bootstrapWorker} from "@tsed/temporal";
+import {Server} from "./app/Server";
+
+const worker = await bootstrapWorker(Server, {
+  worker: {
+    taskQueue: "onboarding",
+    workflowsPath: require.resolve("./temporal") // other example: path.join(process.cwd(), 'dist/apps/api/temporal/index.ts');
+  },
+  connection: {
+    /* optional: see NativeConnectionOptions of @temporalio/worker */
+  },
+  platform: {
+    /* optional: see PlatformBuilderSettings of @tsed/common */
+    componentsScan: false,
+    logger: {
+      level: "info"
+    }
+  }
+});
+await worker.run();
+```
+
+## Contributors
+
+Please read [contributing guidelines here](https://tsed.io/contributing.html)
+
+<a href="https://github.com/tsedio/tsed/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>
+
+## Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]
+
+<a href="https://opencollective.com/tsed#backers" target="_blank"><img src="https://opencollective.com/tsed/backers.svg?width=890"></a>
+
+## Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2016 - 2021 Romain Lenzotti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/src/TemporalModule.ts

@@ -0,0 +1,39 @@
+import {classOf} from "@tsed/core";
+import {Logger} from "@tsed/common";
+import {Inject, InjectorService, Module, Provider} from "@tsed/di";
+import {PROVIDER_TYPE_TEMPORAL} from "./constants";
+import {TemporalStore, TEMPORAL_STORE_KEY} from "./interfaces/TemporalStore";
+import {TemporalClient} from "./services/TemporalFactory";
+
+@Module()
+export class TemporalModule {
+  @Inject()
+  protected logger!: Logger;
+
+  @Inject()
+  protected injector!: InjectorService;
+
+  @Inject()
+  protected client!: TemporalClient;
+
+  constructor(@Inject(PROVIDER_TYPE_TEMPORAL) private temporalServices: any[]) {}
+
+  public getActivities(): object {
+    return this.temporalServices.reduce((activities, instance) => Object.assign(activities, this.getActivitiesFromInstance(instance)), {});
+  }
+
+  protected getActivitiesFromInstance(instance: any) {
+    const provider = this.injector.getProvider(classOf(instance))!;
+    const store = provider.store.get<TemporalStore>(TEMPORAL_STORE_KEY, {});
+
+    return Object.entries(store.activities || {}).reduce((activities, [propertyKey, {name}]) => {
+      const jobProcessor = instance[propertyKey].bind(instance);
+      const jobName = name || propertyKey;
+
+      return {
+        ...activities,
+        [jobName]: jobProcessor
+      };
+    }, {});
+  }
+}

package/src/constants.ts

@@ -0,0 +1 @@
+export const PROVIDER_TYPE_TEMPORAL = "PROVIDER_TYPE_TEMPORAL";

package/src/decorators/activity.spec.ts

@@ -0,0 +1,40 @@
+import {Store} from "@tsed/core";
+import {Activity} from "./activity";
+import {Temporal} from "./temporal";
+
+describe("@Activity()", () => {
+  it("should set metadata", () => {
+    @Temporal()
+    class Test {
+      @Activity()
+      testActivityDecorator() {
+        // test
+      }
+    }
+
+    const store = Store.from(Test);
+
+    expect(store.get("temporal").activities).toEqual({
+      testActivityDecorator: {}
+    });
+  });
+
+  it("should set options metadata", () => {
+    @Temporal()
+    class Test {
+      @Activity({
+        name: "testActivityDecoratorCustomName"
+      })
+      test() {
+        // test
+      }
+    }
+
+    const store = Store.from(Test);
+    expect(store.get("temporal").activities).toEqual({
+      test: {
+        name: "testActivityDecoratorCustomName"
+      }
+    });
+  });
+});

package/src/decorators/activity.ts

@@ -0,0 +1,14 @@
+import {Store} from "@tsed/core";
+import {TemporalStore, ActivityOptions, TEMPORAL_STORE_KEY} from "../interfaces/TemporalStore";
+
+export function Activity(options: ActivityOptions = {}): MethodDecorator {
+  return (target: any, propertyKey: string | symbol) => {
+    const store: TemporalStore = {
+      activities: {
+        [propertyKey]: options
+      }
+    };
+
+    Store.from(target).merge(TEMPORAL_STORE_KEY, store);
+  };
+}

package/src/decorators/temporal.spec.ts

@@ -0,0 +1,11 @@
+import {GlobalProviders} from "@tsed/di";
+import {Temporal} from "./temporal";
+
+describe("@Activity()", () => {
+  it("should set metadata", () => {
+    @Temporal()
+    class Test {}
+
+    expect(GlobalProviders.get(Test)?.useClass).toEqual(Test);
+  });
+});

package/src/decorators/temporal.ts

@@ -0,0 +1,11 @@
+import {useDecorators} from "@tsed/core";
+import {Injectable} from "@tsed/di";
+import {PROVIDER_TYPE_TEMPORAL} from "../constants";
+
+export function Temporal(): ClassDecorator {
+  return useDecorators(
+    Injectable({
+      type: PROVIDER_TYPE_TEMPORAL
+    })
+  );
+}

package/src/index.ts

@@ -0,0 +1,12 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+
+export * from "./TemporalModule";
+export * from "./constants";
+export * from "./decorators/activity";
+export * from "./decorators/temporal";
+export * from "./interfaces/TemporalStore";
+export * from "./interfaces/interfaces";
+export * from "./services/TemporalFactory";
+export * from "./utils/worker";

package/src/interfaces/TemporalStore.ts

@@ -0,0 +1,9 @@
+export const TEMPORAL_STORE_KEY = "temporal";
+
+export interface ActivityOptions {
+  name?: string;
+}
+
+export interface TemporalStore {
+  activities?: {[propertyKey: string]: ActivityOptions};
+}

package/src/interfaces/interfaces.ts

@@ -0,0 +1,14 @@
+import {ClientOptions, ConnectionOptions} from "@temporalio/client";
+
+declare global {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
+  namespace TsED {
+    interface Configuration {
+      temporal?: {
+        enabled?: boolean;
+        connection?: ConnectionOptions;
+        client?: Omit<ClientOptions, "connection">;
+      };
+    }
+  }
+}

package/src/services/TemporalFactory.ts

@@ -0,0 +1,55 @@
+import {Configuration, registerProvider} from "@tsed/di";
+import {Client, Connection} from "@temporalio/client";
+import {Logger} from "@tsed/common";
+
+export const TemporalConnection = Connection;
+export type TemporalConnection = Connection;
+
+export const TemporalClient = Client;
+export type TemporalClient = Client;
+
+registerProvider({
+  provide: TemporalConnection,
+  deps: [Configuration, Logger],
+  async useAsyncFactory(settings: Configuration, logger: Logger) {
+    const {temporal} = settings;
+    if (!temporal?.enabled) {
+      return null;
+    }
+
+    try {
+      logger.info("Connecting to Temporal Server: ", temporal.connection?.address || "default");
+      const connection = await Connection.connect(temporal.connection);
+      logger.info("... connected to Temporal Server: ", temporal.connection?.address || "default");
+      return connection;
+    } catch (error) {
+      logger.error("Failed to connect to Temporal Server:", error);
+      throw error;
+    }
+  }
+});
+
+registerProvider({
+  provide: TemporalClient,
+  deps: [Configuration, TemporalConnection],
+  useFactory(settings: Configuration, connection: TemporalConnection) {
+    const {temporal} = settings;
+    if (!temporal?.enabled) {
+      return null;
+    }
+
+    const client = new TemporalClient({
+      connection,
+      ...temporal.client
+    });
+
+    return client;
+  },
+  hooks: {
+    $onDestroy: async (client: Client | null) => {
+      if (client) {
+        await client.connection.close();
+      }
+    }
+  }
+});

package/src/utils/worker.ts

@@ -0,0 +1,43 @@
+import {PlatformBuilderSettings, PlatformTest} from "@tsed/common";
+import {$log} from "@tsed/logger";
+
+import {NativeConnection, NativeConnectionOptions, Worker, WorkerOptions} from "@temporalio/worker";
+import {TemporalModule} from "../TemporalModule";
+
+type BootstrapWorkerOptions = {
+  platform?: PlatformBuilderSettings;
+  worker: Omit<WorkerOptions, "activities">;
+  connection?: NativeConnection | NativeConnectionOptions;
+};
+
+export async function bootstrapWorker(mod: any, settings: BootstrapWorkerOptions) {
+  await PlatformTest.bootstrap(mod, settings.platform)();
+  const temporalioModule = PlatformTest.get<TemporalModule>(TemporalModule);
+  const activities = temporalioModule.getActivities();
+  $log.info('Starting temporal worker with queue "%s" and activities:', settings.worker.taskQueue);
+
+  if (Object.keys(activities).length > 0) {
+    $log.printTable(
+      Object.entries(activities).map((x) => ({
+        name: x[0],
+        activity: x[1].toString()
+      }))
+    );
+  }
+
+  let connection: NativeConnection;
+  if (settings.connection instanceof NativeConnection) {
+    connection = settings.connection;
+  } else {
+    $log.info("Connecting to Temporal Server: ", settings.connection?.address || "default");
+    connection = await NativeConnection.connect(settings.connection);
+  }
+
+  const worker = await Worker.create({
+    connection,
+    ...settings.worker,
+    activities
+  });
+
+  return worker;
+}