Merge pull request #207 from jwulf/0.26-grpc-proto

Author: jwulf

.npmignore

@@ -4,3 +4,5 @@ guide
 src
 design
 docs
+.env
+*.env

DEVELOP.md

@@ -25,3 +25,27 @@ To log from the Node engine itself (useful in tracking down grpc issues in grpc-
 ```
 NODE_DEBUG=http2 GRPC_TRACE=channel,call_stream GRPC_VERBOSITY=DEBUG ZEEBE_NODE_LOGLEVEL=debug ZEEBE_NODE_PUREJS=true npm run test:integration
 ```
+
+To get extended stack traces:
+
+```
+NODE_DEBUG=http2 GRPC_TRACE=channel,call_stream ZEEBE_NODE_PUREJS=true node --expose-internals --expose-gc  node_modules/.bin/jest --runInBand --testPathIgnorePatterns disconnection --detectOpenHandles --verbose true Worker-Failure
+```
+
+```
+valgrind node --expose-internals --expose-gc  node_modules/.bin/jest --runInBand --testPathIgnorePatterns disconnection --detectOpenHandles  Worker-Failure
+```
+
+## Scaffold a Ubuntu machine for dev
+
+sudo apt install -y build-essential
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.2/install.sh | bash
+source ~/.bashrc
+nvm install 14
+git clone https://github.com/camunda-community-hub/zeebe-client-node-js.git
+cd zeebe-client-node-js
+npm i
+
+# Set Camunda Cloud env variables
+
+ZEEBE_NODE_PUREJS=true node_modules/.bin/jest Worker-Failure

proto/zeebe.proto

@@ -151,14 +151,16 @@ message WorkflowRequestObject {
     // using the file extension of the name field
     FILE = 0;
     BPMN = 1; // extension 'bpmn'
-    YAML = 2; // extension 'yaml'
-  }
+    YAML = 2 [deprecated = true]; // extension 'yaml'; deprecated as of release 1.0
+}
 
   // the resource basename, e.g. myProcess.bpmn
   string name = 1;
   // the resource type; if set to BPMN or YAML then the file extension
   // is ignored
-  ResourceType type = 2;
+  // As of release 1.0, YAML support was removed and BPMN is the only supported resource type.
+  // The field was kept to not break clients.
+  ResourceType type = 2 [deprecated = true];
   // the process definition as a UTF8-encoded string
   bytes definition = 3;
 }
@@ -225,6 +227,8 @@ message PublishMessageRequest {
 }
 
 message PublishMessageResponse {
+  // the unique ID of the message that was published
+  int64 key = 1;
 }
 
 message ResolveIncidentRequest {
@@ -247,6 +251,8 @@ message TopologyResponse {
   int32 partitionsCount = 3;
   // configured replication factor for this cluster
   int32 replicationFactor = 4;
+  // gateway version
+  string gatewayVersion = 5;
 }
 
 message BrokerInfo {
@@ -265,12 +271,21 @@ message Partition {
   enum PartitionBrokerRole {
     LEADER = 0;
     FOLLOWER = 1;
+    INACTIVE = 2;
+  }
+
+  // Describes the current health of the partition
+  enum PartitionBrokerHealth {
+    HEALTHY = 0;
+    UNHEALTHY = 1;
   }
 
   // the unique ID of this partition
   int32 partitionId = 1;
   // the role of the broker for this partition
   PartitionBrokerRole role = 2;
+  // the health of this partition
+  PartitionBrokerHealth health = 3;
 }
 
 message UpdateJobRetriesRequest {

src/lib/interfaces-grpc.ts

@@ -140,14 +140,25 @@ export interface CreateWorkflowInstanceWithResultResponse<Result> {
 	variables: Result
 }
 
+// Describes the Raft role of the broker for a given partition
 export enum PartitionBrokerRole {
 	LEADER = 0,
 	BROKER = 1,
+	INACTIVE = 2,
+}
+
+// Describes the current health of the partition
+export enum PartitionBrokerHealth {
+	HEALTHY = 0,
+	UNHEALTHY = 1,
 }
 
 export interface Partition {
 	partitionId: number
+	// the role of the broker for this partition
 	role: PartitionBrokerRole
+	// the health of this partition
+	health: PartitionBrokerHealth
 }
 
 export interface BrokerInfo {
@@ -162,6 +173,7 @@ export interface TopologyResponse {
 	readonly clusterSize: number
 	readonly partitionsCount: number
 	readonly replicationFactor: number
+	readonly gatewayVersion: string
 }
 
 export enum ResourceType {
@@ -209,6 +221,11 @@ export interface PublishMessageRequest<Variables = IInputVariables> {
 	variables: Variables
 }
 
+export interface PublishMessageResponse {
+	// the unique ID of the message that was published
+	key: number
+}
+
 export interface PublishStartMessageRequest<Variables = IWorkflowVariables> {
 	/** Should match the "Message Name" in a BPMN Message Catch  */
 	name: string

src/lib/interfaces.ts

@@ -11,6 +11,7 @@ import {
 	DeployWorkflowResponse,
 	FailJobRequest,
 	PublishMessageRequest,
+	PublishMessageResponse,
 	SetVariablesRequest,
 	ThrowErrorRequest,
 	TopologyResponse,
@@ -334,7 +335,7 @@ export interface ZBGrpc extends GrpcClient {
 	activateJobsStream: any
 	publishMessageSync(
 		publishMessageRequest: PublishMessageRequest
-	): Promise<void>
+	): Promise<PublishMessageResponse>
 	throwErrorSync(throwErrorRequest: ThrowErrorRequest): Promise<void>
 	topologySync(): Promise<TopologyResponse>
 	updateJobRetriesSync(

src/zb/ZBClient.ts

@@ -664,7 +664,7 @@ export class ZBClient extends TypedEmitter<typeof ConnectionStatusEvent> {
 	 */
 	public publishMessage<WorkflowVariables = ZB.IWorkflowVariables>(
 		publishMessageRequest: Grpc.PublishMessageRequest<WorkflowVariables>
-	): Promise<void> {
+	): Promise<Grpc.PublishMessageResponse> {
 		return this.executeOperation('publishMessage', () =>
 			this.grpc.publishMessageSync(
 				stringifyVariables(publishMessageRequest)
@@ -680,7 +680,7 @@ export class ZBClient extends TypedEmitter<typeof ConnectionStatusEvent> {
 		publishStartMessageRequest: Grpc.PublishStartMessageRequest<
 			WorkflowVariables
 		>
-	): Promise<void> {
+	): Promise<Grpc.PublishMessageResponse> {
 		/**
 		 * The hash of the correlationKey is used to determine the partition where this workflow will start.
 		 * So we assign a random uuid to balance workflow instances created via start message across partitions.

src/zb/ZBWorker.ts

@@ -25,7 +25,7 @@ export class ZBWorker<
 		jobs: Array<ZB.Job<WorkerInputVariables, CustomHeaderShape>>
 	) {
 		// Call task handler for each new job
-		jobs.forEach(job => this.handleJob(job))
+		jobs.forEach(async job => this.handleJob(job))
 	}
 
 	protected async handleJob(