Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an option to add a correlation ID to a request #323

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

sebbi08
Copy link
Contributor

@sebbi08 sebbi08 commented Dec 6, 2024

Readiness checklist

  • I added/updated tests.
  • I ensured that the PR title is good enough for the changelog.
  • I labeled the PR.
  • I self-reviewed the PR.

@sebbi08 sebbi08 added enhancement New feature or request wip Work in Progress (blocks mergify from auto update the branch) labels Dec 6, 2024
@sebbi08
Copy link
Contributor Author

sebbi08 commented Dec 6, 2024

@jkoenig134 what do you think about this ?

Another option would be to tie the client to a correlation ID and "force" the user to use multiple clients.

I am also open for opinions if we should expose those utility functions "startCorrelation", "createCorrelationId" or if we only should document this.

@sebbi08 sebbi08 requested a review from jkoenig134 December 6, 2024 13:01
@jkoenig134
Copy link
Member

I don't really like the idea to add the correlation-id package to the sdk. We should instead provide a possibility to add a correlation id for every request (send the header X-CORRELATION-ID)

@sebbi08 sebbi08 removed the wip Work in Progress (blocks mergify from auto update the branch) label Dec 9, 2024
@sebbi08 sebbi08 marked this pull request as ready for review December 9, 2024 10:09
Copy link

codecov bot commented Dec 9, 2024

Codecov Report

Attention: Patch coverage is 89.53069% with 29 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
packages/sdk/src/endpoints/Endpoint.ts 77.77% 10 Missing ⚠️
...sdk/src/endpoints/RelationshipTemplatesEndpoint.ts 76.92% 9 Missing ⚠️
...ages/sdk/src/endpoints/IncomingRequestsEndpoint.ts 85.71% 3 Missing ⚠️
packages/sdk/src/endpoints/TokensEndpoint.ts 84.61% 2 Missing ⚠️
packages/sdk/src/endpoints/AttributesEndpoint.ts 98.55% 1 Missing ⚠️
packages/sdk/src/endpoints/FilesEndpoint.ts 95.45% 1 Missing ⚠️
packages/sdk/src/endpoints/MessagesEndpoint.ts 90.90% 1 Missing ⚠️
...ages/sdk/src/endpoints/OutgoingRequestsEndpoint.ts 88.88% 1 Missing ⚠️
...ackages/sdk/src/endpoints/RelationshipsEndpoint.ts 96.55% 1 Missing ⚠️
Files with missing lines Coverage Δ
packages/sdk/src/endpoints/AccountEndpoint.ts 100.00% <100.00%> (ø)
packages/sdk/src/endpoints/ChallengesEndpoint.ts 100.00% <100.00%> (ø)
...ages/sdk/src/endpoints/IdentityMetadataEndpoint.ts 100.00% <100.00%> (ø)
packages/sdk/src/endpoints/AttributesEndpoint.ts 97.85% <98.55%> (+0.53%) ⬆️
packages/sdk/src/endpoints/FilesEndpoint.ts 95.52% <95.45%> (+0.06%) ⬆️
packages/sdk/src/endpoints/MessagesEndpoint.ts 89.65% <90.90%> (ø)
...ages/sdk/src/endpoints/OutgoingRequestsEndpoint.ts 89.28% <88.88%> (ø)
...ackages/sdk/src/endpoints/RelationshipsEndpoint.ts 95.65% <96.55%> (ø)
packages/sdk/src/endpoints/TokensEndpoint.ts 81.81% <84.61%> (ø)
...ages/sdk/src/endpoints/IncomingRequestsEndpoint.ts 80.43% <85.71%> (+4.11%) ⬆️
... and 2 more

@sebbi08 sebbi08 changed the title Add correlation id to connector sdk Add an option to add a correlation ID to a request Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants