[native_assets_builder] Fix old build hooks (#1148)

Author: dcharkes

.github/workflows/native.yaml

@@ -68,6 +68,9 @@ jobs:
       - run: dart pub get -C test_data/native_add/
         if: ${{ matrix.package == 'native_assets_builder' }}
 
+      - run: dart pub get -C test_data/native_add_v1_0_0/
+        if: ${{ matrix.package == 'native_assets_builder' }}
+
       - run: dart pub get -C test_data/native_add_add_source/
         if: ${{ matrix.package == 'native_assets_builder' }}
 

pkgs/native_assets_builder/lib/src/build_runner/build_runner.dart

@@ -410,9 +410,12 @@ ${result.stdout}
     }
 
     try {
-      final buildOutput =
-          HookOutputImpl.readFromFile(file: config.outputFile) ??
-              HookOutputImpl();
+      final buildOutput = HookOutputImpl.readFromFile(
+              file: config.outputFile) ??
+          (config.outputFileV1_1_0 == null
+              ? null
+              : HookOutputImpl.readFromFile(file: config.outputFileV1_1_0!)) ??
+          HookOutputImpl();
       //As a link.dart can pipe through assets from other packages.
       if (hook == Hook.build) {
         success &= validateAssetsPackage(

pkgs/native_assets_builder/test/build_runner/v1_0_0_test.dart

@@ -0,0 +1,34 @@
+// Copyright (c) 2023, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'package:test/test.dart';
+
+import '../helpers.dart';
+import 'helpers.dart';
+
+const Timeout longTimeout = Timeout(Duration(minutes: 5));
+
+void main() async {
+  test('native_add build', timeout: longTimeout, () async {
+    await inTempDir((tempUri) async {
+      await copyTestProjects(targetUri: tempUri);
+      final packageUri = tempUri.resolve('native_add_v1_0_0/');
+
+      // First, run `pub get`, we need pub to resolve our dependencies.
+      await runPubGet(
+        workingDirectory: packageUri,
+        logger: logger,
+      );
+
+      {
+        final result = await build(
+          packageUri,
+          logger,
+          dartExecutable,
+        );
+        expect(result.assets.length, 1);
+      }
+    });
+  });
+}

pkgs/native_assets_builder/test_data/manifest.yaml

@@ -6,6 +6,14 @@
 - cyclic_package_2/pubspec.yaml
 - dart_app/bin/dart_app.dart
 - dart_app/pubspec.yaml
+- native_add_v1_0_0/build.dart
+- native_add_v1_0_0/ffigen.yaml
+- native_add_v1_0_0/lib/native_add.dart
+- native_add_v1_0_0/lib/src/native_add_bindings_generated.dart
+- native_add_v1_0_0/lib/src/native_add.dart
+- native_add_v1_0_0/pubspec.yaml
+- native_add_v1_0_0/src/native_add.c
+- native_add_v1_0_0/src/native_add.h
 - native_add/ffigen.yaml
 - native_add/hook/build.dart
 - native_add/lib/native_add.dart
@@ -76,4 +84,4 @@
 - add_asset_link/lib/src/add_asset_link_bindings.dart
 - add_asset_link/src/native_add.h
 - add_asset_link/src/native_add.c
-- add_asset_link/hook/build.dart
+- add_asset_link/hook/build.dart

pkgs/native_assets_builder/test_data/native_add_v1_0_0/build.dart

@@ -0,0 +1,32 @@
+// Copyright (c) 2023, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'package:logging/logging.dart';
+import 'package:native_assets_cli/native_assets_cli.dart';
+import 'package:native_toolchain_c/native_toolchain_c.dart';
+
+const packageName = 'native_add';
+
+void main(List<String> arguments) async {
+  final config = await BuildConfig.fromArgs(arguments);
+  final output = BuildOutput();
+  final cbuilder = CBuilder.library(
+    name: packageName,
+    assetId: 'package/$packageName:src/${packageName}_bindings_generated.dart',
+    sources: [
+      'src/$packageName.c',
+    ],
+    dartBuildFiles: ['build.dart'],
+  );
+  await cbuilder.run(
+    buildConfig: config,
+    buildOutput: output,
+    logger: Logger('')
+      ..level = Level.ALL
+      ..onRecord.listen((record) {
+        print('${record.level.name}: ${record.time}: ${record.message}');
+      }),
+  );
+  await output.writeToFile(outDir: config.outDir);
+}

pkgs/native_assets_builder/test_data/native_add_v1_0_0/ffigen.yaml

@@ -0,0 +1,20 @@
+# Run with `flutter pub run ffigen --config ffigen.yaml`.
+name: NativeAddBindings
+description: |
+  Bindings for `src/native_add.h`.
+
+  Regenerate bindings with `flutter pub run ffigen --config ffigen.yaml`.
+output: "lib/src/native_add_bindings_generated.dart"
+headers:
+  entry-points:
+    - "src/native_add.h"
+  include-directives:
+    - "src/native_add.h"
+preamble: |
+  // Copyright (c) 2023, the Dart project authors.  Please see the AUTHORS file
+  // for details. All rights reserved. Use of this source code is governed by a
+  // BSD-style license that can be found in the LICENSE file.
+comments:
+  style: any
+  length: full
+ffi-native:

pkgs/native_assets_builder/test_data/native_add_v1_0_0/lib/native_add.dart

@@ -0,0 +1,5 @@
+// Copyright (c) 2023, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+export 'src/native_add.dart';

pkgs/native_assets_builder/test_data/native_add_v1_0_0/lib/src/native_add.dart

@@ -0,0 +1,7 @@
+// Copyright (c) 2023, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'native_add_bindings_generated.dart' as bindings;
+
+int add(int a, int b) => bindings.add(a, b);

pkgs/native_assets_builder/test_data/native_add_v1_0_0/lib/src/native_add_bindings_generated.dart

@@ -0,0 +1,15 @@
+// Copyright (c) 2023, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+// AUTO GENERATED FILE, DO NOT EDIT.
+//
+// Generated by `package:ffigen`.
+// ignore_for_file: type=lint
+import 'dart:ffi' as ffi;
+
+@ffi.Native<ffi.Int32 Function(ffi.Int32, ffi.Int32)>(symbol: 'add')
+external int add(
+  int a,
+  int b,
+);

pkgs/native_assets_builder/test_data/native_add_v1_0_0/manifest.yaml

@@ -0,0 +1,8 @@
+- build.dart
+- ffigen.yaml
+- lib/native_add.dart
+- lib/src/native_add_bindings_generated.dart
+- lib/src/native_add.dart
+- pubspec.yaml
+- src/native_add.c
+- src/native_add.h

pkgs/native_assets_builder/test_data/native_add_v1_0_0/pubspec.yaml

@@ -0,0 +1,20 @@
+name: native_add_v1_0_0
+description: Sums two numbers with native code. Uses an old version of the protocol
+version: 0.1.0
+
+publish_to: none
+
+environment:
+  sdk: '>=3.3.0 <4.0.0'
+
+dependencies:
+  logging: ^1.1.1
+  native_assets_cli: ^0.3.0
+  native_toolchain_c: ^0.3.0
+
+dev_dependencies:
+  ffigen: ^8.0.2
+  lints: ^3.0.0
+  some_dev_dep:
+    path: ../some_dev_dep/
+  test: ^1.23.1

pkgs/native_assets_builder/test_data/native_add_v1_0_0/src/native_add.c

@@ -0,0 +1,9 @@
+// Copyright (c) 2023, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+#include "native_add.h"
+
+int32_t add(int32_t a, int32_t b) {
+   return a + b;
+}

pkgs/native_assets_builder/test_data/native_add_v1_0_0/src/native_add.h

@@ -0,0 +1,13 @@
+// Copyright (c) 2023, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+#include <stdint.h>
+
+#if _WIN32
+#define MYLIB_EXPORT __declspec(dllexport)
+#else
+#define MYLIB_EXPORT
+#endif
+
+MYLIB_EXPORT int32_t add(int32_t a, int32_t b);

pkgs/native_assets_cli/lib/src/model/build_config.dart

@@ -21,7 +21,10 @@ final class BuildConfigImpl extends HookConfigImpl implements BuildConfig {
 
   @override
   String get outputName =>
-      version > Version(1, 1, 0) ? 'build_output.json' : 'build_output.yaml';
+      version > Version(1, 1, 0) ? 'build_output.json' : outputNameV1_1_0;
+
+  @override
+  String get outputNameV1_1_0 => 'build_output.yaml';
 
   @override
   Object? metadatum(String packageName, String key) {

pkgs/native_assets_cli/lib/src/model/build_output_CHANGELOG.md

@@ -10,6 +10,7 @@
   Backwards compatibility: JSON is parsable as YAML.
 - Changed filename from `build_output.yaml` to `build_output.json`.
   Backwards compatibility older SDKs: write to the old file name if an older BuildConfig was passed in.
+  Backwards compatibility: Try to read yaml file if json doesn't exist.
 
 ## 1.1.0
 

pkgs/native_assets_cli/lib/src/model/hook_config.dart

@@ -72,8 +72,17 @@ abstract class HookConfigImpl implements HookConfig {
   @override
   final OSImpl targetOS;
 
+  /// Output file name based on the protocol version.
+  ///
+  /// Makes newer build hooks work with older Dart SDKs.
   String get outputName;
 
+  /// Legacy output file name.
+  ///
+  /// Older build hooks output a yaml file, ignoring the newer protocol version
+  /// in the config.
+  String? get outputNameV1_1_0;
+
   HookConfigImpl({
     required this.hook,
     required this.outputDirectory,
@@ -115,6 +124,10 @@ abstract class HookConfigImpl implements HookConfig {
 
   Uri get outputFile => outputDirectory.resolve(outputName);
 
+  Uri? get outputFileV1_1_0 => outputNameV1_1_0 == null
+      ? null
+      : outputDirectory.resolve(outputNameV1_1_0!);
+
   // This is currently overriden by [BuildConfig], do account for older versions
   // still using a top-level build.dart.
   Uri get script => packageRoot.resolve('hook/').resolve(hook.scriptName);

pkgs/native_assets_cli/lib/src/model/hook_output.dart

@@ -160,7 +160,7 @@ final class HookOutputImpl implements BuildOutput, LinkOutput {
   /// passing the highest supported version of BuildOutput.
   static Version latestVersion = HookConfigImpl.latestVersion;
 
-  /// Writes the JSON file from [file].
+  /// Reads the JSON file from [file].
   static HookOutputImpl? readFromFile({required Uri file}) {
     final buildOutputFile = File.fromUri(file);
     if (buildOutputFile.existsSync()) {

pkgs/native_assets_cli/lib/src/model/link_config.dart

@@ -62,9 +62,13 @@ class LinkConfigImpl extends HookConfigImpl implements LinkConfig {
 
   @override
   Hook get hook => Hook.link;
+
   @override
   String get outputName => 'link_output.json';
 
+  @override
+  String? get outputNameV1_1_0 => null;
+
   @override
   Map<String, Object> toJson() => {
         ...hookToJson(),