Merge pull request #2182 from kuzzleio/2.14.11-proposal

# [2.14.11](https://github.com/kuzzleio/kuzzle/releases/tag/2.14.11) (2021-11-01) #### Bug fixes - [ [#2181](#2181) ] Properly disconnect connections on shutdown ([Aschen](https://github.com/Aschen)) - [ [#2173](#2173) ] Clean realtime connections after unexpected deconnection ([Aschen](https://github.com/Aschen)) #### Enhancements - [ [#2174](#2174) ] Allows to disable statistics module ([Aschen](https://github.com/Aschen)) - [ [#2180](#2180) ] Allows to disable the SDK version safety check ([Aschen](https://github.com/Aschen)) #### Others - [ [#2169](#2169) ] Additional logging when choosing cluster IP ([rolljee](https://github.com/rolljee)) ---
kuzzleio · Nov 1, 2021 · 8244888 · 8244888
2 parents 6e0b67d + a2429a3
commit 8244888
Show file tree

Hide file tree

Showing 57 changed files with 1,588 additions and 715 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -65,4 +65,12 @@ lib/util/koncordeCompat.js
 features/support/application/functional-tests-app.js
 lib/model/security/token.js
 lib/core/auth/tokenManager.js
-lib/core/cluster/state.js
+lib/cluster/state.js
+lib/core/realtime/hotelClerk.js
+lib/types/realtime/RealtimeScope.js
+lib/types/realtime/RealtimeUsers.js
+lib/core/realtime/channel.js
+lib/core/realtime/connectionRooms.js
+lib/core/realtime/room.js
+lib/core/realtime/subscription.js
+lib/types/realtime/RoomList.js
diff --git a/.github/actions/deploy-doc/action.yml b/.github/actions/deploy-doc/action.yml
diff --git a/.github/workflows/pull_request.workflow.yml b/.github/workflows/pull_request.workflow.yml
@@ -44,7 +44,7 @@ jobs:
     needs: [lint]
     strategy:
       matrix:
-        node-version: ['14.17.0', '12.16.3', '12.20.0']
+        node-version: ["14.17.0", "12.16.3", "12.20.0"]
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
@@ -62,7 +62,7 @@ jobs:
     strategy:
       matrix:
         test_set: [http, websocket, mqtt]
-        node-version: ['14.17.0', '12.16.3', '12.20.0']
+        node-version: ["14.17.0", "12.16.3", "12.20.0"]
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
@@ -83,7 +83,7 @@ jobs:
     strategy:
       matrix:
         test_set: [http, websocket]
-        node-version: ['14.17.0', '12.16.3', '12.20.0']
+        node-version: ["14.17.0", "12.16.3", "12.20.0"]
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
@@ -113,14 +113,14 @@ jobs:
     runs-on: ubuntu-18.04
     strategy:
       matrix:
-        node-version: ['14.17.0', '12.16.3', '12.20.0']
+        node-version: ["14.17.0", "12.16.3", "12.20.0"]
     steps:
       - uses: actions/checkout@v2
       - name: Cloning Monkey Tester
         uses: actions/checkout@v2
         with:
           repository: kuzzleio/kuzzle-monkey-tests
-          path: 'kuzzle-monkey-tests'
+          path: "kuzzle-monkey-tests"
       - uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
@@ -130,3 +130,26 @@ jobs:
       - uses: ./.github/actions/monkey-tests
         with:
           node-version: ${{ matrix.node-version }}
+
+  doc-dead-links:
+    name: Check dead-links
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Extract references from context
+        shell: bash
+        id: extract-refs
+        run: |
+          echo "::set-output name=version::$(git describe --abbrev=0 --tags | cut -d. -f 1)"
+          echo "::set-output name=repo::$(echo $GITHUB_REPOSITORY | cut -d/ -f 2)"
+          echo "::set-output name=fw-branch::$(if [ $BASE_BRANCH == master ]; then echo master; else echo develop; fi)"
+      - uses: convictional/[email protected]
+        with:
+          owner: kuzzleio
+          repo: documentation
+          github_token: ${{ secrets.ACCESS_TOKEN_CI }}
+          workflow_file_name: dead_links.workflow.yml
+          ref: ${{ steps.extract-refs.outputs.fw-branch }}
+          inputs: '{"repo_name": "${{ steps.extract-refs.outputs.repo }}", "branch": "${{ github.head_ref }}", "version": "${{ steps.extract-refs.outputs.version }}"}'
diff --git a/.github/workflows/push_dev.workflow.yml b/.github/workflows/push_dev.workflow.yml
@@ -25,8 +25,8 @@ jobs:
     runs-on: ubuntu-18.04
     strategy:
       matrix:
-        node-version: ['14.17.0']
-        kuzzle-image: ['kuzzle']
+        node-version: ["14.17.0"]
+        kuzzle-image: ["kuzzle"]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
@@ -44,7 +44,7 @@ jobs:
     needs: [lint]
     strategy:
       matrix:
-        node-version: ['14.17.0', '12.16.3', '12.20.0']
+        node-version: ["14.17.0", "12.16.3", "12.20.0"]
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
@@ -61,8 +61,8 @@ jobs:
     needs: [unit-tests]
     strategy:
       matrix:
-        test_set: ['http', 'websocket', 'mqtt']
-        node-version: ['14.17.0', '12.16.3', '12.20.0']
+        test_set: ["http", "websocket", "mqtt"]
+        node-version: ["14.17.0", "12.16.3", "12.20.0"]
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
@@ -83,7 +83,7 @@ jobs:
     strategy:
       matrix:
         test_set: [http, websocket]
-        node-version: ['14.17.0', '12.16.3', '12.20.0']
+        node-version: ["14.17.0", "12.16.3", "12.20.0"]
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
@@ -104,14 +104,14 @@ jobs:
     runs-on: ubuntu-18.04
     strategy:
       matrix:
-        node-version: ['14.17.0', '12.16.3', '12.20.0']
+        node-version: ["14.17.0", "12.16.3", "12.20.0"]
     steps:
       - uses: actions/checkout@v2
       - name: Cloning Monkey Tester
         uses: actions/checkout@v2
         with:
           repository: kuzzleio/kuzzle-monkey-tests
-          path: 'kuzzle-monkey-tests'
+          path: "kuzzle-monkey-tests"
       - uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
@@ -131,25 +131,26 @@ jobs:
       - name: Test error codes
         run: ./.ci/scripts/check-error-codes-documentation.sh
 
-  documentation-staging:
-    name: Deploy Documentation to staging
-    needs: [error-codes-check]
+  doc-deploy:
+    name: Deployment Doc to Next
     runs-on: ubuntu-18.04
+    needs: [cluster-monkey-tests]
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
         with:
-          node-version: ${{ matrix.node-version }}
-      - uses: ./.github/actions/cache-node-modules
-        with:
-          NODE_VERSION: ${{ matrix.node-version }}
-      - uses: ./.github/actions/deploy-doc
-        with:
-          REGION: us-west-2
-          S3_BUCKET: docs-next.kuzzle.io
-          CLOUDFRONT_ID: E2ZCCEK9GRB49U
-          FRAMEWORK_BRANCH: develop
-          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-        env:
-          NODE_OPTIONS: --max-old-space-size=8096
+          fetch-depth: 0
+      - name: Extract references from context
+        shell: bash
+        id: extract-refs
+        run: |
+          echo "::set-output name=version::$(git describe --abbrev=0 --tags | cut -d. -f 1)"
+          echo "::set-output name=repo::$(echo $GITHUB_REPOSITORY | cut -d/ -f 2)"
+          echo "::set-output name=branch::$(echo $GITHUB_REF | cut -d/ -f 3)"
+      - uses: convictional/[email protected]
+        with:
+          owner: kuzzleio
+          repo: documentation
+          github_token: ${{ secrets.ACCESS_TOKEN_CI }}
+          workflow_file_name: child_repo.workflow.yml
+          ref: develop
+          inputs: '{"repo_name": "${{ steps.extract-refs.outputs.repo }}", "branch": "${{ steps.extract-refs.outputs.branch }}", "version": "${{ steps.extract-refs.outputs.version }}"}'
diff --git a/.github/workflows/push_master.workflow.yml b/.github/workflows/push_master.workflow.yml
@@ -25,8 +25,8 @@ jobs:
     runs-on: ubuntu-18.04
     strategy:
       matrix:
-        node-version: ['14.17.0']
-        kuzzle-image: ['kuzzle']
+        node-version: ["14.17.0"]
+        kuzzle-image: ["kuzzle"]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
@@ -44,7 +44,7 @@ jobs:
     needs: [lint]
     strategy:
       matrix:
-        node-version: ['14.17.0', '12.16.3', '12.20.0']
+        node-version: ["14.17.0", "12.16.3", "12.20.0"]
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
@@ -62,7 +62,7 @@ jobs:
     strategy:
       matrix:
         test_set: [http, websocket, mqtt]
-        node-version: ['14.17.0', '12.16.3', '12.20.0']
+        node-version: ["14.17.0", "12.16.3", "12.20.0"]
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
@@ -83,7 +83,7 @@ jobs:
     strategy:
       matrix:
         test_set: [http, websocket]
-        node-version: ['14.17.0', '12.16.3', '12.20.0']
+        node-version: ["14.17.0", "12.16.3", "12.20.0"]
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
@@ -104,14 +104,14 @@ jobs:
     runs-on: ubuntu-18.04
     strategy:
       matrix:
-        node-version: ['14.17.0', '12.16.3', '12.20.0']
+        node-version: ["14.17.0", "12.16.3", "12.20.0"]
     steps:
       - uses: actions/checkout@v2
       - name: Cloning Monkey Tester
         uses: actions/checkout@v2
         with:
           repository: kuzzleio/kuzzle-monkey-tests
-          path: 'kuzzle-monkey-tests'
+          path: "kuzzle-monkey-tests"
       - uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node-version }}
@@ -131,23 +131,29 @@ jobs:
       - name: Test error codes
         run: ./.ci/scripts/check-error-codes-documentation.sh
 
-  documentation-production:
-    name: Deploy Documentation to production
-    needs: [functional-tests-legacy, functional-tests]
+  doc-deploy:
+    name: Deployment Doc to Prod
     runs-on: ubuntu-18.04
+    needs: [cluster-monkey-tests]
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
         with:
-          node-version: ${{ matrix.node-version }}
-      - uses: ./.github/actions/deploy-doc
-        with:
-          REGION: us-west-2
-          S3_BUCKET: docs.kuzzle.io
-          CLOUDFRONT_ID: E3D6RP0POLCJMM
-          FRAMEWORK_BRANCH: master
-          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          fetch-depth: 0
+      - name: Extract references from context
+        shell: bash
+        id: extract-refs
+        run: |
+          echo "::set-output name=version::$(git describe --abbrev=0 --tags | cut -d. -f 1)"
+          echo "::set-output name=repo::$(echo $GITHUB_REPOSITORY | cut -d/ -f 2)"
+          echo "::set-output name=branch::$(echo $GITHUB_REF | cut -d/ -f 3)"
+      - uses: convictional/[email protected]
+        with:
+          owner: kuzzleio
+          repo: documentation
+          github_token: ${{ secrets.ACCESS_TOKEN_CI }}
+          workflow_file_name: child_repo.workflow.yml
+          ref: master
+          inputs: '{"repo_name": "${{ steps.extract-refs.outputs.repo }}", "branch": "${{ steps.extract-refs.outputs.branch }}", "version": "${{ steps.extract-refs.outputs.version }}"}'
 
   dockerhub-deploy:
     name: Build and deploy images to Dockerhub
@@ -177,8 +183,8 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: '12.x'
-          registry-url: 'https://registry.npmjs.org'
+          node-version: "14.x"
+          registry-url: "https://registry.npmjs.org"
       - run: npm install
       - run: npm publish
         env:

diff --git a/.gitignore b/.gitignore
@@ -142,4 +142,12 @@ docker/scripts/functional-tests-controller.js
 docker/scripts/start-kuzzle-dev.js
 lib/model/security/token.js
 lib/core/auth/tokenManager.js
-lib/core/cluster/state.js
+lib/cluster/state.js
+lib/core/realtime/hotelClerk.js
+lib/types/realtime/RealtimeScope.js
+lib/types/realtime/RealtimeUsers.js
+lib/core/realtime/channel.js
+lib/core/realtime/connectionRooms.js
+lib/core/realtime/room.js
+lib/core/realtime/subscription.js
+lib/types/realtime/RoomList.js
diff --git a/.kuzzlerc.sample b/.kuzzlerc.sample
@@ -356,8 +356,11 @@
     //       ("gb") or terabytes ("tb")
     //   * port:
     //       The listening port for HTTP and WebSocket
+    //   * strictSdkVersion:
+    //       Raise an error when an incompatible SDK is used.
     "maxRequestSize": "1mb",
     "port": 7512,
+    "strictSdkVersion": true,
     // [logs]
     // Configuration section for Kuzzle access logs
     //   * transports:
@@ -820,11 +823,14 @@
   },
 
   // Configuration of the Kuzzle's internal statistics module
+  //   * enabled:
+  //      Enable or disable the stats module
   //   * ttl:
   //      Time to live (in seconds) of a statistics frame
   //   * statsInterval:
   //      Time (in seconds) between statistics snapshots
   "stats": {
+    "enabled": true,
     "ttl": 3600,
     "statsInterval": 10
   },