[native_assets_cli] Stop reading version (#2143)

Bug: #93

Remove any reads of `version` in the protocol.

We're moving towards a world where deprecations and breaking changes are per property and documented via the JSON schemas. So we don't use version numbers anymore.

* Change the syntax to make `version` nullable.
* Still write the last known version (to avoid breaking older hooks and older SDKs with newer SDKs and hooks).
* Remove the `version` from the semantic API.
* Remove all checks that were checking for versions.
  * Note: this regresses error messages, and this is intended.

Author: dcharkes

pkgs/hooks/doc/schema/sdk/shared_definitions.schema.json

@@ -36,10 +36,6 @@
     "HookOutput": {},
     "LinkInput": {
       "$ref": "../shared/shared_definitions.schema.json#/definitions/LinkInput",
-      "required": [
-        "out_file",
-        "version"
-      ],
       "unevaluatedProperties": false
     },
     "LinkOutput": {}

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

@@ -139,8 +139,7 @@
         "out_dir",
         "out_dir_shared",
         "package_name",
-        "package_root",
-        "version"
+        "package_root"
       ]
     },
     "HookOutput": {
@@ -169,8 +168,7 @@
         }
       },
       "required": [
-        "timestamp",
-        "version"
+        "timestamp"
       ]
     },
     "LinkInput": {

pkgs/hooks/test/schema/helpers.dart

@@ -288,16 +288,21 @@ FieldsReturn _hookFields({
   required Party party,
 }) {
   void versionMissingExpectation(ValidationResults result) {
-    if ((party == Party.sdk && inputOrOutput == InputOrOutput.input) ||
-        (party == Party.hook && inputOrOutput == InputOrOutput.output)) {
+    if (party == Party.sdk && inputOrOutput == InputOrOutput.input) {
       // The writer must output this field. SDK must support older hooks reading
       // it.
       expect(result.isValid, isFalse);
+    } else if (party == Party.hook && inputOrOutput == InputOrOutput.output) {
+      // The writer must output this field. SDK must support older hooks reading
+      // it.
+      // Note: For some reason party:hook output does not register as required
+      // `package:json_schema`, but the JSON validator in vscode does properly
+      // mark it as required.
+      // Ignore this issue for now, we'll remove version soon.
+      // expect(result.isValid, isFalse);
     } else {
       // Newer hooks must support future SDKs not outputting a this field.
-      // TODO: Stop requiring version in the reader.
-      // expect(result.isValid, isTrue);
-      expect(result.isValid, isFalse);
+      expect(result.isValid, isTrue);
     }
   }
 

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

@@ -11,7 +11,6 @@ import 'package:logging/logging.dart';
 import 'package:meta/meta.dart';
 import 'package:native_assets_cli/native_assets_cli_internal.dart';
 import 'package:package_config/package_config.dart';
-import 'package:pub_semver/pub_semver.dart';
 
 import '../dependencies_hash_file/dependencies_hash_file.dart';
 import '../locking/locking.dart';
@@ -91,10 +90,6 @@ class NativeAssetsBuildRunner {
     );
     if (buildPlan == null) return null;
 
-    if (!await _ensureNativeAssetsCliProtocolVersion()) {
-      return null;
-    }
-
     var hookResult = HookResult();
     final globalMetadata = <String, Metadata>{};
     for (final package in buildPlan) {
@@ -833,58 +828,6 @@ ${compileResult.stdout}
         ? BuildOutput(hookOutputJson)
         : LinkOutput(hookOutputJson);
   }
-
-  Future<bool> _ensureNativeAssetsCliProtocolVersion() async {
-    final package =
-        packageLayout.packageConfig['native_assets_cli'] ??
-        packageLayout.packageConfig['hook']; // Anticipate rename.
-    if (package == null) {
-      // No dependencies with a hook or using a different protocol helper
-      // package.
-      return true;
-    }
-    final packageRoot = package.root.normalizePath();
-    final hookVersion = await _nativeAssetsCliProtocolVersion(packageRoot);
-    if (hookVersion == null) {
-      logger.fine(
-        'Could not determine the protocol version of '
-        '${packageRoot.toFilePath()}.',
-      );
-      // This is most likely due to a newer version of the package.
-      return true;
-    }
-    if (latestParsableVersion > hookVersion) {
-      // The hook is too old.
-      logger.shout(
-        'The protocol version of ${packageRoot.toFilePath()} is '
-        '$hookVersion, which is no longer supported. Please update your '
-        'dependencies.',
-      );
-      return false;
-    }
-    return true;
-  }
-
-  Future<Version?> _nativeAssetsCliProtocolVersion(Uri packageRoot) async {
-    const files = ['lib/src/config.dart', 'lib/src/model/hook_config.dart'];
-    for (final fileName in files) {
-      final file = _fileSystem.file(packageRoot.resolve(fileName));
-      if (!await file.exists()) {
-        continue;
-      }
-      final contents = await file.readAsString();
-      final regex = RegExp(r'latestVersion = Version\((\d+), (\d+), (\d+)\);');
-      final match = regex.firstMatch(contents);
-      if (match == null) {
-        continue;
-      }
-      final major = int.parse(match.group(1)!);
-      final minor = int.parse(match.group(2)!);
-      final patch = int.parse(match.group(3)!);
-      return Version(major, minor, patch);
-    }
-    return null;
-  }
 }
 
 /// Parses depfile contents.

pkgs/native_assets_builder/test/build_runner/version_skew_test.dart

@@ -53,12 +53,7 @@ void main() async {
         expect(result, isNull);
         expect(
           logMessages.join('\n'),
-          stringContainsInOrder([
-            'The protocol version of ',
-            'native_assets_cli',
-            ' is 1.3.0, which is no longer supported.',
-            'Please update your dependencies.',
-          ]),
+          stringContainsInOrder(['Unhandled exception']),
         );
       });
     },

pkgs/native_assets_cli/lib/native_assets_cli_internal.dart

@@ -6,5 +6,4 @@
 library;
 
 export 'native_assets_cli_builder.dart';
-export 'src/config.dart' show latestParsableVersion;
 export 'src/model/hook.dart';

pkgs/native_assets_cli/lib/src/config.dart

@@ -24,9 +24,6 @@ sealed class HookInput {
   /// The underlying json configuration of this [HookInput].
   Map<String, Object?> get json => _syntax.json;
 
-  /// The version of the [HookInput].
-  Version get version => Version.parse(_syntax.version);
-
   /// The directory in which output and intermediate artifacts that are unique
   /// to the [config] can be placed.
   ///
@@ -82,13 +79,6 @@ sealed class HookInput {
 
   HookInput(Map<String, Object?> json)
     : _syntax = syntax.HookInput.fromJson(json) {
-    if (version.major != latestVersion.major ||
-        version < latestParsableVersion) {
-      throw FormatException(
-        'Only compatible versions with $latestVersion are supported '
-        '(was: $version).',
-      );
-    }
     // Trigger validation, remove with cleanup.
     outputDirectory;
     outputDirectoryShared;
@@ -290,9 +280,6 @@ sealed class HookOutput {
   /// The underlying json configuration of this [HookOutput].
   Map<String, Object?> get json => _syntax.json;
 
-  /// The version of the [HookInput].
-  Version get version => Version.parse(_syntax.version);
-
   /// Start time for the build of this output.
   ///
   /// The [timestamp] is rounded down to whole seconds, because
@@ -316,15 +303,7 @@ sealed class HookOutput {
 
   syntax.HookOutput get _syntax;
 
-  HookOutput._(Map<String, Object?> json) {
-    if (version.major != latestVersion.major ||
-        version < latestParsableVersion) {
-      throw FormatException(
-        'Only compatible versions with $latestVersion are supported '
-        '(was: $version).',
-      );
-    }
-  }
+  HookOutput._(Map<String, Object?> json);
 
   @override
   String toString() => const JsonEncoder.withIndent('  ').convert(json);
@@ -607,27 +586,9 @@ extension type EncodedAssetLinkOutputBuilder._(LinkOutputBuilder _builder) {
       syntax.LinkOutput.fromJson(_builder._syntax.json);
 }
 
-/// The latest supported input version.
-///
-/// We'll never bump the major version. Removing old keys from the input and
-/// output is done via modifying [latestParsableVersion].
+// Deprecated, still emitted for backwards compatibility purposes.
 final latestVersion = Version(1, 9, 0);
 
-/// The parser can deal with inputs and outputs down to this version.
-///
-/// This version can be bumped when:
-///
-/// 1. The stable version of Dart / Flutter uses a newer version _and_ the SDK
-///    constraint is bumped in the pubspec of this package to that stable
-///    version. (This prevents input parsing from failing.)
-/// 2. A stable version of this package is published uses a newer version, _and_
-///    most users have migrated to it. (This prevents the output parsing from
-///    failing.)
-///
-/// When updating this number, update the version_skew_test.dart. (This test
-/// catches issues with 2.)
-final latestParsableVersion = Version(1, 7, 0);
-
 /// The configuration for a build or link hook invocation.
 final class HookConfig {
   Map<String, Object?> get json => _syntax.json;

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

@@ -350,7 +350,7 @@ class HookInput {
     required Uri? outFile,
     required String packageName,
     required Uri packageRoot,
-    required String version,
+    required String? version,
   }) : json = {},
        path = const [] {
     this.config = config;
@@ -428,14 +428,14 @@ class HookInput {
 
   List<String> _validatePackageRoot() => _reader.validatePath('package_root');
 
-  String get version => _reader.get<String>('version');
+  String? get version => _reader.get<String?>('version');
 
-  set version(String value) {
+  set version(String? value) {
     json.setOrRemove('version', value);
     json.sortOnKey();
   }
 
-  List<String> _validateVersion() => _reader.validate<String>('version');
+  List<String> _validateVersion() => _reader.validate<String?>('version');
 
   List<String> validate() => [
     ..._validateConfig(),
@@ -464,7 +464,7 @@ class HookOutput {
     required List<Asset>? assets,
     required List<Uri>? dependencies,
     required String timestamp,
-    required String version,
+    required String? version,
   }) : json = {},
        path = const [] {
     this.assets = assets;
@@ -528,14 +528,14 @@ class HookOutput {
 
   List<String> _validateTimestamp() => _reader.validate<String>('timestamp');
 
-  String get version => _reader.get<String>('version');
+  String? get version => _reader.get<String?>('version');
 
-  set version(String value) {
+  set version(String? value) {
     json.setOrRemove('version', value);
     json.sortOnKey();
   }
 
-  List<String> _validateVersion() => _reader.validate<String>('version');
+  List<String> _validateVersion() => _reader.validate<String?>('version');
 
   List<String> validate() => [
     ..._validateAssets(),