kuzzle 2.16.11 → 2.17.2

package/lib/api/controllers/securityController.js

@@ -38,7 +38,7 @@ const { generateRandomName } = require('../../util/name-generator');
  * @class SecurityController
  */
 class SecurityController extends NativeController {
-  constructor() {
+  constructor () {
     super([
       'checkRights',
       'createApiKey',
@@ -136,7 +136,7 @@ class SecurityController extends NativeController {
     const expiresIn = request.input.args.expiresIn || -1;
     const refresh = request.getRefresh('wait_for');
     const userId = request.getString('userId');
-    const apiKeyId = request.getId({ ifMissing: 'ignore' });
+    const apiKeyId = request.getId({ ifMissing: 'generate' });
     const description = request.getBodyString('description');
 
     const user = await this.ask('core:security:user:get', userId);
@@ -229,9 +229,9 @@ class SecurityController extends NativeController {
    * @returns {Promise}
    */
   async getProfileMapping () {
-    const {properties} = await global.kuzzle.internalIndex.getMapping('profiles');
+    const { properties } = await global.kuzzle.internalIndex.getMapping('profiles');
 
-    return {mapping: properties};
+    return { mapping: properties };
   }
 
   /**
@@ -252,9 +252,9 @@ class SecurityController extends NativeController {
    * @returns {Promise}
    */
   async getUserMapping () {
-    const {properties} = await global.kuzzle.internalIndex.getMapping('users');
+    const { properties } = await global.kuzzle.internalIndex.getMapping('users');
 
-    return {mapping: properties};
+    return { mapping: properties };
   }
 
   /**
@@ -275,7 +275,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async getRole(request) {
+  async getRole (request) {
     const id = request.getId();
 
     const role = await this.ask('core:security:role:get', id);
@@ -289,7 +289,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async mGetRoles(request) {
+  async mGetRoles (request) {
     const ids = request.getBodyArray('ids');
     const roles = await this.ask('core:security:role:mGet', ids);
 
@@ -305,7 +305,7 @@ class SecurityController extends NativeController {
   async refresh (request) {
     const collection = request.getCollection();
 
-    if (!this.securityCollections.includes(collection)) {
+    if (! this.securityCollections.includes(collection)) {
       throw kerror.get(
         'api',
         'assert',
@@ -360,7 +360,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async createOrReplaceRole(request) {
+  async createOrReplaceRole (request) {
     const id = request.getId();
     const body = request.getBody();
     const userId = request.getKuid();
@@ -402,7 +402,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async deleteRole(request) {
+  async deleteRole (request) {
     const id = request.getId();
 
     await this.ask('core:security:role:delete', id, {
@@ -422,7 +422,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async getProfile(request) {
+  async getProfile (request) {
     const id = request.getId();
 
     const profile = await this.ask('core:security:profile:get', id);
@@ -436,7 +436,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async mGetProfiles(request) {
+  async mGetProfiles (request) {
     const ids = request.getBodyArray('ids');
 
     const profiles = await this.ask('core:security:profile:mGet', ids);
@@ -512,7 +512,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async deleteProfile(request) {
+  async deleteProfile (request) {
     const id = request.getId();
     const userId = request.getKuid();
     const options = {
@@ -579,7 +579,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async getUser(request) {
+  async getUser (request) {
     const id = request.getId();
     const user = await this.ask('core:security:user:get', id);
 
@@ -592,7 +592,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise.<Object>}
    */
-  async mGetUsers(request) {
+  async mGetUsers (request) {
     let ids;
 
     if ( request.input.body
@@ -616,7 +616,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async getProfileRights(request) {
+  async getProfileRights (request) {
     const id = request.getId();
 
     const profile = await this.ask('core:security:profile:get', id);
@@ -637,7 +637,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async getUserRights(request) {
+  async getUserRights (request) {
     const id = request.getId();
 
     const user = await this.ask('core:security:user:get', id);
@@ -658,7 +658,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async getUserStrategies(request) {
+  async getUserStrategies (request) {
     const userId = request.getId();
     const checkPromises = [];
 
@@ -695,7 +695,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async searchUsers(request) {
+  async searchUsers (request) {
     const size = this._getSearchPageSize(request);
     const { from, scrollTTL, searchBody } = request.getSearchParams();
     const lang = request.getLangParam();
@@ -751,7 +751,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async deleteUser(request) {
+  async deleteUser (request) {
     const id = request.getId();
     const options = { refresh: request.getRefresh('wait_for') };
 
@@ -768,7 +768,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async createUser(request) {
+  async createUser (request) {
     const content = request.getBodyObject('content');
     const profileIds = get(content, 'profileIds');
     const humanReadableId = request.getString('kuid', 'human') !== 'uuid';
@@ -777,7 +777,7 @@ class SecurityController extends NativeController {
       throw kerror.get('api', 'assert', 'missing_argument', 'body.content.profileIds');
     }
 
-    if (!Array.isArray(profileIds)) {
+    if (! Array.isArray(profileIds)) {
       throw kerror.get('api', 'assert', 'invalid_type', 'body.content.profileIds', 'array');
     }
 
@@ -790,7 +790,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async createRestrictedUser(request) {
+  async createRestrictedUser (request) {
     const content = request.getBodyObject('content', {});
     const humanReadableId = request.getString('kuid', 'human') !== 'uuid';
 
@@ -811,7 +811,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async updateUser(request) {
+  async updateUser (request) {
     const id = request.getId();
     const content = request.getBody();
     const userId = request.getKuid();
@@ -865,7 +865,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async updateProfile(request) {
+  async updateProfile (request) {
     const id = request.getId();
     const body = request.getBody();
     const userId = request.getKuid();
@@ -887,7 +887,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async updateRole(request) {
+  async updateRole (request) {
     const id = request.getId();
     const body = request.getBody();
     const userId = request.getKuid();
@@ -951,7 +951,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  mDeleteProfiles(request) {
+  mDeleteProfiles (request) {
     return this._mDelete('profile', request);
   }
 
@@ -961,7 +961,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  mDeleteRoles(request) {
+  mDeleteRoles (request) {
     return this._mDelete('role', request);
   }
 
@@ -971,7 +971,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  mDeleteUsers(request) {
+  mDeleteUsers (request) {
     return this._mDelete('user', request);
   }
 
@@ -981,7 +981,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async scrollUsers(request) {
+  async scrollUsers (request) {
     const id = request.getString('scrollId');
     const ttl = request.getScrollTTLParam();
 
@@ -998,7 +998,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async scrollProfiles(request) {
+  async scrollProfiles (request) {
     const id = request.getString('scrollId');
     const ttl = request.getScrollTTLParam();
 
@@ -1013,7 +1013,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async createCredentials(request) {
+  async createCredentials (request) {
     const id = request.getId();
     const body = request.getBody();
     const strategy = request.getString('strategy');
@@ -1037,7 +1037,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async updateCredentials(request) {
+  async updateCredentials (request) {
     const id = request.getId();
     const body = request.getBody();
     const strategy = request.getString('strategy');
@@ -1062,7 +1062,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise.<Object>}
    */
-  async hasCredentials(request) {
+  async hasCredentials (request) {
     const id = request.getId();
     const strategy = request.getString('strategy');
 
@@ -1077,7 +1077,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise.<Object>}
    */
-  async validateCredentials(request) {
+  async validateCredentials (request) {
     const strategy = request.getString('strategy');
 
     this.assertIsStrategyRegistered(strategy);
@@ -1096,7 +1096,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async deleteCredentials(request) {
+  async deleteCredentials (request) {
     const id = request.getId();
     const strategy = request.getString('strategy');
 
@@ -1108,14 +1108,14 @@ class SecurityController extends NativeController {
 
     global.kuzzle.log.info(`[SECURITY] User "${request.getKuid()}" applied action "${request.input.action}" on user "${id}."`);
 
-    return {acknowledged: true};
+    return { acknowledged: true };
   }
 
   /**
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async getCredentials(request) {
+  async getCredentials (request) {
     const id = request.getId();
     const strategy = request.getString('strategy');
 
@@ -1134,7 +1134,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async getCredentialsById(request) {
+  async getCredentialsById (request) {
     const id = request.getId();
     const strategy = request.getString('strategy');
 
@@ -1153,7 +1153,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise<Object>}
    */
-  async getCredentialFields(request) {
+  async getCredentialFields (request) {
     const strategy = request.getString('strategy');
 
     this.assertIsStrategyRegistered(strategy);
@@ -1164,7 +1164,7 @@ class SecurityController extends NativeController {
   /**
    * @returns {Promise<Object>}
    */
-  async getAllCredentialFields() {
+  async getAllCredentialFields () {
     const strategyFields = {};
 
     global.kuzzle.pluginsManager.listStrategies()
@@ -1180,7 +1180,7 @@ class SecurityController extends NativeController {
    * @param {Request} request
    * @returns {Promise.<null>}
    */
-  async revokeTokens(request) {
+  async revokeTokens (request) {
     const id = request.getId();
 
     await this.ask('core:security:token:deleteByKuid', id);
@@ -1207,7 +1207,7 @@ class SecurityController extends NativeController {
 
     await Bluebird.map(
       ids,
-      id => this.ask(`core:security:${type}:delete`, id, {refresh})
+      id => this.ask(`core:security:${type}:delete`, id, { refresh })
         .then(() => successes.push(id))
         .catch(err => errors.push(err)));
 
@@ -1231,7 +1231,7 @@ class SecurityController extends NativeController {
    * @returns {Promise}
    * @private
    */
-  async _persistUser(request, profileIds, content, { humanReadableId=true } = {}) {
+  async _persistUser (request, profileIds, content, { humanReadableId = true } = {}) {
     const credentials = request.getBodyObject('credentials', {});
     const strategies = Object.keys(credentials);
     const generator = humanReadableId
@@ -1253,7 +1253,7 @@ class SecurityController extends NativeController {
       });
 
       for (const strategy of strategies) {
-        if (!global.kuzzle.pluginsManager.listStrategies().includes(strategy)) {
+        if (! global.kuzzle.pluginsManager.listStrategies().includes(strategy)) {
           throw kerror.get(
             'security',
             'credentials',
@@ -1293,12 +1293,12 @@ class SecurityController extends NativeController {
 
     for (const strategy of strategies) {
       try {
-        const validate = this.getStrategyMethod(strategy,'validate');
+        const validate = this.getStrategyMethod(strategy, 'validate');
 
         await validate(request, credentials[strategy], id, strategy, false);
       }
       catch (error) {
-        creationFailure = {error, validation: true};
+        creationFailure = { error, validation: true };
         break;
       }
 
@@ -1309,7 +1309,7 @@ class SecurityController extends NativeController {
         createdStrategies.push(strategy);
       }
       catch (error) {
-        creationFailure = {error, validation: false};
+        creationFailure = { error, validation: false };
         break;
       }
     }
@@ -1379,7 +1379,7 @@ class SecurityController extends NativeController {
    * @param {number} limit
    * @throws
    */
-  _getSearchPageSize(request) {
+  _getSearchPageSize (request) {
     const size = request.getInteger(
       'size',
       global.kuzzle.config.limits.documentsFetchCount);

package/lib/api/controllers/serverController.js

@@ -23,9 +23,9 @@
 
 const os = require('os');
 const jsonToYaml = require('json2yaml');
+const packagejson = require('../../../package.json');
 
 const { NativeController } = require('./baseController');
-const { generateOpenApi } = require('../openApiGenerator');
 
 const kerror = require('../../kerror');
 
@@ -33,9 +33,10 @@ const kerror = require('../../kerror');
  * @class ServerController
  */
 class ServerController extends NativeController {
-  constructor() {
+  constructor () {
     super([
       'adminExists',
+      'capabilities',
       'getAllStats',
       'getConfig',
       'getLastStats',
@@ -48,12 +49,28 @@ class ServerController extends NativeController {
       'openapi',
     ]);
 
-    this._openApiDefinition = {
-      json: null,
-      yaml: null,
+    this._info = {
+      elasticsearch: null,
+      redis: null,
     };
   }
 
+  /**
+   * Init ServerController
+   * Used to perform asynchronous initialization safely: the funnel will wait
+   * for all controllers to be initialized before accepting requests.
+   *
+   * @returns {Promise}
+  */
+  async init () {
+    const [storageInfo, cacheInfo] = await Promise.all([
+      global.kuzzle.ask('core:storage:public:info:get'),
+      global.kuzzle.ask('core:cache:public:info:get'),
+    ]);
+    this._info.elasticsearch = storageInfo;
+    this._info.redis = cacheInfo;
+  }
+
   /**
    * Returns the statistics frame from a date
    *
@@ -110,6 +127,39 @@ class ServerController extends NativeController {
     return config;
   }
 
+  /**
+   * Returns the Kuzzle capabilities
+   * @returns {Promise<Object>}
+   */
+  async capabilities () {
+    const config = JSON.parse(JSON.stringify(global.kuzzle.config));
+    const publicApi = await this.publicApi();
+    const services = {};
+    const plugins = {};
+
+    for (const plugin of config.plugins.common.include) {
+      plugins[plugin] = {
+        version: packagejson.dependencies[plugin]
+      };
+    }
+
+    for (const [name, info] of Object.entries(config.services)) {
+      if (info.backend !== undefined) {
+        services[name] = {
+          backend: info.backend,
+          version: this._info[info.backend].version,
+        };
+      }
+    }
+
+    return {
+      limits: config.limits,
+      plugins: plugins,
+      routes: publicApi,
+      services: services,
+      version: config.version,
+    };
+  }
   /**
    * Checks if an admin user Exists
    *
@@ -140,7 +190,7 @@ class ServerController extends NativeController {
     if (typeof request.input.args.services === 'string') {
       services = request.input.args.services.split(',');
     }
-    if (!services || services.includes('internalCache')) {
+    if (! services || services.includes('internalCache')) {
       try {
         await global.kuzzle.ask('core:cache:internal:info:get');
         result.services.internalCache = 'green';
@@ -151,7 +201,7 @@ class ServerController extends NativeController {
         result.status = 'red';
       }
     }
-    if (!services || services.includes('memoryStorage')) {
+    if (! services || services.includes('memoryStorage')) {
       try {
         await global.kuzzle.ask('core:cache:public:info:get');
         result.services.memoryStorage = 'green';
@@ -162,7 +212,7 @@ class ServerController extends NativeController {
         result.status = 'red';
       }
     }
-    if (!services || services.includes('storageEngine')) {
+    if (! services || services.includes('storageEngine')) {
       try {
         const response = await global.kuzzle.ask('core:storage:public:info:get');
 
@@ -247,7 +297,19 @@ class ServerController extends NativeController {
 
   async openapi (request) {
     const format = request.getString('format', 'json');
-    const specifications = this.getOpenApiDefinition(format);
+    const scope = request.getString('scope', 'kuzzle');
+
+    let definition;
+
+    if (scope === 'kuzzle') {
+      definition = await global.kuzzle.ask('core:api:openapi:kuzzle');
+    }
+    else if (scope === 'app') {
+      definition = await global.kuzzle.ask('core:api:openapi:app');
+    }
+    else {
+      throw kerror.get('api', 'assert', 'unexpected_argument', scope, ['kuzzle', 'app']);
+    }
 
     request.response.configure({
       format: 'raw',
@@ -255,23 +317,7 @@ class ServerController extends NativeController {
       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];
+    return format === 'json' ? definition : jsonToYaml.stringify(definition);
   }
 
   /**
@@ -293,7 +339,7 @@ class ServerController extends NativeController {
       const actionList = {};
 
       for (const action of controller._actions) {
-        actionList[action] = { action , controller: name };
+        actionList[action] = { action, controller: name };
 
         // resolve associated http route for each actions
         const routes = httpRoutes.filter(route => {

package/lib/api/documentExtractor.js

@@ -229,7 +229,7 @@ const extractors = ([
 }, {});
 
 class DocumentExtractor {
-  constructor(request) {
+  constructor (request) {
     this.request = request;
 
     const extractor = extractors[request.input.action];
@@ -248,11 +248,11 @@ class DocumentExtractor {
     }
   }
 
-  extract() {
+  extract () {
     return this.extractMethod(this.request);
   }
 
-  insert(documents) {
+  insert (documents) {
     return this.insertMethod(documents, this.request);
   }
 }