[native_assets_cli] Add user_defines (#2165)

dcharkes · web-flow · commit 3fbbf070cb15 · 2025-04-04T15:11:42.000Z
Bug: #39 Note passing in the user-defines should be done by the Dart and Flutter SDK, they need to decide where to take the command-line arguments, and how to read from the `pubspec.yaml`. The `NativeAssetsBuildRunner` provides a suggestion about where to put user-defines in the `pubspec.yaml`: ```yaml hooks: user_defines: my_package: user_define_key: user_define_value user_define_key2: foo: bar some_other_package: user_define_key3: user_define_value3 ``` Moreover, it provides a helper function that can be reused in SDKs after the pubspec yaml is parsed. ### Design choices (According to the discussion on the bug.) * User-defines are name-spaced per package, we don't want new user-defines to invalidate the cache for other packages. * User-defines can be provided for any package in the dependency graph. * If user-defines need to be shared across packages, the common dependency package can export it as metadata. ### Test This change is tested by invoking the build with user-defines, and in the hook failing if the defines are not available.
diff --git a/.github/workflows/native.yaml b/.github/workflows/native.yaml
@@ -114,6 +114,9 @@ jobs:
       - run: dart pub get -C test_data/reuse_dynamic_library/
         if: ${{ matrix.package == 'native_assets_builder' }}
 
+      - run: dart pub get -C test_data/user_defines/
+        if: ${{ matrix.package == 'native_assets_builder' }}
+
       - run: dart pub get -C test_data/no_hook/
         if: ${{ matrix.package == 'native_assets_builder' }}
 
diff --git a/pkgs/code_assets/test/data/build_input_macos.json b/pkgs/code_assets/test/data/build_input_macos.json
@@ -71,5 +71,8 @@
   "out_file": "/Users/dacoharkes/src/dacoharkes/playground/my_package/example/.dart_tool/native_assets_builder/my_package/ca4e7d3d4e7b8912cbd24d9e8a6cecdc/output.json",
   "package_name": "my_package",
   "package_root": "/Users/dacoharkes/src/dacoharkes/playground/my_package/",
+  "user_defines": {
+    "some_key": "some_value"
+  },
   "version": "1.9.0"
 }
diff --git a/pkgs/code_assets/test/data/link_input_macos.json b/pkgs/code_assets/test/data/link_input_macos.json
@@ -71,5 +71,8 @@
   "out_file": "/Users/dacoharkes/src/dacoharkes/playground/my_package/example/.dart_tool/native_assets_builder/my_package/ca4e7d3d4e7b8912cbd24d9e8a6cecdc/output.json",
   "package_name": "my_package",
   "package_root": "/Users/dacoharkes/src/dacoharkes/playground/my_package/",
+  "user_defines": {
+    "some_key": "some_value"
+  },
   "version": "1.9.0"
 }
diff --git a/pkgs/data_assets/test/data/build_input.json b/pkgs/data_assets/test/data/build_input.json
@@ -46,5 +46,8 @@
   "out_file": "/Users/dacoharkes/src/dacoharkes/playground/my_package/example/.dart_tool/native_assets_builder/my_package/ca4e7d3d4e7b8912cbd24d9e8a6cecdc/output.json",
   "package_name": "my_package",
   "package_root": "/Users/dacoharkes/src/dacoharkes/playground/my_package/",
+  "user_defines": {
+    "some_key": "some_value"
+  },
   "version": "1.9.0"
 }
diff --git a/pkgs/data_assets/test/data/link_input.json b/pkgs/data_assets/test/data/link_input.json
@@ -32,5 +32,8 @@
   "out_file": "/Users/dacoharkes/src/dacoharkes/playground/my_package/example/.dart_tool/native_assets_builder/my_package/ca4e7d3d4e7b8912cbd24d9e8a6cecdc/output.json",
   "package_name": "my_package",
   "package_root": "/Users/dacoharkes/src/dacoharkes/playground/my_package/",
+  "user_defines": {
+    "some_key": "some_value"
+  },
   "version": "1.9.0"
 }
diff --git a/pkgs/hooks/doc/schema/shared/shared_definitions.schema.json b/pkgs/hooks/doc/schema/shared/shared_definitions.schema.json
@@ -174,6 +174,10 @@
         "package_root": {
           "$ref": "#/definitions/absolutePath"
         },
+        "user_defines": {
+          "type": "object",
+          "additionalProperties": true
+        },
         "version": {
           "type": "string"
         }
diff --git a/pkgs/hooks/test/data/build_input.json b/pkgs/hooks/test/data/build_input.json
@@ -35,5 +35,8 @@
   "out_file": "/Users/dacoharkes/src/dacoharkes/playground/my_package/example/.dart_tool/native_assets_builder/my_package/ca4e7d3d4e7b8912cbd24d9e8a6cecdc/output.json",
   "package_name": "my_package",
   "package_root": "/Users/dacoharkes/src/dacoharkes/playground/my_package/",
+  "user_defines": {
+    "some_key": "some_value"
+  },
   "version": "1.9.0"
 }
diff --git a/pkgs/hooks/test/data/link_input.json b/pkgs/hooks/test/data/link_input.json
@@ -24,5 +24,8 @@
   "out_file": "/Users/dacoharkes/src/dacoharkes/playground/my_package/example/.dart_tool/native_assets_builder/my_package/ca4e7d3d4e7b8912cbd24d9e8a6cecdc/output.json",
   "package_name": "my_package",
   "package_root": "/Users/dacoharkes/src/dacoharkes/playground/my_package/",
+  "user_defines": {
+    "some_key": "some_value"
+  },
   "version": "1.9.0"
 }
diff --git a/pkgs/hooks/test/schema/helpers.dart b/pkgs/hooks/test/schema/helpers.dart
@@ -323,6 +323,7 @@ FieldsReturn _hookFields({
     ([r'$schema'], expectOptionalFieldMissing),
     (['version'], versionMissingExpectation),
     if (inputOrOutput == InputOrOutput.input) ...[
+      (['user_defines'], expectOptionalFieldMissing),
       (['out_dir_shared'], expectRequiredFieldMissing),
       (['out_dir'], expectRequiredFieldMissing),
       (['package_name'], expectRequiredFieldMissing),
diff --git a/pkgs/native_assets_builder/lib/src/build_runner/build_runner.dart b/pkgs/native_assets_builder/lib/src/build_runner/build_runner.dart
@@ -46,6 +46,7 @@ class NativeAssetsBuildRunner {
   final Uri dartExecutable;
   final Duration singleHookTimeout;
   final Map<String, String> hookEnvironment;
+  final Map<String, Map<String, Object?>?> userDefines;
   final PackageLayout packageLayout;
 
   NativeAssetsBuildRunner({
@@ -55,6 +56,7 @@ class NativeAssetsBuildRunner {
     required this.packageLayout,
     Duration? singleHookTimeout,
     Map<String, String>? hookEnvironment,
+    this.userDefines = const {},
   }) : _fileSystem = fileSystem,
        singleHookTimeout = singleHookTimeout ?? const Duration(minutes: 5),
        hookEnvironment =
@@ -131,6 +133,7 @@ class NativeAssetsBuildRunner {
         outputFile: buildDirUri.resolve('output.json'),
         outputDirectory: outDirUri,
         outputDirectoryShared: outDirSharedUri,
+        userDefines: userDefines[package.name],
       );
 
       final input = BuildInput(inputBuilder.json);
@@ -228,6 +231,7 @@ class NativeAssetsBuildRunner {
         outputFile: buildDirUri.resolve('output.json'),
         outputDirectory: outDirUri,
         outputDirectoryShared: outDirSharedUri,
+        userDefines: userDefines[package.name],
       );
       inputBuilder.setupLink(
         assets: buildResult.encodedAssetsForLinking[package.name] ?? [],
@@ -861,6 +865,80 @@ ${compileResult.stdout}
         ? BuildOutput(hookOutputJson)
         : LinkOutput(hookOutputJson);
   }
+
+  /// Returns a list of errors for [readHooksUserDefinesFromPubspec].
+  static List<String> validateHooksUserDefinesFromPubspec(
+    Map<Object?, Object?> pubspec,
+  ) {
+    final hooks = pubspec['hooks'];
+    if (hooks == null) return [];
+    if (hooks is! Map) {
+      return ["Expected 'hooks' to be a map. Found: '$hooks'"];
+    }
+    final userDefines = hooks['user_defines'];
+    if (userDefines == null) return [];
+    if (userDefines is! Map) {
+      return [
+        "Expected 'hooks.user_defines' to be a map. Found: '$userDefines'",
+      ];
+    }
+
+    final errors = <String>[];
+    for (final MapEntry(:key, :value) in userDefines.entries) {
+      if (key is! String) {
+        errors.add(
+          "Expected 'hooks.user_defines' to be a map with string keys."
+          " Found key: '$key'.",
+        );
+      }
+      if (value is! Map) {
+        errors.add(
+          "Expected 'hooks.user_defines.$key' to be a map. Found: '$value'",
+        );
+        continue;
+      }
+      for (final childKey in value.keys) {
+        if (childKey is! String) {
+          errors.add(
+            "Expected 'hooks.user_defines.$key' to be a "
+            "map with string keys. Found key: '$childKey'.",
+          );
+        }
+      }
+    }
+    return errors;
+  }
+
+  /// Reads the user-defines from a pubspec.yaml in the suggested location.
+  ///
+  /// SDKs do not have to follow this, they might support user-defines in a
+  /// different way.
+  ///
+  /// The [pubspec] is expected to be the decoded yaml, a Map.
+  ///
+  /// Before invoking, check errors with [validateHooksUserDefinesFromPubspec].
+  static Map<String, Map<String, Object?>> readHooksUserDefinesFromPubspec(
+    Map<Object?, Object?> pubspec,
+  ) {
+    assert(validateHooksUserDefinesFromPubspec(pubspec).isEmpty);
+    final hooks = pubspec['hooks'];
+    if (hooks is! Map) {
+      return {};
+    }
+    final userDefines = hooks['user_defines'];
+    if (userDefines is! Map) {
+      return {};
+    }
+    return {
+      for (final MapEntry(:key, :value) in userDefines.entries)
+        if (key is String)
+          key: {
+            if (value is Map)
+              for (final MapEntry(:key, :value) in value.entries)
+                if (key is String) key: value,
+          },
+    };
+  }
 }
 
 /// Parses depfile contents.
diff --git a/pkgs/native_assets_builder/test/build_runner/helpers.dart b/pkgs/native_assets_builder/test/build_runner/helpers.dart
@@ -75,6 +75,7 @@ Future<BuildResult?> build(
   bool linkingEnabled = false,
   required List<BuildAssetType> buildAssetTypes,
   Map<String, String>? hookEnvironment,
+  Map<String, Map<String, Object?>?>? userDefines,
 }) async {
   final targetOS = target?.os ?? OS.current;
   final runPackageName_ =
@@ -91,6 +92,7 @@ Future<BuildResult?> build(
       fileSystem: const LocalFileSystem(),
       hookEnvironment: hookEnvironment,
       packageLayout: packageLayout,
+      userDefines: userDefines ?? {},
     ).build(
       extensions: [
         if (buildAssetTypes.contains(BuildAssetType.code))
diff --git a/pkgs/native_assets_builder/test/test_data/user_defines_test.dart b/pkgs/native_assets_builder/test/test_data/user_defines_test.dart
@@ -0,0 +1,56 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+@OnPlatform({'mac-os': Timeout.factor(2), 'windows': Timeout.factor(10)})
+library;
+
+import 'dart:io';
+
+import 'package:native_assets_builder/native_assets_builder.dart';
+import 'package:test/test.dart';
+import 'package:yaml/yaml.dart';
+
+import '../build_runner/helpers.dart';
+import '../helpers.dart';
+
+void main() async {
+  const name = 'user_defines';
+
+  test(
+    '$name build',
+    () => inTempDir((tempUri) async {
+      await copyTestProjects(targetUri: tempUri);
+      final packageUri = tempUri.resolve('$name/');
+
+      await runPubGet(workingDirectory: packageUri, logger: logger);
+
+      final pubspec =
+          loadYamlDocument(
+                File.fromUri(
+                  packageUri.resolve('pubspec.yaml'),
+                ).readAsStringSync(),
+              ).contents
+              as YamlMap;
+      expect(
+        NativeAssetsBuildRunner.validateHooksUserDefinesFromPubspec(pubspec),
+        isEmpty,
+      );
+      final userDefines =
+          NativeAssetsBuildRunner.readHooksUserDefinesFromPubspec(pubspec);
+
+      final logMessages = <String>[];
+      final result =
+          (await build(
+            packageUri,
+            logger,
+            dartExecutable,
+            capturedLogs: logMessages,
+            buildAssetTypes: [BuildAssetType.data],
+            userDefines: userDefines,
+          ))!;
+
+      expect(result.encodedAssets.length, 1);
+    }),
+  );
+}
diff --git a/pkgs/native_assets_builder/test_data/manifest.yaml b/pkgs/native_assets_builder/test_data/manifest.yaml
@@ -179,6 +179,8 @@
 - use_all_api/hook/build.dart
 - use_all_api/hook/link.dart
 - use_all_api/pubspec.yaml
+- user_defines/hook/build.dart
+- user_defines/pubspec.yaml
 - wrong_build_output/hook/build.dart
 - wrong_build_output/pubspec.yaml
 - wrong_build_output_2/hook/build.dart
diff --git a/pkgs/native_assets_builder/test_data/user_defines/hook/build.dart b/pkgs/native_assets_builder/test_data/user_defines/hook/build.dart
@@ -0,0 +1,27 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'dart:convert';
+import 'dart:io';
+
+import 'package:native_assets_cli/data_assets.dart';
+
+void main(List<String> arguments) async {
+  await build(arguments, (input, output) async {
+    final value1 = input.userDefines['user_define_key'];
+    if (value1 != 'user_define_value') {
+      throw Exception(
+        'User-define user_define_key does not have the right value.',
+      );
+    }
+    final value2 = input.userDefines['user_define_key2'];
+    final dataAsset = DataAsset(
+      file: input.outputDirectoryShared.resolve('my_asset.json'),
+      name: 'my_asset',
+      package: input.packageName,
+    );
+    File.fromUri(dataAsset.file).writeAsStringSync(jsonEncode(value2));
+    output.assets.data.add(dataAsset);
+  });
+}
diff --git a/pkgs/native_assets_cli/lib/src/config.dart b/pkgs/native_assets_cli/lib/src/config.dart
@@ -89,6 +89,17 @@ sealed class HookInput {
   String toString() => const JsonEncoder.withIndent('  ').convert(json);
 
   HookConfig get config => HookConfig._(this);
+
+  /// The user-defines for this [packageName].
+  HookInputUserDefines get userDefines => HookInputUserDefines._(this);
+}
+
+extension type HookInputUserDefines._(HookInput _input) {
+  /// The value for the user-define for [key] for this package.
+  ///
+  /// This can be arbitrary JSON/YAML if provided from the SDK from such source.
+  /// If it's provided from command-line arguments, it's likely a string.
+  Object? operator [](String key) => _input._syntax.userDefines?.json[key];
 }
 
 sealed class HookInputBuilder {
@@ -110,13 +121,16 @@ sealed class HookInputBuilder {
     required Uri outputDirectory,
     required Uri outputDirectoryShared,
     required Uri outputFile,
+    Map<String, Object?>? userDefines,
   }) {
     _syntax.version = latestVersion.toString();
     _syntax.packageRoot = packageRoot;
     _syntax.packageName = packageName;
     _syntax.outDir = outputDirectory;
     _syntax.outDirShared = outputDirectoryShared;
     _syntax.outFile = outputFile;
+    _syntax.userDefines =
+        userDefines == null ? null : syntax.JsonObject.fromJson(userDefines);
   }
 
   /// Constructs a checksum for a [BuildInput].
diff --git a/pkgs/native_assets_cli/lib/src/hooks/syntax.g.dart b/pkgs/native_assets_cli/lib/src/hooks/syntax.g.dart

Original file line number	Diff line number	Diff line change
`@@ -71,5 +71,8 @@`
`71`	`71`	`"out_file": "/Users/dacoharkes/src/dacoharkes/playground/my_package/example/.dart_tool/native_assets_builder/my_package/ca4e7d3d4e7b8912cbd24d9e8a6cecdc/output.json",`
`72`	`72`	`"package_name": "my_package",`
`73`	`73`	`"package_root": "/Users/dacoharkes/src/dacoharkes/playground/my_package/",`
	`74`	`+ "user_defines": {`
	`75`	`+ "some_key": "some_value"`
	`76`	`+ },`
`74`	`77`	`"version": "1.9.0"`
`75`	`78`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,5 +46,8 @@`
`46`	`46`	`"out_file": "/Users/dacoharkes/src/dacoharkes/playground/my_package/example/.dart_tool/native_assets_builder/my_package/ca4e7d3d4e7b8912cbd24d9e8a6cecdc/output.json",`
`47`	`47`	`"package_name": "my_package",`
`48`	`48`	`"package_root": "/Users/dacoharkes/src/dacoharkes/playground/my_package/",`
	`49`	`+ "user_defines": {`
	`50`	`+ "some_key": "some_value"`
	`51`	`+ },`
`49`	`52`	`"version": "1.9.0"`
`50`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,5 +32,8 @@`
`32`	`32`	`"out_file": "/Users/dacoharkes/src/dacoharkes/playground/my_package/example/.dart_tool/native_assets_builder/my_package/ca4e7d3d4e7b8912cbd24d9e8a6cecdc/output.json",`
`33`	`33`	`"package_name": "my_package",`
`34`	`34`	`"package_root": "/Users/dacoharkes/src/dacoharkes/playground/my_package/",`
	`35`	`+ "user_defines": {`
	`36`	`+ "some_key": "some_value"`
	`37`	`+ },`
`35`	`38`	`"version": "1.9.0"`
`36`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,5 +35,8 @@`
`35`	`35`	`"out_file": "/Users/dacoharkes/src/dacoharkes/playground/my_package/example/.dart_tool/native_assets_builder/my_package/ca4e7d3d4e7b8912cbd24d9e8a6cecdc/output.json",`
`36`	`36`	`"package_name": "my_package",`
`37`	`37`	`"package_root": "/Users/dacoharkes/src/dacoharkes/playground/my_package/",`
	`38`	`+ "user_defines": {`
	`39`	`+ "some_key": "some_value"`
	`40`	`+ },`
`38`	`41`	`"version": "1.9.0"`
`39`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,5 +24,8 @@`
`24`	`24`	`"out_file": "/Users/dacoharkes/src/dacoharkes/playground/my_package/example/.dart_tool/native_assets_builder/my_package/ca4e7d3d4e7b8912cbd24d9e8a6cecdc/output.json",`
`25`	`25`	`"package_name": "my_package",`
`26`	`26`	`"package_root": "/Users/dacoharkes/src/dacoharkes/playground/my_package/",`
	`27`	`+ "user_defines": {`
	`28`	`+ "some_key": "some_value"`
	`29`	`+ },`
`27`	`30`	`"version": "1.9.0"`
`28`	`31`	`}`