Merge #689 #695

689: Support user-dictionary loading #660 r=brunoocasali a=mesutgk15

# Pull Request

## Related issue
Fixes #660

## What does this PR do?
- Add a new setting as dictionary and get, update, reset methods for this setting 

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


695: Bump org.junit:junit-bom from 5.10.0 to 5.10.1 r=brunoocasali a=dependabot[bot]

Bumps [org.junit:junit-bom](https://github.com/junit-team/junit5) from 5.10.0 to 5.10.1.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a href="https://github.com/junit-team/junit5/releases">org.junit:junit-bom's releases</a>.</em></p>
<blockquote>
<p>JUnit 5.10.1 = Platform 1.10.1 + Jupiter 5.10.1 + Vintage 5.10.1</p>
<p>See <a href="http://junit.org/junit5/docs/5.10.1/release-notes/">Release Notes</a>.</p>
<p><strong>Full Changelog</strong>: <a href="https://github.com/junit-team/junit5/compare/r5.10.0...r5.10.1">https://github.com/junit-team/junit5/compare/r5.10.0...r5.10.1</a></p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/junit-team/junit5/commit/e5f50d8720741623915979ac154b65bcbcd6a577"><code>e5f50d8</code></a> Release 5.10.1</li>
<li><a href="https://github.com/junit-team/junit5/commit/ac86d18e9b15dbebe046e82743ac7f9534a17582"><code>ac86d18</code></a> Fix typo in AfterAll documentation</li>
<li><a href="https://github.com/junit-team/junit5/commit/388c5beaf42944961ab5b455c900d958a6e15588"><code>388c5be</code></a> Harmonize application of method and field filters in search algorithms</li>
<li><a href="https://github.com/junit-team/junit5/commit/f82dd1e716f8717e012152b1d1d5cc0da10d33cd"><code>f82dd1e</code></a> Apply field predicate before searching type hierarchy</li>
<li><a href="https://github.com/junit-team/junit5/commit/1d1eb8571552bbf28e578241965010de6c8ee779"><code>1d1eb85</code></a> Polishing</li>
<li><a href="https://github.com/junit-team/junit5/commit/5ce280eff69b43759a3cb0c176207abe0a41b579"><code>5ce280e</code></a> Update picocli to 4.7.5 and enable help width computation</li>
<li><a href="https://github.com/junit-team/junit5/commit/fea05c3aa80de76686f326b5ce26ddf7f153ff5a"><code>fea05c3</code></a> Fix ConsoleLauncherTests and StandaloneTests</li>
<li><a href="https://github.com/junit-team/junit5/commit/c5567354c2556e772f8a0035ef7647161011d1c0"><code>c556735</code></a> Use same expected files for all JDK versions</li>
<li><a href="https://github.com/junit-team/junit5/commit/808493ab09b30970b506a48fda3d616ac1ba4fff"><code>808493a</code></a> Run StandaloneTests for Java 8 under Java 8</li>
<li><a href="https://github.com/junit-team/junit5/commit/9ec57661c78c3889db004ab6a89416e56a2fb2e0"><code>9ec5766</code></a> Unify messages about exit codes in StandaloneTests</li>
<li>Additional commits viewable in <a href="https://github.com/junit-team/junit5/compare/r5.10.0...r5.10.1">compare view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=org.junit:junit-bom&package-manager=gradle&previous-version=5.10.0&new-version=5.10.1)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

You can trigger a rebase of this PR by commenting ``@dependabot` rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- ``@dependabot` rebase` will rebase this PR
- ``@dependabot` recreate` will recreate this PR, overwriting any edits that have been made to it
- ``@dependabot` merge` will merge this PR after your CI passes on it
- ``@dependabot` squash and merge` will squash and merge this PR after your CI passes on it
- ``@dependabot` cancel merge` will cancel a previously requested merge and block automerging
- ``@dependabot` reopen` will reopen this PR if it is closed
- ``@dependabot` close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- ``@dependabot` show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency
- ``@dependabot` ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- ``@dependabot` ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- ``@dependabot` ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)


</details>

Co-authored-by: mesut <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Author: 3 people

.code-samples.meilisearch.yaml

@@ -280,6 +280,12 @@ update_faceting_settings_1: |-
   client.index("books").updateFacetingSettings(newFaceting);
 reset_faceting_settings_1: |-
   client.index("books").resetFacetingSettings();
+get_dictionary_1: |-
+  client.index("books").getDictionarySettings();
+update_dictionary_1: |-
+  client.index("books").updateDictionarySettings(new String[] {"J. R. R.", "W. E. B."});
+reset_dictionary_1: |-
+  client.index("books").resetDictionarySettings();
 get_index_stats_1: |-
   client.index("movies").getStats();
 get_indexes_stats_1: |-

build.gradle

@@ -56,7 +56,7 @@ dependencies {
 	api 'com.squareup.okhttp3:okhttp:[4.10.0,5.0.0)'
 
 	// Use JUnit test framework
-	testImplementation(platform('org.junit:junit-bom:5.10.0'))
+	testImplementation(platform('org.junit:junit-bom:5.10.1'))
 	testImplementation('org.junit.jupiter:junit-jupiter:5.10.0')
 	// https://mvnrepository.com/artifact/org.mockito/mockito-core
 	testImplementation 'org.mockito:mockito-core:4.9.0'

src/main/java/com/meilisearch/sdk/Index.java

@@ -832,6 +832,43 @@ public TaskInfo resetFacetingSettings() throws MeilisearchException {
         return this.settingsHandler.resetFacetingSettings(this.uid);
     }
 
+    /**
+     * Gets the dictionary settings of the index
+     *
+     * @return dictionary of a given uid as String
+     * @throws MeilisearchException if an error occurs
+     * @see <a href="https://www.meilisearch.com/docs/reference/api/settings#get-dictionary">API
+     *     specification</a>
+     */
+    public String[] getDictionarySettings() throws MeilisearchException {
+        return this.settingsHandler.getDictionarySettings(this.uid);
+    }
+
+    /**
+     * Updates the dictionary settings of the index
+     *
+     * @param dictionary An array of strings that contains the dictionary.
+     * @return TaskInfo instance
+     * @throws MeilisearchException if an error occurs
+     * @see <a href="https://www.meilisearch.com/docs/reference/api/settings#update-dictionary">API
+     *     specification</a>
+     */
+    public TaskInfo updateDictionarySettings(String[] dictionary) throws MeilisearchException {
+        return this.settingsHandler.updateDictionarySettings(this.uid, dictionary);
+    }
+
+    /**
+     * Resets the dictionary settings of the index
+     *
+     * @return TaskInfo instance
+     * @throws MeilisearchException if an error occurs
+     * @see <a href="https://www.meilisearch.com/docs/reference/api/settings#reset-dictionary">API
+     *     specification</a>
+     */
+    public TaskInfo resetDictionarySettings() throws MeilisearchException {
+        return this.settingsHandler.resetDictionarySettings(this.uid);
+    }
+
     /**
      * Gets extended information and metrics about indexes and the Meilisearch database
      *

src/main/java/com/meilisearch/sdk/SettingsHandler.java

@@ -515,6 +515,44 @@ TaskInfo resetFacetingSettings(String uid) throws MeilisearchException {
                 settingsPath(uid).addSubroute("faceting").getURL(), TaskInfo.class);
     }
 
+    /**
+     * Gets the dictionary settings of the index
+     *
+     * @param uid Index identifier
+     * @return an array of strings that contains the dictionary
+     * @throws MeilisearchException if an error occurs
+     */
+    String[] getDictionarySettings(String uid) throws MeilisearchException {
+        return httpClient.get(settingsPath(uid).addSubroute("dictionary").getURL(), String[].class);
+    }
+
+    /**
+     * Updates the dictionary settings of the index
+     *
+     * @param uid Index identifier
+     * @param dictionary an array of strings that contains the new dictionary settings
+     * @return TaskInfo instance
+     * @throws MeilisearchException if an error occurs
+     */
+    TaskInfo updateDictionarySettings(String uid, String[] dictionary) throws MeilisearchException {
+        return httpClient.put(
+                settingsPath(uid).addSubroute("dictionary").getURL(),
+                dictionary == null ? httpClient.jsonHandler.encode(dictionary) : dictionary,
+                TaskInfo.class);
+    }
+
+    /**
+     * Resets the dictionary settings of the index
+     *
+     * @param uid Index identifier
+     * @return TaskInfo instance
+     * @throws MeilisearchException if an error occurs
+     */
+    TaskInfo resetDictionarySettings(String uid) throws MeilisearchException {
+        return httpClient.delete(
+                settingsPath(uid).addSubroute("dictionary").getURL(), TaskInfo.class);
+    }
+
     /** Creates an URLBuilder for the constant route settings */
     private URLBuilder settingsPath(String uid) {
         return new URLBuilder("/indexes").addSubroute(uid).addSubroute("/settings");

src/main/java/com/meilisearch/sdk/model/Settings.java

@@ -26,6 +26,7 @@ public class Settings {
     protected TypoTolerance typoTolerance;
     protected Pagination pagination;
     protected Faceting faceting;
+    protected String[] dictionary;
 
     public Settings() {}
 }

src/test/java/com/meilisearch/integration/SettingsTest.java

@@ -1057,6 +1057,54 @@ public void testResetFacetingSettings() throws Exception {
         assertThat(facetingAfterReset.getMaxValuesPerFacet(), is(equalTo(100)));
     }
 
+    /** Tests of the dictionary setting methods */
+    @Test
+    @DisplayName("Test get dictionary settings by uid")
+    public void testGetDictionarySettings() throws Exception {
+        Index index = createIndex("testGetDictionarySettings");
+        Settings initialSettings = index.getSettings();
+        String[] initialDictionary = index.getDictionarySettings();
+
+        assertThat(initialDictionary, is(arrayWithSize(initialSettings.getDictionary().length)));
+        assertThat(initialDictionary, is(equalTo(initialSettings.getDictionary())));
+    }
+
+    @Test
+    @DisplayName("Test update dictionary settings")
+    public void testUpdateDictionarySettings() throws Exception {
+        Index index = createIndex("testUpdateDictionarySettings");
+        String[] initialDictionary = index.getDictionarySettings();
+        String[] newDictionary = {"J. R. R.", "W. E. B."};
+
+        index.waitForTask(index.updateDictionarySettings(newDictionary).getTaskUid());
+        String[] updatedDictionarySettings = index.getDictionarySettings();
+
+        assertThat(updatedDictionarySettings, is(arrayWithSize(newDictionary.length)));
+        assertThat(updatedDictionarySettings, is(equalTo(newDictionary)));
+        assertThat(updatedDictionarySettings, is(not(arrayWithSize(initialDictionary.length))));
+    }
+
+    @Test
+    @DisplayName("Test reset dictionary settings")
+    public void testResetDictionarySettings() throws Exception {
+        Index index = createIndex("testResetDictionarySettings");
+        String[] initialDictionary = index.getDictionarySettings();
+        String[] newDictionary = {"J. R. R.", "W. E. B."};
+
+        index.waitForTask(index.updateDictionarySettings(newDictionary).getTaskUid());
+        String[] updatedDictionarySettings = index.getDictionarySettings();
+
+        index.waitForTask(index.resetDictionarySettings().getTaskUid());
+        String[] dictionaryAfterReset = index.getDictionarySettings();
+
+        assertThat(updatedDictionarySettings, is(arrayWithSize(newDictionary.length)));
+        assertThat(updatedDictionarySettings, is(equalTo(newDictionary)));
+        assertThat(updatedDictionarySettings, is(not(arrayWithSize(initialDictionary.length))));
+        assertThat(dictionaryAfterReset, is(not(arrayWithSize(updatedDictionarySettings.length))));
+        assertThat(dictionaryAfterReset, is(arrayWithSize(initialDictionary.length)));
+        assertThat(dictionaryAfterReset, is(equalTo(initialDictionary)));
+    }
+
     private Index createIndex(String indexUid) throws Exception {
         Index index = client.index(indexUid);
         TaskInfo updateInfo = index.addDocuments(testData.getRaw());