SPM: allow podspecs to declare Swift Package Manager dependencies with spm_dependency #11953

mfazekas · 2023-06-15T14:03:55Z

Implements: #11942

See also: #743
and: #344

Also note that implementation is very simplistic, if same spm is included by multiple specs they have to have the exact same requirements. In future this can be improved by implementing a version range merge.

See https://github.com/mfazekas/pods-spm-dep-poc/#how-it-works on description of the changes made to the pods project.

I've added a single integration test, but it required some hacking to project to to_yaml:
https://github.com/CocoaPods/CocoaPods/pull/11953/files#diff-2f87abe8c188a9e01c085e87a3a38d78dcc50ca8d2fe79367e5e2deec6bcd778R13-R15

lib/cocoapods/installer/xcode/pods_project_generator.rb

…h spm_dependency

…roduct dump

mfazekas · 2023-07-01T14:39:19Z

.gitmodules

@@ -6,7 +6,8 @@
 url = https://github.com/tonymillion/Reachability.git
 [submodule "spec/cocoapods-integration-specs"]
 path = spec/cocoapods-integration-specs
- url = https://github.com/CocoaPods/cocoapods-integration-specs.git
+ url = https://github.com/mfazekas/cocoapods-integration-specs.git


should be reverted before merge

mfazekas · 2023-07-01T14:39:25Z

Gemfile

@@ -20,7 +20,8 @@ gemspec

 group :development do
 cp_gem 'claide', 'CLAide'
- cp_gem 'cocoapods-core', 'Core'
+ # cp_gem 'cocoapods-core', 'Core'
+ gem 'cocoapods-core', :git => 'https://github.com/mfazekas/Core', branch: 'podspec-spm'


should be reverted before merge

osrufung · 2023-08-03T07:18:36Z

Thank you for this! 👏

mfazekas · 2023-08-14T14:56:11Z

@dnkoutso how can we move forward with this?

Dragna · 2023-08-31T13:21:22Z

is there anything we can do to help in shipping this ? 🙂

orta · 2023-08-31T20:28:15Z

A lot of it depends on folks' time to do OSS. As CocoaPods, if there's not a critical need for a release during betas we tend to really only ship after the RC version of Xcode - so I think this is likely to get some eyes over it in prep for making a release for the next Xcode major

We're happy conceptually with the idea, just needs some eyes over implementation ideally around when we are looking at making the next release

Dragna · 2023-10-25T14:50:14Z

@mfazekas I tested it (after rebasing on cocoapods 1.13.0), and it seems that if I define a dependency in a subspec, I see the library declared in the pod target where I defined the SPM dependency, but the spm dependency isn't added to the Pods xcodeproj.

I want to look into this to make it work, would you have some insight for me on where to look ? That would be really helpful🙂 🙏

Dragna · 2023-10-27T16:18:06Z

lib/cocoapods/installer/xcode/pods_project_generator.rb

+ end
+
+ def install_spm_dedpendecies(project, pod_targets)
+ spm_dependencies = pod_targets.flat_map { |target| target.root_spec.consumer(target.platform).spm_dependencies }


updating this line to get the dependencies on all the specs lets us define spm dependencies at the subspec level 🙂

Suggested change

spm_dependencies = pod_targets.flat_map { |target| target.root_spec.consumer(target.platform).spm_dependencies }

spm_dependencies = pod_targets.flat_map { |target|

target.specs.flat_map{ |spec| spec.consumer(target.platform).spm_dependencies }

}

Dragna · 2023-11-22T15:31:49Z

I'm getting here step by step, I added the possibility to add local packages to a podspec.

one problem I have now is that for reasons (unknown to me for now) I get a undefined symbols when building the project.

it means that if I have a Pod module A that depends on a swift package B, when I build my project, A compiles, but I get a compile error on the project stating that it doesn't know about B.

I may be missing a piece here (I'm lacking understanding of the build system) and any help would be great 🙂.

mfazekas · 2023-11-22T15:34:08Z

I'm getting here step by step, I added the possibility to add local packages to a podspec.

one problem I have now is that for reasons (unknown to me for now) I get a undefined symbols when building the project.

it means that if I have a Pod module A that depends on a swift package B, when I build my project, A compiles, but I get a compile error on the project stating that it doesn't know about B.

I may be missing a piece here (I'm lacking understanding of the build system) and any help would be great 🙂.

Can you check 3.) here?
https://github.com/mfazekas/pods-spm-dep-poc/#how-it-works

Dragna · 2023-11-22T15:57:47Z

Can you check 3.) here?
https://github.com/mfazekas/pods-spm-dep-poc/#how-it-works

Thank you for your quick answer 🙏

It seems that I have everything set here and the paths were added.

my error is not a No Such Module X on the pod importing my swiftpackage, it's more at the level of the target I'm trying to use which depends on the pod.

my target does not use the swift package code, only the pod.

if I manually add my package to the target, everything compiles.

I'm trying with a big project, I'll try making an example

Dragna · 2023-11-22T17:05:46Z

Ok I have a way of reproducing this, if the podspec that import the swift package is defined as a static_framework
s.static_framework = true, it's in this case that I have my error.
I must be missing a build setting in this case.
here is a small example project

SPMIntegrationInPodsExample.zip

you can install the env by doing :

make // to install my fork of cocoapods where are my currents modifications (based on what you did)
make install or bundle exec pod install // instead of a pod install (there is still some debug logging sorry for that 🙏)

I would totally understand that you don't have time for this, but if you think of anything that could be of help to me on how to better understand / solve let me know, I'll try to implement and test that to push a PR on your fork 🙂

Dragna · 2023-11-28T14:54:10Z

Hi every one,

I'm still investigating on the static_framework generation and I'm kind of stuck there, I must be missing something.

I have a test project that has 3 pods:

LocalPod
- is static
- dependencies
  - EmbededPod
  - SwiftUIX using SPM
LocalPod2
- dynamic
- dependencies
  - none for this example
EmbededPod
- is static
- dependencies
  - SwiftUIX using SPM

in that configuration when I build my app I get a build error saying that I have duplicated symbols for SwiftUIX

I made another sample project, where I have almost the same architecture, but I don't use Pods, I use static libraries directly that have SPM as dependencies, and everything works fine, I can compile without problem.

I may be missing what the difference is between a vanilla static lib and a Pod static framework is. (it seems that in the case of cocoapods, it's generating .framework folder even for the static_frameworks)

if anyone has any idea that would be super helpful 🙂 🙏 .

Funnily if I add SwiftUIX using SPM to my LocalPod2 which is dynamic, I could then add the path to BuildDir/PackageFrameworks in the FRAMEWORK_SEARCH_PATHS to look for the framework and adding it in the OTHER_LDFLAGS.

If I do this everything seems to compile and work (no more duplicated symbols 🤷‍♂️) but it's more of a hack as I need to declare the package in a dynamic pod to see its generated framework in the build products.

contfedorov · 2024-04-05T10:19:58Z

@mfazekas
Could you please clarify if your PR deals with dependency resources correctly?

Imagine the situation. I have an OSS project on Github that defines SPM package. I am able to consume it via Cocoapods by manually creating .podspec with s.source and s.source_files defined. I have just one issue with this. Project has resources (strings, images, etc.) that are packed into .bundle file. XCode generates resource_bundle_accessor.swift that finds that bundle and makes it acessable to Swift code. In case dependency is consumed by SPM, that file is generated. In case dependency is consumed by Cocoapods, that file is not generated.

So, I am wondering if your PR can handle this.

mfazekas · 2024-04-05T11:23:29Z

@contfedorov so this PR does what's described in: https://github.com/mfazekas/pods-spm-dep-poc/#how-it-works

1.) Adds the Package Dependency to the Pods project.
2.) Adds the targets dependencies to Frameworks and Libraries of the pod
3.) (Adds to Swift Import Paths)

contfedorov · 2024-04-10T12:48:03Z

@mfazekas
Can I do the same by modifying my .podspec in any way?

UPD Checked a bit more, looks like there are no chances to do it via podspec only. Thanks for your POC!

This was referenced Jun 15, 2023

SPM: allow pod specs to declare Swift Package Manager dependencies with spm_dependency CocoaPods/Core#743

Open

[RFC] Declare SPM dependencies in podspec #11942

Open

mfazekas force-pushed the podspec-spm branch from 9024747 to b0a1426 Compare June 19, 2023 19:08

dnkoutso added this to the 1.13.0 milestone Jun 28, 2023

Dragna reviewed Jun 30, 2023

View reviewed changes

lib/cocoapods/installer/xcode/pods_project_generator.rb Outdated Show resolved Hide resolved

mfazekas force-pushed the podspec-spm branch from b0a1426 to de07e45 Compare July 1, 2023 11:30

SPM: allow podspecs to declare Swift Package Manager dependencies wit…

c24c80d

…h spm_dependency

mfazekas force-pushed the podspec-spm branch 3 times, most recently from fadf326 to d34cd52 Compare July 1, 2023 13:45

test: add integrtion test for spm and include package references in p…

587a0b5

…roduct dump

mfazekas force-pushed the podspec-spm branch from d34cd52 to 587a0b5 Compare July 1, 2023 14:34

mfazekas commented Jul 1, 2023

View reviewed changes

ricardobrg mentioned this pull request Sep 4, 2023

Import TikiSdk in iOS TikiSdk Capacitor is not working tiki-archive/publish-sdk-capacitor#68

Closed

dnkoutso modified the milestones: 1.13.0, 1.14.0 Sep 22, 2023

Dragna reviewed Oct 27, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SPM: allow podspecs to declare Swift Package Manager dependencies with spm_dependency #11953

SPM: allow podspecs to declare Swift Package Manager dependencies with spm_dependency #11953

mfazekas commented Jun 15, 2023 •

edited

mfazekas Jul 1, 2023

mfazekas Jul 1, 2023

osrufung commented Aug 3, 2023

mfazekas commented Aug 14, 2023

Dragna commented Aug 31, 2023

orta commented Aug 31, 2023

Dragna commented Oct 25, 2023

Dragna Oct 27, 2023

Dragna commented Nov 22, 2023

mfazekas commented Nov 22, 2023 •

edited

Dragna commented Nov 22, 2023

Dragna commented Nov 22, 2023 •

edited

Dragna commented Nov 28, 2023 •

edited

contfedorov commented Apr 5, 2024

mfazekas commented Apr 5, 2024

contfedorov commented Apr 10, 2024 •

edited

SPM: allow podspecs to declare Swift Package Manager dependencies with spm_dependency #11953

Are you sure you want to change the base?

SPM: allow podspecs to declare Swift Package Manager dependencies with spm_dependency #11953

Conversation

mfazekas commented Jun 15, 2023 • edited

mfazekas Jul 1, 2023

Choose a reason for hiding this comment

mfazekas Jul 1, 2023

Choose a reason for hiding this comment

osrufung commented Aug 3, 2023

mfazekas commented Aug 14, 2023

Dragna commented Aug 31, 2023

orta commented Aug 31, 2023

Dragna commented Oct 25, 2023

Dragna Oct 27, 2023

Choose a reason for hiding this comment

Dragna commented Nov 22, 2023

mfazekas commented Nov 22, 2023 • edited

Dragna commented Nov 22, 2023

Dragna commented Nov 22, 2023 • edited

Dragna commented Nov 28, 2023 • edited

contfedorov commented Apr 5, 2024

mfazekas commented Apr 5, 2024

contfedorov commented Apr 10, 2024 • edited

mfazekas commented Jun 15, 2023 •

edited

mfazekas commented Nov 22, 2023 •

edited

Dragna commented Nov 22, 2023 •

edited

Dragna commented Nov 28, 2023 •

edited

contfedorov commented Apr 10, 2024 •

edited