Skip to content

chore(ios): project changes for xcode 14 compatibility#7433

Closed
sgschantz wants to merge 1 commit intomasterfrom
chore/ios/xcode14-compatibility
Closed

chore(ios): project changes for xcode 14 compatibility#7433
sgschantz wants to merge 1 commit intomasterfrom
chore/ios/xcode14-compatibility

Conversation

@sgschantz
Copy link
Contributor

@sgschantz sgschantz commented Oct 11, 2022

To upgrade to Xcode 14 (needed to build and debug apps withiOS 16), two changes generated warnings and caused the build to fail. These changes are described in the Xcode 14 release notes:

  1. increase the iOS target version from 9 to 11

The Xcode 14 release supports on-device debugging in iOS 11 and later, tvOS 11 and later, and watchOS 4 and later. Xcode 14 requires a Mac running macOS Monterey 12.5 or later.

  1. disable bit code

The xcode 14 release notes describe the deprecation of bit code:

Deprecations
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.
Xcode no longer builds bitcode by default and generates a warning message if a project explicitly enables bitcode: “Building with bitcode is deprecated. Please update your project and/or target settings to disable bitcode. The capability to build with bitcode will be removed in a future Xcode release. IPAs that contain bitcode will have the bitcode stripped before being submitted to the App Store. Debug symbols for past bitcode submissions remain available for download. (86118779)

@keymanapp-test-bot keymanapp-test-bot bot added the user-test-missing User tests have not yet been defined for the PR label Oct 11, 2022
@keymanapp-test-bot
Copy link

keymanapp-test-bot bot commented Oct 11, 2022 •
edited
Loading

User Test Results

Test specification and instructions

ERROR: user tests have not yet been defined

mcdurdin
mcdurdin requested changes Oct 11, 2022
View reviewed changes
Copy link
Member

@mcdurdin mcdurdin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few thoughts here. Version bumps are real busy-work, and seem to generate lots of tidy up. But it's important that we cover all the bases.

  • It looks like your mac privacy fixes crept into this PR, so they should be moved into a separate PR.

  • We need to make sure that we can continue to build earlier versions of Keyman targeting 9.0, so build agents won't update to xcode 14 at this time. So these projects need to continue to be able to build and deploy on older xcode, for now.

  • Are there any impacts on macOS builds in upgrading to xcode 14? (e.g. I see this in the release notes: "Building for deployment to OS releases older than macOS 10.13, iOS 11, tvOS 11, and watchOS 4 is no longer supported. (92834476)")

  • You'll also need to fixup the iOS sample projects (e.g. KMSample2 still has bitcode enabled, so it fails to build) and any other iOS projects such as KeyboardCalibrator.

  • You'll need to write up some user tests (we'll do a regression test across supported iOS versions after this merges, though hopefully there won't be any issues).

  • You should remove any existing code which is targeting iOS versions older than 11.0: search for #available in *.swift, looks like there are a few modules in KeyboardCalibrator.

  • This will need at least four 'breaking change' release notes (add these to the sprint retrospective):

    • iOS app (because of min iOS version)
    • iOS engine (because of min iOS version and bitcode changes)
    • macOS app (because of min macOS version)
    • macOS engine (because of min macOS version)

  • We should make sure we loop in the App Builder team (@chrisvire, @rpmargetts) so they have a heads-up on the changing requirements for Keyman 16. They'll probably already be dealing with it in their own move to iOS 16 but it's nice to be informed anyway! 😁

mac/Keyman4MacIM/Keyman4MacIM/KMInputMethodAppDelegate.m Outdated
if (self.runLoopEventSrc && runLoop) {
CFRunLoopAddSource(runLoop, self.runLoopEventSrc, kCFRunLoopDefaultMode);
}
// first notify user and request access to Accessibility/PostEvent permissions
Copy link
Member

@mcdurdin mcdurdin Oct 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes don't look like they belong in this PR.

@chrisvire
Copy link

chrisvire commented Oct 11, 2022

  • We should make sure we loop in the App Builder team (@chrisvire, @rpmargetts) so they have a heads-up on the changing requirements for Keyman 16. They'll probably already be dealing with it in their own move to iOS 16 but it's nice to be informed anyway! 😁

Please include @davidmoore1. He has done work in app-builders for Xcode 14 and iOS 16 (including removing bitcode). He has also done work in a fork of keyman to support Carthage.

@mcdurdin
Copy link
Member

mcdurdin commented Oct 12, 2022

Please include @davidmoore1. He has done work in app-builders for Xcode 14 and iOS 16 (including removing bitcode). He has also done work in a fork of keyman to support Carthage.

Righto, will do. We'd also be interested at some point in understanding what is diverging in the fork and what we should be merging back upstream into the main Keyman project.

@sgschantz sgschantz marked this pull request as draft October 12, 2022 03:46
@sgschantz sgschantz force-pushed the chore/ios/xcode14-compatibility branch from e8ed2ba to 1b015ff Compare October 13, 2022 05:05
@jahorton jahorton removed their request for review October 13, 2022 05:08
@mcdurdin
Copy link
Member

mcdurdin commented Oct 20, 2022 •
edited
Loading

Please see #7483 (comment) for additional work we'll need to do in CI when we move to XCode 14.

@mcdurdin
Copy link
Member

mcdurdin commented Oct 20, 2022

Query: can we reliably use xcode-select to swap between xcode versions? This would allow us to more easily keep up with xcode releases, without breaking existing build agents

@chrisvire
Copy link

chrisvire commented Oct 20, 2022

@mcdurdin: You can have multiple. The question is whether xcodebuild will work correctly after each xcode-select call and if there is anything that resides outside of the Xcode install folder.

https://stackoverflow.com/questions/669367/can-i-have-multiple-xcode-versions-installed

@mcdurdin
Copy link
Member

mcdurdin commented Oct 20, 2022

Thanks @chrisvire, that's helpful info. Sad that we need to sudo xcode-select because that makes it hard to script in TeamCity... some exploration needed I guess.

@mcdurdin mcdurdin mentioned this pull request Oct 25, 2022
Closed
@mcdurdin mcdurdin added this to the 17.0 milestone Oct 31, 2022
@sgschantz sgschantz mentioned this pull request Jan 13, 2023
Merged
@darcywong00
Copy link
Contributor

darcywong00 commented Jan 27, 2023

Is this replaced by #8015 ?

@mcdurdin
Copy link
Member

mcdurdin commented Jan 30, 2023

Replaced by #8015.

@mcdurdin mcdurdin closed this Jan 30, 2023
@mcdurdin mcdurdin deleted the chore/ios/xcode14-compatibility branch January 30, 2023 02:17
@mcdurdin mcdurdin modified the milestones: 17.0, A17S19 Aug 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mcdurdin mcdurdin mcdurdin requested changes

@SabineSIL SabineSIL Awaiting requested review from SabineSIL

+1 more reviewer
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

chore ios/app/ ios/engine/ ios/ mac/ oem/fv/ios/ oem/fv/ oem/ user-test-missing User tests have not yet been defined for the PR

Projects

None yet

Milestone

A17S19

Development

Successfully merging this pull request may close these issues.

5 participants

@sgschantz @chrisvire @mcdurdin @darcywong00 @jahorton