@redhat-cloud-services/frontend-components-config 4.6.7 → 4.6.10

package/README.md

@@ -118,6 +118,9 @@ You can also easily run you application with a local build of Chrome by adding `
 INSIGHTS_CHROME=/Users/rvsiansk/insights-project/insights-chrome/build/
 ```
 
+**The path must end with a slash character / !!**
+
+
 To check what the proxy is doing with your local chrome settings you can set `proxyVerbose: true`.
 
 #### keycloakUri
@@ -489,4 +492,4 @@ const { config: webpackConfig, plugins } = config({
   ...
 });
 
-```
+```

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@redhat-cloud-services/frontend-components-config",
-    "version": "4.6.7",
+    "version": "4.6.10",
     "description": "Config plugins and settings for RedHat Cloud Services project.",
     "main": "index.js",
     "bin": {
@@ -53,7 +53,7 @@
         "util": "^0.12.4",
         "webpack": "^5.55.1",
         "webpack-cli": "^4.8.0",
-        "webpack-dev-server": "4.3.1",
+        "webpack-dev-server": "4.8.1",
         "write-file-webpack-plugin": "^4.5.1",
         "yargs": "^17.2.1"
     }

package/src/config.js

@@ -35,7 +35,7 @@ module.exports = ({
   registry,
   client = {},
   bundlePfModules = false,
-  useChromeTemplate = false,
+  useChromeTemplate = true,
   bounceProd,
   useAgent,
 } = {}) => {

package/src/plugins.js

@@ -1,5 +1,5 @@
 const { SourceMapDevToolPlugin } = require('webpack');
-const { ProvidePlugin } = require('webpack');
+const { ProvidePlugin, DefinePlugin } = require('webpack');
 const MiniCssExtractPlugin = require('mini-css-extract-plugin');
 const { CleanWebpackPlugin } = require('clean-webpack-plugin');
 const HtmlWebpackPlugin = require('html-webpack-plugin');
@@ -16,7 +16,8 @@ module.exports = ({
   modules,
   generateSourceMaps,
   plugins,
-  useChromeTemplate = false,
+  useChromeTemplate = true,
+  definePlugin = {},
 } = {}) => [
   ...(generateSourceMaps
     ? [
@@ -53,6 +54,11 @@ module.exports = ({
           },
           ...(replacePlugin || []),
         ]),
+        new DefinePlugin({
+          // we have to wrap the appname string in another string because of how define plugin explodes strings
+          CRC_APP_NAME: JSON.stringify(insights?.appname),
+          ...(definePlugin || {}),
+        }),
       ]),
   new ProvidePlugin({
     process: 'process/browser.js',

package/src/plugins.test.js

@@ -2,17 +2,18 @@ import plugins from './plugins';
 
 const HTML_WEBPACK = 2;
 const REPLACE = 3;
+const DEFINE_PLUGIN = 4;
 
 describe('plugins generations, no option', () => {
-  const enabledPlugins = plugins();
+  const enabledPlugins = plugins({ useChromeTemplate: false });
 
   it('should generate plugins', () => {
-    expect(enabledPlugins.length).toBe(6);
+    expect(enabledPlugins.length).toBe(7);
   });
 
   it('should generate plugins with sourceMaps', () => {
-    const enabledPlugins = plugins({ generateSourceMaps: true });
-    expect(enabledPlugins.length).toBe(7);
+    const enabledPlugins = plugins({ generateSourceMaps: true, useChromeTemplate: false });
+    expect(enabledPlugins.length).toBe(8);
   });
 
   it('should generate correct template path for HtmlWebpackPlugin', () => {
@@ -21,7 +22,7 @@ describe('plugins generations, no option', () => {
 });
 
 describe('rootFolder', () => {
-  const enabledPlugins = plugins({ rootFolder: '/test/folder' });
+  const enabledPlugins = plugins({ rootFolder: '/test/folder', useChromeTemplate: false });
 
   it('should generate correct template path for HtmlWebpackPlugin', () => {
     expect(enabledPlugins[HTML_WEBPACK].userOptions.template).toBe('/test/folder/src/index.html');
@@ -29,7 +30,7 @@ describe('rootFolder', () => {
 });
 
 describe('appDeployment', () => {
-  const enabledPlugins = plugins({ appDeployment: '/test/folder' });
+  const enabledPlugins = plugins({ appDeployment: '/test/folder', useChromeTemplate: false });
 
   it('should replace correct string', () => {
     enabledPlugins[REPLACE].replace({ html: 'string @@env' }, (_, { html }) => expect(html).toBe('string /test/folder'));
@@ -37,12 +38,13 @@ describe('appDeployment', () => {
 });
 
 it('htmlPlugin should update', () => {
-  const enabledPlugins = plugins({ htmlPlugin: { title: 'myTitle' } });
+  const enabledPlugins = plugins({ htmlPlugin: { title: 'myTitle' }, useChromeTemplate: false });
   expect(enabledPlugins[HTML_WEBPACK].userOptions.title).toBe('myTitle');
 });
 
 it('replacePlugin should update', () => {
   const enabledPlugins = plugins({
+    useChromeTemplate: false,
     replacePlugin: [
       {
         pattern: '@@another',
@@ -52,3 +54,21 @@ it('replacePlugin should update', () => {
   });
   enabledPlugins[REPLACE].replace({ html: '@@another string @@env' }, (_, { html }) => expect(html).toBe('test-string string '));
 });
+
+it('definePlugin should have default replace of CRC_APP_NAME', () => {
+  const enabledPlugins = plugins({
+    useChromeTemplate: false,
+    insights: { appname: 'test_app' },
+  });
+  expect(enabledPlugins[DEFINE_PLUGIN].definitions.CRC_APP_NAME).toBe('"test_app"');
+});
+
+it('definePlugin should update', () => {
+  const enabledPlugins = plugins({
+    useChromeTemplate: false,
+    definePlugin: {
+      SOME_VAR: JSON.stringify('test_val'),
+    },
+  });
+  expect(enabledPlugins[DEFINE_PLUGIN].definitions.SOME_VAR).toBe('"test_val"');
+});