Fixes camunda-community-hub#161

Author: jwulf

CHANGELOG.md

@@ -1,3 +1,13 @@
+# Version 0.24.2
+
+## Fixes
+
+_Things that were broken and are now fixed._
+
+-   The example code in `example` is updated to remove a deprecated method. See [#185](https://github.com/zeebe-io/zeebe-client-node-js/issues/185).
+-   An race condition in the ZBBatchWorker that could cause jobs to be lost in certain specific and rare race conditions has been refactored. See [#177](https://github.com/zeebe-io/zeebe-client-node-js/issues/177)
+-   The `onConnectionError` event is now debounced. See [#161](https://github.com/zeebe-io/zeebe-client-node-js/issues/161).
+
 # Version 0.24.0
 
 ## Fixes

package-lock.json

@@ -1,6 +1,6 @@
 {
 	"name": "zeebe-node",
-	"version": "v0.24.1",
+	"version": "v0.24.2",
 	"description": "A Node.js client library for the Zeebe Microservices Orchestration Engine.",
 	"keywords": [
 		"zeebe",
@@ -100,7 +100,7 @@
 		"tslint-config-prettier": "^1.18.0",
 		"typedoc": "^0.16.0",
 		"typedoc-plugin-sourcefile-url": "^1.0.6",
-		"typescript": "^3.8.3"
+		"typescript": "^3.9.7"
 	},
 	"author": {
 		"name": "Josh Wulf",

package.json

@@ -1,7 +1,6 @@
 // tslint:disable-next-line: no-implicit-dependencies
-import { GenericContainer } from '@sitapati/testcontainers'
+import { GenericContainer, Wait } from '@sitapati/testcontainers'
 import { ZBClient } from '../..'
-// import { createUniqueTaskType } from '../../lib/createUniqueTaskType'
 
 process.env.ZEEBE_NODE_LOG_LEVEL = process.env.ZEEBE_NODE_LOG_LEVEL || 'NONE'
 
@@ -14,45 +13,66 @@ let worker
 
 afterEach(async () => {
 	await container?.stop()
-	await worker?.stop()
+	await worker?.close()
 })
 
 test('reconnects after a pod reschedule', async done => {
+	let readyCount = 0
+	let errorCount = 0
 	const delay = timeout =>
 		new Promise(res => setTimeout(() => res(), timeout))
 
+	// tslint:disable-next-line: no-console
+	console.log('##### Starting container') // @DEBUG
+
 	container = await new GenericContainer(
 		'camunda/zeebe',
 		ZEEBE_DOCKER_TAG,
 		undefined,
 		26500
 	)
 		.withExposedPorts(26500)
+		.withWaitStrategy(Wait.forLogMessage('Bootstrap Broker-0 succeeded.'))
 		.start()
 
 	await delay(10000)
 
 	const zbc = new ZBClient(`localhost`)
 	await zbc.deployWorkflow('./src/__tests__/testdata/disconnection.bpmn')
-	worker = zbc.createWorker({
-		taskHandler: (_, complete) => {
-			complete.success()
-		},
-		taskType: 'disconnection-task',
+	worker = zbc
+		.createWorker({
+			taskHandler: (_, complete) => {
+				complete.success()
+			},
+			taskType: 'disconnection-task',
+		})
+		.on('connectionError', () => {
+			errorCount++
+		})
+		.on('ready', () => {
+			readyCount++
+		})
+
+	// tslint:disable-next-line: no-console
+	console.log('##### Deploying workflow') // @DEBUG
+
+	const wf = await zbc.createWorkflowInstanceWithResult({
+		bpmnProcessId: 'disconnection',
+		requestTimeout: 25000,
+		variables: {},
 	})
-	const wf = await zbc.createWorkflowInstanceWithResult('disconnection', {})
 	expect(wf.bpmnProcessId).toBeTruthy()
 
 	// tslint:disable-next-line: no-console
-	// console.log('##### Stopping container...') // @DEBUG
+	console.log('##### Stopping container...') // @DEBUG
 
 	await container.stop()
 
 	// tslint:disable-next-line: no-console
-	// console.log('##### Container stopped.') // @DEBUG
+	console.log('##### Container stopped.') // @DEBUG
 
 	// tslint:disable-next-line: no-console
-	// console.log('##### Starting container....') // @DEBUG
+	console.log('##### Starting container....') // @DEBUG
 
 	container = await new GenericContainer(
 		'camunda/zeebe',
@@ -61,6 +81,7 @@ test('reconnects after a pod reschedule', async done => {
 		26500
 	)
 		.withExposedPorts(26500)
+		.withWaitStrategy(Wait.forLogMessage('Bootstrap Broker-0 succeeded.'))
 		.start()
 
 	// tslint:disable-next-line: no-console
@@ -75,20 +96,32 @@ test('reconnects after a pod reschedule', async done => {
 	await container.stop()
 	container = undefined
 	worker = undefined
+	expect(readyCount).toBe(2)
+	expect(errorCount).toBe(1)
 	done()
 })
 
 test('a worker that started first, connects to a broker that starts later', async done => {
+	let readyCount = 0
+	let errorCount = 0
+
 	const delay = timeout =>
 		new Promise(res => setTimeout(() => res(), timeout))
 
 	const zbc = new ZBClient(`localhost`)
-	worker = zbc.createWorker({
-		taskHandler: (_, complete) => {
-			complete.success()
-		},
-		taskType: 'disconnection-task',
-	})
+	worker = zbc
+		.createWorker({
+			taskHandler: (_, complete) => {
+				complete.success()
+			},
+			taskType: 'disconnection-task',
+		})
+		.on('connectionError', () => {
+			errorCount++
+		})
+		.on('ready', () => {
+			readyCount++
+		})
 
 	container = await new GenericContainer(
 		'camunda/zeebe',
@@ -97,6 +130,7 @@ test('a worker that started first, connects to a broker that starts later', asyn
 		26500
 	)
 		.withExposedPorts(26500)
+		.withWaitStrategy(Wait.forLogMessage('Bootstrap Broker-0 succeeded.'))
 		.start()
 
 	await delay(10000)
@@ -109,5 +143,7 @@ test('a worker that started first, connects to a broker that starts later', asyn
 	await container.stop()
 	container = undefined
 	worker = undefined
+	expect(readyCount).toBe(1)
+	expect(errorCount).toBe(1)
 	done()
 })