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.

Sign up for GitHub

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

Jump to bottom

Ensure the error handling are following the best practice #467

Closed
3 tasks
brunoocasali opened this issue Aug 14, 2023 · 0 comments · Fixed by #492
Closed
3 tasks

Ensure the error handling are following the best practice #467

brunoocasali opened this issue Aug 14, 2023 · 0 comments · Fixed by #492
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@brunoocasali
Copy link
Member

⚠️ This issue is generated, it means the examples and the namings do not necessarily correspond to the language of this repository.
Also, if you are a maintainer, please add any clarification and instructions about this issue.

Sorry if this is already wholly/partially implemented. Feel free to let me know about the state of this issue in the repo.

Related to meilisearch/integration-guides#267

⚠️ For more information check meilisearch/integration-guides#267

Ensure this SDK follows the following guidelines:

  • All the errors > 400 without message should be sent as MeilisearchCommunicationError
  • Know errors like index is not found, or mistakes in the request like not-allowed params should be sent as MeilisearchApiError
  • Any other error should be a MeilisearchError

Essentially all the error should extend from MeilisearchError, the consumers should have a way to catch all the errors.
Let us know if this is not clear, or you have better idea!

TODO:

  • Create a base error called MeilisearchError which will extend the standard error if it does not exist (when the language supports)
  • Make all the other errors extend this error.
  • Move all errors without message to MeilisearchCommunicationError since it is not a Meilisearch error anyway.
@brunoocasali brunoocasali added good first issue Good for newcomers enhancement New feature or request labels Aug 14, 2023
@ellnix ellnix mentioned this issue Oct 4, 2023
Merged
3 tasks
meili-bors bot added a commit that referenced this issue Oct 9, 2023
@meili-bors @ellnix
Merge #492
8680ee7 
492: Add new `MeiliSearch::Error` from which other errors inherit r=brunoocasali a=ellnix

# Pull Request

## Related issue
Fixes #467 

## PR checklist
Please check if your PR fulfills the following requirements:
- [X] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [X] Have you read the contributing guidelines?
- [X] Have you made sure that the title is accurate and descriptive of the changes?



Co-authored-by: ellnix <103502144+ellnix@users.noreply.github.com>
@meili-bors meili-bors bot closed this as completed in #492 Oct 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add new MeiliSearch::Error from which other errors inherit ellnix/meilisearch-ruby
1 participant
@brunoocasali