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

[ENH] JS admin client should throw well-formatted errors rather than Responses #2106

Merged
merged 1 commit into from
May 2, 2024

Conversation

codetheweb
Copy link
Contributor

@codetheweb codetheweb commented May 1, 2024

Previously, the admin client was throwing Responses rather than Errors. It now uses the same helper as the data plane client to throw well-formatted errors.

Copy link

vercel bot commented May 1, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
chroma ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 1, 2024 4:54pm

Copy link

github-actions bot commented May 1, 2024

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

Copy link

github-actions bot commented May 1, 2024

Please tag your PR title with one of: [ENH | BUG | DOC | TST | BLD | PERF | TYP | CLN | CHORE]. See https://docs.trychroma.com/contributing#contributing-code-and-ideas

@codetheweb codetheweb changed the title JS admin client should throw well-formatted errors rather than Responses [ENH] JS admin client should throw well-formatted errors rather than Responses May 1, 2024
@@ -64,7 +65,7 @@ export class AdminClient {
basePath: path,
});

this.api = new DefaultApi(apiConfig);
this.api = new DefaultApi(apiConfig, undefined, chromaFetch);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for my understanding, why does this result in well formatted errors?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

chromaFetch is a wrapper around fetch() that will throw Errors based on the response status code

by default, the autogenerated client seems to throw Responses

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

got it

Copy link
Collaborator

@HammadB HammadB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks

@codetheweb codetheweb merged commit b0b089a into main May 2, 2024
125 checks passed
@codetheweb codetheweb deleted the fix-admin-client-errors branch May 2, 2024 16:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants