feat(dart_frog_cli): package:dart_frog runtime compatibility check (#366)

felangel · web-flow · commit b90ce81eb506 · 2022-10-11T18:24:02.000-05:00
diff --git a/.github/workflows/examples_counter.yaml b/.github/workflows/examples_counter.yaml
@@ -14,6 +14,8 @@ on:
       - ".github/workflows/examples_counter.yaml"
       - "packages/dart_frog/lib/**"
       - "packages/dart_frog/pubspec.yaml"
+      - "packages/dart_frog_cli/lib/**"
+      - "packages/dart_frog_cli/pubspec.yaml"
     branches:
       - main
 
diff --git a/.github/workflows/examples_echo.yaml b/.github/workflows/examples_echo.yaml
@@ -14,6 +14,8 @@ on:
       - ".github/workflows/examples_echo.yaml"
       - "packages/dart_frog/lib/**"
       - "packages/dart_frog/pubspec.yaml"
+      - "packages/dart_frog_cli/lib/**"
+      - "packages/dart_frog_cli/pubspec.yaml"
     branches:
       - main
 
diff --git a/.github/workflows/examples_hello_world.yaml b/.github/workflows/examples_hello_world.yaml
@@ -14,6 +14,8 @@ on:
       - ".github/workflows/examples_hello_world.yaml"
       - "packages/dart_frog/lib/**"
       - "packages/dart_frog/pubspec.yaml"
+      - "packages/dart_frog_cli/lib/**"
+      - "packages/dart_frog_cli/pubspec.yaml"
     branches:
       - main
 
diff --git a/.github/workflows/examples_todos.yaml b/.github/workflows/examples_todos.yaml
@@ -16,6 +16,8 @@ on:
       - ".github/workflows/examples_todos.yaml"
       - "packages/dart_frog/lib/**"
       - "packages/dart_frog/pubspec.yaml"
+      - "packages/dart_frog_cli/lib/**"
+      - "packages/dart_frog_cli/pubspec.yaml"
     branches:
       - main
 
diff --git a/docs/docs/overview.md b/docs/docs/overview.md
@@ -50,6 +50,10 @@ dart_frog dev
 By default port `8080` is used. A custom port can be used via the `--port` option.
 :::
 
+:::caution
+Each release of the `dart_frog_cli` supports a specific version range of the `dart_frog` runtime. If the current version of the `dart_frog` runtime is incompatible with the installed `dart_frog_cli` version, an error will be reported and you will need to update your `dart_frog_cli` version or `dart_frog` version accordingly.
+:::
+
 ### Create a Production Build 📦
 
 Create a production build which includes a `DockerFile` so that you can deploy anywhere:
diff --git a/examples/counter/pubspec.yaml b/examples/counter/pubspec.yaml
@@ -7,7 +7,7 @@ environment:
   sdk: ">=2.17.0 <3.0.0"
 
 dependencies:
-  dart_frog: ^0.0.1-dev
+  dart_frog: ^0.1.0
 
 dev_dependencies:
   http: ^0.13.5
diff --git a/examples/echo/pubspec.yaml b/examples/echo/pubspec.yaml
@@ -7,7 +7,7 @@ environment:
   sdk: ">=2.17.0 <3.0.0"
 
 dependencies:
-  dart_frog: ^0.0.1-dev
+  dart_frog: ^0.1.0
 
 dev_dependencies:
   http: ^0.13.5
diff --git a/examples/hello_world/pubspec.yaml b/examples/hello_world/pubspec.yaml
@@ -7,7 +7,7 @@ environment:
   sdk: ">=2.17.0 <3.0.0"
 
 dependencies:
-  dart_frog: ^0.0.1-dev
+  dart_frog: ^0.1.0
 
 dev_dependencies:
   http: ^0.13.5
diff --git a/examples/todos/pubspec.yaml b/examples/todos/pubspec.yaml
@@ -7,7 +7,7 @@ environment:
   sdk: ">=2.17.0 <3.0.0"
 
 dependencies:
-  dart_frog: ^0.0.1-dev
+  dart_frog: ^0.1.0
   in_memory_todos_data_source:
     path: packages/in_memory_todos_data_source
   todos_data_source:
diff --git a/packages/dart_frog_cli/lib/src/commands/build/build.dart b/packages/dart_frog_cli/lib/src/commands/build/build.dart
@@ -1,16 +1,26 @@
+import 'dart:io';
+
 import 'package:dart_frog_cli/src/command.dart';
 import 'package:dart_frog_cli/src/commands/build/templates/dart_frog_prod_server_bundle.dart';
 import 'package:dart_frog_cli/src/commands/commands.dart';
+import 'package:dart_frog_cli/src/runtime_compatibility.dart'
+    as runtime_compatibility;
 import 'package:mason/mason.dart';
 
 /// {@template build_command}
 /// `dart_frog build` command which creates a production build`.
 /// {@endtemplate}
 class BuildCommand extends DartFrogCommand {
   /// {@macro build_command}
-  BuildCommand({super.logger, GeneratorBuilder? generator})
-      : _generator = generator ?? MasonGenerator.fromBundle;
-
+  BuildCommand({
+    super.logger,
+    void Function(Directory)? ensureRuntimeCompatibility,
+    GeneratorBuilder? generator,
+  })  : _ensureRuntimeCompatibility = ensureRuntimeCompatibility ??
+            runtime_compatibility.ensureRuntimeCompatibility,
+        _generator = generator ?? MasonGenerator.fromBundle;
+
+  final void Function(Directory) _ensureRuntimeCompatibility;
   final GeneratorBuilder _generator;
 
   @override
@@ -21,6 +31,8 @@ class BuildCommand extends DartFrogCommand {
 
   @override
   Future<int> run() async {
+    _ensureRuntimeCompatibility(cwd);
+
     final generator = await _generator(dartFrogProdServerBundle);
     var vars = <String, dynamic>{};
 
diff --git a/packages/dart_frog_cli/lib/src/commands/dev/dev.dart b/packages/dart_frog_cli/lib/src/commands/dev/dev.dart
@@ -1,10 +1,13 @@
 import 'dart:collection';
 import 'dart:convert';
 import 'dart:io' as io;
+import 'dart:io';
 
 import 'package:dart_frog_cli/src/command.dart';
 import 'package:dart_frog_cli/src/commands/commands.dart';
 import 'package:dart_frog_cli/src/commands/dev/templates/dart_frog_dev_server_bundle.dart';
+import 'package:dart_frog_cli/src/runtime_compatibility.dart'
+    as runtime_compatibility;
 import 'package:mason/mason.dart';
 import 'package:path/path.dart' as path;
 import 'package:stream_transform/stream_transform.dart';
@@ -51,6 +54,7 @@ class DevCommand extends DartFrogCommand {
   /// {@macro dev_command}
   DevCommand({
     super.logger,
+    void Function(Directory)? ensureRuntimeCompatibility,
     DirectoryWatcherBuilder? directoryWatcher,
     GeneratorBuilder? generator,
     RestorableDirectoryGeneratorTargetBuilder? generatorTarget,
@@ -59,7 +63,9 @@ class DevCommand extends DartFrogCommand {
     ProcessRun? runProcess,
     io.ProcessSignal? sigint,
     ProcessStart? startProcess,
-  })  : _directoryWatcher = directoryWatcher ?? DirectoryWatcher.new,
+  })  : _ensureRuntimeCompatibility = ensureRuntimeCompatibility ??
+            runtime_compatibility.ensureRuntimeCompatibility,
+        _directoryWatcher = directoryWatcher ?? DirectoryWatcher.new,
         _generator = generator ?? MasonGenerator.fromBundle,
         _exit = exit ?? io.exit,
         _isWindows = isWindows ?? io.Platform.isWindows,
@@ -75,6 +81,7 @@ class DevCommand extends DartFrogCommand {
     );
   }
 
+  final void Function(Directory) _ensureRuntimeCompatibility;
   final DirectoryWatcherBuilder _directoryWatcher;
   final GeneratorBuilder _generator;
   final Exit _exit;
@@ -92,6 +99,8 @@ class DevCommand extends DartFrogCommand {
 
   @override
   Future<int> run() async {
+    _ensureRuntimeCompatibility(cwd);
+
     var reloading = false;
     var hotReloadEnabled = false;
     final port = io.Platform.environment['PORT'] ?? results['port'] as String;
diff --git a/packages/dart_frog_cli/lib/src/runtime_compatibility.dart b/packages/dart_frog_cli/lib/src/runtime_compatibility.dart
@@ -0,0 +1,61 @@
+import 'dart:io';
+
+import 'package:mason/mason.dart';
+import 'package:path/path.dart' as path;
+import 'package:pubspec_parse/pubspec_parse.dart';
+
+/// {@template dart_frog_compatibility_exception}
+/// An exception thrown when the current version of dart_frog_cli
+/// is incompatible with the dart_frog runtime being used.
+/// {@endtemplate}
+class DartFrogCompatibilityException implements Exception {
+  /// {@macro dart_frog_compatibility_exception}
+  const DartFrogCompatibilityException(this.message);
+
+  /// The error message.
+  final String message;
+
+  @override
+  String toString() => message;
+}
+
+/// The version range of package:dart_frog
+/// supported by the current version of package:dart_frog_cli.
+const compatibleDartFrogVersion = '>=0.1.0 <0.2.0';
+
+/// Whether current version of package:dart_frog_cli is compatible
+/// with the provided [version] of package:dart_frog.
+bool isCompatibleWithDartFrog(VersionConstraint version) {
+  return VersionConstraint.parse(compatibleDartFrogVersion).allowsAll(version);
+}
+
+/// Ensures that the current version of `package:dart_frog_cli` is compatible
+/// with the version of `package:dart_frog` used in the [cwd].
+void ensureRuntimeCompatibility(Directory cwd) {
+  final pubspecFile = File(path.join(cwd.path, 'pubspec.yaml'));
+  if (!pubspecFile.existsSync()) {
+    throw DartFrogCompatibilityException(
+      'Expected to find a pubspec.yaml in ${cwd.path}.',
+    );
+  }
+
+  final pubspec = Pubspec.parse(pubspecFile.readAsStringSync());
+  final dependencyEntry = pubspec.dependencies.entries.where(
+    (e) => e.key == 'dart_frog',
+  );
+
+  if (dependencyEntry.isEmpty) {
+    throw const DartFrogCompatibilityException(
+      'Expected to find a dependency on "dart_frog" in the pubspec.yaml',
+    );
+  }
+
+  final dependency = dependencyEntry.first.value;
+  if (dependency is HostedDependency) {
+    if (!isCompatibleWithDartFrog(dependency.version)) {
+      throw DartFrogCompatibilityException(
+        '''The current version of "dart_frog_cli" requires "dart_frog" $compatibleDartFrogVersion.\nBecause the current version of "dart_frog" is ${dependency.version}, version solving failed.''',
+      );
+    }
+  }
+}
diff --git a/packages/dart_frog_cli/pubspec.yaml b/packages/dart_frog_cli/pubspec.yaml
@@ -15,6 +15,7 @@ dependencies:
   meta: ^1.7.0
   path: ^1.8.1
   pub_updater: ^0.2.2
+  pubspec_parse: ^1.2.0
   stream_transform: ^2.0.0
   watcher: ^1.0.1
 
diff --git a/packages/dart_frog_cli/test/src/commands/build/build_test.dart b/packages/dart_frog_cli/test/src/commands/build/build_test.dart
@@ -1,4 +1,5 @@
 import 'package:dart_frog_cli/src/commands/commands.dart';
+import 'package:dart_frog_cli/src/runtime_compatibility.dart';
 import 'package:mason/mason.dart';
 import 'package:mocktail/mocktail.dart';
 import 'package:test/test.dart';
@@ -32,10 +33,21 @@ void main() {
       generator = _MockMasonGenerator();
       command = BuildCommand(
         logger: logger,
+        ensureRuntimeCompatibility: (_) {},
         generator: (_) async => generator,
       );
     });
 
+    test('throws if ensureRuntimeCompatibility fails', () {
+      command = BuildCommand(
+        logger: logger,
+        ensureRuntimeCompatibility: (_) {
+          throw const DartFrogCompatibilityException('oops');
+        },
+      );
+      expect(command.run, throwsA(isA<DartFrogCompatibilityException>()));
+    });
+
     test('generates a build successfully.', () async {
       final generatorHooks = _MockGeneratorHooks();
       when(
diff --git a/packages/dart_frog_cli/test/src/commands/dev/dev_test.dart b/packages/dart_frog_cli/test/src/commands/dev/dev_test.dart
@@ -4,6 +4,7 @@ import 'dart:io';
 
 import 'package:args/args.dart';
 import 'package:dart_frog_cli/src/commands/commands.dart';
+import 'package:dart_frog_cli/src/runtime_compatibility.dart';
 import 'package:mason/mason.dart';
 import 'package:mocktail/mocktail.dart';
 import 'package:path/path.dart' as path;
@@ -69,6 +70,7 @@ void main() {
       generatorTarget = _MockRestorableDirectoryGeneratorTarget();
       command = DevCommand(
         logger: logger,
+        ensureRuntimeCompatibility: (_) {},
         directoryWatcher: (_) => directoryWatcher,
         generator: (_) async => generator,
         generatorTarget: (_) => generatorTarget,
@@ -87,6 +89,16 @@ void main() {
       )..testArgResults = argResults;
     });
 
+    test('throws if ensureRuntimeCompatibility fails', () {
+      command = DevCommand(
+        logger: logger,
+        ensureRuntimeCompatibility: (_) {
+          throw const DartFrogCompatibilityException('oops');
+        },
+      );
+      expect(command.run, throwsA(isA<DartFrogCompatibilityException>()));
+    });
+
     test('runs a dev server successfully.', () async {
       final generatorHooks = _MockGeneratorHooks();
       when(
@@ -549,6 +561,7 @@ void main() {
       when(() => sigint.watch()).thenAnswer((_) => Stream.value(sigint));
       command = DevCommand(
         logger: logger,
+        ensureRuntimeCompatibility: (_) {},
         directoryWatcher: (_) => directoryWatcher,
         generator: (_) async => generator,
         exit: (code) => exitCode = code,
@@ -616,6 +629,7 @@ void main() {
       when(() => sigint.watch()).thenAnswer((_) => const Stream.empty());
       command = DevCommand(
         logger: logger,
+        ensureRuntimeCompatibility: (_) {},
         directoryWatcher: (_) => directoryWatcher,
         generator: (_) async => generator,
         exit: (code) => exitCode = code,
@@ -681,6 +695,7 @@ void main() {
       when(() => sigint.watch()).thenAnswer((_) => const Stream.empty());
       command = DevCommand(
         logger: logger,
+        ensureRuntimeCompatibility: (_) {},
         directoryWatcher: (_) => directoryWatcher,
         generator: (_) async => generator,
         exit: (code) => exitCode = code,
diff --git a/packages/dart_frog_cli/test/src/runtime_compatibility_test.dart b/packages/dart_frog_cli/test/src/runtime_compatibility_test.dart
