deps: replace zeebe-node with @camunda8/sdk

[jwulf]

fixes #4109

[barmac]

We just had a session together. The mocks need to be fixed. @jwulf will continue on the source code migration.

Discovered #4236.

[barmac]

I rebased this on top of develop so that you can build it locally.

As a side note, you can also run the application via npm start which is significantly faster than waiting for the app to be built. You may need to restart the script once you change code in app directory.

[barmac]

I pushed changes of the test files which fix some of the failing cases. To be continued.

[barmac]

Let's make it a draft until it's ready for merge.

[barmac]

@jwulf zeebe-node uses property port to later construct the URL, but I can't see a relevant property in the SDK config. Is it smart enough to figure out defaults for HTTP(s) or do we need to add them to the Zeebe address?

[barmac]

Also it looks like the SDK expects us to pass a path to the custom root certificates (e.g. CAMUNDA_CUSTOM_ROOT_CERT_PATH) while in zeebe-node we would pass a Buffer with certificates.

[barmac]

For the OS certificates, we cannot really pass a path.

[barmac]

I've migrated most of the tests to the new way of creating the client. @jwulf please take a look at the comments above so that we can proceed with this PR: #4233 (comment), #4233 (comment)

[nikku]

@barmac Let's ensure that it is clear what else we'd need to get this merged (potentially from the SDK side).

[barmac]

To get this merged, we need to:

• Clarify the port usage: deps: replace zeebe-node with @camunda8/sdk #4233 (comment)
• Have a way to include the OS certificates (either built in the library or provide an option to pass a blob with certificates): deps: replace zeebe-node with @camunda8/sdk #4233 (comment)

@jwulf Please let me know if you need any support with this.

[jwulf]

To get this merged, we need to:

• Clarify the port usage: deps: replace zeebe-node with @camunda8/sdk #4233 (comment)
• Have a way to include the OS certificates (either built in the library or provide an option to pass a blob with certificates): deps: replace zeebe-node with @camunda8/sdk #4233 (comment)

@jwulf Please let me know if you need any support with this.

OK. I have moved the custom certificate management code into the SDK itself (see here). At the moment it can take a file path to a custom certificate.

I've added tests for the feature, as well as tests on Windows in CI (didn't have any of those previously - see here).

I have opened an issue to support passing the certificate itself as a Buffer or String, as zeebe-node used to.

camunda/camunda-8-js-sdk#142

I'll get to that at the end of this week or beginning of next week.

For the port number, this is now just part of the ZEEBE_ADDRESS parameter.

[barmac]

Thanks for the update. I will look into the changes this week.

[jwulf]

Version 8.5.2 of the Camunda 8 JS SDK supports CAMUNDA_CUSTOM_ROOT_CERT_STRING as a configuration parameter. This allows you to supply a custom TLS certificate as a string.

It will be aggregated with the system certificates automatically, and used to verify the TLS certificate used to secure the Zeebe Gateway.

[barmac]

Unfortunately, I need to postpone this to the week after CamundaCon.

[barmac]

I am looking into this today.

[barmac]

In order to check the SDK configuration, I implemented a connection test in camunda/zeebe-connection-test#12

[barmac]

@jwulf Is the basic auth supported in the SDK? I couldn't find a configuration option for this even though it was supported in zeebe-node.

[barmac]

This is blocked by camunda/camunda-8-js-sdk#165

[barmac]

This is blocked by camunda/camunda-8-js-sdk#165

We are unblocked now 🚀

[nikku]

@barmac You can verify this works via camunda/zeebe-connection-test#11

[barmac]

This PR is now in the backlog so we will not work on this right now.