feat: add a default logger (#20)

Author: GregoryConrad

README.md

@@ -32,38 +32,17 @@ If you haven't already, create a `Cargo.toml` and `rust-toolchain.toml` in your
 keep reading for what these two files must contain
 (but don't worry if you forget, you'll get a helpful error message).
 
-### Quick n' dirty ("it just works") setup
+### `hook/build.dart`
 ```dart
-// hook/build.dart:
 import 'package:hooks/hooks.dart';
 import 'package:native_toolchain_rs/native_toolchain_rs.dart';
 
 void main(List<String> args) async {
   await build(args, (input, output) async {
-    await RustBuilder(
-      assetName: 'src/my_ffi_bindings.g.dart',
-    ).run(input: input, output: output);
-  });
-}
-```
-
-### Recommended setup (so you get logs)
-```dart
-// hook/build.dart:
-import 'package:hooks/hooks.dart';
-import 'package:logging/logging.dart';
-import 'package:native_toolchain_rs/native_toolchain_rs.dart';
-
-void main(List<String> args) async {
-  Logger.root.level = Level.CONFIG; // or whatever level you prefer
-
-  await build(args, (input, output) async {
-    final logger = Logger('my_package_build')..onRecord.listen(print);
-
     await RustBuilder(
       assetName: 'src/my_ffi_bindings.g.dart',
       // ...maybe enable some Cargo features or something in here too
-    ).run(input: input, output: output, logger: logger);
+    ).run(input: input, output: output);
   });
 }
 ```

native_toolchain_rs/lib/native_toolchain_rs.dart

@@ -1,3 +1,5 @@
+import 'dart:io';
+
 import 'package:code_assets/code_assets.dart';
 import 'package:hooks/hooks.dart';
 import 'package:logging/logging.dart';
@@ -89,6 +91,7 @@ final class RustBuilder implements Builder {
     List<AssetRouting> assetRouting = const [ToAppBundle()],
     Logger? logger,
   }) {
+    logger ??= _createDefaultLogger();
     final processRunner = ProcessRunner(logger);
     const crateDirectoryResolver = CrateDirectoryResolver();
     final tomlDocumentWrapperFactory = TomlDocumentWrapperFactory(logger);
@@ -116,3 +119,22 @@ final class RustBuilder implements Builder {
     ).run(input: input, output: output, assetRouting: assetRouting);
   }
 }
+
+Logger _createDefaultLogger() {
+  return Logger.detached('RustBuilder')
+    ..level = Level.CONFIG
+    ..onRecord.listen((LogRecord record) {
+      final output = record.level >= Level.WARNING ? stderr : stdout;
+
+      // NOTE: this is an unreadable mess with cascade notation
+      // ignore: cascade_invocations
+      output.writeln(record);
+
+      if (record.error != null) {
+        output.writeln(record.error);
+      }
+      if (record.stackTrace != null) {
+        output.writeln(record.stackTrace);
+      }
+    });
+}

native_toolchain_rs/lib/src/build_runner.dart

@@ -24,7 +24,7 @@ interface class RustBuildRunner {
   });
 
   final RustBuilder config;
-  final Logger? logger;
+  final Logger logger;
   final CrateDirectoryResolver crateDirectoryResolver;
   final ProcessRunner processRunner;
   final BuildEnvironmentFactory buildEnvironmentFactory;
@@ -35,19 +35,20 @@ interface class RustBuildRunner {
     required BuildOutputBuilder output,
     required List<AssetRouting> assetRouting,
   }) async {
-    logger?.info('Starting build of Rust native assets');
-    logger?.config(input);
-    logger?.config(Platform.environment);
+    logger
+      ..info('Starting build of Rust native assets')
+      ..config(input)
+      ..config(Platform.environment);
 
     if (!input.config.buildCodeAssets) {
-      logger?.info(
+      logger.info(
         'buildCodeAssets is false; '
         'skipping build of Rust native assets',
       );
       return;
     }
 
-    logger?.info('Gathering all data required for the build');
+    logger.info('Gathering all data required for the build');
     final codeConfig = input.config.code;
     final CodeConfig(:targetOS, :targetTriple, :linkMode) = codeConfig;
     final RustBuilder(
@@ -77,10 +78,10 @@ interface class RustBuildRunner {
     // NOTE: re-run build whenever anything in the Rust directory changes
     output.dependencies.add(crateDirectory.uri);
 
-    logger?.info('Ensuring $toolchainChannel is installed');
+    logger.info('Ensuring $toolchainChannel is installed');
     await ensureToolchainDownloaded(crateDirectory.path);
 
-    logger?.info('Running cargo build');
+    logger.info('Running cargo build');
     await processRunner.invokeRustup(
       [
         'run',
@@ -135,6 +136,6 @@ interface class RustBuildRunner {
       'show',
       'active-toolchain',
     ], workingDirectory: crateDirectory);
-    logger?.config(showToolchainOutput);
+    logger.config(showToolchainOutput);
   }
 }

native_toolchain_rs/lib/src/process_runner.dart

@@ -7,7 +7,7 @@ import 'package:native_toolchain_rs/src/exception.dart';
 @internal
 interface class ProcessRunner {
   const ProcessRunner(this.logger);
-  final Logger? logger;
+  final Logger logger;
 
   Future<String> invoke(
     String executable,
@@ -16,7 +16,7 @@ interface class ProcessRunner {
     Map<String, String>? environment,
   }) async {
     try {
-      logger?.info(
+      logger.info(
         'Invoking "$executable $arguments" '
         '${workingDirectory != null ? 'in directory $workingDirectory ' : ''}'
         'with environment: ${environment ?? {}}',
@@ -35,7 +35,7 @@ interface class ProcessRunner {
       }
       return result.stdout as String;
     } on ProcessException catch (exception, stackTrace) {
-      logger?.severe(
+      logger.severe(
         'Failed to invoke "$executable $arguments"',
         exception,
         stackTrace,

native_toolchain_rs/lib/src/toml_parsing.dart

@@ -8,7 +8,7 @@ import 'package:toml/toml.dart';
 @internal
 interface class TomlDocumentWrapperFactory {
   const TomlDocumentWrapperFactory(this.logger);
-  final Logger? logger;
+  final Logger logger;
 
   TomlDocumentWrapper parseFile(String filePath) =>
       TomlDocumentWrapper(logger, filePath, TomlDocument.loadSync(filePath));
@@ -18,7 +18,7 @@ interface class TomlDocumentWrapperFactory {
 final class TomlDocumentWrapper {
   const TomlDocumentWrapper(this.logger, this.filePath, this.document);
 
-  final Logger? logger;
+  final Logger logger;
   final String filePath;
   final TomlDocument document;
 
@@ -32,7 +32,7 @@ final class TomlDocumentWrapper {
       }
       return currNode as T;
     } on Object catch (exception, stackTrace) {
-      logger?.severe(
+      logger.severe(
         'Failed to find $path in $filePath: $document',
         exception,
         stackTrace,
@@ -50,13 +50,13 @@ The following exception was thrown: $exception''',
 @internal
 interface class CargoManifestParser {
   const CargoManifestParser(this.logger, this.tomlDocumentFactory);
-  final Logger? logger;
+  final Logger logger;
   final TomlDocumentWrapperFactory tomlDocumentFactory;
 
   ({String crateName, List<String> libCrateTypes}) parseManifest(
     String manifestPath,
   ) {
-    logger?.info('Looking for Cargo.toml');
+    logger.info('Looking for Cargo.toml');
     if (!File(manifestPath).existsSync()) {
       throw RustValidationException([
         '''
@@ -65,12 +65,12 @@ For more information, see https://github.com/GregoryConrad/native_toolchain_rs?t
       ]);
     }
 
-    logger?.info('Parsing Cargo.toml');
+    logger.info('Parsing Cargo.toml');
     final TomlDocumentWrapper manifest;
     try {
       manifest = tomlDocumentFactory.parseFile(manifestPath);
     } on Object catch (exception, stackTrace) {
-      logger?.severe('Failed to parse Cargo.toml', exception, stackTrace);
+      logger.severe('Failed to parse Cargo.toml', exception, stackTrace);
       throw RustValidationException([
         '''
 Failed to parse the Cargo.toml file at $manifestPath.
@@ -116,13 +116,13 @@ and https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-crate-type-
 @internal
 interface class ToolchainTomlParser {
   const ToolchainTomlParser(this.logger, this.tomlDocumentFactory);
-  final Logger? logger;
+  final Logger logger;
   final TomlDocumentWrapperFactory tomlDocumentFactory;
 
   ({Set<String> targets, String channel}) parseToolchainToml(
     String toolchainTomlPath,
   ) {
-    logger?.info('Looking for rust-toolchain.toml');
+    logger.info('Looking for rust-toolchain.toml');
     if (!File(toolchainTomlPath).existsSync()) {
       throw RustValidationException([
         '''
@@ -131,12 +131,12 @@ For more information, see https://github.com/GregoryConrad/native_toolchain_rs?t
       ]);
     }
 
-    logger?.info('Parsing rust-toolchain.toml');
+    logger.info('Parsing rust-toolchain.toml');
     final TomlDocumentWrapper toolchain;
     try {
       toolchain = tomlDocumentFactory.parseFile(toolchainTomlPath);
     } on Object catch (e, stackTrace) {
-      logger?.severe('Failed to parse rust-toolchain.toml', e, stackTrace);
+      logger.severe('Failed to parse rust-toolchain.toml', e, stackTrace);
       throw RustValidationException([
         '''
 Failed to parse the rust-toolchain.toml file at $toolchainTomlPath.

native_toolchain_rs/test/toml_parsing_test.dart

@@ -1,10 +1,13 @@
 import 'dart:io';
 
+import 'package:logging/logging.dart';
 import 'package:native_toolchain_rs/src/exception.dart';
 import 'package:native_toolchain_rs/src/toml_parsing.dart';
 import 'package:test/test.dart';
 
 void main() {
+  final logger = Logger.detached('TestLogger');
+
   group('TomlDocumentWrapper', () {
     late Directory tempDir;
     late String tempFilePath;
@@ -20,14 +23,14 @@ void main() {
 
     test('walk returns value when path is valid', () {
       File(tempFilePath).writeAsStringSync('key = "value"\n');
-      const factory = TomlDocumentWrapperFactory(null);
+      final factory = TomlDocumentWrapperFactory(logger);
       final wrapper = factory.parseFile(tempFilePath);
       expect(wrapper.walk<String>('key'), 'value');
     });
 
     test('walk throws RustValidationException when path is invalid', () {
       File(tempFilePath).writeAsStringSync('key = "value"\n');
-      const factory = TomlDocumentWrapperFactory(null);
+      final factory = TomlDocumentWrapperFactory(logger);
       final wrapper = factory.parseFile(tempFilePath);
       expect(
         () => wrapper.walk<String>('invalid.path'),
@@ -37,8 +40,8 @@ void main() {
   });
 
   group('CargoManifestParser', () {
-    const tomlDocumentFactory = TomlDocumentWrapperFactory(null);
-    const parser = CargoManifestParser(null, tomlDocumentFactory);
+    final tomlDocumentFactory = TomlDocumentWrapperFactory(logger);
+    final parser = CargoManifestParser(logger, tomlDocumentFactory);
     late Directory tempDir;
     late String tempManifestPath;
 
@@ -84,8 +87,8 @@ crate-type = ["staticlib"]
   });
 
   group('ToolchainTomlParser', () {
-    const tomlDocumentFactory = TomlDocumentWrapperFactory(null);
-    const parser = ToolchainTomlParser(null, tomlDocumentFactory);
+    final tomlDocumentFactory = TomlDocumentWrapperFactory(logger);
+    final parser = ToolchainTomlParser(logger, tomlDocumentFactory);
     late Directory tempDir;
     late String tempToolchainTomlPath;