cht-conf 3.9.2 → 3.10.0

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+# [3.10.0](https://github.com/medic/cht-conf/compare/v3.9.5...v3.10.0) (2022-02-02)
+
+
+### Features
+
+* **#431:** track form version ([9d0b8d7](https://github.com/medic/cht-conf/commit/9d0b8d7df2c04140b9e84cd044d5583695c4e1c0)), closes [#431](https://github.com/medic/cht-conf/issues/431)
+
+## [3.9.5](https://github.com/medic/cht-conf/compare/v3.9.4...v3.9.5) (2022-01-30)
+
+
+### Bug Fixes
+
+* **#458:** return non-zero code when exiting with failure ([516bff0](https://github.com/medic/cht-conf/commit/516bff0eabec2d3c13a16a994212280d77358c7e)), closes [#458](https://github.com/medic/cht-conf/issues/458)
+
+## [3.9.4](https://github.com/medic/cht-conf/compare/v3.9.3...v3.9.4) (2022-01-05)
+
+
+### Bug Fixes
+
+* **#460:** log useful error messages when api connection fails ([#461](https://github.com/medic/cht-conf/issues/461)) ([095a55c](https://github.com/medic/cht-conf/commit/095a55c9254c6872696cbee2fe42f244fc1fc4a8)), closes [#460](https://github.com/medic/cht-conf/issues/460) [#460](https://github.com/medic/cht-conf/issues/460)
+
+## [3.9.3](https://github.com/medic/cht-conf/compare/v3.9.2...v3.9.3) (2021-12-16)
+
+
+### Bug Fixes
+
+* **#455:** allow empty translation constants ([ac170d7](https://github.com/medic/cht-conf/commit/ac170d7cce13a6a500d89884d4ca63801f06a969)), closes [#455](https://github.com/medic/cht-conf/issues/455)
+
 ## [3.9.2](https://github.com/medic/cht-conf/compare/v3.9.1...v3.9.2) (2021-12-08)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cht-conf",
-  "version": "3.9.2",
+  "version": "3.10.0",
   "description": "Configure CHT deployments",
   "main": "./src/lib/main.js",
   "engines": {
@@ -36,7 +36,7 @@
   "homepage": "https://github.com/medic/cht-conf#readme",
   "dependencies": {
     "@hapi/joi": "^16.1.8",
-    "@medic/translation-checker": "1.0.0",
+    "@medic/translation-checker": "^1.0.1",
     "canonical-json": "0.0.4",
     "csv-parse": "^4.16.0",
     "dom-compare": "^0.6.0",

package/src/bin/index.js

@@ -12,7 +12,7 @@ const main = require('../lib/main');
   }
   catch (e) {
     error(e);
-    returnCode = -1;
+    returnCode = 1;
   }
   finally {
     process.exit(returnCode);

package/src/fn/check-git.js

@@ -18,7 +18,7 @@ module.exports = {
         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);
+          process.exit(1);
         }
       }
       info('Fetching git upstream...');
@@ -27,7 +27,7 @@ module.exports = {
         warn(syncStatus);
         if (!userPrompt.keyInYN('Are you sure you want to continue?')) {
           error('User failed to confirm action.');
-          process.exit(-1);
+          process.exit(1);
         }
       }
     }

package/src/fn/move-contacts.js

@@ -126,7 +126,7 @@ const prepareDocumentDirectory = ({ docDirectoryPath, force }) => {
       fs.deleteFilesInFolder(docDirectoryPath);
     } else {
       error('User failed to confirm action.');
-      process.exit(-1);
+      process.exit(1);
     }
   }
 };

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

@@ -66,7 +66,7 @@ const execute = async () => {
           errMsg += '\nYou can use messages-ex.properties to add placeholders missing from the reference context.';
         }
         log.error(errMsg);
-        return process.exit(-1);
+        return process.exit(1);
       }
     } else {
       throw err;
@@ -78,7 +78,7 @@ const execute = async () => {
     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);
+      return process.exit(1);
     }
 
     let languageName = iso639.getName(languageCode);

package/src/lib/api.js

@@ -99,8 +99,19 @@ const api = {
       await request.get(url);
       return true;
     } catch (err) {
-      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.');
+      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.');
+      }
       return false;
     }
   },

package/src/lib/main.js

@@ -57,7 +57,7 @@ module.exports = async (argv, env) => {
 
   if(argv.length <= 2) {
     usage(0);
-    return -1;
+    return 1;
   }
 
   const cmdArgs = require('minimist')(argv.slice(2), {
@@ -94,7 +94,7 @@ module.exports = async (argv, env) => {
 
   if (cmdArgs.archive && !cmdArgs.destination) {
     error('--destination=<path to save files> is required with --archive.');
-    return -1;
+    return 1;
   }
 
   if (cmdArgs['accept-self-signed-certs']) {
@@ -131,7 +131,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;
+    return 1;
   }
 
   if (cmdArgs['skip-git-check']) {
@@ -164,7 +164,7 @@ module.exports = async (argv, env) => {
     apiUrl = getApiUrl(cmdArgs, env);
     if (!apiUrl) {
       error('Failed to obtain a url to the API');
-      return -1;
+      return 1;
     }
   }
 
@@ -184,7 +184,7 @@ module.exports = async (argv, env) => {
   );
 
   if (apiUrl && !await api().available()) {
-    return false;
+    return 1;
   }
 
   const productionUrlMatch = environment.instanceUrl && environment.instanceUrl.match(/^https:\/\/(?:[^@]*@)?(.*)\.(app|dev)\.medicmobile\.org(?:$|\/)/);
@@ -194,7 +194,7 @@ module.exports = async (argv, env) => {
         `against non-matching instance: \x1b[31m${redactBasicAuth(environment.instanceUrl)}\x1b[33m`);
     if(!userPrompt.keyInYN()) {
       error('User failed to confirm action.');
-      return false;
+      return 1;
     }
   }
 
@@ -218,6 +218,8 @@ module.exports = async (argv, env) => {
   if (actions.length > 1) {
     await info('All actions completed.');
   }
+
+  return 0;
 };
 
 // Exists for generic mocking purposes

package/src/lib/sync-fs.js

@@ -97,6 +97,7 @@ module.exports = {
   recurseFiles,
   deleteFilesInFolder: folderPath => recurseFiles(folderPath).forEach(filePath => fs.unlinkSync(filePath)),
   readdir: fs.readdirSync,
+  statSync: fs.statSync,
   withoutExtension,
   write: (path, data, options = 'utf8') => fs.writeFileSync(path, data, options),
   writeBinary: (path, content) => fs.writeFileSync(path, content),

package/src/lib/upload-forms.js

@@ -1,6 +1,7 @@
 const argsFormFilter = require('./args-form-filter');
 const attachmentsFromDir = require('./attachments-from-dir');
 const attachmentFromFile = require('./attachment-from-file');
+const crypto = require('crypto');
 const fs = require('./sync-fs');
 const log = require('./log');
 const insertOrReplace = require('./insert-or-replace');
@@ -38,7 +39,13 @@ module.exports = async (projectDir, subDirectory, options) => {
       log.info(`No media directory found at ${mediaDir} for form ${xformPath}`);
     }
 
+    const hashSum = crypto.createHash('sha256');
     const xml = fs.read(xformPath);
+    hashSum.update(xml);
+    const xmlVersion = {
+      time: Date.now(),
+      sha256: hashSum.digest('hex'),
+    };
 
     const internalId = readIdFrom(xml);
     if(internalId !== baseDocId) log.warn('DEPRECATED', 'Form:', fileName, 'Bad ID set in XML.  Expected:', baseDocId, 'but saw:', internalId, ' Support for setting these values differently will be dropped.  Please see https://github.com/medic/cht-core/issues/3342.');
@@ -48,6 +55,7 @@ module.exports = async (projectDir, subDirectory, options) => {
       _id: docId,
       type: 'form',
       internalId: internalId,
+      xmlVersion: xmlVersion,
       title: readTitleFrom(xml),
       context: options.default_context,
     };