Add Result container #350

ahmednfwela · 2023-09-01T07:40:00Z

Pull Request

Related issue

Fixes #335
Fixes #337
Fixes #338
Starts work on #276

What does this PR do?

In this PR the main feature is adding MeiliDocumentContainer<T>, which wraps around documents returned by meilisearch and adds typed, useful information to them.

I have also added a dependency on json_serializable to generate serialization information for models (toJson + fromJson), but I will be rolling all models gradually.

Here is the complete list of changes:

chore: updated CONTRIBUTING.md to include instructions on generating json_serializable files.
feat: added getExperimentalFeatures and updateExperimentalFeatures to MeiliSearchClient
feat: added to SearchQuery and IndexSearchQuery
3.1. List? vector
3.2. bool? showRankingScore
3.3. bool? showRankingScoreDetails
feat: added MeiliDocumentContainer<T>
feat: added Map<String, dynamic> src to Searcheable, which exposes the raw json object returned from the server.
REASON: just in case we don't keep up with new meilisearch releases, the user has a way to access new features.
[BREAKING] fix: Searcheable<T> had a wrong matchesPosition property, which I have moved into MeiliDocumentContainer<T>
[BREAKING] fix: Marked all the fields in Searcheable<T> constructor as required
REASON: just in case we forget to add them in PaginatedSearchResult<T> or SearchResult<T>

PR checklist

Please check if your PR fulfills the following requirements:

Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
Have you read the contributing guidelines?
Have you made sure that the title is accurate and descriptive of the changes?
Updates to .code-samples.meilisearch.yml files

Thank you so much for contributing to Meilisearch!

…o search query.

…atures` to MeiliSearchClient

…anking rule details

…urned search result. feat(search): added experimental vector. feat(search): added `mapToContainer` extension on Searcheable<T> and its children, to simplify wrapping documents.

codecov-commenter · 2023-09-01T07:41:53Z

Codecov Report

Patch coverage: 70.06% and project coverage change: -0.81% ⚠️

Comparison is base (758a4b8) 82.84% compared to head (6ebd988) 82.03%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #350      +/-   ##
==========================================
- Coverage   82.84%   82.03%   -0.81%     
==========================================
  Files          48       57       +9     
  Lines        1218     1353     +135     
==========================================
+ Hits         1009     1110     +101     
- Misses        209      243      +34

Files Changed	Coverage Δ
lib/src/query_parameters/index_search_query.dart	`19.35% <0.00%> (-2.08%)`	⬇️
lib/src/results/paginated_search_result.dart	`46.42% <25.00%> (-5.43%)`	⬇️
lib/src/results/ranking_rules/base.dart	`33.33% <33.33%> (ø)`
lib/src/results/searchable.dart	`73.33% <33.33%> (-26.67%)`	⬇️
lib/src/results/searchable_helpers.dart	`75.00% <33.33%> (ø)`
lib/src/query_parameters/search_query.dart	`50.00% <50.00%> (ø)`
lib/src/results/document_container.dart	`67.30% <67.30%> (ø)`
lib/src/results/experimental_features.dart	`73.33% <73.33%> (ø)`
lib/src/results/experimental_features.g.dart	`100.00% <100.00%> (ø)`
lib/src/results/ranking_rules/attribute.dart	`100.00% <100.00%> (ø)`
... and 5 more

... and 1 file with indirect coverage changes

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

ahmednfwela

Added some comments to help reviewers :)

ahmednfwela · 2023-09-01T07:48:33Z

CONTRIBUTING.md

@@ -71,9 +71,9 @@ Each PR should pass the tests and the linter to be accepted.
 # Tests
 curl -L https://install.meilisearch.com | sh # download Meilisearch
 ./meilisearch --master-key=masterKey --no-analytics # run Meilisearch
-pub run test --concurrency=4
+dart test


dart test by default uses concurrency

ahmednfwela · 2023-09-01T07:49:23Z

lib/src/query_parameters/index_search_query.dart

@@ -62,6 +65,9 @@ class IndexSearchQuery extends SearchQuery {
    String? highlightPostTag,
    MatchingStrategy? matchingStrategy,
    List<String>? attributesToSearchOn,
+    bool? showRankingScore,
+    List<dynamic /* double | List<double> */ >? vector,


wish dart had type unions 😢

ahmednfwela · 2023-09-01T07:50:14Z

lib/src/results/document_container.dart

+  final MeiliRankingScoreDetails? rankingScoreDetails;
+
+  /// Contains the location of each occurrence of queried terms across all fields
+  final Map<String, List<MatchPosition>>? matchesPosition;


this was incorrectly placed in Searcheable<T>

ahmednfwela · 2023-09-01T07:50:38Z

lib/src/results/document_container.dart

+  dynamic operator [](String key) => src[key];
+  dynamic getFormatted(String key) => formatted?[key];
+
+  dynamic getFormattedOrSrc(String key) => getFormatted(key) ?? this[key];


convenience methods

ahmednfwela · 2023-09-01T07:51:29Z

lib/src/results/document_container.dart

+        for (var custom in src.entries
+            .where((element) => !reservedKeys.contains(element.key)))
+          custom.key: MeiliRankingScoreDetailsCustomRule.fromJson(
+            custom.value as Map<String, dynamic>,
+          )


I haven't had a chance to test this, since I have no idea when a custom rule is returned

ahmednfwela · 2023-09-01T07:52:40Z

lib/src/results/experimental_features.dart

+    this.scoreDetails,
+  });
+
+  Map<String, dynamic> toJson() => _$UpdateExperimentalFeaturesToJson(this);


this method is generated using json_serializable

ahmednfwela · 2023-09-01T07:53:02Z

lib/src/results/experimental_features.g.dart

this entire file is generated using json_serializable

ahmednfwela · 2023-09-01T07:53:49Z

lib/src/results/paginated_search_result.dart

@@ -40,6 +33,7 @@ class PaginatedSearchResult<T> extends Searcheable<T> {
    String? indexUid,
  }) {
    return PaginatedSearchResult(
+      src: map,


we pass the original map here, if users want access to the raw response.

lib/src/results/ranking_rules/attribute.dart

test/utils/books_data.dart

ahmednfwela · 2023-09-01T08:12:15Z

lib/src/results/ranking_rules/exactness.dart

+  /// - `exactMatch`: the document contains an attribute that exactly matches the query.
+  /// - `matchesStart`: the document contains an attribute that exactly starts with the query.
+  /// - `noExactMatch`: any other document.
+  final String matchType;


maybe use an enum here?

…esult-container

brunoocasali

Just a small remark about the experimental methods, otherwise I think we are good to go!

brunoocasali · 2023-09-05T22:08:53Z

lib/src/client.dart

@@ -125,6 +125,35 @@ class MeiliSearchClient {
    return Task.fromMap(response.data!);
  }

+  /// Get the status of all experimental features that can be toggled at runtime
+  @RequiredMeiliServerVersion('1.3.0')
+  Future<ExperimentalFeatures> getExperimentalFeatures() async {


We did not provide these kinds of methods to the other SDKs. I understand they are very convenient during development but we believe they are not useful after that, since you only enable/disable once :)

I can mark them as internal as a warning to users to not use this

I think that's ok to keep, my concern is because it is more code to maintain and it will be present only in this SDK :)

brunoocasali

🎉 🎉 🎉
bors merge

meili-bors · 2023-09-14T13:33:53Z

Build succeeded:

integration-tests (dart 3.0.0)
linter-check
pana

ahmednfwela added 8 commits September 1, 2023 10:01

feat(search): add vector, showRankingScore, showRankingScoreDetails t…

1dc8eb4

…o search query.

feat(client): add getExperimentalFeatures and `updateExperimentalFe…

9e12faa

…atures` to MeiliSearchClient

feat: added json_annotation as dependency

a9854d8

feat(client): ExperimentalFeatures models

9e5e5ed

chore: update CONTRIBUTING.md

e683d69

feat(search): introduce MeiliDocumentContainer<T> with experimental r…

3d04019

…anking rule details

fix(search): remove misplaced matchesPosition property from the ret…

6f0fbd8

…urned search result. feat(search): added experimental vector. feat(search): added `mapToContainer` extension on Searcheable<T> and its children, to simplify wrapping documents.

chore: add tests

35ddb33

ahmednfwela requested a review from brunoocasali September 1, 2023 07:40

ahmednfwela changed the title ~~Result container~~ Add Result container Sep 1, 2023

format

7c86107

ahmednfwela commented Sep 1, 2023

View reviewed changes

ahmednfwela added 2 commits September 1, 2023 12:09

updated code samples

affe32d

Merge branch 'main' of github.com:meilisearch/meilisearch-dart into r…

e7980d4

…esult-container

brunoocasali previously approved these changes Sep 5, 2023

View reviewed changes

ahmednfwela mentioned this pull request Sep 6, 2023

make _formatted value user friendly :) meilisearch/meilisearch-dotnet#406

Open

3 tasks

brunoocasali added the breaking-change The related changes are breaking for the users label Sep 14, 2023

ahmednfwela added 2 commits September 14, 2023 16:26

mark experimental features as visibleForTesting

0c3f5ca

ExperimentalFeatures are internal, don't export them.

fab1ea4

ahmednfwela dismissed brunoocasali’s stale review via fab1ea4 September 14, 2023 13:30

Merge branch 'main' into result-container

6ebd988

brunoocasali approved these changes Sep 14, 2023

View reviewed changes

ahmednfwela merged commit 656bd85 into main Sep 14, 2023
4 of 6 checks passed

ahmednfwela deleted the result-container branch September 14, 2023 13:33

ahmednfwela mentioned this pull request Sep 14, 2023

Add section about the new MeiliDocumentContainer<T> class in readme #356

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Result container #350

Add Result container #350

ahmednfwela commented Sep 1, 2023 •

edited

Loading

codecov-commenter commented Sep 1, 2023 •

edited by codecov bot

Loading

ahmednfwela left a comment

ahmednfwela Sep 1, 2023

ahmednfwela Sep 1, 2023

ahmednfwela Sep 1, 2023

ahmednfwela Sep 1, 2023

ahmednfwela Sep 1, 2023

ahmednfwela Sep 1, 2023

ahmednfwela Sep 1, 2023

ahmednfwela Sep 1, 2023

ahmednfwela Sep 1, 2023

brunoocasali left a comment

brunoocasali Sep 5, 2023

ahmednfwela Sep 5, 2023

brunoocasali Sep 6, 2023

brunoocasali left a comment

meili-bors bot commented Sep 14, 2023

Add Result container #350

Add Result container #350

Conversation

ahmednfwela commented Sep 1, 2023 • edited Loading

Pull Request

Related issue

What does this PR do?

PR checklist

codecov-commenter commented Sep 1, 2023 • edited by codecov bot Loading

Codecov Report

ahmednfwela left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brunoocasali left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brunoocasali left a comment

Choose a reason for hiding this comment

meili-bors bot commented Sep 14, 2023

ahmednfwela commented Sep 1, 2023 •

edited

Loading

codecov-commenter commented Sep 1, 2023 •

edited by codecov bot

Loading