Update how block editor settings are fetches and stored #24510

kean · 2025-04-29T18:50:24Z

Here the test scenario with fresh install and timeout in the editor set to 300 seconds:

Screen.Recording.2025-04-29.at.3.24.28.PM.mov

dangermattic · 2025-04-29T18:50:54Z

	1 Warning
⚠️	This PR is assigned to the milestone 25.9. The due date for this milestone has already passed. Please assign it to a milestone with a later deadline or check whether the release for this milestone has already been finished.

Generated by 🚫 Danger

kean · 2025-04-29T18:53:23Z

WordPress/Classes/Models/Blog/Blog+Editor.swift

+
+    /// - warning: Decoding can take a non-trivial amount of time.
+    func getBlockEditorSettings() -> [String: Any]? {
+        guard let data = rawBlockEditorSettings?.data else {


The changes ensures that when Blog entity is loaded, the settings blob it not loaded in memory. It is achieved by using a relationship (see BlobEntity) , which is a standard way to approach it. The entity is also configured to store large blobs in external storage, which is more efficient than putting it in a database.

In the previous implementation, the blob was stored in the options dictionary, which is designed for tiny key-value entities and can no be used for large blobs for performance reasons.

The benefits of the new blob store make a lot of sense.

kean · 2025-04-29T18:55:11Z

WordPress/Classes/Services/RawBlockEditorSettingsService.swift

+    /// Refreshes the editor settings in the background.
+    func refreshSettings() {
+        Task { @MainActor in
+            try? await fetchSettings()


The new refreshSettings method does not decode the editor settings. It used to happen every time you open the "My Site" screen and it was relatively expensive, and was happening on the main thread. We don't need to read the current settings to send a request to refresh them.

Avoiding unnecessary decoding is smart.

kean · 2025-04-29T18:55:39Z

WordPress/Classes/Services/RawBlockEditorSettingsService.swift

-                }
-                isRefreshing = false
+    private func fetchSettings() async throws -> [String: Any] {
+        if let task = refreshTask {


This is a standard pattern how you approach this in Swift Concurrency. Task works as a future and can have multiple subscribers.

I see now how proper utilization of Task simplifies the implementation.

kean · 2025-04-29T18:57:47Z

WordPress/Classes/Services/RawBlockEditorSettingsService.swift

@@ -24,48 +25,50 @@ class RawBlockEditorSettingsService {
            guard let dictionary = response as? [String: Any] else {
                throw NSError(domain: "RawBlockEditorSettingsService", code: 1, userInfo: [NSLocalizedDescriptionKey: "Invalid response format"])
            }
-            blog.rawBlockEditorSettings = dictionary
+            let objectID = TaggedManagedObjectID(blog)
+            try? await ContextManager.shared.performAndSave { context in


The previous implementation wasn't performing a save. It now saves and does it in the background.

Is that to say the original storage referenced below was only ever stored in memory and not actually persisted elsewhere?

In the previous implementation, the blob was stored in the options dictionary, which is designed for tiny key-value entities and can no be used for large blobs for performance reasons.

The previous implementation updates blog.rawBlockEditorSettings in memory in an NSManagedObject entity on the main context (main thread), but it never explicitly persists on disk. That's not to say that it never gest persisted. There are other areas of the app that occasionally call try mainContext.save() to their save the in-memory changes on disk. So, it eventually gets saved together with other changes.

The standard concurrency model for working work with Core Data is to save on a background context and only read on main (this is why it's called viewContext in NSPersistentContainer). Unfortunately, we are not strictly following this model.

Thank you for explaining further. 🙇🏻‍♂️

wpmobilebot · 2025-04-29T19:12:15Z

📲 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	`27549`
	Version	`PR #24510`
	Bundle ID	`org.wordpress.alpha`
	Commit	`b381193`
	Installation URL	4eld1j6bhftt8

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

wpmobilebot · 2025-04-29T19:12:27Z

📲 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	`27549`
	Version	`PR #24510`
	Bundle ID	`com.jetpack.alpha`
	Commit	`b381193`
	Installation URL	2f04gr8a4lcv8

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

kean · 2025-04-29T19:20:09Z

WordPress/Classes/Services/RawBlockEditorSettingsService.swift

+    private static var services: [TaggedManagedObjectID<Blog>: RawBlockEditorSettingsService] = [:]
+
+    @MainActor
+    static func getService(forBlog blog: Blog) -> RawBlockEditorSettingsService {


The previous implementation with isRefreshing was ineffective because there were multiple instances of RawBlockEditorSettingsService: one for My Site and one for each editor.

That makes sense now that you call attention to it. I like the new design with static methods for retrieving the individual services.

sonarqubecloud · 2025-04-29T19:22:51Z

Quality Gate passed

Issues
3 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

kean · 2025-04-29T19:27:24Z

WordPress/Classes/WordPress.xcdatamodeld/WordPress 155.xcdatamodel/contents

@@ -182,6 +185,7 @@
        <relationship name="postTypes" optional="YES" toMany="YES" deletionRule="Cascade" destinationEntity="PostType" inverseName="blog" inverseEntity="PostType" syncable="YES"/>
        <relationship name="publicizeInfo" optional="YES" maxCount="1" deletionRule="Cascade" destinationEntity="PublicizeInfo" inverseName="blog" inverseEntity="PublicizeInfo"/>
        <relationship name="quickStartTours" optional="YES" toMany="YES" deletionRule="Cascade" destinationEntity="QuickStartTourState" inverseName="blog" inverseEntity="QuickStartTourState" syncable="YES"/>
+        <relationship name="rawBlockEditorSettings" optional="YES" maxCount="1" deletionRule="Cascade" destinationEntity="BlobEntity" syncable="YES"/>


Note the "cascade" deletion rule, which is what you need.

Thank you for noting this.

dcalhoun

This tested well for me.

I greatly appreciate you taking the time to improve this and explain various aspects of the implementation. Educational for me and a more robust implementation.

dcalhoun · 2025-04-30T13:37:02Z

WordPress/Classes/Models/Blog/Blog+Editor.swift

+
+    /// - warning: Decoding can take a non-trivial amount of time.
+    func getBlockEditorSettings() -> [String: Any]? {
+        guard let data = rawBlockEditorSettings?.data else {


The benefits of the new blob store make a lot of sense.

dcalhoun · 2025-04-30T13:38:56Z

WordPress/Classes/Services/RawBlockEditorSettingsService.swift

+    private static var services: [TaggedManagedObjectID<Blog>: RawBlockEditorSettingsService] = [:]
+
+    @MainActor
+    static func getService(forBlog blog: Blog) -> RawBlockEditorSettingsService {


That makes sense now that you call attention to it. I like the new design with static methods for retrieving the individual services.

dcalhoun · 2025-04-30T13:40:45Z

WordPress/Classes/Services/RawBlockEditorSettingsService.swift

@@ -24,48 +25,50 @@ class RawBlockEditorSettingsService {
            guard let dictionary = response as? [String: Any] else {
                throw NSError(domain: "RawBlockEditorSettingsService", code: 1, userInfo: [NSLocalizedDescriptionKey: "Invalid response format"])
            }
-            blog.rawBlockEditorSettings = dictionary
+            let objectID = TaggedManagedObjectID(blog)
+            try? await ContextManager.shared.performAndSave { context in


Is that to say the original storage referenced below was only ever stored in memory and not actually persisted elsewhere?

In the previous implementation, the blob was stored in the options dictionary, which is designed for tiny key-value entities and can no be used for large blobs for performance reasons.

dcalhoun · 2025-04-30T13:41:51Z

WordPress/Classes/Services/RawBlockEditorSettingsService.swift

+    /// Refreshes the editor settings in the background.
+    func refreshSettings() {
+        Task { @MainActor in
+            try? await fetchSettings()


Avoiding unnecessary decoding is smart.

dcalhoun · 2025-04-30T13:42:31Z

WordPress/Classes/Services/RawBlockEditorSettingsService.swift

-                }
-                isRefreshing = false
+    private func fetchSettings() async throws -> [String: Any] {
+        if let task = refreshTask {


I see now how proper utilization of Task simplifies the implementation.

dcalhoun · 2025-04-30T13:43:03Z

WordPress/Classes/WordPress.xcdatamodeld/WordPress 155.xcdatamodel/contents

@@ -182,6 +185,7 @@
        <relationship name="postTypes" optional="YES" toMany="YES" deletionRule="Cascade" destinationEntity="PostType" inverseName="blog" inverseEntity="PostType" syncable="YES"/>
        <relationship name="publicizeInfo" optional="YES" maxCount="1" deletionRule="Cascade" destinationEntity="PublicizeInfo" inverseName="blog" inverseEntity="PublicizeInfo"/>
        <relationship name="quickStartTours" optional="YES" toMany="YES" deletionRule="Cascade" destinationEntity="QuickStartTourState" inverseName="blog" inverseEntity="QuickStartTourState" syncable="YES"/>
+        <relationship name="rawBlockEditorSettings" optional="YES" maxCount="1" deletionRule="Cascade" destinationEntity="BlobEntity" syncable="YES"/>


Thank you for noting this.

kean added 2 commits April 29, 2025 14:37

Store editor settings in BlobEntity

42fb669

Simplify how RawBlockEditorSettingsService fetches settings

ca11926

kean added the General label Apr 29, 2025

kean added this to the 25.9 milestone Apr 29, 2025

kean commented Apr 29, 2025

View reviewed changes

Fix cast

f362632

kean force-pushed the task/store-cached-blog-settings-in-blob branch from 2a4c34d to f362632 Compare April 29, 2025 19:01

Add shared registry of RawBlockEditorSettingsService objects

c179e9e

kean force-pushed the task/store-cached-blog-settings-in-blob branch from c38886e to c179e9e Compare April 29, 2025 19:19

kean commented Apr 29, 2025

View reviewed changes

Remove unused isRefreshing

b381193

kean requested a review from dcalhoun April 29, 2025 19:21

kean commented Apr 29, 2025

View reviewed changes

kean enabled auto-merge April 29, 2025 20:43

dcalhoun approved these changes Apr 30, 2025

View reviewed changes

kean added this pull request to the merge queue Apr 30, 2025

Merged via the queue into trunk with commit 3c85f36 Apr 30, 2025
32 of 34 checks passed

kean deleted the task/store-cached-blog-settings-in-blob branch April 30, 2025 14:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update how block editor settings are fetches and stored #24510

Update how block editor settings are fetches and stored #24510

kean commented Apr 29, 2025 •

edited

Loading

dangermattic commented Apr 29, 2025

kean Apr 29, 2025 •

edited

Loading

dcalhoun Apr 30, 2025

kean Apr 29, 2025

dcalhoun Apr 30, 2025

kean Apr 29, 2025

dcalhoun Apr 30, 2025

kean Apr 29, 2025 •

edited

Loading

dcalhoun Apr 30, 2025 •

edited

Loading

kean Apr 30, 2025

dcalhoun Apr 30, 2025

wpmobilebot commented Apr 29, 2025 •

edited

Loading

wpmobilebot commented Apr 29, 2025 •

edited

Loading

kean Apr 29, 2025

dcalhoun Apr 30, 2025

sonarqubecloud bot commented Apr 29, 2025

kean Apr 29, 2025

dcalhoun Apr 30, 2025

dcalhoun left a comment

dcalhoun Apr 30, 2025

dcalhoun Apr 30, 2025

dcalhoun Apr 30, 2025 •

edited

Loading

dcalhoun Apr 30, 2025

dcalhoun Apr 30, 2025

dcalhoun Apr 30, 2025

Update how block editor settings are fetches and stored #24510

Update how block editor settings are fetches and stored #24510

Conversation

kean commented Apr 29, 2025 • edited Loading

dangermattic commented Apr 29, 2025

kean Apr 29, 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 Apr 29, 2025 • edited Loading

Choose a reason for hiding this comment

dcalhoun Apr 30, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wpmobilebot commented Apr 29, 2025 • edited Loading

wpmobilebot commented Apr 29, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Apr 29, 2025

Quality Gate passed

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dcalhoun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dcalhoun Apr 30, 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

kean commented Apr 29, 2025 •

edited

Loading

kean Apr 29, 2025 •

edited

Loading

kean Apr 29, 2025 •

edited

Loading

dcalhoun Apr 30, 2025 •

edited

Loading

wpmobilebot commented Apr 29, 2025 •

edited

Loading

wpmobilebot commented Apr 29, 2025 •

edited

Loading

dcalhoun Apr 30, 2025 •

edited

Loading