VilledeMontreal · OlivierAlbertini · Feb 27, 2024 · Jan 11, 2024
diff --git a/examples/basic/README.md b/examples/basic/README.md
@@ -11,6 +11,30 @@ $ # from this directory
 $ npm install
 ```
 
+### Configuring Step function
+
+#### Deploying new workflow
+
+##### Use CloudFormation and the AWS CDK (recommanded)
+
+Todo: provide steps
+
+##### Manually
+
+In `examples/basic/bpmn/stepfunction/BPMN_DEMO.json`, you will need to specify the `QueueUrl` and in `examples/basic/src/deploy.ts` , you must specify the `roleArn` to use for deploying the new workflow.
+
+Notice that you can skip this step if you deploy the workflow through the AWS Step function UI and it won't be necessary to run `npm run deploy`
+
+### For All files
+
+You must specify the following environment variables :
+
+- AWS_REGION
+- AWS_ACCESS_KEY_ID
+- AWS_SECRET_ACCESS_KEY
+- AWS_SQS_QUEUE_URL
+- AWS_SQS_WAIT_TIME_SECONDS (Optional)
+
 (Optional) Setup, we can switch to `TAG.camundaBpm` or `TAG.stepFunction` in order to use both plateform (some comments are added in the example).
 
 ```sh
@@ -22,12 +46,12 @@ $ npm run build
 
 ```sh
 $ # from this directory
-$ # deploy a bpmn provided in the example
-$ npm camunda:deploy
+$ # deploy the workflow provided in the example
+$ npm run deploy
 $ # create instance(s)
-$ npm camunda:create-instance
+$ npm run create-instance
 $ # run worker
-$ npm camunda:worker
+$ npm run worker
 ```
 
 ## Useful links

diff --git a/examples/basic/bpmn/stepfunction/BPMN_DEMO.json b/examples/basic/bpmn/stepfunction/BPMN_DEMO.json
@@ -0,0 +1,37 @@
+{
+    "Comment": "A description of my state machine",
+    "StartAt": "Activity",
+    "States": {
+      "Activity": {
+        "Type": "Task",
+        "Resource": "arn:aws:states:::sqs:sendMessage.waitForTaskToken",
+        "Parameters": {
+          "MessageBody": {
+            "body.$": "$",
+            "properties": {
+              "activityId": "sample_activity",
+              "retries.$": "$$.State.RetryCount",
+              "bpmnProcessId.$": "$$.StateMachine.Id",
+              "jobKey.$": "$$.Task.Token",
+              "workflowInstanceKey.$": "$$.Execution.Id"
+            }
+          },
+          "QueueUrl": "<YOUR QUEUE URL>"
+        },
+        "End": true,
+        "Retry": [
+          {
+            "ErrorEquals": [
+              "States.ALL"
+            ],
+            "BackoffRate": 2,
+            "IntervalSeconds": 1,
+            "MaxAttempts": 5,
+            "Comment": "Basic Retrier"
+          }
+        ],
+        "HeartbeatSeconds": 30,
+        "TimeoutSeconds": 200
+      }
+    }
+  }
diff --git a/examples/basic/package.json b/examples/basic/package.json
@@ -16,31 +16,31 @@
     "lint": "eslint . --ext .ts && prettier -l \"src/**/*.ts\"",
     "lint-fix": "prettier \"./**/*.ts\" --write && eslint . --ext .ts --fix",
     "check-conflicts": "eslint --print-config tests/utils/func-test.ts | eslint-config-prettier-check",
-    "camunda:deploy": "node ./lib/src/deploy.js",
-    "camunda:create-instance": "node ./lib/src/create-process-instances.js",
-    "camunda:worker": "node ./lib/src/worker.js"
+    "deploy": "node ./lib/src/deploy.js",
+    "create-instance": "node ./lib/src/create-process-instances.js",
+    "worker": "node ./lib/src/worker.js"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/VilledeMontreal/workit.git"
   },
   "devDependencies": {
-    "@types/node": "^20.10.4",
-    "@typescript-eslint/eslint-plugin": "^6.14.0",
-    "@typescript-eslint/parser": "^6.14.0",
-    "eslint": "^8.55.0",
+    "@types/node": "^20.10.8",
+    "@typescript-eslint/eslint-plugin": "^6.18.1",
+    "@typescript-eslint/parser": "^6.18.1",
+    "eslint": "^8.56.0",
     "eslint-config-airbnb-typescript": "^17.1.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-header": "^3.1.1",
-    "eslint-plugin-import": "^2.29.0",
-    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.3",
     "prettier": "^3.1.1",
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "@villedemontreal/workit": "^6.0.0-dev",
-    "@villedemontreal/workit-core": "^6.0.0-dev",
-    "@villedemontreal/workit-types": "^6.0.0-dev",
+    "@villedemontreal/workit": "6.0.2-dev",
+    "@villedemontreal/workit-core": "6.0.2-dev",
+    "@villedemontreal/workit-types": "6.0.2-dev",
     "axios": "^1.6.2"
   },
   "keywords": [

diff --git a/examples/basic/src/create-process-instances.ts b/examples/basic/src/create-process-instances.ts
@@ -1,24 +1,34 @@
 /*
- * Copyright (c) 2023 Ville de Montreal. All rights reserved.
+ * Copyright (c) 2024 Ville de Montreal. All rights reserved.
  * Licensed under the MIT license.
  * See LICENSE file in the project root for full license information.
  */
 
+// you can pass value here or an another (safer) way
+// process.env.AWS_REGION = 'us-east-1';
+// process.env.AWS_ACCESS_KEY_ID = '<AWS_ACCESS_KEY_ID>';
+// process.env.AWS_SECRET_ACCESS_KEY = '<AWS_SECRET_ACCESS_KEY>';
+// process.env.AWS_SQS_WAIT_TIME_SECONDS = '20';
+
 import { SERVICE_IDENTIFIER as CORE_IDENTIFIER, TAG } from '@villedemontreal/workit';
 import { IoC } from '@villedemontreal/workit-core';
 import { IWorkflowClient } from '@villedemontreal/workit-types';
 
 (async (): Promise<void> => {
-  const cm = IoC.get<IWorkflowClient>(CORE_IDENTIFIER.client_manager, TAG.camundaBpm);
+  const platform = TAG.stepFunction;
+  const cm = IoC.get<IWorkflowClient>(CORE_IDENTIFIER.client_manager, platform);
   for (let index = 0; index < 1; index += 1) {
     await cm.createWorkflowInstance({
-      bpmnProcessId: 'BPMN_DEMO',
+      bpmnProcessId:
+        platform === TAG.camundaBpm
+          ? 'BPMN_DEMO'
+          : `arn:aws:states:${process.env.AWS_REGION}:<YOUR-AWS-ACCOUNT-ID>:stateMachine:Basic-Exemple`,
       variables: {
         amount: 1000,
         hello: 'world',
       },
     });
   }
 
-  console.log('Success!');
+  console.info('Success!');
 })();
diff --git a/examples/basic/src/deploy.ts b/examples/basic/src/deploy.ts
@@ -1,15 +1,44 @@
 /*
- * Copyright (c) 2023 Ville de Montreal. All rights reserved.
+ * Copyright (c) 2024 Ville de Montreal. All rights reserved.
  * Licensed under the MIT license.
  * See LICENSE file in the project root for full license information.
  */
+
+// you can pass value here or an another (safer) way
+// process.env.AWS_REGION = 'us-east-1';
+// process.env.AWS_SQS_QUEUE_URL = '<SQS_QUEUE_URL>'
+// process.env.AWS_ACCESS_KEY_ID = '<AWS_ACCESS_KEY_ID>';
+// process.env.AWS_SECRET_ACCESS_KEY = '<AWS_SECRET_ACCESS_KEY>';
+// process.env.AWS_SQS_WAIT_TIME_SECONDS = '20';
+
 import { SERVICE_IDENTIFIER as CORE_IDENTIFIER, TAG } from '@villedemontreal/workit';
-import { IoC } from '@villedemontreal/workit-core';
-import { IWorkflowClient } from '@villedemontreal/workit-types';
-
-(async (): Promise<void> => {
-  const cm = IoC.get<IWorkflowClient>(CORE_IDENTIFIER.client_manager, TAG.camundaBpm);
-  const path = `${process.cwd()}/bpmn/BPMN_DEMO.bpmn`;
-  await cm.deployWorkflow(path);
-  console.log('Success!');
-})();
+import { IoC, Worker } from '@villedemontreal/workit-core';
+import { HelloWorldTask } from '../tasks/helloWorldTask';
+
+enum LOCAL_IDENTIFIER {
+  sampleActivity = 'Get credit limit',
+}
+
+IoC.bindTo(HelloWorldTask, LOCAL_IDENTIFIER.sampleActivity);
+const worker = IoC.get<Worker>(CORE_IDENTIFIER.worker, TAG.stepFunction);
+
+const stop = (): void => {
+  console.info('SIGTERM signal received.');
+  console.log('Closing worker');
+  worker
+    .stop()
+    .then(() => {
+      console.log('worker closed');
+      process.exit(0);
+    })
+    .catch((e: Error) => {
+      console.log(e);
+      process.exit(1);
+    });
+};
+
+worker.start();
+worker.run();
+
+process.on('SIGINT', stop);
+process.on('SIGTERM', stop);
diff --git a/examples/basic/src/worker.ts b/examples/basic/src/worker.ts
@@ -1,8 +1,12 @@
 /*
- * Copyright (c) 2023 Ville de Montreal. All rights reserved.
+ * Copyright (c) 2024 Ville de Montreal. All rights reserved.
  * Licensed under the MIT license.
  * See LICENSE file in the project root for full license information.
  */
+// process.env.AWS_REGION = 'us-east-1';
+// process.env.AWS_ACCESS_KEY_ID = '<AWS_ACCESS_KEY_ID>';
+// process.env.AWS_SECRET_ACCESS_KEY = '<AWS_SECRET_ACCESS_KEY>';
+// process.env.AWS_SQS_WAIT_TIME_SECONDS = '20';
 
 import { SERVICE_IDENTIFIER as CORE_IDENTIFIER, TAG } from '@villedemontreal/workit';
 import { IoC, Worker } from '@villedemontreal/workit-core';

diff --git a/examples/basic/tasks/helloWorldTask.ts b/examples/basic/tasks/helloWorldTask.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Ville de Montreal. All rights reserved.
+ * Copyright (c) 2024 Ville de Montreal. All rights reserved.
  * Licensed under the MIT license.
  * See LICENSE file in the project root for full license information.
  */
@@ -13,7 +13,8 @@ export class HelloWorldTask extends TaskBase<IMessage> {
     const { properties } = message;
 
     console.log(`Executing task: ${properties.activityId}`);
-    console.log(`${properties.bpmnProcessId}::${properties.processInstanceId} Servus!`);
+    console.log(properties);
+    console.log(`${properties.bpmnProcessId}::${properties.workflowInstanceKey} Servus!`);
 
     const response = await axios.get('https://jsonplaceholder.typicode.com/todos/1');
 

diff --git a/examples/binding/package.json b/examples/binding/package.json
@@ -25,22 +25,22 @@
     "url": "git+https://github.com/VilledeMontreal/workit.git"
   },
   "devDependencies": {
-    "@types/node": "^20.10.4",
-    "@typescript-eslint/eslint-plugin": "^6.14.0",
-    "@typescript-eslint/parser": "^6.14.0",
-    "eslint": "^8.55.0",
+    "@types/node": "^20.10.8",
+    "@typescript-eslint/eslint-plugin": "^6.18.1",
+    "@typescript-eslint/parser": "^6.18.1",
+    "eslint": "^8.56.0",
     "eslint-config-airbnb-typescript": "^17.1.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-header": "^3.1.1",
-    "eslint-plugin-import": "^2.29.0",
-    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.3",
     "prettier": "^3.1.1",
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "@villedemontreal/workit": "^6.0.0-dev",
-    "@villedemontreal/workit-core": "^6.0.0-dev",
-    "@villedemontreal/workit-types": "^6.0.0-dev",
+    "@villedemontreal/workit": "6.0.2-dev",
+    "@villedemontreal/workit-core": "6.0.2-dev",
+    "@villedemontreal/workit-types": "6.0.2-dev",
     "axios": "^1.6.2"
   },
   "keywords": [

diff --git a/examples/binding/src/create-process-instances.ts b/examples/binding/src/create-process-instances.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Ville de Montreal. All rights reserved.
+ * Copyright (c) 2024 Ville de Montreal. All rights reserved.
  * Licensed under the MIT license.
  * See LICENSE file in the project root for full license information.
  */

diff --git a/examples/binding/src/deploy.ts b/examples/binding/src/deploy.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Ville de Montreal. All rights reserved.
+ * Copyright (c) 2024 Ville de Montreal. All rights reserved.
  * Licensed under the MIT license.
  * See LICENSE file in the project root for full license information.
  */

diff --git a/examples/binding/src/worker.ts b/examples/binding/src/worker.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Ville de Montreal. All rights reserved.
+ * Copyright (c) 2024 Ville de Montreal. All rights reserved.
  * Licensed under the MIT license.
  * See LICENSE file in the project root for full license information.
  */

diff --git a/examples/binding/tasks/helloWorldTask.ts b/examples/binding/tasks/helloWorldTask.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Ville de Montreal. All rights reserved.
+ * Copyright (c) 2024 Ville de Montreal. All rights reserved.
  * Licensed under the MIT license.
  * See LICENSE file in the project root for full license information.
  */

diff --git a/examples/binding/tasks/helloWorldTaskV2.ts b/examples/binding/tasks/helloWorldTaskV2.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Ville de Montreal. All rights reserved.
+ * Copyright (c) 2024 Ville de Montreal. All rights reserved.
  * Licensed under the MIT license.
  * See LICENSE file in the project root for full license information.
  */

diff --git a/examples/binding/tasks/helloWorldTaskV3.ts b/examples/binding/tasks/helloWorldTaskV3.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Ville de Montreal. All rights reserved.
+ * Copyright (c) 2024 Ville de Montreal. All rights reserved.
  * Licensed under the MIT license.
  * See LICENSE file in the project root for full license information.
  */

diff --git a/examples/event/package.json b/examples/event/package.json
@@ -25,22 +25,22 @@
     "url": "git+https://github.com/VilledeMontreal/workit.git"
   },
   "devDependencies": {
-    "@types/node": "^20.10.4",
-    "@typescript-eslint/eslint-plugin": "^6.14.0",
-    "@typescript-eslint/parser": "^6.14.0",
-    "eslint": "^8.55.0",
+    "@types/node": "^20.10.8",
+    "@typescript-eslint/eslint-plugin": "^6.18.1",
+    "@typescript-eslint/parser": "^6.18.1",
+    "eslint": "^8.56.0",
     "eslint-config-airbnb-typescript": "^17.1.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-header": "^3.1.1",
-    "eslint-plugin-import": "^2.29.0",
-    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.3",
     "prettier": "^3.1.1",
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "@villedemontreal/workit": "^6.0.0-dev",
-    "@villedemontreal/workit-core": "^6.0.0-dev",
-    "@villedemontreal/workit-types": "^6.0.0-dev",
+    "@villedemontreal/workit": "6.0.2-dev",
+    "@villedemontreal/workit-core": "6.0.2-dev",
+    "@villedemontreal/workit-types": "6.0.2-dev",
     "axios": "^1.6.2"
   },
   "keywords": [

diff --git a/examples/event/src/create-process-instances.ts b/examples/event/src/create-process-instances.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Ville de Montreal. All rights reserved.
+ * Copyright (c) 2024 Ville de Montreal. All rights reserved.
  * Licensed under the MIT license.
  * See LICENSE file in the project root for full license information.
  */

diff --git a/examples/event/src/deploy.ts b/examples/event/src/deploy.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Ville de Montreal. All rights reserved.
+ * Copyright (c) 2024 Ville de Montreal. All rights reserved.
  * Licensed under the MIT license.
  * See LICENSE file in the project root for full license information.
  */

diff --git a/examples/event/src/worker.ts b/examples/event/src/worker.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Ville de Montreal. All rights reserved.
+ * Copyright (c) 2024 Ville de Montreal. All rights reserved.
  * Licensed under the MIT license.
  * See LICENSE file in the project root for full license information.
  */

diff --git a/examples/event/tasks/helloWorldTask.ts b/examples/event/tasks/helloWorldTask.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Ville de Montreal. All rights reserved.
+ * Copyright (c) 2024 Ville de Montreal. All rights reserved.
  * Licensed under the MIT license.
  * See LICENSE file in the project root for full license information.
  */