Add API surface area for multi-tenancy

[jwulf]

Multi-tenancy is coming.

This task is to add support to the API surface of the client, with no change to the implementation as yet (the gRPC protocol implementation has not landed yet).

The methods will not do anything in the client but will allow consumers of zeebe-node to use the methods during development.

See the Java client task here: https://github.com/camunda/zeebe/issues/13517

Schema changes

The following commands need a way to specify a tenant:

• DeployResource RPC
• CreateProcessInstance RPC
• CreateProcessInstanceWithResult RPC
• EvaluateDecision RPC
• BroadcastSignal RPC
• PublishMessage RPC

The following commands need a way to specify one or more tenants:

• ActivateJobs RPC
• StreamJobs RPC (we can consider this one out of scope for this issue)

Out of scope

The following commands are unaffected:

• ModifyProcessInstance RPC
• CancelProcessInstance RPC
• UpdateJobRetries RPC
• CompleteJob RPC
• FailJob RPC
• ThrowError RPC
• ResolveIncident RPC
• SetVariables RPC
• Topology RPC

[jwulf]

Required by the Desktop Modeler: https://github.com/camunda/camunda-modeler/issues/3716

[jwulf]

I am going to remove the method overloads for createProcessInstance and createProcessInstanceWithResult, leaving only the object parameter method.

So:

zbc.createProcessInstanceWithResult({
   bpmnProcessId: 'order-process',
   variables: {
     customerId: 123,
     invoiceId: 567
   }
})

zbc.createProcessInstance({
  bpmnProcessId: 'test-process',
  variables: {
    testData: 'something'
  }
})

The rationale for this is: adding tenantId to all the method signatures increases the complexity. To reduce complexity, I will remove method overloads.

[jwulf]

Published package 8.3.0-alpha4.

To do: deployProcess needs to be modified. Maybe it won't support tenantId, because it can take an object, a string, or an array of strings - which doesn't give us a single way to do it - other than a second argument.

[jwulf]

Opened a PR for the Modeler team to test integrating the new APIs in 8.3.0-alpha4: https://github.com/camunda/camunda-modeler/issues/3772

[jwulf]

Based on the Operate team's use of the Zeebe Node library, rather than breaking the deployProcess API in the library, I plan to mark it as deprecated, and add support for multi-tenancy to the deployResource API.

This means that users wanting to use the new feature will need to refactor code to use this API, and there will be no change for users who are using the older API and do not wish to use the new feature.

User refactoring is then both motivated by and rewarded by a new feature: multi-tenancy support.

[nikku]

To consider: Add defaultTenantId that can be provided on client instantiation. This would mirror what is currently planned for the Java API and make single tenant applications simpler (i.e. Camunda Desktop Modeler).

[jwulf]

This is a very good idea. If the constructor / env vars provide the tenantIdon client instantiation, then the tenantId can be added to any method invocation.

[akeller]

@jwulf can you add a status here for this work?

[jwulf]

The published 8.3.0-alpha8 and 8.3.0-alpha9 packages include the fix for full multi-tenancy support.

[jwulf]

I tested it with Desktop Modeler against Self-Managed multi-tenant, and it works. Will push 8.3.0 package early next week.

[jwulf]

Published in 8.3.0