Log XCResult before other build issues by cyanglaz · Pull Request #100787 · flutter/flutter

cyanglaz · 2022-03-25T18:54:13Z

Always log XCResult first so it won't get lost if there are other issues.

Also updated the order issues are detected.
Some sample error messages after the change are:

no provisioning profile:

Error (Xcode): "Runner" requires a provisioning profile. Select a provisioning profile in the Signing & Capabilities editor.


════════════════════════════════════════════════════════════════════════════════
No Provisioning Profile was found for your project's Bundle Identifier or your 
device. You can create a new Provisioning Profile for your project in Xcode for 
your team by:
  1- Open the Flutter project's Xcode target with
       open ios/Runner.xcworkspace
  2- Select the 'Runner' project in the navigator then the 'Runner' target
     in the project settings
  3- Make sure a 'Development Team' is selected under Signing & Capabilities > Team. 
     You may need to:
         - Log in with your Apple ID in Xcode first
         - Ensure you have a valid unique Bundle ID
         - Register your device with your Apple Developer Account
         - Let Xcode automatically provision a profile for your app
  4- Build or run your project again

It's also possible that a previously installed app with the same Bundle 
Identifier was signed with a different certificate.

For more information, please visit:
  https://flutter.dev/docs/get-started/install/macos#deploy-to-ios-devices

Or run on an iOS simulator without code signing
════════════════════════════════════════════════════════════════════════════════

no development team

Error (Xcode): Signing for "Runner" requires a development team. Select a development team in the Signing & Capabilities editor.


════════════════════════════════════════════════════════════════════════════════
Building a deployable iOS app requires a selected Development Team with a 
Provisioning Profile. Please ensure that a Development Team is selected by:
  1- Open the Flutter project's Xcode target with
       open ios/Runner.xcworkspace
  2- Select the 'Runner' project in the navigator then the 'Runner' target
     in the project settings
  3- Make sure a 'Development Team' is selected under Signing & Capabilities > Team. 
     You may need to:
         - Log in with your Apple ID in Xcode first
         - Ensure you have a valid unique Bundle ID
         - Register your device with your Apple Developer Account
         - Let Xcode automatically provision a profile for your app
  4- Build or run your project again

For more information, please visit:
  https://flutter.dev/docs/get-started/install/macos#deploy-to-ios-devices

Or run on an iOS simulator without code signing
════════════════════════════════════════════════════════════════════════════════

It appears that your application still contains the default signing identifier.
Try replacing 'com.example' with your signing id in Xcode:
  open ios/Runner.xcworkspace
Encountered error while building for device.

Fixes #100723

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.

jmagman · 2022-03-28T16:58:37Z

packages/flutter_tools/lib/src/ios/mac.dart

What happens when there's provisioning profile in the error? Looks like _handleXCResultIssue and the noProvisioningProfileInstruction check below both output?

What do you mean? The _handleXCResultIssue has a special case to handles general provisioning profile issues and have some special logs for it. It doesn't print the noProvisioningProfileInstruction. The later check (result.stdout?.contains("Xcode couldn't find a provisioning profile matching") would print an instruction for user if they don't have a provisioning profile in the project.

Did you mean we can add the special "no provisioning profile" case check in _handleXCResultIssue?

Before your change, if there was a provisioning profile issue it would print this and return:

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

Lines 590 to 597 in c01cbd2

if (xcodeBuildExecution != null

&& xcodeBuildExecution.environmentType == EnvironmentType.physical

&& (result.stdout?.contains('BCEROR') ?? false)

// May need updating if Xcode changes its outputs.

&& (result.stdout?.contains("Xcode couldn't find a provisioning profile matching") ?? false)) {

logger.printError(noProvisioningProfileInstruction, emphasis: true);

return;

}

Now, it prints

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

Lines 748 to 756 in c01cbd2

if (issue.message != null && issue.message!.toLowerCase().contains('provisioning profile')) {

logger.printError('');

logger.printError('It appears that there was a problem signing your application prior to installation on the device.');

logger.printError('');

logger.printError('Verify that the Bundle Identifier in your project is your signing id in Xcode');

logger.printError(' open ios/Runner.xcworkspace');

logger.printError('');

logger.printError("Also try selecting 'Product > Build' to fix the problem:");

}

and then the above. Unless I'm missing something.

What does that text together look like? Probably needs to be adjusted, or the one only printed if the xcresult wasn't created?

cyanglaz

@jmagman Updated per our offline discussion. PTAL.
I will update the PR description to reflect all the changes when the general idea of the PR is agreed.

cyanglaz · 2022-03-29T23:44:17Z

packages/flutter_tools/lib/src/ios/mac.dart

The noDevelopmentTeamInstruction is documented as a fallback message for signing issues. I do think it is a more proper user message + instructions. Let me know if you think otherwise. @jmagman

jmagman · 2022-03-29T23:48:22Z

Looks like there are some test failures

00:36 +1153 -1: test/general.shard/ios/mac_test.dart: Diagnose Xcode build failure No development team shows message [E]                                                                               
  Expected: contains 'Building a deployable iOS app requires a selected Development Team with a \n'
              'Provisioning Profile.'
    Actual: ''
  
  package:test_api                            expect
  test/general.shard/ios/mac_test.dart 317:7  main.<fn>.<fn>

packages/flutter_tools/lib/src/ios/mac.dart

jmagman · 2022-03-29T23:55:14Z

packages/flutter_tools/lib/src/ios/mac.dart

This seems like a better situation to use noDevelopmentTeamInstruction instead of message.toLowerCase().contains('provisioning profile') since it actually checks if you have DEVELOPMENT_TEAM or PROVISIONING_PROFILE set. Can we pipe the xcodeBuildExecution into the xcresult handler to do similar checking?

This is technically not part of handing xcresult. XCResult does detect this error by showing a message: Showing Recent Messages Signing for "Runner" requires a development team. Select a development team in the Signing & Capabilities editor.

How about move this part where we directly check the flags all the way above xcresult handling?

So the flow becomes:

Check DEVELOPMENT_TEAM and PROVISIONING_PROFILE flags.

Handle xcresults

Handle other issues with stdout.

This is technically not part of handing xcresult

I know, I meant, maybe it should be, the xcresult can print noDevelopmentTeamInstruction if, instead of just message.toLowerCase().contains('provisioning profile') it also checks the build settings?

Check DEVELOPMENT_TEAM and PROVISIONING_PROFILE flags.

Handle xcresults

Handle other issues with stdout.

I'm not following this, why would this one example be a special case where it's handled before the message is parsed?

I'm not following this, why would this one example be a special case where it's handled before the message is parsed?

So the "Check DEVELOPMENT_TEAM and PROVISIONING_PROFILE flag" can be done regardless if xcresult's parsing is successful or not. If this check is part of xcresult handling, it will not be run when xcresult is failed to parse. Or we do the same thing in xcresult handling as well as the fallback error handling when xcresult is failed to parse?

I'm not sure how you want to organize it 🙂 We should only print out the same error once, and include useful recovery suggestions where possible. There's currently fallback to string parsing if the result bundle fails to build, but maybe that never happens (or we should add Usage data about it to see).

jmagman · 2022-03-30T01:11:05Z

00:23 +142 -1: test/commands.shard/hermetic/build_ipa_test.dart: Extra error message for provision profile issue in xcresulb bundle. [E]                                                               
  Expected: contains 'It appears that there was a problem signing your application prior to installation on the device.'
    Actual: 'Action Required: You must set a build name and number in the pubspec.yaml file version field before submitting to the App Store.\n'
              'Semantic Issue (Xcode): Some Provisioning profile issue.\n'
              '\n'
              '════════════════════════════════════════════════════════════════════════════════\n'
              'Building a deployable iOS app requires a selected Development Team with a \n'
              'Provisioning Profile. Please ensure that a Development Team is selected by:\n'
              '  1- Open the Flutter project\'s Xcode target with\n'
              '       open ios/Runner.xcworkspace\n'
              '  2- Select the \'Runner\' project in the navigator then the \'Runner\' target\n'
              '     in the project settings\n'
              '  3- Make sure a \'Development Team\' is selected under Signing & Capabilities > Team. \n'
              '     You may need to:\n'
              '         - Log in with your Apple ID in Xcode first\n'
              '         - Ensure you have a valid unique Bundle ID\n'
              '         - Register your device with your Apple Developer Account\n'
              '         - Let Xcode automatically provision a profile for your app\n'
              '  4- Build or run your project again\n'
              '\n'
              'For more information, please visit:\n'
              '  [https://flutter.dev/docs/get-started/install/macos#deploy-to-ios-devices\n](https://flutter.dev/docs/get-started/install/macos#deploy-to-ios-devices%5cn)'
              '\n'
              'Or run on an iOS simulator without code signing\n'
              '════════════════════════════════════════════════════════════════════════════════\n'
              ''

jmagman · 2022-04-07T01:30:24Z

no development team
It appears that your application still contains the default signing identifier.
Try replacing 'com.example' with your signing id in Xcode:
open ios/Runner.xcworkspace
Encountered error while building for device.

It appears that your application still contains the default signing identifier.
Try replacing 'com.example' with your signing id in Xcode:
open ios/Runner.xcworkspace
Encountered error while building for device.

This is twice in the description. Is that a typo or did it actually print twice?

cyanglaz · 2022-04-07T16:26:45Z

no development team
It appears that your application still contains the default signing identifier.
Try replacing 'com.example' with your signing id in Xcode:
open ios/Runner.xcworkspace
Encountered error while building for device.

It appears that your application still contains the default signing identifier.
Try replacing 'com.example' with your signing id in Xcode:
open ios/Runner.xcworkspace
Encountered error while building for device.

This is twice in the description. Is that a typo or did it actually print twice?

It was a typo

jmagman

LGTM w/ minor nit

jmagman · 2022-04-07T19:20:22Z

packages/flutter_tools/lib/src/ios/mac.dart

If you make the local before the null check you won't need the !

Suggested change

if (issue.message == null) {

return _XCResultIssueHandlingResult(requiresProvisioningProfile: false, hasProvisioningProfileIssue: false);

}

// Add more error messages for flutter users for some special errors.

final String message = issue.message!;

// Add more error messages for flutter users for some special errors.

final String? message = issue.message;

if (issue.message == null) {

return _XCResultIssueHandlingResult(requiresProvisioningProfile: false, hasProvisioningProfileIssue: false);

}

fluttergithubbot · 2022-04-08T18:41:08Z

This pull request is not suitable for automatic merging in its current state.

The status or check suite Linux tool_tests_commands has failed. Please fix the issues identified (or deflake) before re-applying this label.
The status or check suite Linux web_long_running_tests_4_5 has failed. Please fix the issues identified (or deflake) before re-applying this label.
The status or check suite Mac build_tests_4_4 has failed. Please fix the issues identified (or deflake) before re-applying this label.
The status or check suite Mac tool_tests_commands has failed. Please fix the issues identified (or deflake) before re-applying this label.
The status or check suite Windows tool_tests_commands has failed. Please fix the issues identified (or deflake) before re-applying this label.
The status or check suite tool_tests-commands-linux has failed. Please fix the issues identified (or deflake) before re-applying this label.

cleanup cleanup re-arrange issues fix old tests some review fixes re-arrange messages tests remove unnecessary imort fix warnigns fix nits

fluttergithubbot · 2022-04-08T20:52:08Z

This pull request is not suitable for automatic merging in its current state.

The status or check suite Mac module_test_ios has failed. Please fix the issues identified (or deflake) before re-applying this label.

fluttergithubbot · 2022-04-08T21:27:08Z

This pull request is not suitable for automatic merging in its current state.

The status or check suite Google testing has failed. Please fix the issues identified (or deflake) before re-applying this label.

fluttergithubbot · 2022-04-08T22:57:08Z

This pull request is not suitable for automatic merging in its current state.

The status or check suite Linux tool_integration_tests_3_4 has failed. Please fix the issues identified (or deflake) before re-applying this label.

flutter-dashboard bot added the tool Affects the "flutter" command-line tool. See also t: labels. label Mar 25, 2022

cyanglaz requested a review from jmagman March 25, 2022 18:55

jmagman reviewed Mar 28, 2022

View reviewed changes

cyanglaz commented Mar 29, 2022

View reviewed changes

jmagman reviewed Mar 29, 2022

View reviewed changes

cyanglaz force-pushed the xcresult_print_early branch from 492cc2d to a70903c Compare April 7, 2022 00:26

cyanglaz requested a review from jmagman April 7, 2022 00:54

jmagman approved these changes Apr 7, 2022

View reviewed changes

cyanglaz force-pushed the xcresult_print_early branch from 6fa630e to cd8bd29 Compare April 8, 2022 17:39

cyanglaz added the waiting for tree to go green label Apr 8, 2022

fluttergithubbot removed the waiting for tree to go green label Apr 8, 2022

cyanglaz force-pushed the xcresult_print_early branch from cd8bd29 to 6fa630e Compare April 8, 2022 19:50

add test

cd4acce

cleanup cleanup re-arrange issues fix old tests some review fixes re-arrange messages tests remove unnecessary imort fix warnigns fix nits

cyanglaz force-pushed the xcresult_print_early branch from 6fa630e to cd4acce Compare April 8, 2022 19:51

cyanglaz added the waiting for tree to go green label Apr 8, 2022

fluttergithubbot removed the waiting for tree to go green label Apr 8, 2022

jmagman added the waiting for tree to go green label Apr 8, 2022

fluttergithubbot removed the waiting for tree to go green label Apr 8, 2022

jmagman mentioned this pull request Apr 8, 2022

Google testing fails on icon_map_generator Icon "Too few positional arguments: 2 required, 1 given." #101611

Closed

jmagman added the waiting for tree to go green label Apr 8, 2022

fluttergithubbot removed the waiting for tree to go green label Apr 8, 2022

cyanglaz added the waiting for tree to go green label Apr 8, 2022

fluttergithubbot merged commit 1755819 into flutter:master Apr 8, 2022

engine-flutter-autoroll mentioned this pull request Apr 8, 2022

Roll Flutter from 71d52f27fb12 to 1755819cb155 (2 revisions) flutter/packages#1456

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Apr 8, 2022

1755819 Log XCResult before other build issues (flutter/flutter#100787)

1cdff8b

engine-flutter-autoroll mentioned this pull request Apr 9, 2022

Roll Flutter from cae740b9032f to c14ca6d32112 (8 revisions) flutter/plugins#5216

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Apr 9, 2022

1755819 Log XCResult before other build issues (flutter/flutter#100787)

422b689

	if (xcodeBuildExecution != null
	&& xcodeBuildExecution.environmentType == EnvironmentType.physical
	&& (result.stdout?.contains('BCEROR') ?? false)
	// May need updating if Xcode changes its outputs.
	&& (result.stdout?.contains("Xcode couldn't find a provisioning profile matching") ?? false)) {
	logger.printError(noProvisioningProfileInstruction, emphasis: true);
	return;
	}

	if (issue.message != null && issue.message!.toLowerCase().contains('provisioning profile')) {
	logger.printError('');
	logger.printError('It appears that there was a problem signing your application prior to installation on the device.');
	logger.printError('');
	logger.printError('Verify that the Bundle Identifier in your project is your signing id in Xcode');
	logger.printError(' open ios/Runner.xcworkspace');
	logger.printError('');
	logger.printError("Also try selecting 'Product > Build' to fix the problem:");
	}

-  if (issue.message == null) {
-    return _XCResultIssueHandlingResult(requiresProvisioningProfile: false, hasProvisioningProfileIssue: false);
-  }
-  // Add more error messages for flutter users for some special errors.
-  final String message = issue.message!;
+  // Add more error messages for flutter users for some special errors.
+  final String? message = issue.message;
+  if (issue.message == null) {
+    return _XCResultIssueHandlingResult(requiresProvisioningProfile: false, hasProvisioningProfileIssue: false);
+  }

Conversation

cyanglaz commented Mar 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

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!

cyanglaz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jmagman commented Mar 29, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cyanglaz Mar 30, 2022 • 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 Mar 30, 2022 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jmagman commented Mar 30, 2022

Uh oh!

jmagman commented Apr 7, 2022

Uh oh!

cyanglaz commented Apr 7, 2022

Uh oh!

jmagman left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fluttergithubbot commented Apr 8, 2022

Uh oh!

fluttergithubbot commented Apr 8, 2022

Uh oh!

fluttergithubbot commented Apr 8, 2022

Uh oh!

fluttergithubbot commented Apr 8, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

cyanglaz commented Mar 25, 2022 •

edited

Loading

cyanglaz Mar 30, 2022 •

edited

Loading

jmagman Mar 30, 2022 •

edited

Loading