Tasks refactor #180

brunoocasali · 2022-06-21T20:52:38Z

Add TasksQuery object, which adds the ability to paginate the results using a keyset pagination.
- limit, next, from attributes handle the pagination.
- indexUid is used to filter tasks by index.
- status is used to filter tasks by status (succeeded, failed and so on...)
- type is used to filter tasks by type (dumpCreation, documentDeletion, indexCreation and so on...)
MeiliSearchIndex.getTasks(); now returns ResultTask.

- Add ResultTask type to handle response

alallema

So great! I'm going to use it as inspiration for my SDK. I just made a couple of comment

alallema · 2022-06-22T07:43:50Z

lib/src/result_task.dart

@@ -0,0 +1,22 @@
+import 'package:meilisearch/src/task.dart';
+
+class ResultTask<T> {


I changed the name of ResultTask to TaskResult in the golang SDK not sure it's really relevant but for TasksQuery you put Task at the beginning

Or maybe we should follow the standard: TasksResults?

alallema · 2022-06-22T07:44:53Z

lib/src/query_parameters/tasks_query.dart

+      this.status: const [],
+      this.type: const []});
+
+  Map<String, dynamic> toQuery() {


If the one just above is the constructor what is this one for?

The idea of this method is to transform the internal data in a way I can send to the post/get methods as the query string:

final response = await http.getMethod('/tasks', queryParameters: params?.toQuery());

By using this idea, I'll get an object ready to be used, because all the transformations like joined arrays and the removal of null values are already done.

170: Changes related to the next Meilisearch release (v0.28.0) r=brunoocasali a=meili-bot Related to this issue: meilisearch/integration-guides#205 This PR: - gathers the changes related to the next Meilisearch release (v0.28.0) so that this package is ready when the official release is out. - should pass the tests against the [latest pre-release of Meilisearch](https://github.com/meilisearch/meilisearch/releases). - might eventually contain test failures until the Meilisearch v0.28.0 is out. ⚠️ This PR should NOT be merged until the next release of Meilisearch (v0.28.0) is out. _This PR is auto-generated for the [pre-release week](https://github.com/meilisearch/integration-guides/blob/master/guides/pre-release-week.md) purpose._ Remaining: - [x] Fix code-samples - [x] Changes related to the keys management - [x] Changes related to the HTTP verbs - [x] Changes related to the tasks resources - [x] Changes related to the search - [x] Changes related to the indexes resources - [x] Changes related to the documents resources - [x] Changes related to the dumps resources - [x] #180 (comment) - [x] #181 (comment) Co-authored-by: meili-bot <[email protected]> Co-authored-by: Bruno Casali <[email protected]>

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]>

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 added the breaking-change The related changes are breaking for the users label Jun 21, 2022

brunoocasali requested a review from alallema June 21, 2022 20:52

brunoocasali force-pushed the tasks-refactor branch from 06b6186 to d183ef3 Compare June 21, 2022 21:03

brunoocasali added 2 commits June 21, 2022 18:04

Add a way to paginate tasks

505a246

- Add ResultTask type to handle response

Implement the new task response for client.getTasks

195ef54

brunoocasali force-pushed the tasks-refactor branch from d183ef3 to 195ef54 Compare June 21, 2022 21:14

alallema reviewed Jun 22, 2022

View reviewed changes

brunoocasali mentioned this pull request Jun 22, 2022

Changes related to the next Meilisearch release (v0.28.0) #170

Merged

10 tasks

brunoocasali merged commit 8704a6f into bump-meilisearch-v0.28.0 Jun 22, 2022

brunoocasali deleted the tasks-refactor branch June 22, 2022 19:25

brunoocasali mentioned this pull request Jun 22, 2022

Update version for the next release (v0.6.0) #189

Merged

brunoocasali mentioned this pull request Jul 7, 2022

Replace ResultTask by TasksResults #193

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tasks refactor #180

Tasks refactor #180

brunoocasali commented Jun 21, 2022

alallema left a comment

alallema Jun 22, 2022

brunoocasali Jun 22, 2022

alallema Jun 22, 2022

brunoocasali Jun 22, 2022

		@@ -0,0 +1,22 @@
		import 'package:meilisearch/src/task.dart';

		class ResultTask<T> {

Tasks refactor #180

Tasks refactor #180

Conversation

brunoocasali commented Jun 21, 2022

alallema left a comment

Choose a reason for hiding this comment

alallema Jun 22, 2022

Choose a reason for hiding this comment

brunoocasali Jun 22, 2022

Choose a reason for hiding this comment

alallema Jun 22, 2022

Choose a reason for hiding this comment

brunoocasali Jun 22, 2022

Choose a reason for hiding this comment