kuzzle 2.15.2 → 2.16.3

package/CONTRIBUTING.md

@@ -1,116 +0,0 @@
-# How to contribute to Kuzzle
-
-Here are a few rules and guidelines to follow if you want to contribute to Kuzzle and, more importantly, if you want to see your pull requests accepted by Kuzzle team.
-
-## Coding style
-
-We use most of the [NPM Coding Style](https://www.w3resource.com/npm/npm-coding-style.php) rules, except for these ones:
-
-* Semicolons at the end of lines
-* 'Comma first' rule is not followed
-
-## Guidelines
-
-* Prefer async/await or promises instead of callbacks as often as you can
-  * Except for methods invoked before the funnel module: ALWAYS use callbacks there to prevent event loop saturation (i.e. mostly methods handling network connections) 
-* Always add/update the corresponding unit and/or functional tests. We won't accept non-tested pull requests.
-* [Documentation and comments are more important than code](http://queue.acm.org/detail.cfm?id=1053354): comment your code, use jsdoc for every new function, add or update markdown documentation if need be. We won't accept undocumented pull requests.
-* Similar to the previous rule: documentation is important, but also is code readability. Write [self-describing code](https://en.wikipedia.org/wiki/Self-documenting).
-
-## General rules and principles we'd like you to follow
-
-* If you plan to add new features to Kuzzle, make sure that this is for a general improvement to benefit a majority of Kuzzle users. If not, consider making a plugin instead (check our [plugin documentation](https://docs.kuzzle.io/plugins/1))
-* Follow the [KISS Principle](https://en.wikipedia.org/wiki/KISS_principle)
-* Follow [The Boy Scout Rule](https://deviq.com/principles/boy-scout-rule)
-
-## Tools
-
-For development only, we built a specific docker-compose file: `docker-compose.yml`. You can use it to profile, debug, test a variable on the fly, add breakpoints and so on, thanks to [chrome-devtools](https://developer.chrome.com/devtools).  
-Check the logs at the start of Kuzzle using the development docker image to get the appropriate debug URL.
-
-How to run the development stack (needs Docker 1.10+ and Docker Compose 1.8+):
-
-```bash
-# clone this repository
-git clone git@github.com:kuzzleio/kuzzle.git
-cd kuzzle
-
-# Start a kuzzle cluster with development tools enabled
-docker-compose up
-```
-
-### ENOSPC error
-
-On some Linux environments, you may get `ENOSPC` errors from the filesystem watcher, because of limits set too low.
-
-If that happens, simply raise the limits on the number of files that can be watched:
-
-`sudo sysctl -w fs.inotify.max_user_watches=524288`
-
-That configuration change will last until the next reboot. 
-
-To make it permanent, add the following line to your `/etc/sysctl.conf` file:
-
-```
-fs.inotify.max_user_watches=524288
-```
-
-You can now access the Kuzzle HTTP/WebSocket API through the following URL: `http://localhost:7512`.
-This is the entrypoint for the loadbalancer: API requests are then forwarded to kuzzle individual kuzzle nodes (round-robin).
-
-For development purposes, nodes can be accessed individually:
-
-| Node no. | HTTP/WebSocket port | MQTT port | Chrome Inspect Port |
-|:--------:|:-------------------:|:---------:|:-------------------:|
-| 1 | 17510 | 1883 | 9229 |
-| 2 | 17511 | 11883 | 9230 |
-| 3 | 17512 | 11884 | 9231 |
-
-Everytime a modification is detected in the source files, the nodes are automatically restarted.
-
-### Kuzzle over SSL
-
-[See our complete guide](https://docs.kuzzle.io/core/2/guides/essentials/ssl-support/)
-
-The development stack include a endpoint to access Kuzzle API through SSL on port `7443`.  
-
-The certificates are privately signed, using provided [CA certificate](docker/nginx/kuzzleCA.crt).  
-Domains accepted:
-- localhost
-- *.kuzzle.loc
-
-You'll need to import the CA certificate to your browser and possibly your system local authorities to make it verified.
-Once done, your browser should not complain when reaching https://localhost:7443.  
-The CA certificate is here: [docker/nginx/kuzzleCA.crt](docker/nginx/kuzzleCA.crt)
-
-Using node.js, for instance when using the sdk, you'll need to pass the CA cert using the `NODE_EXTRA_CA_CERTS` environment variable:
-
-```
-NODE_EXTRA_CA_CERTS=/path/to/certificate/kuzzleCA.crt wscat -c wss://localhost:7443
-```
-
-## Create a plugin
-
-See our [plugins documentation](https://docs.kuzzle.io/core/2/plugins/)
-
-## Running Tests
-   
-### Using docker, with Kuzzle running in Docker
-
-```bash
-$ docker-compose up -d
-
-# Wait for Kuzzle stack to be up, and start the entire test suite (long)
-$ npm run test
-
-# To launch tests individually:
-
-# linter: check that the code is properly written
-$ npm run test:lint
-
-# unit tests: test parts of the code individually
-$ npm run test:unit
-
-# functional tests: test Kuzzle's API behavior
-$ npm run test:functional
-```

package/bin/.lib/colorOutput.js

@@ -1,71 +0,0 @@
-/*
- * Kuzzle, a backend software, self-hostable and ready to use
- * to power modern apps
- *
- * Copyright 2015-2020 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 clc = require('cli-color');
-
-function noop(str) {
-  return str;
-}
-
-class ColorOutput {
-  constructor (opts) {
-    // /!\ "opts" might be a string
-    const noColors =
-      typeof opts === 'object' &&
-        opts.parent &&
-        opts.parent.noColors;
-
-    this.format = {
-      error: noColors ? noop : clc.red,
-      warn: noColors ? noop : clc.yellow,
-      notice: noColors ? noop : clc.cyanBright,
-      ok: noColors ? noop : clc.green.bold,
-      question: noColors ? noop : clc.whiteBright
-    };
-  }
-
-  /* eslint-disable no-console */
-  error(str) {
-    console.error(this.format.error(str));
-  }
-
-  warn(str) {
-    console.warn(this.format.warn(str));
-  }
-
-  notice(str) {
-    console.log(this.format.notice(str));
-  }
-
-  question(str) {
-    console.log(this.format.question(str));
-  }
-
-  ok(str) {
-    console.log(this.format.ok(str));
-  }
-
-  /* eslint-enable no-console */
-}
-
-module.exports = ColorOutput;

package/bin/.upgrades/connectors/es.js

@@ -1,90 +0,0 @@
-/*
- * Kuzzle, a backend software, self-hostable and ready to use
- * to power modern apps
- *
- * Copyright 2015-2020 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 { formatWithOptions } = require('util');
-
-const { Client } = require('@elastic/elasticsearch');
-const validator = require('validator');
-const _ = require('lodash');
-
-const ConnectorContext = require('../lib/connectorContext');
-
-let promise = null;
-
-async function getEsClient(context) {
-  const currentConfiguration = _.get(context.config, 'services.storageEngine.client');
-
-  if (!currentConfiguration) {
-    context.log.error('Missing Kuzzle configuration for Elasticsearch.');
-    context.log.error('Missing configuration value: services.storageEngine.client');
-    context.log.error('Aborted.');
-    process.exit(1);
-  }
-
-  context.log.notice('Current Elasticsearch configuration:');
-  context.log.print(
-    formatWithOptions({ colors: false, depth: null }, currentConfiguration));
-
-  const answers = await context.inquire.prompt([
-    {
-      choices: ['source', 'target', 'source and target'],
-      default: 'target',
-      message: 'For this migration, use this current instance as the data',
-      name: 'current',
-      type: 'list',
-    },
-    {
-      default: '',
-      message: ({ current }) => `Enter the URL for the ${current === 'source' ? 'target': 'source'} instance:`,
-      name: 'url',
-      type: 'input',
-      validate: url => {
-        const opts = {
-          protocols: ['http', 'https'],
-          require_port: true,
-          require_protocol: true,
-          require_tld: false,
-          require_valid_protocol: true,
-        };
-
-        return validator.isURL(url, opts) || 'A valid URL must be provided. Example: http://<server>:<port>';
-      },
-      when: ({ current }) => current !== 'source and target'
-    }
-  ]);
-
-  const current = new Client(currentConfiguration);
-  const next = answers.url ? new Client({ node: answers.url }) : current;
-
-  return answers.current === 'source'
-    ? new ConnectorContext(context, current, next)
-    : new ConnectorContext(context, next, current);
-}
-
-module.exports = async context => {
-  if (promise === null) {
-    promise = getEsClient(context);
-  }
-
-  return promise;
-};

package/bin/.upgrades/connectors/redis.js

@@ -1,112 +0,0 @@
-/*
- * Kuzzle, a backend software, self-hostable and ready to use
- * to power modern apps
- *
- * Copyright 2015-2020 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
-  { formatWithOptions } = require('util'),
-  IORedis = require('ioredis'),
-  ConnectorContext = require('../lib/connectorContext'),
-  _ = require('lodash');
-
-let promise = null;
-
-async function getRedisClient(context) {
-  const currentConfiguration = _.get(context.config, 'services.internalCache');
-
-  if (!currentConfiguration) {
-    context.log.error('Missing Kuzzle configuration for Redis.');
-    context.log.error('Missing configuration value: services.internalCache');
-    context.log.error('Aborted.');
-    process.exit(1);
-  }
-
-  context.log.notice('Current Redis configuration:');
-  context.log.print(
-    formatWithOptions({ colors: false, depth: null }, currentConfiguration));
-
-  const current = await context.inquire.direct({
-    choices: ['source', 'target', 'source and target'],
-    default: 'target',
-    message: 'For this migration, use this current instance as the data',
-    type: 'list',
-  });
-
-  const remaining = current === 'source' ? 'target': 'source';
-  let answers = null;
-
-  if (current !== 'source and target') {
-    answers = await context.inquire.prompt([
-      {
-        default: '',
-        message: `${remaining} server name or IP:`,
-        name: 'server',
-        type: 'input',
-        validate: name => name.length > 0 || 'Non-empty string expected'
-      },
-      {
-        default: '',
-        message: `${remaining} server port:`,
-        name: 'port',
-        type: 'input',
-        validate: name => {
-          const i = Number.parseFloat(name);
-
-          if (!Number.isNaN(i) && Number.isInteger(i) && i > 1 && i <= 65535) {
-            return true;
-          }
-
-          return 'Invalid port number';
-        }
-      }
-    ]);
-  }
-
-  const
-    options = { enableReadyCheck: true, lazyConnect: true },
-    client = currentConfiguration.nodes
-      ? new IORedis.Cluster(currentConfiguration, options)
-      : new IORedis(currentConfiguration.node, options);
-
-  await client.connect();
-
-  let next;
-
-  if (answers) {
-    next = new IORedis(answers.port, answers.server, options);
-    await next.connect();
-  }
-  else {
-    next = client;
-  }
-
-  return current === 'source'
-    ? new ConnectorContext(context, client, next)
-    : new ConnectorContext(context, next, client);
-}
-
-module.exports = async context => {
-  if (promise === null) {
-    promise = getRedisClient(context);
-  }
-
-  return promise;
-};

package/bin/.upgrades/lib/connectorContext.js

@@ -1,38 +0,0 @@
-/*
- * Kuzzle, a backend software, self-hostable and ready to use
- * to power modern apps
- *
- * Copyright 2015-2020 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 UpgradeContext = require('./context');
-
-class ConnectorContext extends UpgradeContext {
-  constructor(context, source, target) {
-    super(context);
-    this.source = source;
-    this.target = target;
-  }
-
-  get inPlace () {
-    return this.source === this.target;
-  }
-}
-
-module.exports = ConnectorContext;

package/bin/.upgrades/lib/context.js

@@ -1,142 +0,0 @@
-/*
- * Kuzzle, a backend software, self-hostable and ready to use
- * to power modern apps
- *
- * Copyright 2015-2020 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 fs = require('fs');
-const path = require('path');
-
-const rc = require('rc');
-
-const inquirer = require('./inquirerExtended');
-const Logger = require('./logger');
-
-const defaultConfiguration = require('../../../lib/config/default.config.js');
-const { version: currentVersion } = require('../../../package.json');
-
-class Version {
-  constructor() {
-    this.from = null;
-    this.list = [];
-  }
-}
-
-class UpgradeContext {
-  constructor(args) {
-    // copy constructor
-    if (args instanceof UpgradeContext) {
-      this.config = args.config;
-      this.log = args.log;
-      this.inquire = args.inquire;
-      this.version = args.version;
-      this.argv = args.argv;
-    }
-    else {
-      this.config = null;
-      this.log = new Logger(args);
-      this.inquire = inquirer;
-      this.version = null;
-      this.argv = args;
-    }
-  }
-
-  async init () {
-    await this.loadConfiguration();
-
-    if (this.config.configs) {
-      this.log.ok('Configuration files loaded:');
-      this.config.configs.forEach(f => this.log.print(`\t- ${f}`));
-    }
-
-    this.version = await this.getVersions();
-  }
-
-  async loadConfiguration () {
-    let cfg;
-
-    try {
-      cfg = rc('kuzzle', JSON.parse(JSON.stringify(defaultConfiguration)));
-      this.config = cfg;
-      return;
-    }
-    catch (e) {
-      this.log.error(`Cannot load configuration files: ${e.message}`);
-      if (this.config === null) {
-        this.log.error('Check your configuration files, and restart the upgrade script.');
-        process.exit(1);
-      }
-    }
-
-    // If we are here, this means that an error was thrown, due to a change made
-    // to configuration files *during* the upgrade (probably because a version
-    // upgrade asked the user to modify their configuration files manually)
-    // To prevent aborting unnecessarily during the upgrade process, we ask the
-    // user to fix the situation
-    const retry = await this.inquire.direct({
-      default: true,
-      message: 'Retry?',
-      type: 'confirm'
-    });
-
-    if (!retry) {
-      this.log.error('Aborted by user action.');
-      process.exit(1);
-    }
-
-    await this.loadConfiguration();
-  }
-
-  /**
-   * Asks the user the source version to upgrade from
-   * @returns {Version}
-   */
-  async getVersions () {
-    const version = new Version();
-
-    this.log.print(`Current Kuzzle version: ${currentVersion}`);
-
-    version.list = fs
-      .readdirSync(
-        path.resolve(`${__dirname}/../versions`),
-        { withFileTypes: true })
-      .filter(entry => entry.isDirectory() && entry.name.match(/^v\d+$/))
-      .map(entry => entry.name)
-      .sort((a, b) => parseInt(a[0].substring(1))-parseInt(b[0].substring(1)));
-
-    if (version.list.length === 1) {
-      version.from = version.list[0];
-    }
-    else {
-      version.from = await inquirer.direct({
-        choices: version.list,
-        default: version.list[version.list.length - 1],
-        message: 'Migrate from which version',
-        type: 'list'
-      });
-
-      version.list = version.list.slice(version.list.indexOf(version.from));
-    }
-
-    return version;
-  }
-}
-
-module.exports = UpgradeContext;

package/bin/.upgrades/lib/formatters.js

@@ -1,103 +0,0 @@
-/*
- * Kuzzle, a backend software, self-hostable and ready to use
- * to power modern apps
- *
- * Copyright 2015-2020 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 clc = require('cli-color');
-
-class RawFormatter {
-  raw (msg) {
-    return msg;
-  }
-}
-
-class ColoredFormatter extends RawFormatter {
-  error (msg) {
-    return clc.red(msg);
-  }
-
-  warn (msg) {
-    return clc.yellow(msg);
-  }
-
-  notice (msg) {
-    return clc.cyan(msg);
-  }
-
-  ok (msg) {
-    return clc.green(msg);
-  }
-
-  question (msg) {
-    return clc.whiteBright(msg);
-  }
-}
-
-class PrefixedFormatter extends RawFormatter {
-  error (msg) {
-    return `[ERROR] ${msg}`;
-  }
-
-  warn (msg) {
-    return `[WARN] ${msg}`;
-  }
-
-  notice (msg) {
-    return `[i] ${msg}`;
-  }
-
-  ok (msg) {
-    return `[OK] ${msg}`;
-  }
-
-  question (msg) {
-    return `[?] ${msg}`;
-  }
-}
-
-class FileFormatter extends PrefixedFormatter {
-  error (msg) {
-    return Buffer.from(`[${(new Date()).toISOString()}]${super.error(msg)}\n`);
-  }
-
-  warn (msg) {
-    return Buffer.from(`[${(new Date()).toISOString()}]${super.warn(msg)}\n`);
-  }
-
-  notice (msg) {
-    return Buffer.from(`[${(new Date()).toISOString()}]${super.notice(msg)}\n`);
-  }
-
-  ok (msg) {
-    return Buffer.from(`[${(new Date()).toISOString()}]${super.ok(msg)}\n`);
-  }
-
-  question (msg) {
-    return Buffer.from(`[${(new Date()).toISOString()}]${super.question(msg)}\n`);
-  }
-
-  // @override
-  raw (msg) {
-    return Buffer.from(`${msg}\n`);
-  }
-}
-
-module.exports = { ColoredFormatter, FileFormatter, PrefixedFormatter };