cht-conf 3.18.2 → 3.19.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [3.19.0](https://github.com/medic/cht-conf/compare/v3.18.3...v3.19.0) (2023-10-17)
+
+
+### Features
+
+* **#580:** publish recent commits to npm ([db734e1](https://github.com/medic/cht-conf/commit/db734e1818f8501988a5457237dc32c5667b368c)), closes [#580](https://github.com/medic/cht-conf/issues/580)
+
+## [3.18.3](https://github.com/medic/cht-conf/compare/v3.18.2...v3.18.3) (2023-04-27)
+
+
+### Bug Fixes
+
+* **#554:** revert change to docker creds after fixing Hub perms ([#559](https://github.com/medic/cht-conf/issues/559)) ([f0ea5ea](https://github.com/medic/cht-conf/commit/f0ea5ea7330d5c5cd9e1516da1f2b60ec85bfc24)), closes [#554](https://github.com/medic/cht-conf/issues/554)
+
 ## [3.18.2](https://github.com/medic/cht-conf/compare/v3.18.1...v3.18.2) (2023-04-27)
 
 

package/README.md

@@ -343,7 +343,7 @@ Builds brought to you courtesy of GitHub actions.
 
 # Copyright
 
-Copyright 2013-2022 Medic Mobile, Inc. <hello@medic.org>
+Copyright 2013-2023 Medic Mobile, Inc. <hello@medic.org>
 
 # License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cht-conf",
-  "version": "3.18.2",
+  "version": "3.19.0",
   "description": "Configure CHT deployments",
   "main": "./src/lib/main.js",
   "engines": {
@@ -35,7 +35,7 @@
   },
   "homepage": "https://github.com/medic/cht-conf#readme",
   "dependencies": {
-    "@hapi/joi": "^16.1.8",
+    "joi": "^17.9.2",
     "@medic/translation-checker": "^1.0.1",
     "@parcel/watcher": "^2.0.5",
     "@xmldom/xmldom": "^0.8.2",

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

@@ -1,16 +1,16 @@
 const minimist = require('minimist');
 const path = require('path');
-const compileContactSummary = require('../lib/compile-contact-summary');
-const compileNoolsRules = require('../lib/compile-nools-rules');
+
+const compilation = require('../lib/compilation');
 const environment = require('../lib/environment');
 const fs = require('../lib/sync-fs');
+const parsePurge = require('../lib/parse-purge');
 const parseTargets = require('../lib/parse-targets');
 const { warn } = require('../lib/log');
-const parsePurge = require('../lib/parse-purge');
 const validateAppSettings = require('../lib/validate-app-settings');
 const { APP_SETTINGS_DIR_PATH, APP_SETTINGS_JSON_PATH } = require('../lib/project-paths');
 
-// we can't used named capture groups yet
+// we can't use named capture groups yet
 const JS_FILE_MATCHER = /^(.+)(\.js)$/; // 2 groups get the file name and extension
 const JSON_FILE_MATCHER = /^(.+)(\.json)$/;
 const configFileMatcher = (fileName) => {
@@ -100,9 +100,11 @@ const compileAppSettingsForProject = async (projectDir, options) => {
     Please create a base_settings.json file in app_settings folder and move any manually defined configurations there.`);
     appSettings = fs.readJson(appSettingsPath);
   }
-  appSettings.contact_summary = await compileContactSummary(projectDir, options);
+  appSettings.contact_summary = await compilation.compileContactSummary(projectDir, options);
+  const compiledTasksAndTargets = await compilation.compileTasksAndTargets(projectDir, options);
   appSettings.tasks = {
-    rules: await compileNoolsRules(projectDir, options),
+    rules: compiledTasksAndTargets.rules,
+    isDeclarative: compiledTasksAndTargets.isDeclarative,
     schedules: readOptionalJson(taskSchedulesPath),
     targets: parseTargets(projectDir),
   };

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

@@ -1,32 +1,53 @@
+const semver = require('semver');
+
 const api = require('../lib/api');
 const environment = require('../lib/environment');
 const fs = require('../lib/sync-fs');
+const { getValidApiVersion } = require('../lib/get-api-version');
 const { info } = require('../lib/log');
+const nools = require('../lib/nools-utils');
 const { APP_SETTINGS_DIR_PATH, APP_SETTINGS_JSON_PATH } = require('../lib/project-paths');
 
-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);
-      }
+const uploadAppSettings = async api => {
+  const appSettings = JSON.parse(fs.read(`${environment.pathToProject}/${APP_SETTINGS_JSON_PATH}`));
+  await augmentDeclarativeWithNoolsBoilerplate(appSettings);
+  
+  const requestResult = await api.updateAppSettings(JSON.stringify(appSettings));
+  const json = JSON.parse(requestResult);
+  // 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');
+    }
+  }
 };
 
+// https://github.com/medic/cht-core/issues/6506 added in 4.2
+// augmented during upload so compile-app-settings doesn't require a url on the command-line
+async function augmentDeclarativeWithNoolsBoilerplate(appSettings) {
+  if (!appSettings || !appSettings.tasks || !appSettings.tasks.isDeclarative) {
+    return;
+  }
+
+  const actualCoreVersion = await getValidApiVersion(appSettings);
+  const addNoolsBoilerplate = semver.lt(actualCoreVersion, '4.2.0-dev');
+  if (addNoolsBoilerplate) {
+    appSettings.tasks.rules = nools.addBoilerplateToCode(appSettings.tasks.rules);
+
+    // do not set the isDeclarative flag when the code has nools boilerplate
+    delete appSettings.tasks.isDeclarative;
+  }
+}
+
 module.exports = {
   uploadAppSettings,
   APP_SETTINGS_DIR_PATH,

package/src/lib/{compile-contact-summary.js → compilation/compile-contact-summary.js}

@@ -1,6 +1,6 @@
 const path = require('path');
-const fs = require('./sync-fs');
-const pack = require('../lib/package-lib');
+const fs = require('../sync-fs');
+const pack = require('./package-lib');
 
 module.exports = async (projectDir, options) => {
   const freeformPath = `${projectDir}/contact-summary.js`;
@@ -12,8 +12,8 @@ module.exports = async (projectDir, options) => {
   if (!freeformPathExists && !structuredPathExists) throw new Error(`Could not find contact-summary javascript at either of ${freeformPath} or ${structuredPath}.  Please create one xor other of these files.`);
   if (freeformPathExists && structuredPathExists) throw new Error(`Found contact-summary javascript at both ${freeformPath} and ${structuredPath}.  Only one of these files should exist.`);
 
-  const baseEslintPath = path.join(__dirname, '../contact-summary/.eslintrc');
-  const pathToDeclarativeLib = path.join(__dirname, '../contact-summary/lib.js');
+  const baseEslintPath = path.join(__dirname, '../../contact-summary/.eslintrc');
+  const pathToDeclarativeLib = path.join(__dirname, '../../contact-summary/lib.js');
   const pathToPack = freeformPathExists ? freeformPath : pathToDeclarativeLib;
   
   /*

package/src/lib/{compile-nools-rules.js → compilation/compile-tasks-and-targets.js}

@@ -1,13 +1,13 @@
 const path = require('path');
 
-const fs = require('./sync-fs');
+const fs = require('../sync-fs');
 const pack = require('./package-lib');
-const minifyNools = require('./minify-nools');
+const nools = require('../nools-utils');
 const validateDeclarativeSchema = require('./validate-declarative-schema');
 
 const DECLARATIVE_NOOLS_FILES = [ 'tasks.js', 'targets.js' ];
 
-const compileNoolsRules = async (projectDir, options = {}) => {
+const compileTasksAndTargets = async (projectDir, options = {}) => {
   const tryLoadLegacyRules = legacyNoolsFilePath => {
     let result;
     if (fs.exists(legacyNoolsFilePath)) {
@@ -25,10 +25,14 @@ const compileNoolsRules = async (projectDir, options = {}) => {
       throw new Error(`Both legacy and declarative files found. You should either have rules.nools.js xor ${DECLARATIVE_NOOLS_FILES} files.`);
     }
 
-    return options.minifyScripts ? minifyNools(legacyRules) : legacyRules;
-  } else {
-    return compileDeclarativeFiles(projectDir, options);
+    const rules = options.minifyScripts ? nools.minify(legacyRules) : legacyRules;
+    return { rules };
   }
+
+  return {
+    rules: await compileDeclarativeFiles(projectDir, options),
+    isDeclarative: true,
+  };
 };
 
 const findMissingDeclarativeFiles = projectDir => DECLARATIVE_NOOLS_FILES.filter(filename => {
@@ -44,16 +48,10 @@ const compileDeclarativeFiles = async (projectDir, options) => {
 
   validateDeclarativeSchema(projectDir, options.haltOnSchemaError);
 
-  const pathToDeclarativeLib = path.join(__dirname, '../nools/lib.js');
-  const baseEslintPath = path.join(__dirname, '../nools/.eslintrc');
+  const pathToDeclarativeLib = path.join(__dirname, '../../nools/lib.js');
+  const baseEslintPath = path.join(__dirname, '../../nools/.eslintrc');
   
-  const code = await pack(projectDir, pathToDeclarativeLib, baseEslintPath, options);
-  return `define Target { _id: null, contact: null, deleted: null, type: null, pass: null, date: null, groupBy: null }
-define Contact { contact: null, reports: null, tasks: null }
-define Task { _id: null, deleted: null, doc: null, contact: null, icon: null, date: null, readyStart: null, readyEnd: null, title: null, fields: null, resolved: null, priority: null, priorityLabel: null, reports: null, actions: null }
-rule GenerateEvents {
-  when { c: Contact } then { ${code} }
-}`;
+  return pack(projectDir, pathToDeclarativeLib, baseEslintPath, options);
 };
 
-module.exports = compileNoolsRules;
+module.exports = compileTasksAndTargets;

package/src/lib/compilation/index.js

@@ -0,0 +1,7 @@
+const compileContactSummary = require('./compile-contact-summary');
+const compileTasksAndTargets = require('./compile-tasks-and-targets');
+
+module.exports = {
+  compileContactSummary,
+  compileTasksAndTargets,
+};

package/src/lib/{package-lib.js → compilation/package-lib.js}

@@ -4,8 +4,8 @@ const path = require('path');
 const TerserPlugin = require('terser-webpack-plugin');
 const webpack = require('webpack');
 
-const fsUtils = require('../lib/sync-fs');
-const { info, warn, error } = require('./log');
+const fsUtils = require('../sync-fs');
+const { info, warn, error } = require('../log');
 
 module.exports = (pathToProject, entry, baseEslintPath, options = {}) => {
   const baseEslintConfig = fsUtils.readJson(baseEslintPath);

package/src/lib/{validate-declarative-schema.js → compilation/validate-declarative-schema.js}

@@ -1,6 +1,6 @@
 const path = require('path');
-const joi = require('@hapi/joi');
-const { error, warn } = require('./log');
+const joi = require('joi');
+const { error, warn } = require('../log');
 
 const err = (filename, message) => details => {
   const acceptedValues = details[0].local.valids ? ` but only ${JSON.stringify(details[0].local.valids)} are allowed` : '';

package/src/lib/nools-utils.js

@@ -0,0 +1,21 @@
+const minify = js =>
+  js.split('\n')
+    .map(s =>
+      s.trim()
+       .replace(/\s*\/\/.*/, '') // single-line comments (like this one)
+    ).join('')
+        .replace(/\s*\/\*(?:(?!\*\/).)*\*\/\s*/g, '') /* this kind of comment */
+        .replace(/function \(/g, 'function(') // different node versions do function.toString() differently :\
+        ;
+
+const addBoilerplateToCode = code => `define Target { _id: null, contact: null, deleted: null, type: null, pass: null, date: null, groupBy: null }
+define Contact { contact: null, reports: null, tasks: null }
+define Task { _id: null, deleted: null, doc: null, contact: null, icon: null, date: null, readyStart: null, readyEnd: null, title: null, fields: null, resolved: null, priority: null, priorityLabel: null, reports: null, actions: null }
+rule GenerateEvents {
+  when { c: Contact } then { ${code} }
+}`;
+
+module.exports = {
+  addBoilerplateToCode,
+  minify,
+};

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

@@ -1,4 +1,4 @@
-const joi = require('@hapi/joi');
+const joi = require('joi');
 
 const FormsSchema = joi.object().pattern(
   joi.string().min(1),

package/src/lib/minify-nools.js

@@ -1,9 +0,0 @@
-module.exports = js =>
-  js.split('\n')
-    .map(s =>
-      s.trim()
-       .replace(/\s*\/\/.*/, '') // single-line comments (like this one)
-    ).join('')
-        .replace(/\s*\/\*(?:(?!\*\/).)*\*\/\s*/g, '') /* this kind of comment */
-        .replace(/function \(/g, 'function(') // different node versions do function.toString() differently :\
-        ;