Add keep-alive mechanism to detect connection lost with realtime protocols (#586)

Yoann-Abbes · web-flow · commit be40b19b9bba · 2021-02-17T07:12:05.000+01:00
Terminate a connection when the connection is lost by using the ping/pong mechanism
diff --git a/.ci/doc/docker-compose.yml b/.ci/doc/docker-compose.yml
@@ -44,7 +44,7 @@ services:
       - CONFIG_FILE=/mnt/.ci/doc/config.yml
 
   doc-runner-node:
-    image: node:10-alpine
+    image: node:12-alpine
     command: >
       ash -c '
         mkdir -p /var/snippets/node;
diff --git a/.ci/doc/templates/blank.tpl.js b/.ci/doc/templates/blank.tpl.js
@@ -7,7 +7,7 @@ const
   } = require('kuzzle-sdk');
 
 const kuzzle = new Kuzzle(
-  new WebSocket('kuzzle')
+  new WebSocket('kuzzle', { pingInterval: 2000 })
 );
 
 [snippet-code]
diff --git a/.ci/doc/templates/catch.tpl.js b/.ci/doc/templates/catch.tpl.js
@@ -7,7 +7,7 @@ const {
 // Instantiates a Kuzzle client
 const
   kuzzle = new Kuzzle(
-    new WebSocket('kuzzle', { autoReconnect: false })
+    new WebSocket('kuzzle', { autoReconnect: false, pingInterval: 2000 })
   );
 
 // Adds a listener to detect any connection problems
diff --git a/.ci/doc/templates/createDocumentAfterSnippet.tpl.js b/.ci/doc/templates/createDocumentAfterSnippet.tpl.js
@@ -5,7 +5,7 @@
 
 // Require a kuzzle instance assigning it to a weird variable to avoid collisions and create the instance.
 const $k = require('kuzzle-sdk');
-const $kInstance = new $k.Kuzzle(new $k.WebSocket('kuzzle'));
+const $kInstance = new $k.Kuzzle(new $k.WebSocket('kuzzle', { pingInterval: 2000 }));
 
 // add a listener to detect any connection problems
 $kInstance.on('networkError', error => {
diff --git a/.ci/doc/templates/default.tpl.js b/.ci/doc/templates/default.tpl.js
@@ -5,7 +5,7 @@ const {
 } = require('kuzzle-sdk');
 
 // Instantiates a Kuzzle client
-const kuzzle = new Kuzzle(new WebSocket('kuzzle', { autoReconnect: false }));
+const kuzzle = new Kuzzle(new WebSocket('kuzzle', { autoReconnect: false, pingInterval: 2000 }));
 
 // Adds a listener to detect any connection problems
 kuzzle.on('networkError', error => {
diff --git a/.ci/doc/templates/print-result-successes.tpl.js b/.ci/doc/templates/print-result-successes.tpl.js
@@ -7,7 +7,7 @@ const {
 // Instantiates a Kuzzle client
 const
   kuzzle = new Kuzzle(
-    new WebSocket('kuzzle', { autoReconnect: false })
+    new WebSocket('kuzzle', { autoReconnect: false, pingInterval: 2000 })
   );
 
 // Adds a listener to detect connection problems
diff --git a/.ci/doc/templates/realtime.tpl.js b/.ci/doc/templates/realtime.tpl.js
@@ -7,7 +7,7 @@ const {
 // Instantiates a Kuzzle client
 const
   kuzzle = new Kuzzle(
-    new WebSocket('kuzzle', { autoReconnect: false })
+    new WebSocket('kuzzle', { autoReconnect: false, pingInterval: 2000 })
   );
 
 // Adds a listener to detect any connection problems
diff --git a/.ci/doc/templates/success.tpl.js b/.ci/doc/templates/success.tpl.js
@@ -7,7 +7,7 @@ const {
 // Instantiates a Kuzzle client
 const
   kuzzle = new Kuzzle(
-    new WebSocket('kuzzle', { autoReconnect: false })
+    new WebSocket('kuzzle', { autoReconnect: false, pingInterval: 2000 })
   );
 
 // Adds a listener to detect any connection problems
diff --git a/.ci/doc/templates/thencatch.tpl.js b/.ci/doc/templates/thencatch.tpl.js
@@ -9,7 +9,7 @@ const {
 // Instantiates a Kuzzle client
 const
   kuzzle = new Kuzzle(
-    new WebSocket('kuzzle', { autoReconnect: false })
+    new WebSocket('kuzzle', { autoReconnect: false, pingInterval: 2000 })
   );
 
 // Adds a listener to detect any connection problems
diff --git a/.ci/doc/templates/without-connect.tpl.js b/.ci/doc/templates/without-connect.tpl.js
@@ -7,7 +7,7 @@ const {
 // Instantiates a Kuzzle client
 const
   kuzzle = new Kuzzle(
-    new WebSocket('kuzzle', { autoReconnect: false })
+    new WebSocket('kuzzle', { autoReconnect: false, pingInterval: 2000 })
   );
 
 // Adds a listener to detect any connection problems
diff --git a/doc/7/controllers/ms/geopos/snippets/geopos.test.yml b/doc/7/controllers/ms/geopos/snippets/geopos.test.yml
@@ -5,7 +5,7 @@ hooks:
   after:
 template: default
 expected:
-  - "\\[ \\[ 3.910904824733734, 43.607392252329916 ],"
-  - "\\[ 3.8971075415611267, 43.600221526170145 ] ]"
+  - "\\[ 3.910904824733734, 43.607392252329916 ],"
+  - "\\[ 3.8971075415611267, 43.600221526170145 ]"
 sdk: js
 version: 6
diff --git a/doc/7/controllers/ms/georadius/snippets/georadius.test.yml b/doc/7/controllers/ms/georadius/snippets/georadius.test.yml
@@ -5,14 +5,22 @@ hooks:
   after:
 template: default
 expected:
-  - "\\[ { name: 'other HQ' }, { name: 'HQ' } "
-  - "\\[ { name: 'other HQ', distance: 4.9271 },"
-  - "  { name: 'HQ', distance: 4.596 } ]"
-  - "\\[ { name: 'HQ',"
+  - "\\[ { name: 'other HQ' }, { name: 'HQ' } ]"
+  - "\\["
+  - "{ name: 'other HQ', distance: 4.9271 },"
+  - "{ name: 'HQ', distance: 4.596 }"
+  - "\\]"
+  - "\\["
+  - "{"
+  - "name: 'HQ',"
   - "    distance: 4.596,"
-  - "    coordinates: \\[ 3.910904824733734, 43.607392252329916 ] },"
-  - "  { name: 'other HQ',"
+  - "    coordinates: \\[ 3.910904824733734, 43.607392252329916 ]"
+  - "},"
+  - "{"
+  - "name: 'other HQ',"
   - "    distance: 4.9271,"
-  - "    coordinates: \\[ 3.8971075415611267, 43.600221526170145 ] } ]"
+  - "    coordinates: \\[ 3.8971075415611267, 43.600221526170145 ]"
+  - "}"
+  - "\\]"
 sdk: js
 version: 6
diff --git a/doc/7/controllers/ms/georadiusbymember/snippets/georadiusbymember.test.yml b/doc/7/controllers/ms/georadiusbymember/snippets/georadiusbymember.test.yml
@@ -6,13 +6,21 @@ hooks:
 template: default
 expected:
   - "\\[ { name: '(other |)HQ' }, { name: '(other |)HQ' } ]"
-  - "\\[ { name: 'other HQ', distance: 1367.8521 },"
-  - "  { name: 'HQ', distance: 0 } ]"
-  - "\\[ { name: 'HQ',"
+  - "\\["
+  - "{ name: 'other HQ', distance: 1367.8521 },"
+  - "{ name: 'HQ', distance: 0 }"
+  - "\\]"
+  - "\\["
+  - "{"
+  - "name: 'HQ',"
   - "    distance: 0,"
-  - "    coordinates: \\[ 3.910904824733734, 43.607392252329916 ] },"
-  - "  { name: 'other HQ',"
+  - "    coordinates: \\[ 3.910904824733734, 43.607392252329916 ]"
+  - "},"
+  - "{"
+  - "name: 'other HQ',"
   - "    distance: 1367.8521,"
-  - "    coordinates: \\[ 3.8971075415611267, 43.600221526170145 ] } ]"
+  - "    coordinates: \\[ 3.8971075415611267, 43.600221526170145 ]"
+  - "}"
+  - "\\]"
 sdk: js
 version: 6
diff --git a/doc/7/controllers/ms/hscan/snippets/hscan.test.yml b/doc/7/controllers/ms/hscan/snippets/hscan.test.yml
@@ -5,7 +5,9 @@ hooks:
   after:
 template: default
 expected:
-  - "{ cursor: '0',"
-  - "values: \\[ 'key1', 'val1', 'key2', 'val2', 'key3', 'val3' ] }"
+  - "{"
+  - "cursor: '0',"
+  - "values: \\[ 'key1', 'val1', 'key2', 'val2', 'key3', 'val3' ]"
+  - "}"
 sdk: js
 version: 6
diff --git a/doc/7/controllers/ms/sort/snippets/sort.test.yml b/doc/7/controllers/ms/sort/snippets/sort.test.yml
@@ -5,7 +5,11 @@ hooks:
   after:
 template: default
 expected:
-  - "\\[ '7', '6', '5', '4', '3', '2', '1' ]"
+  - "\\["
+  - "'7', '6', '5',"
+  - "'4', '3', '2',"
+  - "'1'"
+  - "]"
   - "\\[ 'bar', 'baz', 'foo', 'qux' ]"
 sdk: js
 version: 6
diff --git a/doc/7/controllers/ms/sunion/snippets/sunion.test.yml b/doc/7/controllers/ms/sunion/snippets/sunion.test.yml
@@ -4,6 +4,10 @@ hooks:
   before: curl -X POST kuzzle:7512/ms/_flushdb
   after:
 template: default
-expected: "\\[ ('[a-i]', ){8}'[a-i]' ]"
+expected:
+  - "\\["
+  - ('[a-i]', )
+  - ('[a-i]', )
+  - ('[a-i]', )
 sdk: js
 version: 6
diff --git a/doc/7/controllers/ms/sunionstore/snippets/sunionstore.test.yml b/doc/7/controllers/ms/sunionstore/snippets/sunionstore.test.yml
@@ -5,7 +5,9 @@ hooks:
   after:
 template: default
 expected:
-  - ^9$
-  - "\\[ ('[a-i]', ){8}'[a-i]' ]"
+  - "\\["
+  - ('[a-i]', )
+  - ('[a-i]', )
+  - ('[a-i]', )
 sdk: js
 version: 6
diff --git a/doc/7/controllers/ms/zadd/snippets/zadd.test.yml b/doc/7/controllers/ms/zadd/snippets/zadd.test.yml
@@ -5,8 +5,10 @@ hooks:
   after:
 template: default
 expected:
-  - "\\[ { member: 'baz', score: -272.15 },"
-  - "  { member: 'bar', score: 4 },"
-  - "  { member: 'foo', score: 42 } ]"
+  - "\\["
+  - "{ member: 'baz', score: -272.15 },"
+  - "{ member: 'bar', score: 4 },"
+  - "{ member: 'foo', score: 42 }"
+  - "]"
 sdk: js
 version: 6
diff --git a/doc/7/controllers/ms/zincrby/snippets/zincrby.test.yml b/doc/7/controllers/ms/zincrby/snippets/zincrby.test.yml
@@ -5,8 +5,10 @@ hooks:
   after:
 template: default
 expected:
-  - "\\[ { member: 'baz', score: -272.15 },"
-  - "\\{ member: 'foo', score: 42 },"
-  - "\\{ member: 'bar', score: 1337 } ]"
+  - "\\["
+  - "{ member: 'baz', score: -272.15 },"
+  - "{ member: 'foo', score: 42 },"
+  - "{ member: 'bar', score: 1337 }"
+  - "\\]"
 sdk: js
 version: 6
diff --git a/doc/7/controllers/ms/zinterstore/snippets/zinterstore.test.yml b/doc/7/controllers/ms/zinterstore/snippets/zinterstore.test.yml
@@ -5,9 +5,10 @@ hooks:
   after:
 template: default
 expected:
-  - "\\[ { member: 'foo', score: 13 },"
-  - "  { member: 'baz', score: 27.85\\d* } ]"
-  - "\\[ { member: 'baz', score: -272.15 }"
-  - "  { member: 'foo', score: -29 } ]"
+  - "\\["
+  - "{ member: 'foo', score: 13 },"
+  - "{ member: 'baz', score: 27.85\\d* }"
+  - "]"
+  - "\\[ { member: 'baz', score: -272.15 }, { member: 'foo', score: -29 } ]"
 sdk: js
 version: 6
diff --git a/doc/7/controllers/ms/zrange/snippets/zrange.test.yml b/doc/7/controllers/ms/zrange/snippets/zrange.test.yml
@@ -5,7 +5,6 @@ hooks:
   after:
 template: default
 expected:
-  - "\\[ { member: 'baz', score: -272.15 },"
-  - "{ member: 'bar', score: 4 } ]"
+  - "\\[ { member: 'baz', score: -272.15 }, { member: 'bar', score: 4 } ]"
 sdk: js
 version: 6
diff --git a/doc/7/controllers/ms/zrangebyscore/snippets/zrangebyscore.test.yml b/doc/7/controllers/ms/zrangebyscore/snippets/zrangebyscore.test.yml
@@ -5,7 +5,6 @@ hooks:
   after:
 template: default
 expected:
-  - "\\[ { member: 'baz', score: -272.15 },"
-  - "{ member: 'bar', score: 4 } ]"
+  - "\\[ { member: 'baz', score: -272.15 }, { member: 'bar', score: 4 } ]"
 sdk: js
 version: 6
diff --git a/doc/7/controllers/ms/zrevrangebyscore/snippets/zrevrangebyscore.test.yml b/doc/7/controllers/ms/zrevrangebyscore/snippets/zrevrangebyscore.test.yml
@@ -5,8 +5,7 @@ hooks:
   after:
 template: default
 expected:
-  - "\\[ { member: 'bar', score: 4 },"
-  - "{ member: 'baz', score: -272.15 } ]"
+  - "\\[ { member: 'bar', score: 4 }, { member: 'baz', score: -272.15 } ]"
 
 sdk: js
 version: 6
diff --git a/doc/7/controllers/ms/zscan/snippets/zscan.test.yml b/doc/7/controllers/ms/zscan/snippets/zscan.test.yml
@@ -5,7 +5,9 @@ hooks:
   after:
 template: default
 expected:
-    - "{ cursor: '0',"
-    - "values: \\[ 'baz', '-272.1\\d{1,}', 'bar', '4', 'foo', '42' ] }"
+    - "{"
+    - "cursor: '0',"
+    - "values: \\[ 'baz', '-272.1\\d{1,}', 'bar', '4', 'foo', '42' ]"
+    - "}"
 sdk: js
 version: 6
diff --git a/doc/7/controllers/ms/zunionstore/snippets/zunionstore.test.yml b/doc/7/controllers/ms/zunionstore/snippets/zunionstore.test.yml
@@ -5,11 +5,15 @@ hooks:
   after:
 template: default
 expected:
-  - "\\[ { member: 'bar', score: 4 },"
-  - "  { member: 'foo', score: 13 },"
-  - "  { member: 'baz', score: 300 } ]"
-  - "\\[ { member: 'foo', score: -29 },"
-  - "  { member: 'bar', score: 4 },"
-  - "  { member: 'baz', score: 300 } ]"
+  - "\\["
+  - "{ member: 'bar', score: 4 },"
+  - "{ member: 'foo', score: 13 },"
+  - "{ member: 'baz', score: 300 }"
+  - "\\]"
+  - "\\["
+  - "{ member: 'foo', score: -29 },"
+  - "{ member: 'bar', score: 4 },"
+  - "{ member: 'baz', score: 300 }"
+  - "]"
 sdk: js
 version: 6
diff --git a/doc/7/controllers/security/create-user/snippets/create-user.js b/doc/7/controllers/security/create-user/snippets/create-user.js
@@ -15,7 +15,7 @@ try {
   /*
   User {
     _id: 'john.doe',
-    content:,
+    content:
       { profileIds: [ 'default' ],
         firstName: 'John',
         lastName: 'Doe',
diff --git a/doc/7/controllers/security/create-user/snippets/create-user.test.yml b/doc/7/controllers/security/create-user/snippets/create-user.test.yml
@@ -3,4 +3,8 @@ description: creates user
 hooks:
   after: curl -XDELETE kuzzle:7512/users/jdoe
 template: default
-expected: '^   { profileIds: \[ ''default'' \],$'
+expected:
+  - "User {"
+  - "_id: 'jdoe',"
+  - "content: {"
+  - "profileIds: \\[ \\'default\\' \\],"
diff --git a/doc/7/controllers/security/get-profile-mapping/snippets/get-profile-mapping.test.yml b/doc/7/controllers/security/get-profile-mapping/snippets/get-profile-mapping.test.yml
@@ -1,4 +1,5 @@
 name: security#getProfileMapping
 description: get profile mapping
 template: default
-expected: '^{ mapping:'
+expected:
+  - "mapping: { policies: { properties: \\[Object\\] } }"
diff --git a/doc/7/controllers/security/get-profile-rights/snippets/get-profile-rights.test.yml b/doc/7/controllers/security/get-profile-rights/snippets/get-profile-rights.test.yml
@@ -23,4 +23,4 @@ hooks:
     }' kuzzle:7512/profiles/myProfile/_create
   after: curl -XDELETE kuzzle:7512/profiles/myProfile
 template: default
-expected: "^    value: 'allowed' },$"
+expected: "^    value: 'allowed'$"
diff --git a/doc/7/controllers/security/get-profile/snippets/get-profile.test.yml b/doc/7/controllers/security/get-profile/snippets/get-profile.test.yml
@@ -23,4 +23,5 @@ hooks:
     }' kuzzle:7512/profiles/myProfile/_create
   after: curl -XDELETE kuzzle:7512/profiles/myProfile
 template: default
-expected: '^   \[ { roleId: ''admin'', restrictedTo: \[Array\] },$'
+expected:
+- "\\[ { roleId: \\'admin\\', restrictedTo: \\[Array\\] }, { roleId: \\'default\\' } \\]"
diff --git a/doc/7/controllers/security/get-role-mapping/snippets/get-role-mapping.test.yml b/doc/7/controllers/security/get-role-mapping/snippets/get-role-mapping.test.yml
@@ -1,4 +1,5 @@
 name: security#getRoleMapping
 description: get roles mapping
 template: default
-expected: '^{ mapping:'
+expected:
+  - "mapping: {"
diff --git a/doc/7/controllers/security/get-role/snippets/get-role.test.yml b/doc/7/controllers/security/get-role/snippets/get-role.test.yml
@@ -21,4 +21,5 @@ hooks:
     }' kuzzle:7512/roles/myRole/_create
   after: curl -XDELETE kuzzle:7512/roles/myRole
 template: default
-expected: '^   { auth: { actions: \[Object\] }, document: { actions: \[Object\] } } }$'
+expected:
+  - "controllers: { auth: { actions: \\[Object\\] }, document: { actions: \\[Object\\] } }"
diff --git a/doc/7/controllers/security/get-user-mapping/snippets/get-user-mapping.test.yml b/doc/7/controllers/security/get-user-mapping/snippets/get-user-mapping.test.yml
@@ -1,4 +1,9 @@
 name: security#getUserMapping
 description: get users mapping
 template: default
-expected: '^{ mapping:'
+expected:
+  - "mapping: {"
+  - "firstName: { type: \\'text\\', fields: \\[Object\\] },"
+  - "fullName: { type: \\'text\\', fields: \\[Object\\] },"
+  - "lastName: { type: \\'text\\', fields: \\[Object\\] },"
+  - "profileIds: { type: \\'keyword\\' }"
diff --git a/doc/7/controllers/security/get-user-rights/snippets/get-user-rights.test.yml b/doc/7/controllers/security/get-user-rights/snippets/get-user-rights.test.yml
@@ -16,4 +16,5 @@ hooks:
     }' kuzzle:7512/users/john.doe/_create
   after: curl -XDELETE kuzzle:7512/users/john.doe
 template: default
-expected: '^    value: ''allowed'' } ]$'
+expected: 
+  - "value: 'allowed'"
diff --git a/doc/7/controllers/security/get-user/snippets/get-user.test.yml b/doc/7/controllers/security/get-user/snippets/get-user.test.yml
@@ -16,4 +16,5 @@ hooks:
     }' kuzzle:7512/users/john.doe/_create
   after: curl -XDELETE kuzzle:7512/users/john.doe
 template: default
-expected: '^     fullName: ''John Doe'',$'
+expected:
+  - "fullName: 'John Doe'"
diff --git a/doc/7/controllers/security/replace-user/snippets/replace-user.test.yml b/doc/7/controllers/security/replace-user/snippets/replace-user.test.yml
@@ -15,4 +15,5 @@ hooks:
     }' kuzzle:7512/users/john.doe/_create
   after: curl -XDELETE kuzzle:7512/users/john.doe
 template: default
-expected: '^     firstName: ''John'',$'
+expected:
+  - "firstName: 'John'"
diff --git a/doc/7/controllers/security/update-profile/snippets/update-profile.test.yml b/doc/7/controllers/security/update-profile/snippets/update-profile.test.yml
diff --git a/doc/7/controllers/security/update-role/snippets/update-role.test.yml b/doc/7/controllers/security/update-role/snippets/update-role.test.yml
diff --git a/doc/7/controllers/security/update-user/snippets/update-user.test.yml b/doc/7/controllers/security/update-user/snippets/update-user.test.yml
diff --git a/doc/7/protocols/websocket/constructor/index.md b/doc/7/protocols/websocket/constructor/index.md
diff --git a/doc/7/protocols/websocket/introduction/index.md b/doc/7/protocols/websocket/introduction/index.md
diff --git a/doc/7/protocols/websocket/properties/index.md b/doc/7/protocols/websocket/properties/index.md
diff --git a/src/controllers/Auth.ts b/src/controllers/Auth.ts
diff --git a/src/protocols/WebSocket.ts b/src/protocols/WebSocket.ts
diff --git a/src/protocols/abstract/Realtime.ts b/src/protocols/abstract/Realtime.ts
diff --git a/test/protocol/WebSocket.test.js b/test/protocol/WebSocket.test.js
