fix(docs,c8run): add CAMUNDA_TASKLIST_BASE_URL to environment variables

[vobu]

just developing with that stack, new Camunda8() fails if the CAMUNDA_TASKLIST_BASE_URL is not set

Description of the change

[Describe your changes here]

Type of change

• Bug fix
• New feature
• Breaking change
• Documentation update

Checklist

• I have read the CONTRIBUTING doc
• I have opened this pull request against the alpha branch
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

Further comments

[If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...]

[jwulf]

This should not fail...

What error message do you get?

The Configuration schema has:

/** The base url for the Tasklist API */
CAMUNDA_TASKLIST_BASE_URL: {
  type: 'string',
  optional: true,
  default: undefined,
},

[vobu]

What error message do you get?

/Users/.../node_modules/@camunda8/sdk/dist/lib/RequireConfiguration.js:6
        throw new Error(`Missing required configuration ${String(key)}. Please supply this value as an environment variable or configuration object field.`);
              ^

Error: Missing required configuration CAMUNDA_TASKLIST_BASE_URL. Please supply this value as an environment variable or configuration object field.

[jwulf]

@vobu, I can't reproduce this.

I created a minimal reproducer here: https://github.com/jwulf/mr-590

Can you try that please, in a new terminal with no environment set.

BTW: thanks for the PR!

[vobu]

@vobu, I can't reproduce this.

I created a minimal reproducer here: https://github.com/jwulf/mr-590

Can you try that please, in a new terminal with no environment set.

sure, will try and report back - please add me as collaborator to the repo, currently getting a 404

[jwulf]

sure, will try and report back - please add me as collaborator to the repo, currently getting a 404

Set to public. Sorry about that.

[vobu]

figured out the problem , it is with getting the task list api client .
Yet not sure whether this is a bug or just advanced dev ergonomics:

import { Camunda8 } from '@camunda8/sdk'

const c8 = new Camunda8()
+ c8.getTasklistApiClient()

console.log("If you see this, it didn't throw.")

produces

npm start                                           ✔ 

> c8sdk-test@1.0.0 start
> source .env && tsx index.ts

/Users/.../mr-590/node_modules/@camunda8/sdk/dist/lib/RequireConfiguration.js:6
        throw new Error(`Missing required configuration ${String(key)}. Please supply this value as an environment variable or configuration object field.`);
              ^

Error: Missing required configuration CAMUNDA_TASKLIST_BASE_URL. Please supply this value as an environment variable or configuration object field.
    at RequireConfiguration (/Users/.../mr-590/node_modules/@camunda8/sdk/src/lib/RequireConfiguration.ts:8:9)
    at new TasklistApiClient

I was under the impression that with the near-zero-config constructor, the camunda client would make a fair/default assumption to find the tasklist API at http://localhost:8080/tasklist :)

[jwulf]

Previously, the SDK was optimised for SaaS connection as the default.

For 8.8.0 we'll optimise for localhost — if we can figure out what port it is (8080 vs 8088)