kuzzle 2.15.0 → 2.16.1

package/lib/api/controllers/serverController.js

@@ -25,7 +25,7 @@ const os = require('os');
 const jsonToYaml = require('json2yaml');
 
 const { NativeController } = require('./baseController');
-const generateOpenApi = require('../openApiGenerator');
+const { generateOpenApi } = require('../openApiGenerator');
 
 const kerror = require('../../kerror');
 
@@ -42,10 +42,12 @@ class ServerController extends NativeController {
       'getStats',
       'healthCheck',
       'info',
+      'metrics',
       'now',
       'publicApi',
-      'openapi'
+      'openapi',
     ]);
+    this._docOpenapi = generateOpenApi();
   }
 
   /**
@@ -53,6 +55,8 @@ class ServerController extends NativeController {
    *
    * @param {Request} request
    * @returns {Promise<Object>}
+   * 
+   * @deprecated
    */
   getStats (request) {
     return global.kuzzle.statistics.getStats(request);
@@ -62,6 +66,8 @@ class ServerController extends NativeController {
    * Returns the last statistics frame
    *
    * @returns {Promise<Object>}
+   * 
+   * @deprecated
    */
   getLastStats () {
     return global.kuzzle.statistics.getLastStats();
@@ -71,6 +77,8 @@ class ServerController extends NativeController {
    * Returns all stored statistics frames
    *
    * @returns {Promise<Object>}
+   * 
+   * @deprecated
    */
   getAllStats () {
     return global.kuzzle.statistics.getAllStats();
@@ -241,8 +249,8 @@ class ServerController extends NativeController {
       ? 'application/yaml'
       : 'application/json';
     const specifications = format === 'yaml'
-      ? jsonToYaml.stringify(generateOpenApi())
-      : generateOpenApi();
+      ? jsonToYaml.stringify(this._docOpenapi)
+      : this._docOpenapi;
 
     request.response.configure({
       format: 'raw',
@@ -253,6 +261,18 @@ class ServerController extends NativeController {
     return specifications;
   }
 
+  /**
+   * Fetches and returns Kuzzle core metrics
+   * @returns {Promise<Object>}
+   */
+  async metrics () {
+    return {
+      api: await global.kuzzle.ask('kuzzle:api:funnel:metrics'),
+      network: await global.kuzzle.ask('core:network:router:metrics'),
+      realtime: await global.kuzzle.ask('core:realtime:hotelClerk:metrics'),
+    };
+  }
+
   _buildApiDefinition (controllers, httpRoutes) {
     const apiDefinition = {};
 

package/lib/api/funnel.js

@@ -101,6 +101,14 @@ class Funnel {
       'kuzzle:api:funnel:controller:isNative',
       name => this.isNativeController(name));
 
+    /**
+     * Returns inner metrics from the Funnel
+     * @returns {Object} 
+     */
+    global.kuzzle.onAsk(
+      'kuzzle:api:funnel:metrics',
+      () => this.metrics());
+
     this.rateLimiter.init();
 
     this.controllers.set('auth', new AuthController());
@@ -716,6 +724,17 @@ class Funnel {
     return this.controllers.has(controller);
   }
 
+  /**
+   * Returns inner metrics from the Funnel
+   * @returns {Object}
+   */
+  metrics () {
+    return {
+      concurrentRequests: this.concurrentRequests,
+      pendingRequests: this.pendingRequestsQueue.length,
+    };
+  }
+
   /**
    * If the request is coming from an official SDK,
    * then checks the compatibility of the SDK against current Kuzzle version.

package/lib/{config → api}/httpRoutes.js

@@ -23,6 +23,20 @@
 
 'use strict';
 
+const {
+  OpenApiDocumentCount,
+  OpenApiDocumentDeleteByQuery,
+  OpenApiDocumentDelete,
+  OpenApiDocumentScroll,
+  OpenApiDocumentExists,
+  OpenApiDocumentUpdate,
+  OpenApiDocumentReplace,
+  OpenApiDocumentGet,
+  OpenApiDocumentCreate,
+  OpenApiDocumentCreateOrReplace,
+} = require('./openapi/document');
+
+
 const routes = [
   // GET (idempotent)
   { verb: 'get', path: '/_me', controller: 'auth', action: 'getCurrentUser' },
@@ -57,10 +71,10 @@ const routes = [
   { verb: 'post', path: '/admin/_loadMappings', controller: 'admin', action: 'loadMappings' },
   { verb: 'post', path: '/admin/_loadSecurities', controller: 'admin', action: 'loadSecurities' },
 
-  { verb: 'get', path: '/:index/:collection/:_id', controller: 'document', action: 'get' },
+  { verb: 'get', path: '/:index/:collection/:_id', controller: 'document', action: 'get', openapi: OpenApiDocumentGet },
   { verb: 'get', path: '/:index/:collection/_mGet', controller: 'document', action: 'mGet' },
-  { verb: 'get', path: '/:index/:collection/:_id/_exists', controller: 'document', action: 'exists' },
-  { verb: 'get', path: '/_scroll/:scrollId', controller: 'document', action: 'scroll' },
+  { verb: 'get', path: '/:index/:collection/:_id/_exists', controller: 'document', action: 'exists', openapi: OpenApiDocumentExists },
+  { verb: 'get', path: '/_scroll/:scrollId', controller: 'document', action: 'scroll', openapi: OpenApiDocumentScroll },
 
   { verb: 'get', path: '/:index/_exists', controller: 'index', action: 'exists' },
   { verb: 'get', path: '/:index/_autoRefresh', controller: 'index', action: 'getAutoRefresh' },
@@ -88,16 +102,17 @@ const routes = [
   { verb: 'get', path: '/profiles/_scroll/:scrollId', controller: 'security', action: 'scrollProfiles' },
 
   { verb: 'get', path: '/_adminExists', controller: 'server', action: 'adminExists' },
-  { verb: 'get', path: '/_getAllStats', controller: 'server', action: 'getAllStats' },
+  { verb: 'get', path: '/_getAllStats', controller: 'server', action: 'getAllStats', deprecated: { since: 'auto-version', message: 'Use this route instead: http://kuzzle:7512/_metrics' } }, // @deprecated
   { verb: 'get', path: '/_getConfig', controller: 'server', action: 'getConfig' },
-  { verb: 'get', path: '/_getLastStats', controller: 'server', action: 'getLastStats' },
-  { verb: 'get', path: '/_getStats', controller: 'server', action: 'getStats' },
+  { verb: 'get', path: '/_getLastStats', controller: 'server', action: 'getLastStats', deprecated: { since: 'auto-version', message: 'Use this route instead: http://kuzzle:7512/_metrics' } }, // @deprecated
+  { verb: 'get', path: '/_getStats', controller: 'server', action: 'getStats', deprecated: { since: 'auto-version', message: 'Use this route instead: http://kuzzle:7512/_metrics' } }, // @deprecated
   { verb: 'get', path: '/', controller: 'server', action: 'info' },
   { verb: 'get', path: '/_healthCheck', controller: 'server', action: 'healthCheck' },
   { verb: 'get', path: '/_serverInfo', controller: 'server', action: 'info' },
   { verb: 'get', path: '/_now', controller: 'server', action: 'now' },
   { verb: 'get', path: '/_publicApi', controller: 'server', action: 'publicApi', deprecated: { since: '2.5.0', message: 'Use this route instead: http://kuzzle:7512/_openapi' } }, // @deprecated
   { verb: 'get', path: '/_openapi', controller: 'server', action: 'openapi' },
+  { verb: 'get', path: '/_metrics', controller: 'server', action: 'metrics' },
 
   { verb: 'get', path: '/ms/_bitcount/:_id', controller: 'ms', action: 'bitcount' },
   { verb: 'get', path: '/ms/_bitpos/:_id', controller: 'ms', action: 'bitpos' },
@@ -183,8 +198,8 @@ const routes = [
 
   { verb: 'post', path: '/:index/_create', controller: 'index', action: 'create' },
 
-  { verb: 'post', path: '/:index/:collection/_count', controller: 'document', action: 'count' },
-  { verb: 'post', path: '/:index/:collection/_create', controller: 'document', action: 'create' },
+  { verb: 'post', path: '/:index/:collection/_count', controller: 'document', action: 'count', openapi: OpenApiDocumentCount },
+  { verb: 'post', path: '/:index/:collection/_create', controller: 'document', action: 'create', openapi: OpenApiDocumentCreate },
   { verb: 'post', path: '/:index/:collection/:_id/_create', controller: 'document', action: 'create' },
   { verb: 'post', path: '/:index/:collection/_publish', controller: 'realtime', action: 'publish' },
   { verb: 'post', path: '/:index/:collection/_search', controller: 'document', action: 'search' },
@@ -289,9 +304,9 @@ const routes = [
   { verb: 'delete', path: '/:index/:collection/_specifications', controller: 'collection', action: 'deleteSpecifications' },
   { verb: 'delete', path: '/:index/:collection/_truncate', controller: 'collection', action: 'truncate' },
 
-  { verb: 'delete', path: '/:index/:collection/:_id', controller: 'document', action: 'delete' },
+  { verb: 'delete', path: '/:index/:collection/:_id', controller: 'document', action: 'delete', openapi: OpenApiDocumentDelete },
   { verb: 'delete', path: '/:index/:collection/:_id/_fields', controller: 'document', action: 'deleteFields' },
-  { verb: 'delete', path: '/:index/:collection/_query', controller: 'document', action: 'deleteByQuery' },
+  { verb: 'delete', path: '/:index/:collection/_query', controller: 'document', action: 'deleteByQuery', openapi: OpenApiDocumentDeleteByQuery },
   { verb: 'delete', path: '/:index/:collection/_bulk/_query', controller: 'bulk', action: 'deleteByQuery' },
 
   { verb: 'delete', path: '/:index/:collection/_mDelete', controller: 'document', action: 'mDelete' },
@@ -334,18 +349,18 @@ const routes = [
 
   { verb: 'put', path: '/:index/:collection/_specifications', controller: 'collection', action: 'updateSpecifications' },
 
-  { verb: 'put', path: '/:index/:collection/:_id', controller: 'document', action: 'createOrReplace' },
+  { verb: 'put', path: '/:index/:collection/:_id', controller: 'document', action: 'createOrReplace', openapi: OpenApiDocumentCreateOrReplace },
   { verb: 'put', path: '/:index/:collection/_mCreateOrReplace', controller: 'document', action: 'mCreateOrReplace' },
-  { verb: 'put', path: '/:index/:collection/:_id/_replace', controller: 'document', action: 'replace' },
+  { verb: 'put', path: '/:index/:collection/:_id/_replace', controller: 'document', action: 'replace', openapi: OpenApiDocumentReplace },
   { verb: 'put', path: '/:index/:collection/_mReplace', controller: 'document', action: 'mReplace' },
   { verb: 'put', path: '/:index/:collection/_mUpdate', controller: 'document', action: 'mUpdate', deprecated: { since: '2.11.0', message: 'Use "document:mUpdate" route with PATCH instead of PUT' } }, // @deprecated
-  { verb: 'put', path: '/:index/:collection/:_id/_update', controller: 'document', action: 'update', deprecated: { since: '2.11.0', message: 'Use "document:update" route with PATCH instead of PUT' } }, // @deprecated
+  { verb: 'put', path: '/:index/:collection/:_id/_update', controller: 'document', action: 'update', openapi: OpenApiDocumentUpdate, deprecated: { since: '2.11.0', message: 'Use "document:update" route with PATCH instead of PUT' } }, // @deprecated
   { verb: 'put', path: '/:index/:collection/:_id/_upsert', controller: 'document', action: 'upsert', deprecated: { since: '2.11.0', message: 'Use "document:upsert" route with POST instead of PUT' } }, // @deprecated
   { verb: 'put', path: '/:index/:collection/_query', controller: 'document', action: 'updateByQuery' },
 
   { verb: 'put', path: '/profiles/:_id', controller: 'security', action: 'createOrReplaceProfile' },
   { verb: 'put', path: '/roles/:_id', controller: 'security', action: 'createOrReplaceRole' },
-  { verb: 'put', path: '/credentials/:strategy/:_id/_update', controller: 'security', action: 'updateCredentials' },
+  { verb: 'put', path: '/credentials/:strategy/:_id/_update', controller: 'security', action: 'updateCredentials', },
   { verb: 'put', path: '/profiles/:_id/_update', controller: 'security', action: 'updateProfile' },
   { verb: 'put', path: '/roles/:_id/_update', controller: 'security', action: 'updateRole' },
   { verb: 'put', path: '/users/:_id/_update', controller: 'security', action: 'updateUser' },

package/lib/api/openApiGenerator.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Generates JSON OpenApi object
+ *
+ * @returns {object} openApi object
+ */
+export declare function generateOpenApi(): any;

package/lib/api/openApiGenerator.js

@@ -1,3 +1,9 @@
+"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
@@ -18,141 +24,176 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-'use strict';
-
-const _ = require('lodash');
-
+const lodash_1 = __importDefault(require("lodash"));
+const package_json_1 = require("./../../package.json");
+const document_1 = require("./openapi/document");
+const inflector_1 = require("./../util/inflector");
 const routeUrlMatch = /:([^/]*)/g;
-
 /**
- * Generates JSON OpenApi object
- *
- * @returns {object} openApi object
+ * Genrate basic openApi Controller
  */
-module.exports = function generateOpenApi () {
-  const routes = [];
-
-  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 = {
-    openapi: '3.0.1',
-    info: {
-      title: 'Kuzzle API',
-      description: 'The Kuzzle HTTP API',
-      contact: {
-        name: 'Kuzzle team',
-        url: 'http://kuzzle.io',
-        email: 'hello@kuzzle.io'
-      },
-      license: {
-        name: 'Apache 2',
-        url: 'http://opensource.org/licenses/apache2.0'
-      },
-      version: require('../../package').version
-    },
-    externalDocs: {
-      description: 'Kuzzle API Documentation',
-      url: 'https://docs.kuzzle.io/core/2/api/'
-    },
-    servers: [
-      {
-        url: 'https://{baseUrl}:{port}',
-        description: 'Kuzzle Base Url',
-        variables: {
-          baseUrl: {
-            default: 'localhost'
-          },
-          port: {
-            default: '7512'
-          }
+function generateController(route, response) {
+    if (route.controller !== undefined) {
+        if (!lodash_1.default.some(response.tags, { name: route.controller })) {
+            const capitalizedController = inflector_1.Inflector.upFirst(route.controller);
+            response.tags.push({ description: `${capitalizedController} Controller`, name: route.controller });
+        }
+        if (route.openapi.tags === undefined) {
+            route.openapi.tags = [];
+        }
+        if (!route.openapi.tags.includes(route.controller)) {
+            route.openapi.tags.push(route.controller);
         }
-
-      }
-    ],
-    tags: [],
-    paths: {},
-  };
-  /* eslint-enable sort-keys */
-
-  routes.forEach(route => {
-    // Make sure route verbs are lowercase
-    if (route.verb !== undefined) {
-      route.verb = route.verb.toLowerCase();
-    }
-
-    // Set :param notation to {param}
-    route.formattedPath = route.path.replace(routeUrlMatch, '{$1}');
-
-    if (response.paths[route.formattedPath] === undefined) {
-      response.paths[route.formattedPath] = {};
-    }
-
-    if (response.paths[route.formattedPath][route.verb] !== undefined) {
-      return;
-    }
-
-    // If custom specification, return as it is
-    if (route.openapi) {
-      response.paths[route.formattedPath][route.verb] = route.openapi;
-      return;
-    }
-
-    if (route.info === undefined) {
-      route.info = {};
     }
-    if (route.controller !== undefined) {
-      if (!_.some(response.tags, {name: route.controller})) {
-        const capitalizedController = route.controller.charAt(0).toUpperCase() + route.controller.slice(1);
-        response.tags.push({description: `${capitalizedController} Controller`, name: route.controller});
-      }
-      if (route.info.tags === undefined) {
-        route.info.tags = [];
-      }
-      if (!route.info.tags.includes(route.controller)) {
-        route.info.tags.push(route.controller);
-      }
+}
+/**
+ * Genrate basic openApi Summary
+ */
+function generateSummary(route) {
+    if (route.openapi.description === undefined) {
+        route.openapi.description = `Controller: ${route.controller}.`;
     }
-
-    if (route.info.description === undefined) {
-      route.info.description = `Controller: ${route.controller}.`;
+    if (route.openapi.summary === undefined) {
+        route.openapi.summary = `Action: ${route.action}.`;
     }
-    if (route.info.summary === undefined) {
-      route.info.summary = `Action: ${route.action}.`;
+}
+/**
+ * Genrate basic openApi Parameters
+ */
+function generateParameters(route) {
+    if (route.openapi.parameters === undefined) {
+        route.openapi.parameters = [];
+        let m = routeUrlMatch.exec(route.path);
+        while (m !== null) {
+            routeUrlMatch.lastIndex++;
+            route.openapi.parameters.push({
+                in: 'path',
+                name: m[1],
+                required: true,
+                schema: { type: 'string' }
+            });
+            m = routeUrlMatch.exec(route.path);
+        }
     }
-    if (route.info.parameters === undefined) {
-      route.info.parameters = [];
-
-      let m = routeUrlMatch.exec(route.path);
-      while (m !== null) {
-        routeUrlMatch.lastIndex++;
-        route.info.parameters.push({
-          in: 'path',
-          name: m[1],
-          required: true,
-          schema: {type: 'string'}
-        });
-
-        m = routeUrlMatch.exec(route.path);
-      }
+    if (route.openapi.parameters.length === 0) {
+        route.openapi.parameters = undefined;
     }
-
-    if (route.info.parameters.length === 0) {
-      route.info.parameters = undefined;
+}
+/**
+ * Genrate basic openApi Response
+ */
+function generateResponse(route) {
+    if (route.openapi.responses === undefined) {
+        route.openapi.responses = {
+            '200': {
+                description: 'OK'
+            }
+        };
     }
-
-    if (route.info.responses === undefined) {
-      route.info.responses = {
-        '200': {
-          description: 'OK'
+}
+/**
+ * Generates JSON OpenApi object
+ *
+ * @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 }));
+    /* eslint-disable sort-keys */
+    const response = {
+        swagger: '2.0',
+        info: {
+            title: 'Kuzzle API',
+            description: 'The Kuzzle HTTP API',
+            contact: {
+                name: 'Kuzzle team',
+                url: 'http://kuzzle.io',
+                email: 'hello@kuzzle.io',
+                discord: 'http://join.discord.kuzzle.io'
+            },
+            license: {
+                name: 'Apache 2',
+                url: 'http://opensource.org/licenses/apache2.0'
+            },
+            version: package_json_1.version
+        },
+        externalDocs: {
+            description: 'Kuzzle API Documentation',
+            url: 'https://docs.kuzzle.io/core/2/api/'
+        },
+        servers: [
+            {
+                url: 'https://{baseUrl}:{port}',
+                description: 'Kuzzle Base Url',
+                variables: {
+                    baseUrl: {
+                        default: 'localhost'
+                    },
+                    port: {
+                        default: '7512'
+                    }
+                }
+            }
+        ],
+        tags: [
+            {
+                name: 'document',
+                description: 'document controller'
+            }
+        ],
+        schemes: [
+            'https',
+            'http'
+        ],
+        paths: {},
+        components: {
+            ...document_1.DefinitionsDocument,
+            schemas: {
+                ...document_1.OpenApiDocumentCountComponent,
+                ...document_1.OpenApiDocumentDeleteByQueryComponent,
+                ...document_1.OpenApiDocumentDeleteComponent,
+                ...document_1.OpenApiDocumentScrollComponent,
+                ...document_1.OpenApiDocumentExistsComponent,
+                ...document_1.OpenApiDocumentUpdateComponent,
+                ...document_1.OpenApiDocumentReplaceComponent,
+                ...document_1.OpenApiDocumentGetComponent,
+                ...document_1.OpenApiDocumentCreateOrReplaceComponent,
+                ...document_1.OpenApiDocumentCreateComponent,
+            }
+        }
+    };
+    /* eslint-enable sort-keys */
+    for (const route of routes) {
+        // Make sure route verbs are lowercase
+        if (route.verb !== undefined) {
+            route.verb = route.verb.toLowerCase();
+        }
+        // Set :param notation to {param}
+        route.formattedPath = route.path.replace(routeUrlMatch, '{$1}');
+        if (response.paths[route.formattedPath] === undefined) {
+            response.paths[route.formattedPath] = {};
+        }
+        if (response.paths[route.formattedPath][route.verb] !== undefined) {
+            continue;
         }
-      };
+        // If custom specification, return as it is
+        if (route.openapi) {
+            response.paths[route.formattedPath][route.verb] = route.openapi;
+            continue;
+        }
+        if (route.openapi === undefined) {
+            route.openapi = {};
+        }
+        generateController(route, response);
+        generateSummary(route);
+        generateParameters(route);
+        generateResponse(route);
+        response.paths[route.formattedPath][route.verb] = route.openapi;
     }
-
-    response.paths[route.formattedPath][route.verb] = route.info;
-  });
-
-  return response;
-};
+    return response;
+}
+exports.generateOpenApi = generateOpenApi;
+//# sourceMappingURL=openApiGenerator.js.map

package/lib/api/openapi/document/count.yaml

@@ -0,0 +1,47 @@
+DocumentCount:
+  summary: "Counts documents in a collection."
+  tags:
+    - document
+  parameters:
+    - in: path
+      name: index
+      schema:
+        type: string
+    - in: path
+      name: collection
+      schema:
+        type: string
+    - in: body
+      name: "body"
+      description: "Counts documents in a collection."
+      required: true
+      schema:
+        $ref: "#/components/schemas/DocumentCountRequest"
+  responses:
+    200:
+      description: "Counts documents in a collection."
+      schema:
+        $ref: "#/components/schemas/DocumentCountResponse"
+
+components:
+  schemas:
+    DocumentCountRequest:
+      allOf:
+        - type: "object"
+          properties:
+            query:
+              type: "object"
+              properties:
+                match_all:
+                  type: "object"
+
+    DocumentCountResponse:
+      allOf:
+        - $ref: "#/components/ResponsePayload"
+        - type: "object"
+          properties:
+            result:
+              type: "object"
+              properties:
+                count:
+                  type: "integer"

package/lib/api/openapi/document/create.yaml

@@ -0,0 +1,46 @@
+DocumentCreate:
+  summary: "Creates a new document in the persistent data storage."
+  tags:
+    - document
+  parameters:
+    - in: path
+      name: index
+      schema:
+        type: string
+    - in: path
+      name: collection
+      schema:
+        type: string
+    - name: body
+      in: "body"
+      description: "Creates a new document in the persistent data storage."
+      required: true
+      schema:
+        $ref: "#/components/schemas/DocumentCreateRequest"
+  responses:
+    200:
+      description: "Creates a new document in the persistent data storage."
+      schema:
+          $ref: "#/components/schemas/DocumentCreateResponse"
+
+components:
+  schemas:
+    DocumentCreateRequest:
+      allOf:
+        - type: "object"
+          description: "document content"
+    DocumentCreateResponse:
+      allOf:
+        - $ref: "#/components/ResponsePayload"
+        - type: "object"
+          properties:
+            result:
+              type: "object"
+              properties:
+                _id:
+                  type: "string"
+                  description: "documentId"
+                _version:
+                  type: "integer"
+                _sources:
+                  type: "object"