@tangelo/tangelo-configuration-toolkit 1.7.0 → 1.8.0-beta.3

package/README.md

@@ -4,7 +4,7 @@ Tangelo Configuration Toolkit is a command-line toolkit which offers support for
 
 ## Installation
 
-The toolkit requires [NPM](https://www.npmjs.com/get-npm) on [Node.js®](https://nodejs.org/) version 12.x or 14.x. An active or maintenance LTS release is recommended. After installing Node.js, you can install the latest version of the Tangelo Configuration Toolkit globally on your system using the following command:
+The toolkit requires [NPM](https://www.npmjs.com/get-npm) on [Node.js®](https://nodejs.org/) (at least version 14.x). An active or maintenance LTS release is recommended. After installing Node.js, you can install the latest version of the Tangelo Configuration Toolkit globally on your system using the following command:
 
     npm i -g @tangelo/tangelo-configuration-toolkit
 

package/index.js

@@ -5,9 +5,10 @@ String.prototype.toFws = function(){
 };
 
 
-const findUp  = require('find-up');
-const fs      = require('fs-extra');
-const path    = require('path');
+const findUp    = require('find-up');
+const fs        = require('fs-extra');
+const {getPath} = require('global-modules-path');
+const path      = require('path');
 
 const execGitCommand = require('./src/lib/exec-git-command');
 
@@ -56,8 +57,12 @@ _paths.repoconfig = path.join(_paths.repo, appname+'-repoconfig.json');
 _paths.apply = process.cwd().replace(_paths.repo, '').substr(1);
 
 
-global._package = require('./package.json');
-global._appdata = fs.readJsonSync(_paths.appdata, {throws: false}) || {versionLastChecked: 0, versionIsLatest: true};
+global._appdata  = fs.readJsonSync(_paths.appdata, {throws: false}) || {};
+global._packages = {
+  TCT: {name: '@tangelo/tangelo-configuration-toolkit', version: require('./package.json')?.version},
+  FDT: {name: '@fontoxml/fontoxml-development-tools'}
+}
+_packages.FDT.version = require(`${getPath(_packages.FDT.name)}/package.json`)?.version;
 
 try { global._appconfig = _paths.appconfig && fs.readJsonSync(_paths.appconfig) || {}; }
 catch({message}) { _error('Error in '+message); }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tangelo/tangelo-configuration-toolkit",
-  "version": "1.7.0",
+  "version": "1.8.0-beta.3",
   "description": "Tangelo Configuration Toolkit is a command-line toolkit which offers support for developing a Tangelo configuration.",
   "bin": {
     "tct": "bin/index.js",
@@ -20,31 +20,33 @@
     "babel-core": "^6.26.3",
     "babel-preset-es2015-without-strict": "0.0.4",
     "cli-spinner": "^0.2.10",
-    "del": "^5.1.0",
+    "compare-versions": "^4.1.1",
+    "del": "^6.0.0",
     "event-stream": "^4.0.1",
     "find-up": "^5.0.0",
-    "fs-extra": "^9.0.1",
+    "fs-extra": "^10.0.0",
+    "global-modules-path": "^2.3.1",
     "globby": "^6.1.0",
     "gulp": "^4.0.2",
     "gulp-babel": "^7.0.1",
     "gulp-eol": "^0.2.0",
-    "gulp-filter": "^6.0.0",
+    "gulp-filter": "^7.0.0",
     "gulp-plumber": "^1.2.1",
     "gulp-print": "^5.0.2",
-    "gulp-sass": "^4.1.0",
+    "gulp-sass": "^5.0.0",
     "gulp-simple-rename": "^0.1.3",
-    "gulp-sourcemaps": "^2.6.5",
-    "inquirer": "^7.3.3",
-    "istextorbinary": "^5.11.0",
+    "gulp-sourcemaps": "^3.0.0",
+    "inquirer": "^8.2.0",
+    "istextorbinary": "^6.0.0",
     "minimatch": "^3.0.4",
-    "node-ssh": "^10.0.0",
+    "node-ssh": "^12.0.2",
     "object-assign-deep": "^0.4.0",
-    "replace-in-file": "^3.4.4",
+    "replace-in-file": "^6.0.0",
+    "sass": "^1.43.4",
     "saxon-js": "^2.3.0",
     "scp2": "^0.5.0",
-    "selfupdate": "^1.1.0",
     "tiny-lr": "^2.0.0",
-    "yargs": "^16.0.3"
+    "yargs": "^16.2.0"
   },
   "repository": {
     "type": "git",

package/src/cli.js

@@ -1,9 +1,23 @@
-const fs          = require('fs-extra');
-const selfupdate  = require('selfupdate');
-const yargs       = require('yargs');
+const {compare} = require('compare-versions');
+const exec  = require('util').promisify(require('child_process').exec);
+const fs    = require('fs-extra');
+const yargs = require('yargs');
 
 
-const updateJsonFile = (path, json = {}, obj = {}) => fs.writeJsonSync(path, Object.assign(json, obj), {spaces: 2});
+const updateAppdata = (data) => Object.assign(_appdata, data, {_changed: true});
+
+const checkForPackageUpdate = (package) => (
+  exec(`npm view -g ${_packages[package].name} version`)
+  .then(r => {
+    const versionAvailable = r.stdout.match(/([\d/.]+)/)[1];
+    if (compare(_packages[package].version, versionAvailable, '<')) {
+      updateAppdata({[`updateCheck${package}`]: {executed: new Date(), versionAvailable}});
+      return versionAvailable;
+    }
+    else updateAppdata({[`updateCheck${package}`]: {executed: new Date()}});
+  })
+  .catch(e => _warn(`Failed checking latest version of ${package}.`))
+);
 
 
 module.exports = function cli () {
@@ -11,7 +25,7 @@ module.exports = function cli () {
   _write();
 
   const txtTitle    = 'Tangelo Configuration Toolkit'.bold.underline.cyan;
-  const txtVersion  = `v${_package.version}${_appdata.versionIsLatest ? '' : ' (new version available)'}`.lblack;
+  const txtVersion  = `v${_packages.TCT.version}`.lblack;
 
   const {argv} = yargs
   .scriptName('tct')
@@ -99,7 +113,6 @@ module.exports = function cli () {
   })
   .recommendCommands()
   .option('config', {alias: 'c', desc: 'Show loaded appconfig', global: false})
-  .option('update', {alias: 'u', desc: 'Update this package', global: false})
   .version(false)
   .help(false)
   .example([
@@ -126,28 +139,36 @@ module.exports = function cli () {
       _write(_appconfig);
     }
 
-    if (argv.update) {
-      _info('Updating...');
-      selfupdate.update(_package, (error, version) => {
-        if (!error) updateJsonFile(_paths.appdata, _appdata, {versionLastChecked: new Date(), versionIsLatest: true});
-        _write((error||{}).message || 'Updated to version ' + version);
-      });
-    }
-
   }
 
 
+  let checkUpdatesDone = false;
+
   process.on('beforeExit', () => {
-    _write(); // always end with empty line
-
-    if (!argv.hasOwnProperty('update') && _appdata.versionIsLatest && new Date() - new Date(_appdata.versionLastChecked || 0) > 1000*3600*24*3) { // check every 3 days
-      _info('Checking for updates...');
-      selfupdate.isUpdated(_package, (error, isUpdated) => {
-        if (!error) updateJsonFile(_paths.appdata, _appdata, {versionLastChecked: new Date(), versionIsLatest: isUpdated});
-        _write((error || isUpdated ? 'Using latest version.' : 'New version available!') + '\n');
-        process.exit(); // otherwise this event keeps being triggered
+    _write(); // print empty line before and after update check
+
+    if (!checkUpdatesDone) { // check if updatecheck has ran before because async calls below trigger beforeExit again
+      checkUpdatesDone = true;
+
+      ['TCT', 'FDT'].forEach(p => {
+        const updateMsg = (va) => `| Update ${p} to ${va} | ` + `npm i -g ${_packages[p].name}`.white;
+        const {versionAvailable} = _appdata[`updateCheck${p}`] || {};
+
+        if (new Date() - new Date(_appdata[`updateCheck${p}`]?.executed || 0) > 1000*3600*24*7) { // check every week
+          checkForPackageUpdate(p).then(r => r && _warn(updateMsg(r)));
+        }
+        else if (versionAvailable) {
+          if (compare(_packages[p].version, versionAvailable, '<')) _warn(updateMsg(versionAvailable));
+          else updateAppdata({[`updateCheck${p}`]: {executed: new Date()}});
+        }
       });
     }
+
+    if (_appdata._changed) {
+      delete _appdata._changed;
+      fs.writeJsonSync(_paths.appdata, _appdata, {spaces: 2});
+    }
+
   });
 
 }

package/src/lib/gulp-batch-replace-with-filter.js

@@ -1,19 +1,19 @@
-// based on gulp-batch-replace
-
-const es = require('event-stream'), minimatch = require("minimatch"), istextorbinary = require('istextorbinary');
-
-const execReplace = (c, s, r) => Buffer.from(s instanceof RegExp ? String(c).replace(s,r) : String(c).split(s).join(r));
-
-module.exports = (arr) => {
-  return es.map((file, callback) => {
-    if(file.contents instanceof Buffer) {
-      arr.forEach(e => {
-        // exec if no glob is passed or if glob matches, and it's a text file
-        if ((!e[2] || minimatch(file.path,e[2])) && istextorbinary.isText(file.path,file)) {
-          file.contents = execReplace(file.contents, e[0], e[1]);
-        }
-      });
-    }
-    callback(null,file);
-  });
-};
+// based on gulp-batch-replace
+
+const es = require('event-stream'), minimatch = require("minimatch"), istextorbinary = require('istextorbinary');
+
+const execReplace = (c, s, r) => Buffer.from(s instanceof RegExp ? String(c).replace(s,r) : String(c).split(s).join(r));
+
+module.exports = (arr) => {
+  return es.map((file, callback) => {
+    if(file.contents instanceof Buffer) {
+      arr.forEach(e => {
+        // exec if no glob is passed or if glob matches, and it's a text file
+        if ((!e[2] || minimatch(file.path,e[2])) && istextorbinary.isText(file.path,file)) {
+          file.contents = execReplace(file.contents, e[0], e[1]);
+        }
+      });
+    }
+    callback(null,file);
+  });
+};

package/src/modules/build/oxygen.js

@@ -78,7 +78,7 @@ const getTransformations = (config) => {
           });
         });
       } else {
-        _write(`No transformation scenarios found in ${cf} for '${config.extracts.base}'`);
+        _write(`No transformation scenarios found in ${f} for '${config.extracts.base}'`);
       }
     });
   });

package/src/modules/deploy/execute.js

@@ -1,8 +1,8 @@
 const fs            = require('fs-extra');
 const globby        = require('globby');
 const gulp          = require('gulp');
+const {NodeSSH}     = require('node-ssh');
 const path          = require('path');
-const ssh           = require('node-ssh');
 const through2      = require('through2');
 const {spawnSync}   = require('child_process');
 
@@ -15,7 +15,7 @@ const g_print       = require('gulp-print');
 const g_rename      = require('gulp-simple-rename');
 const g_replace     = require('../../lib/gulp-batch-replace-with-filter');
 const g_resolveIncl = require('../../lib/gulp-resolve-includes');
-const g_sass        = require('gulp-sass');
+const g_sass        = require('gulp-sass')(require('sass'));
 const g_scp         = require('../../lib/gulp-scp2-async');
 const g_sourcemaps  = require('gulp-sourcemaps');
 
@@ -63,7 +63,7 @@ const remote = {
   process() {
     if (!this.queue[0]) return;
 
-    const sshI = new ssh();
+    const sshI = new NodeSSH();
     sshI.connect(c.server.ftpConfig) // set up connection once
     .then(() => {
       this.do(sshI);
@@ -112,7 +112,9 @@ const createDeliveryPack = () => { // create install scripts if necessary, zip o
     _info('PowerShell script for database install created');
   }
 
-  spawnSync('powershell.exe', [`Compress-Archive -Path * -DestinationPath ../${c.deliveryPackName}`], {cwd: c.server.remotedir});
+  const result = spawnSync('powershell.exe', [`Compress-Archive -Path * -DestinationPath ../${c.deliveryPackName}`], {cwd: c.server.remotedir});
+  if (result.stderr!='') {_warn(`\nLong paths may cause zip-creation to fail; Try to set a short remotedir, for example 'C:/deliveryPacks'.`);_error(`${result.stderr}\n`);}
+
   fs.removeSync(c.server.remotedir);
   _info(`Zipped package as: ${c.deliveryPackName}`);
 };

package/src/modules/fonto/commands.js

@@ -3,7 +3,7 @@ const fs      = require('fs-extra');
 const gulp    = require('gulp');
 const g_print = require('gulp-print');
 const path    = require('path');
-const sass    = require('gulp-sass');
+const sass    = require('gulp-sass')(require('sass'));
 const wws     = require('../../lib/worker-with-spinner');
 
 

package/src/modules/git/index.js

@@ -95,6 +95,16 @@ module.exports = function git (argv) {
         // Create symlinks for TDI
         ['tct b -s', 'Create TDI symlinks'],
       ]);
-    })
+    }).catch((e) => {
+      // Show warnings for missing, expected, system environment variables
+      if (!process.env.GIT_SSH) {
+        _warn(`System environment variable 'GIT_SSH' is missing. (link to putty plink.exe)`);
+      }
+      if (!process.env.GIT_SSH_COMMAND) {
+        _warn(`System environment variable 'GIT_SSH_COMMAND' is missing. (link to putty plink.exe)`);
+      }
+      // continue display stack trace
+      throw e;
+    });
   }
 };

package/src/modules/migrate/steps.js

@@ -5,7 +5,8 @@ const path      = require('path');
 const rif       = require('replace-in-file');
 
 
-const getPaths = (search, filter) =>
+const rifSync   = (options)         => rif.sync(options).filter(result => result.hasChanged).map(result => result.file);
+const getPaths  = (search, filter)  =>
   globby
   .sync(search, {dot: true, ignore: [_paths.tdi + '/**','**/cmscustom/tdi/**']})
   .filter(p => !filter || minimatch(p, filter)
@@ -25,7 +26,7 @@ module.exports = function steps (step, dry, filter) {
       _write('Paths deleted:', paths.length);
     });
   }
-  
+
   if (renamePaths) {
     renamePaths.forEach(([curpath, change]) => {
       _info(`Renaming paths: ${curpath}`);
@@ -34,7 +35,7 @@ module.exports = function steps (step, dry, filter) {
       _write('Paths renamed:', paths.length);
     });
   }
-  
+
   if (replaceInFiles) {
     replaceInFiles.forEach(r => {
       _info(`Executing replacements in files: ${r.files}`);
@@ -47,9 +48,9 @@ module.exports = function steps (step, dry, filter) {
         r.to    = r.fromtoPairs.map(p => p[1]);
       }
 
-      r.files = rif.sync(r);                                                  // execute first time
-      const filesModCount = r.files.length;                                   // save file count
-      for (let i=0; i<20 && !dry && r.files[0]; i++) r.files = rif.sync(r);   // execute repeatedly for modified files only (with safety limit of 20)
+      r.files = rifSync(r);                                                 // execute first time
+      const filesModCount = r.files.length;                                 // save file count
+      for (let i=0; i<20 && !dry && r.files[0]; i++) r.files = rifSync(r);  // execute repeatedly for modified files only (with safety limit of 20)
 
       _write('Files modified:', filesModCount);
     });

package/src/modules/sql/index.js

@@ -14,6 +14,26 @@ const runSqlScript = (path, db, un, pw) => {
   _write('Done.\n');
 };
 
+const checkLog = (logFilePath, remove=true) => {
+  if (fs.existsSync(logFilePath)) {
+    const logFile = fs.readFileSync(logFilePath).toString();
+    // Check for ORA- error messages
+    if (logFile.match(RegExp(`ORA-`, 'gm'))) {
+      // Select each ORA- error message and up to 6 lines before (the lines before may not contain ORA- themselves)
+      const errors = logFile.match(RegExp(`((?![^\n]*ORA-)[^\n]*\n){0,6}ORA-[^\n\r]*`,`gms`));
+      _info(`${errors.length} error(s) during SQL script:\n`)
+      // Print each error + lines before:
+      errors.forEach((e, i) => {
+        _info(`Tail of error ${i+1}:\n`)
+        _warn(`${e.trim()}\n`);
+      })
+    }
+    if (remove) {
+      // remove log file
+      fs.removeSync(logFilePath);
+    }
+  }
+}
 
 module.exports = function sql (argv) {
 
@@ -25,8 +45,10 @@ module.exports = function sql (argv) {
     // tdi
     const dir = `${_paths.tdi}/${_isPre51 ? 'sources' : 'src'}/database/tdi/${_isPre42 ? 'install/' : ''}`;
     runSqlScript(dir + 'install.sql');
+    checkLog(dir + 'tdi-install.log',false);
     // custom
     runSqlScript('database/install.sql');
+    checkLog('database/install.log',false);
   }
 
   if (argv.configure) {
@@ -52,17 +74,20 @@ module.exports = function sql (argv) {
 
         const script = [`define l_env = ${a.pw=='tancms' ? 'dev' : 'prd'}`, 'set verify off define off'];
 
+        script.push(`spool install-config.log`);
         a.projects.forEach(p => {
           const dir = p.path_dbconfig ? p.path_dbconfig.join('/') : (_repoconfig.customer.dirname+'/'+p.dirname);
           script.push('prompt ', `prompt Loading configuration for: ${p.name}`);
           script.push(...globby.sync(`${dir}/*_install.sql`, {cwd}).map(s => `@${s}`));
         });
 
+        script.push(`spool off`);
         script.push('prompt ', 'pause Press ENTER to exit', 'exit');
 
         fs.writeFileSync(file, script.join('\n'));
         runSqlScript(file, a.db, 'tancms', a.pw);
         fs.removeSync(file);
+        checkLog(cwd + 'install-config.log');
       });
 
     }
@@ -75,11 +100,13 @@ module.exports = function sql (argv) {
     fs.ensureSymlinkSync(_paths.apply, dir + 'dist', 'junction');
     runSqlScript(dir + 'start.sql');
     fs.removeSync(dir + 'dist');
+    checkLog(dir + 'generate-config.log');
   }
 
   if (argv.remove) {
     const dir = _paths.tdi + (_isPre51 ? '/util/db-config-remover/' : '/tct/sql/remove/');
     runSqlScript(dir + 'start.sql');
+    checkLog(dir + 'remove-config.log');
   }
 
 };