Merge pull request #43 from EmbeddedEnterprises/runtime-registry

feat: create a manifest for the built configurations + include glibc/abi

Author: aminya

package.json

@@ -36,7 +36,7 @@
   },
   "bin": "build/main.js",
   "scripts": {
-    "clean": "shx rm -rf build",
+    "clean": "shx rm -rf build ./test/.tmp",
     "lint.eslint": "eslint . --cache --cache-location ./.cache/.eslintcache \"./**/*.{js,ts,mjs,mts,cjs,cts,json,yaml,yml}\" --fix",
     "lint.biome": "biome check --write --unsafe .",
     "lint": "turbo run lint.eslint lint.biome",
@@ -87,6 +87,7 @@
     "@types/tar": "^6.1.13",
     "@types/url-join": "~4.0.3",
     "@types/which": "~3.0.4",
+    "@types/escape-quotes": "^1.0.0",
     "@upleveled/babel-plugin-remove-node-prefix": "^1.0.5",
     "turbo": "^2.4.4",
     "cross-env": "^7.0.3",
@@ -113,9 +114,10 @@
     "tar": "^6",
     "url-join": "^4.0.1",
     "which": "^2",
-    "node-downloader-helper": "^2.1.7"
+    "node-downloader-helper": "^2.1.7",
+    "escape-quotes": "^1.0.2"
   },
-  "packageManager": "pnpm@10.6.5",
+  "packageManager": "pnpm@10.7.0",
   "$schema": "https://raw.githubusercontent.com/SchemaStore/schemastore/master/src/schemas/json/package.json",
   "pnpm": {
     "onlyBuiltDependencies": ["core-js", "esbuild"]

pnpm-lock.yaml

@@ -17,6 +17,12 @@ export type BuildConfigurationDefaulted = {
 
   // list of additional definitions to fixup node quirks for some specific versions
   additionalDefines: string[]
+
+  /** The ABI number that is used by the runtime. */
+  abi?: number
+
+  /** The libc that is used by the runtime. */
+  libc?: string
 }
 
 export type BuildConfiguration = Partial<BuildConfigurationDefaulted>

src/lib.ts

@@ -2,8 +2,8 @@
 
 /* eslint-disable node/shebang */
 
-import { join, resolve } from "path"
-import { copy, ensureDir, pathExists, readJson, remove } from "fs-extra"
+import { join, relative, resolve } from "path"
+import { copy, ensureDir, pathExists, readFile, readJson, remove, writeFile } from "fs-extra"
 import { ArgumentBuilder } from "./argumentBuilder.js"
 import { determineBuildMode } from "./buildMode.js"
 import { type BuildOptions, defaultBuildConfiguration, defaultBuildOptions } from "./lib.js"
@@ -127,19 +127,28 @@ async function main(): Promise<void> {
     // Copy back the previously built binary
     process.stdout.write(`> Copying ${configs.projectName}.node to target directory... `)
     await ensureDir(targetDir)
-    if (configs.generatorToUse.includes("Visual Studio")) {
-      if (DEBUG_LOG !== undefined) {
-        console.log("Applying copy fix for MSVC projects")
-      }
-      await copy(
-        join(stagingDir, configs.buildType, `${configs.projectName}.node`),
-        join(targetDir, `${configs.projectName}.node`),
-      )
-    } else {
-      await copy(join(stagingDir, `${configs.projectName}.node`), join(targetDir, `${configs.projectName}.node`))
-    }
+
+    const addonPath = join(targetDir, `${configs.projectName}.node`)
+    const sourceAddonPath = configs.generatorToUse.includes("Visual Studio")
+      ? join(stagingDir, configs.buildType, `${configs.projectName}.node`)
+      : join(stagingDir, `${configs.projectName}.node`)
+    await copy(sourceAddonPath, addonPath)
+
     console.log("[ DONE ]")
 
+    console.log("Adding the built config to the manifest file...")
+
+    // read the manifest if it exists
+    const manifestPath = join(configs.targetDirectory, "manifest.json")
+    let manifest: Record<string, string> = {}
+    if (await pathExists(manifestPath)) {
+      const manifestContent = await readFile(manifestPath, "utf-8")
+      manifest = JSON.parse(manifestContent)
+    }
+    // add the new entry to the manifest
+    manifest[JSON.stringify(config)] = relative(configs.targetDirectory, addonPath)
+    await writeFile(manifestPath, JSON.stringify(manifest, null, 2))
+
     console.log("----------------- END CONFIG -----------------")
   }
 }

src/main.ts

@@ -1,6 +1,6 @@
 import { extname, join as joinPath } from "path"
 import glob from "fast-glob"
-import { ensureDir, readFile } from "fs-extra"
+import { ensureDir, pathExists, readFile } from "fs-extra"
 import urlJoin from "url-join"
 import { downloadFile, downloadTgz, downloadToString } from "./download.js"
 import type { BuildConfigurationDefaulted } from "./lib.js"
@@ -112,6 +112,11 @@ export class RuntimeDistribution {
       return Promise.reject(new Error("Invalid version specified by NODE_MODULE_VERSION macro"))
     }
     this._abi = version
+
+    this.config.abi = version
+
+    this.config.libc = await detectLibc()
+
     return Promise.resolve()
   }
 
@@ -190,3 +195,17 @@ export class RuntimeDistribution {
     }
   }
 }
+
+async function detectLibc() {
+  if (process.platform === "linux") {
+    if (await pathExists("/etc/alpine-release")) {
+      return "musl"
+    }
+    return "glibc"
+  } else if (process.platform === "darwin") {
+    return "libc"
+  } else if (process.platform === "win32") {
+    return "msvc"
+  }
+  return "unknown"
+}

src/runtimeDistribution.ts

@@ -2,10 +2,11 @@ import { execFileSync } from "child_process"
 import path, { join } from "path"
 import { fileURLToPath } from "url"
 import { isCI } from "ci-info"
-import glob from "fast-glob"
-import { existsSync, remove } from "fs-extra"
+import { existsSync, readJson, remove } from "fs-extra"
 import { beforeAll, beforeEach, expect, suite, test } from "vitest"
+import type { BuildConfigurationDefaulted } from "../src/lib.js"
 import { HOME_DIRECTORY } from "../src/urlRegistry.js"
+
 const dirname = typeof __dirname === "string" ? __dirname : path.dirname(fileURLToPath(import.meta.url))
 const root = path.dirname(dirname)
 
@@ -46,14 +47,37 @@ suite("zeromq", { timeout: 300_000 }, (tests) => {
         cwd: zeromqPath,
       })
 
-      const addons = await glob(`build/${process.platform}/${process.arch}/node/*/addon.node`, {
-        cwd: zeromqPath,
-        absolute: true,
-        onlyFiles: true,
-        braceExpansion: false,
+      const addonPath = `${process.platform}/${process.arch}/node/131/addon.node`
+
+      // check manifest file
+      const manifestPath = join(zeromqPath, "build/manifest.json")
+      expect(existsSync(manifestPath), `Manifest file ${manifestPath} does not exist`).toBe(true)
+      const manifest = (await readJson(manifestPath)) as Record<string, string>
+
+      const configKey = JSON.parse(Object.keys(manifest)[0]) as BuildConfigurationDefaulted
+
+      const expectedConfig: BuildConfigurationDefaulted = {
+        name: "",
+        dev: false,
+        os: process.platform,
+        arch: process.arch,
+        runtime: "node",
+        runtimeVersion: process.versions.node,
+        toolchainFile: null,
+        CMakeOptions: [],
+        addonSubdirectory: "",
+        additionalDefines: [],
+        abi: configKey.abi,
+        libc: configKey.libc,
+      }
+
+      expect(manifest).toEqual({
+        [JSON.stringify(expectedConfig)]: addonPath,
       })
 
-      expect(addons.length).toBe(1)
+      // check if the addon.node file exists
+      const addonNodePath = join(zeromqPath, "build", addonPath)
+      expect(existsSync(addonNodePath), `Addon node file ${addonNodePath} does not exist`).toBe(true)
     })
   }
 })