Implement stamping for passing down version info

Author: vitvakatu

.bazelrc

@@ -15,6 +15,10 @@ query --noexperimental_check_output_files
 build --nobuild_runfile_links
 coverage --build_runfile_links
 
+## Stamping for release builds
+# Enable with --config=release
+build:release --stamp --workspace_status_command=./bazel_scripts/stamp.sh
+
 ## JS
 
 # passes an argument `--skipLibCheck` to *every* spawn of tsc

app/electron-client/BUILD.bazel

@@ -1,8 +1,10 @@
 load("@aspect_rules_esbuild//esbuild:defs.bzl", "esbuild")
+load("@aspect_rules_js//js:defs.bzl", "js_binary")
 load("@aspect_rules_js//npm:defs.bzl", "npm_package")
 load("@aspect_rules_ts//ts:defs.bzl", "ts_config", "ts_project")
 load("@npm//:defs.bzl", "npm_link_all_packages", "npm_link_targets")
 load("@npm//app/electron-client:electron-builder/package_json.bzl", electron_builder_bin = "bin")
+load("//app/electron-client:bazel/buildInfo.bzl", "generate_build_info")
 
 npm_link_all_packages(name = "node_modules")
 
@@ -39,9 +41,9 @@ npm_package(
 esbuild(
     name = "bundle",
     srcs = glob(["src/**/*.ts"]) + [
-        "buildInfo.ts",
         "fileAssociations.ts",
         "paths.ts",
+        ":build_info",
     ],
     bundle = True,
     # Some configuration options (like plugins) cannot be defined in Bazel rule, so we use a config file.
@@ -97,3 +99,16 @@ electron_builder_bin.electron_builder(
     out_dirs = ["ide-dist"],
     visibility = ["//visibility:public"],
 )
+
+js_binary(
+    name = "create_build_info_script",
+    chdir = package_name(),
+    entry_point = "create-build-info.mjs",
+    visibility = ["//visibility:public"],
+)
+
+generate_build_info(
+    name = "build_info",
+    out = "buildInfo.ts",
+    visibility = ["//visibility:public"],
+)

app/electron-client/bazel/buildInfo.bzl

@@ -0,0 +1,34 @@
+"""
+Runs a script with a path to the stable status file as an argument.
+"""
+
+load("@aspect_bazel_lib//lib:stamping.bzl", "STAMP_ATTRS", "maybe_stamp")
+
+def _generate_build_info_impl(ctx):
+    args = ctx.actions.args()
+    args.add(ctx.outputs.out.path)
+    inputs = []
+    outputs = [ctx.outputs.out]
+    stamp = maybe_stamp(ctx)
+    if stamp:
+        args.add(stamp.stable_status_file.path)
+        inputs = [stamp.stable_status_file]
+
+    ctx.actions.run(
+        inputs = inputs,
+        outputs = outputs,
+        arguments = [args],
+        env = {
+            "BAZEL_BINDIR": ctx.bin_dir.path,
+        },
+        executable = ctx.executable._stamp_exec,
+    )
+    return [DefaultInfo(files = depset(outputs))]
+
+generate_build_info = rule(
+    implementation = _generate_build_info_impl,
+    attrs = dict({
+        "out": attr.output(mandatory = True),
+        "_stamp_exec": attr.label(executable = True, default = Label("//app/electron-client:create_build_info_script"), cfg = "exec"),
+    }, **STAMP_ATTRS),
+)

app/electron-client/create-build-info.mjs

@@ -0,0 +1,40 @@
+import fs from 'fs'
+import process from 'process'
+
+process.chdir(process.env.JS_BINARY__EXECROOT)
+
+const outputPath = process.argv[2]
+if (!outputPath) {
+  console.error('Output path is required')
+  process.exit(1)
+}
+const statusFilePath = process.argv[3]
+if (!statusFilePath) {
+  // This is normal, stamping is disabled. Write a dummy build info file.
+  fs.writeFileSync(
+    outputPath,
+    `export default {
+    version: '0.0.0-dev',
+    commit: '<snapshot>',
+  }`,
+    {
+      create: true,
+    },
+  )
+  process.exit(0)
+}
+const statusFile = fs.readFileSync(statusFilePath, 'utf8')
+
+// The file is basically a list of space-separated key-value pairs.
+const lines = statusFile.split('\n')
+const getValue = (prefix) => lines.find((line) => line.startsWith(prefix)).split(' ')[1]
+const ideVersion = getValue('STABLE_IDE_VERSION')
+const ideCommitHash = getValue('STABLE_IDE_COMMIT_HASH')
+
+fs.writeFileSync(
+  outputPath,
+  `export default {
+  version: '${ideVersion}',
+  commit: '${ideCommitHash}',
+}`,
+)

app/electron-client/tsconfig.json

@@ -7,5 +7,5 @@
       "@/*": ["./src/*"]
     }
   },
-  "include": ["src/*.ts", "tasks/*.ts", "tests/*.ts", "src/config.json", "*.ts", "esbuild.config.mjs", "electron-builder-config.cjs"],
+  "include": ["src/*.ts", "tasks/*.ts", "tests/*.ts", "src/config.json", "*.ts", "esbuild.config.mjs", "electron-builder-config.cjs", "create-build-info.mjs"],
 }

bazel_scripts/stamp.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+set -eou pipefail
+
+if [[ -n "${GITHUB_SHA:-}" ]]; then
+  IDE_COMMIT_HASH="$GITHUB_SHA"
+else
+  IDE_COMMIT_HASH="$(git rev-parse --verify HEAD)"
+fi
+
+if [[ -n "${ENSO_VERSION:-}" ]]; then
+  IDE_VERSION="$ENSO_VERSION"
+else
+  IDE_VERSION="$(date +%Y.%-m.%-d)-dev"
+fi
+
+
+echo "STABLE_IDE_VERSION $IDE_VERSION"
+echo "STABLE_IDE_COMMIT_HASH $IDE_COMMIT_HASH"

eslint.config.mjs

@@ -190,8 +190,8 @@ const config = [
       '**/generated',
       '**/*.json',
       'app/rust-ffi/pkg/',
-      'app/electron-client/pre-electron-builder.cjs',
       'app/electron-client/electron-builder-config.cjs',
+      'app/electron-client/create-build-info.cjs',
     ],
   },
   {