Add scripts to verify example binaries

Author: kraenhansen

packages/node-addon-examples/package.json

@@ -2,10 +2,12 @@
   "name": "react-native-node-addon-examples",
   "private": true,
   "scripts": {
-    "e2e": "rm -rf tests && npm run copy-examples && npm run gyp-to-cmake && npm run build",
     "copy-examples": "tsx scripts/copy-examples.mts",
     "gyp-to-cmake": "gyp-to-cmake ./examples",
-    "build": "tsx scripts/build-examples.mts"
+    "build": "tsx scripts/build-examples.mts",
+    "copy-and-build": "npm run copy-examples && npm run gyp-to-cmake && npm run build",
+    "verify": "tsx scripts/verify-prebuilds.mts",
+    "test": "npm run copy-and-build && npm run verify"
   },
   "devDependencies": {
     "node-addon-examples": "github:nodejs/node-addon-examples#4213d4c9d07996ae68629c67926251e117f8e52a",

packages/node-addon-examples/scripts/build-examples.mts

@@ -7,7 +7,8 @@ const projectDirectories = findCMakeProjects();
 for (const projectDirectory of projectDirectories) {
   console.log(`Running "react-native-node-api-cmake" in ${projectDirectory}`);
   execSync(
-    "react-native-node-api-cmake --triplet aarch64-linux-android --triplet arm64-apple-ios-sim",
+    "react-native-node-api-cmake --android --apple",
+    // "react-native-node-api-cmake --triplet aarch64-linux-android --triplet arm64-apple-ios-sim",
     {
       cwd: projectDirectory,
       stdio: "inherit",

packages/node-addon-examples/scripts/verify-prebuilds.mts

@@ -0,0 +1,90 @@
+import fs from "node:fs";
+import assert from "node:assert/strict";
+import path from "node:path";
+
+import { EXAMPLES_DIR } from "./cmake-projects.mjs";
+
+const EXPECTED_ANDROID_ARCHS = ["armeabi-v7a", "arm64-v8a", "x86_64", "x86"];
+
+const EXPECTED_XCFRAMEWORK_PLATFORMS = [
+  "ios-arm64",
+  "ios-arm64-simulator",
+  "macos-arm64_x86_64",
+  "tvos-arm64",
+  "tvos-arm64-simulator",
+  "xros-arm64",
+  "xros-arm64-simulator",
+];
+
+async function verifyAndroidDirectory(dirent: fs.Dirent) {
+  for (const arch of EXPECTED_ANDROID_ARCHS) {
+    const archDir = path.join(dirent.parentPath, dirent.name, arch);
+    for (const file of await fs.promises.readdir(archDir, {
+      withFileTypes: true,
+    })) {
+      assert(file.isFile());
+      assert(
+        !file.name.endsWith(".node"),
+        `Unexpected .node file: ${path.join(file.parentPath, file.name)}`
+      );
+    }
+  }
+}
+
+async function verifyXcframework(dirent: fs.Dirent) {
+  for (const arch of EXPECTED_XCFRAMEWORK_PLATFORMS) {
+    const archDir = path.join(dirent.parentPath, dirent.name, arch);
+    for (const file of await fs.promises.readdir(archDir, {
+      withFileTypes: true,
+    })) {
+      assert(
+        file.isDirectory(),
+        "Expected only directories in xcframework arch directory"
+      );
+      assert(file.name.endsWith(".framework"), "Expected framework directory");
+      const frameworkDir = path.join(file.parentPath, file.name);
+      for (const file of await fs.promises.readdir(frameworkDir, {
+        withFileTypes: true,
+      })) {
+        if (file.isDirectory()) {
+          assert.equal(
+            file.name,
+            "Headers",
+            "Unexpected directory in xcframework"
+          );
+        } else {
+          assert(
+            file.isFile(),
+            "Expected only directory and files in framework"
+          );
+          if (file.name === "Info.plist") {
+            // TODO: Verify the contents of the Info.plist file
+            continue;
+          } else {
+            assert(
+              !file.name.endsWith(".node"),
+              `Didn't expected a .node file in xcframework: ${path.join(
+                frameworkDir,
+                file.name
+              )}`
+            );
+          }
+        }
+      }
+    }
+  }
+}
+
+for (const dirent of await fs.promises.readdir(EXAMPLES_DIR, {
+  withFileTypes: true,
+  recursive: true,
+})) {
+  if (!dirent.isDirectory()) {
+    continue;
+  }
+  if (dirent.name.endsWith(".android.node")) {
+    await verifyAndroidDirectory(dirent);
+  } else if (dirent.name.endsWith(".xcframework")) {
+    await verifyXcframework(dirent);
+  }
+}