cht-conf 3.16.2 → 3.17.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+# [3.17.0](https://github.com/medic/cht-conf/compare/v3.16.2...v3.17.0) (2023-04-04)
+
+
+### Features
+
+* **#545:** publish cht-app-ide docker image ([#550](https://github.com/medic/cht-conf/issues/550)) ([8b5e62e](https://github.com/medic/cht-conf/commit/8b5e62e8f2191c4457433d30024266aa27ae1129)), closes [#545](https://github.com/medic/cht-conf/issues/545)
+* **#547:** add command for uploading extension libs ([3b13e40](https://github.com/medic/cht-conf/commit/3b13e40e276d37e554cb5863974cea1090ed4585)), closes [#547](https://github.com/medic/cht-conf/issues/547)
+
 ## [3.16.2](https://github.com/medic/cht-conf/compare/v3.16.1...v3.16.2) (2023-03-18)
 
 

package/README.md

@@ -34,73 +34,33 @@ As Administrator:
 
 CHT Conf can also be run from within a Docker container. This is useful if you are already familiar with Docker and do not wish to configure the various dependencies required for developing CHT apps on your local machine. The necessary dependencies are pre-packaged in the Docker image.
 
-#### Building the image
-
-Install [Docker](https://www.docker.com/). If you are using Windows, you also need to enable the [Windows Subsystem for Linux (WSL2)](https://learn.microsoft.com/en-us/windows/wsl/install) to perform the following steps.
-
-Using the terminal (or the WLS shell on Windows: _Start > wsl_), run the following commands to create a new project directory and build the Docker image:
-
-```shell
-mkdir -p ~/cht-project
-cd ~/cht-project
-curl https://raw.githubusercontent.com/medic/cht-conf/main/Dockerfile > Dockerfile
-docker build -t cht-ide .
-```
-
 #### Using the image
 
-The resulting Docker image can be used as a [VSCode Development Container](https://code.visualstudio.com/docs/devcontainers/containers) (easiest) or as a standalone Docker utility.
-
-##### VSCode Development Container
-
-If you want to develop CHT apps with VSCode, you can use the Docker image as a Development Container. This will allow you to use the `cht-conf` utility and its associated tech stack from within VSCode (without needing to install dependencies like NodeJS on your host system).
-
-[Install VSCode](https://code.visualstudio.com/) if you do not have it already.
-
-Using the terminal (or the WLS shell on Windows: _Start > wsl_), run the following commands from within your project directory (created above) to download the `.devcontainer.json` config file, install the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers), and open the project directory in VSCode:
+The Docker image can be used as a [VS Code Development Container](https://code.visualstudio.com/docs/devcontainers/containers) (easiest) or as a standalone Docker utility.
 
-```shell
-cd ~/cht-project
-curl -s https://raw.githubusercontent.com/medic/cht-conf/main/devcontainer.cht-ide/.devcontainer.json > .devcontainer.json
-code --install-extension ms-vscode-remote.remote-containers
-code -n .
-```
-
-When opening VSCode, you may be prompted with the question:
-
-> **Do you trust the authors of the files in this folder?**
-
-Choose, "Yes, I trust the authors".
-
-Open the Command Palette in VSCode (_Ctrl+Shift+P_ or _Cmd+Shift+P_) and select `Reopen in Container`. This will open your workspace inside a container based on the `cht-ide` image. You can use the `cht` commands by opening a terminal in VSCode (_Ctrl+Shift+\`_ or _Cmd+Shift+\`_). If prompted "Do you trust the authors..." choose "Trust Folder & Continue".
-
-Run the following command in the VSCode terminal to bootstrap your new CHT project:
-
-```shell
-cht initialise-project-layout
-```
+Install [Docker](https://www.docker.com/). If you are using Windows, you also need to enable the [Windows Subsystem for Linux (WSL2)](https://learn.microsoft.com/en-us/windows/wsl/install) to perform the following steps.
 
-###### Terminal environment
+##### VS Code Development Container
 
-When opening a terminal in VSCode in a development container, the terminal will be running on the _container environment_ by default. This is what gives you access to the various `cht` commands.  However, this also means you do NOT have access, within the default VSCode terminal, to commands from your _host environment_. So, for example, you cannot run `docker` commands since Docker is not installed inside the container.
+If you want to develop CHT apps with VS Code, you can use the Docker image as a Development Container. This will allow you to use the `cht-conf` utility and its associated tech stack from within VS Code (without needing to install dependencies like NodeJS on your host system).
 
-To open a terminal running on you _host environment_ in VSCode, open the Command Palette (_Ctrl+Shift+P_ or _Cmd+Shift+P_) and select `Create New Integrated Terminal (Local)`. Just remember that you will NOT be able to run `cht` commands from this terminal since cht-conf is not installed on your host machine.
+See the [CHT Documentation](https://docs.communityhealthtoolkit.org/apps/tutorials/local-setup/#developing-with-vs-code-dev-container) for more information on building CHT apps with VS Code Development Containers.
 
 ##### Standalone Docker utility
 
-If you are not using VSCode, you can use the Docker image as a standalone utility from the command line.  Instead of using the `cht ...` command, you can run `docker run -it --rm -v "$PWD":/workdir cht-ide ...`. This will create an ephemeral container with access to your current directory that will run the given cht command. (Do not include the `cht` part of the command, just your desired actions/parameters.)
+If you are not using VS Code, you can use the Docker image as a standalone utility from the command line.  Instead of using the `cht ...` command, you can run `docker run -it --rm -v "$PWD":/workdir medicmobile/cht-app-ide ...`. This will create an ephemeral container with access to your current directory that will run the given cht command. (Do not include the `cht` part of the command, just your desired actions/parameters.)
 
 Run the following command inside the project directory to bootstrap your new CHT project:
 
 ```shell
-docker run -it --rm -v "$PWD":/workdir cht-ide initialise-project-layout
+docker run -it --rm -v "$PWD":/workdir medicmobile/cht-app-ide initialise-project-layout
 ```
 
 #### Note on connecting to a local CHT instance
 
 When using `cht-conf` within a Docker container to connect to a CHT instance that is running on your local machine (e.g. a development instance), you cannot use the `--local` flag or `localhost` in your `--url` parameter (since these will be interpreted as "local to the container"). 
 
-It is recommended to run a local CHT instance using the [CHT Docker Helper script](https://docs.communityhealthtoolkit.org/apps/guides/hosting/4.x/app-developer/). You can connect to the resulting `...my.local-ip.co` URL from the Docker container (or the VSCode terminal). (Just make sure the port your CHT instance is hosted on is not blocked by your firewall). 
+It is recommended to run a local CHT instance using the [CHT Docker Helper script](https://docs.communityhealthtoolkit.org/apps/guides/hosting/4.x/app-developer/). You can connect to the resulting `...my.local-ip.co` URL from the Docker container (or the VS Code terminal). (Just make sure the port your CHT instance is hosted on is not blocked by your firewall). 
 
 ## Bash completion
 

package/{devcontainer.cht-ide → devcontainer.cht-app-ide}/.devcontainer.json

@@ -1,5 +1,5 @@
 {
-  "image": "cht-ide",
+  "image": "medicmobile/cht-app-ide:latest",
   // Required to run tests with Puppeteer
   // https://pptr.dev/guides/docker
   "capAdd": ["SYS_ADMIN"]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cht-conf",
-  "version": "3.16.2",
+  "version": "3.17.0",
   "description": "Configure CHT deployments",
   "main": "./src/lib/main.js",
   "engines": {

package/src/fn/upload-extension-libs.js

@@ -0,0 +1,41 @@
+const environment = require('../lib/environment');
+const pouch = require('../lib/db');
+const log = require('../lib/log');
+const attachmentsFromDir = require('../lib/attachments-from-dir');
+const warnUploadOverwrite = require('../lib/warn-upload-overwrite');
+const insertOrReplace = require('../lib/insert-or-replace');
+const projectPaths = require('../lib/project-paths');
+
+const DOC_ID = 'extension-libs';
+
+module.exports = {
+  requiresInstance: true,
+  execute: async () => {
+    const configurationDir = `${environment.pathToProject}/${projectPaths.EXTENSION_LIBS_PATH}`;
+
+    const attachments = attachmentsFromDir(configurationDir);
+    if (!Object.keys(attachments).length) {
+      log.info(`No configuration found at "${configurationDir}" - not uploading extension-libs`);
+      return;
+    }
+
+    log.info(`Found extension-libs: ${Object.keys(attachments).join(', ')}`);
+    const doc = {
+      _id: DOC_ID,
+      _attachments: attachments
+    };
+    
+    const db = pouch(environment.apiUrl);
+    const changes = await warnUploadOverwrite.preUploadDoc(db, doc);
+  
+    if (!changes) {
+      log.info('Extension libs not uploaded as already up to date');
+      return;
+    }
+
+    await insertOrReplace(db, doc);
+    log.info('Extension libs upload complete');
+
+    return await warnUploadOverwrite.postUploadDoc(db, doc);
+  }
+};

package/src/lib/main.js

@@ -37,6 +37,7 @@ const defaultActions = [
   'upload-partners',
   'upload-custom-translations',
   'upload-privacy-policies',
+  'upload-extension-libs',
 ];
 const defaultArchiveActions = [
   'compile-app-settings',
@@ -58,6 +59,7 @@ const defaultArchiveActions = [
   'upload-partners',
   'upload-custom-translations',
   'upload-privacy-policies',
+  'upload-extension-libs',
 ];
 
 module.exports = async (argv, env) => {

package/src/lib/project-paths.js

@@ -1,13 +1,14 @@
 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'),
-    TRAINING_FORMS_PATH: path.join('forms', 'training'),
-    TRANSLATIONS_DIR_PATH: 'translations',
-    RESOURCE_CONFIG_PATH: 'resources.json',
-    RESOURCES_DIR_PATH: 'resources'
-};
+  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'),
+  TRAINING_FORMS_PATH: path.join('forms', 'training'),
+  TRANSLATIONS_DIR_PATH: 'translations',
+  RESOURCE_CONFIG_PATH: 'resources.json',
+  RESOURCES_DIR_PATH: 'resources',
+  EXTENSION_LIBS_PATH: 'extension-libs',
+};