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

Simplify tasks #185

Merged
merged 4 commits into from
Jun 22, 2022
Merged

Simplify tasks #185

merged 4 commits into from
Jun 22, 2022

Conversation

brunoocasali
Copy link
Member

@brunoocasali brunoocasali commented Jun 21, 2022 •
edited
Loading

The idea is to simplify the way we handle tasks in the dart repo.

We used to have two implementations and one interface for just one thing to have a getStatus method which is only used for development purposes. After this PR we will have only Task.

@brunoocasali brunoocasali changed the base branch from main to documents-changes June 21, 2022 22:00
@brunoocasali brunoocasali requested a review from alallema June 21, 2022 22:00
@brunoocasali brunoocasali marked this pull request as ready for review June 21, 2022 22:02
alallema
alallema reviewed Jun 22, 2022
View reviewed changes
Copy link
Contributor

@alallema alallema left a comment

Choose a reason for hiding this comment

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

Perfect 🔥 This is way better to understand
LGTM! 🎉

Base automatically changed from documents-changes to bump-meilisearch-v0.28.0 June 22, 2022 19:31
@brunoocasali brunoocasali merged commit 9657085 into bump-meilisearch-v0.28.0 Jun 22, 2022
@brunoocasali brunoocasali deleted the simplify-tasks branch June 22, 2022 19:31
@brunoocasali brunoocasali mentioned this pull request Jun 22, 2022
Merged
bors bot added a commit that referenced this pull request Jul 11, 2022
@bors @brunoocasali
Merge #189
b0165d8 
189: Update version for the next release (v0.6.0) r=brunoocasali a=brunoocasali

This version makes this package compatible with Meilisearch v0.28.0 🎉
Check out the changelog of [Meilisearch v0.28.0](https://github.com/meilisearch/meilisearch/releases/tag/v0.28.0) for more information on the changes.

## 💥  Breaking changes
- `MeiliSearchClient#getDumpStatus` method was removed. (#173) `@brunoocasali`
- `MeiliSearchClient#getIndexes` method now return a object type `Result<MeiliSearchIndex>`. (#183) `@brunoocasali`
- `TaskInfo`, `TaskImpl`, `ClientTaskImpl` are now just `Task`. (#185) `@brunoocasali`
  - The method `getStatus` was removed in the new class.
- `MeiliSearchClient#generateTenantToken` now require a `String uid` which is the `uid` of the `Key` instance used to sign the token.  (#187) `@brunoocasali`
- `MeiliSearchClient#createDump` now responds with `Task`. (#181) `@brunoocasali`
- `MeiliSearchClient#getKeys` method now return a object type `Result<Key>`.  (#186), (#182) `@brunoocasali`
- `MeiliSearchClient#updateKey` now can just update a `description` and/or `name`. (#186), (#182) `@brunoocasali`
- `MeiliSearchClient#getTasks` method now return a object type `Future<ResultTask>`. (#180) `@brunoocasali`
- `MeiliSearchIndex#getTasks` method now return a object type `Future<ResultTask>`. (#180) `@brunoocasali`
- `MeiliSearchIndex#search` `facetsDistribution` is now `facets` (#175) `@brunoocasali`
- `MeiliSearchIndex#search` `matches` is now `showMatchesPosition` (#175) `@brunoocasali`
- `MeiliSearchIndex#getDocuments` method now return a object type `Future<Result>`.
- `MeiliSearchIndex#getDocuments` method now accepts a object as a parameter and `offset`, `limit`, `attributesToRetrieve` were not longer accepted.
- `nbHits`, `exhaustiveNbHits`, `facetsDistribution`, `exhaustiveFacetsCount` were removed from `SearchResult`. (#175) `@brunoocasali`

## 🚀  Enhancements
- `MeiliSearchClient#getIndexes` accepts a object `IndexesQuery` to filter and paginate the results.
- `MeiliSearchClient#getKeys` accepts a object `KeysQuery` to filter and paginate the results. (#186), (#182) `@brunoocasali`
- `MeiliSearchClient#getKey` accepts both a `Key#uid` or `Key#key` value. (#186), (#182) `@brunoocasali`
- `MeiliSearchClient#getTasks` accepts a object `TasksQuery` to filter and paginate the results. (#185) `@brunoocasali`
- `MeiliSearchIndex#getTasks` accepts a object `TasksQuery` to filter and paginate the results. (#185) `@brunoocasali`
- `MeiliSearchClient#createKey` can specify a `uid` (optionally) to create a new `Key`. (#186), (#182) `@brunoocasali`
- `MeiliSearchIndex#getDocuments` accepts a object `DocumentsQuery` to filter and paginate the results. (#184) `@brunoocasali`
- `Key` has now a `name` and `uid` string fields. (#186), (#182) `@brunoocasali`
- `estimatedTotalHits`, `facetDistribution` were added to `SearchResult` (#175) `@brunoocasali`
- Sending a invalid `uid` or `apiKey` will raise `InvalidApiKeyException`. (#187) `@brunoocasali`
- Remove unused generic T in search method (#176) `@ShakyaCsun`

## 💅  Misc

- Improve Docker configuration in the package (#164) `@brunoocasali` 
- Add test for `filter` paramter with spaces (#179) `@ShakyaCsun`
- Improve pub spec score points (#171) `@brunoocasali`

Thanks again to `@ShakyaCsun,` `@brunoocasali,` `@dependabot` ! 🎉

Co-authored-by: Bruno Casali <[email protected]>
bors bot added a commit that referenced this pull request Jul 11, 2022
@bors @brunoocasali
Merge #189
e047e87 
189: Update version for the next release (v0.6.0) r=brunoocasali a=brunoocasali

This version makes this package compatible with Meilisearch v0.28.0 🎉
Check out the changelog of [Meilisearch v0.28.0](https://github.com/meilisearch/meilisearch/releases/tag/v0.28.0) for more information on the changes.

## 💥  Breaking changes
- `MeiliSearchClient#getDumpStatus` method was removed. (#173) `@brunoocasali`
- `MeiliSearchClient#getIndexes` method now return a object type `Result<MeiliSearchIndex>`. (#183) `@brunoocasali`
- `TaskInfo`, `TaskImpl`, `ClientTaskImpl` are now just `Task`. (#185) `@brunoocasali`
  - The method `getStatus` was removed in the new class.
- `MeiliSearchClient#generateTenantToken` now require a `String uid` which is the `uid` of the `Key` instance used to sign the token.  (#187) `@brunoocasali`
- `MeiliSearchClient#createDump` now responds with `Task`. (#181) `@brunoocasali`
- `MeiliSearchClient#getKeys` method now return a object type `Result<Key>`.  (#186), (#182) `@brunoocasali`
- `MeiliSearchClient#updateKey` now can just update a `description` and/or `name`. (#186), (#182) `@brunoocasali`
- `MeiliSearchClient#getTasks` method now return a object type `Future<ResultTask>`. (#180) `@brunoocasali`
- `MeiliSearchIndex#getTasks` method now return a object type `Future<ResultTask>`. (#180) `@brunoocasali`
- `MeiliSearchIndex#search` `facetsDistribution` is now `facets` (#175) `@brunoocasali`
- `MeiliSearchIndex#search` `matches` is now `showMatchesPosition` (#175) `@brunoocasali`
- `MeiliSearchIndex#getDocuments` method now return a object type `Future<Result>`.
- `MeiliSearchIndex#getDocuments` method now accepts a object as a parameter and `offset`, `limit`, `attributesToRetrieve` were not longer accepted.
- `nbHits`, `exhaustiveNbHits`, `facetsDistribution`, `exhaustiveFacetsCount` were removed from `SearchResult`. (#175) `@brunoocasali`

## 🚀  Enhancements
- `MeiliSearchClient#getIndexes` accepts a object `IndexesQuery` to filter and paginate the results.
- `MeiliSearchClient#getKeys` accepts a object `KeysQuery` to filter and paginate the results. (#186), (#182) `@brunoocasali`
- `MeiliSearchClient#getKey` accepts both a `Key#uid` or `Key#key` value. (#186), (#182) `@brunoocasali`
- `MeiliSearchClient#getTasks` accepts a object `TasksQuery` to filter and paginate the results. (#185) `@brunoocasali`
- `MeiliSearchIndex#getTasks` accepts a object `TasksQuery` to filter and paginate the results. (#185) `@brunoocasali`
- `MeiliSearchClient#createKey` can specify a `uid` (optionally) to create a new `Key`. (#186), (#182) `@brunoocasali`
- `MeiliSearchIndex#getDocument` accepts a list of fields to reduce the final payload.
- `MeiliSearchIndex#getDocuments` accepts a object `DocumentsQuery` to filter and paginate the results. (#184) `@brunoocasali`
- `Key` has now a `name` and `uid` string fields. (#186), (#182) `@brunoocasali`
- `estimatedTotalHits`, `facetDistribution` were added to `SearchResult` (#175) `@brunoocasali`
- Sending a invalid `uid` or `apiKey` will raise `InvalidApiKeyException`. (#187) `@brunoocasali`
- Remove unused generic T in search method (#176) `@ShakyaCsun`

## 💅  Misc

- Improve Docker configuration in the package (#164) `@brunoocasali` 
- Add test for `filter` paramter with spaces (#179) `@ShakyaCsun`
- Improve pub spec score points (#171) `@brunoocasali`

Thanks again to `@ShakyaCsun,` `@brunoocasali,` `@dependabot` ! 🎉

Co-authored-by: Bruno Casali <[email protected]>
@brunoocasali brunoocasali added enhancement New feature or request breaking-change The related changes are breaking for the users labels May 30, 2023
@brunoocasali brunoocasali mentioned this pull request May 30, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alallema alallema alallema approved these changes

Assignees
No one assigned
Labels
breaking-change The related changes are breaking for the users enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@brunoocasali @alallema