Merge pull request #101 from kuzzleio/3-dev

Shiranuit · web-flow · commit fcf31f4b4b16 · 2020-11-20T19:29:50.000+01:00
Release SDK Java 3.0.1
diff --git a/.travis.yml b/.travis.yml
@@ -13,22 +13,22 @@ env:
 # ------------------------
 jobs:
   include:
-    - stage: Tests
-      name: Dead link check
-      if:
-        type = pull_request OR type = push AND branch =~ /^master|[0-9]+-(dev|stable)$/
-        OR type = cron
-      language: node_js
-      node_js: 12
-      before_script:
-        - npm ci
-        - npm run doc-prepare
-        - $(npm bin)/kuzdoc iterate-repos:install --repos_path doc/framework/.repos/
-        - $(npm bin)/kuzdoc framework:link -d /sdk/java/3/ -v 3
-
-      script:
-        - gem install typhoeus
-        - cd doc/framework/ && HYDRA_MAX_CONCURRENCY=20 ruby .ci/dead-links.rb -p src/sdk/java/3/
+    # - stage: Tests
+    #   name: Dead link check
+    #   if:
+    #     type = pull_request OR type = push AND branch =~ /^master|[0-9]+-(dev|stable)$/
+    #     OR type = cron
+    #   language: node_js
+    #   node_js: 12
+    #   before_script:
+    #     - npm ci
+    #     - npm run doc-prepare
+    #     - $(npm bin)/kuzdoc iterate-repos:install --repos_path doc/framework/.repos/
+    #     - $(npm bin)/kuzdoc framework:link -d /sdk/java/3/ -v 3
+
+    #   script:
+    #     - gem install typhoeus
+    #     - cd doc/framework/ && HYDRA_MAX_CONCURRENCY=20 ruby .ci/dead-links.rb -p src/sdk/java/3/
 
 
     - stage: Tests
diff --git a/doc/3/controllers/collection/list/index.md b/doc/3/controllers/collection/list/index.md
@@ -29,7 +29,7 @@ Returns a `ConcurrentHashMap<String, Object>` containing the following propertie
 | Property      | Type                | Description                                                        |
 | ------------- | ------------------- | ------------------------------------------------------------------ |
 | `type`        | <pre>String</pre>   | Types of returned collections <br/>(`all`, `realtime` or `stored`) |
-| `collections` | <pre>ArrayList<Object></pre> | List of collections                                                |
+| `collections` | `ArrayList<Object>` | List of collections                                                |
 | `from`        | <pre>Integer</pre>   | Offset of the first result                                         |
 | `size`        | <pre>Integer</pre>   | Maximum number of returned results                                 |
 
diff --git a/doc/3/controllers/collection/update/index.md b/doc/3/controllers/collection/update/index.md
@@ -0,0 +1,66 @@
+---
+code: true
+type: page
+title: update
+description: Update the collection mapping
+---
+
+# update
+
+<SinceBadge version="Kuzzle 2.1.0" />
+
+You can define the collection [dynamic mapping policy](/core/2/guides/essentials/database-mappings#dynamic-mapping-policy) by setting the `dynamic` field to the desired value.
+
+You can define [collection additional metadata](/core/2/guides/essentials/database-mappings#collection-metadata) within the `_meta` root field.
+
+<br/>
+
+```java
+  public CompletableFuture<Void> update(
+      final String index,
+      final String collection,
+      final ConcurrentHashMap<String, Object> mapping)
+```
+
+<br/>
+
+| Arguments    | Type                                         | Description                                                                                                                                                                   |
+| ------------ | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `index`      | <pre>String</pre>                            | Index name                                                                                                                                                                    |
+| `collection` | <pre>String</pre>                            | Collection name                                                                                                                                                               |
+| `mapping`    | <pre>ConcurrentHashMap<String, Object></pre> | Describes the collection mapping  |
+
+### mapping
+
+A `ConcurrentHashMap<String, Object>` representing the collection data mapping.
+
+It must have a root field `properties` that contain the mapping definition:
+
+```java
+{
+  mappings={
+    dynamic="[true|false|strict]",
+    _meta={
+      field="value"
+  },
+    properties={
+      field1={ type='text' },
+      field2={
+        properties={
+          nestedField={ type='keyword' }
+        }
+      }
+    }
+  }
+};
+```
+
+More information about database mappings [here](/core/2/guides/essentials/database-mappings).
+
+## Returns
+
+Returns a `CompletableFuture<Void>`.
+
+## Usage
+
+<<< ./snippets/update.java
diff --git a/doc/3/controllers/collection/update/snippets/update.java b/doc/3/controllers/collection/update/snippets/update.java
@@ -0,0 +1,12 @@
+    ConcurrentHashMap<String, Object> mapping = new ConcurrentHashMap<>();
+    ConcurrentHashMap<String, Object> properties = new ConcurrentHashMap<>();
+    ConcurrentHashMap<String, Object> license = new ConcurrentHashMap<>();
+
+    license.put("type", "keyword");
+    properties.put("license", license);
+    mapping.put("properties", properties);
+
+    kuzzle
+        .getCollectionController()
+        .update("nyc-open-data", "yellow-taxi", mapping)
+        .get();
diff --git a/doc/3/controllers/collection/update/snippets/update.test.yml b/doc/3/controllers/collection/update/snippets/update.test.yml
@@ -0,0 +1,7 @@
+name: collection#update
+description: Update the collection mapping
+hooks:
+  before: curl -X POST kuzzle:7512/nyc-open-data/_create && curl -X PUT kuzzle:7512/nyc-open-data/yellow-taxi
+  after:
+template: default
+expected: Success
diff --git a/doc/3/controllers/collection/validate-specifications/index.md b/doc/3/controllers/collection/validate-specifications/index.md
@@ -43,7 +43,7 @@ It contains the following properties:
 | Property      | Type                         | Description                  |
 | ------------- | ---------------------------- | ---------------------------- |
 | `valid`       | <pre>Boolean</pre>           | Specifications validity      |
-| `details`     | <pre>ArrayList<String></pre> | Specifications errors        |
+| `details`     | `ArrayList<String>` | Specifications errors        |
 | `description` | <pre>String</pre>            | Global description of errors |
 
 ## Usage
diff --git a/doc/3/controllers/document/m-delete/index.md b/doc/3/controllers/document/m-delete/index.md
@@ -26,7 +26,7 @@ throws NotConnectedException, InternalException
 | ------------------ | ------------------------------------------------------- | --------------------------------- |
 | `index`            | <pre>String</pre>                                       | Index name                        |
 | `collection`       | <pre>String</pre>                                       | Collection name                   |
-| `ids`              | <pre>ArrayList<String></pre>                            | Document IDs                      |
+| `ids`              | `ArrayList<String>`                            | Document IDs                      |
 ---
 
 ## Return
diff --git a/doc/3/controllers/document/m-get/index.md b/doc/3/controllers/document/m-get/index.md
@@ -26,7 +26,7 @@ throws NotConnectedException, InternalException
 | ------------------ | ------------------------------------------------------- | --------------------------------- |
 | `index`            | <pre>String</pre>                                       | Index name                        |
 | `collection`       | <pre>String</pre>                                       | Collection name                   |
-| `ids`              | <pre>ArrayList<String></pre>                            | Document IDs                      |
+| `ids`              | `ArrayList<String>`                            | Document IDs                      |
 ---
 
 ## Return
diff --git a/doc/3/controllers/document/update/snippets/update.test.yml b/doc/3/controllers/document/update/snippets/update.test.yml
@@ -8,4 +8,4 @@ hooks:
     curl -XPOST -d '{"name":"John"}' -H "Content-Type: application/json" kuzzle:7512/nyc-open-data/yellow-taxi/some-id/_create
   after:
 template: print-result
-expected: ^{_source={name=Johny,\ _kuzzle_info={updatedAt=[0-9]+,\ updater=-1}},\ _id=some-id,\ _version=2}$
+expected: "_id=some-id, _version=2"
diff --git a/doc/3/controllers/index/m-delete/index.md b/doc/3/controllers/index/m-delete/index.md
@@ -18,7 +18,7 @@ CompletableFuture<ArrayList<String>> mDelete(final ArrayList<String> indexes)
 
 | Argument  | Type              | Description           |
 |-----------|-------------------|-----------------------|
-| `indexes` | <pre>ArrayList<String></pre> | List of indexes names |
+| `indexes` | `ArrayList<String>` | List of indexes names |
 
 ## Return
 
diff --git a/doc/3/controllers/realtime/subscribe/index.md b/doc/3/controllers/realtime/subscribe/index.md
@@ -23,7 +23,7 @@ public CompletableFuture<String> subscribe(
 
 | Argument     | Type                                    | Description                                                                                                    |
 |--------------|-----------------------------------------|----------------------------------------------------------------------------------------------------------------|
-| `index`      | <pre>String/pre>                       | Index name                                                                                                     |
+| `index`      | <pre>String</pre>                       | Index name                                                                                                     |
 | `collection` | <pre>String</pre>                       | Collection name                                                                                                |
 | `filters`    | <pre>ConcurrentHashMap<String, Object></pre>                      | ConcurrentHashMap representing a set of filters following [Koncorde syntax](/core/2/guides/cookbooks/realtime-api/terms) |
 | `handler`   | <pre>NotificationHandler</pre>          | Handler function to handle notifications                                                                      |
diff --git a/doc/3/index.md b/doc/3/index.md
@@ -5,3 +5,5 @@ order: 9
 title: JAVA SDK
 description: JAVA SDK 3.x
 ---
+
+<RedirectToFirstChild />
diff --git a/doc/doc.sh b/doc/doc.sh
diff --git a/src/main/java/io/kuzzle/sdk/API/Controllers/CollectionController.java b/src/main/java/io/kuzzle/sdk/API/Controllers/CollectionController.java
@@ -139,6 +139,36 @@ public CompletableFuture<ConcurrentHashMap<String, Object>> getMapping(
             (response) -> (ConcurrentHashMap<String, Object>) response.result);
   }
 
+  /**
+   * Updates collection mapping.
+   *
+   * @param index
+   * @param collection
+   * @param mapping
+   * @return a CompletableFuture
+   * @throws NotConnectedException
+   * @throws InternalException
+   */
+  public CompletableFuture<Void> update(
+      final String index,
+      final String collection,
+      final ConcurrentHashMap<String, Object> mapping) throws NotConnectedException, InternalException {
+
+    final KuzzleMap query = new KuzzleMap();
+
+    query
+        .put("index", index)
+        .put("collection", collection)
+        .put("controller", "collection")
+        .put("action", "update")
+        .put("body", new KuzzleMap(mapping));
+
+    return kuzzle
+        .query(query)
+        .thenApplyAsync(
+            (response) -> null);
+  }
+
   /**
    * Refreshes collection.
    *
diff --git a/src/main/java/io/kuzzle/sdk/Kuzzle.java b/src/main/java/io/kuzzle/sdk/Kuzzle.java
@@ -197,16 +197,15 @@ protected void onResponseReceived(final Object... payload) {
       return;
     }
 
-    if (response.error.id == null
-        || !response.error.id.equals("security.token.expired")) {
-      final Task<Response> task = requests.get(response.requestId);
-      if (task != null) {
-        task.setException(new ApiErrorException(response));
-      }
-      return;
+    final Task<Response> task = requests.get(response.requestId);
+    if (task != null) {
+      task.setException(new ApiErrorException(response));
     }
+    requests.remove(response.requestId);
 
-    super.trigger(Event.tokenExpired);
+    if (response.error.id != null && response.error.id.equals("security.token.expired")) {
+      super.trigger(Event.tokenExpired);
+    }
   }
 
   protected void onStateChanged(final Object... args) {
diff --git a/src/test/java/io/kuzzle/test/API/Controllers/CollectionTest.java b/src/test/java/io/kuzzle/test/API/Controllers/CollectionTest.java
@@ -186,6 +186,62 @@ public void getMappingShouldThrowWhenNotConnected() throws NotConnectedException
     kuzzleMock.getCollectionController().getMapping(index, collection);
   }
 
+  @Test
+  public void updateCollectionTest() throws NotConnectedException, InternalException {
+
+    Kuzzle kuzzleMock = spy(new Kuzzle(networkProtocol));
+    String index = "nyc-open-data";
+    String collection = "yellow-taxi";
+
+    ArgumentCaptor<KuzzleMap> arg = ArgumentCaptor.forClass(KuzzleMap.class);
+
+    ConcurrentHashMap<String, Object> mapping = new ConcurrentHashMap<>();
+    ConcurrentHashMap<String, Object> properties = new ConcurrentHashMap<>();
+    ConcurrentHashMap<String, Object> license = new ConcurrentHashMap<>();
+
+    license.put("type", "keyword");
+    properties.put("license", license);
+    mapping.put("properties", properties);
+
+    kuzzleMock.getCollectionController().update(index, collection, mapping);
+    Mockito.verify(kuzzleMock, Mockito.times(1)).query(arg.capture());
+
+    assertEquals((arg.getValue()).getString("controller"), "collection");
+    assertEquals((arg.getValue()).getString("action"), "update");
+    assertEquals((arg.getValue()).getString("index"), "nyc-open-data");
+    assertEquals((arg.getValue()).getString("collection"), "yellow-taxi");
+    assertEquals((
+        (ConcurrentHashMap<String, Object>) (
+            (ConcurrentHashMap<String, Object>) (
+                ((ConcurrentHashMap<String, Object>)
+                    ((arg.getValue())
+                        .get("body")))
+                    .get("properties")))
+            .get("license"))
+        .get("type").toString(), "keyword");
+  }
+
+  @Test(expected = NotConnectedException.class)
+  public void updateCollectionThrowWhenNotConnected() throws NotConnectedException, InternalException {
+
+    AbstractProtocol fakeNetworkProtocol = Mockito.mock(WebSocket.class);
+    Mockito.when(fakeNetworkProtocol.getState()).thenAnswer((Answer<ProtocolState>) invocation -> ProtocolState.CLOSE);
+
+    Kuzzle kuzzleMock = spy(new Kuzzle(fakeNetworkProtocol));
+    String index = "nyc-open-data";
+    String collection = "yellow-taxi";
+
+    ConcurrentHashMap<String, Object> mapping = new ConcurrentHashMap<>();
+    ConcurrentHashMap<String, Object> properties = new ConcurrentHashMap<>();
+    ConcurrentHashMap<String, Object> license = new ConcurrentHashMap<>();
+
+    license.put("type", "keyword");
+    properties.put("license", license);
+    mapping.put("properties", properties);
+
+    kuzzleMock.getCollectionController().update(index, collection, mapping);
+  }
+
   @Test
   public void refreshCollectionTest() throws NotConnectedException, InternalException {
 
diff --git a/src/test/java/io/kuzzle/test/API/Controllers/DocumentTest.java b/src/test/java/io/kuzzle/test/API/Controllers/DocumentTest.java
