[hooks] Run link hooks in order #2417

mosuem · 2025-07-16T10:55:24Z

This brings an order in which the link hooks are run - reverse to the build hook run order. This starts at the application link hook, then it's dependencies, and so on.
This enables us to pass information from on link hook to another as MetadataAssets - but also means that now link hooks must be invoked, regardless of whether assets are sent to the from a build hook.

Seems to work: https://dart-review.googlesource.com/c/sdk/+/441201

I’ve reviewed the contributor guide and applied the relevant portions to this PR.

Contribution guidelines:

See our contributor guide for general expectations for PRs.
Larger or significant changes should be discussed in an issue before creating a PR.
Contributions to our repos should follow the Dart style guide and use dart format.
Most changes should add an entry to the changelog and may need to rev the pubspec package version.
Changes to packages require corresponding tests.

Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.

github-actions · 2025-07-16T10:57:53Z

PR Health

Breaking changes

⚠️

Package	Change	Current Version	New Version	Needed Version	Looking good?
code_assets	Breaking	0.19.4	0.19.4-wip	0.20.0 Got "0.19.4-wip" expected >= "0.20.0" (breaking changes)	⚠️
data_assets	Breaking	0.19.1	0.19.2-wip	0.20.0 Got "0.19.2-wip" expected >= "0.20.0" (breaking changes)	⚠️
hooks	Breaking	0.19.5	0.20.0-wip	0.20.0	✔️
hooks_runner	Breaking	0.21.0	0.22.0-wip	0.22.0	✔️
native_toolchain_c	Breaking	0.17.0	0.18.0-wip	0.18.0	✔️

This check can be disabled by tagging the PR with skip-breaking-check.

Changelog Entry ✔️

Package	Changed Files

Changes to files need to be accounted for in their respective changelogs.

API leaks ✔️

The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.

Package	Leaked API symbols

License Headers ✔️

// Copyright (c) 2025, 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.

Files
no missing headers

All source files should start with a license header.

Unrelated files missing license headers

Files
pkgs/jni/lib/src/third_party/generated_bindings.dart
pkgs/native_doc_dartifier/lib/native_doc_dartifier.dart
pkgs/native_doc_dartifier/lib/src/native_doc_dartifier_base.dart
pkgs/objective_c/lib/src/ns_input_stream.dart

pkgs/hooks/lib/hooks.dart

coveralls · 2025-07-17T12:37:35Z

coverage: 82.27% (-2.3%) from 84.56%
when pulling a03078b on runLinkHooksInOrder
into 68ddbca on main.

pkgs/hooks/doc/schema/shared/shared_definitions.schema.json

github-actions · 2025-07-18T12:33:23Z

Package publishing

Package	Version	Status	Publish tag (post-merge)
package:code_assets	0.20.0	ready to publish	`code_assets-v0.20.0`
package:data_assets	0.20.0	ready to publish	`data_assets-v0.20.0`
package:ffi	2.1.5-wip	WIP (no publish necessary)
package:hooks	0.20.0	ready to publish	`hooks-v0.20.0`
package:hooks_runner	0.22.0	ready to publish	`hooks_runner-v0.22.0`
package:native_doc_dartifier	0.0.1-pre	already published at pub.dev
package:native_toolchain_c	0.18.0	ready to publish	`native_toolchain_c-v0.18.0`
package:swift2objc	0.0.1-wip	WIP (no publish necessary)
package:swiftgen	0.0.1-wip	WIP (no publish necessary)

Documentation at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation.

dcharkes

General approach LGTM. I left a bunch of detailed comments.

pkgs/code_assets/test/code_assets/config_test.dart

pkgs/data_assets/CHANGELOG.md

pkgs/hooks/CHANGELOG.md

pkgs/code_assets/CHANGELOG.md

pkgs/hooks/doc/schema/shared/shared_definitions.schema.json

pkgs/hooks_runner/test/build_runner/link_test.dart

pkgs/hooks_runner/lib/src/build_runner/build_planner.dart

pkgs/hooks_runner/lib/src/build_runner/build_runner.dart

pkgs/hooks_runner/test_data/flag_app/lib/flag_app.dart

pkgs/code_assets/lib/src/code_assets/config.dart

pkgs/code_assets/test/code_assets/config_test.dart

pkgs/data_assets/lib/src/data_assets/config.dart

goderbauer · 2025-07-24T12:11:37Z

pkgs/data_assets/pubspec.yaml

Should there be new tests in this package to cover the new functionality?

This should be covered by the added test at pkgs/hooks_runner/test/build_runner/link_test.dart

We have coverage on the CI, but it doesn't collect coverage for the test
projects being run because those are separate dart process invocations. It might
be worth trying to see if we can get code coverage from those.

pkgs/code_assets/CHANGELOG.md

pkgs/hooks_runner/test_data/fun_with_flags/lib/src/fun_with_flags_base.dart

pkgs/hooks_runner/test_data/flag_enthusiast_2/lib/src/flag_enthusiast_2_base.dart

pkgs/hooks_runner/test/build_runner/link_test.dart

goderbauer · 2025-07-24T13:13:36Z

pkgs/hooks/lib/src/config.dart

  }) {
    _syntax.setup(
      assets: [
        for (final asset in assets) AssetSyntax.fromJson(asset.toJson()),
      ],
+      assetsFromLinking: [
+        for (final asset in assetsFromLinking)
+          AssetSyntax.fromJson(asset.toJson()),


I see that we are doing this above as well, but it seems strange that we are converting something to json only to decode it from json again...

I would assume this is from the input/output json files.

Don't assume, verify. (Git blame is your friend.)

As for the JSON ecoding

EncodedAsset is an extension point, so the encoding field is not decoded
by package:hooks but by package:code_assets for example.

Before [native_assets_cli] Cleanup JSON: old asset encoding #2220, the encoding could be in
two places, but not anymore. So this can be cleaned up.
[hooks] Cleanup encoded assets encoding #2454

We still need to copy the map on toJson/fromJson due to EncodedAsset
overriding hashCode and equals. ([native_assets_cli] Prevent EncodedAsset and Metadata hashcode changing #2131)

pkgs/hooks_runner/lib/src/build_runner/build_planner.dart

dcharkes

We need to cover the unhappy paths with tests as well.

cyclic dependencies with link hooks (and only one build hook, so no cycles for the build hooks)
outputting an asset for a link hook not directly in the dependencies, that should not be visible. (Actually we should probably make that an error, but it looks like pkgs/hooks/lib/src/validation.dart does not throw an error on that right now.)

pkgs/hooks_runner/test_data/manifest.yaml

pkgs/hooks_runner/test_data/fun_with_flags/hook/link.dart

dcharkes · 2025-07-28T08:02:27Z

pkgs/hooks/lib/src/config.dart

  }) {
    _syntax.setup(
      assets: [
        for (final asset in assets) AssetSyntax.fromJson(asset.toJson()),
      ],
+      assetsFromLinking: [
+        for (final asset in assetsFromLinking)
+          AssetSyntax.fromJson(asset.toJson()),


Don't assume, verify. (Git blame is your friend.)

As for the JSON ecoding

EncodedAsset is an extension point, so the encoding field is not decoded
by package:hooks but by package:code_assets for example.

Before [native_assets_cli] Cleanup JSON: old asset encoding #2220, the encoding could be in
two places, but not anymore. So this can be cleaned up.
[hooks] Cleanup encoded assets encoding #2454

We still need to copy the map on toJson/fromJson due to EncodedAsset
overriding hashCode and equals. ([native_assets_cli] Prevent EncodedAsset and Metadata hashcode changing #2131)

pkgs/hooks/lib/src/config.dart

pkgs/hooks_runner/lib/src/build_runner/build_planner.dart

pkgs/code_assets/lib/src/code_assets/validation.dart

pkgs/hooks/doc/schema/shared/shared_definitions.schema.json

pkgs/hooks_runner/lib/src/build_runner/build_runner.dart

mosuem · 2025-07-28T14:16:32Z

Changing assets to assetsFromBuilding is a rather large API change - are you sure that you want this? @dcharkes

dcharkes · 2025-07-28T14:19:57Z

Changing assets to assetsFromBuilding is a rather large API change - are you sure that you want this? @dcharkes

Because it's user-facing in the hooks as well?

Maybe skip it for now and keep the version -wip. We need to do another pass on the public API anyways.

mosuem · 2025-07-30T12:45:17Z

Friendly ping @dcharkes or @goderbauer :)

dcharkes · 2025-07-30T14:29:14Z

Friendly ping @dcharkes or @goderbauer :)

Friendly ping to address the previously unaddressed comment(s). Including the schema test.

mosuem · 2025-07-30T14:30:35Z

Is this not addressed? I did add the key to the test files. What else should be addressed?

dcharkes · 2025-07-30T14:43:29Z

Is this not addressed? I did add the key to the test files. What else should be addressed?

Already answered:

Also, the guard for assets_for_linking should not skip link output anymore.

I've pushed a commit with what the test should do. Some already pass due to the test data you added 👍 , but not all.

mosuem · 2025-07-30T15:05:15Z

Done!

dcharkes

LGTM from my side once the last small comments are addressed.

Thanks! 🙏

pkgs/hooks_runner/test_data/link_inverse_package/hook/link.dart

pkgs/code_assets/test/code_assets/config_test.dart

pkgs/code_assets/CHANGELOG.md

pkgs/data_assets/CHANGELOG.md

pkgs/hooks_runner/lib/src/build_runner/build_planner.dart

pkgs/hooks_runner/test_data/manifest.yaml

dcharkes · 2025-07-30T17:18:51Z

pkgs/data_assets/pubspec.yaml

We have coverage on the CI, but it doesn't collect coverage for the test
projects being run because those are separate dart process invocations. It might
be worth trying to see if we can get code coverage from those.

github-actions bot added package:hooks package:hooks_runner package:code_assets labels Jul 16, 2025

dcharkes reviewed Jul 16, 2025

View reviewed changes

pkgs/hooks/lib/hooks.dart Outdated Show resolved Hide resolved

mosuem force-pushed the runLinkHooksInOrder branch from 89d0f4f to 031f3ee Compare July 17, 2025 08:20

github-actions bot added the package:native_toolchain_c label Jul 17, 2025

dcharkes reviewed Jul 17, 2025

View reviewed changes

pkgs/hooks/doc/schema/shared/shared_definitions.schema.json Outdated Show resolved Hide resolved

github-actions bot added the package:data_assets label Jul 17, 2025

mosuem changed the title ~~Run link hooks in order~~ [hooks] Run link hooks in order Jul 18, 2025

mosuem requested a review from dcharkes July 18, 2025 12:37

dcharkes requested changes Jul 21, 2025

View reviewed changes

mosuem marked this pull request as ready for review July 23, 2025 08:21

mosuem requested a review from dcharkes July 23, 2025 08:21

mosuem force-pushed the runLinkHooksInOrder branch 2 times, most recently from 2f596d8 to fb5a45b Compare July 24, 2025 11:40

mosuem requested a review from goderbauer July 24, 2025 11:41

goderbauer reviewed Jul 24, 2025

View reviewed changes

mosuem requested a review from goderbauer July 24, 2025 14:18

mosuem mentioned this pull request Jul 25, 2025

Prepare Dart package for publishing unicode-org/icu4x#6739

Merged

mosuem force-pushed the runLinkHooksInOrder branch from 088820a to ed6e124 Compare July 28, 2025 08:26

dcharkes requested changes Jul 28, 2025

View reviewed changes

Run link hooks in order

15cf956

mosuem force-pushed the runLinkHooksInOrder branch from dce41a1 to 15cf956 Compare July 28, 2025 14:03

change version

3f14d47

mosuem requested a review from dcharkes July 28, 2025 14:15

mosuem added 3 commits July 28, 2025 16:32

Switch back to assets

d75cdf0

add to test data

226fd38

normalized

91bdfe1

schema tests

81f0231

Add more data for some reason

9daf109

dcharkes approved these changes Jul 30, 2025

View reviewed changes

mosuem added 6 commits July 31, 2025 08:55

changes as per review

f0727e5

fix pubspec versions

8dfc9e2

Fix in other pubspecs

0f50464

fix

02f90b1

fix message

63b5d55

fix another message

a03078b

mosuem merged commit 16ae2d8 into main Jul 31, 2025
21 of 22 checks passed

mosuem deleted the runLinkHooksInOrder branch July 31, 2025 12:20

dcharkes mentioned this pull request Aug 11, 2025

[hooks_runner] Add the manifest generator to the ci checks #2491

Merged

[hooks] Run link hooks in order #2417

[hooks] Run link hooks in order #2417

Uh oh!

Conversation

mosuem commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Health

Uh oh!

Uh oh!

coveralls commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jul 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Package publishing

Uh oh!

dcharkes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dcharkes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mosuem commented Jul 28, 2025

Uh oh!

dcharkes commented Jul 28, 2025

Uh oh!

mosuem commented Jul 30, 2025

Uh oh!

dcharkes commented Jul 30, 2025

Uh oh!

mosuem commented Jul 30, 2025

Uh oh!

dcharkes commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mosuem commented Jul 16, 2025 •

edited

Loading

github-actions bot commented Jul 16, 2025 •

edited

Loading

coveralls commented Jul 17, 2025 •

edited

Loading

github-actions bot commented Jul 18, 2025 •

edited

Loading

dcharkes commented Jul 30, 2025 •

edited

Loading