cht-conf 5.2.0 → 5.3.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [5.3.0](https://github.com/medic/cht-conf/compare/v5.2.1...v5.3.0) (2025-09-04)
+
+
+### Features
+
+* **#512:** add form validation for instance::db-doc ([#737](https://github.com/medic/cht-conf/issues/737)) ([0db687e](https://github.com/medic/cht-conf/commit/0db687eb8f2c5dbb6a2d2e387857af50af81a917)), closes [#512](https://github.com/medic/cht-conf/issues/512)
+
+## [5.2.1](https://github.com/medic/cht-conf/compare/v5.2.0...v5.2.1) (2025-08-27)
+
+
+### Bug Fixes
+
+* **#390:** notify user of new cht-conf versions ([#730](https://github.com/medic/cht-conf/issues/730)) ([9d36c21](https://github.com/medic/cht-conf/commit/9d36c215f5b6406233b856b6348fe949757ab0b8)), closes [#390](https://github.com/medic/cht-conf/issues/390)
+
 # [5.2.0](https://github.com/medic/cht-conf/compare/v5.1.0...v5.2.0) (2025-08-07)
 
 

package/README.md

@@ -293,24 +293,6 @@ To achieve this, create a file called `settings.inherit.json` in your project's
 		}
 	}
 
-# Fetching logs
-
-Fetch logs from a CHT v2.x production server.
-
-This is a standalone command installed alongside `cht-conf`.  For usage information, run `cht-logs --help`.
-
-## Usage
-
-	cht-logs <instance-name> <log-types...>
-
-Accepted log types:
-
-	api
-	couchdb
-	gardener
-	nginx
-	sentinel
-
 # Development
 
 To develop a new action or improve an existing one, check the ["Actions" doc](src/fn/README.md).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cht-conf",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "description": "Configure CHT deployments",
   "main": "./src/lib/main.js",
   "engines": {
@@ -16,8 +16,6 @@
   "bin": {
     "medic-conf": "src/bin/index.js",
     "cht": "src/bin/index.js",
-    "medic-logs": "src/bin/cht-logs.bash",
-    "cht-logs": "src/bin/cht-logs.bash",
     "shell-completion-for-medic-conf": "src/bin/shell-completion.js",
     "shell-completion-for-cht": "src/bin/shell-completion.js",
     "pngout-medic": "bin/pngout",
@@ -94,6 +92,6 @@
     "pouchdb-adapter-memory": "^9.0.0",
     "rewire": "^8.0.0",
     "semantic-release": "^24.2.4",
-    "sinon": "^19.0.2"
+    "sinon": "^21.0.0"
   }
 }

package/src/cli/usage.js

@@ -8,9 +8,13 @@ ${bold('NAME')}
 
 ${bold('SYNOPSIS')}
   cht <--local|--instance=instance-name|--url=url>
-Or:
+
+  Or
+
   cht <--local|--instance=instance-name|--url=url|--archive> <actions> <options> -- <params>
 
+  ${underscore('Note')}: If <actions>,<options> or <params> are ${bold('not')} passed but one of --local or --instance or --url ${bold('is')} passed, ${bold('all')} supported actions are called.
+
 ${bold('DESCRIPTION')}
   This script updates and uploads a project's configuration.
 
@@ -58,6 +62,9 @@ ${bold('OPTIONS')}
   --skip-dependency-check
     Skips checking the version running is set to the same version in the package.json
 
+  --skip-version-check       
+    Skips the automatic check for new cht-conf versions
+    
   --skip-git-check
     Skips checking the status of the current repository that holds the configuration
 
@@ -65,12 +72,13 @@ ${bold('OPTIONS')}
     Skips checking message translations
 
   --skip-validate
-    Skips form validation  
+    Skips form validation
 
   --force
-    CAN BE DANGEROUS! Passes yes to all commands and any where that would prompt to overwrite changes will overwrite automatically. 
+    CAN BE DANGEROUS! Passes yes to all commands and any where that would prompt to overwrite changes will overwrite automatically.
 `);
   /* eslint-enable max-len */
 };
 
 const bold = text => `\x1b[1m${text}\x1b[0m`;
+const underscore = text => `\x1b[4m${text}\x1b[0m`;

package/src/lib/check-for-updates.js

@@ -1,39 +1,35 @@
-const info = require('../lib/log').info;
 const request = require('request-promise-native');
-const warn = require('../lib/log').warn;
-
-module.exports = (options) => {
-  const current = require('../../package').version;
-  info(`Current version: ${current}.  Checking NPM for updates…`);
-
-  if (!options) {
-    options = {};
-  }
+const log = require('../lib/log'); 
+const current = require('../../package.json').version;
 
+module.exports = (options = {}) => {
   return request
     .get('https://registry.npmjs.org/cht-conf')
     .then(res => {
       const json = JSON.parse(res);
-      const latest = json['dist-tags'].latest;
-
-      if (latest === current) {
-        info('You are already on the latest version :¬)');
-      } else {
-        warn(`New version available!
+      return json['dist-tags'].latest;
+    })
+    .catch(err => {
+      log.warn(`Could not check NPM for updates: ${err.message}`); 
+      if (!options.nonFatal) {
+        throw err;
+      }
+    })
+    .then(latest => {
+      if (latest && latest !== current) {
+        log.warn(`New version available!
 
-        ${current} -> ${latest}
+      ${current} -> ${latest}
 
-     To install:
+   To install:
 
-       npm install -g cht-conf
-  `);
-      }
-    })
-    .catch(err => {
-      if (options.nonFatal && err.cause && err.cause.code === 'ENOTFOUND') {
-        warn('Could not check NPM for updates.  You may be offline.');
-      } else {
-        warn(`Could not check NPM for updates. Error: ${err.message}`);
+     npm install -g cht-conf
+    `); 
+        if (!options.nonFatal) {
+          throw new Error('You are not running the latest version of cht-conf!');
+        }
+      } else if (!options.nonFatal) {
+        log.info('You are already on the latest version :¬)'); 
       }
     });
 };

package/src/lib/forms-utils.js

@@ -9,6 +9,14 @@ const getNode = (currentNode, path) =>
 const getNodes = (currentNode, path) =>
   xpath.parse(path).select({ node: currentNode, allowAnyNamespaceForNoPrefix: true });
 
+const getFullNodePath = (childNode) => {
+  if (childNode.nodeType !== 1) {
+    return '';
+  }
+  const parentPath = getFullNodePath(childNode.parentNode);
+  return parentPath + '/' + childNode.nodeName;
+};
+
 module.exports = {
   /**
    * Get the full path of the form, or null if the path doesn't exist.
@@ -68,6 +76,15 @@ module.exports = {
    */
   getPrimaryInstanceNode: xmlDoc => getNode(xmlDoc, `${XPATH_MODEL}/instance`),
 
+  /**
+   * Returns the path to the given child node relative to the primary instance node.
+   * This is useful for identifying the node in error/warning messages.
+   * @param childNode the child node
+   * @returns {string}
+   */
+  getPrimaryInstanceNodeChildPath: (childNode) => getFullNodePath(childNode)
+    .replace(`${XPATH_MODEL}/instance`, ''),
+
   /**
    * Check whether the XForm has the <instanceID/> tag.
    * @param {string} xmlDoc the XML document

package/src/lib/main.js

@@ -187,11 +187,6 @@ module.exports = async (argv, env) => {
   info(`Processing config in ${projectName}.`);
   info('Actions:\n     -', actions.map(({name}) => name).join('\n     - '));
 
-  const skipCheckForUpdates = cmdArgs.check === false;
-  if (actions.some(action => action.name === 'check-for-updates') && !skipCheckForUpdates) {
-    await checkForUpdates({ nonFatal: true });
-  }
-
   for (const action of actions) {
     info(`Starting action: ${action.name}…`);
     await executeAction(action);
@@ -201,6 +196,9 @@ module.exports = async (argv, env) => {
   if (actions.length > 1) {
     await info('All actions completed.');
   }
+  if (!actions.some(action => action.name === 'check-for-updates') && !cmdArgs['skip-version-check']) {
+    await checkForUpdates({ nonFatal: true });
+  }
 };
 
 function buildActions(cmdArgs, skipValidate) {

package/src/lib/validation/form/db-doc-is-valid.js

@@ -0,0 +1,27 @@
+const { getPrimaryInstanceNode, getNodes, getPrimaryInstanceNodeChildPath } = require('../../forms-utils');
+
+module.exports = {
+  name: 'db-doc-is-valid.js',
+  requiresInstance: false,
+  execute: async ({ xmlDoc, xformPath }) => {
+    const errors = [];
+    const primaryInstance = getPrimaryInstanceNode(xmlDoc);
+    const dbDocNodes = getNodes(xmlDoc, '//*[@db-doc="true"]', primaryInstance);
+    dbDocNodes.forEach(node => {
+      const childNodes = node.childNodes.filter(n => n.nodeType === 1);
+      if (!childNodes.length) {
+        const nodeName = getPrimaryInstanceNodeChildPath(node);
+        errors.push(`  - ${nodeName}: the db-doc attribute must only be set on groups.`);
+        return;
+      }
+      const hasTypeField = childNodes.some(child => child.nodeName === 'type');
+      if (!hasTypeField) {
+        const nodeName = getPrimaryInstanceNodeChildPath(node);
+        errors.push(`  - ${nodeName}: groups configured with the db-doc attribute must contain a valid type field.`);
+      }
+    });
+
+    const header = `Form at ${xformPath} contains invalid db-doc configuration:`;
+    return { errors: errors.length ? [header, ...errors]: errors };
+  }
+};

package/src/bin/cht-logs.bash

@@ -1,62 +0,0 @@
-#!/bin/bash -eu
-
-usage() {
-	cat <<EOF
-cht-logs
-==========
-
-Fetch logs from production CHT servers.
-
-USAGE
-	$0 <instance-name> <log-types...>
-
-Accepted log types:
-
-	api
-	couchdb
-	gardener
-	nginx
-	sentinel
-EOF
-}
-
-if [[ $# = 0 ]]; then usage; exit 1; fi
-if [[ "$1" = "--help" ]]; then usage; exit; fi
-if [[ $# < 2 ]]; then usage; exit 1; fi
-
-instanceName="$1"
-shift
-
-domain="${instanceName}.medicmobile.org"
-
-localRoot="fetched-logs/${instanceName}"
-
-while [[ $# > 0 ]]; do
-	logType="$1"
-	shift
-
-	case "$logType" in
-		nginx)     logPath="/var/log/medic-core/nginx";  realLogType=nginx    ;;
-
-		gardener)  logPath="/var/log/gardener";          realLogType=gardener ;;
-		api)       logPath="/var/log/gardener";          realLogType=gardener ;;
-		medic-api) logPath="/var/log/gardener";          realLogType=gardener ;;
-		sentinel)  logPath="/var/log/gardener";          realLogType=gardener ;;
-
-		couch)     logPath="/var/log/medic-core/couchdb";realLogType=couchdb  ;;
-		couchdb)   logPath="/var/log/medic-core/couchdb";realLogType=couchdb  ;;
-
-		*) echo "ERROR: Cannot fetch logs of type: $logType"; exit 1 ;;
-	esac
-
-	localDir="${localRoot}/${realLogType}"
-	mkdir -p "$localDir"
-
-	echo "[logs:$logType] Fetching logs to ${localDir}..."
-	rsync -az --progress -e 'ssh -p 33696' "vm@${domain}:${logPath}/*" "$localDir"
-
-	echo "[logs:$logType] Decompressing logs..."
-	(cd "$localDir" && find . -name \*.bz2 | xargs bzip2 -dk)
-
-	echo "[logs:$logType] Completed.  Logs saved in: ${localDir}"
-done