@sketchmonk/tempest-worker

@sketchmonk/tempest-worker is a Nest.js worker wrapper that simplifies the integration of Temporal workers into your Nest.js applications. Temporal is a powerful workflow and event sourcing framework that allows you to build resilient, scalable, and distributed applications.

Installation

You can install @sketchmonk/tempest-worker using npm or yarn:

npm install @sketchmonk/tempest-worker
# or
yarn add @sketchmonk/tempest-worker

Configuration

To configure @sketchmonk/tempest-worker, you can add it to the imports array of your Nest.js application module. This code example demonstrates how to set up the worker module:

import { Module } from '@nestjs/common';
import { TemporalWorkerModule } from '@sketchmonk/tempest-worker';
import { NativeConnection } from '@temporalio/worker';
import { ActivityService } from './activities/activity.service';
import { ActivityModule } from './activities/activity.module';

@Module({
  imports: [
    TemporalWorkerModule.registerAsync({
      imports: [ActivityModule],
      inject: [ActivityService],
      async useFactory(activityService: ActivityService) {
        const connection = await NativeConnection.connect({
          address: 'localhost:7233', // Replace with your Temporal cluster address
        });
        return {
          connection,
          activities: {
            add: activityService.add.bind(activityService),
            subtract: activityService.subtract.bind(activityService),
            multiply: activityService.multiply.bind(activityService),
            divide: activityService.divide.bind(activityService),
          },
          namespace: 'tempest', // Replace with your desired namespace
          taskQueue: 'math',
          workflowsPath: require.resolve('./workflows'), // Specify the path to your workflows
        };
      },
    }),
  ],
  // ...
})
export class AppModule {}

In this example, you configure the @sketchmonk/tempest-worker module by providing the necessary connection details, activities, namespace, task queue, and workflows path. Make sure to replace the cluster address, namespace, and other configurations with your specific settings.

Usage

You can use @sketchmonk/tempest-worker in conjunction with the @nestjs/common module structure. Here's an example of an activity service:

// activity service
import { Injectable } from "@nestjs/common";
import { HttpFailure } from "@sketchmonk/tempest-common";

@Injectable()
export class ActivityService {
    async add(a: number, b: number): Promise<number> {
        return a + b;
    }
    async subtract(a: number, b: number): Promise<number> {
        return a - b;
    }
    async multiply(a: number, b: number): Promise<number> {
        return a * b;
    }
    async divide(a: number, b: number): Promise<number> {
        if (b === 0) {
            throw new HttpFailure("Cannot divide by zero", "DIVIDE_BY_ZERO", 400);
        }
        return a / b;
    }
}

And the corresponding activity module:

// activity module
import { Module } from "@nestjs/common";
import { ActivityService } from "./activity.service";

@Module({
    providers: [ActivityService],
    exports: [ActivityService],
})
export class ActivityModule {}

These code snippets demonstrate how to create an activity service and module for use with Temporal workers. Activities are functions that can be executed asynchronously by Temporal workflows.

Feel free to adapt and customize the code to match your specific workflows and activities.

Contributing

Contributions to @sketchmonk/tempest-worker are welcome. If you encounter issues, have suggestions, or want to add new features, please open an issue or submit a pull request on GitHub.

License

This package is licensed under the MIT License. See the LICENSE file for details.

Author

@sketchmonk/tempest-worker is developed and maintained by Sketchmonk. If you have any questions or need assistance, please feel free to contact me at [email protected].