cht-conf 3.10.0 → 3.10.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [3.10.1](https://github.com/medic/cht-conf/compare/v3.10.0...v3.10.1) (2022-02-23)
+
+
+### Bug Fixes
+
+* **#465:** remove process.exit and extraneous require ([058e651](https://github.com/medic/cht-conf/commit/058e65182928cdefdd5bb8fb41849fb9b5164631)), closes [#465](https://github.com/medic/cht-conf/issues/465)
+
 # [3.10.0](https://github.com/medic/cht-conf/compare/v3.9.5...v3.10.0) (2022-02-02)
 
 

package/README.md

@@ -91,6 +91,8 @@ If a different username is required, add the `--user` switch:
 
 	cht --url=https://username:password@example.com:12345
 
+**NB** - When specifying the URL with `--url`, be sure not to specify the CouchDB database name in the URL. The CHT API will find the correct database.
+
 ### Into an archive to be uploaded later
 
     cht --archive

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cht-conf",
-  "version": "3.10.0",
+  "version": "3.10.1",
   "description": "Configure CHT deployments",
   "main": "./src/lib/main.js",
   "engines": {
@@ -62,6 +62,7 @@
     "request-promise-native": "^1.0.9",
     "semver": "^6.1.1",
     "svgo": "^1.3.2",
+    "terser-webpack-plugin": "^1.4.3",
     "uuid": "^8.3.2",
     "webpack": "^4.46.0",
     "xmldom": "^0.6.0"

package/src/bin/index.js

@@ -1,20 +1,22 @@
 #!/usr/bin/env node
 
-const { error } = require('../lib/log');
-require('../cli/check-node-version');
+const { info, error } = require('../lib/log');
+const checkNodeVersion = require('../cli/check-node-version');
 
-const main = require('../lib/main');
+try {
+  checkNodeVersion();
+} catch (e) {
+  error(e.message);
+  process.exitCode = 1;
+}
 
+const main = require('../lib/main');
 (async () => {
-  let returnCode;
   try {
-    returnCode = await main(process.argv, process.env);
-  }
-  catch (e) {
-    error(e);
-    returnCode = 1;
-  }
-  finally {
-    process.exit(returnCode);
+    await main(process.argv, process.env);
+  } catch (e) {
+    info(e); // log the details for debugging
+    error(e.message); // error the message to make it clear
+    process.exitCode = 1; // emit a non-zero exit code for scripting
   }
 })();

package/src/cli/check-node-version.js

@@ -1,10 +1,12 @@
 const MIN_NODE_VERSION = 6;
 const currentNodeVersion = process.versions.node;
 
-if(Number.parseInt(currentNodeVersion.split('.')[0]) < MIN_NODE_VERSION) {
-  console.log(`\x1b[31mYour NodeJS is too old.
-    You are running node version: ${currentNodeVersion}
-    cht-conf requires version:  ${MIN_NODE_VERSION}
-  Please upgrade node to continue.\x1b[0m`);
-  process.exit(1);
-}
+module.exports = () => {
+  const currentMajor = process.versions.node.split('.')[0];
+  if(Number.parseInt(currentMajor) < MIN_NODE_VERSION) {
+    throw new Error(`Your NodeJS is too old.
+      You are running node version: ${currentNodeVersion}
+      cht-conf requires version:  ${MIN_NODE_VERSION}
+    Please upgrade node to continue.`);
+  }
+};

package/src/cli/shell-completion-setup.js

@@ -1,20 +1,17 @@
 const fs = require('../lib/sync-fs');
-const { error } = require('../lib/log');
 
-const supported_shells = ['bash'];
+const SUPPORTED_SHELLS = ['bash'];
 
 module.exports = shell => {
-
-  if (supported_shells.includes(shell)){
+  if (SUPPORTED_SHELLS.includes(shell)){
     const completionFile = `${__dirname}/shell-completion.${shell}`;
     if (fs.exists(completionFile)){
       console.log(fs.read(completionFile));
-      process.exit(0);
+      return;
     }
   } else if (shell === true){
-    error('shell type argument not specified e.g. --shell-completion=bash');
+    throw new Error('shell type argument not specified e.g. --shell-completion=bash');
   } else {
-    error(`completion not yet supported for '${shell}' shell`);
+    throw new Error(`completion not yet supported for '${shell}' shell`);
   }
-  process.exit(1);
 };

package/src/fn/check-git.js

@@ -1,5 +1,5 @@
 const git = require('../lib/git-exec');
-const { info, warn, error } = require('../lib/log');
+const { info, warn } = require('../lib/log');
 const userPrompt = require('../lib/user-prompt');
 const environment = require('../lib/environment');
 
@@ -17,8 +17,7 @@ module.exports = {
           'not staged for commit.');
         warn('Changes untracked or to be committed:\n' + status);
         if (!userPrompt.keyInYN('Are you sure you want to continue?')) {
-          error('User failed to confirm action.');
-          process.exit(1);
+          throw new Error('User aborted execution.');
         }
       }
       info('Fetching git upstream...');
@@ -26,8 +25,7 @@ module.exports = {
       if (syncStatus) {
         warn(syncStatus);
         if (!userPrompt.keyInYN('Are you sure you want to continue?')) {
-          error('User failed to confirm action.');
-          process.exit(1);
+          throw new Error('User aborted execution.');
         }
       }
     }

package/src/fn/compress-images.js

@@ -1,3 +1,4 @@
+/*eslint node/no-missing-require: "off"*/
 const compressPng = require('../lib/compress-png').execute;
 const compressSvg = require('../lib/compress-svg').execute;
 

package/src/fn/create-users.js

@@ -4,7 +4,7 @@ const userPrompt = require('../../src/lib/user-prompt');
 const api = require('../lib/api');
 const environment = require('../lib/environment');
 const fs = require('../lib/sync-fs');
-const { info, warn, error } = require('../lib/log');
+const { info, warn } = require('../lib/log');
 
 const nestPrefixedProperties = (obj, name) => {
   const nested = {};
@@ -61,7 +61,7 @@ const getUserInfo = async (user) => {
 
 const execute = async () => {
   const csvPath = `${environment.pathToProject}/users.csv`;
-  if(!fs.exists(csvPath)) {
+  if (!fs.exists(csvPath)) {
     throw new Error(`User csv file not found at ${csvPath}`);
   }
 
@@ -76,11 +76,8 @@ const execute = async () => {
   if (warnings.length) {
     warnings.forEach(warning => warn(warning));
     warn('Are you sure you want to continue?');
-    if(!userPrompt.keyInYN()) {
-      error('User failed to confirm action.');
-      process.exit(1);
-      // stop execution in tests
-      return; // eslint-disable-line no-unreachable
+    if (!userPrompt.keyInYN()) {
+      throw new Error('User aborted execution.');
     }
   }
 

package/src/fn/move-contacts.js

@@ -7,7 +7,7 @@ const fs = require('../lib/sync-fs');
 const lineageManipulation = require('../lib/lineage-manipulation');
 const lineageConstraints = require('../lib/lineage-constraints');
 const pouch = require('../lib/db');
-const { warn, trace, info, error } = require('../lib/log');
+const { warn, trace, info } = require('../lib/log');
 
 const HIERARCHY_ROOT = 'root';
 const BATCH_SIZE = 10000;
@@ -125,8 +125,7 @@ const prepareDocumentDirectory = ({ docDirectoryPath, force }) => {
     if(userPrompt.keyInYN()) {
       fs.deleteFilesInFolder(docDirectoryPath);
     } else {
-      error('User failed to confirm action.');
-      process.exit(1);
+      throw new Error('User aborted execution.');
     }
   }
 };

package/src/fn/upload-custom-translations.js

@@ -65,8 +65,7 @@ const execute = async () => {
         if (placeholderErrorsFound > 0) {
           errMsg += '\nYou can use messages-ex.properties to add placeholders missing from the reference context.';
         }
-        log.error(errMsg);
-        return process.exit(1);
+        throw new Error(errMsg);
       }
     } else {
       throw err;
@@ -77,8 +76,7 @@ const execute = async () => {
     const id = idFor(fileName);
     const languageCode = id.substring('messages-'.length);
     if (!isLanguageCodeValid(languageCode)) {
-      log.error(`The language code '${languageCode}' is not valid. It must begin with a letter(a–z, A-Z), followed by any number of hyphens, underscores, letters, or numbers.`);
-      return process.exit(1);
+      throw new Error(`The language code '${languageCode}' is not valid. It must begin with a letter(a-z, A-Z), followed by any number of hyphens, underscores, letters, or numbers.`);
     }
 
     let languageName = iso639.getName(languageCode);

package/src/fn/upload-docs.js

@@ -8,7 +8,7 @@ const log = require('../lib/log');
 const pouch = require('../lib/db');
 const progressBar = require('../lib/progress-bar');
 
-const { info, trace, warn, error } = log;
+const { info, trace, warn } = log;
 
 const FILE_EXTENSION = '.doc.json';
 const INITIAL_BATCH_SIZE = 100;
@@ -34,9 +34,8 @@ const execute = async () => {
   }
 
   warn(`This operation will permanently write ${totalCount} docs.  Are you sure you want to continue?`);
-  if(!userPrompt.keyInYN()) {
-    error('User failed to confirm action.');
-    process.exit(1);
+  if (!userPrompt.keyInYN()) {
+    throw new Error('User aborted execution.');
   }
 
   const results = { ok:[], failed:{} };

package/src/lib/api.js

@@ -94,25 +94,24 @@ const api = {
    */
   available: async () => {
     const url = `${environment.apiUrl}/`;
+    log.info(`Checking that ${url} is available...`);
     try {
-      log.info(`Checking that ${url} is available...`);
       await request.get(url);
-      return true;
     } catch (err) {
       if (err.statusCode === 401) {
-        log.error(`Authentication failed connecting to ${url}. `
-                  + 'Check the supplied username and password and try again.');
-      } else if (err.statusCode === 403) {
-        log.error(`Insufficient permissions connecting to ${url}. `
-                  + 'You need to use admin permissions to execute this command.');
-      } else if (err.statusCode) {
-        log.error(`Received error code ${err.statusCode} connecting to ${url}. `
-                  + 'Check the server and and try again.');
-      } else {
-        log.error(`Failed to get a response from ${url}. Maybe you entered the wrong URL, `
-                  + 'wrong port or the instance is not started. Please check and try again.');
+        throw new Error(`Authentication failed connecting to ${url}. `
+          + 'Check the supplied username and password and try again.');
+      }
+      if (err.statusCode === 403) {
+        throw new Error(`Insufficient permissions connecting to ${url}. `
+          + 'You need to use admin permissions to execute this command.');
+      }
+      if (err.statusCode) {
+        throw new Error(`Received error code ${err.statusCode} connecting to ${url}. `
+          + 'Check the server and and try again.');
       }
-      return false;
+      throw new Error(`Failed to get a response from ${url}. Maybe you entered the wrong URL, `
+        + 'wrong port or the instance is not started. Please check and try again.');
     }
   },
 

package/src/lib/main.js

@@ -12,7 +12,7 @@ const supportedActions = require('../cli/supported-actions');
 const usage = require('../cli/usage');
 const api = require('../lib/api');
 
-const { error, info, warn } = log;
+const { info, warn } = log;
 const defaultActions = [
   'check-git',
   'compile-app-settings',
@@ -55,9 +55,9 @@ module.exports = async (argv, env) => {
     warn('The "medic-conf" cli command is deprecated. Please use "cht" instead');
   }
 
-  if(argv.length <= 2) {
-    usage(0);
-    return 1;
+  if (argv.length <= 2) {
+    usage();
+    throw new Error('Invalid number of arguments.');
   }
 
   const cmdArgs = require('minimist')(argv.slice(2), {
@@ -69,8 +69,8 @@ module.exports = async (argv, env) => {
   // General single use actions
   //
   if (cmdArgs.help) {
-    usage(0);
-    return 0;
+    usage();
+    return;
   }
 
   if (cmdArgs['shell-completion']) {
@@ -79,22 +79,21 @@ module.exports = async (argv, env) => {
 
   if (cmdArgs['supported-actions']) {
     info('Supported actions:\n', supportedActions.join('\n  '));
-    return 0;
+    return;
   }
 
   if (cmdArgs.version) {
     info(require('../../package.json').version);
-    return 0;
+    return;
   }
 
   if (cmdArgs.changelog) {
     await open('https://github.com/medic/cht-conf/releases', { url: true });
-    return process.exit(0);
+    return;
   }
 
   if (cmdArgs.archive && !cmdArgs.destination) {
-    error('--destination=<path to save files> is required with --archive.');
-    return 1;
+    throw new Error('--destination=<path to save files> is required with --archive.');
   }
 
   if (cmdArgs['accept-self-signed-certs']) {
@@ -130,8 +129,7 @@ module.exports = async (argv, env) => {
 
   const unsupported = actions.filter(a => !supportedActions.includes(a));
   if(unsupported.length) {
-    error(`Unsupported action(s): ${unsupported.join(' ')}`);
-    return 1;
+    throw new Error(`Unsupported action(s): ${unsupported.join(' ')}`);
   }
 
   if (cmdArgs['skip-git-check']) {
@@ -163,8 +161,7 @@ module.exports = async (argv, env) => {
   if (actions.some(action => action.requiresInstance)) {
     apiUrl = getApiUrl(cmdArgs, env);
     if (!apiUrl) {
-      error('Failed to obtain a url to the API');
-      return 1;
+      throw new Error('Failed to obtain a url to the API');
     }
   }
 
@@ -183,8 +180,8 @@ module.exports = async (argv, env) => {
     cmdArgs['skip-translation-check']
   );
 
-  if (apiUrl && !await api().available()) {
-    return 1;
+  if (apiUrl) {
+    await api().available();
   }
 
   const productionUrlMatch = environment.instanceUrl && environment.instanceUrl.match(/^https:\/\/(?:[^@]*@)?(.*)\.(app|dev)\.medicmobile\.org(?:$|\/)/);
@@ -192,9 +189,8 @@ module.exports = async (argv, env) => {
   if (productionUrlMatch && !expectedOptions.includes(productionUrlMatch[1])) {
     warn(`Attempting to use project for \x1b[31m${projectName}\x1b[33m`,
         `against non-matching instance: \x1b[31m${redactBasicAuth(environment.instanceUrl)}\x1b[33m`);
-    if(!userPrompt.keyInYN()) {
-      error('User failed to confirm action.');
-      return 1;
+    if (!userPrompt.keyInYN()) {
+      throw new Error('User aborted execution.');
     }
   }
 
@@ -218,8 +214,6 @@ module.exports = async (argv, env) => {
   if (actions.length > 1) {
     await info('All actions completed.');
   }
-
-  return 0;
 };
 
 // Exists for generic mocking purposes