[hooks_runner] Support building assets for dev deps (#2342)

Bug:

* #2312

Breaks the public API of the `package:hooks_runner`, needs a manual roll into Dart and Flutter.

Author: dcharkes

pkgs/code_assets/analysis_options.yaml

@@ -12,6 +12,7 @@ analyzer:
 
 linter:
   rules:
+    - avoid_positional_boolean_parameters
     - dangling_library_doc_comments
     - prefer_const_declarations
     - prefer_expression_function_bodies

pkgs/data_assets/analysis_options.yaml

@@ -12,6 +12,7 @@ analyzer:
 
 linter:
   rules:
+    - avoid_positional_boolean_parameters
     - dangling_library_doc_comments
     - prefer_const_declarations
     - prefer_expression_function_bodies

pkgs/hooks/analysis_options.yaml

@@ -12,6 +12,7 @@ analyzer:
 
 linter:
   rules:
+    - avoid_positional_boolean_parameters
     - dangling_library_doc_comments
     - prefer_const_declarations
     - prefer_expression_function_bodies

pkgs/hooks_runner/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.21.0
+
+* Add `includeDevDependencies` param to `BuildLayout` to enable building the
+  assets for dev dependencies of the `runPackage`.
+
 ## 0.20.2
 
 * Add `dart:developer` `TimelineEvent`s to enable performance tracing for

pkgs/hooks_runner/analysis_options.yaml

@@ -12,6 +12,7 @@ analyzer:
 
 linter:
   rules:
+    - avoid_positional_boolean_parameters
     - dangling_library_doc_comments
     - prefer_const_declarations
     - prefer_expression_function_bodies

pkgs/hooks_runner/lib/src/build_runner/build_planner.dart

@@ -52,6 +52,8 @@ class NativeAssetsBuildPlanner {
     final packageGraphJson = await packageGraphJsonFile.readAsString();
     final packageGraph = PackageGraph.fromPackageGraphJsonString(
       packageGraphJson,
+      packageLayout.runPackageName,
+      includeDevDependencies: packageLayout.includeDevDependencies,
     );
     final packageGraphFromRunPackage = packageGraph.subGraph(
       packageLayout.runPackageName,
@@ -182,12 +184,21 @@ class PackageGraph {
 
   PackageGraph(this.map);
 
-  factory PackageGraph.fromPackageGraphJsonString(String json) =>
-      PackageGraph.fromPackageGraphJson(
-        jsonDecode(json) as Map<dynamic, dynamic>,
-      );
+  factory PackageGraph.fromPackageGraphJsonString(
+    String json,
+    String runPackageName, {
+    required bool includeDevDependencies,
+  }) => PackageGraph.fromPackageGraphJson(
+    jsonDecode(json) as Map<dynamic, dynamic>,
+    runPackageName,
+    includeDevDependencies: includeDevDependencies,
+  );
 
-  factory PackageGraph.fromPackageGraphJson(Map<dynamic, dynamic> map) {
+  factory PackageGraph.fromPackageGraphJson(
+    Map<dynamic, dynamic> map,
+    String runPackageName, {
+    required bool includeDevDependencies,
+  }) {
     final result = <String, List<String>>{};
     final packages = map['packages'] as List<dynamic>;
     for (final package in packages) {
@@ -196,6 +207,14 @@ class PackageGraph {
       final dependencies = (package_['dependencies'] as List<dynamic>)
           .whereType<String>()
           .toList();
+      if (name == runPackageName && includeDevDependencies) {
+        final devDependencies =
+            (package_['devDependencies'] as List<dynamic>?)
+                ?.whereType<String>()
+                .toList() ??
+            [];
+        dependencies.addAll(devDependencies);
+      }
       result[name] = dependencies;
     }
     return PackageGraph(result);

pkgs/hooks_runner/lib/src/package_layout/package_layout.dart

@@ -34,36 +34,52 @@ class PackageLayout {
   /// Only assets of transitive dependencies of [runPackageName] are built.
   final String runPackageName;
 
+  /// Include the dev dependencies of [runPackageName].
+  final bool includeDevDependencies;
+
   PackageLayout._(
     this.packageConfig,
     this.packageConfigUri,
-    this.runPackageName,
-  );
+    this.runPackageName, {
+    required this.includeDevDependencies,
+  });
 
   factory PackageLayout.fromPackageConfig(
     FileSystem fileSystem,
     PackageConfig packageConfig,
     Uri packageConfigUri,
-    String runPackageName,
-  ) {
+    String runPackageName, {
+    required bool includeDevDependencies,
+  }) {
     assert(fileSystem.file(packageConfigUri).existsSync());
     packageConfigUri = packageConfigUri.normalizePath();
-    return PackageLayout._(packageConfig, packageConfigUri, runPackageName);
+    return PackageLayout._(
+      packageConfig,
+      packageConfigUri,
+      runPackageName,
+      includeDevDependencies: includeDevDependencies,
+    );
   }
 
   static Future<PackageLayout> fromWorkingDirectory(
     FileSystem fileSystem,
     Uri workingDirectory,
-    String runPackgeName,
-  ) async {
+    String runPackageName, {
+    required bool includeDevDependencies,
+  }) async {
     workingDirectory = workingDirectory.normalizePath();
     final packageConfigUri = await findPackageConfig(
       fileSystem,
       workingDirectory,
     );
     assert(await fileSystem.file(packageConfigUri).exists());
     final packageConfig = await loadPackageConfigUri(packageConfigUri!);
-    return PackageLayout._(packageConfig, packageConfigUri, runPackgeName);
+    return PackageLayout._(
+      packageConfig,
+      packageConfigUri,
+      runPackageName,
+      includeDevDependencies: includeDevDependencies,
+    );
   }
 
   static Future<Uri?> findPackageConfig(

pkgs/hooks_runner/pubspec.yaml

@@ -2,7 +2,7 @@ name: hooks_runner
 description: >-
   This package is the backend that invokes build hooks.
 
-version: 0.20.2
+version: 0.21.0
 
 repository: https://github.com/dart-lang/native/tree/main/pkgs/hooks_runner
 

pkgs/hooks_runner/test/build_runner/build_planner_test.dart

@@ -25,6 +25,7 @@ void main() async {
         const LocalFileSystem(),
         nativeAddUri,
         'native_add',
+        includeDevDependencies: false,
       );
       final nativeAssetsBuildPlanner =
           await NativeAssetsBuildPlanner.fromPackageConfigUri(
@@ -60,6 +61,7 @@ void main() async {
           const LocalFileSystem(),
           nativeAddUri,
           runPackageName,
+          includeDevDependencies: false,
         );
         final nativeAssetsBuildPlanner =
             await NativeAssetsBuildPlanner.fromPackageConfigUri(
@@ -76,4 +78,36 @@ void main() async {
       });
     });
   }
+
+  for (final includeDevDependencies in [true, false]) {
+    test('includeDevDependencies $includeDevDependencies', () async {
+      const runPackageName = 'dev_dependency_with_hook';
+      await inTempDir((tempUri) async {
+        await copyTestProjects(targetUri: tempUri);
+        final nativeAddUri = tempUri.resolve('$runPackageName/');
+
+        // First, run `pub get`, we need pub to resolve our dependencies.
+        await runPubGet(workingDirectory: nativeAddUri, logger: logger);
+
+        final packageLayout = await PackageLayout.fromWorkingDirectory(
+          const LocalFileSystem(),
+          nativeAddUri,
+          runPackageName,
+          includeDevDependencies: includeDevDependencies,
+        );
+        final nativeAssetsBuildPlanner =
+            await NativeAssetsBuildPlanner.fromPackageConfigUri(
+              packageConfigUri: nativeAddUri.resolve(
+                '.dart_tool/package_config.json',
+              ),
+              dartExecutable: Uri.file(Platform.resolvedExecutable),
+              logger: logger,
+              packageLayout: packageLayout,
+              fileSystem: const LocalFileSystem(),
+            );
+        final buildPlan = await nativeAssetsBuildPlanner.makeBuildHookPlan();
+        expect(buildPlan.success.length, includeDevDependencies ? 1 : 0);
+      });
+    });
+  }
 }

pkgs/hooks_runner/test/build_runner/build_runner_reusability_test.dart

@@ -27,6 +27,7 @@ void main() async {
         const LocalFileSystem(),
         packageUri,
         packageName,
+        includeDevDependencies: false,
       );
       final buildRunner = NativeAssetsBuildRunner(
         logger: logger,