Xcode error message #94747

cyanglaz · 2021-12-06T18:35:54Z

Parse issues in xcresult and display them in console.

Sample output:

Semantic Issue (Xcode): Use of undeclared identifier 'ss'
/path/ios/Runner/AppDelegate.m:11:56

Also in this PR:

Updated XCResultGenerator uses a simpler "issuesMap" when parsing issues.
Make simulator build to diagnose failure when build fails.

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 · 2021-12-08T01:48:43Z

There are some test failures.

cyanglaz · 2021-12-08T23:01:41Z

@jmagman Tests passed, PTAL

jmagman · 2021-12-08T23:47:59Z

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

+            case XCResultIssueType.error:
+              globals.printError('Xcode build issue (${issue.subType}): ${issue.message}');
+              break;
+            case XCResultIssueType.warning:
+              globals.printWarning('Xcode build issue (${issue.subType}): ${issue.message}');
+              break;


Can you add examples for what this output looks like in the case of errors and warnings in this PR description?

Can you add examples for the full flutter build ios and flutter build ios --verbose output of what this kind of error will look like? I can't picture how it will look in the context of all the Xcode logging and build failure text.

I would know more when I see the full output, but this seems too wordy:

Xcode build issue (Swift Compiler Error): Expected dictionary value type

How about:

Swift Compiler Error (Xcode): Expected dictionary value type

Is this message going to be helpful without the class name and line number? Unfortunately this means parsing the url result fragment (which looks like a query, oddly, thanks Xcode...) file:///path/to/ios/Runner/AppDelegate.swift#CharacterRangeLen=0&EndingColumnNumber=8&EndingLineNumber=11&StartingColumnNumber=8&StartingLineNumber=11

There are likely quite a few error messages we should not display, like Command PhaseScriptExecution failed with a nonzero exit code (would happen every time there's a dart compilation issue). Same for the warning that happens when a plugin supports a lower iOS version than the app. Let's get the obvious ones, and then we can add more in future PRs as we discover them.

I think the compiler error usually display at the end of the build, so it looks like:

Running Xcode build... └─Compiling, linking and signing... 759ms Xcode build done. 5.5s Xcode build issue (Swift Compiler Error): Expected dictionary value type Xcode build issue (Swift Compiler Error): Method does not override any method from its superclass Failed to build iOS app Error output from Xcode build: ↳ ** BUILD FAILED ** Xcode's output: ↳ Writing result bundle at path: /var/folders/38/ypkvsh7n1d94tv_njrw0nwrh00l9tg/T/flutter_tools.CtyCRE/flutter_ios_build_temp_dire1EhUm/temporary_xcresult_bundle /Users/ychris/tmp/xcresult/xcresult_parsing/ios/Runner/AppDelegate.swift:8:83: error: expected dictionary value type didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: nil]? ^ /Users/ychris/tmp/xcresult/xcresult_parsing/ios/Runner/AppDelegate.swift:6:17: error: method does not override any method from its superclass override func application( ~~~~~~~~ ^ remark: Incremental compilation has been disabled: it is not compatible with whole module optimization note: Using new build system note: Planning note: Build preparation complete note: Building targets in parallel Result bundle written to path: /var/folders/38/ypkvsh7n1d94tv_njrw0nwrh00l9tg/T/flutter_tools.CtyCRE/flutter_ios_build_temp_dire1EhUm/temporary_xcresult_bundle ════════════════════════════════════════════════════════════════════════════════ 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 ════════════════════════════════════════════════════════════════════════════════ Encountered error while building for device.

In this instance, the xcresult message is not particularly useful as the more useful messages are displayed at the end.

What do you think about this when parsing the url result:

File: file:///path/to/ios/Runner/AppDelegate.swift StartLineNumber: 11 EndLineNumber: 11 StartColumnNumber: 8 EndColumnNumber: 8

I think this detailed compiler error code position is messy enough to deserve a separate PR.

2
Good idea, I can create a separate PR to filter errors we don't want to display to user in non-verbose mode.

In this instance, the xcresult message is not particularly useful as the more useful messages are displayed at the end.

Instead of printing as you have, what if instead add the XCResult stuff to the XcodeBuildResult? And then the caller can choose how and in what order to display this.

flutter/packages/flutter_tools/lib/src/commands/build_ios.dart

Line 266 in 52ae102

final XcodeBuildResult result = await buildXcodeProject(

File: file:///path/to/ios/Runner/AppDelegate.swift
StartLineNumber: 11
EndLineNumber: 11
StartColumnNumber: 8
EndColumnNumber: 8

Let's copy what Xcode does when it displays, with just the line and column start.
/path/to/ios/Runner/AppDelegate.swift:11:8

#95035

I don't think we should land this PR without making sure confusing PhaseScriptExecution errors shows up with dart compilation errors. We can polish in subsequent PRs, but a dart issue is a very core and much more common case than a Swift compilation error, for example.

See diagnoseXcodeBuildFailure for where it would probably make sense to handle these from a XcodeBuildResult.

Also there are a few things in diagnoseXcodeBuildFailure that may actually be more accurate once we can parse these xcresults. For example, it just guesses there's a codesigning error sometimes, even when something else really failed.

Parsing "url" in this PR: #95054

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

cyanglaz · 2021-12-10T18:58:11Z

Created issues to track the 2 sub problems: #95035, #95036

jmagman · 2021-12-15T01:23:20Z

packages/flutter_tools/lib/src/commands/build_ios.dart

+        if (xcResult.issues.isEmpty) {
+          globals.printStatus('Xcode build has no issues!');
+        }


Let's remove this trace, we should already be able to see similar output from Xcode in verbose mode.

jmagman · 2021-12-15T01:24:05Z

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

+  issueSummary += issue.subType ?? 'Unknown';
+  issueSummary += ' (Xcode): ';
+  issueSummary += issue.message ?? '';
+  issueSummary += issue.location != null? '\n$issue.location' : '';


Suggested change

issueSummary += issue.location != null? '\n$issue.location' : '';

issueSummary += issue.location != null ? '\n$issue.location' : '';

jmagman · 2021-12-15T01:26:20Z

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

+    return;
+  }
+
+  xcResult.issues.forEach( (final XCResultIssue issue) => _handleXCResultIssue(issue: issue, logger: logger));


Analyzer didn't like this:

info • Avoid using `forEach` with a function literal • packages/flutter_tools/lib/src/ios/mac.dart:622:19 • avoid_function_literals_in_foreach_calls

Suggested change

xcResult.issues.forEach( (final XCResultIssue issue) => _handleXCResultIssue(issue: issue, logger: logger));

for (final XCResultIssue issue in xcResult.issues) {

_handleXCResultIssue(issue: issue, logger: logger);

}

jmagman · 2021-12-15T01:32:12Z

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

+  }
+
+  // Add more custom output for flutter users.
+  if (issue.message != null && issue.message!.contains('Provisioning profile')) {


I think this may also be No matching provisioning profiles found, though I didn't remove the profiles on my machine to test. Can you make this case insensitive to make it a little more robust to string changes?
(I lamented to you on chat already that I wish we have error codes to go off of...)

jmagman · 2021-12-15T01:32:32Z

packages/flutter_tools/test/commands.shard/hermetic/build_ios_test.dart

+        'json'
+      ],
+      stdout: stdout,
+      onRun: onRun);


Suggested change

onRun: onRun);

onRun: onRun,

);

jmagman · 2021-12-15T01:34:32Z

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

+
+void _handleXCResultIssue({required XCResultIssue issue, required Logger logger}) {
+  // Issue summary from xcresult.
+  String issueSummary = '';


Instead of += string concatenation, use a StringBuffer.

jmagman · 2021-12-15T01:34:55Z

packages/flutter_tools/test/commands.shard/hermetic/build_ios_test.dart

+        '--path',
+        _xcBundleFilePath,
+        '--format',
+        'json'


Suggested change

'json'

'json',

jmagman · 2021-12-15T01:38:36Z

packages/flutter_tools/test/commands.shard/hermetic/build_ios_test.dart

+      _setUpXCResultCommand(onRun: () {
+      }),


onRun can be null.

Suggested change

_setUpXCResultCommand(onRun: () {

}),

_setUpXCResultCommand(),

cyanglaz · 2021-12-15T22:20:31Z

@jmagman Ready to be reviewed again.

jmagman

LGTM with minor whitespace nit.

jmagman · 2021-12-15T23:04:50Z

packages/flutter_tools/test/commands.shard/hermetic/build_ipa_test.dart

+
+
+  testUsingContext('Extra error message for provision profile issue in xcresulb bundle.', () async {
+      final BuildCommand command = BuildCommand();


Extra indentation.

fluttergithubbot · 2021-12-17T01:24:13Z

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

The status or check suite customer_testing-linux 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 Dec 6, 2021

google-cla bot added the cla: yes label Dec 6, 2021

cyanglaz force-pushed the xcode_error_message branch from 3099f0d to 3a5ea37 Compare December 7, 2021 19:15

cyanglaz requested a review from jmagman December 7, 2021 23:42

cyanglaz marked this pull request as ready for review December 7, 2021 23:44

jmagman reviewed Dec 9, 2021

View reviewed changes

This was referenced Dec 10, 2021

xcresult parser should be able to discard error messages we don't want to display. #95035

Closed

xcresult parser shows location of compilation error. #95036

Closed

cyanglaz mentioned this pull request Dec 10, 2021

[tool] XCResult also parses "url" in xcresult bundle #95054

Merged

8 tasks

jmagman reviewed Dec 15, 2021

View reviewed changes

jmagman approved these changes Dec 15, 2021

View reviewed changes

cyanglaz added the waiting for tree to go green label Dec 17, 2021

fluttergithubbot removed the waiting for tree to go green label Dec 17, 2021

Parse xcode error message

fb53cb9

cyanglaz force-pushed the xcode_error_message branch from ca03888 to fb53cb9 Compare December 21, 2021 01:13

cyanglaz added the waiting for tree to go green label Dec 21, 2021

fluttergithubbot merged commit 1c4128c into flutter:master Dec 21, 2021

darshankawar mentioned this pull request Feb 7, 2022

Fails to build for simulator: cannot find 'PiPViewCoordinator' in scope #94858

Closed

jmagman mentioned this pull request Mar 22, 2022

Xcode 13.3 beta prints warning Xcode.DebuggerFoundation.AppExtensionToBundleIdentifierMap.watchOS #98298

Closed

cyanglaz mentioned this pull request Mar 24, 2022

Do not print last x lines of stderr from xcodebuild when there's error on iOS #100721

Closed

jmagman mentioned this pull request Mar 24, 2022

Xcode build failures are not printed when codesigning is off #100723

Closed

jmagman mentioned this pull request Apr 20, 2022

Issue with flutter in MacOS with last version of xCode and M1 ( Version 13.3.1 (13E500a) ) #102025

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Xcode error message #94747

Xcode error message #94747

cyanglaz commented Dec 6, 2021 •

edited

jmagman commented Dec 8, 2021 •

edited

cyanglaz commented Dec 8, 2021

jmagman Dec 8, 2021

cyanglaz Dec 10, 2021

jmagman Dec 10, 2021 •

edited

cyanglaz Dec 10, 2021 •

edited

cyanglaz Dec 10, 2021

jmagman Dec 10, 2021

jmagman Dec 10, 2021

jmagman Dec 10, 2021

cyanglaz Dec 10, 2021

cyanglaz commented Dec 10, 2021

jmagman Dec 15, 2021

jmagman Dec 15, 2021

jmagman Dec 15, 2021

jmagman Dec 15, 2021

jmagman Dec 15, 2021

jmagman Dec 15, 2021

jmagman Dec 15, 2021

jmagman Dec 15, 2021

cyanglaz commented Dec 15, 2021

jmagman left a comment

jmagman Dec 15, 2021

fluttergithubbot commented Dec 17, 2021

	issueSummary += issue.location != null? '\n$issue.location' : '';
	issueSummary += issue.location != null ? '\n$issue.location' : '';

-  xcResult.issues.forEach( (final XCResultIssue issue) => _handleXCResultIssue(issue: issue, logger: logger));
+  for (final XCResultIssue issue in xcResult.issues) {
+    _handleXCResultIssue(issue: issue, logger: logger);
+  }

	_setUpXCResultCommand(onRun: () {
	}),
	_setUpXCResultCommand(),



		testUsingContext('Extra error message for provision profile issue in xcresulb bundle.', () async {
		final BuildCommand command = BuildCommand();

Xcode error message #94747

Xcode error message #94747

Conversation

cyanglaz commented Dec 6, 2021 • edited

Pre-launch Checklist

jmagman commented Dec 8, 2021 • edited

cyanglaz commented Dec 8, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmagman Dec 10, 2021 • edited

Choose a reason for hiding this comment

cyanglaz Dec 10, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cyanglaz commented Dec 10, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cyanglaz commented Dec 15, 2021

jmagman left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fluttergithubbot commented Dec 17, 2021

cyanglaz commented Dec 6, 2021 •

edited

jmagman commented Dec 8, 2021 •

edited

jmagman Dec 10, 2021 •

edited

cyanglaz Dec 10, 2021 •

edited