@elliemae/pui-cli 6.13.0-beta.3 → 7.0.0-beta.3

package/lib/cli-commands/build.js

@@ -1,20 +1,24 @@
 const { exit } = require('yargs');
+const path = require('path');
 const {
   exec,
   logInfo,
   logError,
   logSuccess,
   writeAppInfo,
+  copyBuildAssetsToVersionedFolder,
 } = require('./utils');
 const { esBuild, TARGETS } = require('../transpile/esbuild');
 
-const { name } = require('../../package.json');
-
 async function buildWebApp() {
   await exec(`rimraf ./build`);
   await exec(
-    `cross-env NODE_ENV=production webpack --config node_modules/${name}/lib/webpack/webpack.prod.babel.js --color`,
+    `cross-env NODE_ENV=production webpack --config ${path.resolve(
+      __dirname,
+      '../webpack/webpack.prod.babel.js',
+    )} --color`,
   );
+  await copyBuildAssetsToVersionedFolder();
   await writeAppInfo();
 }
 

package/lib/cli-commands/utils.js

@@ -1,9 +1,21 @@
+/* eslint-disable max-lines */
 /* eslint-disable no-console */
 const execa = require('execa');
 const chalk = require('chalk');
 const path = require('path');
-const { readFile, writeFile } = require('fs/promises');
-const { getPaths } = require('../webpack/helpers');
+const {
+  readFile,
+  writeFile,
+  mkdir,
+  readdir,
+  copyFile,
+} = require('fs/promises');
+const {
+  getPaths,
+  isAppLoaderEnabled,
+  getAppVersion,
+  LATEST_VERSION,
+} = require('../webpack/helpers');
 
 const browsersMapping = {
   and_chr: 'Chrome for Android',
@@ -87,3 +99,37 @@ exports.writeAppInfo = async () => {
     path.join(process.cwd(), 'build', 'public', 'info.json'),
   ].forEach(async (infoPath) => writeFile(infoPath, infoJSON));
 };
+
+const copyDir = async (src, dest) => {
+  const entries = await readdir(src, {
+    withFileTypes: true,
+  });
+  await mkdir(dest);
+  return Promise.all(
+    entries.map((entry) => {
+      const srcPath = path.join(src, entry.name);
+      const destPath = path.join(dest, entry.name);
+      if (entry.isDirectory()) {
+        return copyDir(srcPath, destPath);
+      }
+      return copyFile(srcPath, destPath);
+    }),
+  );
+};
+
+const updateManifestWithVersionInfo = async (dest) => {
+  const manifestFile = path.join(dest, 'manifest.json');
+  let manifestData = await readFile(manifestFile, 'utf8');
+  manifestData = manifestData.replace(/latest\//g, `${getAppVersion()}/`);
+  await writeFile(manifestFile, manifestData);
+};
+
+exports.copyBuildAssetsToVersionedFolder = async () => {
+  const appVersion = getAppVersion();
+  const isVersionedApp = isAppLoaderEnabled() && appVersion !== LATEST_VERSION;
+  if (!isVersionedApp) return;
+  const src = path.resolve(process.cwd(), 'build/public/latest');
+  const dest = path.resolve(process.cwd(), `build/public/${appVersion}`);
+  await copyDir(src, dest);
+  await updateManifestWithVersionInfo(dest);
+};

package/lib/server/csp.js

@@ -17,13 +17,13 @@ const sources = [
 ];
 
 const sendFileWithCSPNonce = ({
-  outputPath,
+  buildPath,
   page = 'index.html',
   nonceRegex = /__CSP_NONCE__/g,
   res,
   fileSystem = fs,
 }) => {
-  fileSystem.readFile(path.resolve(outputPath, page), 'utf8', (err, html) => {
+  fileSystem.readFile(path.resolve(buildPath, page), 'utf8', (err, html) => {
     if (err) {
       res.sendStatus(404);
     } else {

package/lib/server/index.js

@@ -1,26 +1,11 @@
 /* eslint consistent-return:0 import/order:0 */
-
 const express = require('express');
-const cors = require('cors');
-const { resolve } = require('path');
-const expressPinoLogger = require('express-pino-logger');
-const { csp } = require('./csp');
 const logger = require('./logger');
-const argv = require('./argv');
-const port = require('./port');
-const setup = require('./middlewares/frontendMiddleware');
-const { loadRoutes } = require('./util');
-const { getAssetPath } = require('../webpack/helpers');
-
-const pino = expressPinoLogger({
-  transport: {
-    target: 'pino-pretty',
-    options: {
-      colorize: true,
-    },
-  },
-});
-pino.logger.level = 'warn';
+const {
+  setupDefaultMiddlewares,
+  setupAdditionalMiddlewars,
+} = require('./middlewares');
+const { loadRoutes, port, host } = require('./util');
 
 // const corsOptions = {
 //   origin: '*',
@@ -37,33 +22,16 @@ pino.logger.level = 'warn';
 //   maxAge: 3600,
 // };
 const app = express();
-app.use(pino);
-app.use(cors());
-app.options('*', cors());
-csp(app);
-app.use(express.urlencoded({ extended: false }));
-app.use(express.text({ type: 'text/plain' }));
-app.use(express.json({ type: 'application/json' }));
-app.use(express.json({ type: 'application/csp-report' }));
-
+setupDefaultMiddlewares(app);
 // load all custom routes from the application
 loadRoutes(app);
-
 // In production we need to pass these values in instead of relying on webpack
-setup(app, {
-  outputPath: resolve(process.cwd(), 'build/public'),
-  publicPath: getAssetPath(),
-});
-
-// get the intended host and port number, use localhost and port 3000 if not provided
-const customHost = argv.host || process.env.HOST;
-const host = customHost || null; // Let http.Server use its default IPv6/4 host
-const prettyHost = customHost || 'localhost';
+setupAdditionalMiddlewars(app);
 
 // Start your app.
 app.listen(port, host, async (err) => {
   if (err) {
     return logger.error(err.message);
   }
-  logger.appStarted(port, prettyHost);
+  logger.appStarted(port, host || 'localhost');
 });

package/lib/server/middlewares/addProdMiddlewares.js

@@ -1,25 +1,24 @@
-const path = require('path');
 const compression = require('compression');
 const expressStaticGzip = require('express-static-gzip');
 const { sendFileWithCSPNonce } = require('../csp');
+const { getPaths } = require('../../webpack/helpers');
 
-module.exports = function addProdMiddlewares(app, options) {
-  const publicPath = options.publicPath || '/';
-  const outputPath =
-    options.outputPath || path.resolve(process.cwd(), 'build/public');
+const paths = getPaths();
 
+module.exports = function addProdMiddlewares(app, options = {}) {
+  const { buildPath = paths.buildPath, mountPath = paths.mountPath } = options;
   // compression middleware compresses your server responses which makes them
   // smaller (applies also to assets). You can read more about that technique
   // and other good practices on official Express.js docs http://mxs.is/googmy
   app.use(compression());
 
-  app.get(publicPath, (req, res) => {
-    sendFileWithCSPNonce({ outputPath, res });
+  app.get(mountPath, (req, res) => {
+    sendFileWithCSPNonce({ buildPath, res });
   });
 
   app.use(
-    publicPath,
-    expressStaticGzip(outputPath, {
+    mountPath,
+    expressStaticGzip(buildPath, {
       index: false,
       enableBrotli: true,
       orderPreference: ['br'],
@@ -27,5 +26,5 @@ module.exports = function addProdMiddlewares(app, options) {
   );
   app.use(expressStaticGzip('cdn'));
 
-  app.get('*', (req, res) => sendFileWithCSPNonce({ outputPath, res }));
+  app.get('*', (req, res) => sendFileWithCSPNonce({ buildPath, res }));
 };

package/lib/server/middlewares/index.js

@@ -0,0 +1,37 @@
+const express = require('express');
+const cors = require('cors');
+const expressPinoLogger = require('express-pino-logger');
+const { csp } = require('../csp');
+const addProdMiddlewares = require('./addProdMiddlewares');
+const addDevMiddlewares = require('./addDevMiddlewares');
+const webpackConfig = require('../../webpack/webpack.dev.babel');
+
+exports.setupDefaultMiddlewares = (app) => {
+  const pino = expressPinoLogger({
+    transport: {
+      target: 'pino-pretty',
+      options: {
+        colorize: true,
+      },
+    },
+  });
+  pino.logger.level = 'warn';
+  app.use(pino);
+  app.use(cors());
+  app.options('*', cors());
+  csp(app);
+  app.use(express.urlencoded({ extended: false }));
+  app.use(express.text({ type: 'text/plain' }));
+  app.use(express.json({ type: 'application/json' }));
+  app.use(express.json({ type: 'application/csp-report' }));
+};
+
+exports.setupAdditionalMiddlewars = (app, options) => {
+  const isProd = process.env.NODE_ENV === 'production';
+  if (isProd) {
+    addProdMiddlewares(app, options);
+  } else {
+    addDevMiddlewares(app, webpackConfig);
+  }
+  return app;
+};

package/lib/server/util/index.js

@@ -1,5 +1,6 @@
 const fs = require('fs');
 const path = require('path');
+const argv = require('minimist')(process.argv.slice(2));
 
 const getCWD = () => process.cwd();
 
@@ -25,7 +26,7 @@ const getFilesMatching = (filePattern) => {
 const getServerRouteFiles = getFilesMatching(allJS);
 const getServiceEndpoints = getFilesMatching(serviceEndpoints);
 
-const loadRoutes = (app) => {
+exports.loadRoutes = (app) => {
   const routeFiles = getServerRouteFiles(path.join(getCWD(), 'server/routes'));
   routeFiles.push(...getServiceEndpoints(path.join(getCWD(), 'app')));
   routeFiles.push(...getServiceEndpoints(path.join(getCWD(), 'lib')));
@@ -41,7 +42,11 @@ const loadRoutes = (app) => {
   });
 };
 
-module.exports = {
-  getCWD,
-  loadRoutes,
-};
+exports.port = parseInt(
+  argv.port || process.env.port || process.env.PORT || '3000',
+  10,
+);
+
+exports.host = argv.host || process.env.HOST;
+
+exports.getCWD = getCWD;

package/lib/testing/jest.config.js

@@ -1,9 +1,11 @@
 const path = require('path');
 const normalizePath = require('normalize-path');
-const { getAppConfig, getAssetPath } = require('../webpack/helpers');
+const { getAppConfig, getPaths } = require('../webpack/helpers');
 const swcrcConfig = require('../transpile/swcrc.config.js');
 const { findMonoRepoRoot } = require('../monorepo/utils');
 
+const { mountPath } = getPaths();
+
 let isReactModule = true;
 try {
   /* eslint-disable global-require, import/no-unresolved */
@@ -89,7 +91,7 @@ const jestConfig = {
     APP_CONFIG: getAppConfig(),
     __webpack_public_path__: '/',
   },
-  testURL: `http://localhost:3111${getAssetPath()}`,
+  testURL: `http://localhost:3111${mountPath}`,
   testEnvironment: 'jsdom',
 };
 

package/lib/webpack/helpers.js

@@ -150,8 +150,6 @@ const getENCWLoaderFileName = () => {
   )[0];
 };
 
-const getAssetPath = () => (process.env.ASSET_PATH || '/').replace(/\/?$/, '/');
-
 const getAppVersion = () => {
   if (!process.env.APP_VERSION) return LATEST_VERSION;
   const match = process.env.APP_VERSION.match(/^v?(\d+\.\d+)\..*$/);
@@ -166,7 +164,7 @@ const getPaths = (latestVersion = true) => {
   return {
     appVersion: version,
     buildPath: path.resolve(process.cwd(), `build/public/`),
-    // base path for all assets
+    mountPath: (process.env.MOUNT_PATH || '/').replace(/\/?$/, '/'),
     publicPath,
     userMonScriptPath: `latest/js/${getUserMonitoringFileName()}`,
     appLoaderScriptPath: `latest/js/${getAppLoaderFileName()}`,
@@ -226,11 +224,11 @@ const filterByFilePresence = (patterns) =>
       !noErrorOnMissing || fs.existsSync(path.resolve(process.cwd(), from)),
   );
 
+exports.LATEST_VERSION = LATEST_VERSION;
 exports.excludeNodeModulesExcept = excludeNodeModulesExcept;
 exports.getLibraryName = getLibraryName;
 exports.getAppConfig = getAppConfig;
 exports.mapToFolder = mapToFolder;
-exports.getAssetPath = getAssetPath;
 exports.isApp = isApp;
 exports.getAlias = getAlias;
 exports.getAppVersion = getAppVersion;

package/lib/webpack/webpack.prod.babel.js

@@ -11,9 +11,7 @@ const browserslistToEsbuild = require('browserslist-to-esbuild');
 const baseConfigFactory = require('./webpack.base.babel');
 const {
   isAppLoaderEnabled,
-  LATEST_VERSION,
   getPaths,
-  getAppVersion,
   isGoogleTagManagerEnabled,
   getCompressionPlugins,
 } = require('./helpers');
@@ -122,21 +120,13 @@ const htmlWebpackPlugin = new HtmlWebpackPlugin({
   },
 });
 
-// user want to version the web app to support backward compatible releases
-const isVersionedApp =
-  isAppLoaderEnabled() && getAppVersion() !== LATEST_VERSION;
+const config = baseConfigFactory(getProdConfig());
+config.plugins.push(htmlWebpackPlugin);
 
-const latestVersionConfig = baseConfigFactory(getProdConfig());
-latestVersionConfig.plugins.push(htmlWebpackPlugin);
-
-const appVersionConfig = baseConfigFactory(
-  getProdConfig({ latestVersion: false }),
-);
-
-const addSMPPlugin = (config) => {
+const addSMPPlugin = (webpackConfig) => {
   const smpConfig = new SpeedMeasurePlugin({
     disable: !process.env.MEASURE,
-  }).wrap(config);
+  }).wrap(webpackConfig);
   // mini css extract plugin is not working fine with smp
   smpConfig.plugins.push(
     new MiniCssExtractPlugin({
@@ -147,8 +137,4 @@ const addSMPPlugin = (config) => {
   return smpConfig;
 };
 
-const config = isVersionedApp
-  ? [latestVersionConfig, appVersionConfig].map(addSMPPlugin)
-  : addSMPPlugin(latestVersionConfig);
-
-module.exports = config;
+module.exports = addSMPPlugin(config);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-cli",
-  "version": "6.13.0-beta.3",
+  "version": "7.0.0-beta.3",
   "private": false,
   "description": "ICE MT UI Platform CLI",
   "sideEffects": false,

package/lib/server/argv.js

@@ -1 +0,0 @@
-module.exports = require('minimist')(process.argv.slice(2));

package/lib/server/middlewares/frontendMiddleware.js

@@ -1,16 +0,0 @@
-/* eslint-disable global-require */
-
-module.exports = (app, options) => {
-  const isProd = process.env.NODE_ENV === 'production';
-
-  if (isProd) {
-    const addProdMiddlewares = require('./addProdMiddlewares');
-    addProdMiddlewares(app, options);
-  } else {
-    const webpackConfig = require('../../webpack/webpack.dev.babel');
-    const addDevMiddlewares = require('./addDevMiddlewares');
-    addDevMiddlewares(app, webpackConfig);
-  }
-
-  return app;
-};

package/lib/server/port.js

@@ -1,6 +0,0 @@
-const argv = require('./argv');
-
-module.exports = parseInt(
-  argv.port || process.env.port || process.env.PORT || '3000',
-  10,
-);