Merge branch 'main' into Add-lint-package

Author: renancaraujo

.github/workflows/dart_frog_new.yaml

@@ -16,6 +16,5 @@ jobs:
   build:
     uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1
     with:
-      runs_on: macos-latest
       working_directory: bricks/dart_frog_new/hooks
       analyze_directories: .

.github/workflows/dart_frog_prod_server.yaml

@@ -16,7 +16,6 @@ jobs:
   build:
     uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1
     with:
-      runs_on: macos-latest
       working_directory: bricks/dart_frog_prod_server/hooks
       analyze_directories: .
       report_on: "pre_gen.dart,post_gen.dart"

bricks/create_dart_frog/__brick__/analysis_options.yaml

@@ -1,4 +1,4 @@
-include: package:very_good_analysis/analysis_options.4.0.0.yaml
+include: package:very_good_analysis/analysis_options.5.0.0.yaml
 analyzer:
   exclude:
     - build/**

bricks/create_dart_frog/__brick__/pubspec.yaml

@@ -4,12 +4,12 @@ version: 1.0.0+1
 publish_to: none
 
 environment:
-  sdk: ">=2.19.0 <3.0.0"
+  sdk: ">=3.0.0 <4.0.0"
 
 dependencies:
   dart_frog: ^0.3.0
 
 dev_dependencies:
   mocktail: ^0.3.0
   test: ^1.19.2
-  very_good_analysis: ^4.0.0
+  very_good_analysis: ^5.0.0

bricks/create_dart_frog/hooks/analysis_options.yaml

@@ -1 +1 @@
-include: package:very_good_analysis/analysis_options.4.0.0.yaml
+include: package:very_good_analysis/analysis_options.5.0.0.yaml

bricks/create_dart_frog/hooks/pubspec.yaml

@@ -1,7 +1,7 @@
 name: create_dart_frog_hooks
 
 environment:
-  sdk: ">=2.19.0 <3.0.0"
+  sdk: ">=3.0.0 <4.0.0"
 
 dependencies:
   mason: ^0.1.0-dev.39
@@ -10,4 +10,4 @@ dependencies:
 dev_dependencies:
   mocktail: ^0.3.0
   test: ^1.19.2
-  very_good_analysis: ^4.0.0
+  very_good_analysis: ^5.0.0

bricks/dart_frog_dev_server/hooks/analysis_options.yaml

@@ -1 +1 @@
-include: package:very_good_analysis/analysis_options.4.0.0.yaml
+include: package:very_good_analysis/analysis_options.5.0.0.yaml

bricks/dart_frog_dev_server/hooks/pubspec.yaml

@@ -2,7 +2,7 @@ name: dart_frog_dev_server_hooks
 publish_to: none
 
 environment:
-  sdk: ">=2.19.0 <3.0.0"
+  sdk: ">=3.0.0 <4.0.0"
 
 dependencies:
   dart_frog_gen: ^0.4.0
@@ -13,4 +13,4 @@ dev_dependencies:
   mocktail: ^0.3.0
   path: ^1.8.2
   test: ^1.19.2
-  very_good_analysis: ^4.0.0
+  very_good_analysis: ^5.0.0

bricks/dart_frog_new/hooks/analysis_options.yaml

@@ -1,4 +1,4 @@
-include: package:very_good_analysis/analysis_options.4.0.0.yaml
+include: package:very_good_analysis/analysis_options.5.0.0.yaml
 
 linter:
   rules:

bricks/dart_frog_new/hooks/pubspec.yaml

@@ -2,7 +2,7 @@ name: dart_frog_new_hooks
 publish_to: none
 
 environment:
-  sdk: ">=2.19.0 <3.0.0"
+  sdk: ">=3.0.0 <4.0.0"
 
 dependencies:
   dart_frog_gen: ^0.4.0
@@ -12,4 +12,4 @@ dependencies:
 dev_dependencies:
   mocktail: ^0.3.0
   test: ^1.19.2
-  very_good_analysis: ^4.0.0
+  very_good_analysis: ^5.0.0

bricks/dart_frog_prod_server/__brick__/build/Dockerfile

@@ -1,6 +1,6 @@
 # Official Dart image: https://hub.docker.com/_/dart
 # Specify the Dart SDK base image version using dart:<version> (ex: dart:2.17)
-FROM dart:stable AS build
+FROM dart:{{dartVersion}} AS build
 
 WORKDIR /app
 
@@ -28,4 +28,4 @@ COPY --from=build /app/bin/server /app/bin/
 {{#serveStaticFiles}}COPY --from=build /app/public /public/{{/serveStaticFiles}}
 
 # Start server.
-CMD ["/app/bin/server"]
+CMD ["/app/bin/server"]

bricks/dart_frog_prod_server/brick.yaml

@@ -4,3 +4,10 @@ version: 0.1.0+1
 
 environment:
   mason: ">=0.1.0-dev <0.1.0"
+
+vars:
+  dartVersion:
+    type: string
+    description: Dart version to be used in the generated Dockerfile.
+    default: stable
+    prompt: Dart version?

bricks/dart_frog_prod_server/hooks/analysis_options.yaml

@@ -1 +1 @@
-include: package:very_good_analysis/analysis_options.4.0.0.yaml
+include: package:very_good_analysis/analysis_options.5.0.0.yaml

bricks/dart_frog_prod_server/hooks/pre_gen.dart

@@ -93,5 +93,6 @@ Future<void> preGen(
     'invokeCustomEntrypoint': configuration.invokeCustomEntrypoint,
     'invokeCustomInit': configuration.invokeCustomInit,
     'pathDependencies': await getPathDependencies(projectDirectory),
+    'dartVersion': context.vars['dartVersion'],
   };
 }

bricks/dart_frog_prod_server/hooks/pubspec.yaml

@@ -2,7 +2,7 @@ name: dart_frog_prod_server_hooks
 publish_to: none
 
 environment:
-  sdk: ">=2.19.0 <3.0.0"
+  sdk: ">=3.0.0 <4.0.0"
 
 dependencies:
   dart_frog_gen: ^0.4.0
@@ -14,4 +14,4 @@ dependencies:
 dev_dependencies:
   mocktail: ^0.3.0
   test: ^1.19.2
-  very_good_analysis: ^4.0.0
+  very_good_analysis: ^5.0.0

bricks/dart_frog_prod_server/hooks/test/post_gen_test.dart

@@ -30,13 +30,19 @@ class _MockLogger extends Mock implements Logger {}
 
 class _MockProgress extends Mock implements Progress {}
 
-class _MockProcessResult extends Mock implements ProcessResult {}
-
 void main() {
   group('postGen', () {
     late HookContext context;
     late Logger logger;
 
+    const processId = 42;
+    final processResult = ProcessResult(
+      processId,
+      ExitCode.success.code,
+      '',
+      '',
+    );
+
     setUp(() {
       logger = _MockLogger();
       context = _FakeHookContext(logger: logger);
@@ -57,8 +63,7 @@ void main() {
     test('runs dart pub get and outputs next steps', () async {
       var processRunnerCallCount = 0;
       final exitCalls = <int>[];
-      final result = _MockProcessResult();
-      when(() => result.exitCode).thenReturn(ExitCode.success.code);
+
       await postGen(
         context,
         runProcess: (
@@ -75,7 +80,7 @@ void main() {
             equals(path.join(Directory.current.path, 'build')),
           );
           expect(runInShell, isTrue);
-          return result;
+          return processResult;
         },
         exit: exitCalls.add,
       );

bricks/dart_frog_prod_server/hooks/test/pre_gen_test.dart

@@ -38,7 +38,8 @@ void main() {
 
     setUp(() {
       logger = _MockLogger();
-      context = _FakeHookContext(logger: logger);
+      context = _FakeHookContext(logger: logger)
+        ..vars['dartVersion'] = 'stable';
 
       when(() => logger.progress(any())).thenReturn(_MockProgress());
     });
@@ -217,7 +218,8 @@ dev_dependencies:
           'serveStaticFiles': false,
           'invokeCustomEntrypoint': true,
           'invokeCustomInit': false,
-          'pathDependencies': <String>[]
+          'pathDependencies': <String>[],
+          'dartVersion': 'stable',
         }),
       );
     });
@@ -249,7 +251,8 @@ dev_dependencies:
           'serveStaticFiles': false,
           'invokeCustomEntrypoint': false,
           'invokeCustomInit': true,
-          'pathDependencies': <String>[]
+          'pathDependencies': <String>[],
+          'dartVersion': 'stable',
         }),
       );
     });
@@ -383,6 +386,7 @@ dev_dependencies:
             'invokeCustomEntrypoint': false,
             'invokeCustomInit': false,
             'pathDependencies': <String>[],
+            'dartVersion': 'stable',
           }),
         );
       },

bricks/dart_frog_prod_server/hooks/test/src/dart_pub_get_test.dart

@@ -27,13 +27,19 @@ class _MockLogger extends Mock implements Logger {}
 
 class _MockProgress extends Mock implements Progress {}
 
-class _MockProcessResult extends Mock implements ProcessResult {}
-
 void main() {
   group('dartPubGet', () {
     late HookContext context;
     late Logger logger;
 
+    const processId = 42;
+    final processResult = ProcessResult(
+      processId,
+      ExitCode.success.code,
+      '',
+      '',
+    );
+
     setUp(() {
       logger = _MockLogger();
       context = _FakeHookContext(logger: logger);
@@ -43,8 +49,7 @@ void main() {
 
     test('completes when process succeeds', () async {
       final exitCalls = <int>[];
-      final result = _MockProcessResult();
-      when(() => result.exitCode).thenReturn(ExitCode.success.code);
+
       await dartPubGet(
         context,
         workingDirectory: '.',
@@ -58,7 +63,7 @@ void main() {
           expect(args, equals(['pub', 'get']));
           expect(workingDirectory, equals('.'));
           expect(runInShell, isTrue);
-          return result;
+          return processResult;
         },
         exit: exitCalls.add,
       );
@@ -69,10 +74,14 @@ void main() {
     test('exits when process fails', () async {
       const error = 'oops something went wrong';
       final exitCalls = <int>[];
-      final result = _MockProcessResult();
-      final code = ExitCode.software.code;
-      when(() => result.exitCode).thenReturn(code);
-      when(() => result.stderr).thenReturn(error);
+
+      final processResult = ProcessResult(
+        processId,
+        ExitCode.software.code,
+        '',
+        error,
+      );
+
       await dartPubGet(
         context,
         workingDirectory: '.',
@@ -82,21 +91,17 @@ void main() {
           String? workingDirectory,
           bool? runInShell,
         }) async {
-          return result;
+          return processResult;
         },
         exit: exitCalls.add,
       );
-      expect(exitCalls, equals([code]));
+      expect(exitCalls, equals([ExitCode.software.code]));
       verify(() => logger.err(error)).called(1);
     });
 
     test('exits when ProcessException occurs', () async {
       const error = 'oops something went wrong';
       final exitCalls = <int>[];
-      final result = _MockProcessResult();
-      final code = ExitCode.software.code;
-      when(() => result.exitCode).thenReturn(code);
-      when(() => result.stderr).thenReturn(error);
       await dartPubGet(
         context,
         workingDirectory: '.',
@@ -106,11 +111,16 @@ void main() {
           String? workingDirectory,
           bool? runInShell,
         }) async {
-          throw ProcessException('dart', ['pub', 'get'], error, code);
+          throw ProcessException(
+            'dart',
+            ['pub', 'get'],
+            error,
+            ExitCode.software.code,
+          );
         },
         exit: exitCalls.add,
       );
-      expect(exitCalls, equals([code]));
+      expect(exitCalls, equals([ExitCode.software.code]));
       verify(() => logger.err(error)).called(1);
     });
   });

docs/docs/basics/environments.md

@@ -0,0 +1,55 @@
+---
+sidebar_position: 7
+title: 🌱 Environments
+---
+
+# Environments 🌱
+
+There are many ways that environments can be configured in a Dart Frog application. The
+easiest way is to use environment variables via the Dart SDK.
+
+As seen in the [dependency injection docs](dependency-injection.md), middleware can be used to provide dependencies to an application.
+
+Following this approach, the snippet shows how a database client can be configured with different environments.
+
+```dart
+Handler middleware(Handler handler) {
+  return handler
+      .use(provider<CardsRepository>((_) {
+        return DatabaseClient(
+          dbUrl: Platform.environment['DB_URL'],
+          dbUser: Platform.environment['DB_USER'],
+          dbPassword: Platform.environment['DB_PASSWORD'],
+        );
+      }),
+    );
+}
+```
+
+When running the server, these environment variables can be passed along directly to Dart Frog commands:
+
+Development server:
+
+```bash
+DB_URL=... DB_USER=... DB_PASSWORD=... dart_frog server
+```
+
+Production server:
+
+```bash
+DB_URL=... DB_USER=... DB_PASSWORD=... dart build/server.dart
+```
+
+These variables can also be exported in the current session:
+
+```bash
+EXPORT DB_URL=...
+EXPORT DB_USER=...
+EXPORT DB_PASSWORD=...
+```
+
+:::warning
+Accessing variables through `String.fromEnvironment` in a Dart Frog application will not work.`String.fromEnvironment` is meant to accesses variables set by the Dart
+compiler or runtime, which does not apply to a Dart Frog application. Instead, use
+`Platform.environment`.
+:::

docs/docs/basics/resources.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 7
+sidebar_position: 8
 title: 📚 Additional Resources
 ---