Extract the GBK editor parts to a super class #25166

crazytonyli · 2026-01-25T20:11:28Z

Description

This PR extracts the wiring GBK editor code to a new class PostGBKEditorViewController, which is ~~not~~ now the superclass of the existing NewGutenbergViewController.swift.

There is no much actual code changes other than moving them. However, there is one runtime change (the only one that I noticed): the order of function calls in viewDidLoad: previously, createRevisionOfPost was the first, but now it's the last. I have examined the implementation, and I don't think this change would cause any practical issues.

Note

I highly recommend reviewing this PR commit by commit. You'll see the exact code movement from there.

Testing instructions

Smoke test the GBK editor.

sonarqubecloud · 2026-01-25T20:14:14Z

Quality Gate passed

Issues
47 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

dangermattic · 2026-01-25T20:15:27Z

	1 Warning
⚠️	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 · 2026-01-26T07:34:17Z

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

	App Name	WordPress
	Configuration	Release-Alpha
	Build Number	`30596`
	Version	`PR #25166`
	Bundle ID	`org.wordpress.alpha`
	Commit	`f452c12`
	Installation URL	6pj1pougqhp4g

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

wpmobilebot · 2026-01-26T07:40:45Z

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

	App Name	Jetpack
	Configuration	Release-Alpha
	Build Number	`30596`
	Version	`PR #25166`
	Bundle ID	`com.jetpack.alpha`
	Commit	`f452c12`
	Installation URL	6oqrtgu4e9s48

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

wpmobilebot · 2026-01-26T08:09:27Z

🤖 Build Failure Analysis

This build has failures. Claude has analyzed them - check the build annotations for details.

kean · 2026-01-26T17:35:34Z

This PR extracts the wiring GBK editor code to a new class PostGBKEditorViewController, which is not the superclass of the existing NewGutenbergViewController.swift.

Hey, can you provide a bit of rationale for the change please? What is the problem it solves? Were there alternative options?

crazytonyli · 2026-01-26T18:56:10Z

@kean Sorry, there is a typo there. I meant to write "PostGBKEditorViewController is ~~not~~ now the superclass of the existing NewGutenbergViewController.swift." With that correction, do you have the same questions?

kean · 2026-01-26T21:03:43Z

Yes, what's the goal of extracting a superclass? NewGutenbergViewController and PostGBKEditorViewController is one screen. There is no logical way to extract code from it or split it.

Inheritance, in general, makes code harder to reason about.

crazytonyli · 2026-01-26T21:20:10Z

@kean My bad. I should have included more context in the PR description. I will implement a new post editor, inheriting from the PostGBKEditorViewController, to support editing custom posts (relates to your comment in #25157 (comment)). Soon, we'll be able to reuse the new superclass to support editing both post types, and the UI will look similar to what users are used to.

I don't think it makes sense to add custom post support to the NewGutenbergViewController, which implements PostEditor (tightly coupled with AbstractPost). It's going to be messy to support editing another model (AnyPostWithEditContext from the Rust library). And most importantly, custom post support is very new, and at the moment, there are many things you can do with regular posts and pages that you cannot do with custom posts, like offline editing, updating post settings, viewing revisions, resolving conflicts, etc.

I imagine, in the long run, as we add features to the custom post type support, it will be able to be used to edit regular posts and pages, too. And, by then, we no longer need NewGutenbergViewController.

kean · 2026-01-26T21:42:57Z

are many things you can do with regular posts and pages that you cannot do with custom posts, like offline editing, updating post settings, viewing revisions, resolving conflicts, etc.

That's a lot of features to re-implement and they all rely on Core Data, just like the rest of the app.

crazytonyli · 2026-01-26T21:54:38Z

I have not looked into all those features, so I can't say for sure. But I don't imagine we'll write brand-new code to reimplement them for custom posts. We have reused the same UI to add tags (Core Data) and custom terms (the Rust library). That'd be the first thing to explore for the custom post features, too.

kean

The PR looks good. I'm give another pass tomorrow to review the remaining bits.

It makes sense to have a component that provides some defaults on top of GBK's ViewController and have different screens that use them. One more area is the "Comment Editor" that isn't completed yet. I would however suggest considering using composition in NewGutenbergViewController – add GBKEditor on top of it.

kean

Hey, I finished the review and added a couple of comments. I assume that the code was moved, so I focused mainly on the overall design.

@dcalhoun, if you also want to weight in, please do.

kean · 2026-01-30T20:20:07Z

WordPress/Classes/ViewRelated/NewGutenberg/PostGBKEditorViewController.swift

+        self.blog = blog
+        self.navigationBarManager = PostEditorNavigationBarManager()
+
+        EditorLocalization.localize = { $0.localized }


(nit) Should probably bet set once on app launch (existing code)

kean · 2026-01-30T20:22:39Z

WordPress/Classes/ViewRelated/NewGutenberg/NewGutenbergViewController.swift

-        }
-    }
+/*
+ Fix issue: Non-'@objc' instance method 'editorDidLoad' declared in 'PostGBKEditorViewController' cannot be overridden from extension


You should be able to eliminate this by moving these methods toe the main class declaration outside of the extension.

seealso: Extract the GBK editor parts to a super class #25166 (review). A cleaner way to implement it would probably be by using composition and providing a separate set of customization points in GBKViewController instead of overriding a subset of the existing GutenbergKit.EditorViewControllerDelegate methods.

I intentionally did not change the API in this PR, because the main purpose are 1) to get rid of the new SimpleGBKEditorViewController in #25157, and 2) minimal changes (in terms of runtime behaviour) to the existing code to make PR easier to review and quick to merge.

In future PRs, I'll start using the new super class in the custom post editor, and make further changes to the API.

kean · 2026-01-30T20:23:06Z

WordPress/Classes/ViewRelated/NewGutenberg/PostGBKEditorViewController.swift

+    let blog: Blog
+    let navigationBarManager: PostEditorNavigationBarManager
+
+    /* private */ let editorViewController: GutenbergKit.EditorViewController


(nit) Are you planning to address these comment before merging?

kean · 2026-01-30T20:24:47Z

WordPress/Classes/ViewRelated/NewGutenberg/PostGBKEditorViewController.swift

+    // MARK: - PostEditorNavigationBarManagerDelegate
+
+    var publishButtonText: String {
+        wpAssertionFailure("To be implemented by subclasses")


(nit) This is another area where composition would be probably better/cleaner. I would probably recommend to move PostEditorNavigationBar entirely out of GBKEditorViewController. If we end up using GBKEditorViewController for comments, it won't even use the same navigation bar.

dcalhoun · 2026-01-30T20:28:06Z

@dcalhoun, if you also want to weight in, please do.

Thanks for the reminder. I plan to review, but it may be next week. No worries if we need to merge before I provide feedback. This is on my list.

crazytonyli added 30 commits January 25, 2026 20:20

Create a new PostGBKEditorViewController super class

73bb0fb

Remove an unused initialiser

a6fc3d7

Remove unused parameters

ff5ecba

Move initialiser to the super class

94efa5c

Add empty EditorViewControllerDelegate implementation

65199d0

Add empty PostEditorNavigationBarManagerDelegate implementation

54aca0f

Add override keywords

c4a3f8d

Move PostEditorNavigationBarManagerDelegate implementation

9b8f6f0

Add override keywords

715a8a4

Remove private keyword

f6b7b3e

Remove empty override functions

c6b6826

Move didUpdateHistoryState delegate function to the super class

1e6144b

Move didLogException delegate function to the super class

a165d71

Move modal dialog delegate functions to the super class

20a16e3

Move undo redo delegate functions to the super class

3d0b473

Move keyboard observers to the super class

f0cf75c

Call setupKeyboardObservers in the super class

890ab3c

Move showSuggestions function to the super class

9147c85

Move didTriggerAutocompleter to the super class

b35e258

Move setting background

b66faed

Move deinit to the super class

ab3a0e1

Move setupEditorView() to the super class

7d05cc4

Move configureNavigationBar to the super class

32e4acb

Allow overriding makeMoreMenu

d0c92a7

Move loadAuthenticationCookiesAsync to the super class

acaada5

Move prefetchSuggestionsIfNeeded to the super class

22f0796

Move refreshInterface to the super class

1a2c8c4

Move the super class to its own file

8cead76

Move extension functions out to its own file

7e2cea6

Add missing imports

a140993

Add an extension: EditorLocalizableString.localized

f452c12

crazytonyli added this to the 26.7 milestone Jan 25, 2026

crazytonyli requested a review from kean January 25, 2026 20:11

crazytonyli added the Posting/Editing label Jan 25, 2026

kean requested a review from dcalhoun January 26, 2026 21:24

kean reviewed Jan 30, 2026

View reviewed changes

Extract the GBK editor parts to a super class #25166

Are you sure you want to change the base?

Extract the GBK editor parts to a super class #25166

Conversation

crazytonyli commented Jan 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing instructions

Uh oh!

sonarqubecloud bot commented Jan 25, 2026

Quality Gate passed

Uh oh!

dangermattic commented Jan 25, 2026

Uh oh!

wpmobilebot commented Jan 26, 2026

Uh oh!

wpmobilebot commented Jan 26, 2026

Uh oh!

wpmobilebot commented Jan 26, 2026

🤖 Build Failure Analysis

Uh oh!

kean commented Jan 26, 2026

Uh oh!

crazytonyli commented Jan 26, 2026

Uh oh!

kean commented Jan 26, 2026

Uh oh!

crazytonyli commented Jan 26, 2026

Uh oh!

kean commented Jan 26, 2026

Uh oh!

crazytonyli commented Jan 26, 2026

Uh oh!

kean left a comment

Choose a reason for hiding this comment

Uh oh!

kean left a comment

Choose a reason for hiding this comment

Uh oh!

kean Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

kean Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

crazytonyli Feb 1, 2026

Choose a reason for hiding this comment

Uh oh!

kean Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

kean Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dcalhoun commented Jan 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

crazytonyli commented Jan 25, 2026 •

edited

Loading

kean Jan 30, 2026 •

edited

Loading