cht-conf 3.20.0 → 3.21.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [3.21.0](https://github.com/medic/cht-conf/compare/v3.20.0...v3.21.0) (2023-12-06)
+
+
+### Features
+
+* **#575:** retry failed HTTP requests ([#583](https://github.com/medic/cht-conf/issues/583)) ([bc5b0bc](https://github.com/medic/cht-conf/commit/bc5b0bc702e43faf93c495b7fb1197b495c5f66d)), closes [#575](https://github.com/medic/cht-conf/issues/575)
+
 # [3.20.0](https://github.com/medic/cht-conf/compare/v3.19.0...v3.20.0) (2023-10-25)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cht-conf",
-  "version": "3.20.0",
+  "version": "3.21.0",
   "description": "Configure CHT deployments",
   "main": "./src/lib/main.js",
   "engines": {
@@ -35,22 +35,23 @@
   },
   "homepage": "https://github.com/medic/cht-conf#readme",
   "dependencies": {
-    "joi": "^17.9.2",
     "@medic/translation-checker": "^1.0.1",
     "@parcel/watcher": "^2.0.5",
-    "@xmldom/xmldom": "^0.8.2",
+    "@xmldom/xmldom": "^0.8.10",
+    "async-retry": "^1.3.3",
     "canonical-json": "0.0.4",
     "csv-parse": "^4.16.0",
     "dom-compare": "^0.6.0",
     "eslint": "^6.8.0",
     "eslint-loader": "^3.0.4",
     "googleapis": "^84.0.0",
-    "iso-639-1": "^2.1.9",
+    "iso-639-1": "^3.1.0",
+    "joi": "^17.11.0",
     "json-diff": "^0.5.4",
     "json-stringify-safe": "^5.0.1",
     "json2csv": "^4.5.4",
-    "mime-types": "^2.1.32",
-    "minimist": "^1.2.5",
+    "mime-types": "^2.1.35",
+    "minimist": "^1.2.8",
     "mkdirp": "^1.0.4",
     "open": "^7.4.2",
     "pluralize": "^8.0.0",
@@ -68,21 +69,21 @@
     "terser-webpack-plugin": "^1.4.3",
     "uuid": "^8.3.2",
     "webpack": "^4.46.0",
-    "xpath": "0.0.32"
+    "xpath": "0.0.33"
   },
   "devDependencies": {
     "@commitlint/cli": "^13.2.0",
     "@commitlint/config-conventional": "^13.2.0",
-    "@semantic-release/changelog": "^6.0.0",
-    "@semantic-release/git": "^10.0.0",
-    "body-parser": "^1.19.0",
-    "chai": "^4.3.4",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "body-parser": "^1.20.2",
+    "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",
-    "chai-exclude": "^2.0.3",
+    "chai-exclude": "^2.1.0",
     "chai-shallow-deep-equal": "^1.4.6",
-    "chai-xml": "^0.4.0",
+    "chai-xml": "^0.4.1",
     "eslint-plugin-node": "^11.1.0",
-    "express": "^4.17.1",
+    "express": "^4.18.2",
     "express-pouchdb": "^4.2.0",
     "fs-extra": "8.1.0",
     "husky": "^7.0.2",
@@ -91,6 +92,6 @@
     "pouchdb-adapter-memory": "^7.2.2",
     "rewire": "^5.0.0",
     "semantic-release": "^18.0.0",
-    "sinon": "^7.3.2"
+    "sinon": "^8.1.1"
   }
 }

package/src/lib/api.js

@@ -1,4 +1,5 @@
-const request = require('request-promise-native');
+const retry = require('async-retry');
+const rpn = require('request-promise-native');
 
 const archivingApi = require('./archiving-api');
 const environment = require('./environment');
@@ -7,6 +8,13 @@ const url = require('url');
 
 const cache = new Map();
 
+const _request = (method) => (...args) => retry(() => rpn[method](...args), { retries: 5, randomize: false, factor: 1.5 });
+const request = {
+  get: _request('get'),
+  post: _request('post'),
+  put: _request('put'),
+};
+
 const logDeprecatedTransitions = (settings) => {
   const appSettings = JSON.parse(settings);
 
@@ -15,7 +23,7 @@ const logDeprecatedTransitions = (settings) => {
   }
 
   const uri = `${environment.instanceUrl}/api/v1/settings/deprecated-transitions`;
-  return request({ uri, method: 'GET', json: true })
+  return request.get({ uri, json: true })
     .then(transitions => {
       (transitions || []).forEach(transition => {
         const transitionSetting = appSettings.transitions[transition.name];
@@ -34,8 +42,7 @@ const logDeprecatedTransitions = (settings) => {
 };
 
 const updateAppSettings = (settings) => {
-  return request({
-    method: 'PUT',
+  return request.put({
     url: `${environment.apiUrl}/_design/medic/_rewrite/update_settings/medic?replace=1`,
     headers: {'Content-Type': 'application/json'},
     body: settings,
@@ -45,7 +52,7 @@ const updateAppSettings = (settings) => {
 const api = {
   getAppSettings: () => {
     const url = `${environment.apiUrl}/_design/medic/_rewrite/app_settings/medic`;
-    return request({ url, json: true })
+    return request.get({ url, json: true })
       .catch(err => {
         if(err.statusCode === 404) {
           throw new Error(`Failed to fetch existing app_settings from ${url}.\n` +
@@ -66,9 +73,8 @@ const api = {
   },
 
   createUser(userData) {
-    return request({
+    return request.post({
       uri: `${environment.instanceUrl}/api/v1/users`,
-      method: 'POST',
       json: true,
       body: userData,
     });
@@ -79,9 +85,8 @@ const api = {
   },
 
   uploadSms(messages) {
-    return request({
+    return request.post({
       uri: `${environment.instanceUrl}/api/sms`,
-      method: 'POST',
       json: true,
       body: { messages },
     });
@@ -116,7 +121,7 @@ const api = {
   },
 
   version() {
-    return request({ uri: `${environment.instanceUrl}/api/deploy-info`, method: 'GET', json: true }) // endpoint added in 3.5
+    return request.get({ uri: `${environment.instanceUrl}/api/deploy-info`, json: true }) // endpoint added in 3.5
       .then(deploy_info => deploy_info && deploy_info.version);
   },
 
@@ -150,8 +155,7 @@ const api = {
       // (old version), so we assume form is valid but return special result
       return Promise.resolve({ok: true, formsValidateEndpointFound: false});
     }
-    return request({
-      method: 'POST',
+    return request.post({
       uri: `${environment.instanceUrl}/api/v1/forms/validate`,
       headers: { 'Content-Type': 'application/xml' },
       body: formXml,

package/src/lib/environment.js

@@ -20,7 +20,7 @@ const initialize = (
   }
 
   Object.assign(state, {
-    apiUrl,
+    apiUrl: apiUrl.toString(),
     archiveDestination,
     extraArgs,
     initialized: true,

package/src/lib/get-api-url.js

@@ -36,7 +36,16 @@ const getApiUrl = (cmdArgs, env = {}) => {
     instanceUrl = new url.URL(cmdArgs.url);
   }
 
-  return `${instanceUrl.href}medic`;
+  instanceUrl.pathname = `${instanceUrl.pathname}medic`;
+  return instanceUrl;
+};
+
+const isLocalhost = (apiUrl) => {
+  if (!apiUrl) {
+    return false;
+  }
+  const localhosts = [/^localhost$/, /^127\.0\.0\.\d+$/];
+  return !!localhosts.find(localhost => localhost.test(apiUrl.hostname));
 };
 
 const parseLocalUrl = (couchUrl) => {
@@ -56,4 +65,7 @@ const parseLocalUrl = (couchUrl) => {
   return new url.URL('http://admin:pass@localhost:5988');
 };
 
-module.exports = getApiUrl;
+module.exports = {
+  getApiUrl,
+  isLocalhost,
+};

package/src/lib/main.js

@@ -3,7 +3,7 @@ const checkForUpdates = require('../lib/check-for-updates');
 const checkChtConfDependencyVersion = require('../lib/check-cht-conf-dependency-version');
 const environment = require('./environment');
 const fs = require('../lib/sync-fs');
-const getApiUrl = require('../lib/get-api-url');
+const { getApiUrl, isLocalhost } = require('../lib/get-api-url');
 const log = require('../lib/log');
 const userPrompt = require('../lib/user-prompt');
 const redactBasicAuth = require('redact-basic-auth');
@@ -110,10 +110,6 @@ module.exports = async (argv, env) => {
     throw new Error('--destination=<path to save files> is required with --archive.');
   }
 
-  if (cmdArgs['accept-self-signed-certs']) {
-    process.env.NODE_TLS_REJECT_UNAUTHORIZED = 0;
-  }
-
   //
   // Logging
   //
@@ -147,6 +143,10 @@ module.exports = async (argv, env) => {
   const requiresInstance = actions.some(action => action.requiresInstance);
   const apiUrl = requiresInstance && getApiUrl(cmdArgs, env);
 
+  if (cmdArgs['accept-self-signed-certs'] || isLocalhost(apiUrl)) {
+    process.env.NODE_TLS_REJECT_UNAUTHORIZED = 0;
+  }
+
   let extraArgs = cmdArgs['--'];
   if (!extraArgs.length) {
     extraArgs = undefined;