@tsed/temporal 8.0.0 → 8.0.2

package/package.json

@@ -2,13 +2,14 @@
   "name": "@tsed/temporal",
   "description": "Temporal.io package for Ts.ED framework",
   "type": "module",
-  "version": "8.0.0",
+  "version": "8.0.2",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
   "typings": "./lib/types/index.d.ts",
   "exports": {
     ".": {
+      "@tsed/source": "./src/index.ts",
       "types": "./lib/types/index.d.ts",
       "import": "./lib/esm/index.js",
       "default": "./lib/esm/index.js"
@@ -28,11 +29,11 @@
     "@temporalio/client": "1.8.4",
     "@temporalio/testing": "1.8.4",
     "@temporalio/worker": "1.8.4",
-    "@tsed/barrels": "8.0.0",
-    "@tsed/core": "8.0.0",
-    "@tsed/di": "8.0.0",
-    "@tsed/platform-http": "8.0.0",
-    "@tsed/typescript": "8.0.0",
+    "@tsed/barrels": "8.0.2",
+    "@tsed/core": "8.0.2",
+    "@tsed/di": "8.0.2",
+    "@tsed/platform-http": "8.0.2",
+    "@tsed/typescript": "8.0.2",
     "cross-env": "7.0.3",
     "eslint": "9.12.0",
     "typescript": "5.4.5",

package/src/TemporalModule.ts

@@ -0,0 +1,40 @@
+import {classOf} from "@tsed/core";
+import {Inject, InjectorService, Module, Provider} from "@tsed/di";
+import {Logger} from "@tsed/logger";
+
+import {PROVIDER_TYPE_TEMPORAL} from "./constants.js";
+import {TEMPORAL_STORE_KEY, TemporalStore} from "./interfaces/TemporalStore.js";
+import {TemporalClient} from "./services/TemporalFactory.js";
+
+@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,41 @@
+import {Store} from "@tsed/core";
+
+import {Activity} from "./activity.js";
+import {Temporal} from "./temporal.js";
+
+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,15 @@
+import {Store} from "@tsed/core";
+
+import {ActivityOptions, TEMPORAL_STORE_KEY, TemporalStore} from "../interfaces/TemporalStore.js";
+
+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,12 @@
+import {GlobalProviders} from "@tsed/di";
+
+import {Temporal} from "./temporal.js";
+
+describe("@Activity()", () => {
+  it("should set metadata", () => {
+    @Temporal()
+    class Test {}
+
+    expect(GlobalProviders.get(Test)?.useClass).toEqual(Test);
+  });
+});

package/src/decorators/temporal.ts

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

package/src/index.ts

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

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,13 @@
+import {ClientOptions, ConnectionOptions} from "@temporalio/client";
+
+declare global {
+  namespace TsED {
+    interface Configuration {
+      temporal?: {
+        enabled?: boolean;
+        connection?: ConnectionOptions;
+        client?: Omit<ClientOptions, "connection">;
+      };
+    }
+  }
+}

package/src/services/TemporalFactory.ts

@@ -0,0 +1,56 @@
+import {Client, Connection} from "@temporalio/client";
+import {Configuration, registerProvider} from "@tsed/di";
+import {Logger} from "@tsed/logger";
+
+export const TemporalConnection = Connection;
+export type TemporalConnection = Connection;
+
+export const TemporalClient = Client;
+export type TemporalClient = Client;
+
+registerProvider({
+  token: TemporalConnection,
+  deps: [Configuration, Logger],
+  async useAsyncFactory(settings: Configuration, logger: Logger) {
+    const temporal = settings.get("temporal");
+
+    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({
+  token: TemporalClient,
+  deps: [Configuration, TemporalConnection],
+  useFactory(settings: Configuration, connection: TemporalConnection) {
+    const temporal = settings.get("temporal");
+    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,45 @@
+import {NativeConnection, NativeConnectionOptions, Worker, WorkerOptions} from "@temporalio/worker";
+import {$log} from "@tsed/logger";
+import {PlatformBuilderSettings} from "@tsed/platform-http";
+import {PlatformTest} from "@tsed/platform-http/testing";
+
+import {TemporalModule} from "../TemporalModule.js";
+
+type BootstrapWorkerOptions = {
+  platform?: PlatformBuilderSettings;
+  worker: Omit<WorkerOptions, "activities">;
+  connection?: NativeConnection | NativeConnectionOptions;
+};
+
+export async function bootstrapWorker(mod: any, settings: BootstrapWorkerOptions) {
+  // TODO remove this code and use production
+  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;
+}