kuzzle 2.15.2 → 2.16.3

package/bin/.upgrades/lib/inquirerExtended.js

@@ -1,46 +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';
-
-// Returns an instance of "inquirer" extended with a "direct" function that
-// returns the answer directly, instead of a key-value map of answers.
-// Useful only because we often prompt questions one by one, with tasks in the
-// middle, and this "direct" function helps reducing the clutter.
-
-const
-  assert = require('assert').strict,
-  inquirer = require('inquirer'),
-  _ = require('lodash');
-
-inquirer.direct = async function direct (prompt) {
-  assert(_.isPlainObject(prompt), 'Invalid argument: expected a non-empty object');
-  assert(typeof prompt.name === 'undefined', 'Unexpected "name" argument: if you need to set a name, use inquirer.prompt');
-
-  const p = _.cloneDeep(prompt);
-  p.name = 'foo';
-
-  const { foo } = await inquirer.prompt(p);
-
-  return foo;
-};
-
-module.exports = inquirer;

package/bin/.upgrades/lib/logger.js

@@ -1,99 +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'),
-  {
-    ColoredFormatter,
-    PrefixedFormatter,
-    FileFormatter
-  } = require('./formatters');
-
-class ColorOutput {
-  constructor (opts) {
-    this.terminalFormatter = opts.C
-      ? new PrefixedFormatter()
-      : new ColoredFormatter();
-
-    this.fileFormatter = new FileFormatter();
-
-    this.fileReport = null;
-
-    if (!opts.R) {
-      this.notice(`Upgrade report file: ${opts.output}`);
-      this.fileReport = fs.openSync(opts.output, 'w', 0o600);
-    }
-  }
-
-  /* eslint-disable no-console */
-  error (str) {
-    console.error(this.terminalFormatter.error(str));
-
-    if (this.fileReport) {
-      fs.writeSync(this.fileReport, this.fileFormatter.error(str));
-    }
-  }
-
-  warn (str) {
-    console.warn(this.terminalFormatter.warn(str));
-
-    if (this.fileReport) {
-      fs.writeSync(this.fileReport, this.fileFormatter.warn(str));
-    }
-  }
-
-  notice (str) {
-    console.log(this.terminalFormatter.notice(str));
-
-    if (this.fileReport) {
-      fs.writeSync(this.fileReport, this.fileFormatter.notice(str));
-    }
-  }
-
-  question (str) {
-    console.log(this.terminalFormatter.question(str));
-
-    if (this.fileReport) {
-      fs.writeSync(this.fileReport, this.fileFormatter.question(str));
-    }
-  }
-
-  ok (str) {
-    console.log(this.terminalFormatter.ok(str));
-
-    if (this.fileReport) {
-      fs.writeSync(this.fileReport, this.fileFormatter.ok(str));
-    }
-  }
-
-  print (str) {
-    console.log(this.terminalFormatter.raw(str));
-
-    if (this.fileReport) {
-      fs.writeSync(this.fileReport, this.fileFormatter.raw(str));
-    }
-  }
-  /* eslint-enable no-console */
-}
-
-module.exports = ColorOutput;

package/bin/.upgrades/lib/progressBar.js

@@ -1,70 +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 moment = require('moment');
-
-// Simple progress bar making the wait for long tasks more bearable
-class ProgressBar {
-  constructor (context, text, total, barSize = 20) {
-    this.text = text;
-    this.total = total;
-    this.barSize = barSize;
-    this.bar = new context.inquire.ui.BottomBar();
-    this.update(0);
-    this.start = Date.now();
-  }
-
-  destroy () {
-    this.bar.updateBottomBar('');
-    this.bar.close();
-  }
-
-  update (count) {
-    const
-      remaining = this._getRemainingTime(count),
-      str = `${this.text}
-${this._getBar(count)}(remaining: ${remaining}) ${count} / ${this.total}`;
-
-    this.bar.updateBottomBar(str);
-  }
-
-  _getRemainingTime (count) {
-    const
-      elapsed = Date.now() - this.start,
-      remaining = count > 0
-        ? Math.round(this.total * elapsed / count) - elapsed
-        : 0;
-
-    return moment(remaining).format('mm:ss');
-  }
-
-  _getBar (count) {
-    const
-      percent = count * 100 / this.total,
-      progress = Math.round(percent * this.barSize / 100);
-
-    return '[' + '#'.repeat(progress) + '-'.repeat(this.barSize - progress) + ']';
-  }
-}
-
-module.exports = ProgressBar;

package/bin/.upgrades/versions/v1/checkConfiguration.js

@@ -1,85 +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 _ = require('lodash');
-
-module.exports = async function check (context) {
-  let action = false;
-  const warn = msg => context.log.warn(`[CONFIG. FILES] ${msg}`);
-  const renamed = {
-    'services.db': 'services.storageEngine',
-    'services.internalEngine': 'services.internalIndex',
-    'services.storageEngine.commonMapping._kuzzle_info': 'services.storageEngine.commonMapping.properties._kuzzle_info',
-    'services.storageEngine.dynamic': 'services.storageEngine.commonMapping.dynamic'
-  };
-  const deprecated = [
-    'server.entryPoints',
-    'server.protocols.socketio',
-    'server.proxy',
-    'services.garbageCollector',
-    'services.storageEngine.client.apiVersion',
-    'services.storageEngine.commonMapping.properties._kuzzle_info.deletedAt',
-    'services.storageEngine.commonMapping.properties._kuzzle_info.active'
-  ];
-
-
-  for (const [oldName, newName] of Object.entries(renamed)) {
-    if (_.get(context.config, oldName)) {
-      action = true;
-      warn(`The configuration key "${oldName}" is now named "${newName}"`);
-    }
-  }
-
-  for (const name of deprecated) {
-    if (_.get(context.config, name)) {
-      action = true;
-      warn(`The configuration key "${name}" is obsolete and should be removed`);
-    }
-  }
-
-  if (action) {
-    const
-      choices = [
-        'Check again',
-        'Abort',
-        'Ignore (not recommended)'
-      ],
-      proceed = await context.inquire.direct({
-        choices,
-        default: choices[0],
-        message: 'Configuration files need to be updated:',
-        type: 'list'
-      });
-
-    if (proceed === choices[0]) {
-      await context.loadConfiguration();
-      return check(context);
-    }
-
-    if (proceed === choices[1]) {
-      process.exit(1);
-    }
-  }
-
-  context.log.ok('Configuration files checked: OK');
-};

package/bin/.upgrades/versions/v1/index.js

@@ -1,35 +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 checkConfiguration = require('./checkConfiguration');
-const upgradeStorage = require('./upgradeStorage');
-const upgradeCache = require('./upgradeCache');
-
-module.exports = async function upgrade (context) {
-  context.log.notice('\n\n=== CONFIGURATION FILES ===');
-  await checkConfiguration(context);
-  context.log.notice('\n\n=== STORAGE ===');
-  await upgradeStorage(context);
-  context.log.notice('\n\n=== CACHE ===');
-  await upgradeCache(context);
-};

package/bin/.upgrades/versions/v1/upgradeCache.js

@@ -1,149 +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 getRedisConnector = require('../../connectors/redis');
-
-async function copyKey (context, key) {
-  const
-    dump = await context.source.dumpBuffer(key),
-    ttl = Math.max(0, await context.source.pttl(key));
-
-  // Breaking change from v1 to v2, due to how indexes are handled:
-  // token keys are prefixed "repos/%kuzzle/token" in v1, and
-  // "repos/kuzzle/token" in v2
-  const newKey = key.replace('repos/%kuzzle/token', 'repos/kuzzle/token');
-
-  await context.target.restore(newKey, ttl, dump, 'REPLACE');
-}
-
-async function getSourceKeys (context, pattern) {
-  if (!context.source.nodes) {
-    return await context.source.keys(pattern);
-  }
-
-  const keys = [];
-
-  for (const node of context.source.nodes('master')) {
-    keys.push(...await node.source.keys(pattern));
-  }
-
-  return keys;
-}
-
-async function copyDatabase (context, db) {
-  await context.source.select(db);
-  await context.target.select(db);
-
-  await context.target.flushdb();
-
-  const keys = await getSourceKeys(context, '*');
-
-  for (const key of keys) {
-    await copyKey(context, key);
-  }
-
-  context.log.ok(`Imported cache keys from database ${db}`);
-}
-
-async function inPlaceMigration (context) {
-  context.log.notice(`
-In-place migration detected: this script will make the changes necessary to
-make the cache data compatible with Kuzzle v2.`);
-
-  const
-    choices = {
-      abort: 'Abort',
-      copy: 'Copy to new keys (obsolete keys will be delete once expired)',
-      move: 'Move keys (cannot be undone, cache won\'t work with Kuzzle v1 anymore)'
-    },
-    action = await context.inquire.direct({
-      choices: Object.values(choices),
-      default: choices.copy,
-      message: 'Select how the database should be migrated:',
-      type: 'list'
-    });
-
-  if (action === choices.abort) {
-    context.log.error('Aborted by user.');
-    process.exit(0);
-  }
-
-  const db = context.config.services.internalCache.database || 0;
-
-  await context.source.select(db);
-
-  const keys = await getSourceKeys(context, 'repos/*');
-
-  for (const key of keys) {
-    await copyKey(context, key);
-
-    if (action === choices.move) {
-      await context.source.del(key);
-    }
-  }
-}
-
-async function upgradeToTarget (context) {
-  context.log.notice(`
-This script will WIPE TARGET DATABASES from the target cache instance.
-Then, it will COPY all data from the source cache instance, without altering it
-in any way.`);
-
-  const confirm = await context.inquire.direct({
-    default: true,
-    message: 'Continue?',
-    type: 'confirm'
-  });
-
-  if (!confirm) {
-    context.log.error('Aborted by user.');
-    process.exit(0);
-  }
-
-  for (const cachedb of ['internalCache', 'memoryStorage']) {
-    const config = context.config.services[cachedb];
-
-    await copyDatabase(context, config.database || 0);
-  }
-}
-
-module.exports = async function upgradeCache (context) {
-  const cacheContext = await getRedisConnector(context);
-
-  try {
-    if (cacheContext.inPlace) {
-      await inPlaceMigration(cacheContext);
-    }
-    else {
-      await upgradeToTarget(cacheContext);
-    }
-
-    cacheContext.log.ok('Cache import complete.');
-  }
-  catch (e) {
-    cacheContext.log.error(`Cache import failure: ${e.message}`);
-    cacheContext.log.print(e.stack);
-    cacheContext.log.error('Aborted.');
-    process.exit(1);
-  }
-};