cht-conf 3.10.0 → 3.11.0

package/src/fn/upload-app-forms.js

@@ -1,9 +1,16 @@
 const environment = require('../lib/environment');
-const uploadForms = require('../lib/upload-forms');
+const uploadForms = require('../lib/upload-forms').execute;
+const { APP_FORMS_PATH } = require('../lib/project-paths');
+
+const uploadAppForms = (forms) => {
+  return uploadForms(environment.pathToProject, 'app', {
+    forms: forms,
+  });
+};
 
 module.exports = {
   requiresInstance: true,
-  execute: () => uploadForms(environment.pathToProject, 'app', {
-    forms: environment.extraArgs,
-  })
+  uploadAppForms,
+  APP_FORMS_PATH: APP_FORMS_PATH,
+  execute: () => uploadAppForms(environment.extraArgs)
 };

package/src/fn/upload-app-settings.js

@@ -2,29 +2,35 @@ const api = require('../lib/api');
 const environment = require('../lib/environment');
 const fs = require('../lib/sync-fs');
 const { info } = require('../lib/log');
+const { APP_SETTINGS_DIR_PATH, APP_SETTINGS_JSON_PATH } = require('../lib/project-paths');
 
-module.exports = {
-  requiresInstance: true,
-  execute: () => {
-    const settings = fs.read(`${environment.pathToProject}/app_settings.json`);
-    return api().updateAppSettings(settings)
-      .then(JSON.parse)
-      .then(json => {
-        // As per https://github.com/medic/cht-core/issues/3674, this endpoint
-        // will return 200 even when upload fails.
-        if (!json.success) {
-          throw new Error(json.error);
-        }
+const uploadAppSettings = (api) => {
+  const settings = fs.read(`${environment.pathToProject}/${APP_SETTINGS_JSON_PATH}`);
+  return api.updateAppSettings(settings)
+    .then(JSON.parse)
+    .then(json => {
+      // As per https://github.com/medic/cht-core/issues/3674, this endpoint
+      // will return 200 even when upload fails.
+      if (!json.success) {
+        throw new Error(json.error);
+      }
 
-        if ('updated' in json) {
-          // the `updated` param was added in 3.9
-          // https://github.com/medic/cht-core/issues/6315
-          if (!json.updated) {
-            info('Settings not updated - no changes detected');
-          } else {
-            info('Settings updated successfully');
-          }
+      if ('updated' in json) {
+        // the `updated` param was added in 3.9
+        // https://github.com/medic/cht-core/issues/6315
+        if (!json.updated) {
+          info('Settings not updated - no changes detected');
+        } else {
+          info('Settings updated successfully');
         }
-      });
-  }
+      }
+    });
+};
+
+module.exports = {
+  uploadAppSettings,
+  APP_SETTINGS_DIR_PATH,
+  APP_SETTINGS_JSON_PATH,
+  requiresInstance: true,
+  execute: () => uploadAppSettings(api())
 };

package/src/fn/upload-collect-forms.js

@@ -1,10 +1,15 @@
 const environment = require('../lib/environment');
-const uploadForms = require('../lib/upload-forms');
+const uploadForms = require('../lib/upload-forms').execute;
+
+const uploadCollectForms = (forms) => {
+  return uploadForms(environment.pathToProject, 'collect', {
+    forms: forms,
+    default_context: { collect: true },
+  });
+};
 
 module.exports = {
   requiresInstance: true,
-  execute: () => uploadForms(environment.pathToProject, 'collect', {
-    forms: environment.extraArgs,
-    default_context: { collect:true },
-  })
+  uploadCollectForms,
+  execute: () => uploadCollectForms(environment.extraArgs)
 };

package/src/fn/upload-contact-forms.js

@@ -1,11 +1,18 @@
 const environment = require('../lib/environment');
-const uploadForms = require('../lib/upload-forms');
+const uploadForms = require('../lib/upload-forms').execute;
+const CONTACT_FORMS_PATH = require('../lib/project-paths');
+
+const uploadContactForms = (forms) => {
+  return uploadForms(environment.pathToProject, 'contact', {
+    id_prefix: 'contact:',
+    forms: forms,
+    default_context: { person: false, place: false },
+  });
+};
 
 module.exports = {
   requiresInstance: true,
-  execute: () => uploadForms(environment.pathToProject, 'contact', {
-    id_prefix: 'contact:',
-    forms: environment.extraArgs,
-    default_context: { person:false, place:false },
-  })
+  uploadContactForms,
+  CONTACT_FORMS_PATH,
+  execute: () => uploadContactForms(environment.extraArgs)
 };

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

@@ -13,10 +13,12 @@ const {
   TranslationException
 } = require('@medic/translation-checker');
 
+const { TRANSLATIONS_DIR_PATH } = require('../lib/project-paths');
+
 const execute = async () => {
   const db = pouch(environment.apiUrl);
 
-  const dir = `${environment.pathToProject}/translations`;
+  const dir = `${environment.pathToProject}/${TRANSLATIONS_DIR_PATH}`;
 
   let fileNames;
   let formatErrorsFound = 0;
@@ -65,8 +67,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 +78,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);
@@ -87,7 +87,7 @@ const execute = async () => {
       languageName = 'TODO: please ask admin to set this in settings UI';
     } else {
       let languageNativeName = iso639.getNativeName(languageCode);
-      if (languageNativeName !== languageName){
+      if (languageNativeName !== languageName) {
         languageName = `${languageNativeName} (${languageName})`;
       }
     }
@@ -97,7 +97,7 @@ const execute = async () => {
     let doc;
     try {
       doc = await db.get(id);
-    } catch(e) {
+    } catch (e) {
       if (e.status === 404) {
         doc = await newDocFor(fileName, db, languageName, languageCode);
       }
@@ -129,7 +129,7 @@ function parse(filePath, options) {
 }
 
 function overwriteProperties(doc, props) {
-  if(doc.generic) {
+  if (doc.generic) {
     // 3.4.0 translation structure
     doc.custom = props;
   } else if (doc.values) {
@@ -181,5 +181,6 @@ async function genericTranslationsStructure(db) {
 
 module.exports = {
   requiresInstance: true,
+  TRANSLATIONS_DIR_PATH,
   execute
 };

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/fn/upload-resources.js

@@ -6,13 +6,17 @@ const processJson = (json) => {
     resources: json
   };
 };
+const { RESOURCE_CONFIG_PATH, RESOURCES_DIR_PATH } = require('../lib/project-paths');
 
 module.exports = {
   requiresInstance: true,
+  RESOURCE_CONFIG_PATH,
+  RESOURCES_DIR_PATH,
   execute: () => {
-    const configurationPath = `${environment.pathToProject}/resources.json`;
-    const directoryPath = `${environment.pathToProject}/resources`;
+    const configurationPath = `${environment.pathToProject}/${RESOURCE_CONFIG_PATH}`;
+    const directoryPath = `${environment.pathToProject}/${RESOURCES_DIR_PATH}`;
 
     return uploadConfigurationDocs(configurationPath, directoryPath, 'resources', processJson);
   }
 };
+

package/src/fn/watch-project.js

@@ -0,0 +1,271 @@
+const environment = require('../lib/environment');
+const process = require('process');
+const path = require('path');
+const fs = require('fs');
+const { error, warn, info } = require('../lib/log');
+const Queue = require('queue-promise');
+const watcher = require('@parcel/watcher');
+const { uploadAppForms } = require('./upload-app-forms');
+const { uploadContactForms } = require('./upload-contact-forms');
+const { uploadCollectForms } = require('./upload-collect-forms');
+const convertForms = require('../lib/convert-forms');
+const uploadForms = require('../lib/upload-forms');
+const { deleteForms } = require('../fn/delete-forms');
+const { convertAppForms, APP_FORMS_PATH } = require('./convert-app-forms');
+const { convertContactForm, CONTACT_FORMS_PATH } = require('./convert-contact-forms');
+const { convertCollectForms, COLLECT_FORMS_PATH } = require('./convert-collect-forms');
+const { uploadAppSettings, APP_SETTINGS_DIR_PATH, APP_SETTINGS_JSON_PATH } = require('./upload-app-settings');
+const { execute: compileAppSettings, configFileMatcher } = require('./compile-app-settings');
+const { execute: uploadCustomTranslations, TRANSLATIONS_DIR_PATH } = require('./upload-custom-translations');
+const { execute: uploadResources, RESOURCES_DIR_PATH, RESOURCE_CONFIG_PATH } = require('./upload-resources');
+
+const watcherEvents = {
+    CreateEvent: 'create',
+    DeleteEvent: 'delete',
+    UpdateEvent: 'update'
+};
+
+const uploadInitialState = async (api) => {
+    await uploadResources();
+    await uploadAppForms(environment.extraArgs);
+    await uploadContactForms(environment.extraArgs);
+    await uploadCustomTranslations();
+    await uploadAppSettings(api);
+};
+
+let fsEventsSubscription;
+let eventQueue;
+
+const cleanUp = async () => {
+    if (fsEventsSubscription) {
+        await fsEventsSubscription.unsubscribe();
+        fsEventsSubscription = undefined;
+    }
+    if (eventQueue) {
+        await eventQueue.clear();
+        eventQueue = undefined;
+    }
+};
+
+const waitForKillSignal = () => {
+    return new Promise((resolve) => {
+        process.on('SIGINT', async () => {
+            await cleanUp();
+            resolve();
+        });
+    });
+};
+
+const deleteForm = (fileName, formDir) => {
+    const form = uploadForms.formFileMatcher(fileName) || convertForms.formFileMatcher(fileName);
+    if (!form) {
+        return false;
+    }
+    const absFormDirPath = path.join(environment.pathToProject, formDir);
+    const formFiles = fs.readdirSync(absFormDirPath).map(file => (uploadForms.formFileMatcher(file) || convertForms.formFileMatcher(file))).filter(_form => _form === form);
+    const canDelete = formFiles.length <= 0;
+    if (canDelete) {
+        eventQueue.enqueue(async () => {
+            await deleteForms([form]);
+            return fileName;
+        });
+        return true;
+    }
+    warn(`You have to delete all form files (.xlsx, .properties.json, .xml) associated with the ${form} form to delete it from ${environment.apiUrl}`);
+    return false;
+};
+
+const processAppForm = (eventType, fileName) => {
+    if (eventType === watcherEvents.DeleteEvent && deleteForm(fileName, APP_FORMS_PATH)) {
+        return true;
+    }
+    let form = uploadForms.formFileMatcher(fileName);
+    if (form) {
+        eventQueue.enqueue(async () => {
+            await uploadAppForms([form]);
+            return fileName;
+        });
+        return true;
+    }
+
+    form = convertForms.formFileMatcher(fileName);
+    if (form) {
+        eventQueue.enqueue(async () => {
+            await convertAppForms([form]);
+            return fileName;
+        });
+        return true;
+    }
+    return false;
+};
+
+const processAppFormMedia = (formMediaDir, fileName) => {
+    const form = uploadForms.formMediaMatcher(formMediaDir);
+    if (form) {
+        eventQueue.enqueue(async () => {
+            await uploadAppForms([form]);
+            return fileName;
+        });
+        return true;
+    }
+    return false;
+};
+
+const processContactForm = (eventType, fileName) => {
+    if (eventType === watcherEvents.DeleteEvent && deleteForm(fileName, CONTACT_FORMS_PATH)) {
+        return true;
+    }
+    let form = convertForms.formFileMatcher(fileName);
+    if (form) {
+        eventQueue.enqueue(async () => {
+            await convertContactForm([form]);
+            return fileName;
+        });
+        return true;
+    }
+
+    form = uploadForms.formFileMatcher(fileName);
+    if (form) {
+        eventQueue.enqueue(async () => {
+            await uploadContactForms([form]);
+            return fileName;
+        });
+        return true;
+    }
+    return false;
+};
+
+const processCollectForm = (eventType, fileName) => {
+    if (eventType === watcherEvents.DeleteEvent && deleteForm(fileName, COLLECT_FORMS_PATH)) {
+        return true;
+    }
+    let form = uploadForms.formFileMatcher(fileName);
+    if (form) {
+        eventQueue.enqueue(async () => {
+            await uploadCollectForms([form]);
+            return fileName;
+        });
+        return true;
+    }
+
+    form = convertForms.formFileMatcher(fileName);
+    if (form) {
+        eventQueue.enqueue(async () => {
+            await convertCollectForms([form]);
+            return fileName;
+        });
+        return true;
+    }
+    return false;
+};
+
+const processConfigFiles = (api, fileName) => {
+    if (fileName === APP_SETTINGS_JSON_PATH) {
+        eventQueue.enqueue(async () => {
+            await uploadAppSettings(api);
+            return fileName;
+        });
+        return true;
+    }
+    if (configFileMatcher(fileName)) {
+        eventQueue.enqueue(async () => {
+            await compileAppSettings();
+            return fileName;
+        });
+        return true;
+    }
+    return false;
+};
+
+const watchProject = {
+    watch: async (api, blockFn, callback = {}, uploadStateOnStart = false) => {
+        if (uploadStateOnStart) {
+            await uploadInitialState(api);
+            info('Initial State Uploaded');
+        }
+
+        eventQueue = new Queue({ concurrent: 1, start: true });
+
+        fsEventsSubscription = await watcher.subscribe(environment.pathToProject, async (err, events) => {
+            if (err) {
+                error(err);
+                return;
+            }
+            for (const event of events) {
+                const changePath = event.path;
+                const parsedPath = path.parse(changePath);
+                const fileName = parsedPath.base;
+
+                if (parsedPath.dir === path.join(environment.pathToProject, APP_FORMS_PATH)) {
+                    processAppForm(event.type, fileName);
+                    continue;
+                }
+
+                if (parsedPath.dir.startsWith(path.join(environment.pathToProject, APP_FORMS_PATH))
+                    && path.parse(parsedPath.dir).dir.endsWith(APP_FORMS_PATH)) { // check if the directory's immediate parent is forms/app
+                    const dirName = path.parse(parsedPath.dir).base;
+                    processAppFormMedia(dirName, fileName);
+                    continue;
+                }
+
+                if (parsedPath.dir === path.join(environment.pathToProject, CONTACT_FORMS_PATH)) {
+                    processContactForm(event.type, fileName);
+                    continue;
+                }
+
+                if (parsedPath.dir === path.join(environment.pathToProject, COLLECT_FORMS_PATH)) {
+                    processCollectForm(event.type, fileName);
+                    continue;
+                }
+
+
+                if (parsedPath.dir === path.join(environment.pathToProject, TRANSLATIONS_DIR_PATH)) {
+                    eventQueue.enqueue(async () => {
+                        await uploadCustomTranslations();
+                        return fileName;
+                    });
+                    continue;
+                }
+
+                if (parsedPath.dir === path.join(environment.pathToProject, APP_SETTINGS_DIR_PATH)) {
+                    processConfigFiles(api, fileName);
+                    continue;
+                }
+
+                if (parsedPath.dir === environment.pathToProject && parsedPath.base !== RESOURCE_CONFIG_PATH) {
+                    processConfigFiles(api, fileName);
+                    continue;
+                }
+
+                if (parsedPath.base === RESOURCE_CONFIG_PATH || parsedPath.dir === path.join(environment.pathToProject, RESOURCES_DIR_PATH)) {
+                    eventQueue.enqueue(async () => {
+                        await uploadResources();
+                        return fileName;
+                    });
+                    continue;
+                }
+            }
+        });
+
+        eventQueue.on('resolve', file => {
+            if (callback) {
+                callback(file);
+            }
+        });
+        eventQueue.on('reject', err => error('watch-mode: Error while processing change,', err));
+
+        info('watching', environment.pathToProject, 'for changes');
+        await blockFn();
+    },
+    close: async () => {
+        info('stopping watchers');
+        await cleanUp();
+    }
+};
+
+const api = require('../lib/api');
+module.exports = {
+    watchProject,
+    requiresInstance: true,
+    execute: () => watchProject.watch(api(), waitForKillSignal, false, true)
+};

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.');
     }
   },