Merge pull request #2477 from kuzzleio/2.26.0-proposal

Release 2.26.0
kuzzleio · Sep 13, 2023 · 07b3ee9 · 07b3ee9
2 parents 4e51e8c + 42c1e11
commit 07b3ee9
Show file tree

Hide file tree

Showing 24 changed files with 123 additions and 146 deletions.
diff --git a/.ci/danger.config.yaml b/.ci/danger.config.yaml
diff --git a/.ci/scripts/run-monkey-tests.sh b/.ci/scripts/run-monkey-tests.sh
@@ -4,8 +4,8 @@ set -ex
 
 if [ -z "$NODE_VERSION" ];
 then
-  echo "Missing NODE_VERSION, use default NODE_12_VERSION"
-  export NODE_VERSION=$NODE_12_VERSION
+  echo "Missing NODE_VERSION, use default NODE_16_VERSION"
+  export NODE_VERSION=$NODE_16_VERSION
 fi
 
 echo "Testing Kuzzle against node v$NODE_VERSION"

diff --git a/.ci/scripts/run-test-arm.sh b/.ci/scripts/run-test-arm.sh
@@ -4,8 +4,8 @@ set -ex
 
 if [ -z "$NODE_VERSION" ];
 then
-  echo "Missing NODE_VERSION, use default NODE_14_VERSION"
-  NODE_VERSION=$NODE_14_VERSION
+  echo "Missing NODE_VERSION, use default NODE_16_VERSION"
+  NODE_VERSION=$NODE_16_VERSION
 fi
 
 echo "Testing Kuzzle against node v$NODE_VERSION"

diff --git a/.ci/scripts/run-test-cluster.sh b/.ci/scripts/run-test-cluster.sh
@@ -5,8 +5,8 @@ set -ex
 
 if [ -z "$NODE_VERSION" ];
 then
-  echo "Missing NODE_VERSION, use default NODE_14_VERSION"
-  export NODE_VERSION=$NODE_14_VERSION
+  echo "Missing NODE_VERSION, use default NODE_16_VERSION"
+  export NODE_VERSION=$NODE_16_VERSION
 fi
 
 echo "Testing Kuzzle against node v$NODE_VERSION"

diff --git a/.ci/scripts/run-test.sh b/.ci/scripts/run-test.sh
@@ -4,8 +4,8 @@ set -ex
 
 if [ -z "$NODE_VERSION" ];
 then
-  echo "Missing NODE_VERSION, use default NODE_14_VERSION"
-  NODE_VERSION=$NODE_14_VERSION
+  echo "Missing NODE_VERSION, use default NODE_16_VERSION"
+  NODE_VERSION=$NODE_16_VERSION
 fi
 
 echo "Testing Kuzzle against node v$NODE_VERSION"

diff --git a/.github/actions/install-packages/action.yml b/.github/actions/install-packages/action.yml
@@ -4,5 +4,5 @@ description: Install necessary packages inside the CI
 runs:
   using: "composite"
   steps:
-    - run: sudo apt remove libunwind-dev libunwind8
+    - run: sudo apt install libunwind-dev libunwind8 -y
       shell: bash
diff --git a/.github/workflows/workflow-deployments.yaml b/.github/workflows/workflow-deployments.yaml
@@ -3,15 +3,20 @@ name: Workflow Deployments
 on:
   workflow_call:
     inputs:
+      node_lts_maintenance_version:
+        description: "Current Node LTS Version"
+        required: true
+        default: "16"
+        type: string
       node_lts_current_version:
         description: "Current Node LTS Version"
         required: true
-        default: "18"
+        default: "20"
         type: string
       node_lts_active_version:
         description: "Active Node LTS Version"
         required: true
-        default: "16"
+        default: "18"
         type: string
       docker_platforms:
         description: "Docker platforms"
@@ -35,15 +40,20 @@ on:
         required: true
         default: true
         type: boolean
+      node_lts_maintenance_version:
+        description: "Current Node LTS Version"
+        required: true
+        default: "16"
+        type: string
       node_lts_current_version:
         description: "Current Node LTS Version"
         required: true
-        default: "18"
+        default: "20"
         type: string
       node_lts_active_version:
         description: "Active Node LTS Version"
         required: true
-        default: "16"
+        default: "18"
         type: string
       docker_platforms:
         description: "Docker platforms"
@@ -60,7 +70,7 @@ jobs:
     if: ${{ (github.event_name != 'workflow_dispatch' || inputs.doc_deploy) && (github.ref_name == 'master' || github.ref_name == '2-dev') }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Extract references from context
@@ -83,12 +93,12 @@ jobs:
     if: ${{ (github.event_name != 'workflow_dispatch' || inputs.dockerhub_deploy) && github.ref_name == 'master' }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ./.github/actions/install-packages
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
-          node-version: ${{ inputs.node_lts_current_version }}
-      - uses: actions/cache@v2
+          node-version: ${{ inputs.node_lts_maintenance_version }}
+      - uses: actions/cache@v3
         with:
           path: "**/node_modules"
           key: ${{ runner.os }}-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
@@ -126,11 +136,11 @@ jobs:
     if: ${{ (github.event_name != 'workflow_dispatch' || inputs.npm_deploy) && github.ref_name == 'master' }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ./.github/actions/install-packages
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
-          node-version: ${{ inputs.node_lts_active_version }}
+          node-version: ${{ inputs.node_lts_maintenance_version }}
           registry-url: "https://registry.npmjs.org"
       - run: npm install
       - run: npm publish

diff --git a/.github/workflows/workflow.yaml b/.github/workflows/workflow.yaml
@@ -8,9 +8,9 @@ on:
   pull_request: # This syntax stand for all PRs events
 
 env:
-  NODE_LTS_MAINTENANCE_VERSION: "14"
-  NODE_LTS_ACTIVE_VERSION: "16"
-  NODE_LTS_CURRENT_VERSION: "18"  # Stand for the latest LTS version
+  NODE_LTS_MAINTENANCE_VERSION: "16"
+  NODE_LTS_ACTIVE_VERSION: "18"
+  NODE_LTS_CURRENT_VERSION: "20" # Stand for the latest LTS version
   DOCKER_PLATFORMS: "linux/amd64,linux/arm64"
 
 jobs:
@@ -20,67 +20,24 @@ jobs:
     steps:
       - id: set-matrix
         run: |
-          echo "::set-output name=matrix::{\"node-version\": [\"$NODE_LTS_MAINTENANCE_VERSION\", \"$NODE_LTS_ACTIVE_VERSION\", \"$NODE_LTS_CURRENT_VERSION\"]}"
+          echo "::set-output name=matrix::{\"node-version\": [\"$NODE_LTS_MAINTENANCE_VERSION\", \"$NODE_LTS_ACTIVE_VERSION\"]}"
     outputs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}
+      node_lts_maintenance_version: ${{ env.NODE_LTS_MAINTENANCE_VERSION }}
       node_lts_active_version: ${{ env.NODE_LTS_ACTIVE_VERSION }}
       node_lts_current_version: ${{ env.NODE_LTS_CURRENT_VERSION }}
       docker_platforms: ${{ env.DOCKER_PLATFORMS }}
 
-  danger-js:
-    name: Danger JS
-    uses: kuzzleio/ci-tooling/.github/workflows/danger.yaml@master
-    secrets: inherit
-    with:
-      DANGER_CONFIG: "./.ci/danger.config.yaml"
-
-  # -----------------------------------------------------------------------------
-  # Documentation checks: error codes and dead links
-  # -----------------------------------------------------------------------------
-
-#  doc-dead-links:
-#    name: Documentation - Check Dead Links
-#    if: github.event_name == 'pull_request'
-#    runs-on: ubuntu-latest
-#    steps:
-#      - uses: actions/checkout@v2
-#        with:
-#          fetch-depth: 0
-#      - uses: ./.github/actions/install-packages
-#      - 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 }}"}'
-
   error-codes-check:
     name: Documentation - Error codes check
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ./.github/actions/install-packages
-      - uses: actions/cache@v2
-        with:
-          path: "**/node_modules"
-          key: ${{ runner.os }}-${{ env.NODE_LTS_CURRENT_VERSION }}-${{ hashFiles('**/package-lock.json') }}
       - run: npm install
       - name: Test error codes
         run: ./.ci/scripts/check-error-codes-documentation.sh
 
-  # -----------------------------------------------------------------------------
-  # Unit Test and Linting
-  # -----------------------------------------------------------------------------
-
   lint:
     name: Lint - Node.js LTS ${{ matrix.node-version }}
     runs-on: ubuntu-latest
@@ -89,14 +46,11 @@ jobs:
       matrix:
         node-version: ${{ fromJson(needs.prepare-matrix.outputs.matrix).node-version }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ./.github/actions/install-packages
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-      - uses: actions/cache@v2
-        with:
-          path: "**/node_modules"
           key: ${{ runner.os }}-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
       - uses: ./.github/actions/es-lint
 
@@ -108,14 +62,11 @@ jobs:
         node-version: ${{ fromJson(needs.prepare-matrix.outputs.matrix).node-version }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ./.github/actions/install-packages
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-      - uses: actions/cache@v2
-        with:
-          path: "**/node_modules"
           key: ${{ runner.os }}-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
       - uses: ./.github/actions/unit-tests
         env:
@@ -134,14 +85,11 @@ jobs:
         node-version: ${{ fromJson(needs.prepare-matrix.outputs.matrix).node-version }}
         kuzzle-image: ["kuzzle"]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ./.github/actions/install-packages
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-      - uses: actions/cache@v2
-        with:
-          path: "**/node_modules"
           key: ${{ runner.os }}-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
       - uses: ./.github/actions/build-and-run-kuzzle
         with:
@@ -153,17 +101,22 @@ jobs:
     strategy:
       matrix:
         test_set:
-          [jest, http, websocket, "legacy:mqtt", "legacy:http", "legacy:websocket"]
+          [
+            jest,
+            http,
+            websocket,
+            "legacy:mqtt",
+            "legacy:http",
+            "legacy:websocket",
+          ]
         node-version: ${{ fromJson(needs.prepare-matrix.outputs.matrix).node-version }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/install-packages
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-      - uses: actions/cache@v2
-        with:
-          path: "**/node_modules"
           key: ${{ runner.os }}-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
       - uses: ./.github/actions/functional-tests
         with:
@@ -180,19 +133,16 @@ jobs:
       matrix:
         node-version: ${{ fromJson(needs.prepare-matrix.outputs.matrix).node-version }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ./.github/actions/install-packages
       - name: Cloning Monkey Tester
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           repository: kuzzleio/kuzzle-monkey-tests
           path: "kuzzle-monkey-tests"
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-      - uses: actions/cache@v2
-        with:
-          path: "**/node_modules"
           key: ${{ runner.os }}-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
       - uses: ./.github/actions/monkey-tests
         with:
@@ -206,6 +156,7 @@ jobs:
     uses: ./.github/workflows/workflow-deployments.yaml
     secrets: inherit
     with:
+      node_lts_maintenance_version: ${{ needs.prepare-matrix.outputs.node_lts_maintenance_version }}
       node_lts_active_version: ${{ needs.prepare-matrix.outputs.node_lts_active_version }}
       node_lts_current_version: ${{ needs.prepare-matrix.outputs.node_lts_current_version }}
       docker_platforms: ${{ needs.prepare-matrix.outputs.docker_platforms }}
diff --git a/doc/2/api/controllers/auth/check-token/index.md b/doc/2/api/controllers/auth/check-token/index.md
@@ -40,7 +40,7 @@ Body:
 
 ---
 
-<SinceBadge version="2.16.8">
+<SinceBadge version="2.16.8" />
 When no token is provided the method returns information about the anonymous token (`kuid` is `-1`), instead of throwing an error.
 
 ## Body properties

diff --git a/doc/2/api/controllers/bulk/update-by-query/index.md b/doc/2/api/controllers/bulk/update-by-query/index.md
@@ -48,7 +48,7 @@ Body:
 {
   "index": "<index>",
   "collection": "<collection>",
-  "controller": "document",
+  "controller": "bulk",
   "action": "updateByQuery",
   "refresh": "wait_for",
   "body": {
@@ -65,7 +65,7 @@ Body:
 ### Kourou
 
 ```bash
-kourou document:updateByQuery <index> <collection> <body>
+kourou bulk:updateByQuery <index> <collection> <body>
 ```
 
 ---
@@ -103,7 +103,7 @@ Returns the number of updated documents.
   "error": null,
   "index": "<index>",
   "collection": "<collection>",
-  "controller": "document",
+  "controller": "bulk",
   "action": "updateByQuery",
   "requestId": "<unique request identifier>",
   "result": {

diff --git a/doc/2/api/controllers/document/search/index.md b/doc/2/api/controllers/document/search/index.md
@@ -108,7 +108,7 @@ Search using `index` & `collection` parameters
 }
 ```
 
-Search using `targets` parameter <SinceBadge version="2.17.0">
+Search using `targets` parameter <SinceBadge version="2.17.0" />
 
 ```js
 {
@@ -191,8 +191,8 @@ Returns a paginated search result set, with the following properties:
 - `aggregations`: provides aggregation information. Present only if an `aggregations` object has been provided in the search body
 - `hits`: array of found documents. Each document has the following properties:
   - `_id`: document unique identifier
-  - `index`: index name <SinceBadge version="2.17.0">
-  - `collection`: collection name <SinceBadge version="2.17.0">
+  - `index`: index name <SinceBadge version="2.17.0" />
+  - `collection`: collection name <SinceBadge version="2.17.0" />
   - `_score`: [relevance score](https://www.elastic.co/guide/en/elasticsearch/guide/current/relevance-intro.html)
   - `_source`: new document content
   - `highlight`: optional result from [highlight API](https://www.elastic.co/guide/en/elasticsearch/reference/7.4/search-request-body.html#request-body-search-highlighting)