kuzzle 2.49.1 → 2.50.0-beta.3

package/lib/core/shared/abstractManifest.js

@@ -1,102 +0,0 @@
-/*
- * Kuzzle, a backend software, self-hostable and ready to use
- * to power modern apps
- *
- * Copyright 2015-2022 Kuzzle
- * mailto: support AT kuzzle.io
- * website: http://kuzzle.io
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-"use strict";
-
-const _ = require("lodash");
-const path = require("path");
-const semver = require("semver");
-
-const kerror = require("../../kerror").wrap("plugin", "manifest");
-
-/**
- * Abstract class used to load a manifest.json file.
- * Used as a base for plugins and protocols.
- *
- * @param {Kuzzle} kuzzle       - Kuzzle instance
- * @param {string} pluginPath   - Absolute path to the plugin directory
- */
-class AbstractManifest {
-  constructor(pluginPath) {
-    this.path = pluginPath;
-
-    this.manifestPath = path.resolve(this.path, "manifest.json");
-    this.name = null;
-    this.kuzzleVersion = null;
-    this.raw = null;
-  }
-
-  load() {
-    try {
-      this.raw = require(this.manifestPath);
-    } catch (e) {
-      throw kerror.get("cannot_load", this.manifestPath, e.message);
-    }
-
-    if (_.isNil(this.raw.kuzzleVersion)) {
-      throw kerror.get("missing_version", this.manifestPath);
-    }
-
-    this.kuzzleVersion = this.raw.kuzzleVersion;
-
-    if (
-      !semver.satisfies(global.kuzzle.config.version, this.kuzzleVersion, {
-        includePrerelease: true,
-      })
-    ) {
-      throw kerror.get(
-        "version_mismatch",
-        this.path,
-        global.kuzzle.config.version,
-        this.kuzzleVersion,
-      );
-    }
-
-    if (!_.isNil(this.raw.name)) {
-      if (typeof this.raw.name !== "string" || this.raw.name.length === 0) {
-        throw kerror.get("invalid_name_type", this.manifestPath);
-      }
-
-      this.name = this.raw.name;
-    } else {
-      throw kerror.get("missing_name", this.manifestPath);
-    }
-  }
-
-  /**
-   * This object can be stringified and exported, most notably by the
-   * server:info API action
-   * It's important that only relevant properties are stringified, to
-   * prevent circular JSONs (especially with the kuzzle object ref) and
-   * to prevent leaking important information
-   *
-   * @returns {Object}
-   */
-  toJSON() {
-    return {
-      kuzzleVersion: this.kuzzleVersion,
-      name: this.name,
-      path: this.path,
-    };
-  }
-}
-
-module.exports = AbstractManifest;

package/lib/core/shared/sdk/impersonatedSdk.js

@@ -1,94 +0,0 @@
-/*
- * Kuzzle, a backend software, self-hostable and ready to use
- * to power modern apps
- *
- * Copyright 2015-2022 Kuzzle
- * mailto: support AT kuzzle.io
- * website: http://kuzzle.io
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-"use strict";
-
-const nativeControllers = require("../../../api/controllers");
-
-class ImpersonatedSDK {
-  constructor(kuid, options = {}) {
-    this.kuid = kuid;
-    this.checkRights = options.checkRights || false;
-
-    for (const controller of Object.keys(nativeControllers)) {
-      // @todo in the future, native controller names should be normalized to sdk naming
-      const controllerName = controller
-        .replace("Controller", "")
-        .replace("MemoryStorage", "ms")
-        .toLowerCase();
-      const controllerProxy = `${controllerName}Proxy`;
-
-      if (!global.app.sdk[controllerName]) {
-        continue;
-      }
-
-      // Lazily wrap in runtime; native 'sdk' controllers and induce custom 'query' beaviour
-      Reflect.defineProperty(this, controllerName, {
-        get: () => {
-          // If the requested controller has not yet been proxied
-          if (!this[controllerProxy]) {
-            // Create a proxy object to inject our local 'query' behaviour
-            // in the underlying base 'sdk' action methods so we can send
-            // impersonation configuration (kuid & checkRights) to the funnel
-            this[controllerProxy] = new Proxy(global.app.sdk[controllerName], {
-              get: (controllerInstance, actionName) => {
-                const customContext = {
-                  kuzzle: global.app.sdk,
-                  query: (request, opts) => {
-                    request.controller = controllerName;
-
-                    // Call the 'ImpersonatedSdk.query' method instead
-                    return this.query(request, opts);
-                  },
-                };
-
-                // Make sure we bring any local methods into our new custom context
-                Object.getOwnPropertyNames(
-                  Object.getPrototypeOf(global.app.sdk[controllerName]),
-                ).forEach((localMethod) => {
-                  if (!["constructor", "query"].includes(localMethod)) {
-                    customContext[localMethod] =
-                      controllerInstance[localMethod];
-                  }
-                });
-
-                // Return the original SDK action method AND also bind our merged custom context
-                // containing our 'query' method and any original local methods
-                return controllerInstance[actionName].bind(customContext);
-              },
-            });
-          }
-
-          return this[controllerProxy];
-        },
-      });
-    }
-  }
-
-  query(request, options = {}) {
-    request.__kuid__ = this.kuid;
-    request.__checkRights__ = this.checkRights;
-
-    return global.app.sdk.query(request, options);
-  }
-}
-
-module.exports = ImpersonatedSDK;

package/lib/core/statistics/index.js

@@ -1,24 +0,0 @@
-/*
- * Kuzzle, a backend software, self-hostable and ready to use
- * to power modern apps
- *
- * Copyright 2015-2022 Kuzzle
- * mailto: support AT kuzzle.io
- * website: http://kuzzle.io
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-"use strict";
-
-module.exports = require("./statistics");

package/lib/core/statistics/statistics.js

@@ -1,373 +0,0 @@
-/*
- * Kuzzle, a backend software, self-hostable and ready to use
- * to power modern apps
- *
- * Copyright 2015-2022 Kuzzle
- * mailto: support AT kuzzle.io
- * website: http://kuzzle.io
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-"use strict";
-
-const errorApiAssert = require("../../kerror").wrap("api", "assert");
-const errorStats = require("../../kerror").wrap("services", "stats");
-
-/**
- * @class Statistics
- * @param {Kuzzle} kuzzle
- */
-class Statistics {
-  constructor() {
-    // uses '{' and '}' to force all statistics frames to be stored on 1 redis
-    // node
-    // (see https://redis.io/topics/cluster-spec#keys-distribution-model)
-    this.cacheKeyPrefix = "{stats/}";
-
-    this.enabled = global.kuzzle.config.stats.enabled;
-    this.ttl = global.kuzzle.config.stats.ttl * 1000;
-    this.interval = global.kuzzle.config.stats.statsInterval * 1000;
-    this.lastFrame = null;
-    this.timer = null;
-
-    this.currentStats = {
-      completedRequests: new Map(),
-      connections: new Map(),
-      failedRequests: new Map(),
-      ongoingRequests: new Map(),
-    };
-
-    this.logger = global.kuzzle.log.child("core:statistics");
-  }
-
-  /**
-   * Start recording a new request
-   *
-   * @param {Request} request
-   */
-  startRequest(request) {
-    if (!this.enabled) {
-      return;
-    }
-
-    const protocol = request && request.context.connection.protocol;
-
-    if (!protocol) {
-      return;
-    }
-
-    if (!this.currentStats.ongoingRequests.has(protocol)) {
-      this.currentStats.ongoingRequests.set(protocol, 1);
-    } else {
-      this.currentStats.ongoingRequests.set(
-        protocol,
-        this.currentStats.ongoingRequests.get(protocol) + 1,
-      );
-    }
-  }
-
-  /**
-   * Mark an ongoing request as 'completed'
-   *
-   * @param {Request} request
-   */
-  completedRequest(request) {
-    if (!this.enabled) {
-      return;
-    }
-
-    const protocol = request && request.context.connection.protocol;
-
-    if (!protocol) {
-      return;
-    }
-
-    this.currentStats.ongoingRequests.set(
-      protocol,
-      this.currentStats.ongoingRequests.get(protocol) - 1,
-    );
-
-    if (!this.currentStats.completedRequests.has(protocol)) {
-      this.currentStats.completedRequests.set(protocol, 1);
-    } else {
-      this.currentStats.completedRequests.set(
-        protocol,
-        this.currentStats.completedRequests.get(protocol) + 1,
-      );
-    }
-  }
-
-  /**
-   * Mark an ongoing request as 'completed'
-   *
-   * @param {Request} request
-   */
-  failedRequest(request) {
-    if (!this.enabled) {
-      return;
-    }
-
-    const protocol = request && request.context.connection.protocol;
-
-    if (!protocol) {
-      return;
-    }
-
-    this.currentStats.ongoingRequests.set(
-      protocol,
-      this.currentStats.ongoingRequests.get(protocol) - 1,
-    );
-
-    if (!this.currentStats.failedRequests.has(protocol)) {
-      this.currentStats.failedRequests.set(protocol, 1);
-    } else {
-      this.currentStats.failedRequests.set(
-        protocol,
-        this.currentStats.failedRequests.get(protocol) + 1,
-      );
-    }
-  }
-
-  /**
-   * Register a newly created connection
-   *
-   * @param {RequestContext} requestContext
-   */
-  newConnection(requestContext) {
-    if (!this.enabled) {
-      return;
-    }
-
-    if (!requestContext.connection.protocol) {
-      return;
-    }
-
-    if (
-      !this.currentStats.connections.has(requestContext.connection.protocol)
-    ) {
-      this.currentStats.connections.set(requestContext.connection.protocol, 1);
-    } else {
-      this.currentStats.connections.set(
-        requestContext.connection.protocol,
-        this.currentStats.connections.get(requestContext.connection.protocol) +
-          1,
-      );
-    }
-  }
-
-  /**
-   * Removes a connection from the statistics
-   *
-   * @param {RequestContext} requestContext
-   */
-  dropConnection(requestContext) {
-    if (!this.enabled) {
-      return;
-    }
-
-    if (!requestContext.connection.protocol) {
-      return;
-    }
-
-    if (
-      this.currentStats.connections.get(requestContext.connection.protocol) ===
-      1
-    ) {
-      this.currentStats.connections.delete(requestContext.connection.protocol);
-    } else {
-      this.currentStats.connections.set(
-        requestContext.connection.protocol,
-        this.currentStats.connections.get(requestContext.connection.protocol) -
-          1,
-      );
-    }
-  }
-
-  /**
-   * Gets stored statistics frames from a date
-   *
-   * @returns {Promise}
-   */
-  async getLastStats() {
-    if (!this.enabled) {
-      throw errorStats.get("not_available");
-    }
-
-    const frame = Object.assign(
-      { timestamp: new Date().getTime() },
-      this.currentStats,
-    );
-
-    if (!this.lastFrame) {
-      return frame;
-    }
-
-    const last = await global.kuzzle.ask(
-      "core:cache:internal:get",
-      this.cacheKeyPrefix + this.lastFrame,
-    );
-
-    return Object.assign(frame, JSON.parse(last));
-  }
-
-  /**
-   * Gets the last saved statistics frame from a date
-   *
-   * @param {Request} request
-   * @returns {Promise<Object>}
-   */
-  async getStats(request) {
-    if (!this.enabled) {
-      throw errorStats.get("not_available");
-    }
-
-    const response = {
-      hits: [],
-      total: null,
-    };
-    const currentDate = new Date().getTime();
-    let startTime;
-    let stopTime;
-
-    if (request && request.input.args && request.input.args.startTime) {
-      startTime = isNaN(request.input.args.startTime)
-        ? new Date(request.input.args.startTime).getTime()
-        : request.input.args.startTime;
-    }
-
-    if (request && request.input.args && request.input.args.stopTime) {
-      stopTime = isNaN(request.input.args.stopTime)
-        ? new Date(request.input.args.stopTime).getTime()
-        : request.input.args.stopTime;
-    }
-
-    if (startTime !== undefined && isNaN(startTime)) {
-      throw errorApiAssert.get("invalid_argument", "startTime", "number");
-    }
-
-    if (stopTime !== undefined && isNaN(stopTime)) {
-      throw errorApiAssert.get("invalid_argument", "stopTime", "number");
-    }
-
-    if (startTime !== undefined && startTime >= currentDate) {
-      response.total = response.hits.length;
-      return response;
-    }
-
-    const stats = {
-      completedRequests: Object.fromEntries(
-        this.currentStats.completedRequests,
-      ),
-      connections: Object.fromEntries(this.currentStats.connections),
-      failedRequests: Object.fromEntries(this.currentStats.failedRequests),
-      ongoingRequests: Object.fromEntries(this.currentStats.ongoingRequests),
-    };
-
-    if (!this.lastFrame) {
-      if (!stopTime || stopTime >= currentDate) {
-        response.hits.push(
-          Object.assign({ timestamp: new Date(currentDate).getTime() }, stats),
-        );
-      }
-
-      response.total = response.hits.length;
-
-      return response;
-    }
-
-    const frames = await global.kuzzle.ask(
-      "core:cache:internal:searchKeys",
-      `${this.cacheKeyPrefix}*`,
-    );
-
-    // Statistics keys are timestamp.
-    // Ordering them guarantees stats frames to be returned in the right order
-    const values = await global.kuzzle.ask(
-      "core:cache:internal:mget",
-      frames.sort(),
-    );
-
-    values.forEach((v, idx) => {
-      const regex = new RegExp(`^${this.cacheKeyPrefix}`);
-      const frameDate = new Date(Number(frames[idx].replace(regex, "")));
-      const frameDateTime = frameDate.getTime();
-
-      if (
-        (!startTime || startTime <= frameDateTime) &&
-        (!stopTime || stopTime >= frameDateTime)
-      ) {
-        response.hits.push(
-          Object.assign(JSON.parse(v), {
-            timestamp: new Date(frameDateTime).getTime(),
-          }),
-        );
-      }
-    });
-
-    response.total = response.hits.length;
-
-    return response;
-  }
-
-  /**
-   * Gets all the saved statistics
-   *
-   * @returns {Promise<Object>}
-   */
-  getAllStats() {
-    return this.getStats();
-  }
-
-  /**
-   * Init statistics component
-   */
-  init() {
-    if (!this.enabled) {
-      return;
-    }
-
-    this.timer = setInterval(async () => {
-      try {
-        await this.writeStats();
-      } catch (error) {
-        this.logger.error(`Cannot write stats frame: ${error}`);
-      }
-    }, this.interval);
-
-    global.kuzzle.on("core:cache:internal:flushdb", () => {
-      this.lastFrame = null;
-    });
-  }
-
-  async writeStats() {
-    if (!this.enabled) {
-      return;
-    }
-
-    const stats = JSON.stringify(this.currentStats);
-
-    this.lastFrame = Date.now();
-    this.currentStats.completedRequests = new Map();
-    this.currentStats.failedRequests = new Map();
-
-    await global.kuzzle.ask(
-      "core:cache:internal:store",
-      this.cacheKeyPrefix + this.lastFrame,
-      stats,
-      { ttl: this.ttl },
-    );
-  }
-}
-
-module.exports = Statistics;