Dereference framework directories

Author: kraenhansen

packages/cmake-rn/src/platforms/apple.ts

@@ -391,6 +391,7 @@ export const platform: Platform<Triplet[], AppleOpts> = {
         outputPath: xcframeworkOutputPath,
         frameworkPaths,
         autoLink,
+        dereferenceFrameworkLinks: true,
       }),
       {
         text: `Assembling XCFramework (${libraryName})`,

packages/host/src/node/path-utils.test.ts

@@ -13,6 +13,7 @@ import {
   isNodeApiModule,
   stripExtension,
   findNodeApiModulePathsByDependency,
+  dereferenceDirectory,
 } from "./path-utils.js";
 import { setupTempDirectory } from "./test-utils.js";
 
@@ -502,3 +503,37 @@ describe("findNodeAddonForBindings()", () => {
     });
   }
 });
+
+describe("dereferenceDirectory", () => {
+  describe("when directory contains symlinks", () => {
+    it("should dereference symlinks", async (context) => {
+      // Create a temp directory with a symlink
+      const tempDir = setupTempDirectory(context, {
+        "original/file.txt": "Hello, world!",
+      });
+      const originalPath = path.join(tempDir, "original");
+      const symlinkPath = path.join(tempDir, "link");
+      // Create a link to the original directory
+      fs.symlinkSync(originalPath, symlinkPath, "dir");
+      // And an internal link
+      fs.symlinkSync(
+        path.join(originalPath, "file.txt"),
+        path.join(originalPath, "linked-file.txt"),
+        "file",
+      );
+
+      await dereferenceDirectory(symlinkPath);
+
+      // Verify that outer link is no longer a link
+      const symlinkStat = await fs.promises.lstat(symlinkPath);
+      assert(!symlinkStat.isSymbolicLink());
+
+      // Verify that the internal link is still a link to a readable file
+      const internalLinkPath = path.join(symlinkPath, "linked-file.txt");
+      const internalLinkStat = await fs.promises.lstat(internalLinkPath);
+      assert(internalLinkStat.isSymbolicLink());
+      const content = await fs.promises.readFile(internalLinkPath, "utf8");
+      assert.equal(content, "Hello, world!");
+    });
+  });
+});

packages/host/src/node/path-utils.ts

@@ -483,3 +483,16 @@ export function findNodeAddonForBindings(id: string, fromDir: string) {
   }
   return undefined;
 }
+
+export async function dereferenceDirectory(dirPath: string) {
+  const tempPath = dirPath + ".tmp";
+  // Move the existing framework out of the way
+  await fs.promises.rename(dirPath, tempPath);
+  // Only dereference the symlink at tempPath (not recursively)
+  const realPath = await fs.promises.realpath(tempPath);
+  await fs.promises.cp(realPath, dirPath, {
+    recursive: true,
+    verbatimSymlinks: true,
+  });
+  await fs.promises.unlink(tempPath);
+}

packages/host/src/node/prebuilds/apple.ts

@@ -6,7 +6,10 @@ import os from "node:os";
 import { spawn } from "@react-native-node-api/cli-utils";
 
 import { AppleTriplet } from "./triplets.js";
-import { determineLibraryBasename } from "../path-utils.js";
+import {
+  dereferenceDirectory,
+  determineLibraryBasename,
+} from "../path-utils.js";
 
 type AppleArchitecture = "arm64" | "x86_64" | "arm64;x86_64";
 
@@ -42,6 +45,7 @@ type XCframeworkOptions = {
   frameworkPaths: string[];
   outputPath: string;
   autoLink: boolean;
+  dereferenceFrameworkLinks: boolean;
 };
 
 export async function createAppleFramework(
@@ -97,6 +101,7 @@ export async function createXCframework({
   frameworkPaths,
   outputPath,
   autoLink,
+  dereferenceFrameworkLinks,
 }: XCframeworkOptions) {
   // Delete any existing xcframework to prevent the error:
   // - A library with the identifier 'macos-arm64' already exists.
@@ -121,6 +126,17 @@ export async function createXCframework({
       outputMode: "buffered",
     },
   );
+  if (dereferenceFrameworkLinks) {
+    // TODO: Loop over the framework directories and copy their content if they're links
+    for await (const entry of fs.promises.glob("**/*.framework", {
+      cwd: xcodeOutputPath,
+      withFileTypes: true,
+    })) {
+      if (entry.isSymbolicLink()) {
+        await dereferenceDirectory(path.join(entry.parentPath, entry.name));
+      }
+    }
+  }
   if (xcodeOutputPath !== outputPath) {
     // Rename the xcframework to the original output path
     await fs.promises.rename(xcodeOutputPath, outputPath);