build: create minified browser script in prod release working

Author: abose

docs/API-Reference/utils/ExtensionLoader.md

@@ -156,8 +156,8 @@ Load extensions.
 ## uninstallExtension(extensionID) ⇒ <code>Promise</code>
 Uninstall a deprecated extension
 
-**Kind**: global function
-**Returns**: <code>Promise</code> - A promise that resolves when the extension is uninstalled successfully
+**Kind**: global function  
+**Returns**: <code>Promise</code> - A promise that resolves when the extension is uninstalled successfully  
 
 | Param | Type | Description |
 | --- | --- | --- |

gulpfile.js/index.js

@@ -35,6 +35,7 @@ const glob = require("glob");
 const crypto = require("crypto");
 const rename = require("gulp-rename");
 const execSync = require('child_process').execSync;
+const terser = require('terser');
 
 function cleanDist() {
     return del(['dist', 'dist-test']);
@@ -104,7 +105,6 @@ function _deletePhoenixProSourceFolder() {
         for (const folder of phoenixProFolders) {
             if (fs.existsSync(folder)) {
                 fs.rmSync(folder, { recursive: true, force: true });
-                console.log(`Deleted phoenix-pro source folder: ${folder}`);
             }
         }
         resolve();
@@ -581,24 +581,69 @@ function containsRegExpExcludingEmpty(str) {
 }
 
 
+// Paths that should be minified during production builds
+const minifyablePaths = [
+    'src/extensionsIntegrated/phoenix-pro/browser-context'
+];
+
+function _minifyBrowserContextFile(fileContent) {
+    const minified = terser.minify(fileContent, {
+        mangle: false,
+        compress: {
+            unused: false
+        },
+        output: {
+            comments: function(node, comment) {
+                const text = comment.value.trim();
+                return text.includes("DONT_STRIP_MINIFY:");
+            }
+        }
+    });
+
+    if (minified.error) {
+        throw new Error(`Failed to minify file: ${minified.error}`);
+    }
+
+    return minified.code;
+}
+
+function _isMinifyablePath(filePath) {
+    const normalizedFilePath = path.normalize(filePath);
+    return minifyablePaths.some(minifyPath =>
+        normalizedFilePath.startsWith(path.normalize(minifyPath))
+    );
+}
+
+function getKey(filePath, isDevBuild) {
+    return isDevBuild + filePath;
+}
+
 const textContentMap = {};
 const excludeSuffixPathsInlining = ["MessageIds.json"];
-function inlineTextRequire(file, content, srcDir) {
+function inlineTextRequire(file, content, srcDir, isDevBuild = true) {
     if(content.includes(`'text!`) || content.includes("`text!")) {
         throw new Error(`in file ${file} require("text!...") should always use a double quote "text! instead of " or \``);
     }
     if(content.includes(`"text!`)) {
         const requireFragments = extractRequireTextFragments(content);
         for (const {requirePath, requireStatement} of requireFragments) {
-            let textContent = textContentMap[requirePath];
             let filePath = srcDir + requirePath;
             if(requirePath.startsWith("./")) {
                 filePath = path.join(path.dirname(file), requirePath);
             }
+            let textContent = textContentMap[getKey(filePath, isDevBuild)];
+
             if(!textContent){
                 console.log("reading file at path: ", filePath);
-                const fileContent = fs.readFileSync(filePath, "utf8");
-                textContentMap[requirePath] = fileContent;
+                let fileContent = fs.readFileSync(filePath, "utf8");
+
+                // Minify inline if this is a minifyable path and we're in production mode
+                if (!isDevBuild && _isMinifyablePath(filePath)) {
+                    console.log("Minifying file inline:", filePath);
+                    fileContent = _minifyBrowserContextFile(fileContent);
+                }
+
+                textContentMap[getKey(filePath, isDevBuild)] = fileContent;
                 textContent = fileContent;
             }
             if((requirePath.endsWith(".js") && !requirePath.includes("./")) // js files that are relative paths are ok
@@ -626,7 +671,7 @@ function inlineTextRequire(file, content, srcDir) {
     return content;
 }
 
-function makeBracketsConcatJS() {
+function _makeBracketsConcatJSInternal(isDevBuild = true) {
     return new Promise((resolve)=>{
         const srcDir = "src/";
         const DO_NOT_CONCATENATE = [
@@ -660,7 +705,7 @@ function makeBracketsConcatJS() {
                 console.log("Merging: ", requirePath);
                 mergeCount ++;
                 content = content.replace("define(", `define("${requirePath}", `);
-                content = inlineTextRequire(file, content, srcDir);
+                content = inlineTextRequire(file, content, srcDir, isDevBuild);
                 concatenatedFile = concatenatedFile + "\n" + content;
             }
         }
@@ -671,6 +716,14 @@ function makeBracketsConcatJS() {
     });
 }
 
+function makeBracketsConcatJS() {
+    return _makeBracketsConcatJSInternal(true);
+}
+
+function makeBracketsConcatJSWithMinifiedBrowserScripts() {
+    return _makeBracketsConcatJSInternal(false);
+}
+
 function _renameBracketsConcatAsBracketsJSInDist() {
     return new Promise((resolve)=>{
         fs.unlinkSync("dist/brackets.js");
@@ -759,8 +812,8 @@ function makeExtensionConcatJS(extensionName) {
                     `define("${defineId}", `
                 );
 
-                // inline text requires
-                content = inlineTextRequire(file, content, extensionDir);
+                // inline text requires (extensions use isDevBuild=true, they're minified via makeJSDist)
+                content = inlineTextRequire(file, content, extensionDir, true);
 
                 concatenatedFile += '\n' + content;
                 mergeCount++;
@@ -1005,25 +1058,27 @@ function _patchMinifiedCSSInDistIndex() {
 const createDistTest = series(copyDistToDistTestFolder, copyTestToDistTestFolder, copyIndexToDistTestFolder);
 
 exports.build = series(copyThirdPartyLibs.copyAll, makeLoggerConfig, generateProLoaderFiles, zipDefaultProjectFiles, zipSampleProjectFiles,
-    makeBracketsConcatJS, _compileLessSrc, _cleanReleaseBuildArtefactsInSrc, // these are here only as sanity check so as to catch release build minify fails not too late
+    makeBracketsConcatJS, makeBracketsConcatJSWithMinifiedBrowserScripts, _compileLessSrc, _cleanReleaseBuildArtefactsInSrc, // these are here only as sanity check so as to catch release build minify fails not too late
     createSrcCacheManifest, validatePackageVersions);
 exports.buildDebug = series(copyThirdPartyLibs.copyAllDebug, makeLoggerConfig, generateProLoaderFiles, zipDefaultProjectFiles,
-    makeBracketsConcatJS, _compileLessSrc, _cleanReleaseBuildArtefactsInSrc, // these are here only as sanity check so as to catch release build minify fails not too late
+    makeBracketsConcatJS, makeBracketsConcatJSWithMinifiedBrowserScripts, _compileLessSrc, _cleanReleaseBuildArtefactsInSrc, // these are here only as sanity check so as to catch release build minify fails not too late
     zipSampleProjectFiles, createSrcCacheManifest);
 exports.clean = series(cleanDist);
 exports.reset = series(cleanAll);
 
 exports.releaseDev = series(cleanDist, exports.buildDebug, makeBracketsConcatJS, makeConcatExtensions, _compileLessSrc,
     makeDistAll, cleanUnwantedFilesInDist, releaseDev, _renameConcatExtensionsinDist,
     createDistCacheManifest, createDistTest, _cleanPhoenixProGitFolder, _cleanReleaseBuildArtefactsInSrc);
-exports.releaseStaging = series(cleanDist, exports.build, makeBracketsConcatJS, makeConcatExtensions, _compileLessSrc,
-    makeDistNonJS, makeJSDist, makeJSPrettierDist, makeNonMinifyDist, cleanUnwantedFilesInDist,
-    _renameBracketsConcatAsBracketsJSInDist, _renameConcatExtensionsinDist, _patchMinifiedCSSInDistIndex, releaseStaging,
-    createDistCacheManifest, createDistTest, _deletePhoenixProSourceFolder, _cleanReleaseBuildArtefactsInSrc);
-exports.releaseProd = series(cleanDist, exports.build, makeBracketsConcatJS, makeConcatExtensions, _compileLessSrc,
-    makeDistNonJS, makeJSDist, makeJSPrettierDist, makeNonMinifyDist, cleanUnwantedFilesInDist,
-    _renameBracketsConcatAsBracketsJSInDist, _renameConcatExtensionsinDist, _patchMinifiedCSSInDistIndex, releaseProd,
-    createDistCacheManifest, createDistTest, _deletePhoenixProSourceFolder, _cleanReleaseBuildArtefactsInSrc);
+exports.releaseStaging = series(cleanDist, exports.build, makeBracketsConcatJSWithMinifiedBrowserScripts,
+    makeConcatExtensions, _compileLessSrc, makeDistNonJS, makeJSDist, makeJSPrettierDist, makeNonMinifyDist,
+    cleanUnwantedFilesInDist, _renameBracketsConcatAsBracketsJSInDist, _renameConcatExtensionsinDist,
+    _patchMinifiedCSSInDistIndex, releaseStaging, createDistCacheManifest, createDistTest,
+    _deletePhoenixProSourceFolder, _cleanReleaseBuildArtefactsInSrc);
+exports.releaseProd = series(cleanDist, exports.build, makeBracketsConcatJSWithMinifiedBrowserScripts,
+    makeConcatExtensions, _compileLessSrc, makeDistNonJS, makeJSDist, makeJSPrettierDist, makeNonMinifyDist,
+    cleanUnwantedFilesInDist, _renameBracketsConcatAsBracketsJSInDist, _renameConcatExtensionsinDist,
+    _patchMinifiedCSSInDistIndex, releaseProd, createDistCacheManifest, createDistTest,
+    _deletePhoenixProSourceFolder, _cleanReleaseBuildArtefactsInSrc);
 exports.releaseWebCache = series(makeDistWebCache);
 exports.serve = series(exports.build, serve);
 exports.zipTestFiles = series(zipTestFiles);

src/LiveDevelopment/BrowserScripts/RemoteFunctions.js

@@ -1,4 +1,4 @@
-// this is a single non-minified file sent to browser preview. keep this light. add features as extensions
+// this is a single file sent to browser preview. keep this light. add features as extensions
 /**
  * RemoteFunctions define the functions to be executed in the browser. This
  * modules should define a single function that returns an object of all