Simplify plugin framework mismatch check and tests

Author: chrfalch

packages/react-native/scripts/spm/__docs__/spm-autolinking-plugins.md

@@ -130,10 +130,10 @@ The declarations are recorded to
 `<outputDir>/.spm-plugin-flavored-frameworks.json`, normalized into the same
 immutable app-local slots as React Native, and added to Xcode's exact linker and
 embed settings. They are not emitted as SwiftPM product dependencies. Adding or
-removing one requires `npx react-native spm`. The build-time `spm sync` never
-changes the Xcode project. When the frameworks that plugins provide and the
-frameworks that the project links disagree, sync fails the build. An `error:`
-line names each framework and the command to run.
+removing one requires `spm update`; the build-time `spm sync` intentionally does
+not mutate runtime framework settings. When the frameworks that plugins provide
+and the frameworks that the project links disagree, sync fails the build. An
+`error:` line names each framework and the command to run.
 
 ### `watchPaths` — plugin staleness inputs
 
@@ -351,10 +351,9 @@ green build missing native code) is worse than a loud stop.
   on the app target at the requested position, recording the id→UUID map in the
   `.spm-injected.json` marker so a re-run refreshes each phase's content in
   place, re-seats it when its declared position or order changed, `update`
-  removes phases that left the sidecar, and `deinit` reverts them. The
-  build-time `sync` only rewrites the sidecar; it never mutates the project.
-  (For `flavoredFrameworks`, it also fails the build when the project is out of
-  date.)
+  removes phases that left the sidecar, and `deinit` reverts them. Like
+  `flavoredFrameworks`, the build-time `sync` only rewrites the sidecar; it
+  never mutates the project.
 - **Co-design with Expo (not final):** codegen **provider ordering** — codegen
   must consume the same discovered module set the plugin contributes — is
   intentionally left for the first real plugin to drive to a stable shape.

packages/react-native/scripts/spm/__docs__/spm-scripts.md

@@ -755,7 +755,4 @@ script branches on the exit code:
 
 That split is the whole reason these cases have their own exit code: a transient
 sync hiccup should not break a build that could still succeed, while a missing
-manifest or an out-of-date project should not pass silently. Sync writes its
-stamp only after these checks pass. When the project is out of date, sync also
-removes the earlier stamp, so every following build fails the same way until the
-project is updated.
+manifest or an out-of-date project should not pass silently.

packages/react-native/scripts/spm/__tests__/plugin-framework-mismatch-test.js

@@ -119,23 +119,14 @@ function writeSidecar(appRoot, frameworks) {
 }
 
 function projectFiles(xcodeprojPath) {
-  const files = {};
-  const walk = dir => {
-    for (const entry of fs.readdirSync(dir, {withFileTypes: true})) {
-      const full = path.join(dir, entry.name);
-      if (entry.isDirectory()) {
-        walk(full);
-      } else {
-        files[path.relative(xcodeprojPath, full)] = fs.readFileSync(full);
-      }
-    }
-  };
-  walk(xcodeprojPath);
-  return files;
+  return ['project.pbxproj', SPM_INJECTED_MARKER].map(name => {
+    const file = path.join(xcodeprojPath, name);
+    return fs.existsSync(file) ? fs.readFileSync(file, 'utf8') : null;
+  });
 }
 
-// Runs the check and proves it wrote nothing under the .xcodeproj (pbxproj,
-// marker, scheme). Returns the printed lines and the thrown error, if any.
+// Runs the check and proves it wrote neither the pbxproj nor the marker.
+// Returns the printed lines and the thrown error, if any.
 function check(app, env = {}) {
   const before = projectFiles(app.xcodeprojPath);
   let error = null;
@@ -175,24 +166,6 @@ describe('assertPluginFrameworksLinked', () => {
     ]);
   });
 
-  it('reports every mismatch in both directions', () => {
-    const app = scaffoldApp();
-    const other = frameworkEntry(
-      'other-plugin',
-      'OtherPlugin',
-      'plugins/other-plugin.xcframework',
-    );
-    inject(app, [REACT, EXPO]);
-    writeSidecar(app.appRoot, [other]);
-
-    const {error, lines} = check(app);
-
-    expect(error).toBeInstanceOf(PluginFrameworkMismatchError);
-    expect(lines).toHaveLength(2);
-    expect(lines[0]).toMatch(/^error: OtherPlugin \(other-plugin\) /);
-    expect(lines[1]).toMatch(/^error: The Xcode project links ExpoCore\./);
-  });
-
   it('fails when a plugin renames its framework but keeps its id', () => {
     const app = scaffoldApp();
     inject(app, [REACT, EXPO]);
@@ -238,25 +211,12 @@ describe('assertPluginFrameworksLinked', () => {
     inject(app, [REACT, HERMES, EXPO]);
     writeSidecar(app.appRoot, [EXPO]);
     fs.rmSync(
-      path.join(
-        app.appRoot,
-        'build',
-        'xcframeworks',
-        'flavored-frameworks.json',
-      ),
+      path.join(app.appRoot, 'build/xcframeworks/flavored-frameworks.json'),
     );
 
     expect(check(app)).toEqual({error: null, lines: []});
   });
 
-  it('never reports built-in frameworks', () => {
-    const app = scaffoldApp();
-    inject(app, [REACT, HERMES]);
-    writeSidecar(app.appRoot, []);
-
-    expect(check(app)).toEqual({error: null, lines: []});
-  });
-
   it('skips a project that was never injected', () => {
     const app = scaffoldApp();
     writeSidecar(app.appRoot, [EXPO]);
@@ -268,27 +228,19 @@ describe('assertPluginFrameworksLinked', () => {
     const app = scaffoldApp();
     inject(app, [REACT]);
     writeSidecar(app.appRoot, [EXPO]);
-    const markerPath = path.join(app.xcodeprojPath, SPM_INJECTED_MARKER);
-    const marker = JSON.parse(fs.readFileSync(markerPath, 'utf8'));
-    fs.writeFileSync(
-      markerPath,
-      JSON.stringify({...marker, rootUuid: 'NOT_THE_PROJECT_ROOT'}),
-    );
+    fs.writeFileSync(path.join(app.xcodeprojPath, 'project.pbxproj'), PLAIN);
 
     expect(check(app)).toEqual({error: null, lines: []});
   });
 });
 
-describe('injectSpmIntoExistingXcodeproj with a plugin framework', () => {
-  it('is idempotent', () => {
-    const app = scaffoldApp();
-    inject(app, [REACT, EXPO]);
-    const pbxprojPath = path.join(app.xcodeprojPath, 'project.pbxproj');
-    const once = fs.readFileSync(pbxprojPath, 'utf8');
-    expect(once).toContain('$(RN_SPM_EXPO_CORE_FRAMEWORK)');
+it('injects a plugin framework idempotently', () => {
+  const app = scaffoldApp();
+  inject(app, [REACT, EXPO]);
+  const pbxprojPath = path.join(app.xcodeprojPath, 'project.pbxproj');
+  const once = fs.readFileSync(pbxprojPath, 'utf8');
 
-    inject(app, [REACT, EXPO]);
+  inject(app, [REACT, EXPO]);
 
-    expect(fs.readFileSync(pbxprojPath, 'utf8')).toBe(once);
-  });
+  expect(fs.readFileSync(pbxprojPath, 'utf8')).toBe(once);
 });

packages/react-native/scripts/spm/__tests__/sync-spm-autolinking-test.js

@@ -137,9 +137,9 @@ describe('sync-spm-autolinking main', () => {
     expect(fs.existsSync(stampPath())).toBe(false);
   });
 
-  // No stamp on a mismatch, so the next build re-runs sync and fails again
-  // until the project is updated.
-  it('fails without a stamp when plugin frameworks and the project disagree', async () => {
+  it('fails and removes the stamp when plugin frameworks and the project disagree', async () => {
+    fs.mkdirSync(path.dirname(stampPath()), {recursive: true});
+    fs.writeFileSync(stampPath(), 'earlier sync\n');
     const mismatch = new PluginFrameworkMismatchError();
     const deps = makeDeps({
       assertPluginFrameworksLinked: jest.fn(() => {
@@ -152,17 +152,4 @@ describe('sync-spm-autolinking main', () => {
     );
     expect(fs.existsSync(stampPath())).toBe(false);
   });
-
-  it('removes an earlier stamp when plugin frameworks and the project disagree', async () => {
-    fs.mkdirSync(path.dirname(stampPath()), {recursive: true});
-    fs.writeFileSync(stampPath(), 'earlier sync\n');
-    const mismatch = new PluginFrameworkMismatchError();
-    const deps = makeDeps({
-      assertPluginFrameworksLinked: jest.fn(() => {
-        throw mismatch;
-      }),
-    });
-    await expect(run(deps)).rejects.toBe(mismatch);
-    expect(fs.existsSync(stampPath())).toBe(false);
-  });
 });

packages/react-native/scripts/spm/generate-spm-xcodeproj.js

@@ -2231,7 +2231,7 @@ function readScriptPhasesManifest(
  */
 function readMarker(
   xcodeprojPath /*: string */,
-) /*: ?{rootUuid?: ?string, targetUuid?: ?string, generatedSources?: {[string]: Array<string>}, scriptPhases?: {[string]: string}, artifactsVersionOverride?: ?string, configCommand?: ?Array<string>, buildSettingChanges?: Array<BuildSettingChange>, createdArrayFields?: Array<CreatedArrayField>, scheme?: {file?: ?string, created?: ?boolean}, ...} */ {
+) /*: ?{targetUuid?: ?string, generatedSources?: {[string]: Array<string>}, scriptPhases?: {[string]: string}, artifactsVersionOverride?: ?string, configCommand?: ?Array<string>, buildSettingChanges?: Array<BuildSettingChange>, createdArrayFields?: Array<CreatedArrayField>, scheme?: {file?: ?string, created?: ?boolean}, ...} */ {
   const markerPath = path.join(xcodeprojPath, SPM_INJECTED_MARKER);
   try {
     // $FlowFixMe[incompatible-return] JSON.parse returns any
@@ -2277,17 +2277,9 @@ class PluginFrameworkMismatchError extends Error {
   }
 }
 
-function pbxListValues(list /*: string */) /*: Array<string> */ {
-  return (list.match(/"(?:[^"\\]|\\.)*"|[^\s,()"]+/g) ?? []).map(unquotePlist);
-}
-
 /**
- * Compares the precompiled frameworks autolinking plugins provide on this
- * machine with the plugin frameworks the injected project links. Only `spm
- * add` / `spm update` change what the project links, so the build-time sync
- * reports a mismatch instead of fixing it: one `error:` line per framework,
- * then PluginFrameworkMismatchError. Never writes the project. Checks the
- * project Xcode is building (`PROJECT_FILE_PATH`) when it is injected.
+ * Only `spm add` / `spm update` change what the project links, so the
+ * build-time sync reports a plugin framework mismatch instead of fixing it.
  */
 function assertPluginFrameworksLinked(
   appRoot /*: string */,
@@ -2300,15 +2292,17 @@ function assertPluginFrameworksLinked(
     fs.existsSync(path.join(builtProjectPath, SPM_INJECTED_MARKER))
       ? builtProjectPath
       : findInjectedXcodeproj(appRoot);
-  const rootUuid =
-    xcodeprojPath != null ? readMarker(xcodeprojPath)?.rootUuid : null;
-  if (xcodeprojPath == null || rootUuid == null) {
+  if (xcodeprojPath == null) {
     return;
   }
   const text = fs.readFileSync(
     path.join(xcodeprojPath, 'project.pbxproj'),
     'utf8',
   );
+  const rootUuid = findProjectObject(text)?.uuid;
+  if (rootUuid == null) {
+    return;
+  }
   const embedPhase = findObjectByUuid(
     text,
     namespacedUUID(
@@ -2321,14 +2315,10 @@ function assertPluginFrameworksLinked(
     return;
   }
 
-  const inputs = pbxListValues(
-    findField(text, embedPhase, 'inputPaths')?.value ?? '',
-  );
-  const outputs = pbxListValues(
-    findField(text, embedPhase, 'outputPaths')?.value ?? '',
-  );
+  const inputs = findField(text, embedPhase, 'inputPaths')?.value ?? '';
+  const outputs = findField(text, embedPhase, 'outputPaths')?.value ?? '';
   const linkedPrefixes = new Set(
-    inputs.map(input => /^\$\((RN_SPM_\w+)_FRAMEWORK\)$/.exec(input)?.[1]),
+    Array.from(inputs.matchAll(/\$\((RN_SPM_\w+)_FRAMEWORK\)/g), m => m[1]),
   );
   // Built-in framework names come from the staged manifest. Without it, only
   // setting prefixes are compared: a missing manifest is not a plugin mismatch.
@@ -2345,9 +2335,10 @@ function assertPluginFrameworksLinked(
         .map(framework => framework.frameworkName),
     );
     linkedPluginNames = new Set(
-      outputs
-        .map(output => path.basename(output, '.framework'))
-        .filter(name => !builtinNames.has(name)),
+      Array.from(
+        outputs.matchAll(/([^/"\s]+)\.framework\b/g),
+        m => m[1],
+      ).filter(name => !builtinNames.has(name)),
     );
   }