@oliasoft-open-source/node-json-migrator 2.3.10 → 3.0.0-beta-1

package/dist/history/history.js

@@ -1,90 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.printVersionHistory = void 0;
-var _chalk = _interopRequireDefault(require("chalk"));
-var _git = require("../git/git");
-var _database = require("../database/database");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-/**
- * Parse plan.json
- *
- * @param {string} plan
- * @returns object|null parsed plan
- */
-const parsePlan = plan => {
-  return (() => {
-    try {
-      return JSON.parse(plan);
-    } catch (e) {
-      console.error('Unable to parse plan.json');
-      return null;
-    }
-  })();
-};
-
-/**
- * @typedef {Object} Configuration
- * @property {string} directory (path to migrations directory)
- * @property {string} entity (entity name for payload, e.g. dataset)
- * @property {Object} database (connected pg-promise database)
- */
-
-/**
- * Prints the version history of plan.json (for debugging)
- *
- * @param {Object} args
- * @param {Configuration} args.config
- */
-const printVersionHistory = async ({
-  config
-}) => {
-  const {
-    database,
-    entity,
-    directory
-  } = config;
-  try {
-    const planFilePath = `${directory}/plan.json`;
-
-    //read version history from database cache
-    const versionHistoryFromDatabase = await (0, _database.getVersions)(database, entity);
-    const fullDatabaseVersionHistory = versionHistoryFromDatabase.map(d => {
-      const plan = parsePlan(d?.plan);
-      const finalMigration = plan?.length ? plan[plan.length - 1] : null;
-      return {
-        planVersion: d?.version,
-        lastFileName: finalMigration?.fileName || null,
-        lastSequence: finalMigration?.sequence || null
-      };
-    });
-
-    //read full version history from git logs (back to beginning of time)
-    const {
-      historicalPlans: fullHistoricalPlans
-    } = await (0, _git.getHistoricalPlansFromGit)(planFilePath);
-    const fullGitVersionHistory = fullHistoricalPlans.map(p => {
-      const plan = parsePlan(p?.plan);
-      const finalMigration = plan?.length ? plan[plan.length - 1] : null;
-      return {
-        gitCommitHash: p?.revision?.version,
-        planVersion: p?.version,
-        timeStamp: p?.revision?.timeStamp,
-        lastFileName: finalMigration?.fileName || null,
-        lastSequence: finalMigration?.sequence || null
-      };
-    });
-    const output = {
-      fullDatabaseVersionHistory,
-      fullGitVersionHistory
-    };
-    console.log(JSON.stringify(output, null, 2));
-  } catch (error) {
-    console.error(_chalk.default.red(error));
-    console.error(_chalk.default.red(_git.historyError));
-    throw new Error('Unable to print debug history');
-  }
-};
-exports.printVersionHistory = printVersionHistory;

package/dist/index.js

@@ -1,54 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "createMigration", {
-  enumerable: true,
-  get: function () {
-    return _create.createMigration;
-  }
-});
-Object.defineProperty(exports, "getPlannedMigrations", {
-  enumerable: true,
-  get: function () {
-    return _plan.getPlannedMigrations;
-  }
-});
-Object.defineProperty(exports, "getPlannedVersion", {
-  enumerable: true,
-  get: function () {
-    return _plannedVersion.getPlannedVersion;
-  }
-});
-Object.defineProperty(exports, "getVersions", {
-  enumerable: true,
-  get: function () {
-    return _database.getVersions;
-  }
-});
-Object.defineProperty(exports, "migrate", {
-  enumerable: true,
-  get: function () {
-    return _migrate.migrate;
-  }
-});
-Object.defineProperty(exports, "pipe", {
-  enumerable: true,
-  get: function () {
-    return _pipe.pipe;
-  }
-});
-Object.defineProperty(exports, "printVersionHistory", {
-  enumerable: true,
-  get: function () {
-    return _history.printVersionHistory;
-  }
-});
-var _create = require("./create/create");
-var _plan = require("./plan/plan");
-var _plannedVersion = require("./plan/planned-version");
-var _migrate = require("./migrate/migrate");
-var _pipe = require("./pipe/pipe");
-var _database = require("./database/database");
-var _history = require("./history/history");

package/dist/migrate/migrate.js

@@ -1,59 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.migrate = void 0;
-var _pipe = require("../pipe/pipe");
-var _pending = require("../pending/pending");
-/**
- * @typedef {Array|Object} Payload
- */
-
-/**
- * @typedef {Object} PlannedMigrations
- * @property {Array<function>} plannedMigrations (planned migrations)
- * @property {string} nextVersion (next payload version)
- */
-
-/**
- * @typedef {Object} Configuration
- * @property {string} directory (path to migrations directory)
- * @property {string} entity (entity name for payload, e.g. dataset)
- * @property {string} [version] (current payload version)
- * @property {boolean} [force] (override validation)
- * @property {boolean} [dry] (don't alter database or files)
- * @property {Object} [database] (connected pg-promise database)
- * @property {Object} [pgpHelpers] (pg-promise helpers)
- * @property {PlannedMigrations} [plan]
- */
-
-/**
- * Migrates a payload
- *
- * There are two ways to use this function:
- * i) function looks up the pending migrations for you (default)
- * ii) pass in pre-fetched pending migrators via config.pending
- *
- * @param {Object} args
- * @param {Payload} args.payload
- * @param {Configuration} args.config
- * @returns Promise<{nextPayload: Payload, nextVersion: string}>
- */
-
-const migrate = async ({
-  payload,
-  config
-}) => {
-  const {
-    pendingMigrators,
-    nextVersion
-  } = await (0, _pending.getPendingMigrators)({
-    config
-  });
-  return {
-    nextPayload: pendingMigrators.length ? (0, _pipe.pipe)(pendingMigrators, payload) : payload,
-    nextVersion
-  };
-};
-exports.migrate = migrate;

package/dist/pending/pending.js

@@ -1,73 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getPendingMigrators = exports.getPendingMigrations = void 0;
-var _chalk = _interopRequireDefault(require("chalk"));
-var _plan = require("../plan/plan");
-var _executed = require("../executed/executed");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-const shortHash = hash => hash ? hash.substring(0, 8) : '';
-const getPendingMigrations = ({
-  plannedMigrations,
-  executedMigrations,
-  printPendingFileNames = false,
-  force
-}) => {
-  const pendingMigrations = plannedMigrations.filter(m => {
-    const executed = executedMigrations.find(e => e?.fileName === m.fileName);
-    const skippedFileHashes = m?.skippedFileHashes;
-    const isSkippedAndPreviouslyExecuted = skippedFileHashes?.includes(executed?.fileHash);
-    /*
-      - always execute migrations that have never been executed
-      - re-execute migrations only when all are true:
-        - fileHash has changed
-        - force flag is active
-        - the migration was not previously executed and skipped (see .skip feature for patching migration bugs)
-     */
-    return executed === undefined || executed?.fileHash !== m?.fileHash && force && !isSkippedAndPreviouslyExecuted;
-  });
-  if (printPendingFileNames) {
-    pendingMigrations.forEach(m => {
-      console.log(_chalk.default.gray(`  ${m.fileName} ${shortHash(m?.fileHash)}`));
-    });
-  }
-  return pendingMigrations.map(m => ({
-    fileName: m.fileName,
-    migrator: m.migrator
-  }));
-};
-exports.getPendingMigrations = getPendingMigrations;
-const getPendingMigrators = async ({
-  config
-}) => {
-  const {
-    directory,
-    database,
-    pgpHelpers,
-    entity,
-    version,
-    plan,
-    printPendingFileNames,
-    force
-  } = config;
-  const {
-    plannedMigrations,
-    nextVersion
-  } = plan || (await (0, _plan.getPlannedMigrations)({
-    config
-  }));
-  const executedMigrations = database ? await (0, _executed.getExecutedMigrationsFromVersion)(database, pgpHelpers, entity, directory, version, nextVersion, plannedMigrations) : [];
-  const pendingMigrators = getPendingMigrations({
-    plannedMigrations,
-    executedMigrations,
-    printPendingFileNames,
-    force
-  });
-  return {
-    pendingMigrators,
-    nextVersion: plannedMigrations.length < executedMigrations.length ? version : nextVersion
-  };
-};
-exports.getPendingMigrators = getPendingMigrators;

package/dist/pipe/pipe.js

@@ -1,38 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.pipe = void 0;
-const errorMessage = (fileName, message, stack) => `Unhandled exception in file ${fileName}: ${message}
-
-  ${stack}
-`;
-
-/**
- * Executes the pending migrators on a payload, returns modified payload
- *
- * Loosely based on:
- *  - Eric Elliott's pipe implementation https://medium.com/javascript-scene/reduce-composing-software-fe22f0c39a1d
- *  - lodash flow https://lodash.com/docs/4.17.15#flow
- *
- * Implementation includes exception handling to extend errors with the filename
- * until module-with-string fixes its stack trace handling (see OW-8879 and
- * https://github.com/exuanbo/module-from-string/issues/18)
- *
- * @param {Array<Object>} migrations
- * @param {Object} payload
- * @returns {Object} migratedPayload
- */
-
-const pipe = (migrations, payload) => migrations.reduce((v, m) => {
-  if (typeof m?.migrator !== 'function') {
-    throw new TypeError('Expected a function');
-  }
-  try {
-    return m.migrator(v);
-  } catch (error) {
-    throw new Error(errorMessage(m?.fileName, error.message, error.stack));
-  }
-}, payload);
-exports.pipe = pipe;

package/dist/plan/cached-planned-version.js

@@ -1,25 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.setCachedPlannedVersion = exports.setCachedMigratorFunctions = exports.getCachedPlannedVersion = exports.getCachedMigratorFunctions = exports.cacheHasAllMigrationFunctions = void 0;
-let cachedPlannedVersion = null;
-let cachedMigratorFunctions = [];
-const getCachedPlannedVersion = () => cachedPlannedVersion;
-exports.getCachedPlannedVersion = getCachedPlannedVersion;
-const setCachedPlannedVersion = version => {
-  cachedPlannedVersion = version;
-};
-exports.setCachedPlannedVersion = setCachedPlannedVersion;
-const getCachedMigratorFunctions = () => cachedMigratorFunctions;
-exports.getCachedMigratorFunctions = getCachedMigratorFunctions;
-const setCachedMigratorFunctions = scripts => {
-  cachedMigratorFunctions = scripts;
-};
-exports.setCachedMigratorFunctions = setCachedMigratorFunctions;
-const cacheHasAllMigrationFunctions = ({
-  sortedMigrationEntries,
-  cachedMigrationEntries
-}) => sortedMigrationEntries.every(migration => cachedMigrationEntries.some(cached => cached.fileHash === migration.fileHash && typeof cached.migrator === 'function'));
-exports.cacheHasAllMigrationFunctions = cacheHasAllMigrationFunctions;

package/dist/plan/plan.js

@@ -1,274 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.writePlan = exports.sortPlanEntries = exports.readPlan = exports.parsePlan = exports.loadMigrationFunctionsFromStrings = exports.loadMigrationFunctions = exports.getPlannedMigrations = exports.getNextSequenceString = exports.generatePlanEntries = exports.formatJSON = void 0;
-var _path = _interopRequireDefault(require("path"));
-var _lodash = require("lodash");
-var _fs = require("fs");
-var _moduleFromString = require("module-from-string");
-var _hash = require("../hash/hash");
-var _glob = require("../glob/glob");
-var _validator = require("./validator");
-var _database = require("../database/database");
-var _cachedPlannedVersion = require("./cached-planned-version");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-/**
- * Format JSON with 2-space indentation
- *
- * @param {String} json
- * @returns {String} formatted json
- */
-const formatJSON = json => {
-  try {
-    return JSON.stringify(JSON.parse(json), null, 2);
-  } catch (e) {
-    console.warn('Unable to parse JSON');
-    throw new Error(e);
-  }
-};
-
-//https://stackoverflow.com/a/31102605/942635
-exports.formatJSON = formatJSON;
-const sortEntry = entry => Object.keys(entry).sort().reduce((obj, key) => {
-  obj[key] = entry[key];
-  return obj;
-}, {});
-
-/**
- * Sorts the plan entries by sequence string
- *
- * @param {Array<Object>} plannedMigrations
- * returns Array<Object>
- */
-
-const maxSequence = 1000000;
-const sortPlanEntries = plannedMigrations => plannedMigrations
-//dotted sequence sort https://stackoverflow.com/a/40201629/942635
-.sort((a, b) => a.sequence.replace(/\d+/g, n => +n + maxSequence).localeCompare(b.sequence.replace(/\d+/g, n => +n + maxSequence))).map(p => sortEntry(p));
-
-/**
- * Get next automatic sequence string
- *
- * @param {String} sortedPlannedMigrations
- * returns String next sequence
- */
-exports.sortPlanEntries = sortPlanEntries;
-const getNextSequenceString = sortedPlannedMigrations => {
-  const lastMigration = sortedPlannedMigrations[sortedPlannedMigrations.length - 1];
-  if (!lastMigration) {
-    return '1';
-  }
-  const currentLastSequenceNumber = lastMigration.sequence;
-  return `${parseInt(`${currentLastSequenceNumber}`, 10) + 1}`;
-};
-
-/**
- * Read the plan.json file
- *
- * @param {String} directory path to migrations directory
- * returns Promise<String> plan.json string
- */
-exports.getNextSequenceString = getNextSequenceString;
-const readPlan = async directory => {
-  let plan;
-  try {
-    plan = await _fs.promises.readFile(`${directory}/plan.json`, {
-      encoding: 'utf8'
-    });
-    return formatJSON(plan);
-  } catch {
-    throw new Error('Invalid JSON for migrator plan.js (unable to parse file)');
-  }
-};
-
-/**
- * Parse the plan.json string into a sorted object
- *
- * @param {String} plan plan.json string
- * returns Array<Object> migration entries from plan.json
- */
-exports.readPlan = readPlan;
-const parsePlan = plan => {
-  let plannedMigrations;
-  try {
-    plannedMigrations = JSON.parse(plan);
-  } catch {
-    throw new Error('Invalid JSON for migrator plan.js (unable to parse file)');
-  }
-  if (!(0, _validator.validatePlan)(plannedMigrations)) {
-    throw new Error('Invalid JSON for migrator plan.js (does not match schema)');
-  }
-  return sortPlanEntries(plannedMigrations);
-};
-
-/**
- * Write the plan.json file
- *
- * @param {String} directory path to migrations directory
- * @param {String} content string to be written to file
- * returns Promise<>
- */
-exports.parsePlan = parsePlan;
-const writePlan = async (directory, content) => {
-  //todo this is not being written in the correct order
-  await _fs.promises.writeFile(_path.default.resolve(`${directory}/plan.json`), content, {
-    encoding: 'utf8'
-  });
-};
-
-/**
- * Generate plan entries
- *
- * @param {Array<Object>} sortedMigrationEntries
- * returns Array<Object>
- */
-exports.writePlan = writePlan;
-const generatePlanEntries = sortedMigrationEntries => sortedMigrationEntries.map(m => ({
-  fileHash: m.fileHash,
-  fileName: m.fileName,
-  sequence: m.sequence
-}));
-exports.generatePlanEntries = generatePlanEntries;
-const loadMigrationFunctionsFromStrings = async (sortedMigrationEntries, importModule) => Promise.all(sortedMigrationEntries.map(async m => {
-  const {
-    script
-  } = m;
-  const migrator = script && importModule ? (await (0, _moduleFromString.importFromString)(script))?.default : null;
-  return {
-    fileHash: m.fileHash,
-    migrator
-  };
-}));
-exports.loadMigrationFunctionsFromStrings = loadMigrationFunctionsFromStrings;
-const loadMigrationFunctions = async (sortedMigrationEntries, nextVersion, importModule = true) => {
-  const cachedPlannedVersion = (0, _cachedPlannedVersion.getCachedPlannedVersion)();
-  const cachedMigratorFunctions = (0, _cachedPlannedVersion.getCachedMigratorFunctions)();
-  const cacheValid = cachedPlannedVersion === nextVersion && (0, _cachedPlannedVersion.cacheHasAllMigrationFunctions)({
-    sortedMigrationEntries,
-    cachedMigrationEntries: cachedMigratorFunctions
-  });
-  /*
-    OW-15584 the module-from-string package seems to have a memory leak bug
-    where calling importFromString multiple times consumes memory that
-    doesn't get released or garbage collected. We cache the imported strings
-    as a workaround (until plan.json version changes)
-   */
-  const migrationFunctions = cacheValid ? cachedMigratorFunctions : await loadMigrationFunctionsFromStrings(sortedMigrationEntries, importModule);
-  if (!cacheValid) {
-    (0, _cachedPlannedVersion.setCachedMigratorFunctions)(migrationFunctions);
-    (0, _cachedPlannedVersion.setCachedPlannedVersion)(nextVersion);
-  }
-  return (0, _lodash.merge)(sortedMigrationEntries, migrationFunctions);
-};
-exports.loadMigrationFunctions = loadMigrationFunctions;
-const getPlannedMigrations = async ({
-  config
-}) => {
-  const {
-    directory,
-    database,
-    entity,
-    force,
-    pgpHelpers,
-    dry,
-    importModule = true
-  } = config;
-  if (database && !dry) {
-    /*
-      OW-9043 and OW-9238: The tool tries to self-create its own meta tables
-      to simplify setup. That's useful for devs running on local machines,
-      and when running via CLI jobs. But for environments without CREATE
-      privileges, we want this don't want to execute CREATE TABLE IF NOT EXISTS
-      because it throws errors.
-    */
-    const tablesExist = await (0, _database.migrationTablesExist)(database, entity);
-    if (!tablesExist) {
-      await (0, _database.createMigrationsTables)(database, entity);
-    }
-  }
-  const rawPlan = await readPlan(directory);
-  const parsedPlan = parsePlan(rawPlan);
-  const plannedMigrations = parsedPlan.map(m => ({
-    fileHashFromPlan: m.fileHash,
-    fileName: m.fileName,
-    sequence: m.sequence
-  }));
-  const filePaths = await (0, _glob.getMigrationFilePaths)(directory);
-  const skippedFilePaths = await (0, _glob.getSkippedFilePaths)(directory);
-  const plannedMigrationsWithFileEntries = await Promise.all(plannedMigrations.map(async m => {
-    const {
-      fileName
-    } = m;
-    const isValidFileName = (0, _validator.validateFileName)(fileName);
-    const filePath = filePaths.find(f => _path.default.parse(f).base === m.fileName);
-    const script = filePath ? await _fs.promises.readFile(filePath, {
-      encoding: 'utf8'
-    }) : null;
-    const fileHash = script ? (0, _hash.hash)(script) : null;
-
-    //skipped files
-    const skipMatch = '(.skip|.skip\\d+).js$';
-    const nameMatch = _path.default.parse(m.fileName).name;
-    const regex = new RegExp(`${nameMatch}${skipMatch}`, 'g');
-    const matchingSkippedFilePaths = skippedFilePaths.filter(f => {
-      const name = _path.default.parse(f).base;
-      return name.match(regex);
-    });
-    const skippedFileHashes = await Promise.all(matchingSkippedFilePaths.map(async skippedFilePath => {
-      const skippedScript = await _fs.promises.readFile(skippedFilePath, {
-        encoding: 'utf8'
-      });
-      return skippedScript ? (0, _hash.hash)(skippedScript) : null;
-    }));
-    return {
-      ...m,
-      filePath,
-      isValidFileName,
-      script,
-      fileHash,
-      skippedFileHashes
-    };
-  }));
-  const historicalMigrations = database ? await (0, _database.getMigrationRecords)(database, entity) : [];
-  const plannedMigrationsWithHistory = plannedMigrationsWithFileEntries.map(m => {
-    const historicalMigration = historicalMigrations.find(h => h.fileName === m.fileName);
-    return {
-      ...m,
-      fileHashFromHistory: historicalMigration?.fileHash || null,
-      sequenceFromHistory: historicalMigration?.sequence || null
-    };
-  });
-  (0, _validator.throwIfFilesNotFound)(plannedMigrationsWithHistory, importModule);
-  (0, _validator.throwIfFileNamesInvalid)(plannedMigrationsWithHistory);
-  (0, _validator.throwIfFileNamesNotUnique)(plannedMigrationsWithHistory);
-  (0, _validator.throwIfSequenceNotUnique)(plannedMigrationsWithHistory);
-  if (!force) {
-    (0, _validator.warnIfFilesHaveBeenRemovedFromPlan)(plannedMigrationsWithHistory, historicalMigrations);
-    (0, _validator.throwIfFilesHaveChanged)(plannedMigrationsWithHistory);
-    (0, _validator.throwIfSequenceHasChanged)(plannedMigrationsWithHistory);
-  }
-  (0, _validator.throwIfSequenceHasIntegerGaps)(plannedMigrationsWithHistory);
-  const validatedPlannedMigrations = generatePlanEntries(plannedMigrationsWithHistory);
-  const validatedPlan = JSON.stringify(validatedPlannedMigrations, null, 2);
-  const nextVersion = (0, _hash.hash)(validatedPlan);
-  const planHasChanged = validatedPlan !== rawPlan;
-  if (!dry && planHasChanged) {
-    await writePlan(directory, validatedPlan);
-  }
-  if (database && !dry) {
-    await (0, _database.replaceMigrationsRecords)(database, pgpHelpers, entity, validatedPlannedMigrations);
-    const versionRecord = [{
-      version: nextVersion,
-      plan: validatedPlan
-    }];
-    await (0, _database.insertVersions)(database, pgpHelpers, entity, versionRecord);
-  }
-  const plannedMigrationsWithFunctions = await loadMigrationFunctions(plannedMigrationsWithHistory, nextVersion, importModule);
-  return {
-    plannedMigrations: plannedMigrationsWithFunctions,
-    nextVersion
-  };
-};
-exports.getPlannedMigrations = getPlannedMigrations;

package/dist/plan/plan.schema.json

@@ -1,20 +0,0 @@
-{
-  "type": "array",
-  "items": {
-    "type": "object",
-    "properties": {
-      "fileHash": {
-        "type": ["string"]
-      },
-      "fileName": {
-        "type": "string"
-      },
-      "sequence": {
-        "type": "string",
-        "pattern": "^[1-9][0-9]*(.[1-9][0-9]*)*$"
-      }
-    },
-    "required": ["fileHash", "fileName", "sequence"],
-    "additionalProperties": false
-  }
-}

package/dist/plan/planned-version.js

@@ -1,26 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getPlannedVersion = void 0;
-var _hash = require("../hash/hash");
-var _plan = require("./plan");
-var _cachedPlannedVersion = require("./cached-planned-version");
-const getPlannedVersion = async ({
-  config
-}) => {
-  const {
-    directory
-  } = config;
-  const currentPlan = await (0, _plan.readPlan)(directory);
-  const plannedVersion = (0, _hash.hash)(currentPlan);
-  const cachedPlannedVersion = (0, _cachedPlannedVersion.getCachedPlannedVersion)();
-  return cachedPlannedVersion === plannedVersion ? cachedPlannedVersion : (await (0, _plan.getPlannedMigrations)({
-    config: {
-      ...config,
-      importModule: false
-    }
-  })).nextVersion;
-};
-exports.getPlannedVersion = getPlannedVersion;