Add document:create by y-abs · Pull Request #55 · kuzzleio/sdk-java

y-abs · 2020-02-06T17:18:44Z

What does this PR do ?

This PR initiate the document controller and implements the create method with its unit tests.

How should this be manually tested?

Clone this branch and run unit tests
./gradlew test

When it succeed, compile it

./gradlew jar

Initiate another java project by adding the compiled SDK as a dependency.

Then, run Kuzzle, create an index nyc-open-data and a yellow-taxi collection in the admin console.
Finally, run this code

import io.kuzzle.sdk.*;
import io.kuzzle.sdk.Options.KuzzleOptions;
import io.kuzzle.sdk.Options.Protocol.WebSocketOptions;
import io.kuzzle.sdk.Protocol.WebSocket;

import java.util.concurrent.ConcurrentHashMap;

public class createDocument {
    private static Kuzzle kuzzle;

    public static void main(String[] args) {
        WebSocketOptions opts = new WebSocketOptions();
        opts.setAutoReconnect(true).setConnectionTimeout(42000);

        try {
            WebSocket ws = new WebSocket("localhost", opts);

            kuzzle = new Kuzzle(ws, (KuzzleOptions) null);

            kuzzle.connect();

            ConcurrentHashMap<String, Object> content = new ConcurrentHashMap<>();
            content.put("name", "Yoann");
            content.put("nickname", "El angel de la muerte que hace el JAVA");

            ConcurrentHashMap<String, Object> options = new ConcurrentHashMap<>();
            options.put("_id", "some-id");
            options.put("waitForRefresh", true);

            kuzzle.getDocumentController().create("nyc-open-data", "yellow-taxi", content, options)
            .get();
            System.out.println("New document added to the yellow-taxi collection!");
        }  catch (Exception e) {
            e.printStackTrace();
        }

        kuzzle.disconnect();
    }
};

You should see the document in your collection.
You can test without options as well

Other changes

Update .travis.yml -> Add a stage for the Unit Tests

Boyscout

remove useless import

scottinet · 2020-02-07T15:49:13Z

+      final String collection,
+      final ConcurrentHashMap<String, Object> document,
+      final String _id,
+      final ConcurrentHashMap<String, Object> options) throws NotConnectedException, InternalException


A couple weeks ago, @jenow and I decided to amend our confluence document detailing how optional parameters should be handled by SDKs. Long story short: overloads must be used for methods taking only 1 optional argument, and option objects should only be used when there are 2 or more options.

This has been decided because this greatly simplifies the API exposed by SDKs, as well as our code base.

scottinet · 2020-02-07T15:54:04Z

+
+| Option     | Type        | Description                                                                                                
+| ---------- | ----------- | ---------------------------------------------------------------------------------- |
+| `refresh`  | string      | If set to `wait_for`, Kuzzle will wait for the persistence layer to finish indexing|


New SDKs have a waitForRefresh (boolean) option instead of that "refresh = 'wait_for'" one. This is easier to understand, and we'll probably make that update in Kuzzle's API in the future.

Check the query method in this SDK.

scottinet · 2020-02-07T15:54:40Z

+        .put("action", "create")
+        .put("_id", _id)
+        .put("body", document)
+        .put("options", options);


that's not how options should be handled, check the query method

Obviously, that was a mistake, sorry

scottinet · 2020-02-07T15:56:40Z

+    document.put("nickname", "El angel de la muerte que hace el JAVA");
+
+    ConcurrentHashMap<String, Object> options = new ConcurrentHashMap<>();
+    options.put("refresh", "wait_for");


if you put the option, then you need to verify that it is properly passed to the API object being sent to kuzzle (and if my remarks above are right, then it isn't)

Co-Authored-By: Adrien Maret <amaret93@gmail.com>

…o/sdk-java into KZL-1350-document-create

Aschen · 2020-02-20T08:07:50Z

    final KuzzleMap query = new KuzzleMap();
+    final KuzzleMap _options = KuzzleMap
+        .from(options);
+    final String _id = _options.getString("_id") == null ? UUID.randomUUID().toString() : _options.getString("_id");


You don't have to generate the document ID on the client side.

Aschen · 2020-02-20T08:08:22Z

-          final String _id) throws NotConnectedException, InternalException {
-    return this.create(index, collection, document, _id, false);
+    final ConcurrentHashMap<String, Object> options = new ConcurrentHashMap<>();
+    options.put("_id", UUID.randomUUID().toString());


Same, you don't have to generate the ID on client side

Aschen · 2020-02-20T08:08:58Z

-    return this.create(index, collection, document, _id, false);
+    final ConcurrentHashMap<String, Object> options = new ConcurrentHashMap<>();
+    options.put("_id", UUID.randomUUID().toString());
+    options.put("waitForRefresh", false);


The default value for waitFoRefresh must handled only on Kuzzle side

Aschen · 2020-02-20T12:01:17Z

+## Arguments
+
+```java
+public CompletableFuture<ConcurrentHashMap<String, Object>> create(


You should put the 2 possible signatures here

Aschen · 2020-02-21T05:01:21Z

+| ------------------ | -------------------------------------------- | --------------------------------- |
+| `index`            | <pre>string</pre>                            | Index                             |
+| `collection`       | <pre>string</pre>                            | Collection                        |
+| `content`          | <pre>ConcurrentHashMap<String, Object></pre> | Content of the document to create |


Should be document, as in the signature and the options should also be present in the tab

Aschen · 2020-02-21T05:02:22Z

+
+---
+
+# options


Why h1 title for this?

Aschen · 2020-02-21T05:02:55Z

+
+| Arguments          | Type                                         | Description                       |
+| ------------------ | -------------------------------------------- | --------------------------------- |
+| `id`               | <pre>string</pre> (optional)                 | Document identifier. Auto-generated if not specified              |


The correct type is String

Aschen · 2020-02-27T05:03:53Z

+  document.put("firstname", "John");
+  document.put("lastname", "Smith");
+
+  kuzzle.getDocumentController().create("nyc-open-data", "yellow-taxi", document)


Can you do the snippet test on something from the result as well as for the other methods?

Also can you add the result of the println in comment?
It helps developer to better apprehend the structure of the response object they have. We try to do this for every method (Look the Javascript SDK and Doc)

Co-Authored-By: Adrien Maret <amaret93@gmail.com>

jenow · 2020-03-02T08:55:02Z

+      final String index,
+      final String collection,
+      final ConcurrentHashMap<String, Object> document,
+      final ConcurrentHashMap<String, Object> options)


We should have a DocumentOptions class containing id and waitForRefresh

…va into KZL-1350-document-create

add document:create

7f0ea3f

y-abs added changelog:new-features wip labels Feb 6, 2020

y-abs self-assigned this Feb 6, 2020

doc

cd04900

y-abs removed the wip label Feb 7, 2020

y-abs added 5 commits February 7, 2020 15:13

doc

cca5cfb

update .travis.yml

84d015e

update .travis.yml

fcbfd4f

update .travis.yml

7a656ff

update .travis.yml

9ac5549

scottinet suggested changes Feb 7, 2020

View reviewed changes

Aschen suggested changes Feb 8, 2020

View reviewed changes

Comment thread doc/3/controllers/document/index.md Outdated

Comment thread doc/3/controllers/document/index.md Outdated

Comment thread doc/3/controllers/document/index.md Outdated

y-abs and others added 6 commits February 17, 2020 15:00

Merge branch '3-dev' into KZL-1350-document-create

c8e6a3d

Update doc/3/controllers/document/index.md

c6fa610

Co-Authored-By: Adrien Maret <amaret93@gmail.com>

Update doc/3/controllers/document/index.md

1286d02

Co-Authored-By: Adrien Maret <amaret93@gmail.com>

overloads

f52dde1

Merge branch 'KZL-1350-document-create' of https://github.com/kuzzlei…

43e49ef

…o/sdk-java into KZL-1350-document-create

remove useless opt

8d9da7e

y-abs requested review from Aschen, jenow and scottinet February 17, 2020 15:07

y-abs added 2 commits February 18, 2020 17:18

options object

b001ce7

remove useless import

37738a6

Aschen suggested changes Feb 20, 2020

View reviewed changes

@Aschen requested change

2c97572

Aschen suggested changes Feb 20, 2020

View reviewed changes

doc

cebebf8

y-abs requested a review from Aschen February 20, 2020 14:11

Aschen suggested changes Feb 21, 2020

View reviewed changes

y-abs added 2 commits February 26, 2020 13:36

requested changes

a7f58fb

waitForRefresh type

fbaf2c4

y-abs requested a review from scottinet February 26, 2020 16:28

Aschen suggested changes Feb 27, 2020

View reviewed changes

y-abs and others added 2 commits February 27, 2020 10:16

Update doc/3/controllers/document/create/index.md

b77b51d

Co-Authored-By: Adrien Maret <amaret93@gmail.com>

@Aschen requested change

5c64a9a

y-abs requested a review from Aschen February 28, 2020 14:13

jenow suggested changes Mar 2, 2020

View reviewed changes

doc

fbbea5c

y-abs force-pushed the KZL-1350-document-create branch from 76ea0f7 to fbbea5c Compare March 2, 2020 10:16

y-abs and others added 4 commits March 2, 2020 11:21

test [ci skip]

7f65e16

GIT brained [ci skip]

b1b1552

Merge branch '3-dev' into KZL-1350-document-create

a6938c5

update Kuzzle.java

dc21870

Aschen approved these changes Mar 2, 2020

View reviewed changes

scottinet approved these changes Mar 3, 2020

View reviewed changes

y-abs and others added 6 commits March 4, 2020 15:35

@jenow requested changes

30d5553

Merge branch 'KZL-1350-document-create' of github.com:kuzzleio/sdk-ja…

b63cd6b

…va into KZL-1350-document-create

conflict [ci skip]

98d1aed

Merge branch '3-dev' into KZL-1350-document-create

0576974

update DocumentController.java

904f2c8

update doc

fb944a6

y-abs requested a review from jenow March 4, 2020 15:36

y-abs and others added 3 commits March 4, 2020 16:39

doc

bea99e5

update DocumentOptions.java

f42797b

Merge branch '3-dev' into KZL-1350-document-create

2bbbff3

jenow approved these changes Mar 5, 2020

View reviewed changes

jenow merged commit ec454a5 into 3-dev Mar 5, 2020

jenow deleted the KZL-1350-document-create branch March 5, 2020 09:59

jenow mentioned this pull request May 11, 2020

3.0.0 #91

Merged


		---

		# options

Conversation

y-abs commented Feb 6, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do ?

How should this be manually tested?

Other changes

Boyscout

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

scottinet Feb 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

y-abs commented Feb 6, 2020 •

edited

Loading

scottinet Feb 7, 2020 •

edited

Loading