conductor-sdk / conductor-javascript Goto Github PK

Context

• The pipeline itself seems to be ready, but we need to automatize some synchronization at the package.json version and GitHub tag/release.

• Evaluate if current situation already supports that

Hello,
I noticed that you are currently setting the MAX_RETRIES as an hard-coded parameter , are you planning in the future to have it as a configurable parameter , something that could potentially be passed to TaskManager or orkesConductorClient when initialed ?

Thank you !

• Create methods for token management
  • Refresh token:
    • input: (key: string, secret: string)
    • output: (token: string)
    • details: Reference
  • Authentication header:
    • X-Authorization: $token
    • details: Reference

• Apply this for each request by appending this to the default header: Accept-Encoding: gzip

In the README for the project, one example shows that a custom https.Agent can be passed in using the AGENT key in the client options:

const client = new ConductorClient({
  serverUrl: 'https://play.orkes.io/api',
  AGENT: new Agent(agentOptions)
})

When attempting to do this, we're seeing an error about the AGENT key not being a valid option:

Argument of type '{ serverUrl: string; AGENT: https.Agent; }' is not assignable to parameter of type 'Partial<ConductorClientAPIConfig>'.
  Object literal may only specify known properties, and 'AGENT' does not exist in type 'Partial<ConductorClientAPIConfig>'.ts(2345)

Having looked at the source code, it doesn't seem like there is a way of specifying a custom agent?

We're using a self-signed SSL certificate on a local version of Conductor for development purposes, and this issue means that we cannot use this library to connect.

Are we missing anything?

Add JavaScript and TypeScript examples to the following pages:

• https://orkes.io/content/getting-started/adding-custom-code-worker
• https://orkes.io/content/developer-guides/write-workflows-using-code
• https://orkes.io/content/developer-guides/task-to-domain

Problem: Failed to poll task for: _____ errors despite successful workflow execution. This error is incredibly noisy (>30K in 24 hours).

The link of docs of API is redirecting to the not found page (404 error)

Discussed in #52

Hello ,
I noticed that the options provided to the TaskManager are ignored ( pollInterval, domain, concurrency) , only workerId is being used .
So I assumed after the defaultManagerOption spread should be another spread with providedOptions.

    const providedOptions = config.options ?? {}
    this.taskManageOptions = {
      ...defaultManagerOptions,
      ...providedOptions,
      workerID: workerId(providedOptions),
    }

When calling the /api/workflow/search endpoint, the Swagger documentation shows that the response should contain a totalHits field.

However, when attempting to access this field via the ConductorClient (which returns ScrollableSearchResultWorkflowSummary), the Typescript compiler complains with this error:

Property 'totalHits' does not exist on type 'ScrollableSearchResultWorkflowSummary'.ts(2339)

Instead of totalHits, the above type contains queryId as a field:

Following the workflow search path in Conductor, it's quite clear that the search does return totalHits and not queryId (this also matches the Swagger docs):

https://github.com/conductor-oss/conductor/blob/e195ef621b76f8be8e33957996b16232bba71266/core/src/main/java/com/netflix/conductor/service/ExecutionService.java#L414

https://github.com/conductor-oss/conductor/blob/e195ef621b76f8be8e33957996b16232bba71266/core/src/main/java/com/netflix/conductor/core/dal/ExecutionDAOFacade.java#L679

https://github.com/conductor-oss/conductor/blob/main/postgres-persistence/src/main/java/com/netflix/conductor/postgres/dao/PostgresIndexDAO.java#L129

Note that searchV2 isn't implemented for Postgres so we cannot use this:

https://github.com/conductor-oss/conductor/blob/e195ef621b76f8be8e33957996b16232bba71266/core/src/main/java/com/netflix/conductor/service/ExecutionService.java#L421

https://github.com/conductor-oss/conductor/blob/e195ef621b76f8be8e33957996b16232bba71266/core/src/main/java/com/netflix/conductor/core/dal/ExecutionDAOFacade.java#L674

https://github.com/conductor-oss/conductor/blob/e195ef621b76f8be8e33957996b16232bba71266/postgres-persistence/src/main/java/com/netflix/conductor/postgres/dao/PostgresIndexDAO.java#L241