[native assets] Rewrite install names for relocated native libraries (#153054)

Native libraries that are contributed by native asset builders can depend on each other. For macOS and iOS, native libraries are repackaged into Frameworks, which renders install names that have been written into dependent libraries invalid. 

With this change, a mapping between old and new install names is maintained, and install names in dependent libraries are rewritten as a final step.

Related to dart-lang/native#190

Author: blaugold

packages/flutter_tools/lib/executable.dart

@@ -52,6 +52,7 @@ import 'src/isolated/mustache_template.dart';
 import 'src/isolated/native_assets/native_assets.dart';
 import 'src/isolated/native_assets/test/native_assets.dart';
 import 'src/isolated/resident_web_runner.dart';
+import 'src/native_assets.dart';
 import 'src/pre_run_validator.dart';
 import 'src/project_validator.dart';
 import 'src/resident_runner.dart';
@@ -141,6 +142,7 @@ Future<void> main(List<String> args) async {
         // runner.run calls "terminal.applyFeatureFlags()"
       },
       PreRunValidator: () => PreRunValidator(fileSystem: globals.fs),
+      TestCompilerNativeAssetsBuilder: () => const TestCompilerNativeAssetsBuilderImpl(),
     },
     shutdownHooks: globals.shutdownHooks,
   );
@@ -249,7 +251,7 @@ List<FlutterCommand> generateCommands({
   TestCommand(
     verboseHelp: verboseHelp,
     verbose: verbose,
-    nativeAssetsBuilder: const TestCompilerNativeAssetsBuilderImpl(),
+    nativeAssetsBuilder: globals.nativeAssetsBuilder,
   ),
   UpgradeCommand(verboseHelp: verboseHelp),
   SymbolizeCommand(

packages/flutter_tools/lib/src/commands/test.dart

@@ -592,6 +592,7 @@ class TestCommand extends FlutterCommand with DeviceBasedDevelopmentArtifacts {
         shardIndex: shardIndex,
         totalShards: totalShards,
         testTimeRecorder: testTimeRecorder,
+        nativeAssetsBuilder: nativeAssetsBuilder,
       );
     } else {
       result = await testRunner.runTests(

packages/flutter_tools/lib/src/context_runner.dart

@@ -214,6 +214,7 @@ Future<T> runInContext<T>(
         fuchsiaSdk: globals.fuchsiaSdk!,
         operatingSystemUtils: globals.os,
         customDevicesConfig: globals.customDevicesConfig,
+        nativeAssetsBuilder: globals.nativeAssetsBuilder,
       ),
       DevtoolsLauncher: () => DevtoolsServerLauncher(
         processManager: globals.processManager,

packages/flutter_tools/lib/src/flutter_device_manager.dart

@@ -27,11 +27,11 @@ import 'macos/macos_device.dart';
 import 'macos/macos_ipad_device.dart';
 import 'macos/macos_workflow.dart';
 import 'macos/xcdevice.dart';
+import 'native_assets.dart';
 import 'preview_device.dart';
 import 'tester/flutter_tester.dart';
 import 'version.dart';
 import 'web/web_device.dart';
-
 import 'windows/windows_device.dart';
 import 'windows/windows_workflow.dart';
 
@@ -57,6 +57,7 @@ class FlutterDeviceManager extends DeviceManager {
     required OperatingSystemUtils operatingSystemUtils,
     required WindowsWorkflow windowsWorkflow,
     required CustomDevicesConfig customDevicesConfig,
+    required TestCompilerNativeAssetsBuilder? nativeAssetsBuilder,
   }) : deviceDiscoverers =  <DeviceDiscovery>[
     AndroidDevices(
       logger: logger,
@@ -88,6 +89,7 @@ class FlutterDeviceManager extends DeviceManager {
       processManager: processManager,
       logger: logger,
       artifacts: artifacts,
+      nativeAssetsBuilder: nativeAssetsBuilder,
     ),
     MacOSDevices(
       processManager: processManager,

packages/flutter_tools/lib/src/globals.dart

@@ -41,6 +41,7 @@ import 'macos/cocoapods.dart';
 import 'macos/cocoapods_validator.dart';
 import 'macos/xcdevice.dart';
 import 'macos/xcode.dart';
+import 'native_assets.dart';
 import 'persistent_tool_state.dart';
 import 'pre_run_validator.dart';
 import 'project.dart';
@@ -305,3 +306,5 @@ NonNullSafeBuilds get nonNullSafeBuilds => context.get<NonNullSafeBuilds>() ?? N
 /// A value of [null] indicates that no installation of java could be found on
 /// the host machine.
 Java? get java => context.get<Java>();
+
+TestCompilerNativeAssetsBuilder? get nativeAssetsBuilder => context.get<TestCompilerNativeAssetsBuilder>();

packages/flutter_tools/lib/src/isolated/native_assets/ios/native_assets.dart

@@ -9,7 +9,6 @@ import 'package:native_assets_cli/native_assets_cli_internal.dart';
 import '../../../base/file_system.dart';
 import '../../../build_info.dart';
 import '../../../globals.dart' as globals;
-
 import '../macos/native_assets_host.dart';
 import '../native_assets.dart';
 
@@ -232,8 +231,10 @@ final KernelAssetPath kernelAssetPath;
 /// For `flutter run -release` a multi-architecture solution is needed. So,
 /// `lipo` is used to combine all target architectures into a single file.
 ///
-/// The install name is set so that it matches what the place it will
-/// be bundled in the final app.
+/// The install name is set so that it matches with the place it will
+/// be bundled in the final app. Install names that are referenced in dependent
+/// libraries are updated to match the new install name, so that the referenced
+/// library can be found by the dynamic linker.
 ///
 /// Code signing is also done here, so that it doesn't have to be done in
 /// in xcode_backend.dart.
@@ -247,11 +248,15 @@ Future<void> _copyNativeAssetsIOS(
   if (assetTargetLocations.isNotEmpty) {
     globals.logger
         .printTrace('Copying native assets to ${buildUri.toFilePath()}.');
+
+    final Map<String, String> oldToNewInstallNames = <String, String>{};
+    final List<(File, String, Directory)> dylibs = <(File, String, Directory)>[];
+
     for (final MapEntry<KernelAssetPath, List<AssetImpl>> assetMapping
         in assetTargetLocations.entries) {
       final Uri target = (assetMapping.key as KernelAssetAbsolutePath).uri;
-      final List<Uri> sources = <Uri>[
-        for (final AssetImpl source in assetMapping.value) source.file!
+      final List<File> sources = <File>[
+        for (final AssetImpl source in assetMapping.value) fileSystem.file(source.file)
       ];
       final Uri targetUri = buildUri.resolveUri(target);
       final File dylibFile = fileSystem.file(targetUri);
@@ -260,12 +265,25 @@ Future<void> _copyNativeAssetsIOS(
         await frameworkDir.create(recursive: true);
       }
       await lipoDylibs(dylibFile, sources);
-      await setInstallNameDylib(dylibFile);
+
+      final String dylibFileName = dylibFile.basename;
+      final String newInstallName = '@rpath/$dylibFileName.framework/$dylibFileName';
+      final Set<String> oldInstallNames = await getInstallNamesDylib(dylibFile);
+      for (final String oldInstallName in oldInstallNames) {
+        oldToNewInstallNames[oldInstallName] = newInstallName;
+      }
+      dylibs.add((dylibFile, newInstallName, frameworkDir));
+
       // TODO(knopp): Wire the value once there is a way to configure that in the hook.
       // https://github.com/dart-lang/native/issues/1133
       await createInfoPlist(targetUri.pathSegments.last, frameworkDir, minimumIOSVersion: '12.0');
+    }
+
+    for (final (File dylibFile, String newInstallName, Directory frameworkDir) in dylibs) {
+      await setInstallNamesDylib(dylibFile, newInstallName, oldToNewInstallNames);
       await codesignDylib(codesignIdentity, buildMode, frameworkDir);
     }
+
     globals.logger.printTrace('Copying native assets done.');
   }
 }

packages/flutter_tools/lib/src/isolated/native_assets/macos/native_assets.dart

@@ -274,8 +274,10 @@ KernelAsset _targetLocationMacOS(
 /// For `flutter run -release` a multi-architecture solution is needed. So,
 /// `lipo` is used to combine all target architectures into a single file.
 ///
-/// The install name is set so that it matches what the place it will
-/// be bundled in the final app.
+/// The install name is set so that it matches with the place it will
+/// be bundled in the final app. Install names that are referenced in dependent
+/// libraries are updated to match the new install name, so that the referenced
+/// library can be found the dynamic linker.
 ///
 /// Code signing is also done here, so that it doesn't have to be done in
 /// in macos_assemble.sh.
@@ -290,11 +292,15 @@ Future<void> _copyNativeAssetsMacOS(
     globals.logger.printTrace(
       'Copying native assets to ${buildUri.toFilePath()}.',
     );
+
+    final Map<String, String> oldToNewInstallNames = <String, String>{};
+    final List<(File, String, Directory)> dylibs = <(File, String, Directory)>[];
+
     for (final MapEntry<KernelAssetPath, List<AssetImpl>> assetMapping
         in assetTargetLocations.entries) {
       final Uri target = (assetMapping.key as KernelAssetAbsolutePath).uri;
-      final List<Uri> sources = <Uri>[
-        for (final AssetImpl source in assetMapping.value) source.file!,
+      final List<File> sources = <File>[
+        for (final AssetImpl source in assetMapping.value) fileSystem.file(source.file),
       ];
       final Uri targetUri = buildUri.resolveUri(target);
       final String name = targetUri.pathSegments.last;
@@ -332,15 +338,28 @@ Future<void> _copyNativeAssetsMacOS(
         versionsDir.childDirectory('Current').childFile(name).path,
         from: dylibLink.parent.path,
       ));
-      await setInstallNameDylib(dylibFile);
+
+      final String dylibFileName = dylibFile.basename;
+      final String newInstallName = '@rpath/$dylibFileName.framework/$dylibFileName';
+      final Set<String> oldInstallNames = await getInstallNamesDylib(dylibFile);
+      for (final String oldInstallName in oldInstallNames) {
+        oldToNewInstallNames[oldInstallName] = newInstallName;
+      }
+      dylibs.add((dylibFile, newInstallName, frameworkDir));
+
       await createInfoPlist(name, resourcesDir);
+    }
+
+    for (final (File dylibFile, String newInstallName, Directory frameworkDir) in dylibs) {
+      await setInstallNamesDylib(dylibFile, newInstallName, oldToNewInstallNames);
       // Do not code-sign the libraries here with identity. Code-signing
       // for bundled dylibs is done in `macos_assemble.sh embed` because the
       // "Flutter Assemble" target does not have access to the signing identity.
       if (codesignIdentity != null) {
         await codesignDylib(codesignIdentity, buildMode, frameworkDir);
       }
     }
+
     globals.logger.printTrace('Copying native assets done.');
   }
 }
@@ -350,7 +369,10 @@ Future<void> _copyNativeAssetsMacOS(
 /// For `flutter run -release` a multi-architecture solution is needed. So,
 /// `lipo` is used to combine all target architectures into a single file.
 ///
-/// In contrast to [_copyNativeAssetsMacOS], it does not set the install name.
+/// The install names are set to the absolute paths from which the
+/// flutter_tester executable with load them. Install names that are
+/// referenced in dependent libraries are updated to match the new install name,
+/// so that the referenced library can be found the dynamic linker.
 ///
 /// Code signing is also done here.
 Future<void> _copyNativeAssetsMacOSFlutterTester(
@@ -364,11 +386,15 @@ Future<void> _copyNativeAssetsMacOSFlutterTester(
     globals.logger.printTrace(
       'Copying native assets to ${buildUri.toFilePath()}.',
     );
+
+    final Map<String, String> oldToNewInstallNames = <String, String>{};
+    final List<(File, String)> dylibs = <(File, String)>[];
+
     for (final MapEntry<KernelAssetPath, List<AssetImpl>> assetMapping
         in assetTargetLocations.entries) {
       final Uri target = (assetMapping.key as KernelAssetAbsolutePath).uri;
-      final List<Uri> sources = <Uri>[
-        for (final AssetImpl source in assetMapping.value) source.file!,
+      final List<File> sources = <File>[
+        for (final AssetImpl source in assetMapping.value) fileSystem.file(source.file),
       ];
       final Uri targetUri = buildUri.resolveUri(target);
       final File dylibFile = fileSystem.file(targetUri);
@@ -377,8 +403,19 @@ Future<void> _copyNativeAssetsMacOSFlutterTester(
         await targetParent.create(recursive: true);
       }
       await lipoDylibs(dylibFile, sources);
+      final String newInstallName = dylibFile.path;
+      final Set<String> oldInstallNames = await getInstallNamesDylib(dylibFile);
+      for (final String oldInstallName in oldInstallNames) {
+        oldToNewInstallNames[oldInstallName] = newInstallName;
+      }
+      dylibs.add((dylibFile, newInstallName));
+    }
+
+    for (final (File dylibFile, String newInstallName) in dylibs) {
+      await setInstallNamesDylib(dylibFile, newInstallName, oldToNewInstallNames);
       await codesignDylib(codesignIdentity, buildMode, dylibFile);
     }
+
     globals.logger.printTrace('Copying native assets done.');
   }
 }