-
Notifications
You must be signed in to change notification settings - Fork 1.9k
[CLN] Update server error response on JS Client #5327
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
base: main
Are you sure you want to change the base?
Conversation
Reviewer ChecklistPlease leverage this checklist to ensure your code review is thorough before approving Testing, Bugs, Errors, Logs, Documentation
System Compatibility
Quality
|
8758c73
to
be2c0f4
Compare
This PR modifies the error message shown to JS client users when a server connection failure (status 503/504) occurs. The message changes from 'Unable to connect to the chromadb server (status: ${response.status}). Please try again later.' to 'Unable to connect to the chromadb server (status: ${response.status}). Please check server status.' Additionally, there are widespread formatting adjustments (mainly Prettier updates) across several auto-generated and manually maintained files, but the core logic change is only in the relevant error handling code. This summary was automatically generated by @propel-code-bot |
if ( | ||
configuration?.hnsw === undefined && | ||
configuration?.spann === undefined | ||
) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[BestPractice]
This PR mixes a functional change with a large number of formatting changes. To improve reviewability, it's a good practice to separate formatting-only changes into a separate commit. This allows reviewers to focus on the logic changes more easily.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is a prettier that hasnt been run in a while basically. the change is just a 2 liner so i think its fine.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the clarification! I understand that these formatting changes are a result of prettier
and that the core functional change is indeed small. For minor formatting adjustments like these, it's often acceptable to include them in the same commit, especially if they're part of a routine reformat.
However, as a general best practice, for larger pull requests where formatting changes might obscure significant logical changes, separating them into a dedicated commit (e.g., "chore: Run formatter
") can greatly improve reviewability. This allows reviewers to focus on the functional changes without being distracted by extensive whitespace or line-break differences.
Your functional change to the error message is a good improvement, providing more actionable advice to the user. The PR looks good to proceed.
be2c0f4
to
dc3d5f2
Compare
1 Job Failed: PR checks / all-required-pr-checks-passedStep "Decide whether the needed jobs succeeded or failed" from job "all-required-pr-checks-passed" is failing. The last 20 log lines are:
Summary: 1 successful workflow, 1 failed workflow
Last updated: 2025-08-21 11:20:10 UTC |
Description of changes
The server error message has been adjusted on server error
Unable to connect to the chromadb server (status: ${response.status}). Please try again later.
->Unable to connect to the chromadb server (status: ${response.status}). Please check server status.
Test plan
How are these changes tested?
pytest
for python,yarn test
for js,cargo test
for rustMigration plan
Are there any migrations, or any forwards/backwards compatibility changes needed in order to make sure this change deploys reliably?
Observability plan
What is the plan to instrument and monitor this change?
Documentation Changes
Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs section?