refactor(apple): implement simple pbxproj parser (#2442)

Author: tido64

ios/app.mjs

@@ -21,7 +21,13 @@ import {
 import { generateInfoPlist } from "./infoPlist.mjs";
 import { generateLocalizations, getProductName } from "./localizations.mjs";
 import { generatePrivacyManifest } from "./privacyManifest.mjs";
-import { isObject, isString, projectPath, resolveResources } from "./utils.mjs";
+import {
+  assertObject,
+  isObject,
+  isString,
+  projectPath,
+  resolveResources,
+} from "./utils.mjs";
 import {
   PRODUCT_DISPLAY_NAME,
   PRODUCT_VERSION,
@@ -30,6 +36,7 @@ import {
   applySwiftFlags,
   applyUserHeaderSearchPaths,
   configureBuildSchemes,
+  openXcodeProject,
   overrideBuildSettings,
 } from "./xcode.mjs";
 
@@ -272,9 +279,57 @@ export function generateProject(
   return project;
 }
 
+/**
+ * @param {string} projectRoot
+ * @param {string} targetPlatform
+ * @param {JSONObject} options
+ * @returns {ProjectConfiguration}
+ */
+export function makeProject(projectRoot, targetPlatform, options, fs = nodefs) {
+  const project = generateProject(projectRoot, targetPlatform, options, fs);
+
+  /** @type {Record<string, Record<string, string | string[]>>} */
+  const mods = {
+    ReactTestApp: project.buildSettings,
+    ReactTestAppTests: project.testsBuildSettings,
+    ReactTestAppUITests: project.uitestsBuildSettings,
+  };
+
+  const pbxproj = openXcodeProject(project.xcodeprojPath, fs);
+  for (const target of pbxproj.targets) {
+    const { name: targetName } = target;
+    if (typeof targetName !== "string" || !(targetName in mods)) {
+      continue;
+    }
+
+    const targetBuildSettings = Object.entries(mods[targetName]);
+    for (const config of target.buildConfigurations) {
+      const { buildSettings } = config;
+      assertObject(buildSettings, "target.buildConfigurations[].buildSettings");
+
+      for (const [setting, value] of targetBuildSettings) {
+        if (Array.isArray(value)) {
+          const origValue = buildSettings[setting] ?? ["$(inherited)"];
+          if (Array.isArray(origValue)) {
+            origValue.push(...value);
+            buildSettings[setting] = origValue;
+          } else {
+            buildSettings[setting] = [origValue, ...value].join(" ");
+          }
+        } else {
+          buildSettings[setting] = value;
+        }
+      }
+    }
+  }
+  pbxproj.save();
+
+  return project;
+}
+
 if (isMain(import.meta.url)) {
   const [, , projectRoot, platform, options] = process.argv;
   const user = typeof options === "string" ? JSON.parse(options) : {};
-  const project = generateProject(projectRoot, platform, user);
+  const project = makeProject(projectRoot, platform, user);
   console.log(JSON.stringify(project, undefined, 2));
 }

ios/test_app.rb

@@ -127,35 +127,6 @@ def make_project!(project_root, target_platform, options)
   build_settings = project['buildSettings']
 
   app_project = Xcodeproj::Project.open(xcodeproj_path)
-  app_project.native_targets.each do |target|
-    case target.name
-    when 'ReactTestApp'
-      target.build_configurations.each do |config|
-        build_settings.each do |setting, value|
-          if value.is_a? Array
-            arr = config.build_settings[setting] || ['$(inherited)']
-            value.each { |v| arr << v }
-            config.build_settings[setting] = arr
-          else
-            config.build_settings[setting] = value
-          end
-        end
-      end
-    when 'ReactTestAppTests'
-      target.build_configurations.each do |config|
-        project['testsBuildSettings'].each do |setting, value|
-          config.build_settings[setting] = value
-        end
-      end
-    when 'ReactTestAppUITests'
-      target.build_configurations.each do |config|
-        project['uitestsBuildSettings'].each do |setting, value|
-          config.build_settings[setting] = value
-        end
-      end
-    end
-  end
-  app_project.save
 
   config = app_project.build_configurations[0]
   {

ios/utils.mjs

@@ -25,6 +25,39 @@ export function isString(value) {
   return typeof value === "string";
 }
 
+/**
+ * @param {JSONValue} value
+ * @param {string} key
+ * @returns {asserts value is JSONValue[]}
+ */
+export function assertArray(value, key) {
+  if (!Array.isArray(value)) {
+    throw new Error(`Expected '${key}' to be an array`);
+  }
+}
+
+/**
+ * @param {JSONValue} value
+ * @param {string} key
+ * @returns {asserts value is JSONObject}
+ */
+export function assertObject(value, key) {
+  if (!isObject(value)) {
+    throw new Error(`Expected '${key}' to be an object`);
+  }
+}
+
+/**
+ * @param {JSONValue} value
+ * @param {string} key
+ * @returns {asserts value is string}
+ */
+export function assertUniqueId(value, key) {
+  if (typeof value !== "string") {
+    throw new Error(`Expected '${key}' to be a unique id string`);
+  }
+}
+
 /**
  * @param {string} filename
  * @returns {JSONObject}

ios/xcode.mjs

@@ -3,7 +3,15 @@ import { XMLBuilder, XMLParser } from "fast-xml-parser";
 import * as nodefs from "node:fs";
 import * as path from "node:path";
 import { findFile, readTextFile, v } from "../scripts/helpers.js";
-import { isObject, isString } from "./utils.mjs";
+import {
+  assertArray,
+  assertObject,
+  assertUniqueId,
+  isObject,
+  isString,
+  jsonFromPlist,
+  plistFromJSON,
+} from "./utils.mjs";
 
 /**
  * @import {
@@ -216,6 +224,56 @@ export function configureBuildSchemes(
   }
 }
 
+/**
+ * @param {string} xcodeproj
+ */
+export function openXcodeProject(xcodeproj, fs = nodefs) {
+  const projectPath = path.join(xcodeproj, "project.pbxproj");
+  const pbxproj = jsonFromPlist(projectPath);
+  assertObject(pbxproj.objects, "pbxproj.objects");
+  assertUniqueId(pbxproj.rootObject, "pbxproj.rootObject");
+
+  const { objects } = pbxproj;
+  const project = objects[pbxproj.rootObject];
+  assertObject(project, pbxproj.rootObject);
+
+  const { targets } = project;
+  assertArray(targets, "rootObject.targets");
+
+  return {
+    save() {
+      fs.writeFileSync(projectPath, plistFromJSON(pbxproj, projectPath));
+    },
+    get targets() {
+      return targets.map((target, index) => {
+        assertUniqueId(target, `rootObject.targets[${index}]`);
+
+        const product = objects[target];
+        assertObject(product, target);
+
+        const { buildConfigurationList } = product;
+        assertUniqueId(buildConfigurationList, "buildConfigurationList");
+        assertObject(objects[buildConfigurationList], buildConfigurationList);
+
+        const { buildConfigurations } = objects[buildConfigurationList];
+        assertArray(buildConfigurations, "buildConfigurations");
+
+        /** @type {{ buildConfigurations: JSONObject[]; [key: string]: JSONValue; }} */
+        const targets = {
+          ...product,
+          buildConfigurations: buildConfigurations.map((config) => {
+            assertUniqueId(config, `buildConfigurations[${config}]`);
+            const buildConfiguration = objects[config];
+            assertObject(buildConfiguration, config);
+            return buildConfiguration;
+          }),
+        };
+        return targets;
+      });
+    },
+  };
+}
+
 /**
  * @param {JSONObject} buildSettings
  * @param {JSONObject} overrides

test/ios/xcode.test.ts

@@ -9,7 +9,7 @@ import {
 import * as path from "node:path";
 import { afterEach, beforeEach, describe, it } from "node:test";
 import { fileURLToPath, URL } from "node:url";
-import { isObject, jsonFromPlist } from "../../ios/utils.mjs";
+import { isObject } from "../../ios/utils.mjs";
 import {
   applyBuildSettings as applyBuildSettingsActual,
   applyPreprocessorDefinitions,
@@ -20,6 +20,7 @@ import {
   configureBuildSchemes as configureBuildSchemesActual,
   DEVELOPMENT_TEAM,
   GCC_PREPROCESSOR_DEFINITIONS,
+  openXcodeProject,
   OTHER_SWIFT_FLAGS,
   overrideBuildSettings,
   PRODUCT_BUILD_NUMBER,
@@ -471,43 +472,17 @@ describe("macos/ReactTestApp.xcodeproj", macosOnly, () => {
   // targeting macOS. Unlike when targeting iOS, the warnings are treated as
   // errors.
   it("does not specify development team", () => {
-    const xcodeproj = jsonFromPlist(
-      fileURLToPath(
-        new URL(
-          "../../macos/ReactTestApp.xcodeproj/project.pbxproj",
-          import.meta.url
-        )
-      )
+    const xcodeproj = new URL(
+      "../../macos/ReactTestApp.xcodeproj",
+      import.meta.url
     );
-
-    const { objects } = xcodeproj;
-
-    ok(isObject(objects));
-    ok(typeof xcodeproj.rootObject === "string");
-
-    const rootObject = objects[xcodeproj.rootObject];
-
-    ok(isObject(rootObject));
-    ok(Array.isArray(rootObject.targets));
-    ok(typeof rootObject.targets[0] === "string");
-
-    const appTarget = objects[rootObject.targets[0]];
+    const project = openXcodeProject(fileURLToPath(xcodeproj));
+    const appTarget = project.targets[0];
 
     ok(isObject(appTarget));
     equal(appTarget.name, "ReactTestApp");
-    ok(typeof appTarget.buildConfigurationList === "string");
-
-    const buildConfigurationList = objects[appTarget.buildConfigurationList];
-
-    ok(isObject(buildConfigurationList));
-    ok(Array.isArray(buildConfigurationList.buildConfigurations));
-
-    for (const config of buildConfigurationList.buildConfigurations) {
-      ok(typeof config === "string");
-
-      const buildConfiguration: JSONValue = objects[config];
 
-      ok(isObject(buildConfiguration));
+    for (const buildConfiguration of appTarget.buildConfigurations) {
       ok(isObject(buildConfiguration.buildSettings));
       equal(buildConfiguration.buildSettings[CODE_SIGN_IDENTITY], "-");
       equal(buildConfiguration.buildSettings[DEVELOPMENT_TEAM], undefined);