[native_assets_cli] BuildConfig.linkingEnabled (#1273)

Author: dcharkes

pkgs/native_assets_builder/CHANGELOG.md

@@ -1,6 +1,7 @@
-## 0.7.2-wip
+## 0.8.0-wip
 
-- Nothing yet.
+- `BuildRunner.build` and `BuildRunner.buildDryRun` now have a required
+  `linkingEnabled` parameter.
 
 ## 0.7.1
 

pkgs/native_assets_builder/lib/src/build_runner/build_runner.dart

@@ -54,6 +54,7 @@ class NativeAssetsBuildRunner {
     PackageLayout? packageLayout,
     String? runPackageName,
     Iterable<String>? supportedAssetTypes,
+    required bool linkingEnabled,
   }) async =>
       _run(
         hook: Hook.build,
@@ -70,6 +71,7 @@ class NativeAssetsBuildRunner {
         packageLayout: packageLayout,
         runPackageName: runPackageName,
         supportedAssetTypes: supportedAssetTypes,
+        linkingEnabled: linkingEnabled,
       );
 
   /// [workingDirectory] is expected to contain `.dart_tool`.
@@ -133,8 +135,10 @@ class NativeAssetsBuildRunner {
     String? runPackageName,
     Iterable<String>? supportedAssetTypes,
     BuildResult? buildResult,
+    bool? linkingEnabled,
   }) async {
     assert(hook == Hook.link || buildResult == null);
+    assert(hook == Hook.build || linkingEnabled == null);
 
     packageLayout ??= await PackageLayout.fromRootPackageRoot(workingDirectory);
     final (buildPlan, packageGraph, planSuccess) = await _makePlan(
@@ -168,6 +172,7 @@ class NativeAssetsBuildRunner {
         buildMode,
         linkModePreference,
         dependencyMetadata,
+        linkingEnabled,
         cCompilerConfig,
         targetIOSSdk,
         targetAndroidNdkApi,
@@ -201,6 +206,7 @@ class NativeAssetsBuildRunner {
     BuildModeImpl buildMode,
     LinkModePreferenceImpl linkModePreference,
     DependencyMetadata? dependencyMetadata,
+    bool? linkingEnabled,
     CCompilerConfigImpl? cCompilerConfig,
     IOSSdkImpl? targetIOSSdk,
     int? targetAndroidNdkApi,
@@ -224,6 +230,7 @@ class NativeAssetsBuildRunner {
       targetAndroidNdkApi: targetAndroidNdkApi,
       supportedAssetTypes: supportedAssetTypes,
       hook: hook,
+      linkingEnabled: linkingEnabled,
     );
     final buildDirUri =
         packageLayout.dartToolNativeAssetsBuilder.resolve('$buildDirName/');
@@ -273,6 +280,7 @@ class NativeAssetsBuildRunner {
         targetMacOSVersion: targetMacOSVersion,
         cCompiler: cCompilerConfig,
         dependencyMetadata: dependencyMetadata,
+        linkingEnabled: linkingEnabled,
         targetAndroidNdkApi: targetAndroidNdkApi,
       );
     }
@@ -290,6 +298,7 @@ class NativeAssetsBuildRunner {
     required OSImpl targetOS,
     required Uri workingDirectory,
     required bool includeParentEnvironment,
+    required bool linkingEnabled,
     PackageLayout? packageLayout,
     String? runPackageName,
     Iterable<String>? supportedAssetTypes,
@@ -303,6 +312,7 @@ class NativeAssetsBuildRunner {
         packageLayout: packageLayout,
         runPackageName: runPackageName,
         supportedAssetTypes: supportedAssetTypes,
+        linkingEnabled: linkingEnabled,
       );
 
   /// [workingDirectory] is expected to contain `.dart_tool`.
@@ -332,6 +342,7 @@ class NativeAssetsBuildRunner {
         runPackageName: runPackageName,
         supportedAssetTypes: supportedAssetTypes,
         buildDryRunResult: buildDryRunResult,
+        linkingEnabled: null,
       );
 
   Future<HookResult> _runDryRun({
@@ -344,6 +355,7 @@ class NativeAssetsBuildRunner {
     Iterable<String>? supportedAssetTypes,
     required Hook hook,
     BuildDryRunResult? buildDryRunResult,
+    required bool? linkingEnabled,
   }) async {
     packageLayout ??= await PackageLayout.fromRootPackageRoot(workingDirectory);
     final (buildPlan, _, planSuccess) = await _makePlan(
@@ -367,6 +379,7 @@ class NativeAssetsBuildRunner {
         supportedAssetTypes: supportedAssetTypes,
         hook: hook,
         buildDryRunResult: buildDryRunResult,
+        linkingEnabled: linkingEnabled,
       );
       var (buildOutput, packageSuccess) = await _runHookForPackage(
         hook,
@@ -538,6 +551,7 @@ ${e.message}
     required Hook hook,
     BuildDryRunResult? buildDryRunResult,
     Iterable<String>? supportedAssetTypes,
+    required bool? linkingEnabled,
   }) async {
     final hookDirName = 'dry_run_${hook.name}_${targetOS}_$linkMode';
     final outDirUri = buildParentDir.resolve('$hookDirName/out/');
@@ -554,6 +568,7 @@ ${e.message}
           targetOS: targetOS,
           linkModePreference: linkMode,
           supportedAssetTypes: supportedAssetTypes,
+          linkingEnabled: linkingEnabled,
         );
       case Hook.link:
         return LinkConfigImpl.dryRun(

pkgs/native_assets_builder/pubspec.yaml

@@ -1,7 +1,7 @@
 name: native_assets_builder
 description: >-
   This package is the backend that invokes build hooks.
-version: 0.7.2-wip
+version: 0.8.0-wip
 repository: https://github.com/dart-lang/native/tree/main/pkgs/native_assets_builder
 
 publish_to: none

pkgs/native_assets_builder/test/build_runner/build_runner_build_dry_run_test.dart

@@ -28,6 +28,7 @@ void main() async {
         packageUri,
         logger,
         dartExecutable,
+        linkingEnabled: false,
       );
       final dryRunAssets = dryRunResult.assets.toList();
       final result = await build(

pkgs/native_assets_builder/test/build_runner/build_runner_cycle_test.dart

@@ -26,6 +26,7 @@ void main() async {
           packageUri,
           createCapturingLogger(logMessages, level: Level.SEVERE),
           dartExecutable,
+          linkingEnabled: false,
         );
         final fullLog = logMessages.join('\n');
         expect(result.success, false);

pkgs/native_assets_builder/test/build_runner/build_runner_reusability_test.dart

@@ -33,26 +33,30 @@ void main() async {
         linkModePreference: LinkModePreferenceImpl.dynamic,
         workingDirectory: packageUri,
         includeParentEnvironment: true,
+        linkingEnabled: false,
       );
       await buildRunner.buildDryRun(
         targetOS: Target.current.os,
         linkModePreference: LinkModePreferenceImpl.dynamic,
         workingDirectory: packageUri,
         includeParentEnvironment: true,
+        linkingEnabled: false,
       );
       await buildRunner.build(
         buildMode: BuildModeImpl.release,
         linkModePreference: LinkModePreferenceImpl.dynamic,
         target: Target.current,
         workingDirectory: packageUri,
         includeParentEnvironment: true,
+        linkingEnabled: false,
       );
       await buildRunner.build(
         buildMode: BuildModeImpl.release,
         linkModePreference: LinkModePreferenceImpl.dynamic,
         target: Target.current,
         workingDirectory: packageUri,
         includeParentEnvironment: true,
+        linkingEnabled: false,
       );
     });
   });

pkgs/native_assets_builder/test/build_runner/helpers.dart

@@ -46,6 +46,7 @@ Future<BuildResult> build(
   int? targetMacOSVersion,
   int? targetAndroidNdkApi,
   Target? target,
+  bool linkingEnabled = false,
 }) async =>
     await runWithLog(capturedLogs, () async {
       final result = await NativeAssetsBuildRunner(
@@ -64,6 +65,7 @@ Future<BuildResult> build(
         targetIOSVersion: targetIOSVersion,
         targetMacOSVersion: targetMacOSVersion,
         targetAndroidNdkApi: targetAndroidNdkApi,
+        linkingEnabled: linkingEnabled,
       );
 
       if (result.success) {
@@ -155,6 +157,7 @@ Future<(BuildResult, LinkResult)> buildAndLink(
         targetIOSVersion: targetIOSVersion,
         targetMacOSVersion: targetMacOSVersion,
         targetAndroidNdkApi: targetAndroidNdkApi,
+        linkingEnabled: true,
       );
 
       if (!buildResult.success) {
@@ -217,6 +220,7 @@ Future<BuildDryRunResult> buildDryRun(
   bool includeParentEnvironment = true,
   List<String>? capturedLogs,
   PackageLayout? packageLayout,
+  required bool linkingEnabled,
 }) async =>
     runWithLog(capturedLogs, () async {
       final result = await NativeAssetsBuildRunner(
@@ -228,6 +232,7 @@ Future<BuildDryRunResult> buildDryRun(
         workingDirectory: packageUri,
         includeParentEnvironment: includeParentEnvironment,
         packageLayout: packageLayout,
+        linkingEnabled: linkingEnabled,
       );
       return result;
     });

pkgs/native_assets_builder/test/build_runner/link_dry_run_test.dart

@@ -30,6 +30,7 @@ void main() async {
           packageUri,
           logger,
           dartExecutable,
+          linkingEnabled: true,
         );
         expect(buildResult.assets.length, 0);
 
@@ -70,6 +71,7 @@ void main() async {
           packageUri,
           logger,
           dartExecutable,
+          linkingEnabled: true,
         );
         expect(buildResult.success, true);
         expect(_getNames(buildResult.assets), orderedEquals(builtHelperAssets));

pkgs/native_assets_builder/test/build_runner/link_test.dart

@@ -30,6 +30,7 @@ void main() async {
           packageUri,
           logger,
           dartExecutable,
+          linkingEnabled: true,
         );
         expect(buildResult.assets.length, 0);
 
@@ -40,6 +41,14 @@ void main() async {
           buildResult: buildResult,
         );
         expect(linkResult.assets.length, 2);
+
+        final buildNoLinkResult = await build(
+          packageUri,
+          logger,
+          dartExecutable,
+          linkingEnabled: false,
+        );
+        expect(buildNoLinkResult.assets.length, 4);
       });
     },
   );
@@ -70,6 +79,7 @@ void main() async {
           packageUri,
           logger,
           dartExecutable,
+          linkingEnabled: true,
         );
         expect(buildResult.success, true);
         expect(_getNames(buildResult.assets), orderedEquals(builtHelperAssets));
@@ -106,6 +116,7 @@ void main() async {
         packageUri,
         logger,
         dartExecutable,
+        linkingEnabled: true,
       );
       expect(buildResult.assets.length, 0);
       expect(buildResult.assetsForLinking.length, 0);

pkgs/native_assets_builder/test/build_runner/resources_test.dart

@@ -33,6 +33,7 @@ void main() async {
           packageUri,
           logger,
           dartExecutable,
+          linkingEnabled: true,
         );
 
         Iterable<String> buildFiles() => Directory.fromUri(

pkgs/native_assets_builder/test_data/add_asset_link/hook/build.dart

@@ -8,6 +8,9 @@ import 'package:native_toolchain_c/native_toolchain_c.dart';
 
 void main(List<String> arguments) async {
   await build(arguments, (config, output) async {
+    if (!config.linkingEnabled) {
+      throw Exception('Link hook must be run!');
+    }
     final logger = Logger('')
       ..level = Level.ALL
       ..onRecord.listen((record) {

pkgs/native_assets_builder/test_data/complex_link/hook/build.dart

@@ -17,6 +17,6 @@ void main(List<String> args) async => build(args, (config, output) async {
             package: packageName,
           ),
         ),
-        linkInPackage: 'complex_link',
+        linkInPackage: config.linkingEnabled ? 'complex_link' : null,
       );
     });

pkgs/native_assets_builder/test_data/complex_link_helper/hook/build.dart

@@ -29,6 +29,6 @@ void main(List<String> args) async => build(args, (config, output) async {
             package: packageName,
           ),
         ),
-        linkInPackage: 'complex_link',
+        linkInPackage: config.linkingEnabled ? 'complex_link' : null,
       );
     });

pkgs/native_assets_builder/test_data/drop_dylib_link/hook/build.dart

@@ -15,6 +15,7 @@ void main(List<String> arguments) async {
       ..onRecord.listen((record) {
         print('${record.level.name}: ${record.time}: ${record.message}');
       });
+    final linkInPackage = config.linkingEnabled ? packageName : null;
     await CBuilder.library(
       name: 'add',
       assetName: 'dylib_add',
@@ -27,7 +28,7 @@ void main(List<String> arguments) async {
       config: config,
       output: output,
       logger: logger,
-      linkInPackage: packageName,
+      linkInPackage: linkInPackage,
     );
 
     await CBuilder.library(
@@ -42,7 +43,7 @@ void main(List<String> arguments) async {
       config: config,
       output: output,
       logger: logger,
-      linkInPackage: packageName,
+      linkInPackage: linkInPackage,
     );
   });
 }

pkgs/native_assets_builder/test_data/fail_on_os_sdk_version_link/hook/build.dart

@@ -12,7 +12,8 @@ void main(List<String> arguments) async {
         file: config.packageRoot.resolve('assets/data.json'),
         package: config.packageName,
       ),
-      linkInPackage: 'fail_on_os_sdk_version_linker',
+      linkInPackage:
+          config.linkingEnabled ? 'fail_on_os_sdk_version_linker' : null,
     );
   });
 }

pkgs/native_assets_builder/test_data/simple_link/hook/build.dart

@@ -17,6 +17,6 @@ void main(List<String> args) async => build(args, (config, output) async {
             package: packageName,
           ),
         ),
-        linkInPackage: 'simple_link',
+        linkInPackage: config.linkingEnabled ? 'simple_link' : null,
       );
     });

pkgs/native_assets_cli/CHANGELOG.md

@@ -1,6 +1,6 @@
-## 0.6.2-wip
+## 0.7.0-wip
 
-- Nothing yet.
+- `BuildConfig` constructors now have a required `linkingEnabled` parameter.
 
 ## 0.6.1
 

pkgs/native_assets_cli/example/link/package_with_assets/hook/build.dart

@@ -19,6 +19,9 @@ void main(List<String> args) async {
         file: config.packageRoot.resolve('assets/used_asset.json'),
       )
     ];
-    output.addAssets(allAssets, linkInPackage: packageName);
+    output.addAssets(
+      allAssets,
+      linkInPackage: config.linkingEnabled ? packageName : null,
+    );
   });
 }