Skip to content

[flutter_tools] Include dev_dependencies hooks for release integration tests - #193436

Queued
dcharkes wants to merge 1 commit into
flutter:masterfrom
dcharkes:data-assets-dev-dependencies-release-test
Queued

dcharkes wants to merge 1 commit into
flutter:masterfrom
dcharkes:data-assets-dev-dependencies-release-test

Conversation

@dcharkes

@dcharkes dcharkes commented Sep 28, 2026 •

Copy link
Copy Markdown
Contributor

When running release-mode tests (such as flutter test integration_test --release), createFlutterNativeAssetsBuildRunner previously set includeDevDependencies = !buildMode.isRelease, which excluded hooks from dev_dependencies.

Bug:

Changes

  • Check _isTestTarget(environment) (whether kTargetFile is under integration_test/, test_driver/, or test/) so includeDevDependencies is true for test targets even in release mode.
  • Add a unit test in native_assets_test.dart verifying includeDevDependencies is false for lib/main.dart in release mode and true for integration_test/app_test.dart, test_driver/app.dart, and test/app_test.dart.

PR Stack

# PR Branch Commit
1 #193434 data-assets-empty-pubspec ab37f42
2 #193435 data-assets-flutter-test 4956c97
3 👉 #193436 (this PR) data-assets-dev-dependencies-release-test 596124d
4 #193437 data-assets-widget-preview bd246d9

Pre-launch Checklist

  • I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
  • I read the [AI contribution guidelines] and understand my responsibilities, or I am not using AI tools.
  • I read the [Tree Hygiene] wiki page, which explains my responsibilities.
  • I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
  • I signed the [CLA].
  • I listed at least one issue that this PR fixes in the description above.
  • I updated/added relevant in-code documentation (doc comments with ///).
  • If this PR introduces a new feature or capability, I created and linked a website documentation issue or PR in [flutter/website] (or verified none is needed).
  • I added new tests to check the change I am making, or this PR is [test-exempt].
  • I followed the [breaking change policy] and added [Data Driven Fixes] where supported.
  • All existing and new tests are passing.

);
}

bool _isTestTarget(Environment environment) {

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bkonyi I am surprised we have nothing like this yet in the codebase. It seems that the usual logic on dev deps or not is dependent on release mode, but that is too strict if you want to use dev deps in tests or integration tests in release mode.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • There is no existing shared helper in flutter_tools that checks whether kTargetFile is a test target across integration_test/, test_driver/, and test/:
    • _shouldRunAsIntegrationTests in test.dart only checks integration_test/.
    • DriveCommand.runCommand in drive.dart only checks _fileSystem.path.isWithin('test_driver', targetFile) for an error message.
    • RunCommand in run.dart only checks targetFile.endsWith('_test.dart') for analytics.
    • The closest related helper in flutter_tools is PackageConfigWorkspaceExtension.toPackageUriForWorkspace (used in WebEntrypointTarget.build and KernelCompiler.compile), which returns null whenever the entrypoint is outside lib/.

@dcharkes dcharkes added the CICD Run CI/CD label Sep 28, 2026
@dcharkes
dcharkes requested a review from bkonyi September 28, 2026 10:20
pull Bot pushed a commit to phamminhphuc/flutter that referenced this pull request Sep 28, 2026
…mpty (flutter#193434)

When `flutterManifest.isEmpty` (for example, a `pubspec.yaml` without a
`flutter:` section), `ManifestAssetBundle.build` previously returned
early with an empty `AssetManifest.bin`, ignoring any data assets
produced by build/link hooks (`flutterHookResult.dataAssets`).

Bug:

* flutter#146264

### Changes
- Only short-circuit with an empty manifest in
`ManifestAssetBundle.build` when both `flutterManifest.isEmpty` and
`flutterHookResult?.dataAssets.isEmpty ?? true`.
- Skip `computeTransitiveDependencies` when `flutterManifest.isEmpty`.
- Add a unit test in `asset_bundle_test.dart` verifying that data assets
from hooks are bundled when `pubspec.yaml` is empty.

### PR Stack
| # | PR | Branch | Commit |
| :-: | :--- | :--- | :--- |
| **1** | **👉 flutter#193434 (this PR)**
| `data-assets-empty-pubspec` |
flutter@62199c4
|
| 2 | flutter#193435 |
`data-assets-flutter-test` |
flutter@25be1ab
|
| 3 | flutter#193436 |
`data-assets-dev-dependencies-release-test` |
flutter@79abad9
|
| 4 | flutter#193437 |
`data-assets-widget-preview` |
flutter@98f1001
|

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [AI contribution guidelines] and understand my
responsibilities, or I am not using AI tools.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant in-code documentation (doc comments with
`///`).
- [x] If this PR introduces a new feature or capability, I created and
linked a website documentation issue or PR in [flutter/website] (or
verified none is needed).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.
@dcharkes
dcharkes force-pushed the data-assets-dev-dependencies-release-test branch 6 times, most recently from 4e9c425 to 76799a8 Compare October 1, 2026 09:40
mattkae pushed a commit to canonical/flutter that referenced this pull request Oct 1, 2026
…r#193435)

Previously, `flutter test` ran native assets hooks via
`TestCompilerNativeAssetsBuilder.build(buildInfo)`, which only returned
the `NativeAssetsManifest.json` URI and discarded the
`FlutterHookResult` containing hook-generated data assets.

Bug:

* flutter#146264

### Changes
- Add `buildWithHookResult` to `TestCompilerNativeAssetsBuilder`
returning both `nativeAssetsManifest` and `flutterHookResult`.
- Pass `flutterHookResult` to `_buildTestAsset` / `assetBundle.build` in
`TestCommand`.
- Update `TestCommand._needsRebuild` to check if bundled asset files
exist on disk, guard `pub.existsSync()`, and check
`flutterHookResult.dependencies` modification timestamps.
- Add a hermetic test in `test_test.dart` verifying that `flutter test`
bundles data assets from hooks into `build/unit_test_assets`.

### PR Stack
| # | PR | Branch | Commit |
| :-: | :--- | :--- | :--- |
| 1 | flutter#193434 |
`data-assets-empty-pubspec` |
flutter@62199c4
|
| **2** | **👉 flutter#193435 (this PR)**
| `data-assets-flutter-test` |
flutter@390c757
|
| 3 | flutter#193436 |
`data-assets-dev-dependencies-release-test` |
flutter@cca04e9
|
| 4 | flutter#193437 |
`data-assets-widget-preview` |
flutter@0a5a8e9
|

> **Note:** This PR is stacked on
flutter#193434. To review only this PR's
diff before the base PR lands, view commit
flutter@390c757.

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [AI contribution guidelines] and understand my
responsibilities, or I am not using AI tools.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant in-code documentation (doc comments with
`///`).
- [x] If this PR introduces a new feature or capability, I created and
linked a website documentation issue or PR in [flutter/website] (or
verified none is needed).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.
@dcharkes
dcharkes force-pushed the data-assets-dev-dependencies-release-test branch from 76799a8 to bd93510 Compare October 2, 2026 14:33
@dcharkes
dcharkes marked this pull request as ready for review October 2, 2026 14:37

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the native assets build runner to include dev dependencies for release test targets, such as those located in the integration_test, test_driver, or test directories, and adds corresponding tests. Feedback suggests wrapping the relative path calculation in a try-catch block to prevent potential PathException crashes on Windows when paths are on different drives, as well as using triple-slash (///) comments for private member documentation per the style guide.

Comment on lines +426 to +441
bool _isTestTarget(Environment environment) {
final String? targetFile = environment.defines[kTargetFile];
if (targetFile == null) {
return false;
}
final String absoluteTargetPath = environment.fileSystem.path.isAbsolute(targetFile)
? targetFile
: environment.fileSystem.path.join(environment.projectDir.path, targetFile);
final String relativePath = environment.fileSystem.path.relative(
environment.fileSystem.path.normalize(absoluteTargetPath),
from: environment.projectDir.path,
);
final List<String> parts = environment.fileSystem.path.split(relativePath);
return parts.isNotEmpty &&
const <String>{'integration_test', 'test_driver', 'test'}.contains(parts.first);
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To prevent potential crashes on Windows when targetFile and environment.projectDir.path are on different drives (which causes path.relative to throw a PathException), we should wrap the relative path computation in a try-catch block.

Additionally, per the Flutter Style Guide, we should use /// for public-quality documentation, even on private members.

/// Returns whether the target file in the [environment] is a test target.
///
/// This checks if the target file is located within the test, test_driver,
/// or integration_test directories of the project.
bool _isTestTarget(Environment environment) {
  final String? targetFile = environment.defines[kTargetFile];
  if (targetFile == null) {
    return false;
  }
  final String absoluteTargetPath = environment.fileSystem.path.isAbsolute(targetFile)
      ? targetFile
      : environment.fileSystem.path.join(environment.projectDir.path, targetFile);
  try {
    final String relativePath = environment.fileSystem.path.relative(
      environment.fileSystem.path.normalize(absoluteTargetPath),
      from: environment.projectDir.path,
    );
    final List<String> parts = environment.fileSystem.path.split(relativePath);
    return parts.isNotEmpty &&
        const <String>{'integration_test', 'test_driver', 'test'}.contains(parts.first);
  } catch (_) {
    return false;
  }
}
References
  1. Use /// for public-quality documentation, even on private members. (link)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

path.relative across drives on Windows (try-catch) — False (Python hallucination):

  • Unlike Python's os.path.relpath (which raises ValueError across drives), Dart's package:path Context.relative does not throw a PathException when two absolute paths are on different Windows drives (C:\... vs D:\...).
  • Instead, package:path checks if (fromParsed.root != pathParsed.root) return path; and simply returns D:\... unchanged, so parts.first is 'D:\\' and _isTestTarget returns false.
  • (Context.relative only throws PathException if a root-relative Windows path like \foo without a drive letter is compared against C:\bar when current has no drive letter.)

bkonyi
bkonyi previously approved these changes Oct 5, 2026

@bkonyi bkonyi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM overall with one question.

}

testUsingContext(
'createFlutterNativeAssetsBuildRunner includes dev dependencies for release test targets',

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need another case here for test/?

@dcharkes
dcharkes force-pushed the data-assets-dev-dependencies-release-test branch from bd93510 to 596124d Compare October 6, 2026 08:15
@dcharkes
dcharkes requested a review from bkonyi October 6, 2026 08:35

@bkonyi bkonyi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@dcharkes dcharkes added the autosubmit Merge PR when tree becomes green via auto submit App label Oct 12, 2026
@auto-submit
auto-submit Bot added this pull request to the merge queue Oct 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmit Merge PR when tree becomes green via auto submit App CICD Run CI/CD tool Affects the "flutter" command-line tool. See also t: labels.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants