cht-conf 4.4.1 → 4.6.0

package/src/lib/parse-purge.js

@@ -14,7 +14,10 @@ module.exports = (projectDir) => {
   const purgingExists = fs.exists(purgingPath);
 
   if (purgeExists && purgingExists) {
-    throwError(`Purge is defined at both ${purgePath} and ${purgingPath}. Using 'purging.js' is deprecated. Create a 'purge.js' file instead.`);
+    throwError(
+      `Purge is defined at both ${purgePath} and ${purgingPath}. `
+      + `Using 'purging.js' is deprecated. Create a 'purge.js' file instead.`
+    );
   }
 
   let purgeConfig;
@@ -50,9 +53,8 @@ module.exports = (projectDir) => {
     }
 
     if (typeof purgeFn !== 'function') {
-      throwError('Configured purging.js does not contain a function');
+      throwError('Configured purge file does not contain a function');
     }
-
     const appSettings = fs.readJson(path.join(projectDir, 'app_settings.json'));
     purgeConfig = appSettings.purging || {};
     purgeConfig.fn = purgeFnString;

package/src/lib/parse-targets.js

@@ -27,7 +27,9 @@ module.exports = projectDir => {
     throwError(`Targets are defined at both ${jsonPath} and ${jsPath}.  Only one of these files should exist.`);
   }
 
-  if (jsonExists) return fs.readJson(jsonPath);
+  if (jsonExists) {
+    return fs.readJson(jsonPath);
+  }
 
   const pathToTargetJs = path.join(projectDir, 'targets.js');
   const targets = require(pathToTargetJs);

package/src/lib/polyfill.js

@@ -1,2 +1,4 @@
-if(!Object.values) Object.values = o =>
+if(!Object.values) {
+  Object.values = o =>
     Object.keys(o).map(k => o[k]);
+}

package/src/lib/progress-bar.js

@@ -2,20 +2,21 @@
 module.exports = {
   init: function(target, prefix, suffix) {
     let runningTotal = 0;
-    let startTime = Date.now();
+    const startTime = Date.now();
 
     function print() {
-      let bar = '', i;
+      let bar = '';
+      let i;
 
       const timeTaken = Date.now() - startTime;
       const timeLeft = Math.floor(timeTaken * (target - runningTotal) / (runningTotal * 1000));
 
       const format = message => message
-          .replace('{{n}}', runningTotal)
-          .replace('{{N}}', target)
-          .replace('{{s}}', () => roundAndPad(timeLeft % 60))
-          .replace('{{m}}', () => roundAndPad(timeLeft / 60, 1))
-          .replace('{{%}}', () => roundAndPad(runningTotal * 100 / target, 3, ' ') + '%');
+        .replace('{{n}}', runningTotal)
+        .replace('{{N}}', target)
+        .replace('{{s}}', () => roundAndPad(timeLeft % 60))
+        .replace('{{m}}', () => roundAndPad(timeLeft / 60, 1))
+        .replace('{{%}}', () => roundAndPad(runningTotal * 100 / target, 3, ' ') + '%');
 
       const fPrefix = prefix ? format(prefix) : '';
       const fSuffix = suffix ? format(suffix) : '';
@@ -23,9 +24,13 @@ module.exports = {
       const barTotal = process.stdout.columns - fPrefix.length - fSuffix.length - 3;
       const pBarLen = Math.floor(runningTotal * barTotal / target);
 
-      for(i=pBarLen; i>0; --i) bar += '█';
+      for(i=pBarLen; i>0; --i) {
+        bar += '█';
+      }
 
-      for(i=barTotal-pBarLen; i>0; --i) bar += ' ';
+      for(i=barTotal-pBarLen; i>0; --i) {
+        bar += ' ';
+      }
 
       process.stdout.write(`\r${fPrefix}[${bar}]${fSuffix}`);
     }
@@ -41,15 +46,23 @@ module.exports = {
 };
 
 function roundAndPad(n, digits, padWith) {
-  if(typeof digits === 'undefined') digits = 2;
-  if(typeof padWith === 'undefined') padWith = '0';
+  if(typeof digits === 'undefined') {
+    digits = 2;
+  }
+  if(typeof padWith === 'undefined') {
+    padWith = '0';
+  }
   n = Math.round(n);
   let s;
-  if(Number.isFinite(n)) s = n.toString();
+  if(Number.isFinite(n)) {
+    s = n.toString();
+  }
   else {
     padWith = '?';
     s = '';
   }
-  while(s.length < digits) s = padWith + s;
+  while(s.length < digits) {
+    s = padWith + s;
+  }
   return s;
 }

package/src/lib/skip-fn.js

@@ -2,11 +2,13 @@ const warn = require('./log').warn;
 
 module.exports = reason => {
   const fnName = new Error().stack.split('\n')
-      .filter(s => s.includes('fn'))[1]
-      .match('/fn/([a-z-]+)\.js')[1]; // eslint-disable-line no-useless-escape
+    .filter(s => s.includes('fn'))[1]
+    .match('/fn/([a-z-]+)\.js')[1]; // eslint-disable-line no-useless-escape
 
   let warning = `Skipping action: ${fnName}`;
-  if(reason) warning += ` (${reason})`;
+  if(reason) {
+    warning += ` (${reason})`;
+  }
   warn(warning);
 
   return Promise.resolve();

package/src/lib/sync-fs.js

@@ -18,7 +18,9 @@ function read(path) {
 
 function readCsv(path) {
   const raw = csvParse(read(path));
-  if(!raw.length) return { cols:[], rows:[] };
+  if(!raw.length) {
+    return { cols:[], rows:[] };
+  }
   return {
     cols: raw[0],
     rows: raw.slice(1),
@@ -36,14 +38,16 @@ function readJson(path) {
 
 function dirs(dir) {
   return fs
-      .readdirSync(dir)
-      .filter(file => fs
-          .statSync(path.join(dir, file))
-          .isDirectory());
+    .readdirSync(dir)
+    .filter(file => fs
+      .statSync(path.join(dir, file))
+      .isDirectory());
 }
 
 function recurseFiles(dir, files) {
-  if(!files) files = [];
+  if(!files) {
+    files = [];
+  }
 
   fs.readdirSync(dir)
     .filter(name => !name.startsWith('.'))
@@ -52,11 +56,19 @@ function recurseFiles(dir, files) {
       try {
         const stat = fs.statSync(f);
 
-        if(stat.isDirectory()) recurseFiles(f, files);
-        else files.push(f);
+        if(stat.isDirectory()) {
+          recurseFiles(f, files);
+        }
+        else {
+          files.push(f);
+        }
       } catch(e) {
-        if(e.code === 'ENOENT') trace('Ignoring file (err ENOENT - may be a symlink):', f);
-        else throw e;
+        if(e.code === 'ENOENT') {
+          trace('Ignoring file (err ENOENT - may be a symlink):', f);
+        }
+        else {
+          throw e;
+        }
       }
     });
 
@@ -66,8 +78,8 @@ function recurseFiles(dir, files) {
 function extension(fileName) {
   const extensionStart = fileName.lastIndexOf('.');
   return extensionStart === -1 ?
-      fileName :
-      fileName.substring(extensionStart+1);
+    fileName :
+    fileName.substring(extensionStart+1);
 }
 
 function withoutExtension(fileName) {

package/src/lib/upload-forms.js

@@ -15,6 +15,7 @@ const {
 } = require('./forms-utils');
 
 const SUPPORTED_PROPERTIES = ['context', 'icon', 'title', 'xml2sms', 'subject_key', 'hidden_fields'];
+const CONTACT_DUPLICATE_CHECK_PROPERTY = 'duplicate_check';
 const FORM_EXTENSTION = '.xml';
 const FORM_PROPERTIES_EXTENSION = '.properties.json';
 const FORM_MEDIA_MATCHER = /(.+)-media$/;
@@ -40,13 +41,20 @@ const formMediaMatcher = (formMediaDir) => {
 
 const execute = async (projectDir, subDirectory, options) => {
   const db = pouch();
-  if (!options) options = {};
+  if (!options) {
+    options = {};
+  }
   const formsDir = getFormDir(projectDir, subDirectory);
   if (!fs.exists(formsDir)) {
     log.info(`Forms dir not found: ${formsDir}`);
     return;
   }
 
+  const PROPERTIES = [...SUPPORTED_PROPERTIES];
+  if (subDirectory === 'contact') {
+    PROPERTIES.push(CONTACT_DUPLICATE_CHECK_PROPERTY);
+  }
+
   const fileNames = argsFormFilter(formsDir, FORM_EXTENSTION, options);
   for (const fileName of fileNames) {
     log.info(`Preparing form for upload: ${fileName}…`);
@@ -68,7 +76,9 @@ const execute = async (projectDir, subDirectory, options) => {
     };
 
     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.');
+    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.');
+    }
 
     const docId = `form:${baseDocId}`;
     const doc = {
@@ -81,12 +91,12 @@ const execute = async (projectDir, subDirectory, options) => {
     };
 
     const propertiesPath = `${formsDir}/${baseFileName}${FORM_PROPERTIES_EXTENSION}`;
-    updateFromPropertiesFile(doc, propertiesPath);
+    updateFromPropertiesFile(doc, propertiesPath, PROPERTIES);
 
     doc._attachments = mediaDirExists ? attachmentsFromDir(mediaDir) : {};
     doc._attachments.xml = attachmentFromFile(xformPath);
 
-    const properties = SUPPORTED_PROPERTIES.concat('internalId');
+    const properties = PROPERTIES.concat('internalId');
 
     const changes = await warnUploadOverwrite.preUploadForm(db, doc, xml, properties);
     if (changes) {
@@ -108,15 +118,15 @@ module.exports = {
   execute
 };
 
-const updateFromPropertiesFile = (doc, path) => {
+const updateFromPropertiesFile = (doc, path, supported_properties) => {
   if (fs.exists(path)) {
 
-    let ignoredKeys = [];
+    const ignoredKeys = [];
     const properties = fs.readJson(path);
 
     Object.keys(properties).forEach(key => {
       if (typeof properties[key] !== 'undefined') {
-        if (SUPPORTED_PROPERTIES.includes(key)) {
+        if (supported_properties.includes(key)) {
           doc[key] = properties[key];
         } else if (key === 'internalId') {
           log.warn(`DEPRECATED: ${path}. Please do not manually set internalId in .properties.json for new projects. Support for configuring this value will be dropped. Please see https://github.com/medic/cht-core/issues/3342.`);

package/src/lib/validation/form/can-generate-xform.js

@@ -7,7 +7,9 @@ module.exports = {
     try {
       const resp = await api().formsValidate(xmlStr);
       if (resp.formsValidateEndpointFound === false) {
-        warnings.push('Form validation endpoint not found in your version of CHT Core, no form will be checked before push');
+        warnings.push(
+          'Form validation endpoint not found in your version of CHT Core, no form will be checked before push'
+        );
       }
     } catch (err) {
       errors.push(`Error found while validating "${xformPath}". Validation response: ${err.message}`);

package/src/lib/validation/form/check-xpaths-exist.js

@@ -21,9 +21,11 @@ const UNSUPPORTED_CHAR = '[*@:[\\]]';
 const XPATH_CHAR = `(${SUPPORTED_CHAR}|${UNSUPPORTED_CHAR})`;
 // Some XPaths lookup nodes in separate instances (e.g. instance('contact-summary')/context/pregnancy_uuid)
 const INSTANCE = `instance\\([\\w-'"]+\\)`;
-// Look ahead and make sure there are an even number of quotes following the match (this means that the match itself is not in quotes).
+// Look ahead and make sure there are an even number of quotes following the match
+// (this means that the match itself is not in quotes).
 const LOOK_AHEADS_FOR_EVEN_QUOTES = `(?=([^"]*"[^"]*")*[^"]*$)(?=([^']*'[^']*')*[^']*$)`;
-// Matches on all possible XPaths (simple and complex) not in quotes. May start with an instance reference. Must include a slash.
+// Matches on all possible XPaths (simple and complex) not in quotes. May start with an instance reference.
+// Must include a slash.
 const XPATH_PATTERN = new RegExp(`(${INSTANCE}|)${XPATH_CHAR}*\\/${XPATH_CHAR}+${LOOK_AHEADS_FOR_EVEN_QUOTES}`, 'g');
 // Matches on XPaths containing complex calculations (note that '//' indicates a deep lookup, which we do not validate)
 const UNSUPPORTED_XPATH_PATTERN = new RegExp(`\\/\\/|${UNSUPPORTED_CHAR}|${INSTANCE}`, 'g');
@@ -97,7 +99,10 @@ module.exports = {
     try {
       const fields = getFieldsWithInvalidXPaths(xmlDoc);
       if(fields.length) {
-        errors.push(`Form at ${xformPath} contains invalid XPath expressions (absolute or relative paths that refer to a non-existant node):`);
+        errors.push(
+          `Form at ${xformPath} contains invalid XPath expressions `
+          + '(absolute or relative paths that refer to a non-existant node):'
+        );
 
         fields.forEach(field => {
           const recordError = (expressionName) => {

package/src/lib/validation/form/deprecated-appearance.js

@@ -24,6 +24,11 @@ const getDeprecatedAppearances = (apiVersion) => [
     getReplacement: () => 'columns-pack no-buttons',
     versionDeprecated: '4.0.0'
   },
+  {
+    match: appearance => appearance.match(/(?:^|\s)db-object(?:$|\s)/),
+    getReplacement: () => 'select-contact',
+    versionDeprecated: '3.9.0'
+  },
 ].filter(deprecatedAppearance => semver.gte(apiVersion, deprecatedAppearance.versionDeprecated));
 
 const getElementsWithAppearance = (xmlDoc) => getNodes(xmlDoc, '/h:html/h:body//*[@appearance]');
@@ -53,8 +58,9 @@ const createWarning = ({ ref, appearance, deprecatedAppearance }) => {
 
 const populateWarningHeader = (xformPath, warnings) => {
   if (warnings.length) {
-    warnings.unshift(`Form at ${xformPath} contains fields with the deprecated \`horizontal\`/\`compact\` appearance. ` +
-      'These have been deprecated in favor of the `columns` appearance. Please update the following fields:');
+    warnings.unshift(
+      `Form at ${xformPath} contains fields with a deprecated appearance. Please update the following:`
+    );
   }
 };
 

package/src/lib/validation/form/has-instance-id.js

@@ -6,7 +6,10 @@ module.exports = {
   execute: async({ xformPath, xmlDoc }) => {
     const errors = [];
     if(!formHasInstanceId(xmlDoc)) {
-      errors.push(`Form at ${xformPath} appears to be missing <meta><instanceID/></meta> node. This form will not work on CHT webapp.`);
+      errors.push(
+        `Form at ${xformPath} appears to be missing <meta><instanceID/></meta> node. `
+        + 'This form will not work on CHT webapp.'
+      );
     }
 
     return { errors, warnings: [] };

package/src/lib/validation/form/no-required-notes.js

@@ -16,7 +16,10 @@ module.exports = {
       .filter(bind => !bind.getAttribute('calculate'))
       .map(bind => bind.getAttribute('nodeset'));
     if(requiredNotes.length) {
-      errors.push(`Form at ${xformPath} contains the following note fields with 'required' expressions: [${requiredNotes.join(', ')}]`);
+      errors.push(
+        `Form at ${xformPath} contains the following note fields with 'required' expressions: `
+        + `[${requiredNotes.join(', ')}]`
+      );
     }
     return { errors, warnings: [] };
   }

package/src/lib/warn-upload-overwrite.js

@@ -10,7 +10,8 @@ const environment = require('./environment');
 const { compare, GroupingReporter } = require('dom-compare');
 const DOMParser = require('@xmldom/xmldom').DOMParser;
 
-const question = 'You are trying to modify a configuration that has been modified since your last upload. Do you want to?';
+const question = 'You are trying to modify a configuration that has been modified since your last upload. ' +
+  'Do you want to?';
 const responseChoicesWithoutDiff = [
   'Overwrite the changes', 
   'Abort so that you can update the configuration'
@@ -110,7 +111,7 @@ const getDocHash = async (db, originalDoc) => {
     for (const attachmentName of Object.keys(originalDoc._attachments)) {
       const attachment = originalDoc._attachments[attachmentName];
       const attachmentCompressible = compressibleTypes.length ?
-          compressibleTypes.some(c => matchRegex(c, attachment.content_type)) : true;
+        compressibleTypes.some(c => matchRegex(c, attachment.content_type)) : true;
       if (attachmentCompressible) {
         const data = attachment.data ? attachment.data : await db.getAttachment(originalDoc._id, attachmentName);
         crypt.update(data);
@@ -196,7 +197,9 @@ const preUploadForm = async (db, localDoc, localXml, properties) => {
     } else {
       // Unexpected error, we report it then quit
       log.trace('Trying to fetch remote xml', e);
-      throw new Error(`Unable to fetch xml attachment of doc with id ${localDoc._id}, returned status code = ${e.status}`);
+      throw new Error(
+        `Unable to fetch xml attachment of doc with id ${localDoc._id}, returned status code = ${e.status}`
+      );
     }
   }