build: phoenix pro build info in about box

Author: abose

gulpfile.js/index.js

@@ -1075,10 +1075,10 @@ function _patchMinifiedCSSInDistIndex() {
 
 const createDistTest = series(copyDistToDistTestFolder, copyTestToDistTestFolder, copyIndexToDistTestFolder);
 
-exports.build = series(optionalBuild.clonePhoenixProRepo, copyThirdPartyLibs.copyAll, makeLoggerConfig, generateProLoaderFiles, zipDefaultProjectFiles, zipSampleProjectFiles,
+exports.build = series(optionalBuild.clonePhoenixProRepo, optionalBuild.generateProBuildInfo, copyThirdPartyLibs.copyAll, makeLoggerConfig, generateProLoaderFiles, zipDefaultProjectFiles, zipSampleProjectFiles,
     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(optionalBuild.clonePhoenixProRepo, copyThirdPartyLibs.copyAllDebug, makeLoggerConfig, generateProLoaderFiles, zipDefaultProjectFiles,
+exports.buildDebug = series(optionalBuild.clonePhoenixProRepo, optionalBuild.generateProBuildInfo, copyThirdPartyLibs.copyAllDebug, makeLoggerConfig, generateProLoaderFiles, zipDefaultProjectFiles,
     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);

gulpfile.js/optional-build.js

@@ -185,5 +185,52 @@ function clonePhoenixProRepo() {
     });
 }
 
-// Export the function
+/**
+ * Generates a JSON file with phoenix-pro build information including the commit ID.
+ * Only generates if the phoenix-pro folder exists.
+ * If the phoenix-pro directory is not a git repository, the commit ID will be "unknown".
+ */
+function generateProBuildInfo() {
+    return new Promise((resolve) => {
+        const phoenixProPath = path.resolve(__dirname, '../src/extensionsIntegrated/phoenix-pro');
+
+        // Only generate if phoenix-pro folder exists
+        if (!fs.existsSync(phoenixProPath)) {
+            console.log('Phoenix Pro folder not found, skipping buildInfo.json generation');
+            resolve();
+            return;
+        }
+
+        const gitPath = path.join(phoenixProPath, '.git');
+        let commitID = "unknown";
+
+        if (fs.existsSync(gitPath)) {
+            try {
+                commitID = execSync('git rev-parse --short HEAD', {
+                    cwd: phoenixProPath,
+                    encoding: 'utf8'
+                }).trim();
+                console.log(`Phoenix Pro commit ID: ${commitID}`);
+            } catch (error) {
+                console.warn('Could not get phoenix-pro commit ID:', error.message);
+                commitID = "unknown";
+            }
+        } else {
+            console.log('Phoenix Pro is not a git repository, using "unknown" for commit ID');
+        }
+
+        const buildInfo = {
+            phoenixProCommitID: commitID
+        };
+
+        const buildInfoPath = path.join(phoenixProPath, 'proBuildInfo.json');
+        fs.writeFileSync(buildInfoPath, JSON.stringify(buildInfo, null, 2));
+
+        console.log('Generated phoenix-pro/proBuildInfo.json');
+        resolve();
+    });
+}
+
+// Export the functions
 exports.clonePhoenixProRepo = clonePhoenixProRepo;
+exports.generateProBuildInfo = generateProBuildInfo;

src/extensionsIntegrated/phoenix-pro/.gitignore

@@ -0,0 +1 @@
+proBuildInfo.json

src/extensionsIntegrated/phoenix-pro/main.js

@@ -16,6 +16,10 @@ define(function (require, exports, module) {
         throw new Error("KernalModeTrust is not defined. Cannot boot without trust ring");
     }
 
+    const proBuildInfoJSON = require("text!./proBuildInfo.json");
+    const proBuildInfo = JSON.parse(proBuildInfoJSON);
+    Phoenix.pro.commitID = proBuildInfo.phoenixProCommitID;
+
     const HelperCode = require("text!./browser-context/helper.js");
     const ToolBoxCode = require("text!./browser-context/tool-box.js");
     const InfoBoxCode = require("text!./browser-context/info-box.js");

src/help/HelpCommandHandlers.js

@@ -72,6 +72,11 @@ define(function (require, exports, module) {
             Strings: Strings
         };
 
+        // If we have phoenix pro optional features built in
+        if (Phoenix.pro.commitID) {
+            templateVars.PRO_BUILD_COMMIT = window.Phoenix.pro.commitID;
+        }
+
         Dialogs.showModalDialogUsingTemplate(Mustache.render(AboutDialogTemplate, templateVars));
 
         // Get containers

src/htmlContent/about-dialog.html

@@ -8,6 +8,9 @@ <h1 class="dialog-title">{{Strings.ABOUT}}</h1>
             <h2>{{APP_NAME_ABOUT_BOX}}</h2>
             <div class="about-info">
                 <p class="dialog-message">{{Strings.ABOUT_TEXT_LINE1}} <span id="about-build-number">{{BUILD_INFO}}</span>
+                  {{#PRO_BUILD_COMMIT}}
+                  <br><span class="dialog-message">{{Strings.ABOUT_TEXT_PRO_BUILD}}{{PRO_BUILD_COMMIT}}</span>
+                  {{/PRO_BUILD_COMMIT}}
                   {{#BUILD_TIMESTAMP}}
                   <br><span class="dialog-message">{{Strings.ABOUT_TEXT_BUILD_TIMESTAMP}}{{BUILD_TIMESTAMP}}</span>
                   {{/BUILD_TIMESTAMP}}

src/nls/root/strings.js

@@ -706,6 +706,7 @@ define({
     "CLOSE": "Close",
     "ABOUT_TEXT_LINE1": "Release {VERSION_MAJOR}.{VERSION_MINOR} {BUILD_TYPE} {VERSION}",
     "ABOUT_TEXT_BUILD_TIMESTAMP": "build timestamp: ",
+    "ABOUT_TEXT_PRO_BUILD": "Phoenix Pro Build: ",
     "ABOUT_RELEASE_CREDITS": "Release Credits:",
     "ABOUT_TEXT_LINE3": "Third Party Libraries that we use - <a href='https://github.com/phcode-dev/phoenix/tree/main/src/thirdparty/licences'> Licences and Attributions</a> . ",
     "ABOUT_TEXT_LINE4": "Documentation and source at <a href='https://github.com/phcode-dev/phoenix/'>https://github.com/phcode-dev/phoenix/</a>",