Merge pull request #2449 from kuzzleio/node-18-support

Node 18 support
kuzzleio · Apr 24, 2023 · 7a15b9a · 7a15b9a
2 parents 4e8fed3 + 99a4062
commit 7a15b9a
Show file tree

Hide file tree

Showing 12 changed files with 21 additions and 22 deletions.
diff --git a/.github/workflows/workflow.yaml b/.github/workflows/workflow.yaml
@@ -10,7 +10,7 @@ on:
 env:
   NODE_LTS_MAINTENANCE_VERSION: "14"
   NODE_LTS_ACTIVE_VERSION: "16"
-  # NODE_LTS_CURRENT_VERSION: "18"  # Stand for the latest LTS version
+  NODE_LTS_CURRENT_VERSION: "18"  # Stand for the latest LTS version
   DOCKER_PLATFORMS: "linux/amd64,linux/arm64"
 
 jobs:
@@ -20,7 +20,7 @@ jobs:
     steps:
       - id: set-matrix
         run: |
-          echo "::set-output name=matrix::{\"node-version\": [\"$NODE_LTS_MAINTENANCE_VERSION\", \"$NODE_LTS_ACTIVE_VERSION\"]}"
+          echo "::set-output name=matrix::{\"node-version\": [\"$NODE_LTS_MAINTENANCE_VERSION\", \"$NODE_LTS_ACTIVE_VERSION\", \"$NODE_LTS_CURRENT_VERSION\"]}"
     outputs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}
       node_lts_active_version: ${{ env.NODE_LTS_ACTIVE_VERSION }}

diff --git a/README.md b/README.md
@@ -52,15 +52,14 @@ npx kourou app:scaffold playground
 
  🚀 Kourou - Scaffolds a new Kuzzle application
 
-  ✔ Creating playground/ directory
   ✔ Creating and rendering application files
-  ✔ Installing latest Kuzzle version via NPM and Docker (this can take some time)
- [✔] Scaffolding complete! Use "npm run dev:docker" to run your application
+
+ [✔] Scaffolding complete! Use cd playground && npm run docker npm install install dependencies and then npm run docker:dev to run your application!
 ```
 
 Then you need to run Kuzzle services, Elasticsearch and Redis: `kourou app:start-services`
 
-Finally you can run your application inside Docker with `npm run dev:docker`
+Finally you can run your application inside Docker with `npm run docker:dev`
 
 Kuzzle is now listening for requests on the port `7512`!
 

diff --git a/doc/2/api/koncorde-filters-syntax/clauses/index.md b/doc/2/api/koncorde-filters-syntax/clauses/index.md
@@ -179,7 +179,7 @@ And this filter validates the second document:
 
 ## `select`
 
-<SinceBadge version="auto-version"/>
+<SinceBadge version="2.23.0"/>
 
 Executes a Koncorde query on a particular index of an array
 
@@ -251,7 +251,7 @@ And this filter validates the second document:
 
 ## `match`
 
-<SinceBadge version="auto-version"/>
+<SinceBadge version="2.23.0"/>
 
 Test if properties of the filter is matching with the properties of the document.
 

diff --git a/doc/2/framework/classes/backend-subscription/add/index.md b/doc/2/framework/classes/backend-subscription/add/index.md
@@ -8,7 +8,7 @@ description: BackendSubscription.add method
 
 # `add()`
 
-<SinceBadge version="auto-version" />
+<SinceBadge version="2.22.0" />
 
 Registers a new realtime subscription on the specified connection.
 

diff --git a/doc/2/framework/classes/backend-subscription/properties/index.md b/doc/2/framework/classes/backend-subscription/properties/index.md
@@ -8,7 +8,7 @@ description: BackendSubscription class properties
 
 # BackendSubscription
 
-<SinceBadge version="auto-version" />
+<SinceBadge version="2.22.0" />
 
 The `BackendSubscription` class handles subscriptions to the realtime engine for a specific connection.
 

diff --git a/doc/2/framework/classes/backend-subscription/remove/index.md b/doc/2/framework/classes/backend-subscription/remove/index.md
@@ -8,7 +8,7 @@ description: BackendSubscription.remove method
 
 # `remove()`
 
-<SinceBadge version="auto-version" />
+<SinceBadge version="2.22.0" />
 
 Removes a realtime subscription on the specified connection.
 

diff --git a/doc/2/guides/getting-started/customize-api-behavior/index.md b/doc/2/guides/getting-started/customize-api-behavior/index.md
@@ -33,7 +33,7 @@ The format of those events is the following:
  - `<controller>:before<Action>`: emitted before processing
  - `<controller>:after<Action>`: emitted after processing, before sending back the response
 
-Restarts your application with the following command to display events: `DEBUG=kuzzle:events npm run dev:docker`
+Restarts your application with the following command to display events: `DEBUG=kuzzle:events npm run docker:dev`
 
 ::: info
 Kuzzle uses the [debug](https://www.npmjs.com/package/debug) package to display messages.  

diff --git a/doc/2/guides/getting-started/run-kuzzle/index.md b/doc/2/guides/getting-started/run-kuzzle/index.md
@@ -20,7 +20,7 @@ In this guide we will use Docker and Docker Compose to run those services.
 
 ### Prerequisites
 
-- [Node.js >= 12](https://nodejs.org/en/download/)
+- [Node.js <= 16](https://nodejs.org/en/download/)
 - [Docker](https://docs.docker.com/engine/install/)
 - [Docker Compose](https://docs.docker.com/compose/install/)
 - [Kourou](https://github.com/kuzzleio/kourou)
@@ -91,10 +91,10 @@ app
   .catch(console.error);
 ```
 
-We can now run our first application with `npm run dev:docker`
+We can now run our first application with `npm run docker:dev`
 
 ::: info
-Under the hood, the command `npm run dev:docker` uses [nodemon](https://nodemon.io/) and [ts-node](https://www.npmjs.com/package/ts-node) inside the Docker container to run the application.
+Under the hood, the command `npm run docker:dev` uses [nodemon](https://nodemon.io/) and [ts-node](https://www.npmjs.com/package/ts-node) inside the Docker container to run the application.
 :::
 
 Now visit [http://localhost:7512](http://localhost:7512) with your browser. You should see the result of the [server:info](/core/2/api/controllers/server/info) action.

diff --git a/docker/images/kuzzle/Dockerfile b/docker/images/kuzzle/Dockerfile
@@ -1,7 +1,7 @@
 ################################################################################
 # Production build image
 ################################################################################
-FROM node:12-bullseye-slim as builder
+FROM node:14-bullseye-slim as builder
 
 RUN  set -x \
  && apt-get update \
@@ -45,7 +45,7 @@ RUN  set -x \
 ################################################################################
 # Production build 2 image
 ################################################################################
-FROM node:12-bullseye-slim as minifier
+FROM node:14-bullseye-slim as minifier
 
 ENV NODE_ENV=production
 

diff --git a/docker/images/plugin-dev/Dockerfile b/docker/images/plugin-dev/Dockerfile
@@ -1,7 +1,7 @@
 ################################################################################
 # Plugin development build image
 ################################################################################
-FROM node:12-bullseye-slim as builder
+FROM node:14-bullseye-slim as builder
 
 RUN  set -x \
   && apt-get update && apt-get install -y \

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
-  "version": "2.21.1",
+  "version": "2.23.0",
   "description": "Kuzzle is an open-source solution that handles all the data management through a secured API, with a large choice of protocols.",
   "bin": "bin/start-kuzzle-server",
   "scripts": {
@@ -79,7 +79,7 @@
     "semver": "^7.3.8",
     "sorted-array": "^2.0.4",
     "uuid": "^9.0.0",
-    "uWebSockets.js": "https://github.com/uNetworking/uWebSockets.js/archive/refs/tags/v20.0.0.tar.gz",
+    "uWebSockets.js": "https://github.com/uNetworking/uWebSockets.js/archive/refs/tags/v20.7.0.tar.gz",
     "validator": "^13.9.0",
     "winston": "^3.8.2",
     "winston-elasticsearch": "0.17.1",