@oroinc/oro-webpack-config-builder 5.1.0-alpha4 → 5.1.0-alpha40

package/README.md

@@ -2,4 +2,4 @@
 
 An integration of OroPlatform based applications with the Webpack.
 
-For more details see [the documentation](https://doc.oroinc.com/backend/bundles/platform/AssetBundle/).
+For more details see [the documentation](https://doc.oroinc.com/bundles/platform/AssetBundle/).

package/error-handler.js

@@ -0,0 +1,95 @@
+const BaseError = require('./validation/errors/base-error');
+const {isVerboseMode} = require('./utils');
+const {red, yellow, green, bgRed} = require('colorette');
+
+const emptyLine = length => new Array(length).fill(' ').join('');
+const multiline = (color, msg) => {
+    msg = ` ${msg}`;
+    msg = msg + emptyLine(120 - msg.length);
+
+    return `\n${color(emptyLine(msg.length))}\n${color(msg)}\n${color(emptyLine(msg.length))}`;
+};
+
+class ErrorHandler {
+    constructor() {
+        this.failedThemes = [];
+
+        process.on('beforeExit', code => {
+            this.onProcess();
+        });
+    }
+
+    /**
+     * Show a message about failed themes
+     */
+    onProcess() {
+        if (this.failedThemes.length) {
+            let msg = '[ERROR] Assets build';
+
+            if (this.failedThemes.length === 1) {
+                msg = `${msg} for "${this.failedThemes[0]}" theme failed.`;
+            } else {
+                msg = `${msg} for "${this.failedThemes.join(', ')}" themes failed.`;
+            }
+            console.error(multiline(bgRed, msg));
+            process.exit(1);
+        }
+    }
+
+    /**
+     * Executes when the Webpack Compiler will complete a compilation
+     * In case of empty Webpack Config this method will not run
+     *
+     * @param {Object} stats
+     */
+    onBuildComplete(stats) {
+        const failed = stats?.compilation?.errors.length !== 0;
+
+        if (failed) {
+            console.error(multiline(bgRed, '[ERROR] Assets build failed.'));
+            process.exit(1);
+        }
+    }
+
+    /**
+     * @param {Array|string} errors
+     * @param {string} [failedTheme]
+     */
+    displayError(errors, failedTheme) {
+        if (typeof failedTheme === 'string') {
+            this.failedThemes.push(failedTheme);
+        }
+
+        if (typeof errors === 'string') {
+            errors = [errors];
+        }
+
+        const errorMessage = errors.map(err => {
+            const highlightPrefix = str => {
+                const prefix = str.substring(0, str.search(':'));
+                return red(prefix) + str.substring(str.search(':'));
+            };
+
+            if (err instanceof BaseError) {
+                err.message = `${err.message}\n${green(err.extra)}`;
+            }
+
+            let msg = err.message;
+
+            if (isVerboseMode()) {
+                msg = highlightPrefix(err.stack);
+            } else {
+                const command = yellow('php bin/console oro:assets:build --env=dev --verbose');
+                const info = `${green(`Run the command ${command} to see more information`)}`;
+
+                msg = highlightPrefix(`${err.name}: ${msg}\n${info}`);
+            }
+
+            return `${msg}\n`;
+        });
+
+        console.error(errorMessage.join('\n'));
+    }
+}
+
+module.exports = ErrorHandler;

package/loader/inject-loader/index.js

@@ -0,0 +1 @@
+module.exports=function(e){var n={};function t(i){if(n[i])return n[i].exports;var r=n[i]={i:i,l:!1,exports:{}};return e[i].call(r.exports,r,r.exports,t),r.l=!0,r.exports}return t.m=e,t.c=n,t.d=function(e,n,i){t.o(e,n)||Object.defineProperty(e,n,{configurable:!1,enumerable:!0,get:i})},t.r=function(e){Object.defineProperty(e,"__esModule",{value:!0})},t.n=function(e){var n=e&&e.__esModule?function(){return e.default}:function(){return e};return t.d(n,"a",n),n},t.o=function(e,n){return Object.prototype.hasOwnProperty.call(e,n)},t.p="",t.w={},t(t.s=3)}([function(e,n){e.exports=require("babel-core")},function(e,n,t){"use strict";Object.defineProperty(n,"__esModule",{value:!0});var i=t(0);n.default=(0,i.template)("\n  module.exports = function __injector(__injections) {\n    __injections = __injections || {};\n\n    (function __validateInjection() {\n      var validDependencies = DEPENDENCIES;\n      var injectedDependencies = Object.keys(__injections);\n      var invalidInjectedDependencies = injectedDependencies.filter(function (dependency) {\n        return validDependencies.indexOf(dependency) === -1;\n      });\n\n      if (invalidInjectedDependencies.length > 0) {\n        var validDependenciesString = ' - ' + validDependencies.join('\\n - ');\n        var injectedDependenciesString = ' - ' + injectedDependencies.join('\\n - ');\n        var invalidDependenciesString = ' - ' + invalidInjectedDependencies.join('\\n - ');\n\n        throw new Error('Injection Error in ' + SOURCE_PATH + '\\n\\n' +\n          'The following injections are invalid:\\n' + invalidDependenciesString + '\\n\\n' +\n          'The following injections were passed in:\\n' + injectedDependenciesString + '\\n\\n' +\n          'Valid injection targets for this module are:\\n' + validDependenciesString + '\\n'\n        );\n      }\n    })();\n\n    __injector.sourcePath = SOURCE_PATH;\n    __injector.validDependencies = DEPENDENCIES;\n\n    var module = { exports: {} };\n    var exports = module.exports;\n\n    (function () {\n      SOURCE\n    })();\n\n    return module.exports;\n  }\n"),e.exports=n.default},function(e,n,t){"use strict";Object.defineProperty(n,"__esModule",{value:!0}),n.default=function(e,n,t){var i=(0,r.transform)(n,{babelrc:!1,code:!1,compact:!1,filename:e.resourcePath}).ast,o=[];(0,r.traverse)(i,{CallExpression:function(e){r.types.isIdentifier(e.node.callee,{name:"require"})&&(o.push(function(e){var n=e.node.arguments[0].value;return e.replaceWith(r.types.expressionStatement(r.types.conditionalExpression(r.types.callExpression(r.types.memberExpression(r.types.identifier("__injections"),r.types.identifier("hasOwnProperty"),!1),[r.types.stringLiteral(n)]),r.types.memberExpression(r.types.identifier("__injections"),r.types.stringLiteral(n),!0),e.node))),n}(e)),e.skip())}}),0===o.length&&e.emitWarning("The module you are trying to inject into doesn't have any dependencies. Are you sure you want to do this?");var a=r.types.file(r.types.program([(0,s.default)({SOURCE:i,SOURCE_PATH:r.types.stringLiteral(e.resourcePath),DEPENDENCIES:r.types.arrayExpression(o.map(function(e){return r.types.stringLiteral(e)}))})]));return(0,r.transformFromAst)(a,n,{sourceMaps:e.sourceMap,sourceFileName:e.resourcePath,inputSourceMap:t,babelrc:!1,compact:!1,filename:e.resourcePath})};var i,r=t(0),o=t(1),s=(i=o)&&i.__esModule?i:{default:i};e.exports=n.default},function(e,n,t){"use strict";Object.defineProperty(n,"__esModule",{value:!0}),n.default=function(e,n){this.cacheable&&this.cacheable();var t=(0,o.default)(this,e,n),i=t.code,r=t.map;this.callback(null,i,r)};var i,r=t(2),o=(i=r)&&i.__esModule?i:{default:i};e.exports=n.default}]);

package/loader/inject-loader/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["webpack:///webpack/bootstrap 393a9525777b8b817cc3","webpack:///external \"babel-core\"","webpack:///src/index.js","webpack:///src/injectify.js","webpack:///src/wrapper_template.js"],"sourcesContent":[" \t// The module cache\n \tvar installedModules = {};\n\n \t// The require function\n \tfunction __webpack_require__(moduleId) {\n\n \t\t// Check if module is in cache\n \t\tif(installedModules[moduleId]) {\n \t\t\treturn installedModules[moduleId].exports;\n \t\t}\n \t\t// Create a new module (and put it into the cache)\n \t\tvar module = installedModules[moduleId] = {\n \t\t\ti: moduleId,\n \t\t\tl: false,\n \t\t\texports: {}\n \t\t};\n\n \t\t// Execute the module function\n \t\tmodules[moduleId].call(module.exports, module, module.exports, __webpack_require__);\n\n \t\t// Flag the module as loaded\n \t\tmodule.l = true;\n\n \t\t// Return the exports of the module\n \t\treturn module.exports;\n \t}\n\n\n \t// expose the modules object (__webpack_modules__)\n \t__webpack_require__.m = modules;\n\n \t// expose the module cache\n \t__webpack_require__.c = installedModules;\n\n \t// define getter function for harmony exports\n \t__webpack_require__.d = function(exports, name, getter) {\n \t\tif(!__webpack_require__.o(exports, name)) {\n \t\t\tObject.defineProperty(exports, name, {\n \t\t\t\tconfigurable: false,\n \t\t\t\tenumerable: true,\n \t\t\t\tget: getter\n \t\t\t});\n \t\t}\n \t};\n\n \t// getDefaultExport function for compatibility with non-harmony modules\n \t__webpack_require__.n = function(module) {\n \t\tvar getter = module && module.__esModule ?\n \t\t\tfunction getDefault() { return module['default']; } :\n \t\t\tfunction getModuleExports() { return module; };\n \t\t__webpack_require__.d(getter, 'a', getter);\n \t\treturn getter;\n \t};\n\n \t// Object.prototype.hasOwnProperty.call\n \t__webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); };\n\n \t// __webpack_public_path__\n \t__webpack_require__.p = \"\";\n\n \t// Load entry module and return exports\n \treturn __webpack_require__(__webpack_require__.s = 1);\n\n\n\n// WEBPACK FOOTER //\n// webpack/bootstrap 393a9525777b8b817cc3","module.exports = require(\"babel-core\");\n\n\n//////////////////\n// WEBPACK FOOTER\n// external \"babel-core\"\n// module id = 0\n// module chunks = 0","// @flow\n\nimport injectify from './injectify.js';\n\nexport default function injectifyLoader(source, inputSourceMap) {\n  if (this.cacheable) {\n    this.cacheable();\n  }\n\n  const { code, map } = injectify(this, source, inputSourceMap);\n  this.callback(null, code, map);\n}\n\n\n\n// WEBPACK FOOTER //\n// src/index.js","// @flow\n\nimport { transform, traverse, types as t, transformFromAst } from 'babel-core';\nimport wrapperTemplate from './wrapper_template.js';\n\nfunction processRequireCall(path) {\n  const dependencyString = path.node.arguments[0].value;\n  path.replaceWith(\n    t.expressionStatement(\n      t.conditionalExpression(\n        t.callExpression(\n          t.memberExpression(\n            t.identifier('__injections'),\n            t.identifier('hasOwnProperty'),\n            false,\n          ),\n          [\n            t.stringLiteral(dependencyString),\n          ],\n        ),\n        t.memberExpression(\n          t.identifier('__injections'),\n          t.stringLiteral(dependencyString),\n          true,\n        ),\n        path.node,\n      ),\n    ),\n  );\n\n  return dependencyString;\n}\n\nexport default function injectify(context, source, inputSourceMap) {\n  const { ast } = transform(source, {\n    babelrc: false,\n    code: false,\n    compact: false,\n    filename: context.resourcePath,\n  });\n\n  const dependencies = [];\n  traverse(ast, {\n    CallExpression(path) {\n      if (t.isIdentifier(path.node.callee, { name: 'require' })) {\n        dependencies.push(processRequireCall(path));\n        path.skip();\n      }\n    },\n  });\n\n  if (dependencies.length === 0) {\n    context.emitWarning('The module you are trying to inject into doesn\\'t have any dependencies. ' +\n      'Are you sure you want to do this?');\n  }\n\n  const dependenciesArrayAst = t.arrayExpression(\n    dependencies.map(dependency => t.stringLiteral(dependency)),\n  );\n  const wrapperModuleAst = t.file(t.program([\n    wrapperTemplate({ SOURCE: ast, DEPENDENCIES: dependenciesArrayAst }),\n  ]));\n\n  return transformFromAst(wrapperModuleAst, source, {\n    sourceMaps: context.sourceMap,\n    sourceFileName: context.resourcePath,\n    inputSourceMap,\n    babelrc: false,\n    compact: false,\n    filename: context.resourcePath,\n  });\n}\n\n\n\n// WEBPACK FOOTER //\n// src/injectify.js","// @flow\n\nimport { template } from 'babel-core';\n\nexport default template(`\n  module.exports = function __injector(__injections) {\n    __injections = __injections || {};\n\n    (function __validateInjection() {\n      var validDependencies = DEPENDENCIES;\n      var injectedDependencies = Object.keys(__injections);\n      var invalidInjectedDependencies = injectedDependencies.filter(function (dependency) {\n        return validDependencies.indexOf(dependency) === -1;\n      });\n\n      if (invalidInjectedDependencies.length > 0) {\n        var validDependenciesString = '- ' + validDependencies.join('\\\\n- ');\n        var injectedDependenciesString = '- ' + injectedDependencies.join('\\\\n- ');\n        var invalidDependenciesString = '- ' + invalidInjectedDependencies.join('\\\\n- ');\n\n        throw new Error('Some of the injections you passed in are invalid.\\\\n' +\n          'Valid injection targets for this module are:\\\\n' + validDependenciesString + '\\\\n' +\n          'The following injections were passed in:\\\\n' + injectedDependenciesString + '\\\\n' +\n          'The following injections are invalid:\\\\n' + invalidDependenciesString + '\\\\n'\n        );\n      }\n    })();\n\n    var module = { exports: {} };\n    var exports = module.exports;\n\n    (function () {\n      SOURCE\n    })();\n\n    return module.exports;\n  }\n`);\n\n\n\n// WEBPACK FOOTER //\n// src/wrapper_template.js"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;;;;AC7DA;;;;;;;;;;;;;;;;;;;ACIA;AACA;AAHA;AACA;;;;;AACA;AACA;AACA;AACA;AACA;AAJA;AAAA;AAAA;AACA;AAKA;AACA;AACA;;;;;;;;;;;;;ACqBA;AACA;AAhCA;AACA;AAAA;AACA;;;;;AAJA;AACA;AAIA;AACA;AACA;AACA;AAsBA;AACA;AACA;AACA;AAAA;AAEA;AACA;AACA;AACA;AAJA;AADA;AACA;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AANA;AACA;AAQA;AACA;AAEA;AACA;AACA;AACA;AAAA;AAEA;AACA;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AANA;AAQA;;;;;;;;;;;;;;ACrEA;AACA;AACA;AACA;;;;A","sourceRoot":""}

package/modules-config/layout-modules-config-loader.js

@@ -4,19 +4,83 @@ const ModulesConfigLoader = require('./modules-config-loader');
 
 class LayoutModulesConfigLoader extends ModulesConfigLoader {
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     loadConfig(theme, filePath) {
-        let themeConfig = super.loadConfig(theme, path.join('/Resources/views/layouts/', theme, filePath));
+        let themeConfig = super.loadConfig(theme, path.join('Resources/views/layouts/', theme, filePath));
+        themeConfig = merge(themeConfig, super.loadConfig(theme, path.join('templates/layouts/', theme, filePath)));
         // recursive process parent theme
         const {parent: parentTheme} = this.themes[theme];
         if (typeof parentTheme === 'string') {
+            const processedFiles = this.processedFiles;
             const parentThemeConfig = this.loadConfig(parentTheme, filePath);
+
             themeConfig = merge(parentThemeConfig, themeConfig);
+            // processedFiles from parent theme is added to processedFiles of current theme
+            this._processedFiles = [...processedFiles, ...this.processedFiles];
         }
-
         return themeConfig;
     }
+
+    /**
+     * All build names:
+     *  - based on theme names
+     *  - and theme's extra js builds
+     *
+     * @return {string[]}
+     */
+    get buildNames() {
+        const buildNames = super.buildNames;
+        this.themeNames.forEach(theme => {
+            buildNames.push(...this.extraJSBuildNames(theme));
+        });
+        return buildNames;
+    }
+
+    /**
+     * Collect extra js-build names for a theme
+     *
+     * @param {string} theme name on the theme
+     * @return {string[]}
+     */
+    extraJSBuildNames(theme) {
+        const {extra_js_builds: extraJSBuilds = []} = this._themes[theme] || {};
+        return [...extraJSBuilds.map(suffix => `${theme}-${suffix}`)];
+    }
+
+    /**
+     * Check if buildName is an extra js build of layout theme
+     *
+     * @param {string} buildName name of the build
+     * @return {boolean}
+     */
+    isExtraJSBuild(buildName) {
+        const [, suffix] = this.splitBuildName(buildName);
+        return suffix !== void 0;
+    }
+
+    /**
+     * Splits build name on parts theme name and suffix (name of extra js build)
+     * @param {string} buildName
+     * @return {[string]|[string, string]}
+     */
+    splitBuildName(buildName) {
+        // suffix can not contain '-'
+        const marches = buildName.match(/(.+)-([^\-]+)?/);
+        const result = [];
+        if (marches) {
+            const [, theme, suffix] = marches;
+            const {extra_js_builds: extraJSBuilds = []} = this._themes[theme] || {};
+            if (extraJSBuilds.includes(suffix)) {
+                result.push(marches[1], marches[2]);
+            } else {
+                result.push(buildName);
+            }
+        } else {
+            result.push(buildName);
+        }
+        return result;
+    }
 }
 
 module.exports = LayoutModulesConfigLoader;

package/modules-config/modules-config-loader.js

@@ -2,6 +2,10 @@ const path = require('path');
 const fs = require('fs');
 const merge = require('deepmerge');
 const yaml = require('js-yaml');
+const validation = require('../validation');
+
+// merge only unique items
+const arrayMerge = (target, source) => target.concat(source.filter(item => !target.includes(item)));
 
 class ModulesConfigLoader {
     /**
@@ -18,62 +22,101 @@ class ModulesConfigLoader {
         return Object.keys(this._themes);
     }
 
+    /**
+     * @returns {Array}
+     */
+    get buildNames() {
+        return this.themeNames;
+    }
+
+    /**
+     * @returns {Array}
+     */
+    get processedFiles() {
+        return [...this._processedFiles];
+    }
+
     /**
      * @param {Array} bundles Array of ordered symfony bundle paths
-     * @param {string} themesLocation Path inside the bundle, where to find the theme
-     * @param {string} themeInfoFileName Yml File name with theme info
+     * @param {string|Array} themesLocation Path inside the bundle, where to find the theme
+     * @param {string} themeInfoFileName Yaml File name with theme info
      */
     constructor(bundles, themesLocation, themeInfoFileName) {
         this._bundles = bundles;
-        this._themes = this._getThemes(themesLocation, themeInfoFileName);
+        if (!Array.isArray(themesLocation)) {
+            themesLocation = [themesLocation];
+        }
+
+        const themes = {};
+        const self = this;
+        themesLocation.forEach(themesLocation => {
+            self._collectThemes(themes, themesLocation, themeInfoFileName);
+        });
+
+        this._themes = themes;
+        this._processedFiles = [];
     }
 
     /**
-     * Return list of themes with their parents
+     * Collects list of themes with their parents into given storage(themes param)
+     *
+     * @param {Object} themes
      * @param {string} themesLocation
      * @param {string} themeInfoFileName
-     * @returns {Object.<string|null>}
      * @private
      */
-    _getThemes(themesLocation, themeInfoFileName) {
-        const themes = {};
+    _collectThemes(themes, themesLocation, themeInfoFileName) {
         this._bundles.forEach(bundle => {
             const source = bundle + themesLocation;
 
             if (!fs.existsSync(source)) return;
 
             fs.readdirSync(source).forEach(name => {
-                const theme = path.resolve(source, name);
-                if (!fs.lstatSync(theme).isDirectory()) {
+                const themePath = path.resolve(source, name);
+                if (!fs.lstatSync(themePath).isDirectory()) {
                     return;
                 }
-                const themeFile = path.resolve(theme, themeInfoFileName);
+                const themeFile = path.resolve(themePath, themeInfoFileName);
                 if (!fs.existsSync(themeFile)) return;
 
-                if (!(name in themes)) {
-                    themes[name] = null;
-                }
-                themes[name] = yaml.load(fs.readFileSync(themeFile, 'utf8'));
+                const theme = yaml.load(fs.readFileSync(themeFile, 'utf8'));
+                themes[name] = merge(themes[name] || {}, theme, {arrayMerge});
             });
         });
-
-        return themes;
     }
 
     /**
      * @param {string} theme Theme name
-     * @param {string} filePath Path to the file inside bundle directory where to find the configs
-     * @return {Object} Merged Configs loaded from all the bundles Yml files matched by filePath
+     * @param {string|string[]} filePath Path (or paths with fallback) to the file inside bundle directory where to find the configs
+     * @return {Object} Merged Configs loaded from all the bundles Yaml files matched by filePath
      */
     loadConfig(theme, filePath) {
         let configs = {};
+        const filePaths = [].concat(filePath);
+
+        this._processedFiles = [];
         this._bundles.forEach(bundle => {
-            const absolutePath = bundle + filePath;
-            if (!fs.existsSync(absolutePath)) return;
+            let absolutePath;
+
+            for (const file of filePaths) {
+                absolutePath = path.resolve(bundle, file);
+                if (fs.existsSync(absolutePath)) {
+                    break;
+                }
+                absolutePath = void 0;
+            }
 
-            const doc = yaml.load(fs.readFileSync(absolutePath, 'utf8'));
-            configs = merge(configs, doc);
+            if (absolutePath) {
+                const rawDoc = fs.readFileSync(absolutePath, 'utf8');
+                const doc = yaml.load(rawDoc);
+
+                this._processedFiles.push(absolutePath);
+
+                validation.checkSchema(absolutePath, doc, theme);
+                configs = merge(configs, doc);
+            }
         });
+
         return configs;
     }
 }