add dsl example

swyxio · swyxio · commit 24c3fbfd819c · 2021-12-06T12:53:31.000-08:00
diff --git a/.scripts/copy-shared-files.mjs b/.scripts/copy-shared-files.mjs
@@ -7,7 +7,7 @@ const ADDITIONAL_SAMPLES = [];
 // that we don't want to overwrite
 const TSCONFIG_EXCLUDE = ['nextjs-ecommerce-oneclick', 'monorepo-folders', 'fetch-esm', 'production', 'hello-world-js'];
 const GITIGNORE_EXCLUDE = ['nextjs-ecommerce-oneclick', 'monorepo-folders', 'production', 'hello-world-js'];
-const ESLINTRC_EXCLUDE = ['nextjs-ecommerce-oneclick', 'monorepo-folders', 'fetch-esm', 'hello-world-js'];
+const ESLINTRC_EXCLUDE = ['nextjs-ecommerce-oneclick', 'monorepo-folders', 'fetch-esm', 'hello-world-js', 'dsl-interpreter'];
 const ESLINTIGNORE_EXCLUDE = ['production', 'monorepo-folders', 'hello-world-js'];
 
 const POST_CREATE_EXCLUDE = [
diff --git a/README.md b/README.md
@@ -76,6 +76,8 @@ Each directory in this repo is a sample Temporal project built with the [TypeScr
 
 ### Full Apps
 
+- **Control Flow demonstrations**:
+  - [**DSL Interpreter**](https://github.com/temporalio/samples-typescript/tree/main/dsl-interpreter): demonstrates how to make workflows interpret a custom YML based Domain Specific Language.
 - **Next.js**:
   - [**One-click e-commerce**](https://github.com/temporalio/samples-typescript/tree/main/nextjs-ecommerce-oneclick): Buy an item with one click, and the Workflow will wait 5 seconds to see if the user cancels before it executes the order.
   - Food Delivery: https://github.com/lorensr/food-delivery
diff --git a/dsl-interpreter/.eslintignore b/dsl-interpreter/.eslintignore
@@ -0,0 +1,3 @@
+node_modules
+lib
+.eslintrc.js
diff --git a/dsl-interpreter/.eslintrc.js b/dsl-interpreter/.eslintrc.js
@@ -0,0 +1,28 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: './tsconfig.json',
+    tsconfigRootDir: __dirname,
+  },
+  plugins: ['@typescript-eslint', 'deprecation'],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier',
+  ],
+  rules: {
+    '@typescript-eslint/no-unused-vars': [
+      'warn',
+      {
+        argsIgnorePattern: '^_',
+        varsIgnorePattern: '^_',
+      },
+    ],
+    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    'object-shorthand': ['error', 'always'],
+    'deprecation/deprecation': 'warn',
+  },
+};
diff --git a/dsl-interpreter/.gitignore b/dsl-interpreter/.gitignore
@@ -0,0 +1,2 @@
+lib
+node_modules
diff --git a/dsl-interpreter/.npmrc b/dsl-interpreter/.npmrc
@@ -0,0 +1 @@
+package-lock=false
diff --git a/dsl-interpreter/.nvmrc b/dsl-interpreter/.nvmrc
@@ -0,0 +1 @@
+16
diff --git a/dsl-interpreter/.post-create b/dsl-interpreter/.post-create
@@ -0,0 +1,12 @@
+To begin development, start Temporal Server:
+
+  {cyan cd} ~/path/to/temporal/docker-compose/
+  {cyan docker-compose up}
+
+{dim.italic If you haven’t run Temporal Server before, visit:
+https://docs.temporal.io/docs/typescript/getting-started/}
+
+Then, in the project directory, using two other shells, run these commands:
+
+  {cyan npm run start.watch}
+  {cyan npm run workflow}
diff --git a/dsl-interpreter/README.md b/dsl-interpreter/README.md
@@ -0,0 +1,10 @@
+# DSL Interpreter Workflow
+
+This sample demonstrates how to implement a DSL workflow, based on the [Go equivalent](https://github.com/temporalio/samples-go/tree/main/dsl). In this sample, we provide 2 sample yaml files each defines a custom workflow that can be processed by this DSL workflow sample code.
+
+### Running this sample
+
+1. Make sure Temporal Server is running locally (see the [quick install guide](https://docs.temporal.io/docs/server/quick-install/)).
+1. `npm install` to install dependencies.
+1. `npm run start.watch` to start the Worker.
+1. In another terminal, `npm run workflow1` or `npm run `workflow2` to run the Workflows accordingly
diff --git a/dsl-interpreter/package.json b/dsl-interpreter/package.json
@@ -0,0 +1,38 @@
+{
+  "name": "temporal-dsl-interpreter",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "build": "tsc --build",
+    "build.watch": "tsc --build --watch",
+    "start": "ts-node src/worker.ts",
+    "start.watch": "nodemon src/worker.ts",
+    "workflow1": "ts-node src/client.ts ../workflow1.yaml",
+    "workflow2": "ts-node src/client.ts ../workflow2.yaml",
+    "lint": "eslint ."
+  },
+  "nodemonConfig": {
+    "execMap": {
+      "ts": "ts-node"
+    },
+    "ext": "ts",
+    "watch": [
+      "src"
+    ]
+  },
+  "dependencies": {
+    "node-yaml": "^4.0.1",
+    "temporalio": "0.16.x"
+  },
+  "devDependencies": {
+    "@tsconfig/node14": "^1.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-deprecation": "^1.2.1",
+    "nodemon": "^2.0.12",
+    "ts-node": "^10.2.1",
+    "typescript": "^4.4.2"
+  }
+}
diff --git a/dsl-interpreter/src/activities.ts b/dsl-interpreter/src/activities.ts
@@ -0,0 +1,28 @@
+export async function Activity1(arg1: string): Promise<string> {
+  if (!arg1) throw new Error('arg1 is required');
+  console.log`[Activity1] arg1: ${arg1}!`;
+  return `[result from Activity1: ${arg1}]`;
+}
+export async function Activity2(arg: string): Promise<string> {
+  if (!arg) throw new Error('arg is required');
+  console.log`[Activity2] arg: ${arg}!`;
+  return `[result from Activity2: ${arg}]`;
+}
+export async function Activity3(arg2: string, arg: string): Promise<string> {
+  if (!arg2) throw new Error('arg2 is required');
+  return `Activity3 received arg2: ${arg2}: 
+  
+  And received: ${arg}`;
+}
+
+export async function Activity4(result1: string): Promise<string> {
+  if (!result1) throw new Error('result1 is required');
+  console.log`[Activity4] result1: ${result1}!`;
+  return `[result from Activity4: ${result1}]`;
+}
+
+export async function Activity5(arg3: string, result4: string): Promise<string> {
+  return `Activity5 received:
+  arg3: ${arg3}: 
+  result4: ${result4}:`;
+}
diff --git a/dsl-interpreter/src/client.ts b/dsl-interpreter/src/client.ts
@@ -0,0 +1,45 @@
+import { Connection, WorkflowClient } from '@temporalio/client';
+import { DSLInterpreter, DSL } from './workflows';
+// @ts-ignore
+import { read } from 'node-yaml';
+
+let dslInput: DSL = {
+  variables: { arg1: 'value1', arg2: 'value2' },
+  root: {
+    sequence: {
+      elements: [
+        { activity: { name: 'Activity1', arguments: ['arg1'], result: 'result1' } },
+        { activity: { name: 'Activity2', arguments: ['result1'], result: 'result2' } },
+        { activity: { name: 'Activity3', arguments: ['arg2', 'result2'], result: 'result3' } },
+      ],
+    },
+  },
+};
+
+async function run() {
+  const path = process.argv[2];
+  if (path) {
+    dslInput = await read(path);
+    console.log({ dslInput });
+  }
+  const connection = new Connection(); // Connect to localhost with default ConnectionOptions.
+  // In production, pass options to the Connection constructor to configure TLS and other settings.
+  // This is optional but we leave this here to remind you there is a gRPC connection being established.
+
+  const client = new WorkflowClient(connection.service, {
+    // In production you will likely specify `namespace` here; it is 'default' if omitted
+  });
+
+  // Invoke the `DSLInterpreter` Workflow, only resolved when the workflow completes
+  const result = await client.execute(DSLInterpreter, {
+    args: [dslInput], // type inference works! args: [name: string]
+    taskQueue: 'tutorial',
+    workflowId: 'my-business-id',
+  });
+  console.log(result); // Hello, Temporal!
+}
+
+run().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});
diff --git a/dsl-interpreter/src/script.ts b/dsl-interpreter/src/script.ts
@@ -0,0 +1,11 @@
+// @ts-ignore
+import { read } from 'node-yaml';
+let dslInput;
+async function run() {
+  const path = process.argv[2];
+  if (path) {
+    dslInput = await read(path);
+    console.log({ dslInput });
+  }
+}
+run();
diff --git a/dsl-interpreter/src/types.d.ts b/dsl-interpreter/src/types.d.ts
@@ -0,0 +1 @@
+declare module 'node-yaml';
diff --git a/dsl-interpreter/src/worker.ts b/dsl-interpreter/src/worker.ts
@@ -0,0 +1,28 @@
+import { Worker } from '@temporalio/worker';
+import * as activities from './activities';
+
+async function run() {
+  // Step 1: Register Workflows and Activities with the Worker and connect to
+  // the Temporal server.
+  const worker = await Worker.create({
+    workflowsPath: require.resolve('./workflows'),
+    activities,
+    taskQueue: 'tutorial',
+  });
+  // Worker connects to localhost by default and uses console.error for logging.
+  // Customize the Worker by passing more options to create():
+  // https://typescript.temporal.io/api/classes/worker.Worker
+
+  // If you need to configure server connection parameters, see the mTLS example:
+  // https://github.com/temporalio/samples-typescript/tree/main/hello-world-mtls
+
+  // Step 2: Start accepting tasks on the `tutorial` queue
+  await worker.run();
+
+  // You may create multiple Workers in a single process in order to poll on multiple task queues.
+}
+
+run().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});
diff --git a/dsl-interpreter/src/workflows.ts b/dsl-interpreter/src/workflows.ts
@@ -0,0 +1,55 @@
+import { proxyActivities } from '@temporalio/workflow';
+// Only import the activity types
+import type * as activities from './activities';
+
+export type DSL = {
+  variables: Record<string, string>; // could be string | number?
+  root: Statement;
+};
+
+type Sequence = {
+  elements: Statement[];
+};
+type ActivityInvocation = {
+  name: string;
+  arguments?: string[];
+  result?: string;
+};
+type Parallel = {
+  branches: Statement[];
+};
+
+type Statement = { activity: ActivityInvocation } | { sequence: Sequence } | { parallel: Parallel };
+
+const acts = proxyActivities<typeof activities>({
+  startToCloseTimeout: '1 minute',
+}) as Record<string, (...args: string[]) => Promise<string | undefined>>;
+
+/** A workflow that simply calls an activity */
+export async function DSLInterpreter(dsl: DSL): Promise<any> {
+  return execute(dsl.root);
+}
+
+async function execute(statement: Statement): Promise<string | undefined> {
+  const results = {} as Record<string, string | undefined>;
+  // console.log(statement)
+  if ('parallel' in statement) {
+    await Promise.all(statement.parallel.branches.map(execute));
+    // todo: if one activity fails we want to cancel all the others
+  } else if ('sequence' in statement) {
+    let result: string | undefined;
+    for (const el of statement.sequence.elements) {
+      result = await execute(el);
+    }
+    return result;
+  } else {
+    const activity = statement.activity;
+    let args = activity.arguments || [];
+    args = args.map((arg) => results[arg] ?? arg);
+    const activityResult = await acts[activity.name](...args);
+    if (activity.result) {
+      results[activity.result] = activityResult;
+    }
+    return activityResult;
+  }
+}
diff --git a/dsl-interpreter/tsconfig.json b/dsl-interpreter/tsconfig.json
@@ -0,0 +1,13 @@
+{
+  "extends": "@tsconfig/node16/tsconfig.json",
+  "version": "4.4.2",
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "rootDir": "./src",
+    "outDir": "./lib"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules"]
+}
diff --git a/dsl-interpreter/workflow1.yaml b/dsl-interpreter/workflow1.yaml
@@ -0,0 +1,28 @@
+# This sample workflows execute 3 steps in sequence.
+# 1) Activity1, takes arg1 as input, and put result as result1.
+# 2) Activity2, takes result1 as input, and put result as result2.
+# 3) Activity3, takes args2 and result2 as input, and put result as result3.
+
+variables:
+  arg1: value1
+  arg2: value2
+
+root:
+  sequence:
+    elements:
+     - activity:
+        name: Activity1
+        arguments:
+          - arg1
+        result: result1
+     - activity:
+        name: Activity2
+        arguments:
+          - result1
+        result: result2
+     - activity:
+        name: Activity3
+        arguments:
+          - arg2
+          - result2
+        result: result3
diff --git a/dsl-interpreter/workflow2.yaml b/dsl-interpreter/workflow2.yaml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+node_modules`
	`2`	`+lib`
	`3`	`+.eslintrc.js`