[native assets] Use workspace pubspec for user-defines

Native assets are cached for the whole pub workspace. So to avoid
invalidating caches for running hooks from different root packages,
only read user-defines from the workspace `pubspec.yaml`.

Bug: dart-lang/native#39
Bug: dart-lang/native#2187

Change-Id: I3aeb91455a418004d3e28c231dc1f5d002c15739
Cq-Include-Trybots: luci.dart.try:pkg-linux-debug-try,pkg-linux-release-arm64-try,pkg-linux-release-try,pkg-mac-release-arm64-try,pkg-win-release-arm64-try,pkg-mac-release-try,pkg-win-release-try
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/422101
Auto-Submit: Daco Harkes <[email protected]>
Reviewed-by: Hossein Yousefi <[email protected]>
Commit-Queue: Daco Harkes <[email protected]>

Author: dcharkes

pkg/dartdev/lib/src/commands/build.dart

@@ -135,7 +135,8 @@ class BuildCommand extends DartdevCommand {
     final runPackageName = await DartNativeAssetsBuilder.findRootPackageName(
       sourceUri,
     );
-    final pubspecUri = await DartNativeAssetsBuilder.findPubspec(sourceUri);
+    final pubspecUri =
+        await DartNativeAssetsBuilder.findWorkspacePubspec(packageConfig);
     final Map? pubspec;
     if (pubspecUri == null) {
       pubspec = null;

pkg/dartdev/lib/src/commands/compile.dart

@@ -630,7 +630,7 @@ Remove debugging information from the output and save it separately to the speci
       );
       if (runPackageName != null) {
         final pubspecUri =
-            await DartNativeAssetsBuilder.findPubspec(Directory.current.uri);
+            await DartNativeAssetsBuilder.findWorkspacePubspec(packageConfig);
         final Map? pubspec;
         if (pubspecUri == null) {
           pubspec = null;

pkg/dartdev/lib/src/commands/run.dart

@@ -393,7 +393,7 @@ class RunCommand extends DartdevCommand {
           );
       if (runPackageName != null) {
         final pubspecUri =
-            await DartNativeAssetsBuilder.findPubspec(Directory.current.uri);
+            await DartNativeAssetsBuilder.findWorkspacePubspec(packageConfig);
         final Map? pubspec;
         if (pubspecUri == null) {
           pubspec = null;

pkg/dartdev/lib/src/commands/test.dart

@@ -57,7 +57,7 @@ Run "${runner!.executableName} help" to see global options.''');
       );
       if (runPackageName != null) {
         final pubspecUri =
-            await DartNativeAssetsBuilder.findPubspec(Directory.current.uri);
+            await DartNativeAssetsBuilder.findWorkspacePubspec(packageConfig);
         final Map? pubspec;
         if (pubspecUri == null) {
           pubspec = null;

pkg/dartdev/lib/src/native_assets.dart

@@ -287,6 +287,17 @@ class DartNativeAssetsBuilder {
     }
   }
 
+  static Future<Uri?> findWorkspacePubspec(Uri? workspacePackageConfig) async {
+    if (workspacePackageConfig == null) {
+      return null;
+    }
+    final candidate = workspacePackageConfig.resolve('../pubspec.yaml');
+    if (File.fromUri(candidate).existsSync()) {
+      return candidate;
+    }
+    return null;
+  }
+
   /// Tries to find the package name that [uri] is in.
   ///
   /// Returns `null` if package cannnot be determined.

pkg/dartdev/test/native_assets/build_test.dart

@@ -328,34 +328,37 @@ void main(List<String> args) {
     },
   );
 
-  test(
-    'dart build with user defines',
-    timeout: longTimeout,
-    () async {
-      await nativeAssetsTest('user_defines', (packageUri) async {
-        await runDart(
-          arguments: [
-            '--enable-experiment=native-assets',
-            'build',
-            'bin/user_defines.dart',
-          ],
-          workingDirectory: packageUri,
-          logger: logger,
-        );
+  for (final usePubWorkspace in [true, false]) {
+    test(
+      'dart build with user defines',
+      timeout: longTimeout,
+      () async {
+        await nativeAssetsTest('user_defines', usePubWorkspace: usePubWorkspace,
+            (packageUri) async {
+          await runDart(
+            arguments: [
+              '--enable-experiment=native-assets',
+              'build',
+              'bin/user_defines.dart',
+            ],
+            workingDirectory: packageUri,
+            logger: logger,
+          );
 
-        final outputDirectory =
-            Directory.fromUri(packageUri.resolve('bin/user_defines'));
-        expect(outputDirectory.existsSync(), true);
+          final outputDirectory =
+              Directory.fromUri(packageUri.resolve('bin/user_defines'));
+          expect(outputDirectory.existsSync(), true);
 
-        final proccessResult = await runProcess(
-          executable: outputDirectory.uri.resolve('user_defines.exe'),
-          logger: logger,
-          throwOnUnexpectedExitCode: true,
-        );
-        expect(proccessResult.stdout, contains('Hello world!'));
-      });
-    },
-  );
+          final proccessResult = await runProcess(
+            executable: outputDirectory.uri.resolve('user_defines.exe'),
+            logger: logger,
+            throwOnUnexpectedExitCode: true,
+          );
+          expect(proccessResult.stdout, contains('Hello world!'));
+        });
+      },
+    );
+  }
 }
 
 Future<void> _withTempDir(Future<void> Function(Uri tempUri) fun) async {

pkg/dartdev/test/native_assets/helpers.dart

@@ -99,33 +99,41 @@ Future<void> copyTestProjects(Uri copyTargetUri, Logger logger,
     await sourceFile.copy(targetUri.toFilePath());
   }
   final dependencyOverrides = {
-      'native_assets_cli': {
-        'path': sdkRoot
-            .resolve('third_party/pkg/native/pkgs/native_assets_cli/')
-            .toFilePath(),
-      },
-      'native_toolchain_c': {
-        'path': sdkRoot
-            .resolve('third_party/pkg/native/pkgs/native_toolchain_c/')
-            .toFilePath(),
-      },
-      'meta': {
-        'path': sdkRoot.resolve('pkg/meta/').toFilePath(),
-      },
-      'record_use': {
-        'path': sdkRoot.resolve('pkg/record_use/').toFilePath(),
-      },
+    'native_assets_cli': {
+      'path': sdkRoot
+          .resolve('third_party/pkg/native/pkgs/native_assets_cli/')
+          .toFilePath(),
+    },
+    'native_toolchain_c': {
+      'path': sdkRoot
+          .resolve('third_party/pkg/native/pkgs/native_toolchain_c/')
+          .toFilePath(),
+    },
+    'meta': {
+      'path': sdkRoot.resolve('pkg/meta/').toFilePath(),
+    },
+    'record_use': {
+      'path': sdkRoot.resolve('pkg/record_use/').toFilePath(),
+    },
   };
+  final userDefinesWorkspace = {};
   for (final pubspecPath in pubspecPaths) {
     final sourceFile = File.fromUri(testProjectsUri.resolveUri(pubspecPath));
     final targetUri = copyTargetUri.resolveUri(pubspecPath);
     final sourceString = await sourceFile.readAsString();
     final pubspec = YamlEditor(sourceString);
+    final pubspecRead = loadYamlNode(sourceString) as Map;
     if (!usePubWorkspace) {
-      if ((loadYamlNode(sourceString) as Map)['resolution'] != null) {
+      if (pubspecRead['resolution'] != null) {
         pubspec.remove(['resolution']);
       }
       pubspec.update(['dependency_overrides'], dependencyOverrides);
+    } else {
+      final userDefines = pubspecRead['hooks']?['user_defines'];
+      if (userDefines is Map) {
+        pubspec.remove(['hooks', 'user_defines']);
+        userDefinesWorkspace.addAll(userDefines);
+      }
     }
     final modifiedString = pubspec.toString();
     await File.fromUri(targetUri).writeAsString(modifiedString);
@@ -141,6 +149,9 @@ Future<void> copyTestProjects(Uri copyTargetUri, Logger logger,
             pubspec.toFilePath().replaceAll('pubspec.yaml', ''),
       ],
       'dependency_overrides': dependencyOverrides,
+      'hooks': {
+        'user_defines': userDefinesWorkspace,
+      }
     });
     final pubspecUri = copyTargetUri.resolve('pubspec.yaml');
     await File.fromUri(pubspecUri).writeAsString(workspacePubspec.toString());

pkg/dartdev/test/native_assets/run_test.dart

@@ -193,22 +193,25 @@ Couldn't resolve native function 'multiply' in 'package:drop_dylib_link/dylib_mu
     });
   });
 
-  test(
-    'dart run with user defines',
-    timeout: longTimeout,
-    () async {
-      await nativeAssetsTest('user_defines', (packageUri) async {
-        final result = await runDart(
-          arguments: [
-            '--enable-experiment=native-assets',
-            'run',
-            'bin/user_defines.dart',
-          ],
-          workingDirectory: packageUri,
-          logger: logger,
-        );
-        expect(result.stdout, contains('Hello world!'));
-      });
-    },
-  );
+  for (final usePubWorkspace in [true, false]) {
+    test(
+      'dart run with user defines',
+      timeout: longTimeout,
+      () async {
+        await nativeAssetsTest('user_defines', usePubWorkspace: usePubWorkspace,
+            (packageUri) async {
+          final result = await runDart(
+            arguments: [
+              '--enable-experiment=native-assets',
+              'run',
+              'bin/user_defines.dart',
+            ],
+            workingDirectory: packageUri,
+            logger: logger,
+          );
+          expect(result.stdout, contains('Hello world!'));
+        });
+      },
+    );
+  }
 }

pkg/dartdev/test/native_assets/test_test.dart

@@ -125,28 +125,31 @@ void main(List<String> args) async {
     });
   });
 
-  test(
-    'dart test with user defines',
-    timeout: longTimeout,
-    () async {
-      await nativeAssetsTest('user_defines', (packageUri) async {
-        final result = await runDart(
-          arguments: [
-            '--enable-experiment=native-assets',
-            'test',
-          ],
-          workingDirectory: packageUri,
-          logger: logger,
-        );
-        expect(
-          result.stdout,
-          stringContainsInOrder(
-            [
-              'All tests passed!',
+  for (final usePubWorkspace in [true, false]) {
+    test(
+      'dart test with user defines',
+      timeout: longTimeout,
+      () async {
+        await nativeAssetsTest('user_defines', usePubWorkspace: usePubWorkspace,
+            (packageUri) async {
+          final result = await runDart(
+            arguments: [
+              '--enable-experiment=native-assets',
+              'test',
             ],
-          ),
-        );
-      });
-    },
-  );
+            workingDirectory: packageUri,
+            logger: logger,
+          );
+          expect(
+            result.stdout,
+            stringContainsInOrder(
+              [
+                'All tests passed!',
+              ],
+            ),
+          );
+        });
+      },
+    );
+  }
 }