cob-cli 2.29.0 → 2.31.0

package/bin/cob-cli.js

@@ -36,6 +36,7 @@ program
     .option('-f --force', 'skips comparisons')
     .option('-c --cache', 'cache all customizations')
     .option('-l --local', 'use local files')
+    .option('-u --update', 'update all previsously added customizations')
     .description('Interactive prompt to customize an aspect of the server')
     .action( customize );
 

package/lib/commands/customize.js

@@ -4,72 +4,112 @@ const path = require("path");
 const { checkVersion } = require("./upgradeRepo");
 const { checkWorkingCopyCleanliness } = require("../task_lists/common_helpers");
 const axios = require("axios");
-const git = require("simple-git/promise");
+const git = require("simple-git");
 const ncp = require("ncp");
 const { Transform } = require("stream");
 const fg = require("fast-glob");
 const fs = require("fs-extra");
 
+const customizationsVersionsFile = "customizations.json";
+
 /* ************************************************************************ */
 async function customize(filter, args) {
   try {
     console.log("Customize...");
-    checkVersion();
-    if (!args.force) await checkWorkingCopyCleanliness();
+    if (!args.cache) checkVersion();
+    if (!args.force && !args.cache) await checkWorkingCopyCleanliness();
 
-    let customizationRepo = await getCustomizationRepo(filter,args);
-    if (!args.local) await getCustomizationFiles(customizationRepo);
-    await applyCustomization(customizationRepo);
+    if (args.cache) {
+      await cacheAllCustomizations(filter, args);
+  
+    } else if (args.update) {
+      await updatePreviouslyAppliedCostumizations(filter, args);
+
+    } else {
+      const customizationRepo = await getCustomizationRepo(filter, args);
+      await applyCustomization(customizationRepo, args);
+  
+      console.log( colors.green("\nDone"), "\nCheck changes to your git working tree and try:" );
+      console.log( "\tcob-cli test\n" );
+    }
 
-    console.log( colors.green("\nDone"), "\nCheck changes to your git working tree and try:" );
-    console.log( "\tcob-cli test\n" );
   } catch (err) {
     console.error("\n", err.message);
   }
 }
 module.exports = customize;
 
+/* ************************************************************************ */
+async function updatePreviouslyAppliedCostumizations(filter, args) {
+  if (filter || args.cache) {
+    throw new Error("\nError: ".red + " incompatible options. Use of --update with filter or --cache.\n");
+  }
+  console.log("Updating all installed customizations...");
+
+  let customizationsVersions = {};
+  if(fs.existsSync(customizationsVersionsFile)) {
+    const customizationsVersionsRawData = fs.readFileSync(customizationsVersionsFile);
+    customizationsVersions = JSON.parse(customizationsVersionsRawData);
+  }
+
+  const customizationRepos = await getCustomizationRepo(null, args);  
+  for (let customizationRepo of customizationRepos) {
+    if(customizationsVersions[customizationRepo.name]) {
+      await applyCustomization(customizationRepo, args);
+    }
+  }
+}
+
+/* ************************************************************************ */
+async function cacheAllCustomizations(filter, args) {
+  if (filter || args.local || args.update) {
+    throw new Error("\nError: ".red + " incompatible options. Use --cache as single argument\n");
+  }
+  
+  console.log("Caching all customizations...");
+  const customizationRepos = await getCustomizationRepo(null, args);  
+  for (let customizationRepo of customizationRepos) {
+    await downloadCustomizationFiles(customizationRepo);
+  }
+
+  const { xdgData } = await import("xdg-basedir");
+  const cacheCustomizationsFile = path.resolve(xdgData, "cob-cli", "customizations.json")
+  fs.writeFileSync(cacheCustomizationsFile,
+    JSON.stringify(customizationRepos, null, 2),
+    (err) =>  {
+      if(err) throw new Error("\nError: ".red + " problem writing " + cacheCustomizationsFile + ":", err.message);
+    }
+  );
+}
+
 /* ************************************************************************ */
 async function getCustomizationRepo(filter, args) {
   const { xdgData } = await import("xdg-basedir");
-  const cacheCustomizations = path.resolve(xdgData,"cob-cli","customizations.json")
+  const cacheCustomizationsFile = path.resolve(xdgData,"cob-cli","customizations.json")
   
   let customizationRepos;
   let customizationNameQuery = "customize. " + (filter ? filter : "");
   if (args.local) {
-    customizationRepos = JSON.parse(fs.readFileSync(cacheCustomizations))
+    customizationRepos = JSON.parse(fs.readFileSync(cacheCustomizationsFile))
     if (filter) {
       customizationRepos = customizationRepos.filter(customizationRepo => customizationRepo.name.indexOf(filter) != -1)
     }
   } else {    
     // Get list of relevant customizations from github
-    let response = await axios.get(
-      "https://api.github.com/search/repositories?q=" +
-        customizationNameQuery + "+in:name+org:cob",
-      { headers: { Accept: "application/json", "Accept-Encoding": "identity" } }
-    )
+    const response = await axios.get( "https://api.github.com/search/repositories?q=" + customizationNameQuery + "+in:name+org:cob", { headers: { Accept: "application/json", "Accept-Encoding": "identity" } } )
     customizationRepos = response.data.items
   }
 
-  // Check if there's at least one customization
-  if (customizationRepos.length == 0) throw new Error("\nError: ".red + " no customization found\n");
+  //If the goal is to cache or update customizations just return all customizations
+  if (args.cache || args.update) {
+    return customizationRepos;
+  } 
 
-  // Asks for customization to apply
-  if (args.cache && args.local) {
-    throw new Error("\nError: ".red + " incompatible options, --local AND --cache\n");
-  } else if(args.cache) {
-    console.log("Caching all customizations...");
-    for( let customizationRepo of customizationRepos) {
-      await getCustomizationFiles(customizationRepo);
-    }
-    fs.writeFileSync( cacheCustomizations,
-      JSON.stringify(customizationRepos, null, 2),
-      (err) => {
-        if (err) console.log( "Error writing " + cacheCustomizations + ":", err.message);
-      }
-    )
-  }
 
+  // Throw error if there's no customization
+  if (customizationRepos.length == 0) throw new Error("\nError: ".red + " no customization found\n");
+  
+  // Otherwise asks for customization to apply
   let answer = await inquirer.prompt([
     {
       type: "list",
@@ -84,7 +124,7 @@ async function getCustomizationRepo(filter, args) {
 }
 
 /* ************************************************************************ */
-async function getCustomizationFiles(customizationRepo) {
+async function downloadCustomizationFiles(customizationRepo) {
   const { xdgData } = await import("xdg-basedir");
   const baseDir = process.cwd();
   const cacheDir = path.resolve(xdgData,"cob-cli")
@@ -97,16 +137,20 @@ async function getCustomizationFiles(customizationRepo) {
   } else {
     console.log("  git pull " + customizationRepo.ssh_url);
     process.chdir(customizationRepo.name);
-    await git().pull();
+    try {
+      await git().pull();
+    } catch (error) { }
   }
   process.chdir(baseDir);
 }
 
 /* ************************************************************************ */
-async function applyCustomization(customizationRepo) {
+async function applyCustomization(customizationRepo, args) {
   console.log("\nApplying " + customizationRepo.name + " customization ...");
 
   // Get customization info from convention defined file (customize.js)
+  if (!args.local) await downloadCustomizationFiles(customizationRepo);
+  
   const { xdgData } = await import("xdg-basedir");
   const customizationPath = path.resolve( xdgData, "cob-cli", customizationRepo.name);
   const customizationFile = path.resolve( customizationPath, "customize.js");
@@ -126,7 +170,7 @@ async function applyCustomization(customizationRepo) {
     customization.actions(customizationRepo.name, answers, copyAndMerge);
   } else {
     // Default actions
-    copyAndMerge(customizationRepo.name, answers);
+    await copyAndMerge(customizationRepo.name, answers);
   }
 
   // Update customizations.json file
@@ -166,50 +210,53 @@ async function copyAndMerge(customizationRepoName, substitutions = {}) {
   // Source is on cob-cli customizationRepo and Destination on the server repo
   const target = process.cwd() // Always copy to directory where command is being executed, ie, the root directory of the server repo
   const substitutionRegex = /__(((?!word).)*)__/g;
-  ncp(
-    source,
-    target,
-    {
-      clobber: true,
-      filter: (src) => src.match(excludedFiles) == null,
-      rename: function(target) {
-        // Don't rename __MERGE__ templates, they will be handled by the merge method
-        if (target.match(/__MERGE__/)) return target;
-        
-        //get finalTarget from target with any existing substitution
-        const finalTarget = target.replace(substitutionRegex, (match,g1) => substitutions[g1] ? substitutions[g1] : match);
-        
-        //if the directory of finalTarget doesn't exists it means that a replacement ocurred on the dirpath (ie, there was a /__.+__/ was on the dirpath), in which case we need to create the desired directory and remove the one just created by ncp
-        if (!fs.existsSync(path.dirname(finalTarget))) {
-          fs.mkdirSync(path.dirname(finalTarget), { recursive: true })
-          fs.rmdirSync(target.substring(0,target.lastIndexOf("__")+2), { recursive: true,force: false }) //NOTE: won't handle more than 1 substitution on the same dirpath
+  return new Promise((resolve, reject) => {  
+    ncp(
+      source,
+      target,
+      {
+        clobber: true,
+        filter: (src) => src.match(excludedFiles) == null,
+        rename: function(target) {
+          // Don't rename __MERGE__ templates, they will be handled by the merge method
+          if (target.match(/__MERGE__/)) return target;
+          
+          //get finalTarget from target with any existing substitution
+          const finalTarget = target.replace(substitutionRegex, (match,g1) => substitutions[g1] ? substitutions[g1] : match);
+          
+          //if the directory of finalTarget doesn't exists it means that a replacement ocurred on the dirpath (ie, there was a /__.+__/ was on the dirpath), in which case we need to create the desired directory and remove the one just created by ncp
+          if (!fs.existsSync(path.dirname(finalTarget))) {
+            fs.mkdirSync(path.dirname(finalTarget), { recursive: true })
+            fs.rmdirSync(target.substring(0,target.lastIndexOf("__")+2), { recursive: true,force: false }) //NOTE: won't handle more than 1 substitution on the same dirpath
+          }
+          return finalTarget;
+        },
+        transform(read, write) {
+          const replaceVarsTransformFunction = new Transform({
+              transform: (chunk, encoding, done) => {
+                if(/\ufffd/.test(chunk) === true) {
+                  // If chunk is binary don't change anything
+                  done(null, chunk)
+                } else {
+                  // Otherwise change any existing substitution
+                  done(null,chunk.toString().replace(substitutionRegex, (match,g1) => substitutions[g1] ? substitutions[g1] : match))
+                }
+              }
+          })
+          read.pipe(replaceVarsTransformFunction).pipe(write)
         }
-        return finalTarget;
       },
-      transform(read, write) {
-        const replaceVarsTransformFunction = new Transform({
-            transform: (chunk, encoding, done) => {
-              if(/\ufffd/.test(chunk) === true) {
-                // If chunk is binary don't change anything
-                done(null, chunk)
-              } else {
-                // Otherwise change any existing substitution
-                done(null,chunk.toString().replace(substitutionRegex, (match,g1) => substitutions[g1] ? substitutions[g1] : match))
-              }
-            }
-        })
-        read.pipe(replaceVarsTransformFunction).pipe(write)
-      }
-    },
-    (error) => {
-      // If no error occurred then proced with merging files
-      if(!error) {
-        mergeFiles(customizationRepoName);
-      } else {
-        throw new Error(error.map((e) => e.message).join("\n"))
+      async (error) => {
+        // If no error occurred then proced with merging files
+        if(!error) {
+          await mergeFiles(customizationRepoName);
+          resolve();
+        } else {
+          reject(error.map((e) => e.message).join("\n"))
+        }
       }
-    }
-  )
+    )
+  });
 }
 
 /* ************************************************************************ */
@@ -256,13 +303,16 @@ async function mergeFiles(block) {
 
 /* ************************************************************************ */
 function updateCustomizationsVersions(customizationKey, version) {
-  const customizationsVersionsFile = "customizations.json";
   let customizationsVersions = {};
   if(fs.existsSync(customizationsVersionsFile)) {
     const customizationsVersionsRawData = fs.readFileSync(customizationsVersionsFile);
     customizationsVersions = JSON.parse(customizationsVersionsRawData);
   }
-  customizationsVersions = {[customizationKey]: version, ...customizationsVersions}
+  if(customizationsVersions[customizationKey]) {
+    customizationsVersions[customizationKey] = version
+  } else {
+    customizationsVersions = {[customizationKey]: version, ...customizationsVersions}
+  }
 
   fs.writeFileSync(
     customizationsVersionsFile,

package/lib/commands/init.js

@@ -4,7 +4,7 @@ const { newProjectTasks } = require("../task_lists/init_newProject");
 const { existingProjectTasks } = require("../task_lists/init_existingProject");
 const fs = require('fs-extra');
 const axios = require('axios');
-const git = require('simple-git/promise');
+const git = require('simple-git');
 
 /* ******************************** MAIN LOGIC **************************************** */
 async function init(servername,args) {

package/lib/commands/test.js

@@ -1,5 +1,5 @@
 require('colors');
-const opn = require('opn');
+const opn = require('open');
 const { validateTestingConditions }  = require("../task_lists/test_validate");
 const { customUIsContinuosReload } = require("../task_lists/test_customUIsContinuosReload");
 const { otherFilesContiousReload } = require("../task_lists/test_otherFilesContiousReload");
@@ -24,7 +24,6 @@ async function test (args) {
         }
         customUIsContinuosReload(cmdEnv, args.dashboard)
         
-        console.log( "\n" + (" NOTE: Press " + "O".bold.red + " to open default browser, " + "CTRL+C".bold.red + " or " + "Q".bold.red + " to stop the tests... ").yellow.bold + "\n\n" )
         let key;
         do {
             key = await getKeypress()

package/lib/task_lists/common_enviromentHandler.js

@@ -1,7 +1,7 @@
 require('colors');
 const execa = require('execa');
 const fg = require('fast-glob');
-const git = require('simple-git/promise');
+const git = require('simple-git');
 const fs = require('fs-extra');
 const { getCurrentBranch } = require("./common_releaseManager");
 const { SERVER_COB_CLI_DIRECTORY } = require("./common_helpers")

package/lib/task_lists/common_helpers.js

@@ -2,7 +2,7 @@ const SERVER_COB_CLI_DIRECTORY = "/opt/cob-cli/";
 
 /* **************************************************************************************** */
 async function checkWorkingCopyCleanliness(testNotDetached=true) {
-    const git = require('simple-git/promise');
+    const git = require('simple-git');
     //Check we're not detached
     if(testNotDetached) await git().revparse(["--abbrev-ref", "HEAD"]).then( currentBranch => { if(!currentBranch) throw new Error("Aborded:".red + " git head is dettached")} ) 
     await git().fetch()

package/lib/task_lists/common_releaseManager.js

@@ -1,6 +1,6 @@
 const execa = require('execa');
 const fs = require('fs-extra');
-const git = require('simple-git/promise');
+const git = require('simple-git');
 
 const SERVER_CHANGELOG = "/opt/cob-cli/DEPLOYLOG.md";
 const LAST_SHA_FILE = "lastDeploySha"
@@ -33,7 +33,7 @@ async function registerRelease(cmdEnv) {
     }
 
     // Maintain server deploy file log
-    const user = require('whoami');
+    const user = require("os").userInfo().username;
     const date = new Date();
     const dateStr = date.toISOString().slice(0,10).replace(/-/g,".")
     const dateTimeStr = date.toISOString().slice(0,16).replace(/T/," ")

package/lib/task_lists/deploy_execute.js

@@ -1,7 +1,7 @@
 const Listr = require('listr');
 const UpdaterRenderer = require('listr-update-renderer');
 const verboseRenderer = require('listr-verbose-renderer');
-const git = require('simple-git/promise');
+const git = require('simple-git');
 const { registerRelease } = require("./common_releaseManager");
 const { copyFiles } = require("./common_syncFiles");
 

package/lib/task_lists/deploy_validate.js

@@ -2,7 +2,7 @@ require('colors');
 const Listr = require('listr');
 const UpdaterRenderer = require('listr-update-renderer');
 const verboseRenderer = require('listr-verbose-renderer');
-const git = require('simple-git/promise');
+const git = require('simple-git');
 const { checkWorkingCopyCleanliness, checkConnectivity } = require("./common_helpers");
 const { getCurrentBranch, getLastDeployedSha } = require("./common_releaseManager");
 const { testEquality } = require("./common_syncFiles");

package/lib/task_lists/init_existingProject.js

@@ -1,5 +1,5 @@
 const Listr = require('listr');
-const git = require('simple-git/promise');
+const git = require('simple-git');
 
 function existingProjectTasks(repo) {
     return new Listr([

package/lib/task_lists/init_newProject.js

@@ -3,7 +3,7 @@ const Listr = require('listr');
 const fs = require('fs-extra');
 const path = require('path')
 const execa = require('execa');
-const git = require('simple-git/promise');
+const git = require('simple-git');
 const UpdaterRenderer = require('listr-update-renderer');
 const verboseRenderer = require('listr-verbose-renderer');
 const { checkConnectivity } = require("./common_helpers");

package/lib/task_lists/test_customUIsContinuosReload.js

@@ -20,7 +20,7 @@ async function customUIsContinuosReload(cmdEnv, dashboard) {
     if(dashboardPathIsDirectory) {
         // If we have a dashboard to serve run it from local dashboard directory on 8081 with vue-cli-service
         // it will use its vue.config.js
-        console.log("\n Installing dependencies...")
+        console.log("\n PLEASE WAIT".red + ": checking dependencies...")
         await execa("npm",["install"],{cwd: dashboardPath} )
 
         commands.push( {
@@ -33,14 +33,15 @@ async function customUIsContinuosReload(cmdEnv, dashboard) {
         })
     }
 
+    console.log( "\n" + (" NOTE: Press " + "O".bold.red + " to open default browser, " + "CTRL+C".bold.red + " or " + "Q".bold.red + " to stop the tests... ").yellow.bold + "\n\n" )
+
     commands.push({
         // run wepback from cob-cli directory with webpack.config.js also from cob-cli directory
         command: [
             path.resolve(__dirname, '../../node_modules/.bin/webpack-dev-server'),
             "--config",
             path.resolve(__dirname, "../webpack/webpack.config.js"),
-            "--env.SERVER=" + "https://" + cmdEnv.server,
-            "--env.DASHBOARD=" + dashboard
+            "--mode=development"
         ].join(" "), 
         name: 'customUIs server',
         prefixColor: "blue" 

package/lib/task_lists/test_otherFilesContiousReload.js

@@ -1,7 +1,6 @@
 const fs = require('fs-extra');
 const execa = require('execa');
-const git = require('simple-git/promise');
-const user = require('whoami');
+const git = require('simple-git');
 const { SERVER_COB_CLI_DIRECTORY } = require("./common_helpers");
 const { confirmExecutionOfChanges, resolveCobPath } = require("./common_syncFiles");
 const { syncFile } = require("./test_syncFile");
@@ -124,6 +123,7 @@ async function addFileToCurrentTest(server, changedFile, changedFiles, changeTyp
             }
 
             if(!changedFiles.has(changedFile)) {
+                const user = require("os").userInfo().username;
                 execa('ssh', [server, "echo '" + changedFile + " by " + user + "' >> " + SERVER_IN_PROGRESS_TEST_FILE]);
                 changedFiles.add(changedFile);
             }

package/lib/task_lists/test_validate.js

@@ -4,7 +4,7 @@ const execa = require('execa');
 const fs = require('fs-extra');
 const UpdaterRenderer = require('listr-update-renderer');
 const verboseRenderer = require('listr-verbose-renderer');
-const git = require('simple-git/promise');
+const git = require('simple-git');
 const { checkConnectivity } = require("./common_helpers");
 const { getCurrentBranch, getLastDeployedSha } = require("./common_releaseManager");
 const { testEquality } = require("./common_syncFiles");

package/lib/webpack/webpack.config.js

@@ -1,5 +1,4 @@
 const path = require('path');
-const { env } = require('process');
 
 module.exports = env => {
   return {
@@ -7,37 +6,45 @@ module.exports = env => {
       fake_customizations2: path.resolve(__dirname,'./fake_customizations2.js')
     },
     devServer: {
-      contentBase: '.',
-      watchContentBase: true,
-      watchOptions: {
-        ignored: [
-          "**/.git/**",
-          "**/integrationm/**",
-          "**/recordm-importer/**",
-          "**/node_modules/**",
-          "**/node_modules/.cache/**",
-          "**/services/**",
-          "**/" + env.DASHBOARD + "/**"
-        ]
+      static : {
+        directory: '.',
+        watch: {
+          ignored: [
+            "**/.git/**",
+            "**/integrationm/**",
+            "**/recordm-importer/**",
+            "**/node_modules/**",
+            "**/node_modules/.cache/**",
+            "**/services/**",
+            "**/" + process.env.dash_dir + "/**"
+          ]
+        }  
       },
-      liveReload: true,
+      hot:false,
       port: 8040,
       host: "0.0.0.0",
-      stats: {
-        maxModules: 0 // Set the maximum number of modules to be shown
+      devMiddleware: {
+        stats: {
+          maxModules: 0 // Set the maximum number of modules to be shown
+        }
       },
-      before: function(app) {
-        app.get('/*', function(req, res, next) {
-          // Permite usar / ou /DASH_BOARD/ quando acedido directamente
-          if(req.url != "/") {
-            return next();
-          }
-  
-          res.redirect(`/recordm/`);
+      setupMiddlewares: (middlewares, devServer) => {
+        middlewares.push({
+          name: 'hello-world-test-one',
+          // `path` is optional
+          path: '*',
+          middleware: (req, res, next) => {
+            // Permite usar / ou /DASH_BOARD/ quando acedido directamente
+            if(req.url != "/") {
+              return next();
+            }    
+            res.redirect(`/recordm/`);
+          },
         });
+        return middlewares;
       },
       proxy: {
-        [ "**/" + env.DASHBOARD + "/**"]: {
+        [ "**/" + process.env.dash_dir + "/**"]: {
           target: "http://localhost:8041",
           secure: false
         },
@@ -47,7 +54,7 @@ module.exports = env => {
         },
         "/": {
           logLevel: "warn",
-          target: env.SERVER,
+          target: process.env.server,
           secure: false,
           ws: false,
           changeOrigin: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cob-cli",
-  "version": "2.29.0",
+  "version": "2.31.0",
   "description": "A command line utility to help Cult of Bits partners develop with higher speed and reusing common code and best practices.",
   "preferGlobal": true,
   "repository": {
@@ -16,6 +16,7 @@
     "cob-cli": "bin/cob-cli.js"
   },
   "dependencies": {
+    "@webpack-cli/serve": "^2.0.1",
     "axios": "^0.21.1",
     "colors": "^1.4.0",
     "commander": "^5.1.0",
@@ -27,11 +28,11 @@
     "listr": "^0.14.3",
     "ncp": "^2.0.0",
     "omelette": "^0.4.15-1",
-    "simple-git": "^1.132.0",
-    "webpack": "^5.49.0",
-    "webpack-cli": "^3.3.12",
-    "webpack-dev-server": "^3.11.2",
-    "whoami": "0.0.3",
+    "open": "^8.4.0",
+    "simple-git": "^3.15.1",
+    "webpack": "^5.75.0",
+    "webpack-cli": "^5.0.1",
+    "webpack-dev-server": "^4.11.1",
     "xdg-basedir": "^5.1.0"
   },
   "keywords": [],