fix: add all build dependencies to the output for rebuilds (#44)

Fixes #43

Author: GregoryConrad

native_toolchain_rust/lib/native_toolchain_rust.dart

@@ -8,6 +8,7 @@ import 'package:native_toolchain_rust/src/build_environment.dart';
 import 'package:native_toolchain_rust/src/build_runner.dart';
 import 'package:native_toolchain_rust/src/crate_info_validator.dart';
 import 'package:native_toolchain_rust/src/crate_resolver.dart';
+import 'package:native_toolchain_rust/src/dependency_discoverer.dart';
 import 'package:native_toolchain_rust/src/process_runner.dart';
 import 'package:native_toolchain_rust/src/toml_parsing.dart';
 
@@ -108,6 +109,7 @@ final class RustBuilder implements Builder {
       toolchainTomlParser: toolchainTomlParser,
       cargoManifestParser: cargoManifestParser,
     );
+    final dependencyDiscoverer = DependencyDiscoverer(logger);
 
     return RustBuildRunner(
       config: this,
@@ -116,6 +118,7 @@ final class RustBuilder implements Builder {
       crateDirectoryResolver: crateDirectoryResolver,
       buildEnvironmentFactory: buildEnvironmentFactory,
       crateInfoValidator: crateInfoValidator,
+      dependencyDiscoverer: dependencyDiscoverer,
     ).run(input: input, output: output, assetRouting: assetRouting);
   }
 }

native_toolchain_rust/lib/src/build_runner.dart

@@ -9,6 +9,7 @@ import 'package:native_toolchain_rust/src/build_environment.dart';
 import 'package:native_toolchain_rust/src/config_mapping.dart';
 import 'package:native_toolchain_rust/src/crate_info_validator.dart';
 import 'package:native_toolchain_rust/src/crate_resolver.dart';
+import 'package:native_toolchain_rust/src/dependency_discoverer.dart';
 import 'package:native_toolchain_rust/src/process_runner.dart';
 import 'package:path/path.dart' as path;
 
@@ -21,6 +22,7 @@ interface class RustBuildRunner {
     required this.processRunner,
     required this.buildEnvironmentFactory,
     required this.crateInfoValidator,
+    required this.dependencyDiscoverer,
   });
 
   final RustBuilder config;
@@ -29,6 +31,7 @@ interface class RustBuildRunner {
   final ProcessRunner processRunner;
   final BuildEnvironmentFactory buildEnvironmentFactory;
   final CrateInfoValidator crateInfoValidator;
+  final DependencyDiscoverer dependencyDiscoverer;
 
   Future<void> run({
     required BuildInput input,
@@ -75,9 +78,6 @@ interface class RustBuildRunner {
       toolchainTomlPath: path.join(crateDirectory.path, 'rust-toolchain.toml'),
     );
 
-    // NOTE: re-run build whenever anything in the Rust directory changes
-    output.dependencies.add(crateDirectory.uri);
-
     logger.info('Ensuring $toolchainChannel is installed');
     await ensureToolchainDownloaded(crateDirectory.path);
 
@@ -107,22 +107,25 @@ interface class RustBuildRunner {
       },
     );
 
+    final binaryFilePath = path.join(
+      outputDir,
+      targetTriple,
+      cargoBuildMode,
+      targetOS.libraryFileName(crateName, linkMode).replaceAll('-', '_'),
+    );
+
+    // NOTE: re-run build whenever any of the dependencies change
+    output.dependencies.addAll(
+      dependencyDiscoverer.discover(path.setExtension(binaryFilePath, '.d')),
+    );
+
     for (final routing in assetRouting) {
       output.assets.code.add(
         CodeAsset(
           package: input.packageName,
           name: assetName,
           linkMode: linkMode,
-          file: path.toUri(
-            path.join(
-              outputDir,
-              targetTriple,
-              cargoBuildMode,
-              targetOS
-                  .libraryFileName(crateName, linkMode)
-                  .replaceAll('-', '_'),
-            ),
-          ),
+          file: path.toUri(binaryFilePath),
         ),
         routing: routing,
       );

native_toolchain_rust/lib/src/dependency_discoverer.dart

@@ -0,0 +1,29 @@
+import 'dart:io';
+
+import 'package:logging/logging.dart';
+import 'package:meta/meta.dart';
+import 'package:path/path.dart' as path;
+
+@internal
+interface class DependencyDiscoverer {
+  const DependencyDiscoverer(this.logger);
+
+  final Logger logger;
+
+  /// Finds all the dependencies from the specified dependency file,
+  /// including the dependency file itself.
+  Iterable<Uri> discover(String dependencyFilePath) {
+    logger.fine('Discovering dependencies in $dependencyFilePath');
+    return File(dependencyFilePath)
+        .readAsLinesSync()
+        .map((line) {
+          final splitIndex = line.indexOf(':');
+          if (splitIndex < 0) return null;
+          return line.substring(splitIndex + 1).trim();
+        })
+        .nonNulls
+        .expand((files) => files.split(' '))
+        .followedBy([dependencyFilePath])
+        .map(path.toUri);
+  }
+}

native_toolchain_rust/test/dependency_discoverer_test.dart

@@ -0,0 +1,104 @@
+import 'dart:io';
+
+import 'package:logging/logging.dart';
+import 'package:native_toolchain_rust/src/dependency_discoverer.dart';
+import 'package:path/path.dart' as path;
+import 'package:test/test.dart';
+
+void main() {
+  group('DependencyDiscoverer', () {
+    late DependencyDiscoverer dependencyDiscoverer;
+    late Directory tempDir;
+
+    setUp(() {
+      tempDir = Directory.systemTemp.createTempSync();
+      dependencyDiscoverer = DependencyDiscoverer(Logger.detached(''));
+    });
+
+    tearDown(() {
+      tempDir.deleteSync(recursive: true);
+    });
+
+    test('discover returns dependencies from a valid dependency file', () {
+      final dependencyFilePath = path.join(tempDir.path, 'test.d');
+      File(dependencyFilePath).writeAsStringSync(
+        'target/debug/librust_lib.a: src/lib.rs /path/to/some/other/file.rs',
+      );
+
+      final dependencies = dependencyDiscoverer.discover(dependencyFilePath);
+
+      expect(
+        dependencies,
+        containsAll([
+          path.toUri('src/lib.rs'),
+          path.toUri('/path/to/some/other/file.rs'),
+          path.toUri(dependencyFilePath),
+        ]),
+      );
+    });
+
+    test('discover handles multiple lines in the dependency file', () {
+      final dependencyFilePath = path.join(tempDir.path, 'test.d');
+      File(dependencyFilePath).writeAsStringSync('''
+target/debug/librust_lib.a: src/lib.rs
+target/debug/librust_lib.a: /path/to/some/other/file.rs
+''');
+
+      final dependencies = dependencyDiscoverer.discover(dependencyFilePath);
+
+      expect(
+        dependencies,
+        containsAll([
+          path.toUri('src/lib.rs'),
+          path.toUri('/path/to/some/other/file.rs'),
+          path.toUri(dependencyFilePath),
+        ]),
+      );
+    });
+
+    test('discover ignores lines without a colon', () {
+      final dependencyFilePath = path.join(tempDir.path, 'test.d');
+      File(dependencyFilePath).writeAsStringSync('''
+invalid line
+target/debug/librust_lib.a: src/lib.rs
+''');
+
+      final dependencies = dependencyDiscoverer.discover(dependencyFilePath);
+
+      expect(
+        dependencies,
+        containsAll([
+          path.toUri('src/lib.rs'),
+          path.toUri(dependencyFilePath),
+        ]),
+      );
+      expect(dependencies.length, 2);
+    });
+
+    test('discover handles an empty dependency file', () {
+      final dependencyFilePath = path.join(tempDir.path, 'test.d');
+      File(dependencyFilePath).writeAsStringSync('');
+
+      final dependencies = dependencyDiscoverer.discover(dependencyFilePath);
+
+      expect(
+        dependencies,
+        containsAll([
+          path.toUri(dependencyFilePath),
+        ]),
+      );
+      expect(dependencies.length, 1);
+    });
+
+    test(
+      'discover throws an exception if the dependency file is not found',
+      () {
+        final dependencyFilePath = path.join(tempDir.path, 'non_existent.d');
+        expect(
+          () => dependencyDiscoverer.discover(dependencyFilePath),
+          throwsA(isA<PathNotFoundException>()),
+        );
+      },
+    );
+  });
+}

pubspec.lock

@@ -5,18 +5,18 @@ packages:
     dependency: transitive
     description:
       name: _fe_analyzer_shared
-      sha256: c209688d9f5a5f26b2fb47a188131a6fb9e876ae9e47af3737c0b4f58a93470d
+      sha256: "5b7468c326d2f8a4f630056404ca0d291ade42918f4a3c6233618e724f39da8e"
       url: "https://pub.dev"
     source: hosted
-    version: "91.0.0"
+    version: "92.0.0"
   analyzer:
     dependency: transitive
     description:
       name: analyzer
-      sha256: f51c8499b35f9b26820cfe914828a6a98a94efd5cc78b37bb7d03debae3a1d08
+      sha256: "70e4b1ef8003c64793a9e268a551a82869a8a96f39deb73dea28084b0e8bf75e"
       url: "https://pub.dev"
     source: hosted
-    version: "8.4.1"
+    version: "9.0.0"
   ansi_styles:
     dependency: transitive
     description:
@@ -157,10 +157,10 @@ packages:
     dependency: transitive
     description:
       name: dart_style
-      sha256: c87dfe3d56f183ffe9106a18aebc6db431fc7c98c31a54b952a77f3d54a85697
+      sha256: a9c30492da18ff84efe2422ba2d319a89942d93e58eb0b73d32abe822ef54b7b
       url: "https://pub.dev"
     source: hosted
-    version: "3.1.2"
+    version: "3.1.3"
   fake_async:
     dependency: transitive
     description:
@@ -181,10 +181,10 @@ packages:
     dependency: transitive
     description:
       name: ffigen
-      sha256: "5c792e87491e762b64c225c295563534e37df68b4d4ccbf2f6b928d264285a73"
+      sha256: b7803707faeec4ce3c1b0c2274906504b796e3b70ad573577e72333bd1c9b3ba
       url: "https://pub.dev"
     source: hosted
-    version: "20.1.0"
+    version: "20.1.1"
   file:
     dependency: transitive
     description:
@@ -282,14 +282,6 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.0.5"
-  js:
-    dependency: transitive
-    description:
-      name: js
-      sha256: "53385261521cc4a0c4658fd0ad07a7d14591cf8fc33abbceae306ddb974888dc"
-      url: "https://pub.dev"
-    source: hosted
-    version: "0.7.2"
   json_annotation:
     dependency: transitive
     description:
@@ -334,18 +326,18 @@ packages:
     dependency: transitive
     description:
       name: matcher
-      sha256: dc58c723c3c24bf8d3e2d3ad3f2f9d7bd9cf43ec6feaa64181775e60190153f2
+      sha256: "12956d0ad8390bbcc63ca2e1469c0619946ccb52809807067a7020d57e647aa6"
       url: "https://pub.dev"
     source: hosted
-    version: "0.12.17"
+    version: "0.12.18"
   material_color_utilities:
     dependency: transitive
     description:
       name: material_color_utilities
-      sha256: f7142bb1154231d7ea5f96bc7bde4bda2a0945d2806bb11670e30b850d56bdec
+      sha256: "9c337007e82b1889149c82ed242ed1cb24a66044e30979c44912381e9be4c48b"
       url: "https://pub.dev"
     source: hosted
-    version: "0.11.1"
+    version: "0.13.0"
   melos:
     dependency: "direct dev"
     description:
@@ -587,26 +579,26 @@ packages:
     dependency: transitive
     description:
       name: test
-      sha256: "75906bf273541b676716d1ca7627a17e4c4070a3a16272b7a3dc7da3b9f3f6b7"
+      sha256: "77cc98ea27006c84e71a7356cf3daf9ddbde2d91d84f77dbfe64cf0e4d9611ae"
       url: "https://pub.dev"
     source: hosted
-    version: "1.26.3"
+    version: "1.28.0"
   test_api:
     dependency: transitive
     description:
       name: test_api
-      sha256: ab2726c1a94d3176a45960b6234466ec367179b87dd74f1611adb1f3b5fb9d55
+      sha256: "19a78f63e83d3a61f00826d09bc2f60e191bf3504183c001262be6ac75589fb8"
       url: "https://pub.dev"
     source: hosted
-    version: "0.7.7"
+    version: "0.7.8"
   test_core:
     dependency: transitive
     description:
       name: test_core
-      sha256: "0cc24b5ff94b38d2ae73e1eb43cc302b77964fbf67abad1e296025b78deb53d0"
+      sha256: f1072617a6657e5fc09662e721307f7fb009b4ed89b19f47175d11d5254a62d4
       url: "https://pub.dev"
     source: hosted
-    version: "0.6.12"
+    version: "0.6.14"
   toml:
     dependency: transitive
     description:
@@ -715,10 +707,10 @@ packages:
     dependency: transitive
     description:
       name: yaml_edit
-      sha256: fb38626579fb345ad00e674e2af3a5c9b0cc4b9bfb8fd7f7ff322c7c9e62aef5
+      sha256: ec709065bb2c911b336853b67f3732dd13e0336bd065cc2f1061d7610ddf45e3
       url: "https://pub.dev"
     source: hosted
-    version: "2.2.2"
+    version: "2.2.3"
 sdks:
   dart: ">=3.9.0 <4.0.0"
   flutter: ">=3.18.0-18.0.pre.54"