Check Xcode build setting FULL_PRODUCT_NAME for bundle name by jmagman · Pull Request #55799 · flutter/flutter

jmagman · 2020-04-28T00:23:43Z

Another attempt at #46838.

Description

Users who update their app's display name from Xcode's UI (what gets shown on the home screen under the icon) can no longer flutter run. Xcode sets PRODUCT_NAME to whatever is input to General > Display Name, and that's used to name the My App.app app product (spaces and all).

Don't hardcode the product name to Runner.app during a run or install. Get it from Xcode build setting FULL_PRODUCT_NAME.
Fix the logging regex to handle the actual product name instead of Runner.

This will still work for "legacy" apps called Runner.app or with a display name hard-coded in the Info.plist.

Related Issues

Fixes #41793
See also #9767 (comment)

Tests

Updated:

ios_device_start_nonprebuilt_test
mac_test
simulators_test
project_test

Update gallery integration test to set the name in the project instead of the Info.plist (the default way Xcode projects and macOS Flutter Xcode projects are named).

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
I signed the [CLA].
I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
I read the [Tree Hygiene] wiki page, which explains my responsibilities.
I updated/added relevant documentation (doc comments with ///).
All existing and new tests are passing.
The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
I am willing to follow-up on review comments in a timely manner.

Breaking Change

No, no existing tests failed, so this is not a breaking change.
Yes, this is a breaking change. If not, delete the remainder of this section.

christopherfujino · 2020-04-30T16:20:53Z

@jmagman I remember reviewing #46838. Can you give me the tl;dr on why it was reverted (was it because of basic_material_app_ios__compile?) and the differences in this PR?

jmagman

@jmagman I remember reviewing #46838. Can you give me the tl;dr on why it was reverted (was it because of basic_material_app_ios__compile?) and the differences in this PR?

Yes, sorry meant to do this!

There are three main changes:

I renamed the Flutter Gallery integration test in Xcode's UI (details inline in comment).
The pre-iOS 11 simulator logs need to be parsed to handle older versions of log lines. This caused the original revert. (details inline in comment).
The creation template has not been changed. That was the riskiest part of #46838, and upon further thought, isn't really necessary. We can leave as-is with the name being set in the Info.plist, but make sure we handle if users change the Display Name from Xcode's UI (the way you're really supposed to do this).

jmagman · 2020-04-30T17:24:49Z

I renamed the Flutter Gallery integration test in Xcode's UI, which names in the project, not the Info.plist.
This project is used in Cirrus and devicelab tests, any if it can flutter run with a "Flutter Gallery.app" instead of "Runner.app" then it proves this works.

Caught one! https://cirrus-ci.com/task/5961945742311424?command=main#L27

jmagman · 2020-04-30T17:35:09Z

The last attempt at this PR was reverted because of a g3 test that checked the format of a simulator log from some older iOS SDK. I added that test at Add iOS simulator log parse test #55808, and it passes in this PR.

This code is filtering out log lines that come from an app other than this one (category doesn't match the app name). The previous regex assumed the app name was one word (Runner), but now we don't know how many words it will be, and it's hard to separate it out from the hostname, plus we don't know how many tokens the date will have since it's different formats across iOS SDKs. So now it checks if anything after the date (green match below) ENDS in the app name instead of exactly matches.

This is a great comment, very clear (and the screenshot helps as well). That being said, I was completely bewildered from just reading the code. Do you think you can add more context to the comments here (especially why you're using .endsWith()?

category != _appName && !category.endsWith(' $_appName') is redundant.

christopherfujino

LGTM, with a nit about additional comments about the log parsing change.

jonahwilliams · 2020-04-30T21:59:20Z

nit: avoid getters that do work: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#getters-feel-faster-than-methods

The way we usually set this up is to have a private _ hostAppBundleName, and then a _compute HostAppBundleName that initializes the field:

int _foo; int _computeFoo(); int get foo => _foo ??= _computeFoo(); ``

Will swap productBundleIdentifier too.

… app during flutter run

jonahwilliams

LGTM

stuartmorgan-g · 2020-05-05T20:42:49Z

Sorry for not reviewing; I was OOO Thu-Mon

jmagman self-assigned this Apr 28, 2020

fluttergithubbot added c: contributor-productivity Team-specific productivity, code health, technical debt. tool Affects the "flutter" command-line tool. See also t: labels. work in progress; do not review labels Apr 28, 2020

googlebot added the cla: yes label Apr 28, 2020

jmagman added t: xcode "xcodebuild" on iOS and general Xcode project management and removed cla: yes labels Apr 28, 2020

googlebot added the cla: yes label Apr 28, 2020

jmagman force-pushed the handle-non-runner branch from 18e4c0c to cff5437 Compare April 28, 2020 01:02

jmagman mentioned this pull request Apr 28, 2020

Add iOS simulator log parse test #55808

Merged

9 of 10 tasks

jmagman force-pushed the handle-non-runner branch 2 times, most recently from daea0f6 to 2f88ead Compare April 29, 2020 20:55

jmagman marked this pull request as ready for review April 29, 2020 20:56

jmagman removed the work in progress; do not review label Apr 29, 2020

jmagman requested review from christopherfujino and stuartmorgan-g April 29, 2020 21:06

jmagman commented Apr 30, 2020

View reviewed changes

jmagman force-pushed the handle-non-runner branch from e7d8b63 to 85013ff Compare April 30, 2020 18:09

christopherfujino approved these changes Apr 30, 2020

View reviewed changes

jonahwilliams reviewed Apr 30, 2020

View reviewed changes

jmagman added 4 commits April 30, 2020 19:33

Check Xcode build setting FULL_PRODUCT_NAME for the name of the built…

b6f74a1

… app during flutter run

Change flutter gallery name

04b6e2c

Reset simulator logging comment

fe435ed

Runner => Flutter Gallery

ab8bf1b

jmagman force-pushed the handle-non-runner branch from 85013ff to ab8bf1b Compare May 1, 2020 03:05

Review edits

2c59c91

jonahwilliams approved these changes May 1, 2020

View reviewed changes

jmagman merged commit c8c55b4 into flutter:master May 4, 2020

jmagman deleted the handle-non-runner branch May 4, 2020 18:31

jmagman mentioned this pull request May 12, 2020

buggy/messy deploy on iOS with multiple schemas/target #14648

Closed

jmagman mentioned this pull request Jul 27, 2020

Running for the iOS simulator with flavor-specific app name fails with "Could not find the built application bundle at" #62288

Open

jmagman added the platform-ios iOS applications specifically label Aug 21, 2020

jmagman mentioned this pull request Dec 12, 2020

Cannot run flavored application on iOS Device because flutter uses one certificate for project #46879

Open

github-actions Bot locked as resolved and limited conversation to collaborators Aug 21, 2021

Navigation Menu

Repository navigation

Check Xcode build setting FULL_PRODUCT_NAME for bundle name - #55799

Check Xcode build setting FULL_PRODUCT_NAME for bundle name#55799
jmagman merged 5 commits into
flutter:masterfrom
jmagman:handle-non-runner

jmagman commented Apr 28, 2020 •

edited

Loading

Uh oh!

christopherfujino commented Apr 30, 2020

Uh oh!

jmagman left a comment

Uh oh!

jmagman Apr 30, 2020

Uh oh!

jmagman Apr 30, 2020

Uh oh!

jmagman Apr 30, 2020

Uh oh!

christopherfujino Apr 30, 2020 •

edited

Loading

Uh oh!

jmagman May 1, 2020

Uh oh!

christopherfujino left a comment

Uh oh!

jonahwilliams Apr 30, 2020

Uh oh!

jmagman May 1, 2020

Uh oh!

jonahwilliams left a comment

Uh oh!

stuartmorgan-g commented May 5, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

jmagman commented Apr 28, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Tests

Checklist

Breaking Change

Uh oh!

christopherfujino commented Apr 30, 2020

Uh oh!

jmagman left a comment

Choose a reason for hiding this comment

Uh oh!

jmagman Apr 30, 2020

Choose a reason for hiding this comment

Uh oh!

jmagman Apr 30, 2020

Choose a reason for hiding this comment

Uh oh!

jmagman Apr 30, 2020

Choose a reason for hiding this comment

Uh oh!

christopherfujino Apr 30, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jmagman May 1, 2020

Choose a reason for hiding this comment

Uh oh!

christopherfujino left a comment

Choose a reason for hiding this comment

Uh oh!

jonahwilliams Apr 30, 2020

Choose a reason for hiding this comment

Uh oh!

jmagman May 1, 2020

Choose a reason for hiding this comment

Uh oh!

jonahwilliams left a comment

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g commented May 5, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

jmagman commented Apr 28, 2020 •

edited

Loading

christopherfujino Apr 30, 2020 •

edited

Loading