[native_assets_cli] Make CodeAsset os and architecture optional in JSON

Author: dcharkes

pkgs/code_assets/doc/schema/shared/shared_definitions.schema.json

@@ -340,10 +340,8 @@
         }
       },
       "required": [
-        "architecture",
         "id",
-        "link_mode",
-        "os"
+        "link_mode"
       ],
       "if": {
         "properties": {

pkgs/code_assets/test/schema/schema_test.dart

@@ -87,13 +87,15 @@ FieldsFunction _codeFields(AllTestData allTestData) {
     required Hook hook,
     required Party party,
   }) {
-    const requiredCodeAssetFields = [
-      ['architecture'],
-      ['os'],
-      ['id'],
-      ['link_mode'],
-      ['link_mode', 'type'],
-    ];
+    // (expectFunction, path)
+    const codeAssetFields =
+        <(List<Object>, void Function(ValidationResults result))>[
+          (['architecture'], expectOptionalFieldMissing),
+          (['os'], expectOptionalFieldMissing),
+          (['id'], expectRequiredFieldMissing),
+          (['link_mode'], expectRequiredFieldMissing),
+          (['link_mode', 'type'], expectRequiredFieldMissing),
+        ];
 
     return <(List<Object>, void Function(ValidationResults result))>[
       for (final codeConfigPath in [
@@ -111,20 +113,17 @@ FieldsFunction _codeFields(AllTestData allTestData) {
             expectRequiredFieldMissing,
           ),
           if (hook == Hook.link) ...[
-            for (final field in requiredCodeAssetFields)
+            for (final (field, expect) in codeAssetFields)
               for (final encoding in _encoding)
-                (
-                  ['assets', 0, ...encoding, ...field],
-                  expectRequiredFieldMissing,
-                ),
+                (['assets', 0, ...encoding, ...field], expect),
           ],
         ],
       if (inputOrOutput == InputOrOutput.output) ...[
-        for (final field in requiredCodeAssetFields)
+        for (final (field, expect) in codeAssetFields)
           for (final encoding in _encoding)
-            (['assets', 0, ...encoding, ...field], expectRequiredFieldMissing),
+            (['assets', 0, ...encoding, ...field], expect),
         if (hook == Hook.build) ...[
-          for (final field in requiredCodeAssetFields)
+          for (final (field, expect) in codeAssetFields)
             for (final encoding in _encoding)
               for (final assetsForLinking in [
                 'assetsForLinking',
@@ -138,7 +137,7 @@ FieldsFunction _codeFields(AllTestData allTestData) {
                     ...encoding,
                     ...field,
                   ],
-                  expectRequiredFieldMissing,
+                  expect,
                 ),
         ],
         (['assets', staticIndex, 'file'], expectRequiredFieldMissing),

pkgs/native_assets_cli/lib/src/code_assets/code_asset.dart

@@ -55,10 +55,10 @@ final class CodeAsset {
   final String id;
 
   /// The operating system this asset can run on.
-  final OS _os;
+  final OS? _os;
 
   /// The architecture this asset can run on.
-  final Architecture _architecture;
+  final Architecture? _architecture;
 
   /// The link mode for this native code.
   ///
@@ -99,9 +99,9 @@ final class CodeAsset {
   CodeAsset._({
     required this.id,
     required this.linkMode,
-    required OS os,
+    required OS? os,
     required this.file,
-    required Architecture architecture,
+    required Architecture? architecture,
   }) : _architecture = architecture,
        _os = os;
 
@@ -113,8 +113,14 @@ final class CodeAsset {
     );
     return CodeAsset._(
       id: syntaxNode.id,
-      os: OSSyntax.fromSyntax(syntaxNode.os),
-      architecture: ArchitectureSyntax.fromSyntax(syntaxNode.architecture),
+      os: switch (syntaxNode.os) {
+        null => null,
+        final s => OSSyntax.fromSyntax(s),
+      },
+      architecture: switch (syntaxNode.architecture) {
+        null => null,
+        final s => ArchitectureSyntax.fromSyntax(s),
+      },
       linkMode: LinkModeSyntax.fromSyntax(syntaxNode.linkMode),
       file: syntaxNode.file,
     );
@@ -151,12 +157,11 @@ final class CodeAsset {
 
   EncodedAsset encode() {
     final encoding = syntax.NativeCodeAssetEncoding(
-      architecture: _architecture.toSyntax(),
+      architecture: _architecture?.toSyntax(),
       file: file,
       id: id,
       linkMode: linkMode.toSyntax(),
-
-      os: _os.toSyntax(),
+      os: _os?.toSyntax(),
     );
     return EncodedAsset(CodeAsset.type, encoding.json);
   }
@@ -166,9 +171,9 @@ final class CodeAsset {
 
 // These field will be removed in the future, prevent anyone from reading them.
 extension ForValidationOnly on CodeAsset {
-  OS get os => _os;
+  OS? get os => _os;
 
-  Architecture get architecture => _architecture;
+  Architecture? get architecture => _architecture;
 }
 
 extension OSLibraryNaming on OS {

pkgs/native_assets_cli/lib/src/code_assets/syntax.g.dart

@@ -818,12 +818,12 @@ class NativeCodeAsset extends Asset {
   NativeCodeAsset.fromJson(super.json, {super.path}) : super._fromJson();
 
   NativeCodeAsset({
-    required Architecture architecture,
+    required Architecture? architecture,
     required NativeCodeAssetEncoding? encoding,
     required Uri? file,
     required String id,
     required LinkMode linkMode,
-    required OS os,
+    required OS? os,
   }) : super(type: 'native_code') {
     _architecture = architecture;
     _encoding = encoding;
@@ -837,12 +837,12 @@ class NativeCodeAsset extends Asset {
   /// Setup all fields for [NativeCodeAsset] that are not in
   /// [Asset].
   void setup({
-    required Architecture architecture,
+    required Architecture? architecture,
     required NativeCodeAssetEncoding? encoding,
     required Uri? file,
     required String id,
     required LinkMode linkMode,
-    required OS os,
+    required OS? os,
   }) {
     _architecture = architecture;
     _encoding = encoding;
@@ -853,17 +853,18 @@ class NativeCodeAsset extends Asset {
     json.sortOnKey();
   }
 
-  Architecture get architecture {
-    final jsonValue = _reader.get<String>('architecture');
+  Architecture? get architecture {
+    final jsonValue = _reader.get<String?>('architecture');
+    if (jsonValue == null) return null;
     return Architecture.fromJson(jsonValue);
   }
 
-  set _architecture(Architecture value) {
-    json['architecture'] = value.name;
+  set _architecture(Architecture? value) {
+    json.setOrRemove('architecture', value?.name);
   }
 
   List<String> _validateArchitecture() =>
-      _reader.validate<String>('architecture');
+      _reader.validate<String?>('architecture');
 
   NativeCodeAssetEncoding? get encoding {
     final jsonValue = _reader.optionalMap('encoding');
@@ -919,16 +920,17 @@ class NativeCodeAsset extends Asset {
     return linkMode.validate();
   }
 
-  OS get os {
-    final jsonValue = _reader.get<String>('os');
+  OS? get os {
+    final jsonValue = _reader.get<String?>('os');
+    if (jsonValue == null) return null;
     return OS.fromJson(jsonValue);
   }
 
-  set _os(OS value) {
-    json['os'] = value.name;
+  set _os(OS? value) {
+    json.setOrRemove('os', value?.name);
   }
 
-  List<String> _validateOs() => _reader.validate<String>('os');
+  List<String> _validateOs() => _reader.validate<String?>('os');
 
   @override
   List<String> validate() => [
@@ -974,11 +976,11 @@ class NativeCodeAssetEncoding {
   NativeCodeAssetEncoding.fromJson(this.json, {this.path = const []});
 
   NativeCodeAssetEncoding({
-    required Architecture architecture,
+    required Architecture? architecture,
     required Uri? file,
     required String id,
     required LinkMode linkMode,
-    required OS os,
+    required OS? os,
   }) : json = {},
        path = const [] {
     _architecture = architecture;
@@ -989,17 +991,18 @@ class NativeCodeAssetEncoding {
     json.sortOnKey();
   }
 
-  Architecture get architecture {
-    final jsonValue = _reader.get<String>('architecture');
+  Architecture? get architecture {
+    final jsonValue = _reader.get<String?>('architecture');
+    if (jsonValue == null) return null;
     return Architecture.fromJson(jsonValue);
   }
 
-  set _architecture(Architecture value) {
-    json['architecture'] = value.name;
+  set _architecture(Architecture? value) {
+    json.setOrRemove('architecture', value?.name);
   }
 
   List<String> _validateArchitecture() =>
-      _reader.validate<String>('architecture');
+      _reader.validate<String?>('architecture');
 
   Uri? get file => _reader.optionalPath('file');
 
@@ -1034,16 +1037,17 @@ class NativeCodeAssetEncoding {
     return linkMode.validate();
   }
 
-  OS get os {
-    final jsonValue = _reader.get<String>('os');
+  OS? get os {
+    final jsonValue = _reader.get<String?>('os');
+    if (jsonValue == null) return null;
     return OS.fromJson(jsonValue);
   }
 
-  set _os(OS value) {
-    json['os'] = value.name;
+  set _os(OS? value) {
+    json.setOrRemove('os', value?.name);
   }
 
-  List<String> _validateOs() => _reader.validate<String>('os');
+  List<String> _validateOs() => _reader.validate<String?>('os');
 
   List<String> validate() => [
     ..._validateArchitecture(),

pkgs/native_assets_cli/lib/src/code_assets/validation.dart

@@ -232,16 +232,15 @@ void _validateCodeAsset(
   }
 
   final os = codeAsset.os;
-  if (codeConfig.targetOS != os) {
+  if (os != null && codeConfig.targetOS != os) {
     final error =
         'CodeAsset "$id" has a os "$os", which '
         'is not the target os "${codeConfig.targetOS}".';
     errors.add(error);
   }
 
   final architecture = codeAsset.architecture;
-
-  if (architecture != codeConfig.targetArchitecture) {
+  if (architecture != null && architecture != codeConfig.targetArchitecture) {
     errors.add(
       'CodeAsset "$id" has an architecture "$architecture", which '
       'is not the target architecture "${codeConfig.targetArchitecture}".',

pkgs/native_assets_cli/test/code_assets/validation_test.dart

@@ -158,45 +158,6 @@ void main() {
       ),
       isEmpty,
     );
-
-    traverseJson<Map<String, Object?>>(outputBuilder.json, [
-      'assets',
-      0,
-      'encoding',
-    ]).remove('architecture');
-    expect(
-      await validateCodeAssetBuildOutput(
-        input,
-        BuildOutput(outputBuilder.json),
-      ),
-      contains(
-        contains(
-          'No value was provided for \'assets.0.encoding.architecture\'.'
-          ' Expected a String.',
-        ),
-      ),
-    );
-
-    traverseJson<Map<String, Object?>>(outputBuilder.json, [
-      'assets',
-      0,
-    ]).remove('encoding');
-    traverseJson<Map<String, Object?>>(outputBuilder.json, [
-      'assets',
-      0,
-    ]).remove('architecture');
-    expect(
-      await validateCodeAssetBuildOutput(
-        input,
-        BuildOutput(outputBuilder.json),
-      ),
-      contains(
-        contains(
-          'No value was provided for \'assets.0.architecture\'.'
-          ' Expected a String.',
-        ),
-      ),
-    );
   });
 
   test('dynamic_loading_system uri missing', () async {