@contentstack/cli-migration 1.5.5 → 1.6.0

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @contentstack/cli-migration
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-migration/1.5.5 darwin-arm64 node-v21.6.2
+@contentstack/cli-migration/1.6.0 darwin-arm64 node-v22.2.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@contentstack/cli-migration",
-  "version": "1.5.5",
+  "version": "1.6.0",
   "author": "@contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "~1.2.18",
-    "@contentstack/cli-utilities": "~1.6.1",
+    "@contentstack/cli-command": "~1.2.19",
+    "@contentstack/cli-utilities": "~1.7.0",
     "async": "^3.2.4",
     "callsites": "^3.1.0",
     "cardinal": "^2.1.1",
@@ -66,4 +66,4 @@
       "cm:migration": "O-MGRTN"
     }
   }
-}
+}

package/src/commands/cm/stacks/migration.js

@@ -19,12 +19,13 @@ const {
   flags,
   isAuthenticated,
   pathValidator,
+  sanitizePath,
 } = require('@contentstack/cli-utilities');
 
 const { ApiError, SchemaValidator, MigrationError, FieldValidator } = require('../../../validators');
 
 // Utils
-const { map: _map, constants, safePromise, errorHelper } = require('../../../utils');
+const { map: _map, constants, safePromise, errorHelper, installModules } = require('../../../utils');
 // Properties
 const { get, set, getMapInstance, resetMapInstance } = _map;
 const {
@@ -66,7 +67,7 @@ class MigrationCommand extends Command {
       this.exit();
     }
 
-    if (!filePath) {
+    if (!filePath || !fs.existsSync(filePath)) {
       this.log('Please provide the migration script file path, use --file-path flag');
       this.exit();
     }
@@ -128,6 +129,11 @@ class MigrationCommand extends Command {
     set(MANAGEMENT_SDK, mapInstance, stackSDKInstance);
     set(MANAGEMENT_CLIENT, mapInstance, APIClient);
 
+    if (!(await installModules(filePath, multi))) {
+      this.log(`Error: Failed to install dependencies for the specified scripts.`);
+      process.exit(1);
+    }
+
     if (multi) {
       await this.execMultiFiles(filePath, mapInstance);
     } else {
@@ -180,7 +186,7 @@ class MigrationCommand extends Command {
         const file = element;
         if (extname(file) === '.js') {
           // eslint-disable-next-line no-await-in-loop
-          await this.execSingleFile(pathValidator(resolve(filePath, file)), mapInstance);
+          await this.execSingleFile(pathValidator(resolve(sanitizePath(filePath), sanitizePath(file))), mapInstance);
         }
       }
     } catch (error) {

package/src/utils/callsite.js

@@ -2,10 +2,10 @@
 
 const getCallsites = require('callsites');
 const { parse, resolve } = require('path');
-const { pathValidator } = require('@contentstack/cli-utilities');
+const { pathValidator, sanitizePath } = require('@contentstack/cli-utilities');
 
 function getFileDirectory(path) {
-  const parentPath = pathValidator(resolve(path, '../')); // Assuming that will be 2 folders up
+  const parentPath = pathValidator(resolve(sanitizePath(path), '../')); // Assuming that will be 2 folders up
   return parse(parentPath).dir;
 }
 

package/src/utils/index.js

@@ -17,4 +17,5 @@ module.exports = {
   getBatches: require('./get-batches'),
   autoRetry: require('./auto-retry'),
   contentstackSdk: require('./contentstack-sdk'),
+  installModules: require('./modules'),
 };

package/src/utils/logger.js

@@ -4,7 +4,7 @@ const { createLogger, format, transports } = require('winston');
 const { resolve, join } = require('path');
 const { slice } = Array.prototype;
 const { stringify } = JSON;
-const { pathValidator } = require('@contentstack/cli-utilities');
+const { pathValidator, sanitizePath } = require('@contentstack/cli-utilities');
 
 const { combine, label, printf, colorize } = format;
 
@@ -33,7 +33,7 @@ function init(logFileName) {
   // Create dir if does not exist
   makeDir(logsDir);
 
-  const logPath = pathValidator(join(logsDir, logFileName + '.log'));
+  const logPath = pathValidator(join(sanitizePath(logsDir), sanitizePath(logFileName) + '.log'));
   const logger = createLogger({
     format: combine(colorize(), label({ label: 'Migration' }), customFormat),
     transports: [new transports.File({ filename: logPath })],

package/src/utils/migration-logger.js

@@ -1,14 +1,15 @@
 const winston = require('winston');
 const path = require('path');
+const { sanitizePath } = require('@contentstack/cli-utilities');
 module.exports = class MigrationLogger {
   constructor(filePath) {
-    this.filePath = path.join(filePath, 'migration-logs');
+    this.filePath = path.join(sanitizePath(filePath), 'migration-logs');
     this.logger = winston.createLogger({
       levels: { error: 1 },
       transports: [
         new winston.transports.File({
           level: 'error',
-          filename: path.join(this.filePath, 'error.logs'),
+          filename: path.join(sanitizePath(this.filePath), 'error.logs'),
           format: winston.format.combine(winston.format.timestamp(), winston.format.json()),
         }),
       ],

package/src/utils/modules.js

@@ -0,0 +1,134 @@
+const fs = require('fs');
+const { execSync } = require('child_process');
+const path = require('path');
+const { sanitizePath } = require('@contentstack/cli-utilities');
+const os = require('os');
+const { builtinModules } = require('module');
+
+const internalModules = new Set(builtinModules);
+
+function checkWritePermissionToDirectory(directory) {
+  try {
+    fs.accessSync(directory, fs.constants.W_OK);
+    return true;
+  } catch (err) {
+    console.log(`Permission Denied! You do not have the necessary write access for this directory.`);
+    return false;
+  }
+}
+
+function doesPackageJsonExist(directory) {
+  return fs.existsSync(path.join(sanitizePath(directory), 'package.json'));
+}
+
+function scanDirectory(directory) {
+  return fs.readdirSync(directory);
+}
+
+function scanFileForDependencies(directory, files) {
+  const dependencies = new Set();
+
+  files.forEach((file) => {
+    const filePath = path.join(sanitizePath(directory), sanitizePath(file));
+    if (path.extname(filePath) === '.js') {
+      const fileContent = fs.readFileSync(filePath, 'utf-8');
+      findModulesSync(fileContent).forEach((dep) => dependencies.add(dep));
+    }
+  });
+
+  return [...dependencies];
+}
+
+function createPackageJson(directory) {
+  const templateString = `{
+    "name": "MigrationPackage",
+    "version": "1.0.0",
+    "main": "",
+    "scripts": {},
+    "keywords": [],
+    "author": "",
+    "license": "ISC",
+    "description": ""
+  }`;
+
+  fs.writeFileSync(path.join(sanitizePath(directory), 'package.json'), templateString);
+}
+
+function installDependencies(dependencies, directory) {
+  const installedDependencies = new Set();
+
+  dependencies.forEach((dep) => {
+    if (!internalModules.has(dep)) {
+      const pkg = dep.startsWith('@') ? dep : dep.split('/')[0];
+      if (!installedDependencies.has(pkg)) {
+        executeShellCommand(`npm i ${pkg}`, directory);
+        installedDependencies.add(pkg);
+      }
+    }
+  });
+}
+
+function executeShellCommand(command, directory = '') {
+  try {
+    execSync(command, { stdio: 'inherit', cwd: directory });
+    console.log(`The '${command}' command has been executed successfully.`);
+  } catch (error) {
+    console.error(`Command execution failed. Error: ${error.message}`);
+  }
+}
+
+async function installModules(filePath, multiple) {
+  const files = multiple ? [] : [path.basename(filePath)];
+  const dirPath = multiple ? filePath : path.dirname(filePath);
+
+  if (checkWritePermissionToDirectory(dirPath)) {
+    if (multiple) {
+      files.push(...scanDirectory(dirPath));
+    }
+
+    if (files.length === 0) {
+      console.log(`Error: Could not locate files needed to create package.json. Exiting the process.`);
+      return true;
+    }
+
+    const dependencies = scanFileForDependencies(dirPath, files);
+
+    if (!doesPackageJsonExist(dirPath)) {
+      console.log(`package.json not found. Creating a new package.json...`);
+      createPackageJson(dirPath);
+    }
+
+    installDependencies(dependencies, dirPath);
+  } else {
+    console.log(`You don't have write permission to the directory`);
+    return false;
+  }
+
+  console.log(`All dependencies installed successfully.`);
+  return true;
+}
+
+function findModulesSync(data) {
+  try {
+    const requireRegex = /require\(['"`](.*?)['"`]\)/g;
+    const importRegex = /import\s+(?:(?:[\w*\s{},]*)\s+from\s+)?['"`](.*?)['"`]/g;
+
+    const modules = new Set();
+    let match;
+
+    while ((match = requireRegex.exec(data)) !== null) {
+      modules.add(match[1]);
+    }
+
+    while ((match = importRegex.exec(data)) !== null) {
+      modules.add(match[1]);
+    }
+
+    return [...modules];
+  } catch (error) {
+    console.error(`Error reading file: ${error.message}`);
+    return [];
+  }
+}
+
+module.exports = installModules;