Compare linked plugin frameworks as (id, frameworkName) pairs

Author: chrfalch

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

@@ -281,9 +281,75 @@ describe('assertPluginFrameworksLinked, linked frameworks from the marker', () =
 
     expect(check(app).lines).toEqual([EXPO_NOT_PROVIDED]);
   });
+
+  it('fails when plugins swap the ids of two linked frameworks', () => {
+    const app = scaffoldApp();
+    inject(app, [
+      REACT,
+      frameworkEntry('a', 'Foo', 'plugins/a.xcframework'),
+      frameworkEntry('b', 'Bar', 'plugins/b.xcframework'),
+    ]);
+    writeSidecar(app.appRoot, [
+      {id: 'a', frameworkName: 'Bar'},
+      {id: 'b', frameworkName: 'Foo'},
+    ]);
+
+    const {error, lines} = check(app);
+
+    expect(error).toBeInstanceOf(PluginFrameworkMismatchError);
+    expect(lines).toEqual([
+      'error: The Xcode project links Foo.framework (a), but the autolinking plugin that provides Foo gives it a different id. Run `npx react-native spm update` to relink Foo in the committed project for the whole team.',
+      'error: The Xcode project links Bar.framework (b), but the autolinking plugin that provides Bar gives it a different id. Run `npx react-native spm update` to relink Bar in the committed project for the whole team.',
+    ]);
+  });
+
+  it('fails once when a plugin changes the id of a linked framework', () => {
+    const app = scaffoldApp();
+    inject(app, [REACT, frameworkEntry('a', 'Foo', 'plugins/a.xcframework')]);
+    writeSidecar(app.appRoot, [{id: 'c', frameworkName: 'Foo'}]);
+
+    expect(check(app).lines).toEqual([
+      'error: The Xcode project links Foo.framework (a), but the autolinking plugin that provides Foo gives it a different id. Run `npx react-native spm update` to relink Foo in the committed project for the whole team.',
+    ]);
+  });
+
+  it('reports a new framework and swapped ids once each', () => {
+    const app = scaffoldApp();
+    inject(app, [
+      REACT,
+      frameworkEntry('a', 'Foo', 'plugins/a.xcframework'),
+      frameworkEntry('b', 'Bar', 'plugins/b.xcframework'),
+    ]);
+    writeSidecar(app.appRoot, [
+      {id: 'a', frameworkName: 'Bar'},
+      {id: 'b', frameworkName: 'Foo'},
+      {id: 'c', frameworkName: 'Baz'},
+    ]);
+
+    expect(check(app).lines).toEqual([
+      'error: Baz (c) is a precompiled framework from an autolinking plugin, but the Xcode project does not link it. Run `npx react-native spm update` to add Baz to the committed project for the whole team.',
+      'error: The Xcode project links Foo.framework (a), but the autolinking plugin that provides Foo gives it a different id. Run `npx react-native spm update` to relink Foo in the committed project for the whole team.',
+      'error: The Xcode project links Bar.framework (b), but the autolinking plugin that provides Bar gives it a different id. Run `npx react-native spm update` to relink Bar in the committed project for the whole team.',
+    ]);
+  });
 });
 
 describe('assertPluginFrameworksLinked, linked frameworks from the project, for an older marker', () => {
+  it('compares setting prefixes and names separately', () => {
+    const app = scaffoldApp();
+    injectWithOlderMarker(app, [
+      REACT,
+      frameworkEntry('a', 'Foo', 'plugins/a.xcframework'),
+      frameworkEntry('b', 'Bar', 'plugins/b.xcframework'),
+    ]);
+    writeSidecar(app.appRoot, [
+      {id: 'a', frameworkName: 'Bar'},
+      {id: 'b', frameworkName: 'Foo'},
+    ]);
+
+    expect(check(app)).toEqual({error: null, lines: []});
+  });
+
   it('compares only setting prefixes when the frameworks manifest is missing', () => {
     const app = scaffoldApp();
     injectWithOlderMarker(app, [REACT, HERMES, EXPO]);

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

@@ -2293,26 +2293,33 @@ class PluginFrameworkMismatchError extends Error {
 
 /**
  * The frameworks the project links: the setting prefix of every one, and the
- * names of the plugin ones. For an older marker they come from the embed
- * phase: null without one, and null names when the frameworks manifest that
- * tells plugin names from built-in ones is missing.
+ * names of the plugin ones. A marker that records them also pairs each plugin
+ * framework's id with its name. For an older marker they come from the embed
+ * phase, which cannot pair them: null without one, and null names when the
+ * frameworks manifest that tells plugin names from built-in ones is missing.
  */
 function readLinkedFrameworks(
   appRoot /*: string */,
   xcodeprojPath /*: string */,
-) /*: ?{settingPrefixes: Set<string>, pluginNames: ?Set<string>} */ {
+) /*: ?{
+  settingPrefixes: Set<string>,
+  pluginNames: ?Set<string>,
+  pluginFrameworks?: Array<{id: string, frameworkName: string}>,
+} */ {
   const builtinIds = new Set(BUILTIN_FRAMEWORKS.map(({id}) => id));
   const recorded = readMarker(xcodeprojPath)?.linkedFrameworks;
   if (recorded != null) {
+    const pluginFrameworks = recorded.filter(
+      framework => !builtinIds.has(framework.id),
+    );
     return {
       settingPrefixes: new Set(
         recorded.map(framework => frameworkSettingPrefix(framework.id)),
       ),
       pluginNames: new Set(
-        recorded
-          .filter(framework => !builtinIds.has(framework.id))
-          .map(framework => framework.frameworkName),
+        pluginFrameworks.map(framework => framework.frameworkName),
       ),
+      pluginFrameworks,
     };
   }
 
@@ -2393,12 +2400,19 @@ function assertPluginFrameworksLinked(
   const pairedNames = new Set(
     pluginFrameworks.map(framework => framework.frameworkName),
   );
+  const pairKey = (
+    {id, frameworkName} /*: {id: string, frameworkName: string, ...} */,
+  ) => JSON.stringify([id, frameworkName]);
+  const pairedPairs = new Set(pluginFrameworks.map(pairKey));
   const problems /*: Array<string> */ = [];
   for (const {id, frameworkName} of pluginFrameworks) {
-    if (
-      !linked.settingPrefixes.has(frameworkSettingPrefix(id)) ||
-      linked.pluginNames?.has(frameworkName) === false
-    ) {
+    // A name linked under another id is reported once, from the linked side.
+    const notLinked =
+      linked.pluginFrameworks != null
+        ? linked.pluginNames?.has(frameworkName) === false
+        : !linked.settingPrefixes.has(frameworkSettingPrefix(id)) ||
+          linked.pluginNames?.has(frameworkName) === false;
+    if (notLinked) {
       problems.push(
         `error: ${frameworkName} (${id}) is a precompiled framework from an autolinking plugin, but the Xcode project does not link it. Run \`npx react-native spm update\` to add ${frameworkName} to the committed project for the whole team.`,
       );
@@ -2418,6 +2432,17 @@ function assertPluginFrameworksLinked(
       );
     }
   }
+  for (const framework of linked.pluginFrameworks ?? []) {
+    const {id, frameworkName} = framework;
+    if (
+      pairedNames.has(frameworkName) &&
+      !pairedPairs.has(pairKey(framework))
+    ) {
+      problems.push(
+        `error: The Xcode project links ${frameworkName}.framework (${id}), but the autolinking plugin that provides ${frameworkName} gives it a different id. Run \`npx react-native spm update\` to relink ${frameworkName} in the committed project for the whole team.`,
+      );
+    }
+  }
   if (problems.length > 0) {
     problems.forEach(problem => console.error(problem));
     throw new PluginFrameworkMismatchError(problems);