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

[CLN] make ValueError and TypeError present as InvalidArgumentError #3017

Merged
merged 3 commits into from
Oct 29, 2024

Conversation

HammadB
Copy link
Collaborator

@HammadB HammadB commented Oct 28, 2024

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • This will propagate value/type errors as invalid argument errors
  • New functionality
    • None

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

None

@HammadB HammadB requested review from codetheweb and tazarov and removed request for codetheweb October 28, 2024 23:06
Copy link

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)

@HammadB HammadB requested a review from atroyn October 28, 2024 23:06
Comment on lines +109 to +118
except ValueError as e:
return JSONResponse(
content={"error": "InvalidArgumentError", "message": str(e)},
status_code=400,
)
except TypeError as e:
return JSONResponse(
content={"error": "InvalidArgumentError", "message": str(e)},
status_code=400,
)
Copy link
Contributor

Choose a reason for hiding this comment

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

should we transform these error types to a ChromaError inside this handler and then allow the normal error flow to handle them?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I thought about that, but it felt silly / not helpful to do so, I could go either way - and don't have a principled way of deciding since the change is localized - I.e we'd catch this type, turn it into a chroma error and rethrow.

If you have a way to decide lmk - I can change it.

Copy link
Contributor

Choose a reason for hiding this comment

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

yeah current method seems fine

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd like to understand this a bit better; how do we know both of these are due to an InvalidArgumentError ? Why don't we throw a ChromaError that represents an InvalidArgumentError further down the stack?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

ValueError / TypeError

"A TypeError occurs when an operation or function is applied to an object of inappropriate type. A ValueError occurs when a built-in operation or function receives an argument that has the right type but an inappropriate value"

Map to chromas invalid argument error. Rather than replace ALL instances in our code of ValueError/TypeError I opted to catch them and transmit them to clients as an InvalidArgumentError.

Copy link
Contributor

Choose a reason for hiding this comment

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

The global replace is probably the 'right' thing in the long run (and an easy starter issue); let's make an issue for that. Meantime this looks fine to land.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@HammadB HammadB merged commit 43f13bc into main Oct 29, 2024
71 checks passed
codetheweb pushed a commit that referenced this pull request Nov 5, 2024
…3017)

## Description of changes

*Summarize the changes made by this PR.*
 - Improvements & Bug fixes
	 - This will propagate value/type errors as invalid argument errors
 - New functionality
	 - None

## Test plan
*How are these changes tested?*
- [x] Tests pass locally with `pytest` for python, `yarn test` for js,
`cargo test` for rust

## Documentation Changes
None
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.

3 participants