Camunda cloud oauth (#68)

Camunda cloud oauth

Author: s3than

.circleci/config.yml

@@ -33,7 +33,7 @@ jobs:
   test:
     docker:
       - image: circleci/node:11.10.1
-      - image: camunda/zeebe:0.20.0
+      - image: camunda/zeebe:SNAPSHOT
     working_directory: ~/zeebe-client-node-js
     steps:
       - checkout

.vscode/settings.json

@@ -1,10 +1,20 @@
 {
-	"workbench.colorCustomizations": {
-		"activityBar.background": "#0B3330",
-		"titleBar.activeBackground": "#0F4844",
-		"titleBar.activeForeground": "#F4FDFC"
-	},
 	"editor.codeActionsOnSave": {
 		"source.organizeImports": true
-	}
+	},
+	"workbench.colorCustomizations": {
+		"activityBar.background": "#8a2ca2",
+		"activityBar.foreground": "#e7e7e7",
+		"activityBar.inactiveForeground": "#e7e7e799",
+		"activityBarBadge.background": "#af9530",
+		"activityBarBadge.foreground": "#15202b",
+		"titleBar.activeBackground": "#68217a",
+		"titleBar.inactiveBackground": "#68217a99",
+		"titleBar.activeForeground": "#e7e7e7",
+		"titleBar.inactiveForeground": "#e7e7e799",
+		"statusBar.background": "#68217a",
+		"statusBarItem.hoverBackground": "#8a2ca2",
+		"statusBar.foreground": "#e7e7e7"
+	},
+	"peacock.color": "#68217A"
 }

CHANGELOG.md

@@ -1,9 +1,20 @@
+# Version v0.21
+
+• Add long polling support. See [#64](https://github.com/creditsenseau/zeebe-client-node-js/issues/64).
+• @TODO: Add authentication via JWT.
+
+# Version v0.20
+
+• Add TLS support (Thanks Colin from the Camunda Cloud Team!).
+• Remove node-grpc-client dependency.
+• Change versioning to match Broker versioning (Thanks Tim!).
+
 # Version 2.4.0
 
 • Update for Zeebe 0.18.
 • Remove `ZBClient.listWorkflows` and `ZBClient.getWorkflow` - the broker no longer provides a query API.
 • Remove `{redeploy: boolean}` option from `ZBClient.deployWorkflow` method. This relies on `listWorkflows`. This will be the default behaviour in a future release of Zeebe. See [zeebe/#1159](https://github.com/zeebe-io/zeebe/issues/1159).
-• Add client-side retry logic. Retries ZBClient gRPC command methods on failure due to [gRPC error code 14](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md) (Transient Network Error). See [#40](https://github.com/creditsenseau/zeebe-client-node-js/issues/40).
+• Add client-side retry logic. Retries ZBClient gRPC command methods on failure due to [gRPC error code 14](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md) (Transient Network Error). See [#41](https://github.com/creditsenseau/zeebe-client-node-js/issues/40).
 
 # Version 1.2.0
 

README.md

@@ -13,6 +13,8 @@ Docker-compose configurations for Zeebe are available at [https://github.com/zee
 
 To enable that the client libraries can be easily supported to the Zeebe server we are remapping the version numbers, so that Major, Minor match the server application. Patches will be independent and indicate client updates.
 
+NPM Package version 0.21.x supports Zeebe 0.21.x
+
 NPM Package version 0.20.x supports Zeebe 0.20.x
 
 NPM Package version 0.19.x supports Zeebe 0.19.x
@@ -25,6 +27,10 @@ NPM Package version 1.x.x supports Zeebe 0.15/0.16.
 
 Protobuf fields of type `int64` are serialised as type string in the Node library. These fields are serialised as numbers (long) in the Go and Java client. See [grpc/#7229](https://github.com/grpc/grpc/issues/7229) for why the Node library serialises them as string. The Workflow instance key, and other fields that are of type long in other client libraries, are type string in this library. Fields of type `int32` are serialised as type number in the Node library.
 
+## Scaffolding code from a BPM file
+
+You can scaffold your worker code from a BPMN file with the `bin/zeebe-node-cli` command. Pass in the path to the BPMN file, and it will produce a file to implement it.
+
 ## Example Use
 
 ### Add the Library to your Project
@@ -85,14 +91,23 @@ const zbc = new ZB.ZBClient(gatewayAddress, {
 
 Retry is provided by [promise-retry](https://www.npmjs.com/package/promise-retry), and the back-off strategy is simple ^2.
 
-### TLS
+Additionally, the gRPC Client will contiually reconnect when in a failed state.
+
+### OAuth
 
-In case you need to connect to a secured endpoint, you can enable TLS.
+In case you need to connect to a secured endpoint with OAuth (such as Camunda Cloud), you can pass in OAuth credentials. This will enable TLS, and handle the OAuth flow to get / renew a JWT:
 
 ```typescript
-const zbc = new ZB.ZBClient(gatewayAddress, {
-	tls: true,
-})
+const zbc = new ZB.ZBClient("103ca930-6da6-4df7-aa97-941eb1f85040.zeebe.camunda.io:443", {
+	auth: {
+		url: "https://login.cloud.camunda.io/oauth/token",
+		audience: "103ca930-6da6-4df7-aa97-941eb1f85040.zeebe.camunda.io",
+		clientId: "yStuGvJ6a1RQhy8DQpeXJ80yEpar3pXh",
+		clientSecret:
+		"WZahIGHjyj0-oQ7DZ_aH2wwNuZt5O8Sq0ZJTz0OaxfO7D6jaDBZxM_Q-BHRsiGO_",
+		cache: true
+	}
+}
 ```
 
 ### Create a Task Worker
@@ -180,6 +195,22 @@ Call `complete.failure()` to fail the task. You must pass in a string message de
 complete.failure('This is a critical failure and will raise an incident', 0)
 ```
 
+### Long polling
+
+With Zeebe 0.21 onward, long polling is supported for clients. Rather than polling continuously for work and getting nothing back, a client can poll once and leave the request open until work appears. This reduces network traffic and CPU utilization in the server. Every JobActivation Request is appended to the event log, so continuous polling can significantly impact broker performance, especially when an exporter is loaded (see [here](https://github.com/creditsenseau/zeebe-client-node-js/issues/64#issuecomment-520233275)).
+
+To use long pollling, pass in a long poll timeout in milliseconds to the client. All workers created with that client will use it.
+
+Long polling for workers is enabled in the ZBClient, like this:
+
+```typescript
+const zbc = new ZBClient('serverAddress', {
+	longPoll: 600000, // Ten minutes in millis
+})
+
+const longPollingWorker = zbc.createWorker(uuid.v4(), 'task-type', handler)
+```
+
 ### Start a Workflow Instance
 
 ```javascript
@@ -262,18 +293,13 @@ This will produce output similar to:
 // Autogenerated constants for msg-start.bpmn
 
 export enum TaskType = {
-
     CONSOLE_LOG = "console-log"
-
 };
 
 export enum MessageName = {
-
     MSG_EMIT_FRAME = "MSG-EMIT_FRAME",
     MSG_START_JOB = "MSG-START_JOB"
-
 };
-
 ```
 
 ## Logging
@@ -344,10 +370,22 @@ npm run test:integration
 
 For the failure test, you need to run Operate ([docker-compose config](https://github.com/zeebe-io/zeebe-docker-compose/blob/master/operate/docker-compose.yml)) and manually verify that an incident has been raised at [http://localhost:8080](http://localhost:8080).
 
+### Writing Tests
+
+Zeebe is inherently stateful, so integration tests need to be carefully isolated so that workers from one test do not service tasks in another test. Jest runs tests in a random order, so intermittent failures are the outcome of tests that mutate shared state.
+
+For each feature:
+
+-   Use a unique bpmn process, named the same as the test file. Don't reuse processes between tests, because they are tightly coupled.
+-   Name the task types with a namespace that matches the test name. This avoids workers from one test servicing tasks from another test, which causes unpredictable behaviour.
+-   Cancel any workflows that do not run to completion in an `AfterAll` or `AfterEach` block. This avoids subsequent test runs interacting with workflows from a previous test run.
+-   Ensure that there no Active workflows in the engine after running the integration tests have run. This manual check is to verify that there is no left-over state. (Note one exception: the Raise Incident test leaves the workflow open for manual verification in Operate).
+
 ## Contributors
 
 | Name                                                         |
 | ------------------------------------------------------------ |
+| **[Colin Raddatz](https://github.com/ColRad)**               |
 | **[Josh Wulf](https://github.com/jwulf)**                    |
 | **[Jarred Filmer](https://github.com/BrighTide)**            |
 | **[Timothy Colbert](https://github.com/s3than)**             |

bin/zeebe-node-cli

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+const ZB = require("../")
+
+const workfile = args[1]
+(async () => {
+  console.log(await ZB.BpmnParser.scaffold(workflowFile));
+})();