Remove CocoaPods #23958

mokagio · 2025-01-08T07:38:05Z

This is a replay of #23951 but onto #23923, as discussed with @kean here. I copied the PR description below, but you might want to check the original PR, too, for the inline comments.

Notice the base is #23960, which addresses the build failures from #23923, so that we can verify that CI is green with only the CocoaPods changes. Refer to that PR for explanations for UI tests failures, too.

Picks up where #23750, but starting from scratch because of too many project file changes since then, and completes the migration away from CocoaPods as the mean of linking the Gutenberg XCFramework.

The sequence of changes is roughly:

De-integrate CocoaPods
Drag-n-drop the xcframeworks
Tweak build settings to work around compilation errors due to the frameworks see fbb0997 and 4a29aea
Update the script that copies the React Native App.js file from the XCFramework to the build products as a jsbundle to use the new location
Remove the various "if cocoapods" kind of checks from app code and automation

Theree things noteworthy:

I had to disable a couple of clang checks, CLANG_WARN_STRICT_PROTOTYPES and CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER, because of build failures in the XCFramework imports. It doesn't seem ideal, but also we have increasingly less Objective-C so it should be acceptable. Open to suggestions.
@jkmassel 's implementation had a build phase that downloaded the XCFrameworks sources. I omitted it and expect devs to run make dependencies before building the app. It felt a build phase was a bit too much, but it also feels like a line in the README to call attention to this is not enough. Open to suggestions.
@jkmassel 's implementation also deleted the xcworkspace in favor of using only the xcproject, which makes sense given the workspace was required by the CocoaPods setup which is now gone. I decided not to remove the workspace in this PR just to not add to an already big diff. Also, when I opened the standalone project file, some things weren't working out of the box, so I decide to postpone the move to it.

SwiftLint

SwiftLint was previously fetched via CocoaPods and the automation was configured with that in mind. Removing CocoaPods also removes SwiftLint. In the interest of moving on with the removal process, I didn't provide an alternative setup for SwiftLint. The rake lint task merely prints a "no linter configured" message at the moment. As you can see in CI, this does not affect SwiftLint there, so we still have reliable checks in place.

Testing

I published this from the Simulator: https://giotestdotsite.wordpress.com/2025/01/07/via-gutenbegkit-without-cocoapods/ (please ignore the slug, it's indeed mobile-gunteber) — Not sure if the HTML source can show it, but I did check locally that the experimental editor toggle was disabled. Besides, the UI being a bit different between the two helps being aware of it.

Apart from that, I'd say run the prototype build on device and see if the Gutenber-via-XCFramework editor works as expected.

Regression Notes

Potential unintended areas of impact

It's possible that some behavior in the Gutenber-XCFramework editor will be compromised. However, I don't see why, once the editor loads, all the code should be the same.

What I did to test those areas of impact (or what existing automated tests I relied on)

Had a go at publishing a post from the Simulator.

What automated tests I added (or what prevented me from doing so)

N.A.

PR submission checklist:

I have completed the Regression Notes.
I have considered adding unit tests for my changes. - N.A.
I have considered adding accessibility improvements for my changes. - N.A.
I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary. - N.A.

Testing checklist:

dangermattic · 2025-01-08T07:38:40Z

	2 Warnings
⚠️	`Modules/Package.swift` was changed without updating its corresponding `Package.resolved`. Please resolve the Swift packages as appropriate to your project setup (e.g. in Xcode or by running `swift package resolve`).
⚠️	This PR is larger than 500 lines of changes. Please consider splitting it into smaller PRs for easier and faster reviews.

Generated by 🚫 Danger

wpmobilebot · 2025-01-08T08:25:00Z

📲 You can test the changes from this Pull Request in WordPress Alpha by scanning the QR code below to install the corresponding build.

	App Name	WordPress Alpha
	Configuration	Release-Alpha
	Build Number	pr23958-e79a62d
	Version	25.7.1
	Bundle ID	org.wordpress.alpha
	Commit	`e79a62d`
	App Center Build	WPiOS - One-Offs #11458

Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

wpmobilebot · 2025-01-08T08:25:35Z

📲 You can test the changes from this Pull Request in Jetpack Alpha by scanning the QR code below to install the corresponding build.

	App Name	Jetpack Alpha
	Configuration	Release-Alpha
	Build Number	pr23958-e79a62d
	Version	25.7.1
	Bundle ID	com.jetpack.alpha
	Commit	`e79a62d`
	App Center Build	jetpack-installable-builds #10490

Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

kean · 2025-01-10T12:49:20Z

Hey, nice work. It's a historic moment 😃

I've updated the tests in the target branch. It should be green now. I don't think I should/can review the changes in infra, but you get 👍

kean · 2025-01-10T12:57:16Z

Podfile

-end
-
-abstract_target 'Tools' do
-  pod 'SwiftLint', swiftlint_version


Where does the SwiftLint version get pinned now? It doesn't appear to be in Gemfile. I'd probably suggest trying SwiftPM since this project is not itself a dependency, so it should be fine.

Where does the SwiftLint version get pinned now?

The version is defined in .swiftlint.yml:

WordPress-iOS/.swiftlint.yml

Line 1 in 388dbb1

swiftlint_version: 0.54.0

As for installing the tool, I'm happy to have a go at setting it up via SwiftPM. I ignored the problem for the context of this PR because there was already a lot going on.

I was also keen to ask everyone in the team what they'd prefer to do for provisioning. @jkmassel and I discussed. in the past the idea of having Apps Infra recommend and maintain a golden path for integration (which was CocoaPods but now needs to be updated) but leave the teams the option to decide how to go about it. For example, some people/team in the past expressed the feeling that running the linter on every build was too much friction when just hammering code together and they'd rather get linter feedback in the PR via CI only.

I'd suggest removing swiftlint_version from .swiftlint.yml and pinning it using SwiftPM. It should solve both issues: installation and pinning. Wdyt?

Note: I never tried it. I usually use Gemfile for tools.

rather get linter feedback in the PR via CI only

I'm sorry, I don't believe anyone would've preferred this 😄

I'd suggest removing swiftlint_version from .swiftlint.yml and pinning it using SwiftPM. It should solve both issues: installation and pinning. Wdyt?

Sounds good, but... currently the linter expects swiftlint_version to be defined in the config file, see https://github.com/Automattic/a8c-ci-toolkit-buildkite-plugin/blob/29064ab1e6e49135f9700d86b7b3279081b9ebc9/bin/run_swiftlint#L25

I think we could satisfy both the SPM and swiftlint_version requirements by reading the SwiftLint version from the YML in the Package file, see https://github.com/wordpress-mobile/WordPress-iOS-Shared/blob/6e8a44120452b08075d1838506bd632a5f83b044/Package.swift#L55-L77

In the past, that approach has given us trouble when implemented in a dependency, but given this is a root project, we should be fine. I'll try it in a dedicated PR.

~~Just a note that I had a look at this and is not as straightforward as I hoped.~~

~~@kean @crazytonyli @jkmassel would you be okay with merging without the SwiftLint support, developing for a few days without the linter?~~

Update: Still not super straightforward, and with some performance issues. But I have a SwiftPM implementation that ticks most boxes here #23996

If you take a look, you'll see it runs slower than 0.54.0. Depending on the performance consideration, we might consider sticking with CocoaPods just to fetch SwiftLint—at least till SwiftLint addresses the issue. Given it would be used only for a CLI tool outside the project, I'd consider it a minor DX annoyance. Update: I looked better into the numbers and I can say the performance is comparable to what's on trunk with the existing setup. The poor execution time I saw originally on my end was due to configuration issues.

mokagio · 2025-01-10T15:27:18Z

WordPress/Makefile

+	tar -xvf Frameworks/Gutenberg.tar.gz -C Frameworks/ -k
+	mv -n Frameworks/Frameworks/*.xcframework Frameworks/
+	rm -rf Frameworks/Frameworks Frameworks/dummy.txt
+	mkdir -p Frameworks/hermes.xcframework/ios-arm64/dSYMs Frameworks/hermes.xcframework/ios-arm64_x86_64-simulator/dSYMs


Given gutenberg-mobile should have an hopefully short time left in the project, I think this rudimental way to fetch it is acceptable.

Also, the version is not likely to change at all, which again makes me comfortable with simply hardcoding it there and duplicating it it in Fastlane.

Is it possible to use binaryTarget to import gutenberg-mobile via SPM?

If not, can we use the existing Rakefile, instead of adding a new Makefile?

Is it possible to use binaryTarget to import gutenberg-mobile via SPM?

I haven't tried using SwiftPM directly yet. I inherited this setup from #23750 and it worked 😄 How about trying it as a followup?

If not, can we use the existing Rakefile, instead of adding a new Makefile?

Yeah, that's a good point. I'll take care of it.

mokagio · 2025-01-10T15:28:16Z

WordPressAuthenticator/Sources/Services/LoginFacade.m

-#import "WPAuthenticator-Swift.h"
+#import <WordPressAuthenticator/WordPressAuthenticator-Swift.h>


The header above was necessary when the lib was distributed via CocoaPods, but now we can access the Xcode-generated one directly.

This is unrelated with the CP removal for Gutenberg, but I noticed it when grepping "CocoaPods".

Modules/Package.swift

kean · 2025-01-13T23:15:39Z

Hey, we've merged the feature branch in trunk, so please feel free to continue the work branching from trunk.

I run `grep swiftlint` in the context of replacing the CocoaPods installation with a SwiftPM one, #23958 (comment), and got a hit on `.hound.yml`. We have not been using Hound since at least a year, see paaHJt-68e-p2, so there is no reason to keep carrying the config file in the repo.

crazytonyli · 2025-02-04T23:02:18Z

Hey @mokagio , there are whole lots of unrelated commits in this PR. You may want to remove them before merging this PR?

We don't have pods anymore

We don't use Pods anymore

See wordpress-mobile/AztecEditor-iOS#1379

mokagio · 2025-02-05T06:02:32Z

@crazytonyli

If not, can we use the existing Rakefile, instead of adding a new Makefile?

Done in d7d0010

crazytonyli · 2025-02-05T06:33:08Z

Scripts/BuildPhases/CopyGutenbergJS.sh


 BUNDLE_FILE="$DEST/main.jsbundle"
 BUNDLE_ASSETS="$DEST/assets/"

 if [[ -d $XCFRAMEWORK_BUNDLE_ROOT ]]; then
+  set +x


Should this line be removed?

crazytonyli · 2025-02-05T06:34:41Z

Rakefile

+    sh "curl https://cdn.a8c-ci.services/gutenberg-mobile/Gutenberg-#{GUTENBERG_VERSION}.tar.gz --output #{gutenberg_tar_gz_download_path} -C -"
+    sh "tar -xf #{gutenberg_tar_gz_download_path} -C #{frameworks_dir}/ -k"
+    sh "mv -n #{frameworks_dir}/Frameworks/*.xcframework #{frameworks_dir}/"
+    sh "rm -rf #{frameworks_dir}/Frameworks #{frameworks_dir}/dummy.txt"


Nitpick: FileUtils has API for mkdir, mv, and rm commands.

Worked on it through 1590586 and 2d542d1. Pushed it forward too, re-implementing the download and unarchiving in Ruby (with Cursor's help)

Thanks for looking into it! It'd be nice if Rake has a feature to download a file (with checksum would be even nicer) and unzip a file.

More idiomatic and safer than shelling out. See #23958 (comment)

crazytonyli

Thanks for working on this! And, bye-bye CocoaPods 🥳

mokagio added this to the 25.8 milestone Jan 8, 2025

mokagio added the Tooling Build, Release, and Validation Tools label Jan 8, 2025

mokagio self-assigned this Jan 8, 2025

This was referenced Jan 8, 2025

Remove CocoaPods #23951

Closed

Address localization and test build failures #23960

Merged

mokagio requested review from jkmassel and kean January 8, 2025 10:09

mokagio changed the base branch from christmas-feature-branch to mokagio/christmas-build-failures January 8, 2025 10:36

mokagio force-pushed the mokagio/remove-cocoapods-christmast-branch branch from 96e2bd8 to 1e62678 Compare January 8, 2025 10:37

mokagio marked this pull request as ready for review January 8, 2025 15:57

Base automatically changed from mokagio/christmas-build-failures to christmas-feature-branch January 9, 2025 17:05

mokagio force-pushed the mokagio/remove-cocoapods-christmast-branch branch from 1e62678 to b2e22a1 Compare January 10, 2025 10:58

kean closed this Jan 10, 2025

kean reopened this Jan 10, 2025

kean reviewed Jan 10, 2025

View reviewed changes

mokagio requested a review from a team January 10, 2025 15:24

mokagio commented Jan 10, 2025

View reviewed changes

twstokes reviewed Jan 10, 2025

View reviewed changes

Modules/Package.swift Outdated Show resolved Hide resolved

Base automatically changed from christmas-feature-branch to trunk January 13, 2025 20:35

mokagio mentioned this pull request Jan 18, 2025

Remove .hound.yml #23989

Merged

mokagio mentioned this pull request Jan 22, 2025

Set up SwiftLint as a standalone build plugin #23996

Merged

4 tasks

mokagio added 15 commits February 5, 2025 16:26

Fetch XCFrameworks in CI

68de618

Update Gutenberg checkout logic in localization lint for CP-less setup

4f278b4

Update source map upload for CP-less Gutenberg setup

a2b442c

Ensure Frameworks folder exist, otherwise tar will fail

00d7d8d

Remove "Log Outdated Pods" step from code freeze

2b9c1a6

We don't have pods anymore

Remove Pods from lists in .gitignore and RuboCop

4a72faa

We don't use Pods anymore

Remove imports of Pods xcconfigs

9195450

No longer look in Pods folder to extract localizations

d257a3b

Link Gutenberg XCFramework in Jetpack target too!

1435da3

Add instruction in README to run make dependencies

ba06bb6

Use CI toolkit 3.8.0

c31a247

Point Aztec to branch in wordpress-mobile org from SPM support PR

3b25e98

See wordpress-mobile/AztecEditor-iOS#1379

Point Aztec to latest SwiftPM-support commit

2720039

Point to latest Aztec, 1.20.0

1780f9b

Reimplement logic to download XCFrameworks from make to rake

d7d0010

mokagio force-pushed the mokagio/remove-cocoapods-christmast-branch branch from 5189e4b to d7d0010 Compare February 5, 2025 05:47

crazytonyli approved these changes Feb 5, 2025

View reviewed changes

mokagio added 4 commits February 5, 2025 20:13

Remove a debug set +x

afff2e7

Rewrite gutenberg_xcframeworks using Ruby APIs

1590586

More idiomatic and safer than shelling out. See #23958 (comment)

Also delete tar.gz when cleaning up after setting up Gutenberg

2d542d1

Ignore Pods/ for retro-compatibility

e79a62d

crazytonyli approved these changes Feb 6, 2025

View reviewed changes

kean requested review from kean February 10, 2025 15:31

kean approved these changes Feb 10, 2025

View reviewed changes

mokagio added this pull request to the merge queue Feb 11, 2025

Merged via the queue into trunk with commit bb6c179 Feb 11, 2025
25 checks passed

mokagio deleted the mokagio/remove-cocoapods-christmast-branch branch February 11, 2025 03:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove CocoaPods #23958

Remove CocoaPods #23958

mokagio commented Jan 8, 2025 •

edited

Loading

dangermattic commented Jan 8, 2025 •

edited

Loading

wpmobilebot commented Jan 8, 2025 •

edited

Loading

wpmobilebot commented Jan 8, 2025 •

edited

Loading

kean commented Jan 10, 2025 •

edited

Loading

kean Jan 10, 2025

mokagio Jan 10, 2025

kean Jan 10, 2025 •

edited

Loading

mokagio Jan 17, 2025

mokagio Jan 21, 2025 •

edited

Loading

mokagio Jan 10, 2025

crazytonyli Feb 4, 2025

crazytonyli Feb 4, 2025

mokagio Feb 5, 2025

mokagio Jan 10, 2025

kean commented Jan 13, 2025

crazytonyli commented Feb 4, 2025

mokagio commented Feb 5, 2025

crazytonyli Feb 5, 2025

crazytonyli Feb 5, 2025

mokagio Feb 5, 2025

crazytonyli Feb 6, 2025

crazytonyli left a comment

		#import "WPAuthenticator-Swift.h"
		#import <WordPressAuthenticator/WordPressAuthenticator-Swift.h>

Remove CocoaPods #23958

Remove CocoaPods #23958

Conversation

mokagio commented Jan 8, 2025 • edited Loading

SwiftLint

Testing

Regression Notes

dangermattic commented Jan 8, 2025 • edited Loading

wpmobilebot commented Jan 8, 2025 • edited Loading

wpmobilebot commented Jan 8, 2025 • edited Loading

kean commented Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kean Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mokagio Jan 21, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kean commented Jan 13, 2025

crazytonyli commented Feb 4, 2025

mokagio commented Feb 5, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crazytonyli left a comment

Choose a reason for hiding this comment

mokagio commented Jan 8, 2025 •

edited

Loading

dangermattic commented Jan 8, 2025 •

edited

Loading

wpmobilebot commented Jan 8, 2025 •

edited

Loading

wpmobilebot commented Jan 8, 2025 •

edited

Loading

kean commented Jan 10, 2025 •

edited

Loading

kean Jan 10, 2025 •

edited

Loading

mokagio Jan 21, 2025 •

edited

Loading