[native_assets_cli] Use JSON instead of YAML (#1019)

* #991

Author: dcharkes

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

@@ -258,14 +258,14 @@ class NativeAssetsBuildRunner {
     required bool dryRun,
   }) async {
     final outDir = config.outputDirectory;
-    final configFile = outDir.resolve('../config.yaml');
+    final configFile = outDir.resolve('../config.json');
     final buildHook = config.packageRoot.resolve('hook/').resolve('build.dart');
     final buildHookLegacy = config.packageRoot.resolve('build.dart');
-    final configFileContents = config.toYamlString();
-    logger.info('config.yaml contents: $configFileContents');
+    final configFileContents = config.toJsonString();
+    logger.info('config.json contents: $configFileContents');
     await File.fromUri(configFile).writeAsString(configFileContents);
     final buildOutputFile =
-        File.fromUri(outDir.resolve(BuildOutputImpl.fileName));
+        File.fromUri(outDir.resolve(BuildOutputImpl.fileNameV1_1_0));
     if (await buildOutputFile.exists()) {
       // Ensure we'll never read outdated build results.
       await buildOutputFile.delete();
@@ -320,7 +320,7 @@ ${result.stdout}
     } on FormatException catch (e) {
       logger.severe('''
 Building native assets for package:${config.packageName} failed.
-build_output.yaml contained a format error.
+build_output.json contained a format error.
 ${e.message}
         ''');
       success = false;
@@ -332,14 +332,14 @@ ${e.message}
     } on TypeError {
       logger.severe('''
 Building native assets for package:${config.packageName} failed.
-build_output.yaml contained a format error.
+build_output.json contained a format error.
         ''');
       success = false;
       return (<NativeCodeAssetImpl>[], <Uri>[], const Metadata({}), false);
     } finally {
       if (!success) {
         final buildOutputFile =
-            File.fromUri(outDir.resolve(BuildOutputImpl.fileName));
+            File.fromUri(outDir.resolve(BuildOutputImpl.fileNameV1_1_0));
         if (await buildOutputFile.exists()) {
           await buildOutputFile.delete();
         }

pkgs/native_assets_builder/lib/src/model/kernel_assets.dart

@@ -6,7 +6,7 @@
 /// kernel file.
 ///
 /// The `native_assets.yaml` embedded in a kernel file has a different format
-/// from the assets passed in the `build_output.yaml` from individual native
+/// from the assets passed in the `build_output.json` from individual native
 /// assets builds. This library defines the format of the former so that it
 /// can be reused in `package:dartdev` and `package:flutter_tools`.
 ///
@@ -36,7 +36,7 @@ class KernelAssets {
       'native-assets': {
         for (final entry in assetsPerTarget.entries)
           entry.key.toString(): {
-            for (final e in entry.value) e.id: e.path.toYaml(),
+            for (final e in entry.value) e.id: e.path.toJson(),
           }
       },
     };
@@ -58,7 +58,7 @@ class KernelAsset {
 }
 
 abstract class KernelAssetPath {
-  List<String> toYaml();
+  List<String> toJson();
 }
 
 /// Asset at absolute path [uri] on the target device where Dart is run.
@@ -78,7 +78,7 @@ class KernelAssetAbsolutePath implements KernelAssetPath {
   int get hashCode => uri.hashCode;
 
   @override
-  List<String> toYaml() => [_pathTypeValue, uri.toFilePath()];
+  List<String> toJson() => [_pathTypeValue, uri.toFilePath()];
 }
 
 /// Asset at relative path [uri], relative to the 'dart file' executed.
@@ -111,7 +111,7 @@ class KernelAssetRelativePath implements KernelAssetPath {
   int get hashCode => uri.hashCode;
 
   @override
-  List<String> toYaml() => [_pathTypeValue, uri.toFilePath()];
+  List<String> toJson() => [_pathTypeValue, uri.toFilePath()];
 }
 
 /// Asset is available on the system `PATH`.
@@ -136,7 +136,7 @@ class KernelAssetSystemPath implements KernelAssetPath {
   String toString() => 'KernelAssetAbsolutePath($uri)';
 
   @override
-  List<String> toYaml() => [_pathTypeValue, uri.toFilePath()];
+  List<String> toJson() => [_pathTypeValue, uri.toFilePath()];
 }
 
 /// Asset is loaded in the process and symbols are available through
@@ -151,7 +151,7 @@ class KernelAssetInProcess implements KernelAssetPath {
   static const _pathTypeValue = 'process';
 
   @override
-  List<String> toYaml() => [_pathTypeValue];
+  List<String> toJson() => [_pathTypeValue];
 }
 
 /// Asset is embedded in executable and symbols are available through
@@ -166,5 +166,5 @@ class KernelAssetInExecutable implements KernelAssetPath {
   static const _pathTypeValue = 'executable';
 
   @override
-  List<String> toYaml() => [_pathTypeValue];
+  List<String> toJson() => [_pathTypeValue];
 }

pkgs/native_assets_builder/test/build_runner/build_runner_build_output_format_test.dart

@@ -45,7 +45,7 @@ void main() async {
           } else {
             expect(
               fullLog,
-              contains('build_output.yaml contained a format error.'),
+              contains('build_output.json contained a format error.'),
             );
           }
         }

pkgs/native_assets_builder/test/build_runner/build_runner_dry_run_test.dart

@@ -56,8 +56,8 @@ void main() async {
 
       final dryRunDir = packageUri.resolve(
           '.dart_tool/native_assets_builder/dry_run_${Target.current.os}_dynamic/');
-      expect(File.fromUri(dryRunDir.resolve('config.yaml')), exists);
-      expect(File.fromUri(dryRunDir.resolve('out/build_output.yaml')), exists);
+      expect(File.fromUri(dryRunDir.resolve('config.json')), exists);
+      expect(File.fromUri(dryRunDir.resolve('out/build_output.json')), exists);
       //
     });
   });

pkgs/native_assets_builder/test/helpers.dart

@@ -120,7 +120,7 @@ Future<void> copyTestProjects({
   final manifestString = await manifestFile.readAsString();
   final manifestYaml = loadYamlDocument(manifestString);
   final manifest = [
-    for (final path in manifestYaml.contents as YamlList)
+    for (final path in manifestYaml.contents as List<Object?>)
       Uri(path: path as String)
   ];
   final filesToCopy = manifest

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

@@ -9,7 +9,7 @@ import 'package:native_assets_cli/native_assets_cli_internal.dart';
 void main(List<String> args) async {
   final buildConfig = BuildConfigImpl.fromArguments(args);
   await File.fromUri(
-          buildConfig.outputDirectory.resolve(BuildOutputImpl.fileName))
+          buildConfig.outputDirectory.resolve(BuildOutputImpl.fileNameV1_1_0))
       .writeAsString(_wrongContents);
 }
 

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

@@ -9,7 +9,7 @@ import 'package:native_assets_cli/native_assets_cli_internal.dart';
 void main(List<String> args) async {
   final buildConfig = BuildConfigImpl.fromArguments(args);
   await File.fromUri(
-          buildConfig.outputDirectory.resolve(BuildOutputImpl.fileName))
+          buildConfig.outputDirectory.resolve(BuildOutputImpl.fileNameV1_1_0))
       .writeAsString(_wrongContents);
 }
 

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

@@ -9,7 +9,7 @@ import 'package:native_assets_cli/native_assets_cli_internal.dart';
 void main(List<String> args) async {
   final buildConfig = BuildConfigImpl.fromArguments(args);
   await File.fromUri(
-          buildConfig.outputDirectory.resolve(BuildOutputImpl.fileName))
+          buildConfig.outputDirectory.resolve(BuildOutputImpl.fileNameV1_1_0))
       .writeAsString(_rightContents);
   exit(1);
 }

pkgs/native_assets_cli/CHANGELOG.md

@@ -4,6 +4,8 @@
   https://github.com/dart-lang/native/pull/946
 - **Breaking change** Move `build.dart` to `hook/build.dart`.
   https://github.com/dart-lang/native/issues/823
+- **Breaking change** Use JSON instead of YAML in the protocol.
+  https://github.com/dart-lang/native/issues/991
 - Bump examples dependencies to path dependencies.
 
 ## 0.4.2

pkgs/native_assets_cli/lib/src/api/asset.dart

@@ -3,21 +3,20 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:pub_semver/pub_semver.dart';
-import 'package:yaml/yaml.dart';
 
 import '../model/target.dart';
+import '../utils/json.dart';
 import '../utils/map.dart';
-import '../utils/yaml.dart';
 import 'architecture.dart';
 import 'build_config.dart';
 import 'build_output.dart';
 import 'os.dart';
 
-part 'native_code_asset.dart';
-part 'data_asset.dart';
 part '../model/asset.dart';
-part '../model/native_code_asset.dart';
 part '../model/data_asset.dart';
+part '../model/native_code_asset.dart';
+part 'data_asset.dart';
+part 'native_code_asset.dart';
 
 /// Data or code bundled with a Dart or Flutter application.
 ///

pkgs/native_assets_cli/lib/src/api/build_config.dart

@@ -12,8 +12,8 @@ import 'package:pub_semver/pub_semver.dart';
 
 import '../model/metadata.dart';
 import '../model/target.dart';
+import '../utils/json.dart';
 import '../utils/map.dart';
-import '../utils/yaml.dart';
 import 'architecture.dart';
 import 'asset.dart';
 import 'build.dart';
@@ -22,9 +22,9 @@ import 'ios_sdk.dart';
 import 'link_mode_preference.dart';
 import 'os.dart';
 
-part 'c_compiler_config.dart';
 part '../model/build_config.dart';
 part '../model/c_compiler_config.dart';
+part 'c_compiler_config.dart';
 
 /// The configuration for a `build.dart` invocation.
 ///

pkgs/native_assets_cli/lib/src/api/build_output.dart

@@ -2,18 +2,19 @@
 // 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:collection/collection.dart';
 import 'package:pub_semver/pub_semver.dart';
-import 'package:yaml/yaml.dart';
+import 'package:yaml/yaml.dart' show loadYaml;
 
 import '../model/dependencies.dart';
 import '../model/metadata.dart';
 import '../utils/datetime.dart';
 import '../utils/file.dart';
+import '../utils/json.dart';
 import '../utils/map.dart';
-import '../utils/yaml.dart';
 import 'architecture.dart';
 import 'asset.dart';
 import 'build_config.dart';

pkgs/native_assets_cli/lib/src/model/asset.dart

@@ -5,19 +5,19 @@
 part of '../api/asset.dart';
 
 abstract final class AssetImpl implements Asset {
-  Map<String, Object> toYaml(Version version);
+  Map<String, Object> toJson(Version version);
 
-  static List<AssetImpl> listFromYamlList(YamlList list) {
+  static List<AssetImpl> listFromJsonList(List<Object?> list) {
     final assets = <AssetImpl>[];
-    for (final yamlElement in list) {
-      final yamlMap = as<YamlMap>(yamlElement);
-      final type = yamlMap[NativeCodeAssetImpl.typeKey];
+    for (final jsonElement in list) {
+      final jsonMap = as<Map<Object?, Object?>>(jsonElement);
+      final type = jsonMap[NativeCodeAssetImpl.typeKey];
       switch (type) {
         case NativeCodeAsset.type:
         case null: // Backwards compatibility with v1.0.0.
-          assets.add(NativeCodeAssetImpl.fromYaml(yamlMap));
+          assets.add(NativeCodeAssetImpl.fromJson(jsonMap));
         case DataAsset.type:
-          assets.add(DataAssetImpl.fromYaml(yamlMap));
+          assets.add(DataAssetImpl.fromJson(jsonMap));
         default:
         // Do nothing, some other launcher might define it's own asset types.
       }

pkgs/native_assets_cli/lib/src/model/build_config.dart

@@ -103,9 +103,10 @@ final class BuildConfigImpl implements BuildConfig {
     required LinkModePreferenceImpl linkModePreference,
     Map<String, Metadata>? dependencyMetadata,
     Iterable<String>? supportedAssetTypes,
+    Version? version,
   }) {
     final nonValidated = BuildConfigImpl._()
-      .._version = latestVersion
+      .._version = version ?? latestVersion
       .._outDir = outDir
       .._packageName = packageName
       .._packageRoot = packageRoot
@@ -120,7 +121,7 @@ final class BuildConfigImpl implements BuildConfig {
       .._dryRun = false
       .._supportedAssetTypes =
           _supportedAssetTypesBackwardsCompatibility(supportedAssetTypes);
-    final parsedConfigFile = nonValidated.toYaml();
+    final parsedConfigFile = nonValidated.toJson();
     final config = Config(fileParsed: parsedConfigFile);
     return BuildConfigImpl.fromConfig(config);
   }
@@ -145,7 +146,7 @@ final class BuildConfigImpl implements BuildConfig {
       .._dryRun = true
       .._supportedAssetTypes =
           _supportedAssetTypesBackwardsCompatibility(supportedAssetTypes);
-    final parsedConfigFile = nonValidated.toYaml();
+    final parsedConfigFile = nonValidated.toJson();
     final config = Config(fileParsed: parsedConfigFile);
     return BuildConfigImpl.fromConfig(config);
   }
@@ -189,7 +190,7 @@ final class BuildConfigImpl implements BuildConfig {
       if (dependencyMetadata != null)
         for (final entry in dependencyMetadata.entries) ...[
           entry.key,
-          json.encode(entry.value.toYaml()),
+          json.encode(entry.value.toJson()),
         ],
       ..._supportedAssetTypesBackwardsCompatibility(supportedAssetTypes),
     ].join('###');
@@ -217,9 +218,9 @@ final class BuildConfigImpl implements BuildConfig {
   /// and packages through `build.dart` invocations.
   ///
   /// If we ever were to make breaking changes, it would be useful to give
-  /// proper error messages rather than just fail to parse the YAML
+  /// proper error messages rather than just fail to parse the JSON
   /// representation in the protocol.
-  static Version latestVersion = Version(1, 1, 0);
+  static Version latestVersion = Version(1, 2, 0);
 
   factory BuildConfigImpl.fromConfig(Config config) {
     final result = BuildConfigImpl._().._cCompiler = CCompilerConfigImpl._();
@@ -246,6 +247,9 @@ final class BuildConfigImpl implements BuildConfig {
     Map<String, String>? environment,
     Uri? workingDirectory,
   }) {
+    // TODO(https://github.com/dart-lang/native/issues/1000): At some point,
+    // migrate away from package:cli_config, to get rid of package:yaml
+    // dependency.
     final config = Config.fromArgumentsSync(
       arguments: args,
       environment: environment,
@@ -451,10 +455,10 @@ final class BuildConfigImpl implements BuildConfig {
     return result.sortOnKey();
   }
 
-  Map<String, Object> toYaml() {
-    late Map<String, Object> cCompilerYaml;
+  Map<String, Object> toJson() {
+    late Map<String, Object> cCompilerJson;
     if (!dryRun) {
-      cCompilerYaml = _cCompiler.toYaml();
+      cCompilerJson = _cCompiler.toJson();
     }
 
     return {
@@ -464,7 +468,7 @@ final class BuildConfigImpl implements BuildConfig {
       OSImpl.configKey: _targetOS.toString(),
       LinkModePreferenceImpl.configKey: _linkModePreference.toString(),
       supportedAssetTypesKey: _supportedAssetTypes,
-      _versionKey: latestVersion.toString(),
+      _versionKey: version.toString(),
       if (dryRun) dryRunConfigKey: dryRun,
       if (!dryRun) ...{
         BuildModeImpl.configKey: _buildMode.toString(),
@@ -473,18 +477,18 @@ final class BuildConfigImpl implements BuildConfig {
           IOSSdkImpl.configKey: _targetIOSSdk.toString(),
         if (_targetAndroidNdkApi != null)
           targetAndroidNdkApiConfigKey: _targetAndroidNdkApi,
-        if (cCompilerYaml.isNotEmpty)
-          CCompilerConfigImpl.configKey: cCompilerYaml,
+        if (cCompilerJson.isNotEmpty)
+          CCompilerConfigImpl.configKey: cCompilerJson,
         if (_dependencyMetadata != null && _dependencyMetadata.isNotEmpty)
           dependencyMetadataConfigKey: {
             for (final entry in _dependencyMetadata.entries)
-              entry.key: entry.value.toYaml(),
+              entry.key: entry.value.toJson(),
           },
       },
     }.sortOnKey();
   }
 
-  String toYamlString() => yamlEncode(toYaml());
+  String toJsonString() => const JsonEncoder.withIndent('  ').convert(toJson());
 
   @override
   bool operator ==(Object other) {
@@ -533,7 +537,7 @@ final class BuildConfigImpl implements BuildConfig {
       ]);
 
   @override
-  String toString() => 'BuildConfig.build(${toYaml()})';
+  String toString() => 'BuildConfig.build(${toJson()})';
 
   void _ensureNotDryRun() {
     if (dryRun) {