kuzzle 2.16.3 → 2.16.7

package/lib/api/controllers/collectionController.js

@@ -269,7 +269,7 @@ class CollectionController extends NativeController {
   }
 
   /**
-   * Reset a collection by removing all documents
+   * Reset a collection by removing all documents while keeping the existing mapping
    *
    * @param {KuzzleRequest} request
    * @returns {Promise.<Object>}
@@ -277,13 +277,7 @@ class CollectionController extends NativeController {
   async truncate (request) {
     const { index, collection } = request.getIndexAndCollection();
 
-    await this.ask('core:storage:public:collection:refresh', index, collection);
-    await this.ask(
-      'core:storage:public:document:deleteByQuery',
-      index,
-      collection,
-      {},
-      { fetch: false, refresh: 'wait_for' });
+    await this.ask('core:storage:public:collection:truncate', index, collection);
 
     return {
       acknowledged: true

package/lib/api/controllers/serverController.js

@@ -47,7 +47,11 @@ class ServerController extends NativeController {
       'publicApi',
       'openapi',
     ]);
-    this._docOpenapi = generateOpenApi();
+
+    this._openApiDefinition = {
+      json: null,
+      yaml: null,
+    };
   }
 
   /**
@@ -55,7 +59,7 @@ class ServerController extends NativeController {
    *
    * @param {Request} request
    * @returns {Promise<Object>}
-   * 
+   *
    * @deprecated
    */
   getStats (request) {
@@ -66,7 +70,7 @@ class ServerController extends NativeController {
    * Returns the last statistics frame
    *
    * @returns {Promise<Object>}
-   * 
+   *
    * @deprecated
    */
   getLastStats () {
@@ -77,7 +81,7 @@ class ServerController extends NativeController {
    * Returns all stored statistics frames
    *
    * @returns {Promise<Object>}
-   * 
+   *
    * @deprecated
    */
   getAllStats () {
@@ -242,25 +246,34 @@ class ServerController extends NativeController {
   }
 
   async openapi (request) {
-    const format = request.input.args.format
-      ? request.input.args.format
-      : 'json';
-    const contentType = format === 'yaml'
-      ? 'application/yaml'
-      : 'application/json';
-    const specifications = format === 'yaml'
-      ? jsonToYaml.stringify(this._docOpenapi)
-      : this._docOpenapi;
+    const format = request.getString('format', 'json');
+    const specifications = this.getOpenApiDefinition(format);
 
     request.response.configure({
       format: 'raw',
-      headers: { 'Content-Type': contentType },
+      headers: { 'Content-Type': `application/${format}` },
       status: 200,
     });
 
     return specifications;
   }
 
+  /**
+   * Lazy loading of OpenAPI definition.
+   *
+   * Mainly because we need to wait all plugin to be loaded
+   * to generate the definition.
+   */
+  getOpenApiDefinition (format) {
+    if (! this._openApiDefinition[format]) {
+      this._openApiDefinition[format] = format === 'json'
+        ? generateOpenApi()
+        : jsonToYaml.stringify(generateOpenApi());
+    }
+
+    return this._openApiDefinition[format];
+  }
+
   /**
    * Fetches and returns Kuzzle core metrics
    * @returns {Promise<Object>}

package/lib/api/openApiGenerator.d.ts

@@ -1,6 +1,7 @@
+import { JSONObject } from '../../index';
 /**
  * Generates JSON OpenApi object
  *
  * @returns {object} openApi object
  */
-export declare function generateOpenApi(): any;
+export declare function generateOpenApi(): JSONObject;

package/lib/api/openApiGenerator.js

@@ -1,9 +1,4 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateOpenApi = void 0;
 /*
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
@@ -24,13 +19,18 @@ exports.generateOpenApi = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateOpenApi = void 0;
 const lodash_1 = __importDefault(require("lodash"));
-const package_json_1 = require("./../../package.json");
+const package_json_1 = require("../../package.json");
 const openapi_1 = require("./openapi");
-const inflector_1 = require("./../util/inflector");
+const inflector_1 = require("../util/inflector");
 const routeUrlMatch = /:([^/]*)/g;
 /**
- * Genrate basic openApi Controller
+ * Generate basic openApi Controller
  */
 function generateController(route, response) {
     if (route.controller !== undefined) {
@@ -47,7 +47,7 @@ function generateController(route, response) {
     }
 }
 /**
- * Genrate basic openApi Summary
+ * Generate basic openApi Summary
  */
 function generateSummary(route) {
     if (route.openapi.description === undefined) {
@@ -58,7 +58,7 @@ function generateSummary(route) {
     }
 }
 /**
- * Genrate basic openApi Parameters
+ * Generate basic openApi Parameters
  */
 function generateParameters(route) {
     if (route.openapi.parameters === undefined) {
@@ -80,7 +80,7 @@ function generateParameters(route) {
     }
 }
 /**
- * Genrate basic openApi Response
+ * Generate basic openApi Response
  */
 function generateResponse(route) {
     if (route.openapi.responses === undefined) {
@@ -96,22 +96,20 @@ function generateResponse(route) {
  *
  * @returns {object} openApi object
  */
-/* eslint-disable @typescript-eslint/no-unused-vars */
 function generateOpenApi() {
-    /* eslint-enable @typescript-eslint/no-unused-vars */
     const routes = [];
-    global.kuzzle.config.http.routes.forEach(_route => routes.push({ ..._route }));
-    global.kuzzle.pluginsManager.routes.forEach(_route => routes.push({ ..._route }));
+    global.kuzzle.config.http.routes.forEach(route => routes.push({ ...route }));
+    global.kuzzle.pluginsManager.routes.forEach(route => routes.push({ ...route }));
     /* eslint-disable sort-keys */
     const response = {
         swagger: '2.0',
         info: {
             title: 'Kuzzle API',
-            description: 'The Kuzzle HTTP API',
+            description: 'Kuzzle HTTP API definition',
             contact: {
                 name: 'Kuzzle team',
-                url: 'http://kuzzle.io',
-                email: 'hello@kuzzle.io',
+                url: 'https://kuzzle.io',
+                email: 'support@kuzzle.io',
                 discord: 'http://join.discord.kuzzle.io'
             },
             license: {

package/lib/core/backend/backendController.js

@@ -141,9 +141,6 @@ class BackendController extends index_1.ApplicationManager {
         this._add(controller.name, controller.definition);
     }
     _add(name, definition) {
-        // Check definition here to throw error early
-        // with the corresponding line number
-        this._application.PluginObject.checkControllerDefinition(name, definition, { application: true });
         if (this._application._controllers[name]) {
             throw assertionError.get('invalid_controller_definition', name, 'A controller with this name already exists');
         }

package/lib/core/plugin/plugin.js

@@ -264,7 +264,7 @@ class Plugin {
     return PLUGIN_NAME_REGEX.test(name);
   }
 
-  static checkControllerDefinition (name, definition, { application=false } = {}) {
+  static async checkControllerDefinition (name, definition, { application=false } = {}) {
     if (typeof name !== 'string') {
       throw assertionError.get(
         'invalid_controller_definition',
@@ -344,7 +344,7 @@ class Plugin {
           }
 
           if (route.openapi) {
-            checkOpenAPISpecification(name, action, route);
+            await checkOpenAPISpecification(name, action, route);
           }
         }
       }
@@ -365,20 +365,24 @@ function checkHttpRouteProperties (route, action, name, application) {
   }
 }
 
-function checkOpenAPISpecification (controller, action, route) {
+async function checkOpenAPISpecification (controller, action, route) {
   if (! isPlainObject(route.openapi)) {
     throw assertionError.get(
       'invalid_controller_definition',
       controller,
-      'The "openapi" property must be an object');
+      'The "openapi" property of the route definition must be an object');
   }
 
+  const routePath = route.path.charAt(0) === '/'
+    ? route.path
+    : `/_/${route.path}`;
+
   // Set :param notation to {param}
-  const formattedPath = route.path.replace(/\/:([^/]*)/g,'/{$1}');
+  const formattedPath = routePath.replace(/\/:([^/]*)/g,'/{$1}');
 
-  const { error, warning } = enforcer({
+  const { error, warning } = await enforcer({
     /* eslint-disable sort-keys */
-    openapi: '3.0.1',
+    openapi: '3.0.0',
     info: {
       title: 'Kuzzle API',
       version: require('../../../package').version
@@ -394,8 +398,14 @@ function checkOpenAPISpecification (controller, action, route) {
   if (warning) {
     global.kuzzle.log.warn(`Warning for OpenAPI specification in "${controller}:${action}", ${route.openapi} : ${warning}`);
   }
+
   if (error) {
-    throw controllerError.get('invalid_openapi_schema', controller, action, route.openapi, error);
+    throw controllerError.get(
+      'invalid_openapi_schema',
+      controller,
+      action,
+      route.openapi,
+      error);
   }
 }
 

package/lib/core/plugin/pluginsManager.js

@@ -678,7 +678,7 @@ class PluginsManager {
           'Native controllers cannot be overriden');
       }
 
-      Plugin.checkControllerDefinition(controller, definition);
+      await Plugin.checkControllerDefinition(controller, definition);
 
       for (const [action, actionDefinition ] of Object.entries(definition.actions)) {
         let apiController = this.controllers.get(controller);

package/lib/service/storage/elasticsearch.js

@@ -237,6 +237,12 @@ class ElasticSearch extends Service {
     let size = 0;
 
     for (const [indice, indiceInfo] of Object.entries(body.indices)) {
+      // Ignore non-Kuzzle indices
+      if ( indice[INDEX_PREFIX_POSITION_IN_INDICE] !== PRIVATE_PREFIX
+        && indice[INDEX_PREFIX_POSITION_IN_INDICE] !== PUBLIC_PREFIX ) {
+        continue;
+      }
+
       const alias = await this._getAliasFromIndice(indice);
       const indexName = this._extractIndex(alias);
       const collectionName = this._extractCollection(alias);

package/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle",
-  "version": "2.16.3",
+  "version": "2.16.7",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -730,9 +730,9 @@
       "dev": true
     },
     "@types/lodash": {
-      "version": "4.14.177",
-      "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.14.177.tgz",
-      "integrity": "sha512-0fDwydE2clKe9MNfvXHBHF9WEahRuj+msTuQqOmAApNORFvhMYZKNGGJdCzuhheVjMps/ti0Ak/iJPACMaevvw==",
+      "version": "4.14.178",
+      "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.14.178.tgz",
+      "integrity": "sha512-0d5Wd09ItQWH1qFbEyQ7oTQ3GZrMfth5JkbN3EvTKLXcHLRDSXeLnlvlOn0wvxVIwK5o2M8JzP/OWz7T3NRsbw==",
       "dev": true
     },
     "@types/long": {
@@ -883,9 +883,9 @@
       "dev": true
     },
     "aedes": {
-      "version": "0.46.1",
-      "resolved": "https://registry.npmjs.org/aedes/-/aedes-0.46.1.tgz",
-      "integrity": "sha512-ZTSpKmtUwzaIX+JzigT8Y1vinh64MAEIUb88bAUW+Xwubtuivmj42H3tOgXNSHdpaPebAq83ZHo0AxihXb2HBw==",
+      "version": "0.46.2",
+      "resolved": "https://registry.npmjs.org/aedes/-/aedes-0.46.2.tgz",
+      "integrity": "sha512-bzDY5ZC1zEduKHBuAZW8Ccr46+42TB9lynP+Fw4Bl41kQYxUZBA8hQwp4Eba3gUM2EZHgj22Q83ib2UuvAWnkw==",
       "requires": {
         "aedes-packet": "^2.3.1",
         "aedes-persistence": "^8.1.3",
@@ -904,9 +904,9 @@
       },
       "dependencies": {
         "mqtt-packet": {
-          "version": "7.1.0",
-          "resolved": "https://registry.npmjs.org/mqtt-packet/-/mqtt-packet-7.1.0.tgz",
-          "integrity": "sha512-ireFY+9xK0JgiLWIBkskTK5B6uPz6kN2JvyBK+TUhxCWaEhpFeG/7O4734Pac3imeZ6ZtU6QQABAvMz4z7pfUg==",
+          "version": "7.1.1",
+          "resolved": "https://registry.npmjs.org/mqtt-packet/-/mqtt-packet-7.1.1.tgz",
+          "integrity": "sha512-xNNDZG169D2c96NJmkkoDdj3tj5z0jsZ1yv/vGBY9chg4JellV9wJwawKPXv4fyLetmXp50LtPNwL2u8qvLssw==",
           "requires": {
             "bl": "^4.0.2",
             "debug": "^4.1.1",
@@ -2902,9 +2902,9 @@
       "optional": true
     },
     "fastparallel": {
-      "version": "2.4.0",
-      "resolved": "https://registry.npmjs.org/fastparallel/-/fastparallel-2.4.0.tgz",
-      "integrity": "sha512-sacwQ7wwKlQXsa7TN24UvMBLZNLmVcPhmxccC9riFqb3N+fSczJL8eWdnZodZ/KijGVgNBBfvF/NeXER08uXnQ==",
+      "version": "2.4.1",
+      "resolved": "https://registry.npmjs.org/fastparallel/-/fastparallel-2.4.1.tgz",
+      "integrity": "sha512-qUmhxPgNHmvRjZKBFUNI0oZuuH9OlSIOXmJ98lhKPxMZZ7zS/Fi0wRHOihDSz0R1YiIOjxzOY4bq65YTcdBi2Q==",
       "requires": {
         "reusify": "^1.0.4",
         "xtend": "^4.0.2"
@@ -4802,9 +4802,9 @@
       "optional": true
     },
     "mqemitter": {
-      "version": "4.4.1",
-      "resolved": "https://registry.npmjs.org/mqemitter/-/mqemitter-4.4.1.tgz",
-      "integrity": "sha512-tXSsyzhsD70Jc7WFz1tjbfczGOAyObMhJ8O15ZFkpDI+g9ENmWFUo5BseAuS9HCxNnFtnMWo4lHh7yDi5CjVTQ==",
+      "version": "4.5.0",
+      "resolved": "https://registry.npmjs.org/mqemitter/-/mqemitter-4.5.0.tgz",
+      "integrity": "sha512-Mp/zytFeIv6piJQkEKnncHcP4R/ErJc5C7dfonkhkNUT2LA/nTayrfNxbipp3M5iCJUTQSUtzfQAQA3XVcKz6w==",
       "requires": {
         "fastparallel": "^2.3.0",
         "qlobber": "^5.0.0"
@@ -5424,9 +5424,9 @@
       }
     },
     "openapi-enforcer": {
-      "version": "1.16.0",
-      "resolved": "https://registry.npmjs.org/openapi-enforcer/-/openapi-enforcer-1.16.0.tgz",
-      "integrity": "sha512-7wwvOGehsF65UHj1kPBZ+UovgJUvdK8ztWaeqRnwskXd2qlt+YZcOILwmCyxdqHt59B57u46LT28klLgXJOKjQ==",
+      "version": "1.16.1",
+      "resolved": "https://registry.npmjs.org/openapi-enforcer/-/openapi-enforcer-1.16.1.tgz",
+      "integrity": "sha512-MG3lwulSdL9Qo1p0r8QMLjX+jTcvEN+YgMIGDNjyOxe2sYuk4Iu1wWN/3rVtkudrU/AQXIAZZP31NcqTIWcE7Q==",
       "requires": {
         "js-yaml": "^4.1.0",
         "randexp": "^0.5.3"
@@ -7653,9 +7653,9 @@
       }
     },
     "typescript": {
-      "version": "4.5.2",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.2.tgz",
-      "integrity": "sha512-5BlMof9H1yGt0P8/WF+wPNw6GfctgGjXp5hkblpyT+8rkASSmkUKMXrxR0Xg8ThVCi/JnHQiKXeBaEwCeQwMFw==",
+      "version": "4.5.3",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.3.tgz",
+      "integrity": "sha512-eVYaEHALSt+s9LbvgEv4Ef+Tdq7hBiIZgii12xXJnukryt3pMgJf6aKhoCZ3FWQsu6sydEnkg11fYXLzhLBjeQ==",
       "dev": true
     },
     "uWebSockets.js": {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
-  "version": "2.16.3",
+  "version": "2.16.7",
   "description": "Kuzzle is an open-source solution that handles all the data management through a secured API, with a large choice of protocols.",
   "bin": {
     "kuzzle": "bin/start-kuzzle-server"
@@ -41,7 +41,7 @@
   "dependencies": {
     "@elastic/elasticsearch": "https://github.com/elastic/elasticsearch-js/archive/refs/tags/v7.13.0.tar.gz",
     "@types/js-yaml": "^4.0.5",
-    "aedes": "^0.46.1",
+    "aedes": "^0.46.2",
     "bluebird": "^3.7.2",
     "cli-color": "^2.0.1",
     "cookie": "^0.4.1",
@@ -68,7 +68,7 @@
     "murmurhash-native": "^3.5.0",
     "nanoid": "^3.1.30",
     "node-segfault-handler": "^1.0.4",
-    "openapi-enforcer": "^1.16.0",
+    "openapi-enforcer": "^1.16.1",
     "passport": "^0.5.0",
     "protobufjs": "~6.11.2",
     "rc": "1.2.8",
@@ -89,7 +89,7 @@
     "url": "git://github.com/kuzzleio/kuzzle.git"
   },
   "devDependencies": {
-    "@types/lodash": "^4.14.177",
+    "@types/lodash": "^4.14.178",
     "@typescript-eslint/eslint-plugin": "^5.6.0",
     "@typescript-eslint/parser": "^5.6.0",
     "async": "^3.2.2",
@@ -110,7 +110,7 @@
     "sinon": "^12.0.1",
     "strip-json-comments": "https://github.com/sindresorhus/strip-json-comments/archive/refs/tags/v3.1.1.tar.gz",
     "ts-node": "^10.4.0",
-    "typescript": "^4.5.2",
+    "typescript": "^4.5.3",
     "yaml": "^1.10.2"
   },
   "engines": {