refactor: Fetch and cache GutenbergKit editor settings #21791

dcalhoun · 2025-04-09T19:10:43Z

Fetch and cache editor settings before providing them to the editor, as it
allows improving offline support. The changes also communicate the
background activity with an activity indicator.

Ref CMM-200.

Important

Ensure the following experimental features are enabled:

Experimental block editor
Experimental block editor styles

1: Initial editor fallbacks to default settings

Enable airplane mode.
Open the post editor.
Verify the editor loads, using default settings—e.g., white background with black text.

2: Editor fetches site-specific settings

Disable airplane mode.
Open the post editor.
Verify the editor loads with site-specific settings—e.g., the theme's background and foreground colors.

3: Editor fallback to cached settings

Enable airplane mode.
Open the post editor.
Verify the editor loads with site-specific settings—e.g., the theme's background and foreground colors.

Regression Notes

Potential unintended areas of impact
Regressions in Gutenberg Mobile or Aztec editors.
What I did to test those areas of impact (or what existing automated tests I relied on)
Manually smoke tested the editors.
What automated tests I added (or what prevented me from doing so)
Deemed unnecessary for the experimental editor.

PR Submission Checklist:

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

Testing Checklist (strike-out the not-applying and unnecessary ones):

dangermattic · 2025-04-09T19:11:33Z

	7 Warnings
⚠️	This PR is larger than 300 lines of changes. Please consider splitting it into smaller PRs for easier and faster reviews.
⚠️	Class `EditorSettings` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `EditorSettingsSqlUtils` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `EditorSettingsStore` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `FetchEditorSettingsPayload` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `EditorSettingsError` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	PR is not assigned to a milestone.

Generated by 🚫 Danger

wpmobilebot · 2025-04-09T19:21:10Z

Project dependencies changes

list

! Upgraded Dependencies
org.wordpress.gutenbergkit:android:trunk-fa72e630203e7472d55f4abedfd5c462d2333584, (changed from trunk-a03e0dae10a404c88c215bfcee3176df951302f5)

tree

 +--- project :libs:editor
-|    \--- org.wordpress.gutenbergkit:android:trunk-a03e0dae10a404c88c215bfcee3176df951302f5
+|    \--- org.wordpress.gutenbergkit:android:trunk-fa72e630203e7472d55f4abedfd5c462d2333584
-\--- org.wordpress.gutenbergkit:android:trunk-a03e0dae10a404c88c215bfcee3176df951302f5 (*)
+\--- org.wordpress.gutenbergkit:android:trunk-fa72e630203e7472d55f4abedfd5c462d2333584 (*)

wpmobilebot · 2025-04-09T19:33:32Z

📲 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
	Flavor	Jalapeno
	Build Type	Debug
	Version	pr21791-d99dc81
	Commit	`d99dc81`
	Direct Download	`wordpress-prototype-build-pr21791-d99dc81.apk`

Note: Google Login is not supported on these builds.

wpmobilebot · 2025-04-09T19:34:31Z

📲 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
	Flavor	Jalapeno
	Build Type	Debug
	Version	pr21791-d99dc81
	Commit	`d99dc81`
	Direct Download	`jetpack-prototype-build-pr21791-d99dc81.apk`

Note: Google Login is not supported on these builds.

.../editor/src/main/java/org/wordpress/android/editor/gutenberg/GutenbergKitEditorFragment.java

libs/editor/src/main/res/layout/fragment_gutenberg_kit_editor.xml

dcalhoun · 2025-04-11T15:00:14Z

WordPress/src/main/java/org/wordpress/android/ui/posts/EditPostActivity.kt

+        if (editorFragment !is GutenbergKitEditorFragment) {
+            refreshEditorContent()
+        }


The timing of this content refresh is currently incompatible with/unnecessary for GutenbergKit.

dcalhoun · 2025-04-11T15:27:07Z

libs/fluxc/src/main/java/org/wordpress/android/fluxc/persistence/WellSqlConfig.kt

    annotation class AddOn

    override fun getDbVersion(): Int {
-        return 204


Noting that a 204 migration did not exist. I do not believe this is a problem, but noting it just in case.

dcalhoun · 2025-04-11T15:27:49Z

libs/fluxc/src/main/java/org/wordpress/android/fluxc/store/EditorSettingsStore.kt

This store was built based on the existing EditorThemeStore.

@dcalhoun I'm curious why we have this duplication with EditorThemeStore? Do we need two separate stores for editor settings?

@nbradbury it's an attempt to mitigate regressions.

When the GutenbergKit implementation first began, we colocated much of the new logic with existing editor logic; this included introducing a good amount of branching logic to exiting code. In retrospect, we deemed this misguided, as every change we made in the advancement of GutenbergKit meant the possibility of a regression in the Gutenberg Mobile and Aztec editors. We ultimately separated a good amount of the logic in #21493.

Duplicating EditorThemeStore to EditorSettings felt appropriate for continuing that separation practice, it also allowed for a simpler implementation for GutenbergKit.

codecov · 2025-04-11T20:33:37Z

Codecov Report

Attention: Patch coverage is 25.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 39.32%. Comparing base (ad0b027) to head (d99dc81).
Report is 1 commits behind head on trunk.

Files with missing lines	Patch %	Lines
...rdpress/android/fluxc/persistence/WellSqlConfig.kt	25.00%	3 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##            trunk   #21791   +/-   ##
=======================================
  Coverage   39.32%   39.32%           
=======================================
  Files        2125     2125           
  Lines       99871    99871           
  Branches    15385    15385           
=======================================
  Hits        39277    39277           
  Misses      57114    57114           
  Partials     3480     3480

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

nbradbury · 2025-04-14T14:01:56Z

@dcalhoun This isn't something that needs to be addressed here, especially since EditorThemeStore already does this, but I wanted to caution against storing raw JSON in the database. I think it was with WCAndroid where we encountered users getting SQLiteBlobTooBigException due to plugins adding a ton of baggage to JSON responses.

Semi-related, we may want to make use of the fields parameter to limit the response to just the fields we use. The response is only ~5KB in this case so it's not huge, but it would be more efficient for storage.

dcalhoun · 2025-04-14T14:47:41Z

This isn't something that needs to be addressed here, especially since EditorThemeStore already does this, but I wanted to caution against storing raw JSON in the database. I think it was with WCAndroid where we encountered users getting SQLiteBlobTooBigException due to plugins adding a ton of baggage to JSON responses.

@nbradbury thank you for the feedback. This is a great point. I believe the WP-Android app suffers from similar exceptions in certain contexts.

Semi-related, we may want to make use of the fields parameter to limit the response to just the fields we use. The response is only ~5KB in this case so it's not huge, but it would be more efficient for storage.

Leveraging the _fields parameter may be a good option. I have not reviewed which fields are applicable to GutenbergKit at this time; doing so is a good optimization opportunity to pursue later.

Is there an alternative persistence layer to SQLite that makes sense for this specific feature? Or is SQLite the best choice? For context, the data is site-specific and should likely persist at least a few days.

nbradbury · 2025-04-14T14:54:42Z

Is there an alternative persistence layer to SQLite that makes sense for this specific feature? Or is SQLite the best choice?

I recommend sticking with SQLite, especially for this feature since the data isn't unreasonably large. I've heard other devs recommend storing the data in a separate file and write the filename to the database, but I've never felt the need to do that.

nbradbury

Looks good!

dcalhoun · 2025-04-15T13:34:24Z

@nbradbury thank you for the review. Did you have time to also review the sibling PR: wordpress-mobile/GutenbergKit#114?

Mirror theme change subscription.

Avoid typing complex JSON structures.

Communicate active background work to the user.

Improve offline support and performance.

Match caching strategy for other FluxC stores.

This is the expected ID value for the Gutenberg editor.

This reverts commit a715424.

This was added erroneously.

Now that we await the editor settings, we should postpone starting the editor. This means we only start the editor once.

Ensure the editor continues launching if retrieving site-specific editor settings fails.

Apply the cached settings rather than the default settings, if available.

sonarqubecloud · 2025-04-24T20:13:05Z

Quality Gate passed

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

dcalhoun added [Type] Enhancement Gutenberg Editing and display of Gutenberg blocks. labels Apr 9, 2025

This was referenced Apr 9, 2025

refactor: Host provides editor settings wordpress-mobile/GutenbergKit#114

Merged

refactor: Fetch and cache GutenbergKit editor settings wordpress-mobile/WordPress-iOS#24417

Merged

dcalhoun force-pushed the feat/provide-editor-settings branch from a2d6293 to 26d42ef Compare April 9, 2025 19:13

github-advanced-security bot found potential problems Apr 9, 2025

View reviewed changes

dcalhoun added the unit-tests-exemption label Apr 11, 2025

dcalhoun commented Apr 11, 2025

View reviewed changes

dcalhoun changed the title ~~refactor: Provide GutenbergKit editor settings~~ refactor: Fetch and cache GutenbergKit editor settings Apr 11, 2025

dcalhoun marked this pull request as ready for review April 12, 2025 01:14

dcalhoun requested a review from nbradbury April 12, 2025 01:15

nbradbury self-assigned this Apr 14, 2025

nbradbury approved these changes Apr 14, 2025

View reviewed changes

dcalhoun force-pushed the feat/provide-editor-settings branch from bf0f0ca to 234d290 Compare April 21, 2025 15:09

dcalhoun added 7 commits April 24, 2025 16:01

refactor: Provide editor settings to GutenbergKit

550a588

refactor: Move onEditorSettingsChanged subscription to EditPostActivity

2727408

Mirror theme change subscription.

style: Automated formatting changes

14f99cc

feat: Dispatch editor settings request

0de6ee0

refactor: Improve editor settings parsing

00438a3

refactor: Simplify EditorSettings

a9710cb

refactor: Pass editor settings as JSON string

7ae1aa5

Avoid typing complex JSON structures.

dcalhoun added 2 commits April 24, 2025 16:01

feat: Display activity indicator while fetching editor settings

37df679

Communicate active background work to the user.

feat: Add cache-while-revalidate for editor settings

dd7a59d

Improve offline support and performance.

dcalhoun force-pushed the feat/provide-editor-settings branch from 234d290 to 6064d99 Compare April 24, 2025 20:05

dcalhoun added 13 commits April 24, 2025 16:08

feat: Persist editor settings in SQLite

2e0a1dc

Match caching strategy for other FluxC stores.

build: Update GutenbergKit ref

6ea9561

style: Address lint errors

1434de3

style: Address lint warnings

acad23b

fix: Use -1 post ID for new drafts

d38bf79

This is the expected ID value for the Gutenberg editor.

Revert "style: Automated formatting changes"

c6f73b0

This reverts commit a715424.

refactor: Remove unnecessary style configuration

119bf6c

This was added erroneously.

refactor: Avoid redundant editor starts

074a3f6

Now that we await the editor settings, we should postpone starting the editor. This means we only start the editor once.

build: Update GutenbergKit ref

c9c358a

style: Address lint warning

948efd9

fix: Start editor with default settings on failed editor settings

dd7f3a8

Ensure the editor continues launching if retrieving site-specific editor settings fails.

fix: Emit available cached editor settings on fetch failure

9067f91

Apply the cached settings rather than the default settings, if available.

build: Update GutenbergKit ref

d99dc81

dcalhoun force-pushed the feat/provide-editor-settings branch from 6064d99 to d99dc81 Compare April 24, 2025 20:08

dcalhoun merged commit 19e4ecd into trunk Apr 24, 2025
24 of 26 checks passed

dcalhoun deleted the feat/provide-editor-settings branch April 24, 2025 20:33

refactor: Fetch and cache GutenbergKit editor settings #21791

refactor: Fetch and cache GutenbergKit editor settings #21791

Uh oh!

Conversation

dcalhoun commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

To Test:

Regression Notes

PR Submission Checklist:

Testing Checklist (strike-out the not-applying and unnecessary ones):

Uh oh!

dangermattic commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wpmobilebot commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Project dependencies changes

Uh oh!

wpmobilebot commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wpmobilebot commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dcalhoun Apr 11, 2025

Choose a reason for hiding this comment

Uh oh!

dcalhoun Apr 11, 2025

Choose a reason for hiding this comment

Uh oh!

dcalhoun Apr 11, 2025

Choose a reason for hiding this comment

Uh oh!

nbradbury Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

dcalhoun Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Apr 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

nbradbury commented Apr 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dcalhoun commented Apr 14, 2025

Uh oh!

nbradbury commented Apr 14, 2025

Uh oh!

nbradbury left a comment

Choose a reason for hiding this comment

Uh oh!

dcalhoun commented Apr 15, 2025

Uh oh!

sonarqubecloud bot commented Apr 24, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dcalhoun commented Apr 9, 2025 •

edited

Loading

dangermattic commented Apr 9, 2025 •

edited

Loading

wpmobilebot commented Apr 9, 2025 •

edited

Loading

wpmobilebot commented Apr 9, 2025 •

edited

Loading

wpmobilebot commented Apr 9, 2025 •

edited

Loading

codecov bot commented Apr 11, 2025 •

edited

Loading

nbradbury commented Apr 14, 2025 •

edited

Loading