openmrs 5.3.3-pre.1421 → 5.3.3-pre.1424

package/.turbo/turbo-build.log

@@ -1 +1 @@
-openmrs:build: cache hit, replaying output 84205ded3bab6162
+openmrs:build: cache hit, replaying output 124f62a216601cdd

package/dist/cli.js

@@ -195,10 +195,10 @@ yargs_1.default.command('assemble', 'Assembles an import map incl. all required
     coerce: (arg) => (0, utils_1.trimEnd)(arg, '/'),
 })
     .option('config', {
-    default: 'spa-build-config.json',
+    default: ['spa-build-config.json'],
     description: 'Path to a SPA build config JSON.',
-    type: 'string',
-    coerce: (arg) => (0, path_1.resolve)(process.cwd(), arg),
+    type: 'array',
+    coerce: (arg) => arg.map((p) => (0, path_1.resolve)(process.cwd(), p)),
 })
     .option('hash-importmap', {
     default: false,

package/dist/commands/assemble.js

@@ -5,26 +5,60 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runAssemble = void 0;
 const promises_1 = require("fs/promises");
+const fs_1 = require("fs");
 const path_1 = require("path");
+const stream_1 = require("stream");
 const inquirer_1 = require("inquirer");
 const rimraf_1 = __importDefault(require("rimraf"));
 const axios_1 = __importDefault(require("axios"));
 const npm_registry_fetch_1 = __importDefault(require("npm-registry-fetch"));
 const pacote_1 = __importDefault(require("pacote"));
 const utils_1 = require("../utils");
-const fs_1 = require("fs");
 const npmConfig_1 = require("../utils/npmConfig");
-async function readConfig(mode, config, fetchOptions) {
+async function readConfig(mode, configs, fetchOptions) {
     switch (mode) {
-        case 'config':
-            if (!(0, fs_1.existsSync)(config)) {
-                throw new Error(`Could not find the config file "${config}".`);
+        // curly-braces are here to add a lexical scope which allows us to safely
+        // declare variables
+        case 'config': {
+            if (configs.length === 0) {
+                configs = [(0, path_1.resolve)(process.cwd(), 'spa-build-config.json')];
             }
-            (0, utils_1.logInfo)(`Reading configuration ...`);
-            return {
-                baseDir: (0, path_1.dirname)(config),
-                ...JSON.parse(await (0, promises_1.readFile)(config, 'utf8')),
+            const results = {
+                configs: [],
+                errors: [],
             };
+            for (const config of configs) {
+                if (!(0, fs_1.existsSync)(config)) {
+                    results.errors.push(new Error(`Could not find the config file "${config}".`));
+                    continue;
+                }
+                (0, utils_1.logInfo)(`Reading configuration ${config} ...`);
+                results.configs.push({
+                    ...JSON.parse(await (0, promises_1.readFile)(config, 'utf8')),
+                });
+            }
+            if (results.errors.length > 0) {
+                throw new Error(results.errors.reduce((str, e, idx) => {
+                    if (idx > 0) {
+                        str += '\n\n';
+                    }
+                    return str + e.message;
+                }, ''));
+            }
+            return results.configs.reduce((config, newConfig) => {
+                if (newConfig.frontendModules) {
+                    config.frontendModules = { ...config.frontendModules, ...newConfig.frontendModules };
+                }
+                // excludes are processed for each config in turn; this ensure that modules removed in one config can
+                // be added back by providing another config override
+                if (Array.isArray(newConfig.frontendModuleExcludes)) {
+                    newConfig.frontendModuleExcludes.forEach((exclude) => {
+                        typeof exclude === 'string' && config.frontendModules[exclude] && delete config.frontendModules[exclude];
+                    });
+                }
+                return config;
+            });
+        }
         case 'survey': {
             (0, utils_1.logInfo)(`Loading available frontend modules ...`);
             const packages = await npm_registry_fetch_1.default
@@ -56,7 +90,6 @@ async function readConfig(mode, config, fetchOptions) {
             }
             const answers = await (0, inquirer_1.prompt)(questions);
             return {
-                baseDir: process.cwd(),
                 publicUrl: '.',
                 frontendModules: Object.keys(answers)
                     .filter((m) => answers[m])
@@ -68,7 +101,6 @@ async function readConfig(mode, config, fetchOptions) {
         }
     }
     return {
-        baseDir: process.cwd(),
         frontendModules: {},
         publicUrl: '.',
     };
@@ -79,17 +111,11 @@ async function downloadPackage(cacheDir, esmName, esmVersion, baseDir, fetchOpti
     }
     if (esmVersion.startsWith('file:')) {
         const source = (0, path_1.resolve)(baseDir, esmVersion.substring(5));
-        const file = (0, path_1.basename)(source);
-        const target = (0, path_1.resolve)(cacheDir, file);
-        await (0, promises_1.copyFile)(source, target);
-        return file;
+        return (0, promises_1.readFile)(source);
     }
     else if (/^https?:\/\//.test(esmVersion)) {
         const response = await axios_1.default.get(esmVersion);
-        const content = response.data;
-        const file = esmName.replace('@', '').replace(/\//g, '-') + '.tgz';
-        await (0, promises_1.writeFile)((0, path_1.resolve)(cacheDir, file), content);
-        return file;
+        return response.data;
     }
     else {
         const packageName = `${esmName}@${esmVersion}`;
@@ -97,19 +123,16 @@ async function downloadPackage(cacheDir, esmName, esmVersion, baseDir, fetchOpti
         if (!Boolean(tarManifest) || !Boolean(tarManifest._resolved) || !Boolean(tarManifest._integrity)) {
             throw new Error(`Failed to load manifest for ${packageName} from registry ${fetchOptions.registry}`);
         }
-        const tarball = await pacote_1.default.tarball(tarManifest._resolved, {
+        return pacote_1.default.tarball(tarManifest._resolved, {
             ...fetchOptions,
             integrity: tarManifest._integrity,
         });
-        const filename = `${tarManifest.name}-${tarManifest.version}.tgz`.replace(/^@/, '').replace(/\//, '-');
-        await (0, promises_1.writeFile)((0, path_1.resolve)(cacheDir, filename), tarball);
-        return filename;
     }
 }
-async function extractFiles(sourceFile, targetDir) {
+async function extractFiles(buffer, targetDir) {
     await (0, promises_1.mkdir)(targetDir, { recursive: true });
     const packageRoot = 'package';
-    const rs = (0, fs_1.createReadStream)(sourceFile);
+    const rs = stream_1.Readable.from(buffer);
     const files = await (0, utils_1.untar)(rs);
     const packageJson = JSON.parse(files[`${packageRoot}/package.json`].toString('utf8'));
     const version = packageJson.version ?? '0.0.0';
@@ -125,7 +148,6 @@ async function extractFiles(sourceFile, targetDir) {
         await (0, promises_1.mkdir)((0, path_1.dirname)(targetFile), { recursive: true });
         await (0, promises_1.writeFile)(targetFile, content);
     }));
-    await (0, promises_1.unlink)(sourceFile);
     return [fileName, version];
 }
 async function runAssemble(args) {
@@ -138,7 +160,7 @@ async function runAssemble(args) {
         frontendModules: {},
     };
     const routes = {};
-    (0, utils_1.logInfo)(`Assembling the importmap ...`);
+    (0, utils_1.logInfo)(`Assembling dependencies and building import map and routes registry...`);
     const { frontendModules = {}, publicUrl = '.' } = config;
     const cacheDir = (0, path_1.resolve)(process.cwd(), '.cache');
     if (args.fresh && (0, fs_1.existsSync)(args.target)) {
@@ -147,13 +169,13 @@ async function runAssemble(args) {
     await (0, promises_1.mkdir)(args.target, { recursive: true });
     await Promise.all(Object.keys(frontendModules).map(async (esmName) => {
         const esmVersion = frontendModules[esmName];
-        const tgzFileName = await downloadPackage(cacheDir, esmName, esmVersion, config.baseDir, npmConf);
-        const dirName = tgzFileName.replace('.tgz', '');
-        const [fileName, version] = await extractFiles((0, path_1.resolve)(cacheDir, tgzFileName), (0, path_1.resolve)(args.target, dirName));
+        const tgzBuffer = await downloadPackage(cacheDir, esmName, esmVersion, process.cwd(), npmConf);
+        const dirName = `${esmName}-${esmVersion}`.replace(/^@/, '').replace(/\//, '-');
+        const [fileName, version] = await extractFiles(tgzBuffer, (0, path_1.resolve)(args.target, dirName));
         const appRoutes = (0, path_1.resolve)(args.target, dirName, 'routes.json');
         if ((0, fs_1.existsSync)(appRoutes)) {
             try {
-                routes[esmName] = JSON.parse((0, fs_1.readFileSync)(appRoutes).toString());
+                routes[esmName] = JSON.parse((await (0, promises_1.readFile)(appRoutes)).toString());
                 routes[esmName]['version'] = version;
             }
             catch (e) {
@@ -174,7 +196,8 @@ async function runAssemble(args) {
         await (0, promises_1.writeFile)((0, path_1.resolve)(args.target, `routes.registry${args.hashImportmap ? '.' + (0, utils_1.contentHash)(routes) : ''}.json`), JSON.stringify(routes), 'utf-8');
     }
     if (args.manifest) {
-        await (0, promises_1.writeFile)((0, path_1.resolve)(args.target, 'spa-module-versions.json'), JSON.stringify(versionManifest), 'utf8');
+        await (0, promises_1.writeFile)((0, path_1.resolve)(args.target, 'spa-assemble-config.json'), JSON.stringify(versionManifest), 'utf8');
     }
+    (0, utils_1.logInfo)(`Finished assembling frontend distribution`);
 }
 exports.runAssemble = runAssemble;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openmrs",
-  "version": "5.3.3-pre.1421",
+  "version": "5.3.3-pre.1424",
   "license": "MPL-2.0",
   "main": "dist/index.js",
   "bin": "./dist/cli.js",
@@ -30,8 +30,8 @@
   "homepage": "https://github.com/openmrs/openmrs-esm-core#readme",
   "dependencies": {
     "@carbon/icons-react": "11.26.0",
-    "@openmrs/esm-app-shell": "5.3.3-pre.1421",
-    "@openmrs/webpack-config": "5.3.3-pre.1421",
+    "@openmrs/esm-app-shell": "5.3.3-pre.1424",
+    "@openmrs/webpack-config": "5.3.3-pre.1424",
     "@pnpm/npm-conf": "^2.1.0",
     "@swc/core": "^1.3.58",
     "autoprefixer": "^10.4.2",

package/src/cli.ts

@@ -258,10 +258,10 @@ yargs.command(
         coerce: (arg) => trimEnd(arg, '/'),
       })
       .option('config', {
-        default: 'spa-build-config.json',
+        default: ['spa-build-config.json'],
         description: 'Path to a SPA build config JSON.',
-        type: 'string',
-        coerce: (arg) => resolve(process.cwd(), arg),
+        type: 'array',
+        coerce: (arg: Array<string>) => arg.map((p) => resolve(process.cwd(), p)),
       })
       .option('hash-importmap', {
         default: false,

package/src/commands/assemble.ts

@@ -1,12 +1,13 @@
-import { copyFile, mkdir, readFile, unlink, writeFile } from 'fs/promises';
+import { mkdir, readFile, writeFile } from 'fs/promises';
+import { existsSync } from 'fs';
 import { resolve, dirname, basename } from 'path';
+import { Readable } from 'stream';
 import { prompt, type Question } from 'inquirer';
 import rimraf from 'rimraf';
 import axios from 'axios';
 import npmRegistryFetch from 'npm-registry-fetch';
 import pacote from 'pacote';
 import { contentHash, logInfo, logWarn, untar } from '../utils';
-import { createReadStream, existsSync, readFileSync } from 'fs';
 import { getNpmRegistryConfiguration } from '../utils/npmConfig';
 
 /* eslint-disable no-console */
@@ -14,7 +15,7 @@ import { getNpmRegistryConfiguration } from '../utils/npmConfig';
 export interface AssembleArgs {
   target: string;
   mode: string;
-  config: string;
+  config: Array<string>;
   registry?: string;
   hashImportmap: boolean;
   fresh: boolean;
@@ -32,29 +33,72 @@ interface NpmSearchResult {
 }
 
 interface AssembleConfig {
-  baseDir: string;
   publicUrl: string;
   frontendModules: Record<string, string>;
+  frontendModuleExcludes?: Array<string>;
 }
 
 async function readConfig(
   mode: string,
-  config: string,
+  configs: Array<string>,
   fetchOptions: npmRegistryFetch.Options,
 ): Promise<AssembleConfig> {
   switch (mode) {
-    case 'config':
-      if (!existsSync(config)) {
-        throw new Error(`Could not find the config file "${config}".`);
+    // curly-braces are here to add a lexical scope which allows us to safely
+    // declare variables
+    case 'config': {
+      if (configs.length === 0) {
+        configs = [resolve(process.cwd(), 'spa-build-config.json')];
       }
 
-      logInfo(`Reading configuration ...`);
-
-      return {
-        baseDir: dirname(config),
-        ...JSON.parse(await readFile(config, 'utf8')),
+      const results: {
+        configs: Array<AssembleConfig>;
+        errors: Array<Error>;
+      } = {
+        configs: [],
+        errors: [],
       };
 
+      for (const config of configs) {
+        if (!existsSync(config)) {
+          results.errors.push(new Error(`Could not find the config file "${config}".`));
+          continue;
+        }
+
+        logInfo(`Reading configuration ${config} ...`);
+
+        results.configs.push({
+          ...JSON.parse(await readFile(config, 'utf8')),
+        });
+      }
+
+      if (results.errors.length > 0) {
+        throw new Error(
+          results.errors.reduce((str, e, idx) => {
+            if (idx > 0) {
+              str += '\n\n';
+            }
+
+            return str + e.message;
+          }, ''),
+        );
+      }
+
+      return results.configs.reduce((config, newConfig) => {
+        if (newConfig.frontendModules) {
+          config.frontendModules = { ...config.frontendModules, ...newConfig.frontendModules };
+        }
+
+        // excludes are processed for each config in turn; this ensure that modules removed in one config can
+        // be added back by providing another config override
+        if (Array.isArray(newConfig.frontendModuleExcludes)) {
+          newConfig.frontendModuleExcludes.forEach((exclude) => {
+            typeof exclude === 'string' && config.frontendModules[exclude] && delete config.frontendModules[exclude];
+          });
+        }
+        return config;
+      });
+    }
     case 'survey': {
       logInfo(`Loading available frontend modules ...`);
 
@@ -95,7 +139,6 @@ async function readConfig(
       const answers = await prompt(questions);
 
       return {
-        baseDir: process.cwd(),
         publicUrl: '.',
         frontendModules: Object.keys(answers)
           .filter((m) => answers[m])
@@ -108,7 +151,6 @@ async function readConfig(
   }
 
   return {
-    baseDir: process.cwd(),
     frontendModules: {},
     publicUrl: '.',
   };
@@ -120,23 +162,17 @@ async function downloadPackage(
   esmVersion: string,
   baseDir: string,
   fetchOptions: npmRegistryFetch.Options,
-) {
+): Promise<Buffer> {
   if (!existsSync(cacheDir)) {
     await mkdir(cacheDir, { recursive: true });
   }
 
   if (esmVersion.startsWith('file:')) {
     const source = resolve(baseDir, esmVersion.substring(5));
-    const file = basename(source);
-    const target = resolve(cacheDir, file);
-    await copyFile(source, target);
-    return file;
+    return readFile(source);
   } else if (/^https?:\/\//.test(esmVersion)) {
     const response = await axios.get<Buffer>(esmVersion);
-    const content = response.data;
-    const file = esmName.replace('@', '').replace(/\//g, '-') + '.tgz';
-    await writeFile(resolve(cacheDir, file), content);
-    return file;
+    return response.data;
   } else {
     const packageName = `${esmName}@${esmVersion}`;
     const tarManifest = await pacote.manifest(packageName, fetchOptions);
@@ -145,23 +181,17 @@ async function downloadPackage(
       throw new Error(`Failed to load manifest for ${packageName} from registry ${fetchOptions.registry}`);
     }
 
-    const tarball = await pacote.tarball(tarManifest._resolved, {
+    return pacote.tarball(tarManifest._resolved, {
       ...fetchOptions,
       integrity: tarManifest._integrity,
     });
-
-    const filename = `${tarManifest.name}-${tarManifest.version}.tgz`.replace(/^@/, '').replace(/\//, '-');
-
-    await writeFile(resolve(cacheDir, filename), tarball);
-
-    return filename;
   }
 }
 
-async function extractFiles(sourceFile: string, targetDir: string) {
+async function extractFiles(buffer: Buffer, targetDir: string) {
   await mkdir(targetDir, { recursive: true });
   const packageRoot = 'package';
-  const rs = createReadStream(sourceFile);
+  const rs = Readable.from(buffer);
   const files = await untar(rs);
   const packageJson = JSON.parse(files[`${packageRoot}/package.json`].toString('utf8'));
   const version = packageJson.version ?? '0.0.0';
@@ -181,7 +211,6 @@ async function extractFiles(sourceFile: string, targetDir: string) {
       }),
   );
 
-  await unlink(sourceFile);
   return [fileName, version];
 }
 
@@ -199,7 +228,7 @@ export async function runAssemble(args: AssembleArgs) {
 
   const routes = {};
 
-  logInfo(`Assembling the importmap ...`);
+  logInfo(`Assembling dependencies and building import map and routes registry...`);
 
   const { frontendModules = {}, publicUrl = '.' } = config;
   const cacheDir = resolve(process.cwd(), '.cache');
@@ -213,15 +242,15 @@ export async function runAssemble(args: AssembleArgs) {
   await Promise.all(
     Object.keys(frontendModules).map(async (esmName) => {
       const esmVersion = frontendModules[esmName];
-      const tgzFileName = await downloadPackage(cacheDir, esmName, esmVersion, config.baseDir, npmConf);
+      const tgzBuffer = await downloadPackage(cacheDir, esmName, esmVersion, process.cwd(), npmConf);
 
-      const dirName = tgzFileName.replace('.tgz', '');
-      const [fileName, version] = await extractFiles(resolve(cacheDir, tgzFileName), resolve(args.target, dirName));
+      const dirName = `${esmName}-${esmVersion}`.replace(/^@/, '').replace(/\//, '-');
+      const [fileName, version] = await extractFiles(tgzBuffer, resolve(args.target, dirName));
 
       const appRoutes = resolve(args.target, dirName, 'routes.json');
       if (existsSync(appRoutes)) {
         try {
-          routes[esmName] = JSON.parse(readFileSync(appRoutes).toString());
+          routes[esmName] = JSON.parse((await readFile(appRoutes)).toString());
           routes[esmName]['version'] = version;
         } catch (e) {
           logWarn(`Error while processing routes for ${esmName} using ${appRoutes}: ${e}`);
@@ -256,6 +285,8 @@ export async function runAssemble(args: AssembleArgs) {
   }
 
   if (args.manifest) {
-    await writeFile(resolve(args.target, 'spa-module-versions.json'), JSON.stringify(versionManifest), 'utf8');
+    await writeFile(resolve(args.target, 'spa-assemble-config.json'), JSON.stringify(versionManifest), 'utf8');
   }
+
+  logInfo(`Finished assembling frontend distribution`);
 }