apache / apache/cordova-node-xcode

addFramework uses incorrect path for Swift libraries

Open
#114 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
JavaScript
Stars
217
Forks
102
Avg merge
2d 3h
Merged PRs (30d)
6

Description

The default path used in the `PBXFileReference` for frameworks with `.tbd` extensions is `/usr/lib`. However, I believe that Swift libraries with the same extension needs to have the path `/usr/lib/swift`.

For example, if you use `addFramework` to add `libswiftAVFoundation.tbd` it produces the following `PBXFileReference` in the project file:
```
27874A9BBF2444AABA64E8E0 /* libswiftAVFoundation.tbd */ = {isa = PBXFileReference; lastKnownFileType = "sourcecode.text-based-dylib-definition"; name = libswiftAVFoundation.tbd; path = usr/lib/libswiftAVFoundation.tbd; sourceTree = SDKROOT; };
```
This will ultimately result in a Crash on iOS versions 12.1 or lower, before the Swift runtime was bundled with the OS.

If you add the library manually in Xcode, the project file has the following `PBXFileReference' added:
```
5DBEA893249434B30034407A /* libswiftAVFoundation.tbd */ = {isa = PBXFileReference; lastKnownFileType = "sourcecode.text-based-dylib-definition"; name = libswiftAVFoundation.tbd; path = usr/lib/swift/libswiftAVFoundation.tbd; sourceTree = SDKROOT; };
```
Note the path difference:
cordova-node-xcode: usr/lib/libswiftAVFoundation.tbd
Xcode: usr/lib/swift/libswiftAVFoundation.tbd

I have an experimental patch [here](https://github.com/jskrepnek/cordova-node-xcode/commit/ebca1c14c11b5897d12e2829f4cd592d00f89d6b) to work around this.

Assuming I'm on the right track here, I'll submit a pull request but I'm hoping that the maintainers can recommend if the approach I used is acceptable or if there's a more effective way to select the correct default path for these libraries than introducing another option.

Contributor guide

Open the contributing guide

Research direction

Start at the addFramework entry point and compare its PBXFileReference path handling with the experimental patch linked in the issue. Reproduce the libswiftAVFoundation.tbd example and confirm that Swift libraries use usr/lib/swift while other frameworks retain their expected paths.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, nodejs
Domain
mobile
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.