@jungvonmatt/contentful-migrations 4.0.1 → 5.0.1

package/README.md

@@ -29,7 +29,6 @@ This initializes migrations and stores the config values in the `package.json` o
 | accessToken            | `undefined`    | Contentful Management Token. Just run `npx contentful login` and you're done.                                                               |
 | spaceId                | `undefined`    | Contentful Space id. Will fallback to `process.env.CONTENTFUL_SPACE_ID` if not set.                                                         |
 | environmentId          | `undefined`    | Contentful Environment id. Will fallback to `process.env.CONTENTFUL_ENVIRONMENT_ID` if not set.<br/>If neither `environmentId` nor `CONTENTFUL_ENVIRONMENT_ID` is available we search for environment whose id matches the current git branch |
-| fallbackEnvironmentId  | `'master'`     | Contentful Space environment. Acts as default if there is no environment named after the current git branch or the passed env doesn't exist |
 | storage                | `undefined`    | We need to keep a hint to the executed migrations inside Contentful. You can choose between **content* and **tag**. <br/><br/>**Content** will add a new content type to your Contentful environment and stores the state of every migration as content entry (recommended approach) <br/>**tag** Will only store the latest version inside a tag. You need to preserve the right order yourself. When you add a new migration with an older version number it will not be executed. |
 | fieldId                | `'migration'`  | Id of the tag where the migration version is stored (only used with storage `tag`)  |
 | migrationContentTypeId | `'contentful-migrations'` | Id of the migration content-type (only used with storage `content`)  |
@@ -48,6 +47,9 @@ npx migrations environment <environment-id> --create
 
 # Remove an environment
 npx migrations environment <environment-id> --remove
+
+# Reset an environment
+npx migrations environment <environment-id> --reset
 ```
 
 ## Generating blank migrations

package/index.js

@@ -13,9 +13,9 @@ const { createMigration, runMigrations, fetchMigration, executeMigration } = req
 const { versionDelete, versionAdd } = require('./lib/version');
 const { transferContent } = require('./lib/content');
 const { createOfflineDocs } = require('./lib/doc');
+const { createEnvironment, removeEnvironment, resetEnvironment } = require('./lib/environment');
 const { getConfig, askAll, askMissing, STORAGE_CONTENT, STORAGE_TAG } = require('./lib/config');
 const pkg = require('./package.json');
-const { createEnvironment, removeEnvironment } = require('./lib/environment');
 
 require('dotenv').config();
 
@@ -30,6 +30,7 @@ const parseArgs = (cmd) => {
     destEnvironmentId: cmd.destEnvironmentId || parent.destEnvironmentId,
     verbose: cmd.verbose || parent.verbose,
     template: cmd.template || parent.template,
+    yes: cmd.yes || parent.yes,
     extension: cmd.extension || parent.extension,
     bail: cmd.bail || parent.bail,
   };
@@ -47,7 +48,10 @@ const errorHandler = (error, log) => {
 };
 
 const actionRunner = (fn, log = true) => {
-  return (...args) => fn(...args).catch((error) => errorHandler(error, log));
+  return (...args) => {
+    const verbose = args.some((arg) => arg.verbose);
+    return fn(...args).catch((error) => errorHandler(error, verbose || log));
+  };
 };
 
 const program = new Command();
@@ -60,7 +64,7 @@ program
     actionRunner(async (cmd) => {
       const config = await getConfig(parseArgs(cmd || {}));
       const verified = await askAll(config);
-      const { managementToken, accessToken, environmentId, ...rest } = verified;
+      const { managementToken, accessToken, environmentId, spaceId, ...rest } = verified;
 
       if (verified.storage === STORAGE_CONTENT) {
         await initializeContentModel({ ...config, ...verified });
@@ -70,6 +74,10 @@ program
         await migrateToTagStorage({ ...config, ...verified });
       }
 
+      if (!process.env.CONTENTFUL_SPACE_ID) {
+        rest.spaceId = spaceId;
+      }
+
       // try to store in package.json
       const localPkg = await pkgUp();
       if (localPkg) {
@@ -121,6 +129,7 @@ program
   .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
   .option('-p, --path <path/to/migrations>', 'Change the path where the migrations are stored')
   .option('-v, --verbose', 'Verbosity')
+  .option('-y, --yes', 'Assume "yes" as answer to all prompts and run non-interactively.')
   .option('--bail', 'Abort execution after first failed migration (default: true)', true)
   .option('--no-bail', 'Ignore failed migrations')
   .description('Execute all unexecuted migrations available.')
@@ -139,13 +148,15 @@ program
       }
 
       await runMigrations(verified);
-    }, true)
+    }, false)
   );
 
 program
   .command('execute <file>')
   .option('-s, --space-id <space-id>', 'Contentful space id')
   .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
+  .option('-v, --verbose', 'Verbosity')
+  .option('-y, --yes', 'Assume "yes" as answer to all prompts and run non-interactively.')
   .description('Execute a single migration.')
   .action(
     actionRunner(async (file, options) => {
@@ -169,6 +180,7 @@ program
   .command('version <file>')
   .option('-s, --space-id <space-id>', 'Contentful space id')
   .option('-e, --environment-id <environment-id>', 'Change the Contentful environment')
+  .option('-v, --verbose', 'Verbosity')
   .option('--add', 'Mark migration as migrated')
   .option('--remove', 'Delete migration entry in Contentful')
   .description('Manually mark a migration as migrated or not. (Only available with the Content-model storage)')
@@ -202,15 +214,17 @@ program
 program
   .command('environment <environment-id>')
   .option('-s, --space-id <space-id>', 'Contentful space id')
+  .option('-v, --verbose', 'Verbosity')
   .option('--create', 'Create new contentful environment')
   .option('--remove', 'Delete contentful environment')
   .option('--reset', 'Reset contentful environment')
+  .option('--source-environment-id <environment-id>', 'Set the source environment to clone new environment from')
   .description('Add or remove a contentful environment for migrations')
   .action(
     actionRunner(async (environmentId, options) => {
-      const { remove, create } = options;
-      const config = await getConfig(parseArgs(options || {}));
-      const verified = await askMissing(config);
+      const { remove, create, reset } = options;
+      const config = await getConfig(parseArgs({ ...(options || {}), environmentId }));
+      const verified = await askMissing(config, ['accessToken', 'spaceId', 'environmentId']);
 
       if (create) {
         return createEnvironment(environmentId, verified);
@@ -238,7 +252,7 @@ program
   .action(
     actionRunner(async (cmd) => {
       const config = await getConfig(parseArgs(cmd || {}));
-      const verified = await askMissing(config);
+      const verified = await askMissing(config, ['accessToken', 'spaceId', 'environmentId']);
       await createOfflineDocs(verified);
     }, true)
   );
@@ -249,14 +263,15 @@ program
   .requiredOption('--dest-environment-id <environment-id>', 'Set the Contentful destination environment (to)')
   .option('-s, --space-id <space-id>', 'Contentful space id')
   .option('-c, --content-type <content-type>', 'Specify content-type')
+  .option('-v, --verbose', 'Verbosity')
+  .option('-y, --yes', 'Assume "yes" as answer to all prompts and run non-interactively.')
   .option('--diff', 'Manually choose skip/overwrite for every conflict')
   .option('--force', 'No manual diffing. Overwrites all conflicting entries/assets')
-  .option('-v, --verbose', 'Verbosity')
   .description('Transfer content from source environment to destination environment')
   .action(
     actionRunner(async (cmd) => {
       const config = await getConfig(parseArgs(cmd || {}));
-      const verified = await askMissing(config);
+      const verified = await askMissing({ ...config, environmentId: 'not-used' });
 
       // run migrations on destination environment
       await transferContent({

package/lib/backend.js

@@ -360,14 +360,19 @@ const getNewMigrations = async (config) => {
   const migrations = await globby(`${directory}/*.js`);
 
   if (storage === STORAGE_CONTENT) {
-    const versions = await getMigrationVersions(config);
+    try {
+      const versions = await getMigrationVersions(config);
 
-    return migrations.filter((file) => {
-      const name = path.basename(file);
-      const [, num] = /^(\d+)-/.exec(name);
+      return migrations.filter((file) => {
+        const name = path.basename(file);
+        const [, num] = /^(\d+)-/.exec(name);
 
-      return !(versions || []).includes(parseInt(num, 10));
-    });
+        return !(versions || []).includes(parseInt(num, 10));
+      });
+    } catch (error) {
+      console.error(chalk.red('\nError:'), `Missing migration content type. Run ${chalk.cyan('npx migrations init')}`);
+      process.exit(1);
+    }
   }
 
   const version = await getMigrationVersionFromTag(config);

package/lib/config.js

@@ -2,7 +2,6 @@ const path = require('path');
 const inquirer = require('inquirer');
 const mergeOptions = require('merge-options').bind({ ignoreUndefined: true });
 const { cosmiconfig } = require('cosmiconfig');
-const branch = require('git-branch');
 
 const { getSpaces, getEnvironments } = require('./contentful');
 
@@ -20,7 +19,6 @@ const getConfig = async (args) => {
   const defaultOptions = {
     fieldId: 'migration',
     migrationContentTypeId: 'contentful-migrations',
-    fallbackEnvironmentId: 'master',
     host: 'api.contentful.com',
     directory: path.resolve(process.cwd(), 'migrations'),
   };
@@ -31,10 +29,6 @@ const getConfig = async (args) => {
     accessToken: process.env.CONTENTFUL_MANAGEMENT_TOKEN,
   };
 
-  try {
-    defaultOptions.branch = await branch();
-  } catch (error) {}
-
   let contentfulCliOptions = {};
   try {
     // get configuration from contentful rc file (created by the contentful cli command)
@@ -92,7 +86,7 @@ const getPromts = (data) => {
       name: 'spaceId',
       message: 'Space ID',
       choices: async (answers) => {
-        const spaces = await getSpaces(answers);
+        const spaces = await getSpaces({ ...(data || {}), ...answers });
         return spaces.map((space) => ({
           name: `${space.name} (${space.sys.id})`,
           value: space.sys.id,
@@ -104,14 +98,14 @@ const getPromts = (data) => {
     },
     {
       type: 'list',
-      name: 'fallbackEnvironmentId',
-      message: 'Fallback environment',
+      name: 'environmentId',
+      message: 'Environment ID',
       choices: async (answers) => {
-        const environments = await getEnvironments(answers);
+        const environments = await getEnvironments({ ...(data || {}), ...answers });
         return environments.map((environment) => environment.sys.id);
       },
       default: function () {
-        return data.fallbackEnvironmentId;
+        return data.environmentId;
       },
     },
     {
@@ -174,8 +168,13 @@ const askAll = async (data = {}) => {
   return answers;
 };
 
-const askMissing = async (data = {}) => {
-  const missingPromts = getPromts(data).filter(({ name }) => !data[name]);
+const askMissing = async (data = {}, requiredFields = undefined) => {
+  const allQuestions = getPromts(data);
+  if (!requiredFields) {
+    requiredFields = allQuestions.map(({ name }) => name);
+  }
+
+  const missingPromts = getPromts(data).filter(({ name }) => !data[name] && requiredFields.includes(name));
 
   // Check if storage changed to content and run initialization
   const missingStorage = missingPromts.some((prompt) => prompt.name === 'storage');
@@ -185,9 +184,26 @@ const askMissing = async (data = {}) => {
   return { ...data, ...answers, missingStorageModel: missingStorage && storage === STORAGE_CONTENT };
 };
 
+const confirm = async (config = {}) => {
+  if (config.yes) {
+    return true;
+  }
+  const { proceed } = await inquirer.prompt([
+    {
+      type: 'confirm',
+      name: 'check',
+      message: 'Do you wish to proceed?',
+      default: true,
+    },
+  ]);
+
+  return proceed;
+};
+
 module.exports.getConfig = getConfig;
 module.exports.askAll = askAll;
 module.exports.askMissing = askMissing;
+module.exports.confirm = confirm;
 module.exports.STORAGE_TAG = STORAGE_TAG;
 module.exports.STORAGE_CONTENT = STORAGE_CONTENT;
 module.exports.STATE_SUCCESS = STATE_SUCCESS;

package/lib/content.js

@@ -5,6 +5,7 @@ const { getContent, getContentId, getLinkedAssets, getLinkedEntries } = require(
 const { diff } = require('./diff');
 const { buildTree } = require('./tree');
 const { getLatestVersion } = require('./backend');
+const { confirm } = require('./config');
 
 const resolveConflicts = async (sourceEntries, destEntries, options) => {
   const { contentTypes, diffConflicts, forceOverwrite } = options;
@@ -150,16 +151,8 @@ const transferContent = async (config) => {
     )} from ${chalk.cyan(sourceEnvironmentId)} to ${chalk.cyan(destEnvironmentId)}`
   );
 
-  const { proceed } = await inquirer.prompt([
-    {
-      type: 'confirm',
-      message: 'Do you wish to proceed?',
-      default: true,
-      name: 'proceed',
-    },
-  ]);
-
-  if (proceed !== true) {
+  proceed = await confirm(config);
+  if (!proceed) {
     return;
   }
 

package/lib/contentful.js

@@ -156,18 +156,22 @@ const getEnvironment = async (options) => {
   if (environmentCache.has(cacheKey)) {
     return environmentCache.get(cacheKey);
   }
-  const { environmentId, branch, fallbackEnvironmentId } = options || {};
+  const { environmentId, spaceId } = options || {};
   const space = await getSpace(options);
 
   const { items: environments } = await space.getEnvironments();
 
   const environmentIds = (environments || []).map((env) => env.sys.id);
 
-  const targetEnvironmentId = environmentId || branch;
+  const targetEnvironmentId = environmentId;
   if (targetEnvironmentId && environmentIds.includes(targetEnvironmentId)) {
     environmentCache.set(cacheKey, space.getEnvironment(targetEnvironmentId));
+  } else if (targetEnvironmentId) {
+    throw new Error(`Environment "${targetEnvironmentId}" is not available in space "${spaceId}"`);
   } else {
-    environmentCache.set(cacheKey, space.getEnvironment(fallbackEnvironmentId || DEFAULT_ENVIRONMENT_ID));
+    throw new Error(
+      'Missing environment id. Use -e <environment-id> or set environment variable CONTENTFUL_ENVIRONMENT_ID'
+    );
   }
 
   return environmentCache.get(cacheKey);

package/lib/doc.js

@@ -1,11 +1,11 @@
 const path = require('path');
-const table = require('markdown-table');
 const chalk = require('chalk');
 const fs = require('fs-extra');
 const Mustache = require('mustache');
 const { getEditorInterfaces, getContentTypes, getContentTypeId, getContentId } = require('./contentful');
 
-const getFieldTable = (fields, editorInterfaces) => {
+const getFieldTable = async (fields, editorInterfaces) => {
+  const { markdownTable: table } = await import('markdown-table');
   const { controls = [] } = editorInterfaces;
   return table([
     ['Id', 'Name', 'Type', 'Required', 'Localized', 'HelpText', 'Remarks'],
@@ -27,7 +27,8 @@ const getFieldTable = (fields, editorInterfaces) => {
   ]);
 };
 
-const createDoc = (contentType, editorInterfaces) => {
+const createDoc = async (contentType, editorInterfaces) => {
+  const { markdownTable: table } = await import('markdown-table');
   const { name, displayField, description, sys, fields } = contentType || {};
   const { id } = sys || {};
 
@@ -50,7 +51,7 @@ ${description}
 
 ## Fields
 
-${getFieldTable(fields, editorInterfaces)}
+${await getFieldTable(fields, editorInterfaces)}
 `;
 };
 
@@ -98,7 +99,7 @@ const createOfflineDocs = async (config) => {
       const data = prepareData(contentType, interfaces);
       content = await customRender(data);
     } else {
-      content = createDoc(contentType, interfaces);
+      content = await createDoc(contentType, interfaces);
     }
 
     const filename = `${getContentId(contentType)}.${extension}`;

package/lib/environment.js

@@ -20,11 +20,11 @@ const getActiveApiKey = async (config) => {
  * @param {Object} config The config object including all required data
  */
 const createEnvironment = async (environmentId, config) => {
-  const { sourceEnvironment = 'master' } = config;
-  console.log(`\nCreating new environment ${chalk.green(environmentId)} from ${chalk.green(sourceEnvironment)}`);
+  const { sourceEnvironmentId = 'master' } = config;
+  console.log(`\nCreating new environment ${chalk.green(environmentId)} from ${chalk.green(sourceEnvironmentId)}`);
 
   const space = await getSpace(config);
-  const environment = await space.createEnvironmentWithId(environmentId, { name: environmentId }, sourceEnvironment);
+  const environment = await space.createEnvironmentWithId(environmentId, { name: environmentId }, sourceEnvironmentId);
 
   const apiKey = await getActiveApiKey(config);
 
@@ -52,9 +52,8 @@ const createEnvironment = async (environmentId, config) => {
  * @param {Object} config The config object including all required data
  */
 const removeEnvironment = async (environmentId, config) => {
-  const { fallbackEnvironment } = config;
-  if ([fallbackEnvironment, 'master'].includes(environmentId)) {
-    throw new Error('Removing the fallback environment or the master environment is not supported');
+  if (['master'].includes(environmentId)) {
+    throw new Error('Removing the master environment is not supported');
   }
   console.log(`\nRemoving environment ${chalk.green(environmentId)}`);
   const space = await getSpace(config);
@@ -79,7 +78,7 @@ const removeEnvironment = async (environmentId, config) => {
  */
 const resetEnvironment = async (environmentId, config) => {
   if (['master'].includes(environmentId)) {
-    throw new Error('Removing the fallback environment or the master environment is not supported');
+    throw new Error('Removing the master environment is not supported');
   }
   console.log(`\nRemoving environment ${chalk.green(environmentId)}`);
   const space = await getSpace(config);
@@ -88,8 +87,6 @@ const resetEnvironment = async (environmentId, config) => {
     await environment.delete();
   } catch {}
   await createEnvironment(environmentId, config);
-
-  console.log(chalk.green('\nDone'), '🚀');
 };
 
 module.exports.createEnvironment = createEnvironment;

package/lib/migration.js

@@ -9,7 +9,7 @@ const {
 const chalk = require('chalk');
 const { getEnvironment } = require('./contentful');
 
-const { STATE_SUCCESS, STATE_FAILURE } = require('./config');
+const { confirm, STATE_SUCCESS, STATE_FAILURE } = require('./config');
 
 const { storeMigration, getNewMigrations } = require('./backend');
 
@@ -69,7 +69,6 @@ const executeMigration = async (file, config) => {
   const { accessToken, spaceId } = config || {};
   const client = await getEnvironment(config);
   const environmentId = client.sys.id;
-
   const name = path.basename(file);
   const [, version] = /^(\d+)-/.exec(name);
 
@@ -81,7 +80,11 @@ const executeMigration = async (file, config) => {
     yes: true,
   };
 
-  console.log(`\nRun migration ${chalk.green(version)} ...`);
+  console.log(`\nRun migration ${chalk.green(version)} in environment ${chalk.green(environmentId)}`);
+  const proceed = await confirm(config);
+  if (!proceed) {
+    return;
+  }
   try {
     await runMigration(options);
     await storeMigration({ version, name, state: STATE_SUCCESS }, config);
@@ -104,17 +107,25 @@ const runMigrations = async (config) => {
 
   const client = await getEnvironment(config);
   const environmentId = client.sys.id;
-  console.log('TEST 1');
-  const migrations = await getNewMigrations(config);
-  console.log('TEST 2', migrations);
+  let migrations = [];
+  try {
+    migrations = await getNewMigrations(config);
+  } catch (error) {
+    console.log(error.message);
+    throw error;
+  }
   console.log(
     `Found ${chalk.green(migrations.length)} unexecuted migrations in environment ${chalk.green(environmentId)}`
   );
 
-  let migrationVersion = 0;
+  const proceed = migrations.length === 0 || (await confirm(config));
+  if (!proceed) {
+    return;
+  }
+
   for await (const file of migrations) {
     try {
-      migrationVersion = await executeMigration(file, config);
+      await executeMigration(file, { ...config, yes: true });
     } catch (error) {
       if (bail) {
         throw error;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jungvonmatt/contentful-migrations",
-  "version": "4.0.1",
+  "version": "5.0.1",
   "description": "Helper to handle migrations in contentful",
   "main": "index.js",
   "files": [
@@ -30,40 +30,39 @@
     "content-type"
   ],
   "dependencies": {
-    "@contentful/rich-text-plain-text-renderer": "^14.1.2",
-    "array.prototype.flatmap": "^1.2.4",
+    "@contentful/rich-text-plain-text-renderer": "^15.5.1",
+    "array.prototype.flatmap": "^1.2.5",
     "ascii-tree": "^0.3.0",
     "chalk": "^4.1.2",
     "cli-progress": "^3.9.1",
-    "commander": "^7.2.0",
+    "commander": "^8.3.0",
     "common-tags": "^1.8.0",
     "contentful-cli": "^1.8.23",
     "contentful-import": "^8.2.22",
     "contentful-management": "^7.32.0",
     "contentful-migration": "^4.3.0",
-    "cosmiconfig": "^7.0.0",
+    "cosmiconfig": "^7.0.1",
     "deep-diff": "^1.0.2",
     "diff": "^5.0.0",
     "dotenv": "^10.0.0",
     "fs-extra": "^10.0.0",
-    "git-branch": "^2.0.1",
     "globby": "^11.0.3",
-    "inquirer": "^8.1.2",
-    "markdown-table": "^2.0.0",
+    "inquirer": "^8.2.0",
+    "markdown-table": "^3.0.1",
     "merge-options": "^3.0.4",
     "mustache": "^4.2.0",
-    "node-fetch": "^2.6.1",
+    "node-fetch": "^3.0.0",
     "node-object-hash": "^2.3.10",
     "pkg-up": "^3.1.0"
   },
   "devDependencies": {
     "babel-eslint": "^10.1.0",
-    "eslint": "^7.32.0",
+    "eslint": "^8.1.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^3.4.0",
-    "husky": "^6.0.0",
-    "lint-staged": "^11.1.2",
-    "prettier": "^2.3.2"
+    "eslint-plugin-prettier": "^4.0.0",
+    "husky": "^7.0.4",
+    "lint-staged": "^11.2.6",
+    "prettier": "^2.4.1"
   },
   "publishConfig": {
     "access": "public"
@@ -107,5 +106,11 @@
     "hooks": {
       "pre-commit": "lint-staged"
     }
+  },
+  "migrations": {
+    "spaceId": "89na9aswdzfj",
+    "storage": "content",
+    "migrationContentTypeId": "contentful-migrations",
+    "directory": "migrations"
   }
 }