@oliasoft-open-source/node-json-migrator 2.3.0 → 2.3.1-beta-1

package/dist/git/git.js

@@ -3,14 +3,68 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getPlanRevisionsFromGit = exports.getPlanFromGit = exports.getHistoricalPlansFromGit = exports.exec = void 0;
+exports.terminals = exports.isWindows = exports.gitAvailable = exports.getTerminal = exports.getPlanRevisionsFromGit = exports.getPlanFromGit = exports.getHistoricalPlansFromGit = exports.exec = exports.commandAvailable = exports.cmdAvailable = exports.bashAvailable = void 0;
 var _chalk = _interopRequireDefault(require("chalk"));
+var _process = _interopRequireDefault(require("process"));
 var _child_process = require("child_process");
 var _hash = require("../hash/hash");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-const exec = command => new Promise((resolve, reject) => {
-  const args = ['-c', command];
-  const thread = (0, _child_process.spawn)('bash', args, {
+const {
+  platform
+} = _process.default;
+const isWindows = platform === 'win32';
+exports.isWindows = isWindows;
+const terminals = Object.freeze({
+  bash: 'bash',
+  cmd: 'cmd'
+});
+exports.terminals = terminals;
+const historyError = `Unable to fetch git history. Possible reasons:
+    - Have you merged latest master branch into your environment (pull latest migrations)?
+    - Are you trying to downgrade data (not allowed), e.g. newer data into an older environment?
+        - Not allowed to export from TEST and import to PROD
+        - Not allowed to export datasets generated from migration feature branches into TEST, PROD or master ENVs
+    - On Windows? Do you have git and a terminal (bash or cmd) in your PATH? Try cmder.app, gitforwindows.org, or WSL
+`;
+const commandAvailable = command => {
+  try {
+    const exists = isWindows ? 'where' : 'which';
+    (0, _child_process.execSync)(`${exists} ${command}`);
+    return true;
+  } catch (error) {
+    return false;
+  }
+};
+exports.commandAvailable = commandAvailable;
+const gitAvailable = () => commandAvailable('git');
+exports.gitAvailable = gitAvailable;
+const cmdAvailable = () => isWindows && commandAvailable('cmd');
+exports.cmdAvailable = cmdAvailable;
+const bashAvailable = () => {
+  if (commandAvailable('bash')) {
+    try {
+      const response = (0, _child_process.execSync)('bash --version').toString();
+      return response.includes('version');
+    } catch (error) {
+      return false;
+    }
+  }
+  return false;
+};
+exports.bashAvailable = bashAvailable;
+const getTerminal = () => {
+  const bashActive = bashAvailable();
+  const cmdActive = cmdAvailable();
+  if (!(bashActive || cmdActive)) {
+    throw new Error('bash terminal (or cmd.exe on Windows) must be installed and in PATH');
+  }
+  return isWindows && !bashActive ? terminals.cmd : terminals.bash;
+};
+exports.getTerminal = getTerminal;
+const exec = (command, terminal) => new Promise((resolve, reject) => {
+  const useWinCmd = terminal === terminals.cmd;
+  const args = useWinCmd ? ['/c', command] : ['-c', command];
+  const thread = (0, _child_process.spawn)(terminal, args, {
     stdio: ['inherit', 'pipe', 'pipe']
   });
   const stdOut = [];
@@ -24,15 +78,15 @@ const exec = command => new Promise((resolve, reject) => {
   thread.on('close', () => {
     if (stdErr.length) {
       reject(stdErr.join(''));
-      return;
     }
     resolve(stdOut.join(''));
   });
 });
 exports.exec = exec;
-const getPlanRevisionsFromGit = async planFilePath => {
-  const stdOut = await exec(`git rev-list --pretty='format:%H|%ad' HEAD ${planFilePath}`);
-  const lines = stdOut.split(/\r\n|\r|\n/).filter(r => r?.includes('|'));
+const getPlanRevisionsFromGit = async (planFilePath, terminal) => {
+  const command = terminal === terminals.bash ? `git rev-list --pretty="format:%H|%ad" HEAD ${planFilePath}` : `git rev-list --pretty="%H|%ad" HEAD ${planFilePath}`;
+  const stdOut = await exec(command, terminal);
+  const lines = stdOut.split(/\r\n|\r|\n/).filter(r => r?.includes('|')).map(r => r?.replace(/"/g, '')); //trim extra double quotes in Windows output
   return lines.map(line => {
     const [version, timeStamp] = line.split('|');
     const utcTimeStamp = new Date(timeStamp).toISOString();
@@ -43,15 +97,20 @@ const getPlanRevisionsFromGit = async planFilePath => {
   });
 };
 exports.getPlanRevisionsFromGit = getPlanRevisionsFromGit;
-const getPlanFromGit = async (planFilePath, revision) => {
-  return exec(`git show ${revision}:${planFilePath}`);
+const getPlanFromGit = async (planFilePath, revision, terminal) => {
+  return exec(`git show ${revision}:${planFilePath}`, terminal);
 };
 exports.getPlanFromGit = getPlanFromGit;
 const getHistoricalPlansFromGit = async planFilePath => {
   try {
-    const revisions = await getPlanRevisionsFromGit(planFilePath);
+    const gitActive = gitAvailable();
+    if (!gitActive) {
+      throw new Error('git must be installed and in PATH');
+    }
+    const terminal = getTerminal();
+    const revisions = await getPlanRevisionsFromGit(planFilePath, terminal);
     const historicalPlans = await Promise.all(revisions.map(async revision => {
-      const plan = await getPlanFromGit(planFilePath, revision.version);
+      const plan = await getPlanFromGit(planFilePath, revision.version, terminal);
       const version = (0, _hash.hash)(plan);
       return {
         revision,
@@ -64,6 +123,7 @@ const getHistoricalPlansFromGit = async planFilePath => {
     };
   } catch (error) {
     console.error(_chalk.default.red(error));
+    console.error(historyError);
     throw new Error('Unable to fetch plan.json history from git');
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oliasoft-open-source/node-json-migrator",
-  "version": "2.3.0",
+  "version": "2.3.1-beta-1",
   "description": "A library for JSON migrations",
   "scripts": {
     "build": "npx babel src --ignore 'src/**/*.test.js' --out-dir dist --copy-files --no-copy-ignored",

package/release-notes.md

@@ -1,5 +1,9 @@
 # Node JSON Migrator Release Notes
 
+## 2.3.1
+
+- fix support for git history search on Windows ([OW-8747](https://oliasoft.atlassian.net/browse/OW-8747))
+
 ## 2.3.0
 
 - switch from npm to yarn (to match other repos)