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

Refactor the library #557

Merged
merged 23 commits into from
Aug 14, 2024
Merged

Refactor the library #557

merged 23 commits into from
Aug 14, 2024

Conversation

curquiza
Copy link
Member

No description provided.

Ja7ad and others added 22 commits August 4, 2024 08:57
556: Refactor meilisearch client wtih new client and documentation r=curquiza a=Ja7ad

# Pull Request

## Related issue
Resolves #554, resolves #462 

## What does this PR do?
- Refactor client to http.Client with optimized configuration
- Support parent context for all methods
- Add option pattern for optional configuration of constructor
- Improved documentation package, methods
- This refactor make better experience usage sdk for developers.

## 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?

Thank you so much for contributing to Meilisearch!


Co-authored-by: Javad <ja7ad@live.com>
Copy link

codecov bot commented Aug 14, 2024

Codecov Report

Attention: Patch coverage is 87.04104% with 180 lines in your changes missing coverage. Please review.

Project coverage is 86.79%. Comparing base (6b5e6fb) to head (077eaf1).
Report is 36 commits behind head on main.

Files Patch % Lines
index_document.go 78.19% 43 Missing and 32 partials ⚠️
meilisearch.go 88.81% 44 Missing and 4 partials ⚠️
index_settings.go 85.90% 0 Missing and 42 partials ⚠️
client.go 95.72% 3 Missing and 2 partials ⚠️
helper.go 94.73% 2 Missing and 2 partials ⚠️
index.go 93.33% 0 Missing and 4 partials ⚠️
index_search.go 94.87% 1 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #557      +/-   ##
==========================================
- Coverage   86.92%   86.79%   -0.13%     
==========================================
  Files          11       11              
  Lines        1629     1856     +227     
==========================================
+ Hits         1416     1611     +195     
- Misses        113      152      +39     
+ Partials      100       93       -7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@curquiza curquiza added the breaking-change The related changes are breaking for the users label Aug 14, 2024
@curquiza curquiza added skip-changelog The PR will not appear in the release changelogs and removed breaking-change The related changes are breaking for the users labels Aug 14, 2024
@curquiza curquiza merged commit ad4b0b2 into main Aug 14, 2024
4 of 5 checks passed
@curquiza curquiza deleted the refactor branch August 14, 2024 12:55
@curquiza curquiza added breaking-change The related changes are breaking for the users and removed skip-changelog The PR will not appear in the release changelogs labels Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change The related changes are breaking for the users
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Using built-in http.Client instead fasthttp.Client API doesn't take context.Context
2 participants