Turn off bitcode in existing iOS Xcode projects #112828

jmagman · 2022-10-03T21:56:18Z

Starting with Xcode 14, bitcode is no longer required for watchOS and tvOS applications, and the App Store no longer accepts bitcode submissions from Xcode 14.

https://developer.apple.com/documentation/xcode-release-notes/xcode-14-release-notes

Ensure Flutter apps have ENABLE_BITCODE set to NO. We never turned bitcode on by default in our template, but it's possible the user turned it on manually. It it is on, then give the user a warning and remove the build setting.

$ flutter build ios --config-only
Building com.example.testCreate for device (ios-release)...
Disabling deprecated bitcode Xcode build setting. See https://github.com/flutter/flutter/issues/107887 for additional details.
Upgrading project.pbxproj
Automatically signing iOS for device deployment using specified development team in Xcode project: S8QB4VV633

Confirmed this worked and removed the build setting in the test project where I manually turned it on:

				DEVELOPMENT_TEAM = S8QB4VV633;
-				ENABLE_BITCODE = YES;
				INFOPLIST_FILE = Runner/Info.plist;

Fixes #111776

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-10-03T22:32:45Z

Actually, instead of removing the build setting, it will be safer to set ENABLE_BITCODE = NO; for all versions of Xcode. On Xcode < 14 the OS default is YES. That will allow us to more confidently remove bitcode from the tool without needing to check Xcode versions.

jmagman · 2022-10-03T23:14:53Z

Actually, instead of removing the build setting, it will be safer to set ENABLE_BITCODE = NO; for all versions of Xcode.

Done.

christopherfujino · 2022-10-04T00:18:56Z

packages/flutter_tools/lib/src/ios/migrations/remove_bitcode_migration.dart

+        // Only print for the first discovered change found.
+        logger.printWarning('Disabling deprecated bitcode Xcode build setting. See https://github.com/flutter/flutter/issues/107887 for additional details.');
+      }
+      return line.replaceAll('ENABLE_BITCODE = YES', 'ENABLE_BITCODE = NO');


is the spacing here guaranteed to be a single space on both sides of the =?

I mean it's totally undocumented but it's been that way for as long as I've been mucking with Xcode projects.

christopherfujino · 2022-10-04T00:20:39Z

packages/flutter_tools/lib/src/ios/migrations/remove_bitcode_migration.dart

+    if (_xcodeProjectInfoFile.existsSync()) {
+      processFileLines(_xcodeProjectInfoFile);
+    } else {
+      logger.printTrace('Xcode project not found, skipping removing bitcode migration.');


isn't migrate() supposed to return false if the migration was skipped?

At least how it works now is that returning false means something catastrophic happened and the build fails:

flutter/packages/flutter_tools/lib/src/linux/build_linux.dart

Lines 50 to 52 in 5f5d480

if (!migration.run()) {

throwToolExit('Unable to migrate project files');

}

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

Lines 134 to 136 in 70aaff1

if (!migration.run()) {

return XcodeBuildResult(success: false);

}

etc

flutter/packages/flutter_tools/lib/src/base/project_migrator.dart

Lines 85 to 90 in c77e4cd

if (!migrator.migrate()) {

// Migration failures should be more robust, with transactions and fallbacks.

// See https://github.com/flutter/flutter/issues/12573 and

// https://github.com/flutter/flutter/issues/40460

return false;

}

So this comment is just wrong:

flutter/packages/flutter_tools/lib/src/base/project_migrator.dart

Lines 19 to 20 in c77e4cd

/// Returns whether migration was successful or was skipped.

bool migrate();

Will fix in follow-up PR.

christopherfujino

two nit questions, otherwise LGTM

…utter#112828)

…ter#112828)

Flutter deprecated bitcode in 2022 #112828, and introduced a warning in #112900 to let add-to-app devs know. Apps should be migrated by now, remove the outdated warning.

Remove Xcode build setting in existing projects

978326c

jmagman self-assigned this Oct 3, 2022

flutter-dashboard bot added platform-ios iOS applications specifically tool Affects the "flutter" command-line tool. See also t: labels. labels Oct 3, 2022

jmagman requested review from cyanglaz and christopherfujino October 3, 2022 22:19

jmagman marked this pull request as draft October 3, 2022 22:32

jmagman removed request for cyanglaz and christopherfujino October 3, 2022 22:32

jmagman mentioned this pull request Oct 3, 2022

Stop embedding bitcode for iOS in tool #112831

Merged

8 tasks

Set to NO regardless of Xcode

d2f50ba

jmagman marked this pull request as ready for review October 3, 2022 23:04

jmagman changed the title ~~Remove Xcode build setting in existing projects~~ Turn off bitcode in existing iOS Xcode projects Oct 3, 2022

jmagman requested review from cyanglaz and christopherfujino October 3, 2022 23:14

christopherfujino reviewed Oct 4, 2022

View reviewed changes

christopherfujino approved these changes Oct 4, 2022

View reviewed changes

jmagman added the autosubmit Merge PR when tree becomes green via auto submit App label Oct 4, 2022

auto-submit bot merged commit 8c0aa6c into flutter:master Oct 4, 2022

jmagman deleted the migrate-bitcode branch October 4, 2022 01:20

This was referenced Oct 4, 2022

Roll Flutter from a4b246f2a88c to 55d67cc7d992 (20 revisions) flutter/packages#2674

Merged

Roll Flutter from a4b246f2a88c to 55d67cc7d992 (20 revisions) flutter/plugins#6534

Merged

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

8c0aa6c66 Turn off bitcode in existing iOS Xcode projects (flutter/fl…

15bb5b5

…utter#112828)

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

8c0aa6c Turn off bitcode in existing iOS Xcode projects (flutter/flut…

5744a22

…ter#112828)

This was referenced Oct 5, 2022

Return void from project migrate() #112897

Merged

Add bitcode deprecation note for add-to-app iOS developers #112900

Merged

jmagman mentioned this pull request Oct 18, 2022

version 1.17.5 does not compile on iOS cleverpush/cleverpush-flutter-sdk#33

Closed

jmagman mentioned this pull request May 17, 2024

Remove add-to-app bitcode warning #148587

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Turn off bitcode in existing iOS Xcode projects #112828

Turn off bitcode in existing iOS Xcode projects #112828

jmagman commented Oct 3, 2022 •

edited

Loading

jmagman commented Oct 3, 2022

jmagman commented Oct 3, 2022

christopherfujino Oct 4, 2022

jmagman Oct 4, 2022

christopherfujino Oct 4, 2022

jmagman Oct 4, 2022

jmagman Oct 4, 2022

christopherfujino left a comment

	if (!migration.run()) {
	throwToolExit('Unable to migrate project files');
	}

	if (!migration.run()) {
	return XcodeBuildResult(success: false);
	}

	if (!migrator.migrate()) {
	// Migration failures should be more robust, with transactions and fallbacks.
	// See https://github.com/flutter/flutter/issues/12573 and
	// https://github.com/flutter/flutter/issues/40460
	return false;
	}

	/// Returns whether migration was successful or was skipped.
	bool migrate();

Turn off bitcode in existing iOS Xcode projects #112828

Turn off bitcode in existing iOS Xcode projects #112828

Conversation

jmagman commented Oct 3, 2022 • edited Loading

Pre-launch Checklist

jmagman commented Oct 3, 2022

jmagman commented Oct 3, 2022

christopherfujino Oct 4, 2022

Choose a reason for hiding this comment

jmagman Oct 4, 2022

Choose a reason for hiding this comment

christopherfujino Oct 4, 2022

Choose a reason for hiding this comment

jmagman Oct 4, 2022

Choose a reason for hiding this comment

jmagman Oct 4, 2022

Choose a reason for hiding this comment

christopherfujino left a comment

Choose a reason for hiding this comment

jmagman commented Oct 3, 2022 •

edited

Loading