Initialize `default-flavor` in `FlutterCommand`, adds integration test. #169298

matanlurey · 2025-05-22T19:20:54Z

bkonyi · 2025-05-22T19:27:23Z

packages/flutter_tools/lib/src/build_system/targets/common.dart

-        '$kAppFlavor is used by the framework and cannot be '
-        'set using --${FlutterOptions.kDartDefinesOption} or --${FlutterOptions.kDartDefineFromFileOption}',
-      );
-    }
    dartDefines.add('$kAppFlavor=$flavor');


Do we still need to add the flavor here now that we're doing it in flutter_command.dart?

My understanding is yes because this is special-case handling for special Xcode-y things, but I will need to ask @vashworth to be sure.

Yeah this is still needed for when you launch the app from Xcode instead of the CLI. I think we may also need to check if the flavor is already in the dartDefines here and skip the parsing and adding if it is, otherwise it'll get added twice I think

Sg, PTAL @vashworth

bkonyi

Thanks for getting this over the line. LGTM!

vashworth

LGTM

…t. (flutter#169298) Closes flutter#169160. Closes flutter#165803.

matanlurey · 2025-05-28T12:31:56Z

reason for revert: Broke mac/iOS integration tests.

…tion test. (#169298)" This reverts commit 5759401.

…ation test. (#169298)" (#169581)  Reverts: #169298   Initiated by: matanlurey   Reason for reverting: Broke mac/iOS integration tests.   Original PR Author: matanlurey   Reviewed By: {vashworth, bkonyi}   This change reverts the following previous change: Closes #169160. Closes #165803.  Co-authored-by: auto-submit[bot] <flutter-engprod-team@google.com>

…ration test. (flutter/flutter#169298)

flutter/flutter@4372bfb...0e536eb 2025-05-28 30870216+gaaclarke@users.noreply.github.com Introduces FlutterPluginRegistrant protocol. (flutter/flutter#169399) 2025-05-28 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Initialize `default-flavor` in `FlutterCommand`, adds integration test. (#169298)" (flutter/flutter#169581) 2025-05-28 matanlurey@users.noreply.github.com Initialize `default-flavor` in `FlutterCommand`, adds integration test. (flutter/flutter#169298) 2025-05-28 jakemac@google.com Update DEPS to add dart-lang/ai repo (flutter/flutter#169540) 2025-05-28 engine-flutter-autoroll@skia.org Roll Skia from 92311f2ba0b7 to 82d326fc2148 (1 revision) (flutter/flutter#169552) 2025-05-28 kevmoo@users.noreply.github.com dev/bots: improve service worker test code (flutter/flutter#169231) 2025-05-28 magder@google.com Make Android team platform view TESTOWNERS (flutter/flutter#169297) 2025-05-28 engine-flutter-autoroll@skia.org Roll Skia from 044f58f78a73 to 92311f2ba0b7 (9 revisions) (flutter/flutter#169542) 2025-05-27 engine-flutter-autoroll@skia.org Roll Skia from 443f5257f382 to 044f58f78a73 (16 revisions) (flutter/flutter#169530) 2025-05-27 sokolovskyi.konstantin@gmail.com [web] Fix unresponsive input above SelectionArea in Safari and Firefox. (flutter/flutter#167275) 2025-05-27 58529443+srujzs@users.noreply.github.com Set pause_isolates_on_start flag if --start-paused (flutter/flutter#169392) 2025-05-27 engine-flutter-autoroll@skia.org Roll Packages from af0b9a9 to 6eebe72 (24 revisions) (flutter/flutter#169514) 2025-05-27 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from 5mpmPsuD8rpeiJizT... to nC9hLWjYVlChDTEPh... (flutter/flutter#169498) 2025-05-27 zhongliu88889@gmail.com Split hint from label and expose it via aria-description or aria-describedby (flutter/flutter#169157) 2025-05-26 github@alexv525.com 🐛 Normalize generated file paths for the l10n generator (flutter/flutter#169467) 2025-05-26 engine-flutter-autoroll@skia.org Roll Dart SDK from d811152316e4 to 6aeb798bdbe2 (2 revisions) (flutter/flutter#169478) 2025-05-26 dkwingsmt@users.noreply.github.com [Cupertino] Apply RSuperellipse to most Cupertino widgets (flutter/flutter#167784) 2025-05-26 bkonyi@google.com Roll `package:dds` to 5.0.2 (flutter/flutter#169471) 2025-05-26 matanlurey@users.noreply.github.com Use `.flutter-plugins-dependencies` for crash reporting. (flutter/flutter#169319) 2025-05-26 matanlurey@users.noreply.github.com Remove now disabled code that would generate `.flutter-plugins`. (flutter/flutter#169320) 2025-05-26 engine-flutter-autoroll@skia.org Roll Dart SDK from 7dab9bffe1f7 to d811152316e4 (1 revision) (flutter/flutter#169473) 2025-05-26 munsocket@protonmail.com Precise browser resizing with integration_test and driver (flutter/flutter#160678) 2025-05-26 matanlurey@users.noreply.github.com Add `/coverage/` to `.gitignore.tmp` (flutter/flutter#169387) 2025-05-26 matanlurey@users.noreply.github.com Make test output with encoded `dart-defines=...` human readable. (flutter/flutter#169353) 2025-05-26 matanlurey@users.noreply.github.com Use at most `PROC~/2` tasks to transform assets. (flutter/flutter#169386) 2025-05-26 32538273+ValentinVignal@users.noreply.github.com Forward exit code from dart test to flutter test (flutter/flutter#168604) 2025-05-26 51940183+Sameri11@users.noreply.github.com Fix warning when building for macOS desktop (flutter/flutter#165996) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC stuartmorgan@google.com,tarrinneal@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

…s integration test. (flutter#169298)" (flutter#169581)" This reverts commit 5d013c7.

Closes #169598 (which explains the integration test failure). Closes #169160. Closes #165803. This is the only diff from 5d013c7: ```diff diff --git a/packages/flutter_tools/lib/src/build_system/targets/common.dart b/packages/flutter_tools/lib/src/build_system/targets/common.dart index 6158321..6773101 100644 --- a/packages/flutter_tools/lib/src/build_system/targets/common.dart +++ b/packages/flutter_tools/lib/src/build_system/targets/common.dart @@ -308,10 +308,18 @@ class KernelSnapshot extends Target { if (flavor == null) { return; } - if (!dartDefines.any((String element) => element.startsWith(kAppFlavor))) { - // If the flavor is not already in the dart defines, add it. - dartDefines.add('$kAppFlavor=$flavor'); - } + + // It is possible there is a flavor already in dartDefines, from another + // part of the build process, but this should take precedence as it happens + // last (xcodebuild execution). + // + // See #169598. + + // If the flavor is already in the dart defines, remove it. + dartDefines.removeWhere((String define) => define.startsWith(kAppFlavor)); + + // Then, add it to the end. + dartDefines.add('$kAppFlavor=$flavor'); } } ```

…er#169602) Closes flutter#169598 (which explains the integration test failure). Closes flutter#169160. Closes flutter#165803. This is the only diff from 5d013c7: ```diff diff --git a/packages/flutter_tools/lib/src/build_system/targets/common.dart b/packages/flutter_tools/lib/src/build_system/targets/common.dart index 6158321..6773101 100644 --- a/packages/flutter_tools/lib/src/build_system/targets/common.dart +++ b/packages/flutter_tools/lib/src/build_system/targets/common.dart @@ -308,10 +308,18 @@ class KernelSnapshot extends Target { if (flavor == null) { return; } - if (!dartDefines.any((String element) => element.startsWith(kAppFlavor))) { - // If the flavor is not already in the dart defines, add it. - dartDefines.add('$kAppFlavor=$flavor'); - } + + // It is possible there is a flavor already in dartDefines, from another + // part of the build process, but this should take precedence as it happens + // last (xcodebuild execution). + // + // See flutter#169598. + + // If the flavor is already in the dart defines, remove it. + dartDefines.removeWhere((String define) => define.startsWith(kAppFlavor)); + + // Then, add it to the end. + dartDefines.add('$kAppFlavor=$flavor'); } } ```

…169623) This pull request is created by [automatic cherry pick workflow](https://github.com/flutter/flutter/blob/main/docs/releases/Flutter-Cherrypick-Process.md#automatically-creates-a-cherry-pick-request) Please fill in the form below, and a flutter domain expert will evaluate this cherry pick request. ### Issue Link: What is the link to the issue this cherry-pick is addressing? #169602 ### Changelog Description: Explain this cherry pick in one line that is accessible to most Flutter developers. See [best practices](https://github.com/flutter/flutter/blob/main/docs/releases/Hotfix-Documentation-Best-Practices.md) for examples Fixes a bug where `appFlavor` is `null` when being run with `flutter test` or being hot-restarted. ### Impact Description: What is the impact (ex. visual jank on Samsung phones, app crash, cannot ship an iOS app)? Does it impact development (ex. flutter doctor crashes when Android Studio is installed), or the shipping production app (the app crashes on launch) Cannot reliably use `appFlavor` without rebuilding the app from scratch. ### Workaround: Is there a workaround for this issue? Do not use hot restart, do not use `flutter test`. ### Risk: What is the risk level of this cherry-pick? ### Test Coverage: Are you confident that your fix is well-tested by automated tests? ### Validation Steps: What are the steps to validate that this fix works? Automated test coverage.

…9624) This pull request is created by [automatic cherry pick workflow](https://github.com/flutter/flutter/blob/main/docs/releases/Flutter-Cherrypick-Process.md#automatically-creates-a-cherry-pick-request) Please fill in the form below, and a flutter domain expert will evaluate this cherry pick request. ### Issue Link: What is the link to the issue this cherry-pick is addressing? #169602 ### Changelog Description: Explain this cherry pick in one line that is accessible to most Flutter developers. See [best practices](https://github.com/flutter/flutter/blob/main/docs/releases/Hotfix-Documentation-Best-Practices.md) for examples Fixes a bug where `appFlavor` is `null` when being run with `flutter test` or being hot-restarted. ### Impact Description: What is the impact (ex. visual jank on Samsung phones, app crash, cannot ship an iOS app)? Does it impact development (ex. flutter doctor crashes when Android Studio is installed), or the shipping production app (the app crashes on launch) Cannot reliably use `appFlavor` without rebuilding the app from scratch. ### Workaround: Is there a workaround for this issue? Do not use hot restart, do not use `flutter test`. ### Risk: What is the risk level of this cherry-pick? ### Test Coverage: Are you confident that your fix is well-tested by automated tests? ### Validation Steps: What are the steps to validate that this fix works? Automated test coverage.

…r#9334) flutter/flutter@4372bfb...0e536eb 2025-05-28 30870216+gaaclarke@users.noreply.github.com Introduces FlutterPluginRegistrant protocol. (flutter/flutter#169399) 2025-05-28 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Initialize `default-flavor` in `FlutterCommand`, adds integration test. (#169298)" (flutter/flutter#169581) 2025-05-28 matanlurey@users.noreply.github.com Initialize `default-flavor` in `FlutterCommand`, adds integration test. (flutter/flutter#169298) 2025-05-28 jakemac@google.com Update DEPS to add dart-lang/ai repo (flutter/flutter#169540) 2025-05-28 engine-flutter-autoroll@skia.org Roll Skia from 92311f2ba0b7 to 82d326fc2148 (1 revision) (flutter/flutter#169552) 2025-05-28 kevmoo@users.noreply.github.com dev/bots: improve service worker test code (flutter/flutter#169231) 2025-05-28 magder@google.com Make Android team platform view TESTOWNERS (flutter/flutter#169297) 2025-05-28 engine-flutter-autoroll@skia.org Roll Skia from 044f58f78a73 to 92311f2ba0b7 (9 revisions) (flutter/flutter#169542) 2025-05-27 engine-flutter-autoroll@skia.org Roll Skia from 443f5257f382 to 044f58f78a73 (16 revisions) (flutter/flutter#169530) 2025-05-27 sokolovskyi.konstantin@gmail.com [web] Fix unresponsive input above SelectionArea in Safari and Firefox. (flutter/flutter#167275) 2025-05-27 58529443+srujzs@users.noreply.github.com Set pause_isolates_on_start flag if --start-paused (flutter/flutter#169392) 2025-05-27 engine-flutter-autoroll@skia.org Roll Packages from af0b9a9 to 6eebe72 (24 revisions) (flutter/flutter#169514) 2025-05-27 engine-flutter-autoroll@skia.org Roll Fuchsia Linux SDK from 5mpmPsuD8rpeiJizT... to nC9hLWjYVlChDTEPh... (flutter/flutter#169498) 2025-05-27 zhongliu88889@gmail.com Split hint from label and expose it via aria-description or aria-describedby (flutter/flutter#169157) 2025-05-26 github@alexv525.com 🐛 Normalize generated file paths for the l10n generator (flutter/flutter#169467) 2025-05-26 engine-flutter-autoroll@skia.org Roll Dart SDK from d811152316e4 to 6aeb798bdbe2 (2 revisions) (flutter/flutter#169478) 2025-05-26 dkwingsmt@users.noreply.github.com [Cupertino] Apply RSuperellipse to most Cupertino widgets (flutter/flutter#167784) 2025-05-26 bkonyi@google.com Roll `package:dds` to 5.0.2 (flutter/flutter#169471) 2025-05-26 matanlurey@users.noreply.github.com Use `.flutter-plugins-dependencies` for crash reporting. (flutter/flutter#169319) 2025-05-26 matanlurey@users.noreply.github.com Remove now disabled code that would generate `.flutter-plugins`. (flutter/flutter#169320) 2025-05-26 engine-flutter-autoroll@skia.org Roll Dart SDK from 7dab9bffe1f7 to d811152316e4 (1 revision) (flutter/flutter#169473) 2025-05-26 munsocket@protonmail.com Precise browser resizing with integration_test and driver (flutter/flutter#160678) 2025-05-26 matanlurey@users.noreply.github.com Add `/coverage/` to `.gitignore.tmp` (flutter/flutter#169387) 2025-05-26 matanlurey@users.noreply.github.com Make test output with encoded `dart-defines=...` human readable. (flutter/flutter#169353) 2025-05-26 matanlurey@users.noreply.github.com Use at most `PROC~/2` tasks to transform assets. (flutter/flutter#169386) 2025-05-26 32538273+ValentinVignal@users.noreply.github.com Forward exit code from dart test to flutter test (flutter/flutter#168604) 2025-05-26 51940183+Sameri11@users.noreply.github.com Fix warning when building for macOS desktop (flutter/flutter#165996) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC stuartmorgan@google.com,tarrinneal@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

…ration test. (flutter/flutter#169298)

Initialize default-flavor in FlutterCommmand, add integration test.

c99ff47

matanlurey requested review from vashworth and bkonyi May 22, 2025 19:20

github-actions bot added the tool Affects the "flutter" command-line tool. See also t: labels. label May 22, 2025

bkonyi reviewed May 22, 2025

View reviewed changes

matanlurey added 2 commits May 22, 2025 15:36

Update befuddling defines in permeable tests.

51abf18

Update dart-define expectations.

657d585

matanlurey requested a review from a team as a code owner May 22, 2025 21:08

github-actions bot added the team-ios Owned by iOS platform team label May 22, 2025

matanlurey added 3 commits May 22, 2025 23:03

++

7b4c68b

++

6c796f1

Add another test, fix bug.

c7fca11

github-actions bot removed the team-ios Owned by iOS platform team label May 23, 2025

++

5b13446

matanlurey requested a review from bkonyi May 23, 2025 17:58

bkonyi approved these changes May 26, 2025

View reviewed changes

matanlurey mentioned this pull request May 27, 2025

appFlavor returns "null" after hot restart (Channel beta, 3.31.0-0.1.pre) #165803

Closed

Merge branch 'master' into fix-default-flavor-init

9729c39

vashworth approved these changes May 28, 2025

View reviewed changes

matanlurey added the autosubmit Merge PR when tree becomes green via auto submit App label May 28, 2025

auto-submit bot added this pull request to the merge queue May 28, 2025

Merged via the queue into master with commit 5759401 May 28, 2025
148 checks passed

auto-submit bot deleted the fix-default-flavor-init branch May 28, 2025 06:23

flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label May 28, 2025

matanlurey added cp: beta cherry pick this pull request to beta release candidate branch cp: stable cherry pick this pull request to stable release candidate branch labels May 28, 2025

flutteractionsbot pushed a commit to flutteractionsbot/flutter that referenced this pull request May 28, 2025

Initialize default-flavor in FlutterCommand, adds integration tes…

398a6f5

…t. (flutter#169298) Closes flutter#169160. Closes flutter#165803.

flutteractionsbot pushed a commit to flutteractionsbot/flutter that referenced this pull request May 28, 2025

Initialize default-flavor in FlutterCommand, adds integration tes…

aacf7c7

…t. (flutter#169298) Closes flutter#169160. Closes flutter#165803.

matanlurey removed the cp: beta cherry pick this pull request to beta release candidate branch label May 28, 2025

matanlurey removed the cp: stable cherry pick this pull request to stable release candidate branch label May 28, 2025

matanlurey added the revert Autorevert PR (with "Reason for revert:" comment) label May 28, 2025

auto-submit bot pushed a commit that referenced this pull request May 28, 2025

Revert "Initialize default-flavor in FlutterCommand, adds integra…

3a8232a

…tion test. (#169298)" This reverts commit 5759401.

auto-submit bot removed the revert Autorevert PR (with "Reason for revert:" comment) label May 28, 2025

auto-submit bot mentioned this pull request May 28, 2025

Reverts "Initialize default-flavor in FlutterCommand, adds integration test. (#169298)" #169581

Merged

engine-flutter-autoroll mentioned this pull request May 28, 2025

Roll Flutter from 4372bfbc6c23 to 5d013c73baa7 (26 revisions) flutter/packages#9333

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 28, 2025

575940144 Initialize default-flavor in FlutterCommand, adds integ…

bff7a8f

…ration test. (flutter/flutter#169298)

engine-flutter-autoroll mentioned this pull request May 28, 2025

Roll Flutter from 4372bfbc6c23 to 0e536eb9fe4b (27 revisions) flutter/packages#9334

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 28, 2025

575940144 Initialize default-flavor in FlutterCommand, adds integ…

f647cd0

…ration test. (flutter/flutter#169298)

matanlurey mentioned this pull request May 28, 2025

"Initialize default-app-flavor (#169581)" fails flavors_test_macos #169598

Closed

matanlurey added a commit to matanlurey/flutter that referenced this pull request May 28, 2025

Revert "Reverts "Initialize default-flavor in FlutterCommand, add…

685cf79

…s integration test. (flutter#169298)" (flutter#169581)" This reverts commit 5d013c7.

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 14, 2025

575940144 Initialize default-flavor in FlutterCommand, adds integ…

047d9a6

…ration test. (flutter/flutter#169298)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 14, 2025

575940144 Initialize default-flavor in FlutterCommand, adds integ…

9357faf

…ration test. (flutter/flutter#169298)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2025

575940144 Initialize default-flavor in FlutterCommand, adds integ…

cef9b67

…ration test. (flutter/flutter#169298)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 15, 2025

575940144 Initialize default-flavor in FlutterCommand, adds integ…

4b66be2

…ration test. (flutter/flutter#169298)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 16, 2025

575940144 Initialize default-flavor in FlutterCommand, adds integ…

67d0f97

…ration test. (flutter/flutter#169298)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Initialize `default-flavor` in `FlutterCommand`, adds integration test. #169298

Initialize `default-flavor` in `FlutterCommand`, adds integration test. #169298

Uh oh!

matanlurey commented May 22, 2025

Uh oh!

bkonyi May 22, 2025

Uh oh!

matanlurey May 22, 2025

Uh oh!

vashworth May 23, 2025

Uh oh!

matanlurey May 23, 2025

Uh oh!

bkonyi left a comment

Uh oh!

vashworth left a comment

Uh oh!

Uh oh!

matanlurey commented May 28, 2025

Uh oh!

Uh oh!

Initialize default-flavor in FlutterCommand, adds integration test. #169298

Initialize default-flavor in FlutterCommand, adds integration test. #169298

Uh oh!

Conversation

matanlurey commented May 22, 2025

Uh oh!

bkonyi May 22, 2025

Choose a reason for hiding this comment

Uh oh!

matanlurey May 22, 2025

Choose a reason for hiding this comment

Uh oh!

vashworth May 23, 2025

Choose a reason for hiding this comment

Uh oh!

matanlurey May 23, 2025

Choose a reason for hiding this comment

Uh oh!

bkonyi left a comment

Choose a reason for hiding this comment

Uh oh!

vashworth left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

matanlurey commented May 28, 2025

Uh oh!

Uh oh!

Initialize `default-flavor` in `FlutterCommand`, adds integration test. #169298

Initialize `default-flavor` in `FlutterCommand`, adds integration test. #169298