Get flavor/scheme in assemble command from the build configuration #162907

vashworth · 2025-02-07T21:28:01Z

This moves the logic for FLUTTER_APP_FLAVOR into flutter assemble, so that it also works when ran through Xcode and not just through the Flutter CLI.

However, there's no definitive way to get the the flavor/scheme in flutter assemble, so this makes a best effort to get it by parsing it out of the CONFIGURATION. CONFIGURATION should have the name of the scheme in it, although, this is only semi-enforced, so may not always work. If it's unable to get the scheme name from the CONFIGURATION, it falls back to using the FLAVOR environment variable, which is set by the Flutter CLI and used currently.

Verified Mac_ios flavors_test_ios passes: https://ci.chromium.org/ui/p/flutter/builders/prod.shadow/Mac_ios%20flavors_test_ios/7/overview

Verified Mac flavors_test_macos passes: https://ci.chromium.org/ui/p/flutter/builders/try.shadow/Mac%20flavors_test_macos/2/overview

Fixes #155951.

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.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

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

…xcode_workaround

matanlurey

A few comments/questions. In general LGTM.

matanlurey · 2025-02-11T22:14:49Z

dev/devicelab/bin/tasks/flavors_test_ios.dart

+Future<TaskResult> _testFlavorWhenBuiltFromXcode(String projectDir) async {
+  final Device device = await devices.workingDevice;
+  await inDirectory(projectDir, () async {
+    await flutter('clean');


Just curious, why was this needed?

If you know, please add a comment.

It was to ensure the app bundle was left over from the previous parts of the test. I changed it to just delete the app bundle since that's faster the flutter clean

matanlurey · 2025-02-11T22:16:36Z

packages/flutter_tools/bin/xcode_backend.dart

      '-dTargetFile=$targetPath',
      '-dBuildMode=$buildMode',
      if (environment['FLAVOR'] != null) '-dFlavor=${environment['FLAVOR']}',
+      '-dConfiguration=${environment['CONFIGURATION']}',


Is threre a reason this isn't similar to line 442; that is, if this is null, we would print=null, which I'm not sure is intended (if it is, probably deserves a comment)

Yes, so FLAVOR is set by the Flutter CLI in Flutter/Generated.xcconfig when the --flavor is used, so may not always be present. CONFIGURATION is provided by Xcode/xcodebuild and should always be present. I'll add a comment explaining why FLAVOR may be null

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

packages/flutter_tools/lib/src/xcode_project.dart

matanlurey

LGTM, but I'll defer final approval to Jenn and Ben.

bkonyi · 2025-02-19T19:17:41Z

dev/devicelab/bin/tasks/flavors_test_ios.dart

+
+  // Delete app bundle before build to ensure checks below do not use previously
+  // built bundle.
+  final String appPath = '$projectDir/$buildDir/$configuration-iphoneos/$productName.app';


Nit: should we consider using path.join(...) here instead of building the path manually?

…ation (flutter/flutter#162907)

…#163737)  This request is a subset of #157871 and follows up #162907. #162907 actually fixed behaviour of building with native tooling not only for iOS/macOS, but also for Android builds too: now on master, if you start build with `gradle` instead of `flutter build ...` – you also get the correct behaviour and `appFlavor` won't be null in runtime. Tests in this PR will check exactly this behavior. Another diff is the change in the method of obtaining flavor at runtime inside test project. Before this change, method channels were used for this, after – `appFlavor` constant. Both methods do more or less the same thing right now, but they may diverge in future, so I guess this is the right way to check correctness here. Also, this change was requested and approved by Andrew in #157871 (comment) issue for checklist: #155951 New test was tested here: https://ci.chromium.org/ui/p/flutter/builders/try/Linux_pixel_7pro%20flavors_test/63/overview ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [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 documentation (doc comments with `///`). - [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. If you need help, consider asking for advice on the #hackers-new channel on [Discord].  [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md

…ation (flutter/flutter#162907)

Gustl22 · 2025-07-15T11:30:13Z

I know there don't exist flavors on web, but some use the FLUTTER_APP_FLAVOR to set the flavor.dart::appFlavor variable to use it in the code internally:
https://stackoverflow.com/a/77576947/5164462

So it would be good to have an option on web to set this variable (e.g. via --flavor option), which is only available on flutter run -d chrome but not on flutter build web.

vashworth added 3 commits February 6, 2025 16:47

Get flavor from CONFIGURATION

122ebf2

more tests, fix environment lookup

e4c03b6

add more tests

99083c6

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

vashworth added 4 commits February 7, 2025 15:35

fix macos configuration

40ed8da

remove comma

aa991d9

also match on space separated flavors

7e0da38

use FLAVOR env var as a fallback

e964b47

github-actions bot added the team-ios Owned by iOS platform team label Feb 10, 2025

vashworth added 6 commits February 10, 2025 10:15

add FLAVOR back

a1843ba

formatting

1417fa3

Merge remote-tracking branch 'upstream/master' into flavors_run_from_…

5b4a9e2

…xcode_workaround

Fix merge conflicts

9285d74

add integration test

e004084

change test name to be more accurate

3f4ac26

vashworth mentioned this pull request Feb 11, 2025

[tool] Building flavors with native tooling #157871

Closed

9 tasks

vashworth added 2 commits February 11, 2025 11:08

add macos integration test

53bbf4c

fix typo

b9d0549

vashworth marked this pull request as ready for review February 11, 2025 21:37

vashworth requested a review from matanlurey as a code owner February 11, 2025 21:37

vashworth requested review from bkonyi and jmagman February 11, 2025 21:37

matanlurey reviewed Feb 11, 2025

View reviewed changes

apply feedback

c72a9dc

matanlurey reviewed Feb 12, 2025

View reviewed changes

matanlurey approved these changes Feb 12, 2025

View reviewed changes

vashworth removed the request for review from jmagman February 12, 2025 22:52

bkonyi approved these changes Feb 19, 2025

View reviewed changes

jmagman approved these changes Feb 19, 2025

View reviewed changes

vashworth added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 19, 2025

engine-flutter-autoroll mentioned this pull request Feb 20, 2025

Roll Flutter from e8f34a9eea90 to 7df3f8fc06e3 (125 revisions) flutter/packages#8667

Closed

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

11b8315

…ation (flutter/flutter#162907)

engine-flutter-autoroll mentioned this pull request Feb 20, 2025

Roll Flutter from e8f34a9eea90 to 5ce2ad91583c (126 revisions) flutter/packages#8668

Closed

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

8b727b0

…ation (flutter/flutter#162907)

engine-flutter-autoroll mentioned this pull request Feb 20, 2025

Roll Flutter from e8f34a9eea90 to 2a6b0158b229 (127 revisions) flutter/packages#8669

Closed

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

b8524da

…ation (flutter/flutter#162907)

engine-flutter-autoroll mentioned this pull request Feb 21, 2025

Roll Flutter from 39b4951f8f0b to b205b6b48a2e (52 revisions) flutter/packages#8670

Closed

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

5dc37f1

…ation (flutter/flutter#162907)

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

03bfc59

…ation (flutter/flutter#162907)

engine-flutter-autoroll mentioned this pull request Feb 21, 2025

Roll Flutter from 39b4951f8f0b to 8bc9d5271844 (53 revisions) flutter/packages#8671

Closed

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

9162e87

…ation (flutter/flutter#162907)

engine-flutter-autoroll mentioned this pull request Feb 21, 2025

Roll Flutter from 39b4951f8f0b to 99b2c1adaa5a (54 revisions) flutter/packages#8672

Closed

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

c45fb8a

…ation (flutter/flutter#162907)

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

90c48a7

…ation (flutter/flutter#162907)

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

1e731da

…ation (flutter/flutter#162907)

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

769d2cf

…ation (flutter/flutter#162907)

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

b35d5b1

…ation (flutter/flutter#162907)

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

55ef1e2

…ation (flutter/flutter#162907)

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

918ad33

…ation (flutter/flutter#162907)

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

828f1cb

…ation (flutter/flutter#162907)

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

69ab99d

…ation (flutter/flutter#162907)

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

d1c1ad0

…ation (flutter/flutter#162907)

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

e07bf11

…ation (flutter/flutter#162907)

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

cf77abe

…ation (flutter/flutter#162907)

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

c9af784

…ation (flutter/flutter#162907)

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

a4a627a

…ation (flutter/flutter#162907)

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

49e0f87

…ation (flutter/flutter#162907)

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

8d100a6 Get flavor/scheme in assemble command from the build configur…

65a0830

…ation (flutter/flutter#162907)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Get flavor/scheme in assemble command from the build configuration #162907

Get flavor/scheme in assemble command from the build configuration #162907

Uh oh!

vashworth commented Feb 7, 2025 •

edited

Loading

Uh oh!

matanlurey left a comment

Uh oh!

matanlurey Feb 11, 2025

Uh oh!

vashworth Feb 11, 2025

Uh oh!

matanlurey Feb 11, 2025

Uh oh!

vashworth Feb 11, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matanlurey left a comment

Uh oh!

bkonyi Feb 19, 2025

Uh oh!

Gustl22 commented Jul 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Get flavor/scheme in assemble command from the build configuration #162907

Get flavor/scheme in assemble command from the build configuration #162907

Uh oh!

Conversation

vashworth commented Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

matanlurey left a comment

Choose a reason for hiding this comment

Uh oh!

matanlurey Feb 11, 2025

Choose a reason for hiding this comment

Uh oh!

vashworth Feb 11, 2025

Choose a reason for hiding this comment

Uh oh!

matanlurey Feb 11, 2025

Choose a reason for hiding this comment

Uh oh!

vashworth Feb 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matanlurey left a comment

Choose a reason for hiding this comment

Uh oh!

bkonyi Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

Gustl22 commented Jul 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

vashworth commented Feb 7, 2025 •

edited

Loading