Catch file system exceptions when trying to parse user-provided asset file paths #142214

andrewkolos · 2024-01-25T08:35:15Z

Fixes #141211

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
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 documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

packages/flutter_tools/test/general.shard/asset_bundle_test.dart

packages/flutter_tools/lib/src/asset.dart

christopherfujino · 2024-01-26T23:17:57Z

packages/flutter_tools/lib/src/asset.dart

+    } on FileSystemException catch (e) {
+      throwToolExit(
+        'Unable to check the existence of asset file "$assetPath". '
+        'Ensure that the asset file is declared is a valid local file system path.\n'


-'Ensure that the asset file is declared is a valid local file system path.\n' +'Ensure that the asset file is declared and is a valid local file system path.\n'

andrewkolos · 2024-01-26T23:18:34Z

@christopherfujino FYI I'm rewriting the test to be hermetic. Converting to draft.

packages/flutter_tools/test/general.shard/asset_bundle_test.dart

christopherfujino · 2024-01-26T23:22:12Z

@christopherfujino FYI I'm rewriting the test to be hermetic. Converting to draft.

oops, just saw this, SGTM

andrewkolos · 2024-01-27T00:04:33Z

Ready again. I did some tidying up before I left, making the diff bigger. See the recent commits with refactor in the message to help yourself make sense of it.

packages/flutter_tools/lib/src/asset.dart

christopherfujino · 2024-01-27T00:11:26Z

packages/flutter_tools/test/general.shard/asset_bundle_test.dart

-        );
-        return bundle;
-      }
+  group('AssetBundle.build (hermetic)', () {


why hermetic in the group name? are some of these not hermetic?

Yes, see the group above named "AssetBundle.build"

Alternatively, I can rename the other group to AssetBundle.build (non-hermetic)

Basically the point of this was I didn't want to reuse the polluted scope of the existing group

packages/flutter_tools/test/general.shard/asset_bundle_test.dart

christopherfujino

A few nit questions, but LGTM, this is a good cleanup!

auto-submit · 2024-01-27T00:35:06Z

auto label is removed for flutter/flutter/142214, due to - The status or check suite Linux analyze has failed. Please fix the issues identified (or deflake) before re-applying this label.

christopherfujino · 2024-01-28T07:16:32Z

packages/flutter_tools/test/general.shard/asset_bundle_test.dart

-    late Logger logger;
+  const String shaderLibDir = '/./shader_lib';
+
+  group('AssetBundle.build (non-hermetic)', () {


in what ways are these non-hermetic? ideally we would either make them hermetic, or move them to the integration shard if they must use the real environment.

I'm uncomfortable calling anything that uses testUsingContext hermetic. If you ignore the lack of a Logger override, these tests are probably hermetic, so perhaps the non-hermetic label is unfair. If you have better ideas for group names, I'm all ears (perhaps "using context" and "not using context").

The reason the groups are separate is that one uses setUp (polluting the scope with testFileSystem and platform) and testUsingContext (both of which are not recommended for use), and the latter group is more idiomatic.

I do not wish the rewrite all of these tests to be idiomatic now, as this would be a significant undertaking, and I lack the needed bandwidth.

addressed in tweak group name

ahh, I see, thanks for the explanation!

…ed asset file paths (flutter/flutter#142214)

Manual roll Flutter from 2f6fdf2 to ace9181 (57 revisions) Manual roll requested by [email protected] flutter/flutter@2f6fdf2...ace9181 2024-01-29 [email protected] Roll Flutter Engine from 9c3ebf67b5da to bedafa8794b6 (4 revisions) (flutter/flutter#142478) 2024-01-29 [email protected] onNavigationNotification for *App.router (flutter/flutter#142190) 2024-01-29 [email protected] Marks Mac_x64 framework_tests_misc to be unflaky (flutter/flutter#142118) 2024-01-29 [email protected] Roll Flutter Engine from 3e2b8975bd5b to 9c3ebf67b5da (1 revision) (flutter/flutter#142472) 2024-01-29 [email protected] Feat: TextField can scroll when disabled (flutter/flutter#140922) 2024-01-29 [email protected] Roll Flutter Engine from 436f91f3b06b to 3e2b8975bd5b (2 revisions) (flutter/flutter#142466) 2024-01-29 [email protected] Marks Mac_arm64 framework_tests_misc to be unflaky (flutter/flutter#142119) 2024-01-29 [email protected] Fix InputDecorationTheme copyWith fallback for iconColor (flutter/flutter#142462) 2024-01-29 [email protected] Add `SingleChildScrollView` for `NavigationRail` (flutter/flutter#137415) 2024-01-29 [email protected] [Windows Arm64] Run plugin test post-submit (flutter/flutter#141987) 2024-01-29 [email protected] Catch file system exceptions when trying to parse user-provided asset file paths (flutter/flutter#142214) 2024-01-29 [email protected] Implementing `switch` expressions in `foundation/` and `material/` (flutter/flutter#142279) 2024-01-29 [email protected] Roll Flutter Engine from bff1e46c0d65 to 436f91f3b06b (1 revision) (flutter/flutter#142455) 2024-01-29 [email protected] Opt out test from leak tracking. (flutter/flutter#142417) 2024-01-29 [email protected] Update Android minSdkVersion to 21 (flutter/flutter#142267) 2024-01-29 [email protected] Roll Flutter Engine from 3d87470655b1 to bff1e46c0d65 (1 revision) (flutter/flutter#142446) 2024-01-29 [email protected] Roll Packages from cbe8100 to 516648a (3 revisions) (flutter/flutter#142445) 2024-01-29 [email protected] Roll Flutter Engine from 1405cb7b6e74 to 3d87470655b1 (1 revision) (flutter/flutter#142444) 2024-01-29 [email protected] Roll Flutter Engine from 3e65f1720a6f to 1405cb7b6e74 (1 revision) (flutter/flutter#142432) 2024-01-29 [email protected] Roll Flutter Engine from 210ed1dfb8cf to 3e65f1720a6f (1 revision) (flutter/flutter#142429) 2024-01-29 [email protected] Roll Flutter Engine from f15cb86d31c3 to 210ed1dfb8cf (1 revision) (flutter/flutter#142426) 2024-01-29 [email protected] Roll Flutter Engine from f3d48be76630 to f15cb86d31c3 (11 revisions) (flutter/flutter#142425) 2024-01-27 [email protected] Roll Flutter Engine from 95e9a15fd909 to f3d48be76630 (1 revision) (flutter/flutter#142370) 2024-01-27 [email protected] Add no-shuffle to language_version_test.dart (flutter/flutter#142378) 2024-01-27 [email protected] Roll Flutter Engine from 2687ddb2655c to 95e9a15fd909 (8 revisions) (flutter/flutter#142369) 2024-01-27 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Roll Flutter Engine from 2687ddb2655c to 2adad88a39f4 (4 revisions)" (flutter/flutter#142366) 2024-01-27 [email protected] Roll Flutter Engine from 2687ddb2655c to 2adad88a39f4 (4 revisions) (flutter/flutter#142362) 2024-01-27 [email protected] Roll Flutter Engine from 45c06c22d5c7 to 2687ddb2655c (1 revision) (flutter/flutter#142359) 2024-01-27 [email protected] Remove suspicious constant from input decorator layout (flutter/flutter#142342) 2024-01-27 [email protected] Roll Flutter Engine from 2e32acf4c31a to 45c06c22d5c7 (2 revisions) (flutter/flutter#142353) 2024-01-27 [email protected] Roll Flutter Engine from a65a1b55e06a to 2e32acf4c31a (1 revision) (flutter/flutter#142351) 2024-01-26 [email protected] Roll Flutter Engine from 525bd7dcf7f3 to a65a1b55e06a (11 revisions) (flutter/flutter#142347) 2024-01-26 [email protected] Relands "Add runWidget to bootstrap a widget tree without a default View" (flutter/flutter#142344) 2024-01-26 [email protected] Fix assertion failure when reordering two dimensional children (flutter/flutter#141504) 2024-01-26 [email protected] Limit `fuchsia_precache` in presubmit to engine rolls (flutter/flutter#142333) 2024-01-26 49699333+dependabot[bot]@users.noreply.github.com Bump github/codeql-action from 3.23.1 to 3.23.2 (flutter/flutter#142345) 2024-01-26 [email protected] refactor asset bundle code to not depend on the global Cache.flutterRoot (flutter/flutter#142277) 2024-01-26 [email protected] [flutter_tools] remove await runZonedGuarded() in tests (flutter/flutter#142336) 2024-01-26 [email protected] Only use iOS 17 physical devices in staging tests (flutter/flutter#142323) 2024-01-26 [email protected] Roll deps from dart-lang/native in templates (flutter/flutter#142322) 2024-01-26 [email protected] Remove duplicate global declaration of `UserMessages` (flutter/flutter#142281) 2024-01-26 [email protected] Redistribute iOS TESTOWNERS (flutter/flutter#142315) 2024-01-26 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Add runWidget to bootstrap a widget tree without a default View" (flutter/flutter#142339) 2024-01-26 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Roll Flutter Engine from 525bd7dcf7f3 to 65d1291c3add (1 revision)" (flutter/flutter#142332) ...

github-actions bot added the tool Affects the "flutter" command-line tool. See also t: labels. label Jan 25, 2024

andrewkolos marked this pull request as ready for review January 25, 2024 17:43

andrewkolos requested a review from christopherfujino January 25, 2024 17:48

andrewkolos commented Jan 25, 2024

View reviewed changes

packages/flutter_tools/test/general.shard/asset_bundle_test.dart Outdated Show resolved Hide resolved

christopherfujino reviewed Jan 25, 2024

View reviewed changes

packages/flutter_tools/lib/src/asset.dart Outdated Show resolved Hide resolved

christopherfujino reviewed Jan 25, 2024

View reviewed changes

packages/flutter_tools/lib/src/asset.dart Show resolved Hide resolved

andrewkolos added 3 commits January 26, 2024 15:10

fix

2336464

lint

6b0ef6b

nit

3c7f176

andrewkolos force-pushed the another-uri-crash-fix branch from 6bda113 to 3c7f176 Compare January 26, 2024 23:10

christopherfujino reviewed Jan 26, 2024

View reviewed changes

andrewkolos marked this pull request as draft January 26, 2024 23:18

This comment was marked as off-topic.

Sign in to view

christopherfujino reviewed Jan 26, 2024

View reviewed changes

packages/flutter_tools/test/general.shard/asset_bundle_test.dart Outdated Show resolved Hide resolved

andrewkolos added 4 commits January 26, 2024 15:33

make test hermetic

7839b8e

refactor similar test to be hermetic

9dd6106

refactor: move flavors test to their own file per the style guide

0e19750

reduce diff size

07a4e86

andrewkolos marked this pull request as ready for review January 27, 2024 00:04

andrewkolos requested a review from christopherfujino January 27, 2024 00:04

fix oopsie

e72245e

christopherfujino reviewed Jan 27, 2024

View reviewed changes

packages/flutter_tools/lib/src/asset.dart Outdated Show resolved Hide resolved

christopherfujino reviewed Jan 27, 2024

View reviewed changes

packages/flutter_tools/test/general.shard/asset_bundle_test.dart Outdated Show resolved Hide resolved

christopherfujino approved these changes Jan 27, 2024

View reviewed changes

andrewkolos added 2 commits January 26, 2024 16:20

avoid use of "Uri" in user-facing language

44532be

fix oopsie in test

699383e

andrewkolos added the autosubmit Merge PR when tree becomes green via auto submit App label Jan 27, 2024

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jan 27, 2024

license

75e5864

christopherfujino reviewed Jan 28, 2024

View reviewed changes

tweak group name

f76d703

andrewkolos added the autosubmit Merge PR when tree becomes green via auto submit App label Jan 29, 2024

auto-submit bot merged commit 83bdde2 into flutter:master Jan 29, 2024

engine-flutter-autoroll mentioned this pull request Jan 30, 2024

Manual roll Flutter from 2f6fdf2650d4 to ace9181172b6 (57 revisions) flutter/packages#6013

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 30, 2024

83bdde2 Catch file system exceptions when trying to parse user-provid…

2fc45df

…ed asset file paths (flutter/flutter#142214)

engine-flutter-autoroll mentioned this pull request Jan 30, 2024

Roll Flutter from 2f6fdf2650d4 to ccb2b4439a43 (68 revisions) flutter/packages#6014

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 30, 2024

83bdde2 Catch file system exceptions when trying to parse user-provid…

642d6b0

…ed asset file paths (flutter/flutter#142214)

engine-flutter-autoroll mentioned this pull request Jan 30, 2024

Roll Flutter from 2f6fdf2650d4 to 72dc162ff052 (69 revisions) flutter/packages#6015

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 30, 2024

83bdde2 Catch file system exceptions when trying to parse user-provid…

5e3bc1d

…ed asset file paths (flutter/flutter#142214)

andrewkolos deleted the another-uri-crash-fix branch April 29, 2024 18:18

Catch file system exceptions when trying to parse user-provided asset file paths #142214

Catch file system exceptions when trying to parse user-provided asset file paths #142214

Uh oh!

Conversation

andrewkolos commented Jan 25, 2024

Pre-launch Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrewkolos commented Jan 26, 2024

Uh oh!

This comment was marked as off-topic.

Uh oh!

christopherfujino commented Jan 26, 2024

Uh oh!

andrewkolos commented Jan 27, 2024

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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

christopherfujino left a comment

Choose a reason for hiding this comment

Uh oh!

auto-submit bot commented Jan 27, 2024

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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!