Implements addFoundCodeAssets to find and add outputs by name. (#11)

* find_assets

* rename to add_assets

* comment data assets not available yet

* comment in example

* needs architecture

* update test names

* fix unix problem with addDirectories

* rename: `addLibraries -> addCodeAssets`, `addAssets -> addDataAssets`, use `patternMap` for `addCodeAssets`

* fix pattern for windows

* use string list for code asset name

* fix comments

* fix comment

* refactor to map library names to dart, removes data asset helpers

* update changelog

* cleanup data assets from cmake

* cleanup data assets from cmake tests

* support optional regexp matching

---------

Co-authored-by: rainyl <[email protected]>

Author: MichealReed

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - new: add `CMakeBuilder.fromGit` constructor to create a builder from a remote repository.
 - new: add `buildLocal` optional parameter to build out of `.dart_tool`.
+- new: add `AddFoundCodeAssets`, `BuildOutputBuilder.findAndAddCodeAssets` to find and add code assets.
 - breaking change: move android and `ios.toolchain.cmake` related args of `CMakeBuilder` to separate `AndroidBuilderArgs` and `AppleBuilderArgs`.
 
 ## 0.0.2

analysis_options.yaml

@@ -218,7 +218,6 @@ linter:
     - unnecessary_this
     - unnecessary_to_list_in_spreads
     - unrelated_type_equality_checks
-    - unsafe_html
     - use_build_context_synchronously
     - use_colored_box
     - use_decorated_box

example/add/hook/build.dart

@@ -1,3 +1,4 @@
+//  ignore_for_file: dead_code
 import 'dart:io';
 
 import 'package:add/src/hook_helpers/hook_helpers.dart';

example/add/lib/src/hook_helpers/hook_helpers.dart

@@ -11,6 +11,10 @@ Future<void> runBuild(
   BuildOutputBuilder output,
   Uri sourceDir,
 ) async {
+  final _logger = Logger('')
+    ..level = Level.ALL
+    // temp fwd to stderr until process logs pass to stdout
+    ..onRecord.listen((record) => stderr.writeln(record));
   final builder = CMakeBuilder.create(
     name: name,
     sourceDir: sourceDir,
@@ -22,32 +26,25 @@ Future<void> runBuild(
       'install',
     ],
     buildLocal: true,
-    logger: Logger('')
-      ..level = Level.ALL
-      // temp fwd to stderr until process logs pass to stdout
-      ..onRecord.listen((record) => stderr.writeln(record)),
+    logger: _logger,
   );
 
-  await builder.run(input: input, output: output);
+  await builder.run(input: input, output: output, logger: _logger);
 
-  final libPath = switch (input.config.code.targetOS) {
-    OS.linux => "install/lib/libadd.so",
-    OS.macOS => "install/lib/libadd.dylib",
-    OS.windows => "install/lib/add.dll",
-    OS.android => "install/lib/libadd.so",
-    OS.iOS => "install/lib/libadd.dylib",
-    _ => throw UnsupportedError("Unsupported OS")
-  };
-  output.assets.code.add(
-    CodeAsset(
-      package: name,
-      name: '$name.dart',
-      linkMode: DynamicLoadingBundled(),
-      os: input.config.code.targetOS,
-      file: input.outputDirectory.resolve(libPath),
-      architecture: input.config.code.targetArchitecture,
-    ),
+  final buildjson = input.config.json;
+  _logger.info('Build output: $buildjson');
+
+  // automatically search and add libraries
+  final outLibs = await output.findAndAddCodeAssets(
+    input,
+    names: {r'(lib)?add\.(dll|so|dylib)': 'add.dart'},
+    outDir: input.outputDirectory.resolve('install'),
+    logger: _logger,
+    regExp: true,
   );
+
+  // Do something else with outLibs uris
+  _logger.info('Found libs: $outLibs');
 }
 
 Future<void> runBuildGit(
@@ -80,6 +77,7 @@ Future<void> runBuildGit(
     logger: logger,
   );
 
+  // manually add assets
   final libPath = switch (input.config.code.targetOS) {
     OS.linux => "install/lib/libadd.so",
     OS.macOS => "install/lib/libadd.dylib",

lib/native_toolchain_cmake.dart

@@ -9,5 +9,6 @@ export 'src/builder/builder.dart' show CMakeBuilder;
 export 'src/builder/builder_args.dart';
 export 'src/builder/generator.dart';
 export 'src/builder/log_level.dart';
+export 'src/utils/add_assets.dart';
 export 'src/utils/env_from_bat.dart';
 export 'src/utils/package_config_parser.dart';

lib/src/utils/add_assets.dart

@@ -0,0 +1,112 @@
+// ignore_for_file: comment_references
+import 'dart:io';
+
+import 'package:logging/logging.dart';
+import 'package:native_assets_cli/code_assets_builder.dart';
+import 'package:path/path.dart' as p;
+
+import '../builder/linkmode.dart';
+
+/// Searches recursively through the provided [outDir] (or [input.outputDirectory]
+/// if not provided) for native library files that match the given [names]
+/// and adds them to [output.assets.code].
+///
+/// [names] are used to map a found library file to package URI.
+/// e.g., for `foo_windows_x64.dll` -> `package:my_pkg/native_foo.dart`,
+/// should provide `{'foo_windows_x64': 'native_foo.dart'}`.
+///
+/// If [regExp] is true, keys in [names] are treated as regular expression patterns to match library filenames.
+/// Use regExp if the built libraries are something like `libadd-1.dll`.
+/// e.g.,
+/// ```dart
+/// {r'(lib)?add-\d\.(dll|so|dylib)': 'native_foo.dart'}.
+/// ```
+///
+/// The expected filename is computed using the current operating system's naming conventions
+/// combined with a concrete [LinkMode] derived from [input.config.code.linkModePreference].
+/// For each file that ends with the computed library filename for one of the provided [names],
+/// a [CodeAsset] is created and added to [output.assets.code] if it hasn't already been added.
+///
+/// Duplicate assets are avoided by tracking previously added file paths internally
+/// as [output.assets] is not iterable.
+///
+/// Returns a list of URIs corresponding to all the added code assets.
+///
+/// Example:
+/// ```dart
+/// final foundUris = await addCodeAssets(
+///   input,
+///   output,
+///   outDir: myOutputUri,
+///   names: {'add': 'add.dart'},
+/// );
+/// ```
+///
+/// ```dart
+/// final foundUris = await addCodeAssets(
+///   input,
+///   output,
+///   outDir: myOutputUri,
+///   names: { r'(lib)?add\.(dll|so|dylib)': 'add.dart' },
+///   regExp=true,
+/// );
+/// ```
+Future<List<Uri>> addFoundCodeAssets(
+  BuildInput input,
+  BuildOutputBuilder output, {
+  required Map<String, String> names, // key: search library name, value: dart ffi name
+  Uri? outDir,
+  Logger? logger,
+  bool regExp = false,
+}) async {
+  final preferredMode = input.config.code.linkModePreference;
+  final searchDir = Directory.fromUri(outDir ?? input.outputDirectory);
+  final linkMode = getLinkMode(preferredMode);
+  final List<Uri> foundFiles = [];
+
+  logger?.info('Searching for libraries in ${searchDir.path}');
+  logger?.info('Preferred link mode: $preferredMode');
+
+  await for (final entity in searchDir.list(recursive: true, followLinks: false)) {
+    if (entity is! File) continue;
+    for (final MapEntry(:key, value: name) in names.entries) {
+      // even on windows, library name may be `libadd.dll` instead of `add.dll` sometimes,
+      // e.g., when using mingw64, so allow using RegExp matching if regExp=true.
+      final found = regExp
+          ? RegExp(key).hasMatch(p.basename(entity.path))
+          : entity.path.endsWith(OS.current.libraryFileName(key, linkMode));
+      if (!found) continue;
+      logger?.info('Found library file: ${entity.path}');
+      output.addCodeAsset(
+        CodeAsset(
+          package: input.packageName,
+          name: name,
+          linkMode: linkMode,
+          os: input.config.code.targetOS,
+          file: entity.uri,
+          architecture: input.config.code.targetArchitecture,
+        ),
+      );
+      foundFiles.add(entity.uri);
+      break; // only add one file per name
+    }
+  }
+  return foundFiles;
+}
+
+extension BuildOutputBuilderCodeAssets on BuildOutputBuilder {
+  /// short for [assets.code.add]
+  void addCodeAsset(CodeAsset codeAsset) {
+    assets.code.add(codeAsset);
+  }
+
+  /// extension method for [addFoundCodeAssets]
+  Future<List<Uri>> findAndAddCodeAssets(
+    BuildInput input, {
+    required Map<String, String> names,
+    Uri? outDir,
+    Logger? logger,
+    bool regExp = false,
+  }) async =>
+      addFoundCodeAssets(input, this, names: names, outDir: outDir, logger: logger, regExp: regExp);
+}

pubspec.yaml

@@ -19,6 +19,7 @@ dependencies:
   logging: ^1.1.1
   meta: ^1.9.1
   native_assets_cli: ^0.11.0
+  path: ^1.9.1
   pub_semver: ^2.1.3
 
 dev_dependencies:

test/utils/add_assets_test.dart

@@ -0,0 +1,80 @@
+import 'dart:io';
+
+import 'package:logging/logging.dart';
+import 'package:native_toolchain_cmake/native_toolchain_cmake.dart';
+import 'package:native_toolchain_cmake/src/utils/add_assets.dart';
+import 'package:test/test.dart';
+
+import '../helpers.dart';
+
+void main() {
+  final logger = Logger('AddAssetsTest');
+
+  group('addLibraries', () {
+    test('finds and adds library files matching expected names', () async {
+      // Create temporary directories as URIs.
+      final baseDir = await tempDirForTest();
+      final sharedDir = await tempDirForTest();
+
+      // Create a "lib" subdirectory.
+      final libDir = Directory.fromUri(baseDir.resolve('lib'));
+      await libDir.create();
+
+      // Based on the current OS, create a dummy dynamic library file for the "add" project.
+      final libFileName = OS.current.dylibFileName('add'); // e.g. add.dll, libadd.so, or add.dylib.
+      final libFile = File.fromUri(baseDir.resolve('lib').resolve(libFileName));
+      await libFile.writeAsString('dummy library content');
+
+      final buildInputBuilder = BuildInputBuilder()
+        ..setupShared(
+          packageName: 'add',
+          packageRoot: baseDir,
+          outputFile: baseDir.resolve('output.json'),
+          outputDirectory: baseDir,
+          outputDirectoryShared: sharedDir,
+        )
+        ..config.setupBuild(linkingEnabled: true, dryRun: false)
+        ..config.setupShared(buildAssetTypes: [CodeAsset.type])
+        ..config.setupCode(
+          targetOS: OS.current,
+          linkModePreference: LinkModePreference.dynamic,
+          targetArchitecture: Architecture.current,
+        );
+
+      final buildInput = BuildInput(buildInputBuilder.json);
+      final buildOutput = BuildOutputBuilder();
+
+      {
+        // Call addLibraries with the provided dynamic library names.
+        final found = await addFoundCodeAssets(
+          buildInput,
+          buildOutput,
+          outDir: baseDir,
+          names: {'add': 'add.dart'},
+          logger: logger,
+        );
+
+        // Validate that one library file was found.
+        expect(found.length, equals(1));
+        // The file should reside in a "lib" subdirectory.
+        expect(found.first.toFilePath(), equals(libFile.absolute.path));
+      }
+
+      {
+        // Call addLibraries with the provided dynamic library names.
+        final found = await buildOutput.findAndAddCodeAssets(
+          buildInput,
+          outDir: baseDir,
+          names: {r'(lib)?add\.(dll|so|dylib)': 'add.dart'},
+          logger: logger,
+          regExp: true,
+        );
+
+        // Validate that one library file was found.
+        expect(found.length, equals(1));
+        // The file should reside in a "lib" subdirectory.
+        expect(found.first.toFilePath(), equals(libFile.absolute.path));
+      }
+    });
+  });
+}