Fix inconsistently suffixed macOS flavored bundle directory #127997

arnemolland · 2023-05-31T22:19:46Z

The current implementation of macOS flavor support (#119564) assumes a bundle directory that differs from both the iOS implementation and the official documentation. The documentation instructs developers to suffix their Xcode build configurations with -<flavor>, but the implementation assumes a space:

flutter/packages/flutter_tools/lib/src/macos/application_package.dart

Lines 174 to 178 in 5fd9ef4

    
           String bundleDirectory(BuildInfo buildInfo) { 
        
             return sentenceCase(buildInfo.mode.cliName) + (buildInfo.flavor != null 
        
               ? ' ${sentenceCase(buildInfo.flavor!)}' 
        
               : ''); 
        
           }

Whereas the iOS implementation, which is the reference for the docs, assumes a -<flavor> suffix:

flutter/packages/flutter_tools/lib/src/ios/xcodeproj.dart

Lines 482 to 488 in a257efc

    
             static String expectedBuildConfigurationFor(BuildInfo buildInfo, String scheme) { 
        
               final String baseConfiguration = _baseConfigurationFor(buildInfo); 
        
               if (buildInfo.flavor == null) { 
        
                 return baseConfiguration; 
        
               } 
        
               return '$baseConfiguration-$scheme'; 
        
             }

This change replaces the empty space with the - character which is in line with the documentation and iOS implementation, as well as removing the sentence-casing applied to the flavor name; every bundle built with a flavor keeps the original flavor name in its filename.

List which issues are fixed by this PR. You must list at least one issue.
#122684.

If you had to change anything in the flutter/tests repo, include a link to the migration guide as per the breaking change policy.

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.

flutter-dashboard · 2023-05-31T22:19:50Z

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat (don't just cc him here, he won't see it! He's on Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

JasCodes · 2023-06-03T09:24:45Z

@goderbauer looks like pretty straight forward, any plans to review merge this?

JasCodes · 2023-06-09T15:46:36Z

Any update please?

Signed-off-by: Arne Molland <[email protected]>

ryanduffyne · 2023-06-14T13:32:11Z

Has there been any movement on this change. It seems pretty simple and would be a huge quality of life upgrade for developers. Currently the only way I can run the macos version of the app is through xcode and that is annoying. I don't like to have to document this for other developers as an exception to the rule for how to run the app during development.

arnemolland · 2023-06-14T22:34:36Z

Has there been any movement on this change. It seems pretty simple and would be a huge quality of life upgrade for developers. Currently the only way I can run the macos version of the app is through xcode and that is annoying. I don't like to have to document this for other developers as an exception to the rule for how to run the app during development.

Hoping to get a review on this shortly, but it doesn’t look like a team member has particular ownership looking at the issue yet.

cc @goderbauer, @christopherfujino

christopherfujino · 2023-06-14T22:38:49Z

Has there been any movement on this change. It seems pretty simple and would be a huge quality of life upgrade for developers. Currently the only way I can run the macos version of the app is through xcode and that is annoying. I don't like to have to document this for other developers as an exception to the rule for how to run the app during development.

Hoping to get a review on this shortly, but it doesn’t look like a team member has particular ownership looking at the issue yet.

Whoops, missed this in tool PR review last week. Looking now.

christopherfujino

This looks good to me. However, I wonder if this would be a breaking change. @cbracken WDYT?

ryanduffyne · 2023-06-14T22:57:21Z

Probably to the people who took time to try to hack around it. Get Outlook for iOS<https://aka.ms/o0ukef>

…

________________________________ From: Christopher Fujino ***@***.***> Sent: Wednesday, June 14, 2023 5:52:02 PM To: flutter/flutter ***@***.***> Cc: Duffy, Ryan ***@***.***>; Comment ***@***.***> Subject: Re: [flutter/flutter] Fix inconsistently suffixed macOS flavored bundle directory (PR #127997) @christopherfujino commented on this pull request. This looks good to me. However, I wonder if this would be a breaking change. @cbracken<https://urldefense.com/v3/__https://github.com/cbracken__;!!A69Ausm6DtA!aQCyxJbOXxT2IVl2Z2_HwVm6BAZ-191s0_vftHw2nDpQEKt0yZfrylAcJTSruKYbMzTz-hO8YMHzvB5M9mpp0WuMkgDS6A$> WDYT? — Reply to this email directly, view it on GitHub<https://urldefense.com/v3/__https://github.com/flutter/flutter/pull/127997*pullrequestreview-1480418493__;Iw!!A69Ausm6DtA!aQCyxJbOXxT2IVl2Z2_HwVm6BAZ-191s0_vftHw2nDpQEKt0yZfrylAcJTSruKYbMzTz-hO8YMHzvB5M9mpp0Wv5MPptKA$>, or unsubscribe<https://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/ACLYTY7EGRB5IBNZOAMNXSTXLI6BFANCNFSM6AAAAAAYWCU7ZY__;!!A69Ausm6DtA!aQCyxJbOXxT2IVl2Z2_HwVm6BAZ-191s0_vftHw2nDpQEKt0yZfrylAcJTSruKYbMzTz-hO8YMHzvB5M9mpp0WsiAmiLiA$>. You are receiving this because you commented.Message ID: ***@***.***>

cbracken · 2023-06-14T23:10:38Z

Yep this will be a breaking change, but given that we haven't officially announced flavours support (the device lab test was broken and was reverted while still in bringup mode), I think that's fine.

Thanks for CCing me. Taking a look.

I wonder if there's a way to get auto cc'ed on macOS-specific tool changes. There's an email-based patch monitoring tool I use; will see if that allows path-based filters. Will also see if there's a reasonable set of paths we can use for the GitHub bot to auto-tag these with the platform where relevant, if it's not too fragile.

cbracken

christopherfujino · 2023-06-14T23:22:22Z

Will also see if there's a reasonable set of paths we can use for the GitHub bot to auto-tag these with the platform where relevant, if it's not too fragile.

@cbracken If you decide on the paths you're interested in, adding entries to https://github.com/flutter/flutter/blob/master/.github/labeler.yml will enable auto-labeling.

christopherfujino

LGTM

…lutter/flutter#127997)

flutter/flutter@95be76a...b0188cd 2023-06-15 [email protected] [web] Pass creation params to the platform view factory (flutter/flutter#128146) 2023-06-15 [email protected] [flutter_tools] cache flutter sdk version to disk (flutter/flutter#124558) 2023-06-14 [email protected] Fix inconsistently suffixed macOS flavored bundle directory (flutter/flutter#127997) 2023-06-14 [email protected] Update golden tests for material (flutter/flutter#128839) 2023-06-14 [email protected] Update getChildrenSummaryTree to handle Diagnosticable as input. (flutter/flutter#128833) 2023-06-14 [email protected] Improve the error message for non-normalized constraints (flutter/flutter#127906) 2023-06-14 [email protected] ContextAction.isEnabled needs a context (flutter/flutter#127721) 2023-06-14 [email protected] Remove temporary default case for PointerSignalKind (flutter/flutter#128900) 2023-06-14 [email protected] Respect allowlisted count of leaks. (flutter/flutter#128823) 2023-06-14 [email protected] Unpin flutter_plugin_android_lifecycle (flutter/flutter#128898) 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 [email protected],[email protected],[email protected] 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://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

…lutter/flutter#127997)

flutter-dashboard bot added the tool Affects the "flutter" command-line tool. See also t: labels. label May 31, 2023

github-actions bot removed the tool Affects the "flutter" command-line tool. See also t: labels. label May 31, 2023

arnemolland force-pushed the macos-flavor-bundle-path branch 2 times, most recently from 21143ee to 4f8a23f Compare May 31, 2023 22:58

flutter-dashboard bot added the tool Affects the "flutter" command-line tool. See also t: labels. label May 31, 2023

arnemolland force-pushed the macos-flavor-bundle-path branch from 4f8a23f to 234cc12 Compare May 31, 2023 23:00

github-actions bot removed the tool Affects the "flutter" command-line tool. See also t: labels. label May 31, 2023

arnemolland force-pushed the macos-flavor-bundle-path branch from 234cc12 to 2f5bb33 Compare June 1, 2023 10:39

goderbauer added the tool Affects the "flutter" command-line tool. See also t: labels. label Jun 1, 2023

arnemolland force-pushed the macos-flavor-bundle-path branch from 2f5bb33 to 058d385 Compare June 2, 2023 07:53

AngeloAvv mentioned this pull request Jun 3, 2023

macOS desktop support AngeloAvv/flutter_flavorizr#10

Closed

arnemolland force-pushed the macos-flavor-bundle-path branch from 058d385 to 6ffde8a Compare June 10, 2023 20:56

Fix invalid macOS flavored bundle directory

abe4777

Signed-off-by: Arne Molland <[email protected]>

arnemolland force-pushed the macos-flavor-bundle-path branch from 6ffde8a to abe4777 Compare June 14, 2023 06:47

Merge branch 'master' into macos-flavor-bundle-path

fce9c96

christopherfujino reviewed Jun 14, 2023

View reviewed changes

cbracken approved these changes Jun 14, 2023

View reviewed changes

christopherfujino approved these changes Jun 14, 2023

View reviewed changes

christopherfujino added the autosubmit Merge PR when tree becomes green via auto submit App label Jun 14, 2023

auto-submit bot merged commit 6d2b5ea into flutter:master Jun 14, 2023

engine-flutter-autoroll mentioned this pull request Jun 15, 2023

Roll Flutter from 95be76ab7e3d to 3246808cd26e (9 revisions) flutter/packages#4218

Closed

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

6d2b5ea Fix inconsistently suffixed macOS flavored bundle directory (f…

7a7aef1

…lutter/flutter#127997)

engine-flutter-autoroll mentioned this pull request Jun 15, 2023

Roll Flutter from 95be76ab7e3d to b0188cd18274 (10 revisions) flutter/packages#4221

Merged

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

6d2b5ea Fix inconsistently suffixed macOS flavored bundle directory (f…

d7da840

…lutter/flutter#127997)

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

6d2b5ea Fix inconsistently suffixed macOS flavored bundle directory (f…

3c90c03

…lutter/flutter#127997)

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

6d2b5ea Fix inconsistently suffixed macOS flavored bundle directory (f…

af6d421

…lutter/flutter#127997)

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

6d2b5ea Fix inconsistently suffixed macOS flavored bundle directory (f…

c648713

…lutter/flutter#127997)

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

6d2b5ea Fix inconsistently suffixed macOS flavored bundle directory (f…

f4b43dc

…lutter/flutter#127997)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix inconsistently suffixed macOS flavored bundle directory #127997

Fix inconsistently suffixed macOS flavored bundle directory #127997

Uh oh!

arnemolland commented May 31, 2023 •

edited

Loading

Uh oh!

flutter-dashboard bot commented May 31, 2023

Uh oh!

JasCodes commented Jun 3, 2023

Uh oh!

JasCodes commented Jun 9, 2023

Uh oh!

ryanduffyne commented Jun 14, 2023

Uh oh!

arnemolland commented Jun 14, 2023

Uh oh!

christopherfujino commented Jun 14, 2023

Uh oh!

christopherfujino left a comment

Uh oh!

ryanduffyne commented Jun 14, 2023 via email

Uh oh!

cbracken commented Jun 14, 2023

Uh oh!

cbracken left a comment

Uh oh!

christopherfujino commented Jun 14, 2023

Uh oh!

christopherfujino left a comment

Uh oh!

Uh oh!

	String bundleDirectory(BuildInfo buildInfo) {
	return sentenceCase(buildInfo.mode.cliName) + (buildInfo.flavor != null
	? ' ${sentenceCase(buildInfo.flavor!)}'
	: '');
	}

	static String expectedBuildConfigurationFor(BuildInfo buildInfo, String scheme) {
	final String baseConfiguration = _baseConfigurationFor(buildInfo);
	if (buildInfo.flavor == null) {
	return baseConfiguration;
	}
	return '$baseConfiguration-$scheme';
	}

Fix inconsistently suffixed macOS flavored bundle directory #127997

Fix inconsistently suffixed macOS flavored bundle directory #127997

Uh oh!

Conversation

arnemolland commented May 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

flutter-dashboard bot commented May 31, 2023

Uh oh!

JasCodes commented Jun 3, 2023

Uh oh!

JasCodes commented Jun 9, 2023

Uh oh!

ryanduffyne commented Jun 14, 2023

Uh oh!

arnemolland commented Jun 14, 2023

Uh oh!

christopherfujino commented Jun 14, 2023

Uh oh!

christopherfujino left a comment

Choose a reason for hiding this comment

Uh oh!

ryanduffyne commented Jun 14, 2023 via email

Uh oh!

cbracken commented Jun 14, 2023

Uh oh!

cbracken left a comment

Choose a reason for hiding this comment

Uh oh!

christopherfujino commented Jun 14, 2023

Uh oh!

christopherfujino left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

arnemolland commented May 31, 2023 •

edited

Loading