Adopt GutenbergKit EditorConfigurationBuilder

Author: jkmassel

Modules/Package.resolved

@@ -53,7 +53,7 @@ let package = Package(
         .package(url: "https://github.com/zendesk/support_sdk_ios", from: "8.0.3"),
         // We can't use wordpress-rs branches nor commits here. Only tags work.
         .package(url: "https://github.com/Automattic/wordpress-rs", revision: "alpha-20250901"),
-        .package(url: "https://github.com/wordpress-mobile/GutenbergKit", revision: "d81b8ca022d5db9e33f66bb93133a63d053426ee"),
+        .package(url: "https://github.com/wordpress-mobile/GutenbergKit", revision: "f3e64e4d7edc60a5c09b84e9421aa80516231414"),
         .package(
             url: "https://github.com/Automattic/color-studio",
             revision: "bf141adc75e2769eb469a3e095bdc93dc30be8de"

Modules/Package.swift

@@ -47,4 +47,22 @@ extension Blog {
     @objc public var isGutenbergEnabled: Bool {
         return editor == .gutenberg
     }
+
+    func getBlockEditorSettings() -> Data? {
+        guard let data = rawBlockEditorSettings?.data else {
+            return nil
+        }
+
+        return data
+    }
+
+    func setRawBlockEditorSettings(_ settings: Data) {
+        guard let context = managedObjectContext else {
+            return wpAssertionFailure("missing managed object context")
+        }
+
+        let blob = NSEntityDescription.insertNewObject(forEntityName: "BlobEntity", into: context) as! BlobEntity
+        blob.data = settings
+        self.rawBlockEditorSettings = blob
+    }
 }

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

@@ -21,28 +21,20 @@ final class BlockEditorCache {
 
     // MARK: - Block Settings
 
-    func saveBlockSettings(_ settings: [String: Any], for blogID: TaggedManagedObjectID<Blog>) {
+    func saveBlockSettings(_ settings: Data, for blogID: TaggedManagedObjectID<Blog>) throws {
         let fileURL = makeBlockSettingsURL(for: blogID)
-
-        do {
-            let data = try JSONSerialization.data(withJSONObject: settings, options: [.prettyPrinted])
-            try data.write(to: fileURL)
-        } catch {
-            DDLogError("Failed to save block editor settings: \(error)")
-        }
+        try settings.write(to: fileURL)
     }
 
-    func getBlockSettings(for blogID: TaggedManagedObjectID<Blog>) -> [String: Any]? {
+    func getBlockSettings(for blogID: TaggedManagedObjectID<Blog>) -> Data? {
         let fileURL = makeBlockSettingsURL(for: blogID)
 
         guard FileManager.default.fileExists(atPath: fileURL.path) else {
             return nil
         }
 
         do {
-            let data = try Data(contentsOf: fileURL)
-            let object = try JSONSerialization.jsonObject(with: data, options: [])
-            return object as? [String: Any]
+            return try Data(contentsOf: fileURL)
         } catch {
             DDLogError("Failed to load block editor settings: \(error)")
             // If the file is corrupted, delete it

WordPress/Classes/Services/BlockEditorCache.swift

@@ -4,8 +4,9 @@ import WordPressKit
 import WordPressShared
 
 final class RawBlockEditorSettingsService {
+
     private let blog: Blog
-    private var refreshTask: Task<[String: Any], Error>?
+    private var refreshTask: Task<Data, Error>?
 
     init(blog: Blog) {
         self.blog = blog
@@ -24,27 +25,6 @@ final class RawBlockEditorSettingsService {
         return service
     }
 
-    @MainActor
-    private func fetchSettingsFromAPI() async throws -> [String: Any] {
-        guard let remoteAPI = WordPressOrgRestApi(blog: blog) else {
-            throw URLError(.unknown) // Should not happen
-        }
-        let result = await remoteAPI.get(path: "/wp-block-editor/v1/settings")
-        switch result {
-        case .success(let response):
-            guard let dictionary = response as? [String: Any] else {
-                throw NSError(domain: "RawBlockEditorSettingsService", code: 1, userInfo: [NSLocalizedDescriptionKey: "Invalid response format"])
-            }
-            let blogID = TaggedManagedObjectID(blog)
-            Task {
-                await saveSettingsInBackground(dictionary, for: blogID)
-            }
-            return dictionary
-        case .failure(let error):
-            throw error
-        }
-    }
-
     /// Refreshes the editor settings in the background.
     func refreshSettings() {
         Task { @MainActor in
@@ -53,7 +33,7 @@ final class RawBlockEditorSettingsService {
     }
 
     @MainActor
-    private func fetchSettings() async throws -> [String: Any] {
+    private func fetchSettings() async throws -> Data {
         if let task = refreshTask {
             return try await task.value
         }
@@ -70,23 +50,55 @@ final class RawBlockEditorSettingsService {
         return try await task.value
     }
 
+    private func fetchSettingsFromAPI() async throws -> Data {
+        guard let remoteAPI = WordPressOrgRestApi(blog: blog) else {
+            throw URLError(.unknown)
+        }
+
+        guard let remoteAPI = WordPressOrgRestApi(blog: blog) else {
+            throw URLError(.unknown) // Should not happen
+        }
+
+        let data: Data = try await remoteAPI.get(path: "/wp-block-editor/v1/settings").get()
+
+        let blogID = TaggedManagedObjectID(blog)
+        saveSettingsInBackground(data, for: blogID)
+
+        return data
+    }
+
     /// Returns cached settings if available. If not, fetches the settings from
     /// the network.
     @MainActor
-    func getSettings() async throws -> [String: Any] {
+    func getSettings() async throws -> Data {
         // Return cached settings if available
         let blogID = TaggedManagedObjectID(blog)
         if let cachedSettings = await loadSettingsInBackground(for: blogID) {
             return cachedSettings
         }
         return try await fetchSettings()
     }
+
+    @MainActor
+    func getSettingsString() async throws -> String {
+        let data = try await getSettings()
+        guard let string = String(data: data, encoding: .utf8) else {
+            throw CocoaError(.fileReadCorruptFile)
+        }
+        return string
+    }
 }
 
-private func saveSettingsInBackground(_ settings: [String: Any], for blogID: TaggedManagedObjectID<Blog>) async {
-    BlockEditorCache.shared.saveBlockSettings(settings, for: blogID)
+private func saveSettingsInBackground(_ settings: Data, for blogID: TaggedManagedObjectID<Blog>) {
+    Task {
+        do {
+            try BlockEditorCache.shared.saveBlockSettings(settings, for: blogID)
+        } catch {
+            wpAssertionFailure("Unable to save block settings", userInfo: ["error": error])
+        }
+    }
 }
 
-private func loadSettingsInBackground(for blogID: TaggedManagedObjectID<Blog>) async -> [String: Any]? {
+private func loadSettingsInBackground(for blogID: TaggedManagedObjectID<Blog>) async -> Data? {
     BlockEditorCache.shared.getBlockSettings(for: blogID)
 }

WordPress/Classes/Services/RawBlockEditorSettingsService.swift

@@ -55,17 +55,5 @@ extension EditorConfigurationBuilder {
             }
         }
         self = self.setLocale(WordPressComLanguageDatabase().deviceLanguage.slug)
-
-        if !blog.isSelfHosted {
-            let siteType: String = blog.isHostedAtWPcom ? "simple" : "atomic"
-            do {
-                self = self.setWebViewGlobals([
-                    try WebViewGlobal(name: "_currentSiteType", value: .string(siteType))
-                ])
-            } catch {
-                wpAssertionFailure("Failed to create WebViewGlobal", userInfo: ["error": "\(error)"])
-                self = self.setWebViewGlobals([])
-            }
-        }
     }
 }

WordPress/Classes/Utility/Editor/EditorConfigurationBuilder+Blog.swift

@@ -379,12 +379,12 @@ class NewGutenbergViewController: UIViewController, PostEditor, PublishingEditor
         }
     }
 
-    private func fetchBlockEditorSettings() async -> [String: Any]? {
+    private func fetchBlockEditorSettings() async -> String? {
         let service = RawBlockEditorSettingsService.getService(forBlog: post.blog)
         service.refreshSettings()
 
         do {
-            let settings = try await service.getSettings()
+            let settings = try await service.getSettingsString()
             return settings
         } catch {
             return nil
@@ -413,15 +413,15 @@ class NewGutenbergViewController: UIViewController, PostEditor, PublishingEditor
         }
     }
 
-    private func startEditor(with settings: [String: Any]? = nil) {
+    private func startEditor(with settings: String? = nil) {
         guard !hasEditorStarted else { return }
         hasEditorStarted = true
 
         if let settings {
             // TODO: `setEditorSettings` throws due to incompatibility between `[String: Any]`
             // and `[String: Encodable]`. The latter is now expected by
             // `GutenbergKitConfiguration.EditorSettings`. How should we reconcile this?
-            let updatedConfig = self.editorViewController.configuration.toBuilder()
+            let updatedConfig: GutenbergKit.EditorConfiguration = self.editorViewController.configuration.toBuilder()
                 .setEditorSettings(settings)
                 .build()
             self.editorViewController.updateConfiguration(updatedConfig)
@@ -1033,26 +1033,33 @@ extension EditorConfiguration {
             siteApiNamespace.append("sites/\(siteDomain)/")
         }
 
-        self = EditorConfiguration()
+        var builder = EditorConfigurationBuilder(blog: blog)
+            .setSiteApiNamespace(siteApiNamespace)
+            .setNamespaceExcludedPaths(["/wpcom/v2/following/recommendations", "/wpcom/v2/following/mine"])
+            .setAuthHeader(authHeader)
+            .setShouldUseThemeStyles(FeatureFlag.newGutenbergThemeStyles.enabled)
+            // Limited to Jetpack-connected sites until editor assets endpoint is available in WordPress core
+            .setShouldUsePlugins(EditorConfiguration.shouldEnablePlugins(for: blog, appPassword: applicationPassword))
+            .setLocale(WordPressComLanguageDatabase().deviceLanguage.slug)
+
+        if let blogUrl = blog.url {
+            builder = builder.setSiteUrl(blogUrl)
+        }
 
-        self.siteURL = blog.url ?? ""
-        self.siteApiRoot = siteApiRoot ?? ""
-        self.siteApiNamespace = siteApiNamespace
-        self.namespaceExcludedPaths = ["/wpcom/v2/following/recommendations", "/wpcom/v2/following/mine"]
-        self.authHeader = authHeader
+        if let siteApiRoot {
+            builder = builder.setSiteApiRoot(siteApiRoot)
 
-        self.themeStyles = FeatureFlag.newGutenbergThemeStyles.enabled
-        // Limited to Jetpack-connected sites until editor assets endpoint is available in WordPress core
-        if EditorConfiguration.shouldEnablePlugins(for: blog, appPassword: applicationPassword) {
-            self.plugins = true
-            if var editorAssetsEndpoint = URL(string: self.siteApiRoot) {
+            if var editorAssetsEndpoint = URL(string: siteApiRoot) {
                 editorAssetsEndpoint.appendPathComponent("wpcom/v2/")
                 if let namespace = siteApiNamespace.first {
                     editorAssetsEndpoint.appendPathComponent(namespace)
                 }
+
+                builder = builder.setEditorAssetsEndpoint(editorAssetsEndpoint)
             }
         }
-        self.locale = WordPressComLanguageDatabase().deviceLanguage.slug
+
+        self = builder.build()
     }
 
     /// Returns true if the plugins should be enabled for the given blog.