cht-conf 3.10.0 → 3.11.0

package/src/lib/convert-forms.js

@@ -20,25 +20,34 @@ E
 E	pip uninstall pyxform-medic
 E` + INSTALLATION_INSTRUCTIONS;
 
-module.exports = async (projectDir, subDirectory, options) => {
-  if(!options) options = {};
+const FORM_EXTENSION = '.xlsx';
+const formFileMatcher = (fileName) => {
+  if (fileName.endsWith(FORM_EXTENSION) &&
+    !fileName.startsWith('~$') // ignore Excel "owner files"
+    && fileName !== 'PLACE_TYPE-create.xlsx' && fileName !== 'PLACE_TYPE-edit.xlsx') {
+    return fileName.slice(0, fileName.length - FORM_EXTENSION.length);
+  }
+  return null;
+};
+
+const execute = async (projectDir, subDirectory, options) => {
+  if (!options) options = {};
 
   const formsDir = getFormDir(projectDir, subDirectory);
 
-  if(!fs.exists(formsDir)) {
+  if (!fs.exists(formsDir)) {
     warn(`Forms dir not found: ${formsDir}`);
     return Promise.resolve();
   }
 
-  const filesToConvert = argsFormFilter(formsDir, '.xlsx', options)
-    .filter(name => !name.startsWith('~$')) // ignore Excel "owner files"
-    .filter(name => name !== 'PLACE_TYPE-create.xlsx' && name !== 'PLACE_TYPE-edit.xlsx');
+  const filesToConvert = argsFormFilter(formsDir, FORM_EXTENSION, options)
+    .filter(name => formFileMatcher(name));
 
   for (let xls of filesToConvert) {
     const originalSourcePath = `${formsDir}/${xls}`;
     let sourcePath;
 
-    if(options.force_data_node) {
+    if (options.force_data_node) {
       const temporaryPath = `${fs.mkdtemp()}/${options.force_data_node}.xlsx`;
       fs.copy(originalSourcePath, temporaryPath);
       sourcePath = temporaryPath;
@@ -54,15 +63,21 @@ module.exports = async (projectDir, subDirectory, options) => {
   }
 };
 
+module.exports = {
+  SUPPORTED_EXTENSIONS: [FORM_EXTENSION],
+  formFileMatcher,
+  execute
+};
+
 const xls2xform = (sourcePath, targetPath) =>
-    exec([XLS2XFORM, '--skip_validate', sourcePath, targetPath])
-      .catch(e => {
-        if(executableAvailable()) {
-          if(e.includes('unrecognized arguments: --skip_validate')) {
-            throw new Error('Your xls2xform installation appears to be out of date.' + UPDATE_INSTRUCTIONS);
-          } else throw e;
-        } else throw new Error('There was a problem executing xls2xform.  It may not be installed.' + INSTALLATION_INSTRUCTIONS);
-      });
+  exec([XLS2XFORM, '--skip_validate', sourcePath, targetPath])
+    .catch(e => {
+      if (executableAvailable()) {
+        if (e.includes('unrecognized arguments: --skip_validate')) {
+          throw new Error('Your xls2xform installation appears to be out of date.' + UPDATE_INSTRUCTIONS);
+        } else throw e;
+      } else throw new Error('There was a problem executing xls2xform.  It may not be installed.' + INSTALLATION_INSTRUCTIONS);
+    });
 
 // here we fix the form content in arcane ways.  Seeing as we have out own fork
 // of pyxform, we should probably be doing this fixing there.
@@ -72,33 +87,33 @@ const fixXml = (path, hiddenFields, transformer, enketo) => {
   // future changes to the output of xls2xform.
   let xml = fs.read(path)
 
-      // The following copies behaviour from old bash scripts, and will create a
-      // second <meta> element if one already existed.  We may want to actually
-      // merge the two instead.
-      .replace(/<inputs>/, META_XML_SECTION)
+    // The following copies behaviour from old bash scripts, and will create a
+    // second <meta> element if one already existed.  We may want to actually
+    // merge the two instead.
+    .replace(/<inputs>/, META_XML_SECTION)
 
-      // XLSForm does not allow converting a field without a label, so we use
-      // the placeholder NO_LABEL.
-      .replace(/NO_LABEL/g, '')
+    // XLSForm does not allow converting a field without a label, so we use
+    // the placeholder NO_LABEL.
+    .replace(/NO_LABEL/g, '')
 
-      // No comment.
-      .replace(/.*DELETE_THIS_LINE.*(\r|\n)/g, '')
-      ;
+    // No comment.
+    .replace(/.*DELETE_THIS_LINE.*(\r|\n)/g, '')
+    ;
 
   // Enketo _may_ not work with forms which define a default language - see
   // https://github.com/medic/cht-core/issues/3174
-  if(enketo) xml = xml.replace(/ default="true\(\)"/g, '');
+  if (enketo) xml = xml.replace(/ default="true\(\)"/g, '');
 
-  if(hiddenFields) {
+  if (hiddenFields) {
     const r = new RegExp(`<(${hiddenFields.join('|')})(/?)>`, 'g');
     xml = xml.replace(r, '<$1 tag="hidden"$2>');
   }
 
-  if(transformer) xml = transformer(xml, path);
+  if (transformer) xml = transformer(xml, path);
 
 
   // Check for deprecations
-  if(xml.includes('repeat-relevant')) {
+  if (xml.includes('repeat-relevant')) {
     warn('From webapp version 2.14.0, repeat-relevant is no longer required.  See https://github.com/medic/cht-core/issues/3449 for more info.');
   }
 
@@ -106,7 +121,7 @@ const fixXml = (path, hiddenFields, transformer, enketo) => {
 };
 
 function getHiddenFields(propsJson) {
-  if(!fs.exists(propsJson)) return [];
+  if (!fs.exists(propsJson)) return [];
   else return fs.readJson(propsJson).hidden_fields;
 }
 
@@ -116,7 +131,7 @@ function executableAvailable() {
       stdio: ['ignore', 'ignore', 'ignore'],
     });
     return true;
-  } catch(e) {
+  } catch (e) {
     return false;
   }
 }

package/src/lib/git-exec.js

@@ -64,7 +64,7 @@ module.exports.getDefaultRemote = async () => {
 
 /**
  * Returns the upstream of the current branch,
- * in the form of repo/branch, eg. 'origin/master'.
+ * in the form of repo/branch, eg. 'origin/main'.
  *
  * Returns `null` if there are no upstreams repos configured.
  */

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

package/src/lib/project-paths.js

@@ -0,0 +1,12 @@
+const path = require('path');
+// Paths Relative to the Project
+module.exports = {
+    APP_SETTINGS_DIR_PATH: 'app_settings',
+    APP_SETTINGS_JSON_PATH: 'app_settings.json',
+    APP_FORMS_PATH: path.join('forms', 'app'),
+    CONTACT_FORMS_PATH: path.join('forms', 'contact'),
+    COLLECT_FORMS_PATH: path.join('forms', 'collect'),
+    TRANSLATIONS_DIR_PATH: 'translations',
+    RESOURCE_CONFIG_PATH: 'resources.json',
+    RESOURCES_DIR_PATH: 'resources'
+};

package/src/lib/upload-forms.js

@@ -16,18 +16,40 @@ const {
 const validateForms = require('./validate-forms');
 
 const SUPPORTED_PROPERTIES = ['context', 'icon', 'title', 'xml2sms', 'subject_key', 'hidden_fields'];
+const FORM_EXTENSTION = '.xml';
+const FORM_PROPERTIES_EXTENSION = '.properties.json';
+const FORM_MEDIA_MATCHER = /(.+)-media$/;
+const SUPPORTED_EXTENSIONS = [FORM_EXTENSTION, FORM_PROPERTIES_EXTENSION];
+
+const formFileMatcher = (fileName) => {
+  if (fileName.endsWith(FORM_EXTENSTION)) {
+    return fileName.slice(0, fileName.length - FORM_EXTENSTION.length);
+  }
+  if (fileName.endsWith(FORM_PROPERTIES_EXTENSION)) {
+    return fileName.slice(0, fileName.length - FORM_PROPERTIES_EXTENSION.length);
+  }
+  return null;
+};
+
+const formMediaMatcher = (formMediaDir) => {
+  const matchResult = formMediaDir.match(FORM_MEDIA_MATCHER);
+  if (matchResult) {
+    return matchResult[1]; // return the captured form name
+  }
+  return null;
+};
 
-module.exports = async (projectDir, subDirectory, options) => {
+const execute = async (projectDir, subDirectory, options) => {
   await validateForms(projectDir, subDirectory, options);
   const db = pouch();
   if (!options) options = {};
   const formsDir = getFormDir(projectDir, subDirectory);
-  if(!fs.exists(formsDir)) {
+  if (!fs.exists(formsDir)) {
     log.info(`Forms dir not found: ${formsDir}`);
     return;
   }
 
-  const fileNames = argsFormFilter(formsDir, '.xml', options);
+  const fileNames = argsFormFilter(formsDir, FORM_EXTENSTION, options);
   for (const fileName of fileNames) {
     log.info(`Preparing form for upload: ${fileName}…`);
 
@@ -35,7 +57,7 @@ module.exports = async (projectDir, subDirectory, options) => {
     const baseDocId = (options.id_prefix || '') + baseFileName.replace(/-/g, ':');
 
     const mediaDirExists = fs.exists(mediaDir);
-    if(!mediaDirExists) {
+    if (!mediaDirExists) {
       log.info(`No media directory found at ${mediaDir} for form ${xformPath}`);
     }
 
@@ -48,7 +70,7 @@ module.exports = 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 = {
@@ -60,7 +82,7 @@ module.exports = async (projectDir, subDirectory, options) => {
       context: options.default_context,
     };
 
-    const propertiesPath = `${formsDir}/${baseFileName}.properties.json`;
+    const propertiesPath = `${formsDir}/${baseFileName}${FORM_PROPERTIES_EXTENSION}`;
     updateFromPropertiesFile(doc, propertiesPath);
 
     doc._attachments = mediaDirExists ? attachmentsFromDir(mediaDir) : {};
@@ -80,6 +102,14 @@ module.exports = async (projectDir, subDirectory, options) => {
   }
 };
 
+module.exports = {
+  SUPPORTED_EXTENSIONS,
+  FORM_MEDIA_MATCHER,
+  formFileMatcher,
+  formMediaMatcher,
+  execute
+};
+
 const updateFromPropertiesFile = (doc, path) => {
   if (fs.exists(path)) {
 

package/src/lib/validate-app-settings.js

@@ -1,7 +1,7 @@
 const joi = require('@hapi/joi');
 
 const FormsSchema = joi.object().pattern(
-  /\w{1,30}/,
+  joi.string().min(1),
   joi.object({
     meta: joi.object({
       code: joi.string().required(),
@@ -10,7 +10,7 @@ const FormsSchema = joi.object().pattern(
       subject_key: joi.string()
     }).required(),
     fields: joi.object().pattern(
-      /\w{1,30}/,
+      joi.string().min(1),
       joi.object({
         type: joi.string().required(),
         labels: joi.object({