feat(ios): support xcframeworks in modules/platform folders #12092

sgtcoolguy · 2020-09-16T19:33:27Z

JIRA: https://jira.appcelerator.org/browse/TIMOB-27986

Description:
This adds support for integrating .xcframeworks in the same manner we do .frameworks for app projects.

I tested this while developing tidev/ti.barcode#134

It seems to properly integrate the ti.barcode module and the ZXingObjC.xcframework that module now includes (in it's platform folder on that PR). I fumbled through this a bit, so it may be doing some things wrong:

such as adding wrong/too many search paths for frameworks?
Assuming all xcframeworks are dynamic (tiverify.xcframework in the SDK itself isn't. I don't know the correct way to "check" for static vs dynamic xcframeworks. Just look for .framework subdirs?)
I didn't attempt to tackle the general issue that we (and Apple!) have long conflated architectures with arch/target combinations. This is present in our module code as well (i.e. the manifest). We can't use 'arm64' as shorthand for device arm64 anymore - there will be arm64 Apple Silicon simulators! And arm64 Apple Silicon maccatalyst targets! So I don't know what to do with the collection of architectures on xcframeworks and stripping them. I assume Xcode does that itself with xcframewokrs (they're basically pre-sliced target frameworks/binaries with multiple architectures for that target).

build · 2020-09-16T19:55:54Z

	Fails
🚫	Tests have failed, see below for more information.

	Warnings
⚠️	This PR has milestone set to 9.2.0, but the version defined in package.json is 9.3.0 Please either: - Update the milestone on the PR - Update the version in package.json - Hold the PR to be merged later after a release and version bump on this branch

	Messages
📖	✊ The commits in this PR match our conventions! Feel free to Rebase and Merge this PR when ready.
📖	❌ 1 tests have failed There are 1 tests failing and 739 skipped out of 8337 total tests.

Tests:

Classname

Name

Time

Error

ios.macos.Titanium.UI.iOS.CollisionBehavior.example

works (10.15.4)

15.096

Error: timeout of 15000ms exceeded
file:///Users/build/jenkins/workspace/ium-sdk_titanium_mobile_PR-12092/tmp/mocha/build/iphone/build/Products/Debug-maccatalyst/mocha.app/Contents/Resources/ti-mocha.js:4326:27

New dependencies added: simple-plist.

simple-plist

Author: Joe Wollard

Description: A wrapper utility for interacting with plist data.

Homepage: https://github.com/wollardj/node-simple-plist.git


Created	almost 7 years ago
Last Updated	about 2 months ago
License	MIT
Maintainers	2
Releases	10
Direct Dependencies	`bplist-creator`, `bplist-parser` and `plist`
Keywords	plist, binary, bplist and xml

Generated by 🚫 dangerJS against aedb408

vijaysingh-axway · 2020-09-17T00:01:06Z

iphone/cli/hooks/frameworks.js

 		this._xobjs.PBXFileReference[fileRefUuid] = {
 			isa: 'PBXFileReference',
-			lastKnownFileType: 'wrapper.framework',
+			lastKnownFileType: frameworkInfo.wrapperName, // FIXME: What if framework is an xcframework?


In case of xcframework it should be "wrapper.xcframework" .

I think the fixme comment can be removed, the correct file type will be returned here

iphone/cli/hooks/frameworks.js

janvennemann · 2020-09-18T08:46:49Z

@sgtcoolguy @vijaysingh-axway i added a couple of things to this PR:

Parsing supported archs and platforms from Info.plist
Determine mach-o type from one library inside the .xcframework package. I assumed that all libraries will have the same type so i only check this one time.
Set platformFilter based on the parsed platforms as mentioned above by Vijay.

sgtcoolguy

I can't approve, only "comment", since I'm the original author 😆

Anyways, feedback is optional below. Looks good to me.

iphone/cli/hooks/frameworks.js

sgtcoolguy · 2020-09-18T13:47:18Z

iphone/cli/hooks/frameworks.js

@@ -55,7 +61,12 @@ class FrameworkManager {
 			post: (builder, callback) => {
 				this._logger.trace('Starting third-party framework detection');
 				this._builder = builder;
-				this.detectFrameworks().then(callback, callback);
+				this.detectFrameworks().then(callback, e => {
+					if (this._cli.argv.platform === 'ios') {


why spit out the error stack trace only on iOS? Won't this always be true? Wouldn't we spit out the full error before?

Well, it's kinda messy (surprise!). This has been an issue on both platforms until Josh refactored the whole Android build for the Gradle support. Now the Android build manually spits out the error here. The iOS build on the other hand has no special handling and relies on the default error handling in the common builder here which only prints out the error message, effectively suppressing the error stack.

iphone/cli/hooks/frameworks.js

- read metadata from xcframework packages Fixes TIMOB-27986

sgtcoolguy added ios feature no tests cli 📟 backport 9_2_X labels Sep 16, 2020

sgtcoolguy added this to the 9.2.0 milestone Sep 16, 2020

sgtcoolguy requested a review from janvennemann September 16, 2020 19:33

sgtcoolguy mentioned this pull request Sep 16, 2020

Mac support tidev/ti.barcode#134

Merged

vijaysingh-axway reviewed Sep 17, 2020

View reviewed changes

iphone/cli/hooks/frameworks.js Outdated Show resolved Hide resolved

vijaysingh-axway reviewed Sep 17, 2020

View reviewed changes

iphone/cli/hooks/frameworks.js Outdated Show resolved Hide resolved

janvennemann reviewed Sep 17, 2020

View reviewed changes

iphone/cli/hooks/frameworks.js Outdated Show resolved Hide resolved

sgtcoolguy assigned janvennemann Sep 17, 2020

sgtcoolguy commented Sep 18, 2020

View reviewed changes

sgtcoolguy added the in-qe-testing 🕵 label Sep 18, 2020

vijaysingh-axway mentioned this pull request Sep 18, 2020

fix(ios): ignore the mac build if it failed and exclude sim arm64 if thirdparty .framework is there #12093

Merged

vijaysingh-axway reviewed Sep 18, 2020

View reviewed changes

iphone/cli/hooks/frameworks.js Outdated Show resolved Hide resolved

sgtcoolguy force-pushed the TIMOB-27986 branch from a38adef to bf743bd Compare September 21, 2020 17:02

janvennemann approved these changes Sep 21, 2020

View reviewed changes

sgtcoolguy force-pushed the TIMOB-27986 branch 2 times, most recently from 2fc9fbb to 2c83c2c Compare September 21, 2020 19:13

sgtcoolguy added 2 commits September 21, 2020 15:24

feat(ios): support xcframeworks in modules/platform folders

281ee20

- read metadata from xcframework packages Fixes TIMOB-27986

refactor(ios): let framework hook handle module xcframeworks

aedb408

sgtcoolguy force-pushed the TIMOB-27986 branch from 2c83c2c to aedb408 Compare September 21, 2020 19:24

sgtcoolguy merged commit ca66820 into tidev:master Sep 21, 2020

sgtcoolguy deleted the TIMOB-27986 branch September 21, 2020 19:45

build mentioned this pull request Sep 21, 2020

[Backport 9_2_X] feat(ios): support xcframeworks in modules/platform folders #12113

Merged

build removed the backport 9_2_X label Sep 21, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(ios): support xcframeworks in modules/platform folders #12092

feat(ios): support xcframeworks in modules/platform folders #12092

sgtcoolguy commented Sep 16, 2020

build commented Sep 16, 2020 •

edited

vijaysingh-axway Sep 17, 2020

janvennemann Sep 17, 2020

janvennemann commented Sep 18, 2020

sgtcoolguy left a comment

sgtcoolguy Sep 18, 2020

janvennemann Sep 21, 2020 •

edited

feat(ios): support xcframeworks in modules/platform folders #12092

feat(ios): support xcframeworks in modules/platform folders #12092

Conversation

sgtcoolguy commented Sep 16, 2020

build commented Sep 16, 2020 • edited

Tests:

simple-plist

vijaysingh-axway Sep 17, 2020

Choose a reason for hiding this comment

janvennemann Sep 17, 2020

Choose a reason for hiding this comment

janvennemann commented Sep 18, 2020

sgtcoolguy left a comment

Choose a reason for hiding this comment

sgtcoolguy Sep 18, 2020

Choose a reason for hiding this comment

janvennemann Sep 21, 2020 • edited

Choose a reason for hiding this comment

build commented Sep 16, 2020 •

edited

janvennemann Sep 21, 2020 •

edited