Refactor PineconeError: use thiserror/anyhow, ensure we support Send + Sync
#56
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…our boilerplate for the custom error enum, make sure we can safely use PineconeError with Send and Sync, add unit test for this
austin-denoble
changed the title
PineconeError: use thiserror/anyhow & ensure we support Send + SyncPineconeError: use thiserror/anyhow, ensure we support Send + Sync
austin-denoble
commented
Sep 3, 2024
| @@ -210,123 +239,6 @@ fn parse_forbidden_error(source: WrappedResponseContent, message: String) -> Pin | |||
| } | |||
| } | |||
|
|
|||
| impl std::fmt::Display for PineconeError { | |||
There was a problem hiding this comment.
These Display implementations are basically all up in the #[error("message")] annotations above each error in the enum due to deriving thiserror::Error.
austin-denoble
commented
Sep 3, 2024
| } | ||
| } | ||
|
|
||
| impl std::error::Error for PineconeError { |
There was a problem hiding this comment.
Handled with deriving thiserror::Error.
austin-denoble
commented
Sep 3, 2024
Comment on lines
+277
to
+282
| fn assert_send_sync<T: Send + Sync>() {} | ||
|
|
||
| #[tokio::test] | ||
| async fn test_pinecone_error_is_send_sync() { | ||
| assert_send_sync::<PineconeError>(); | ||
| } |
There was a problem hiding this comment.
Testing to ensure we're properly implementing Send + Sync on the custom error type.
austin-denoble
commented
Sep 3, 2024
| ConnectionError { | ||
| /// inner: Error object for connection error. | ||
| source: Box<dyn std::error::Error>, |
There was a problem hiding this comment.
The issue with no adhering to Send + Sync was due to this inner error type.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Currently,
PineconeErrorcontains a lot of boilerplate for implementingstd::error::Error. @haruska suggested we could maybe simplify some of the boilerplate using thethiserrorandanyhowcrates.Additionally, there was an enhancement filed (#54) to implement
Send+SyncforPineconeErroras currently we're unable to usePineconeErrorin a multithreaded context.Solution
Refactor PineconeError to use thiserror and anyhow to reduce some of our boilerplate for the custom error enum, make sure we can safely use PineconeError with Send and Sync, add unit test for this
Type of Change
Test Plan
New unit test added to verify that
PineoneErrorhas properly implemented theSendandSynctraits.cargo test-> validate CI passes as expected