Add retry in templates to wait realtime notifications

src/sdk-reference/js/6/realtime/subscribe/snippets/user-notifications.js

@@ -1,28 +1,13 @@
 function callback (notification) {
   if (notification.type === 'user') {
-    console.log(notification);
+    console.log(notification.volatile);
     /*
-    { status: 200,
-      timestamp: 1539696822690,
-      volatile: { sdkVersion: '6.0.0-beta-2', username: 'nina vkote' },
-      index: 'nyc-open-data',
-      collection: 'yellow-taxi',
-      controller: 'realtime',
-      action: 'subscribe',
-      protocol: 'websocket',
-      user: 'in',
-      result: { count: 2 },
-      type: 'user',
-      room: '14b675feccf5ac320456ef0dbdf6c1fa-0bab84b784bbf372' }
+      { sdkVersion: '<current SDK version>', username: 'nina vkote' },
     */
     console.log(`Currently ${notification.result.count} users in the room`);
   }
 }
 
-// instantiate a second kuzzle client because
-// the same sdk instance does not receive his own notifications
-const fuzzle = new Kuzzle('websocket', { host: 'kuzzle' });
-
 try {
   const filters = { exists: 'name' };
   // Subscribe users notifications
@@ -36,19 +21,21 @@ try {
     options
   );
 
+  // instantiate a second kuzzle client because
+  // subscribing again to the same filters won't be considered
+  // by Kuzzle as new users
+  const kuzzle2 = new Kuzzle('websocket', { host: 'kuzzle' });
+  await kuzzle2.connect();
+
   // Subscribe to the same room with the second client
-  const opfions = { users: 'all', volatile: { username: 'nina vkote' } };
-  await fuzzle.connect();
-  await fuzzle.realtime.subscribe(
+  const options2 = { users: 'all', volatile: { username: 'nina vkote' } };
+  await kuzzle2.realtime.subscribe(
     'nyc-open-data',
     'yellow-taxi',
     filters,
     () => {},
-    opfions
+    options2
   );
-
-  await kuzzle.realtime.unsubscribe(roomId);
-  fuzzle.disconnect();
 } catch (error) {
   console.log(error.message);
-}
+}

src/sdk-reference/js/6/realtime/subscribe/snippets/user-notifications.test.yml

@@ -4,4 +4,6 @@ hooks:
   before: curl -X POST kuzzle:7512/nyc-open-data/_create ; curl -X PUT kuzzle:7512/nyc-open-data/yellow-taxi/
   after:
 template: realtime
-expected: Currently 2 users in the room
+expected:
+  - "username: 'nina vkote'"
+  - "Currently 2 users in the room"

test/lib/runners/baseRunner.js

@@ -62,10 +62,12 @@ module.exports = class BaseRunner {
             previous = null;
 
           for (const e of expected) {
-            let match = null;
+            let
+              match = null,
+              index;
 
-            for (let i = 0; i < stdout.length && match === null; i++) {
-              match = stdout[i].match(e);
+            for (index = 0; index < stdout.length && match === null; index++) {
+              match = stdout[index].match(e);
             }
 
             if (match === null) {
@@ -76,14 +78,15 @@ module.exports = class BaseRunner {
               }));
             }
 
-            if (match.index < lastIndex) {
+            if (index < lastIndex) {
               return reject(new TestResult({
                 code: 'ERR_ORDER',
-                actualOrder: [previous, e]
+                actualOrder: [previous, e],
+                actual: stdout
               }));
             }
 
-            lastIndex = match.index;
+            lastIndex = index;
             previous = e;
           }
 

test/templates/realtime.tpl.js

@@ -38,6 +38,7 @@ function sleep (ms) {
     console.log = consoleLog;
     console.log(...outputs);
 
-    kuzzle.disconnect();
+    // force exit: do not wait for the event loop to be empty
+    process.exit(0);
   }
 })();