Change the Gutenberg integration to use XCFramework #20717

mokagio · 2023-05-21T10:09:00Z

This one was a long time coming... kept having to tweak the setup 😰

This PRs adds all the setup necessary to fetch and use Gutenberg as an XCFramework via commit or tag.

The setup is relatively straightforward. If Gutenberg/version.rb specifies a commit, the code that declares the pod 'Gutenberg' dependency will try and fetch the podspec for that commit from our CDN.

You can see the setup in action in #20792 and #20845. In #20845 in particular, notice how everything is green apart from a UI test which is 1) unrelated to the editor (insights) and 2) most likely failing due to async behavior.

Notice that this PR doesn't switch Gutenberg to a commit or tag. Assuming this PR will be merged before the next minor version of Gutenberg ships (meaning 1.98.0), the switch will happen when the Gutenberg folks update to that new version.

Testing

You can try replicating the changes from #20792 locally, then run bundle exec pod install. Verify then that the editor works as expected. @fluiddot @geriux @SiobhyB @dcalhoun I'd appreciate your input as well as knowing if I wired up things correctly. Thanks!

Regression Notes

Potential unintended areas of impact – N.A.
What I did to test those areas of impact (or what existing automated tests I relied on) – N.A.
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.

UI changes testing checklist: Not a UI PR.

wpmobilebot · 2023-05-25T12:53:03Z

📲 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	pr20717-d6dd34e
	Version	22.7
	Bundle ID	com.jetpack.alpha
	Commit	`d6dd34e`
	App Center Build	jetpack-installable-builds #5256

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

wpmobilebot · 2023-05-25T12:53:16Z

📲 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	pr20717-d6dd34e
	Version	22.7
	Bundle ID	org.wordpress.alpha
	Commit	`d6dd34e`
	App Center Build	WPiOS - One-Offs #6230

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

Gutenberg/Gutenberg.podspec

mokagio · 2023-06-13T04:01:20Z

.buildkite/cache-builder.yml

-    IMAGE_ID: xcode-14.2
+    IMAGE_ID: xcode-14.3.1


Admittedly, this was unrelated with the Gutenberg setup.

I did run into some Xcode version compatibility issue during the long development of this integration, but I think it should no longer be a problem.

Having said that, I think we might as well use the latest toolchain, no?

Co-authored-by: Tony Li <tony.li@automattic.com>

wpmobilebot · 2023-07-04T03:54:28Z

Gutenberg/cocoapods_helpers.rb

+  #
+  #   [!] An error occurred while processing the post-install hook of the Podfile.
+  #
+  #   No such file or directory @ rb_sysopen - /Users/gio/Developer/a8c/wpios/Users/gio/Developer/a8c/wpios/Gutenberg/../../gutenberg-mobile/gutenberg/node_modules/react-native/package.json


🚫 Line is too long. [189/180]

fluiddot · 2023-07-05T17:33:12Z

Heads up that I updated the PR related to the RN upgrade 0.71.11 with these changes. I'm happy to share that the installable builds were created 🎊.

There are only two minor changes on that PR compared to this one:

fluiddot · 2023-07-06T16:40:50Z

@mokagio Heads up that I created this PR to fix the current failures we have in CI jobs. Let me know if you could take a look, thanks 🙇 !

mokagio · 2023-07-07T05:03:53Z

Thanks @fluiddot!

I received your message but I might run out of time to look into it today. I have a lot of PRs to review for the upcoming 22.8 code freeze.

fluiddot · 2023-07-07T08:01:20Z

Thanks @fluiddot!

I received your message but I might run out of time to look into it today. I have a lot of PRs to review for the upcoming 22.8 code freeze.

No worries at all @mokagio. We can revisit this next week if you have more availability. Thanks!

UPDATE: I've just realized you will be away next week, so we can postpone this to the week after the next one.

# Conflicts: # Podfile.lock

fluiddot · 2023-07-19T16:17:28Z

@mokagio Heads up that I've updated the PR with trunk to get recent changes. From my side the PR is ready but I understand that we'd need first to land:

[Gutenberg] Tweak Pod dependencies based on React Native version used by Gutenberg #21021
Fixes introduced in Test alternative Gutenberg + XCFramework + Hermes setup #21128

Let me know if I'm missing anything to set the XCFramework integration ready.

The UI tests are still failing even when using the latest changes introduced in the editor. We should keep investigating how to address them.

Regarding the merge, I'd like to note that since we need changes from the React Native upgrade, we should wait until those changes are merged. Alternatively, I'm updating #20956 with all changes needed for the RN upgrade. Maybe it's easier to merge them through that PR.

Co-authored-by: Olivier Halligon <olivier.halligon@automattic.com>

fluiddot · 2023-07-21T08:58:14Z

Closing in favor of #20956, as these changes need to be merged along with the React Native upgrade 0.71.11.

Heads up that I'll re-assign current reviewers to that PR to validate the XCFramework integration. Thanks for your help 🙇 !

mokagio force-pushed the mokagio/gutenberg-xcframework-setup branch from d8bd8f1 to cc51e8b Compare May 22, 2023 04:34

mokagio mentioned this pull request May 22, 2023

Extract build phase to copy Gutenberg resources in script #20719

Merged

4 tasks

mokagio force-pushed the mokagio/gutenberg-xcframework-setup branch 2 times, most recently from a2500f3 to cb4b3e0 Compare May 23, 2023 04:26

mokagio changed the title ~~Changed Gutenberg integration to use XCFramework~~ Change the Gutenberg integration to use XCFramework May 24, 2023

mokagio mentioned this pull request May 24, 2023

Setup for CocoaPods and SPM distribution woocommerce/WooCommerce-Shared#5

Merged

mokagio force-pushed the mokagio/gutenberg-xcframework-setup branch from cb4b3e0 to 25884d2 Compare May 25, 2023 03:56

mokagio mentioned this pull request May 25, 2023

Test – Point Gutenberg to a commit to verify XCFramework setup #20741

Closed

mokagio force-pushed the mokagio/gutenberg-xcframework-setup branch from 25884d2 to 6f74940 Compare May 25, 2023 12:12

mokagio force-pushed the mokagio/gutenberg-xcframework-setup branch 2 times, most recently from 0ff26e5 to 5b7a7b7 Compare June 2, 2023 03:17

mokagio commented Jun 2, 2023

View reviewed changes

Gutenberg/Gutenberg.podspec Outdated Show resolved Hide resolved

mokagio force-pushed the mokagio/gutenberg-xcframework-setup branch 3 times, most recently from ec6fe5f to b2ecf7b Compare June 5, 2023 11:30

mokagio marked this pull request as ready for review June 5, 2023 11:42

mokagio marked this pull request as draft June 5, 2023 11:42

mokagio force-pushed the mokagio/gutenberg-xcframework-setup branch 5 times, most recently from 056d7c5 to 1df239d Compare June 13, 2023 03:58

mokagio commented Jun 13, 2023

View reviewed changes

mokagio force-pushed the mokagio/gutenberg-xcframework-setup branch 2 times, most recently from af3b326 to 081ea98 Compare June 13, 2023 08:48

mokagio requested a review from crazytonyli June 13, 2023 09:25

mokagio added the Tooling Build, Release, and Validation Tools label Jun 13, 2023

mokagio added this to the 22.7 milestone Jun 13, 2023

mokagio and others added 2 commits July 3, 2023 15:51

DRY logic setting Gutenberg URL when using tag or commit

4726973

Co-authored-by: Tony Li <tony.li@automattic.com>

Simplify gutenberg_dependencies with early return

c2c46cc

Co-authored-by: Tony Li <tony.li@automattic.com>

mokagio force-pushed the mokagio/gutenberg-xcframework-setup branch from 0f8cc00 to c2c46cc Compare July 3, 2023 05:52

mokagio added 3 commits July 4, 2023 13:22

Update Gutenberg local setup to work with React Native 0.71.11

59d7b78

Add calls to RN hooks when using Gutenberg from local path

d03be58

Update build script to run locally without a Gutenberg App.js

3fcd1b5

mokagio force-pushed the mokagio/gutenberg-xcframework-setup branch from f1c05f5 to 3fcd1b5 Compare July 4, 2023 03:23

mokagio mentioned this pull request Jul 4, 2023

HACK – Publish an XCFramework build for 1.98.1 wordpress-mobile/gutenberg-mobile#5932

Closed

wpmobilebot reviewed Jul 4, 2023

View reviewed changes

fluiddot mentioned this pull request Jul 5, 2023

[Gutenberg] Upgrade React Native 0.71.11 #20956

Merged

13 tasks

fluiddot added 2 commits July 6, 2023 16:57

Shrink inline comment of gutenberg_post_install helper

b6b8d9c

Update Podfile.lock file

d6dd34e

fluiddot mentioned this pull request Jul 6, 2023

[Gutenberg] Tweak Pod dependencies based on React Native version used by Gutenberg #21021

Closed

13 tasks

mokagio modified the milestones: 22.8, 22.9 Jul 7, 2023

mokagio mentioned this pull request Jul 18, 2023

Experiment: Mobile Gutenberg as an XCFramework #20532

Closed

mokagio and others added 3 commits July 18, 2023 21:32

Add build phase to prevent nested frameworks

d81f466

Remove outdated Xcode 12.5 mention from nested frameworks linter

f875968

Merge branch 'trunk' into mokagio/gutenberg-xcframework-setup

9192af0

# Conflicts: # Podfile.lock

mokagio and others added 2 commits July 20, 2023 09:47

Reintroduce link to internal doc with "Do Not Embed" explanation

723f8ed

Co-authored-by: Olivier Halligon <olivier.halligon@automattic.com>

Add build phase to detect nested frameworks (#21130)

e39537b

fluiddot closed this Jul 21, 2023

auto-merge was automatically disabled July 21, 2023 08:58
Pull request was closed

mokagio deleted the mokagio/gutenberg-xcframework-setup branch July 24, 2023 06:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change the Gutenberg integration to use XCFramework #20717

Change the Gutenberg integration to use XCFramework #20717

mokagio commented May 21, 2023 •

edited

Loading

wpmobilebot commented May 25, 2023 •

edited

Loading

wpmobilebot commented May 25, 2023 •

edited

Loading

mokagio Jun 13, 2023

wpmobilebot Jul 4, 2023

fluiddot commented Jul 5, 2023

fluiddot commented Jul 6, 2023

mokagio commented Jul 7, 2023

fluiddot commented Jul 7, 2023 •

edited

Loading

fluiddot commented Jul 19, 2023

fluiddot commented Jul 21, 2023

Change the Gutenberg integration to use XCFramework #20717

Change the Gutenberg integration to use XCFramework #20717

Conversation

mokagio commented May 21, 2023 • edited Loading

Testing

Regression Notes

wpmobilebot commented May 25, 2023 • edited Loading

wpmobilebot commented May 25, 2023 • edited Loading

mokagio Jun 13, 2023

Choose a reason for hiding this comment

wpmobilebot Jul 4, 2023

Choose a reason for hiding this comment

fluiddot commented Jul 5, 2023

fluiddot commented Jul 6, 2023

mokagio commented Jul 7, 2023

fluiddot commented Jul 7, 2023 • edited Loading

fluiddot commented Jul 19, 2023

fluiddot commented Jul 21, 2023

mokagio commented May 21, 2023 •

edited

Loading

wpmobilebot commented May 25, 2023 •

edited

Loading

wpmobilebot commented May 25, 2023 •

edited

Loading

fluiddot commented Jul 7, 2023 •

edited

Loading