Merge pull request #1 from conductor-sdk/added-examples

Added examples

jest.config.js

@@ -0,0 +1,196 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+  preset: 'ts-jest',
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/r5/s0779_114sj3t6j4m3mkn5xr0000gn/T/jest_dx",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: [
+    "**/__tests__/**/*.test.[jt]s?(x)",
+    "**/?(*.)+(spec|test).[tj]s?(x)"
+  ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

package.json

@@ -0,0 +1,42 @@
+{
+  "name": "typescript-sdk-examples",
+  "version": "1.0.0",
+  "main": "index.js",
+  "repository": "git@github.com:conductor-sdk/typescript-sdk-examples.git",
+  "author": "James Stuart Milne <jstuartmilne@gmail.com>",
+  "license": "MIT",
+  "dependencies": {
+    "@io-orkes/conductor-typescript": "^0.0.2",
+    "node-fetch": "^2.6.7",
+    "npm-user": "^5.0.0"
+  },
+  "scripts": {
+    "test": "jest"
+  }, 
+  "devDependencies": {
+    "@tsconfig/node16": "^1.0.2",
+    "@types/node": "^17.0.30",
+    "@types/node-fetch": "^2.6.1",
+    "@typescript-eslint/eslint-plugin": "^5.23.0",
+    "@typescript-eslint/parser": "^5.23.0",
+    "eslint": "^6.1.0",
+    "jest": "^28.1.0",
+    "ts-jest": "^28.0.1",
+    "ts-node": "^10.7.0",
+    "tsup": "^5.12.6",
+    "typescript": "^4.6.4"
+  },
+  "tsup": {
+    "target": "node16",
+    "sourcemap": true,
+    "format": [
+      "esm",
+      "cjs"
+    ],
+    "dts": true,
+    "clean": true
+  },
+  "engines": {
+    "node": ">=16"
+  }
+}

sendEmailUsingGenerator.test.ts

@@ -0,0 +1,83 @@
+import { expect, describe, test, afterAll } from "@jest/globals";
+import { createSimpleWorkflow, createComplexWf } from "./workflowCreator";
+import { userInfoWorker, sendEmailWorker, sendSMSWorker } from "./workers";
+import {
+  OrkesApiConfig,
+  orkesConductorClient,
+  TaskManager,
+  TaskType,
+  WorkflowExecutor,
+} from "@io-orkes/conductor-typescript";
+
+const playConfig: Partial<OrkesApiConfig> = {
+  keyId:"",
+  keySecret:"",
+  serverUrl: "https://play.orkes.io/api",
+};
+
+describe("Should create workflow Simple", () => {
+  const clientPromise = orkesConductorClient(playConfig);
+  const simpleWf = createSimpleWorkflow();
+  test("Creates a simple worker", async () => {
+    const client = await clientPromise;
+    const workflowExecutor = new WorkflowExecutor(client);
+    await expect(
+      workflowExecutor.registerWorkflow(true, simpleWf)
+    ).resolves.not.toThrowError();
+  });
+  test("Start the workers and runs worklfow", async () => {
+    const client = await clientPromise;
+    const runner = new TaskManager(client, [
+      userInfoWorker(),
+      sendEmailWorker(),
+    ]);
+    runner.startPolling();
+
+    const workflowExecutor = new WorkflowExecutor(client);
+    const executionId = await workflowExecutor.startWorkflow({
+      name: simpleWf.name,
+      version: simpleWf.version,
+      input: { userId: "jim" },
+    });
+    await new Promise((r) => setTimeout(() => r(true), 2000));
+    const workflowStatus = await workflowExecutor.getWorkflow(
+      executionId,
+      true
+    );
+    runner.stopPolling();
+  });
+});
+
+describe("Should create workflow Complex", () => {
+  const clientPromise = orkesConductorClient(playConfig);
+  const simpleWf = createComplexWf();
+  test("Creates a simple worker", async () => {
+    const client = await clientPromise;
+    const workflowExecutor = new WorkflowExecutor(client);
+    await expect(
+      workflowExecutor.registerWorkflow(true, simpleWf)
+    ).resolves.not.toThrowError();
+  });
+  test("Start the workers and runs worklfow", async () => {
+    const client = await clientPromise;
+    const runner = new TaskManager(client, [
+      userInfoWorker(),
+      sendEmailWorker(),
+      sendSMSWorker()
+    ]);
+    runner.startPolling();
+
+    const workflowExecutor = new WorkflowExecutor(client);
+    const executionId = await workflowExecutor.startWorkflow({
+      name: simpleWf.name,
+      version: simpleWf.version,
+      input: { userId: "jim", notificationPref: "sms" },
+    });
+    await new Promise((r) => setTimeout(() => r(true), 3000));
+    const workflowStatus = await workflowExecutor.getWorkflow(
+      executionId,
+      true
+    );
+    runner.stopPolling();
+  });
+});

workers.ts

@@ -0,0 +1,53 @@
+import {
+  TaskRunner,
+  ConductorClient,
+  generate,
+  generateHTTPTask,
+  generateInlineTask,
+  TaskType,
+  WorkflowDef,
+  RunnerArgs,
+  ConductorWorker,
+} from "@io-orkes/conductor-typescript";
+
+export const userInfoWorker = (): ConductorWorker => {
+  return {
+    taskDefName: "get_user_info",
+    execute: async ({ inputData }) => {
+      const userId = inputData?.userId;
+      return {
+        outputData: {
+          email: `${userId}@email.com`,
+          phoneNumber: "555-555-5555",
+        },
+        status: "COMPLETED",
+      };
+    },
+  };
+};
+
+export const sendEmailWorker = (): ConductorWorker => {
+  return {
+    taskDefName: "send_email",
+    execute: async ({ inputData }) => {
+      const email = inputData?.email;
+      console.log("SENDING EMAIL TO " + email);
+      return {
+        status: "COMPLETED",
+      };
+    },
+  };
+};
+
+export const sendSMSWorker = (): ConductorWorker => {
+  return {
+    taskDefName: "send_sms",
+    execute: async ({ inputData }) => {
+      const phoneNumber = inputData?.phoneNumber;
+      console.log("SENDING SMS TO " + phoneNumber);
+      return {
+        status: "COMPLETED",
+      };
+    },
+  };
+};