From d33355d56184aca6d7c7d4bf316efa9d81142fe4 Mon Sep 17 00:00:00 2001 From: Yuri Kuznetsov Date: Wed, 22 Jun 2022 13:01:24 +0300 Subject: [PATCH] support unnamed amd modules in bundle --- .idea/jsLibraryMappings.xml | 6 ++ Gruntfile.js | 13 +++- js/bundler.js | 125 ++++++++++++++++++++++++++++++++++++ package-lock.json | 23 ++++++- package.json | 3 +- 5 files changed, 167 insertions(+), 3 deletions(-) create mode 100644 .idea/jsLibraryMappings.xml create mode 100644 js/bundler.js diff --git a/.idea/jsLibraryMappings.xml b/.idea/jsLibraryMappings.xml new file mode 100644 index 0000000000..d23208fbb7 --- /dev/null +++ b/.idea/jsLibraryMappings.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/Gruntfile.js b/Gruntfile.js index 860b0967df..9c4b4d6629 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -32,13 +32,15 @@ const fs = require('fs'); const cp = require('child_process'); const path = require('path'); +const bundleConfig = require("./frontend/bundle-config.json"); module.exports = grunt => { const pkg = grunt.file.readJSON('package.json'); const bundleConfig = require('./frontend/bundle-config.json'); - let jsFilesToBundle = getBundleLibList().concat(bundleConfig.jsFiles); + let jsFilesToBundle = getBundleLibList() + .concat('build/tmp/espo-bundle.js'); let jsFilesToCopy = getCopyLibDataList(); let libFilesToMinify = jsFilesToCopy @@ -117,6 +119,7 @@ module.exports = grunt => { '!build/tmp/client/custom/modules', 'build/tmp/client/custom/modules/*', '!build/tmp/client/custom/modules/dummy.txt', + 'build/tmp/espo-bundle.js', ] } }, @@ -246,7 +249,14 @@ module.exports = grunt => { ], }, }, + }); + grunt.registerTask('espo-bundle', () => { + const Bundler = require('./js/bundler'); + + let contents = (new Bundler()).bundle(bundleConfig.jsFiles); + + fs.writeFileSync('build/tmp/espo-bundle.js', contents, 'utf8'); }); grunt.registerTask('chmod-folders', () => { @@ -423,6 +433,7 @@ module.exports = grunt => { grunt.registerTask('internal', [ 'less', 'cssmin', + 'espo-bundle', 'uglify:bundle', 'copy:frontendLib', 'uglify:lib', diff --git a/js/bundler.js b/js/bundler.js new file mode 100644 index 0000000000..1ae133606e --- /dev/null +++ b/js/bundler.js @@ -0,0 +1,125 @@ +/************************************************************************ + * This file is part of EspoCRM. + * + * EspoCRM - Open Source CRM application. + * Copyright (C) 2014-2022 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko + * Website: https://www.espocrm.com + * + * EspoCRM is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * EspoCRM is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with EspoCRM. If not, see http://www.gnu.org/licenses/. + * + * The interactive user interfaces in modified source and object code versions + * of this program must display Appropriate Legal Notices, as required under + * Section 5 of the GNU General Public License version 3. + * + * In accordance with Section 7(b) of the GNU General Public License version 3, + * these Appropriate Legal Notices must retain the display of the "EspoCRM" word. + ************************************************************************/ + +const typescript = require('typescript'); +const fs = require('fs'); + +/** + * Normalizes and concatenates Espo modules. + */ +class Bundler { + + /** + * @private + * @type {string} + */ + basePath = 'client/src' + + /** + * @param {string[]} pathList + * @return {string} + */ + bundle(pathList) { + let bundleContents = ''; + + pathList.forEach(path => { + bundleContents += this.normalizeSourceFile(path); + }) + + return bundleContents; + } + + /** + * @private + * @param {string} path + * @return {string} + */ + normalizeSourceFile(path) { + let sourceCode = fs.readFileSync(path, 'utf-8'); + let basePath = this._getBathPath(); + + if ( + path.indexOf(basePath) !== 0 || + path.slice(-3) !== '.js' + ) { + return sourceCode; + } + + let moduleName = path.slice(basePath.length, -3); + + let tsSourceFile = typescript.createSourceFile( + path, + sourceCode, + typescript.ScriptTarget.Latest + ); + + let rootStatement = tsSourceFile.statements[0]; + + if ( + !rootStatement.expression || + !rootStatement.expression.expression || + rootStatement.expression.expression.escapedText !== 'define' + ) { + return sourceCode; + } + + let argumentList = rootStatement.expression.arguments; + + if (argumentList.length >= 3 || argumentList.length === 0) { + return sourceCode; + } + + let moduleNameNode = typescript.createStringLiteral(moduleName); + + if (argumentList.length === 1) { + argumentList.unshift( + typescript.createArrayLiteral([]) + ); + } + + argumentList.unshift(moduleNameNode); + + return typescript.createPrinter().printFile(tsSourceFile); + } + + /** + * @private + * @return {string} + */ + _getBathPath() { + let path = this.basePath; + + if (path.slice(-1) !== '/') { + path += '/'; + } + + return path; + } +} + +module.exports = Bundler; diff --git a/package-lock.json b/package-lock.json index ca6b4c33b1..7c6092fd09 100644 --- a/package-lock.json +++ b/package-lock.json @@ -7,6 +7,7 @@ "": { "name": "espocrm", "version": "7.1.7", + "hasInstallScript": true, "license": "GPL-3.0", "dependencies": { "ace-builds": "^1.4.12", @@ -60,7 +61,8 @@ "grunt-replace": "^2.0.2", "js-yaml": "^3.13.1", "pofile": "^1.1.3", - "tar": "^6.1.11" + "tar": "^6.1.11", + "typescript": "^4.7.4" }, "engines": { "npm": ">=7" @@ -3694,6 +3696,19 @@ "integrity": "sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw==", "dev": true }, + "node_modules/typescript": { + "version": "4.7.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.7.4.tgz", + "integrity": "sha512-C0WQT0gezHuw6AdY1M2jxUO83Rjf0HP7Sk1DtXj6j1EwkQNZrHAg2XPWlq62oqEhYvONq5pkC2Y9oPljWToLmQ==", + "dev": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=4.2.0" + } + }, "node_modules/uglify-js": { "version": "3.15.1", "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.15.1.tgz", @@ -6541,6 +6556,12 @@ "integrity": "sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw==", "dev": true }, + "typescript": { + "version": "4.7.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.7.4.tgz", + "integrity": "sha512-C0WQT0gezHuw6AdY1M2jxUO83Rjf0HP7Sk1DtXj6j1EwkQNZrHAg2XPWlq62oqEhYvONq5pkC2Y9oPljWToLmQ==", + "dev": true + }, "uglify-js": { "version": "3.15.1", "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.15.1.tgz", diff --git a/package.json b/package.json index 80b229ed9e..12e02eb60c 100644 --- a/package.json +++ b/package.json @@ -29,7 +29,8 @@ "grunt-replace": "^2.0.2", "js-yaml": "^3.13.1", "pofile": "^1.1.3", - "tar": "^6.1.11" + "tar": "^6.1.11", + "typescript": "^4.7.4" }, "dependencies": { "ace-builds": "^1.4.12",