Merge pull request #48 from EmbeddedEnterprises/glibc-conflict

fix: prevent conflict between binaries

Author: aminya

src/build.ts

@@ -79,12 +79,16 @@ export async function buildConfig(config: BuildConfiguration, opts: Options) {
 
   logger.debug("> Building directories... ")
 
-  const stagingDir = resolve(
-    join(config.stagingDirectory, config.os, config.arch, config.runtime, `${dist.abi()}`, config.addonSubdirectory),
-  )
-  const targetDir = resolve(
-    join(config.targetDirectory, config.os, config.arch, config.runtime, `${dist.abi()}`, config.addonSubdirectory),
+  const subDirectory = join(
+    config.os,
+    config.arch,
+    config.runtime,
+    `${config.libc}-${dist.abi()}-${config.buildType}`,
+    config.addonSubdirectory,
   )
+
+  const stagingDir = resolve(join(config.stagingDirectory, subDirectory))
+  const targetDir = resolve(join(config.targetDirectory, subDirectory))
   logger.debug("[ DONE ]")
 
   logger.debug("> Applying overrides... ")
@@ -150,6 +154,18 @@ Build Type: ${config.buildType}
     manifest = JSON.parse(manifestContent)
   }
   // add the new entry to the manifest
-  manifest[JSON.stringify(config)] = relative(config.targetDirectory, addonPath)
+  manifest[serializeConfig(config, config.packageDirectory)] = relative(config.targetDirectory, addonPath)
   await writeFile(manifestPath, JSON.stringify(manifest, null, 2))
 }
+
+function serializeConfig(config: BuildConfiguration, rootDir: string) {
+  // replace absolute paths with relative paths
+  const serialized = JSON.stringify(config, (_key, value) => {
+    if (typeof value === "string" && value.startsWith(rootDir)) {
+      return relative(rootDir, value)
+    }
+    return value
+  })
+
+  return serialized
+}

src/config.ts

@@ -176,7 +176,7 @@ export type BuildConfiguration = {
   // Optimization levels
 
   /** Release, Debug, or RelWithDebInfo build */
-  buildType: string
+  buildType: "Release" | "Debug" | "RelWithDebInfo"
   /** Whether the build is a development build. */
   dev: boolean
 
@@ -388,7 +388,7 @@ const architectures = new Set<NodeJS.Architecture>([
   "x64",
 ])
 
-const buildTypes = new Map<BuildConfiguration["buildType"], BuildConfiguration["buildType"]>([
+const buildTypes = new Map<string, BuildConfiguration["buildType"]>([
   ["release", "Release"],
   ["debug", "Debug"],
   ["relwithdebinfo", "RelWithDebInfo"],

test/zeromq.test.ts

@@ -59,11 +59,11 @@ suite("zeromq", { timeout: 300_000 }, async () => {
         runtime: "node",
         runtimeVersion: process.versions.node,
         buildType: "Release",
-        packageDirectory: zeromqPath,
+        packageDirectory: "",
         projectName: "addon",
         nodeAPI: "node-addon-api",
-        targetDirectory: await realpath(join(zeromqPath, "build")),
-        stagingDirectory: await realpath(join(zeromqPath, "staging")),
+        targetDirectory: "build",
+        stagingDirectory: "staging",
         cmakeToUse: await which("cmake"),
         generatorToUse: "Ninja",
         generatorBinary: await which("ninja"),
@@ -75,7 +75,13 @@ suite("zeromq", { timeout: 300_000 }, async () => {
       }
 
       expect(configKey.abi).toBeDefined()
-      const addonPath = join(process.platform, process.arch, "node", configKey.abi!.toString(), "addon.node")
+      const addonPath = join(
+        process.platform,
+        process.arch,
+        "node",
+        `${configKey.libc}-${configKey.abi}-${configKey.buildType}`,
+        "addon.node",
+      )
 
       expect(configKey).toEqual(expectedConfig)
       expect(configValue).toEqual(addonPath)