cht-conf 3.9.1 → 3.9.5

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+## [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)
+
+
+### Performance Improvements
+
+* **#432:** refactor the moving of reports to use a recursive function to improve performance ([c17b43b](https://github.com/medic/cht-conf/commit/c17b43b4d89b29b813db4be6e0f2d2c0a1e6c94d)), closes [#432](https://github.com/medic/cht-conf/issues/432)
+
 ## [3.9.1](https://github.com/medic/cht-conf/compare/v3.9.0...v3.9.1) (2021-11-16)
 
 

package/README.md

@@ -282,7 +282,7 @@ To develop a new action or improve an existing one, check the ["Actions" doc](sr
 
 ## Testing
 
-Execute `npm test` to run static analysis checks and the test suite.
+Execute `npm test` to run static analysis checks and the test suite. Requires Docker to run integration tests against a CouchDB instance. 
 
 ## Executing your local branch
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cht-conf",
-  "version": "3.9.1",
+  "version": "3.9.5",
   "description": "Configure CHT deployments",
   "main": "./src/lib/main.js",
   "engines": {
@@ -9,7 +9,9 @@
   "scripts": {
     "clean": "rm -rf ./build/",
     "eslint": "eslint src/**/*.js test/*.js test/**/*.js",
-    "test": "npm run eslint && npm run clean && mkdir -p build/test && cp -r test/data build/test/data && cd build/test && nyc --reporter=html mocha --forbid-only ../../test/**/*.spec.js && cd ../..",
+    "docker-start-couchdb": "npm run docker-stop-couchdb && docker run -d -p 6984:5984 --rm --name cht-conf-couchdb couchdb:2.3.1 && sh test/scripts/wait_for_response_code.sh 6984 200 CouchDB",
+    "docker-stop-couchdb": "docker stop cht-conf-couchdb || true",
+    "test": "npm run eslint && npm run docker-start-couchdb && npm run clean && mkdir -p build/test && cp -r test/data build/test/data && cd build/test && nyc --reporter=html mocha --forbid-only ../../test/**/*.spec.js && cd ../.. && npm run docker-stop-couchdb",
     "semantic-release": "semantic-release"
   },
   "bin": {
@@ -34,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

@@ -10,6 +10,7 @@ const pouch = require('../lib/db');
 const { warn, trace, info, error } = require('../lib/log');
 
 const HIERARCHY_ROOT = 'root';
+const BATCH_SIZE = 10000;
 
 module.exports = {
   requiresInstance: true,
@@ -49,19 +50,15 @@ const updateLineagesAndStage = async (options, db) => {
     trace(`Considering primary contact updates to ${ancestors.length} ancestor(s) of contact ${prettyPrintDocument(contactDoc)}.`);
     const updatedAncestors = replaceLineageInAncestors(descendantsAndSelf, ancestors);
 
-    const reportsCreatedByDescendants = await fetch.reportsCreatedBy(db, descendantsAndSelf.map(descendant => descendant._id));
-    trace(`${reportsCreatedByDescendants.length} report(s) created by these affected contact(s) will update`);
-    const updatedReports = replaceLineageInReports(reportsCreatedByDescendants, replacementLineage, contactId);
+    minifyLineageAndWriteToDisk([...updatedDescendants, ...updatedAncestors], options);
 
-    [...updatedDescendants, ...updatedReports, ...updatedAncestors].forEach(updatedDoc => {
-      lineageManipulation.minifyLineagesInDoc(updatedDoc);
-      writeDocumentToDisk(options, updatedDoc);
-    });
+    const movedReportsCount = await moveReports(db, descendantsAndSelf, options, replacementLineage, contactId);
+    trace(`${movedReportsCount} report(s) created by these affected contact(s) will be updated`);
 
     affectedContactCount += updatedDescendants.length + updatedAncestors.length;
-    affectedReportCount += updatedReports.length;
+    affectedReportCount += movedReportsCount;
 
-    info(`Staged updates to ${prettyPrintDocument(contactDoc)}. ${updatedDescendants.length} contact(s) and ${updatedReports.length} report(s).`);
+    info(`Staged updates to ${prettyPrintDocument(contactDoc)}. ${updatedDescendants.length} contact(s) and ${movedReportsCount} report(s).`);
   }
 
   info(`Staged changes to lineage information for ${affectedContactCount} contact(s) and ${affectedReportCount} report(s).`);
@@ -129,7 +126,7 @@ const prepareDocumentDirectory = ({ docDirectoryPath, force }) => {
       fs.deleteFilesInFolder(docDirectoryPath);
     } else {
       error('User failed to confirm action.');
-      process.exit(-1);
+      process.exit(1);
     }
   }
 };
@@ -155,6 +152,31 @@ ${bold('OPTIONS')}
 `);
 };
 
+const moveReports = async (db, descendantsAndSelf, writeOptions, replacementLineage, contactId) => {
+  const contactIds = descendantsAndSelf.map(contact => contact._id);
+
+  let skip = 0;
+  let reportDocsBatch;
+  do {
+    info(`Processing ${skip} to ${skip + BATCH_SIZE} report docs`);
+    reportDocsBatch = await fetch.reportsCreatedBy(db, contactIds, skip);
+
+    const updatedReports = replaceLineageInReports(reportDocsBatch, replacementLineage, contactId);
+    minifyLineageAndWriteToDisk(updatedReports, writeOptions);
+
+    skip += reportDocsBatch.length;
+  } while (reportDocsBatch.length >= BATCH_SIZE);
+
+  return skip;
+};
+
+const minifyLineageAndWriteToDisk = (docs, parsedArgs) => {
+  docs.forEach(doc => {
+    lineageManipulation.minifyLineagesInDoc(doc);
+    writeDocumentToDisk(parsedArgs, doc);
+  });
+};
+
 const writeDocumentToDisk = ({ docDirectoryPath }, doc) => {
   const destinationPath = path.join(docDirectoryPath, `${doc._id}.doc.json`);
   if (fs.exists(destinationPath)) {
@@ -214,10 +236,12 @@ const fetch = {
       .filter(doc => doc && doc.type !== 'tombstone');
   },
 
-  reportsCreatedBy: async (db, contactIds) => {
+  reportsCreatedBy: async (db, contactIds, skip) => {
     const reports = await db.query('medic-client/reports_by_freetext', {
       keys: contactIds.map(id => [`contact:${id}`]),
       include_docs: true,
+      limit: BATCH_SIZE,
+      skip: skip,
     });
 
     return reports.rows.map(row => row.doc);

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