Skip to content

feat: Enable GutenbergKit asset caching #22035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 18, 2025
Merged

feat: Enable GutenbergKit asset caching #22035

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e6e956c
refactor: Remove redundant private Atomic site check
dcalhoun Jul 18, 2025
d7f1999
feat: Cache GutenbergKit assets and improve configuration
dcalhoun Jul 18, 2025
f013498
fix: Disable WebView preloading causing GutenbergKit load failures
dcalhoun Jul 18, 2025
dd36e2c
fix: Avoid unnecessary GutenbergKit starts
dcalhoun Jul 18, 2025
20288d0
build: Update GutenbergKit version
dcalhoun Jul 18, 2025
fd98574
refactor: Address lint errors
dcalhoun Jul 18, 2025
3ef5c35
build: Update GutenbergKit version
dcalhoun Jul 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 27 additions & 19 deletions WordPress/src/main/java/org/wordpress/android/ui/posts/EditPostActivity.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,6 @@ import org.wordpress.android.viewmodel.storage.StorageUtilsViewModel
import org.wordpress.android.widgets.AppReviewManager.incrementInteractions
import org.wordpress.android.widgets.WPSnackbar.Companion.make
import org.wordpress.android.widgets.WPViewPager
import org.wordpress.gutenberg.GutenbergWebViewPool
import org.wordpress.aztec.AztecExceptionHandler
import org.wordpress.aztec.exceptions.DynamicLayoutGetBlockIndexOutOfBoundsException
import org.wordpress.aztec.util.AztecLog
Expand Down Expand Up @@ -798,9 +797,6 @@ class EditPostActivity : BaseAppCompatActivity(), EditorFragmentActivity, Editor
}

private fun setupEditor() {
if (isGutenbergKitEditor) {
GutenbergWebViewPool.getPreloadedWebView(this)
}
Comment on lines -801 to -803
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This performance optimization leads to duplicate "editor mounted" events, which results in invisible editor UI. We should reinstate this after refactoring the WebView initialization to avoid this issue.

Additional details capture in f013498.

// Check whether to show the visual editor

// NOTE: Migrate to 'androidx.preference.PreferenceManager' and 'androidx.preference.Preference'
Expand Down Expand Up @@ -2503,8 +2499,21 @@ class EditPostActivity : BaseAppCompatActivity(), EditorFragmentActivity, Editor
onXpostsSettingsCapability(isXpostsCapable)
}

val isWpCom = site.isWPCom || siteModel.isPrivateWPComAtomic || siteModel.isWPComAtomic
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isPrivateWPComAtomic is duplicative of isWPComAtomic in this context of identifying non-self-hosted sites.

val gutenbergWebViewAuthorizationData = GutenbergWebViewAuthorizationData(
val isWpCom = site.isWPCom || siteModel.isWPComAtomic
val gutenbergWebViewAuthorizationData = createGutenbergWebViewAuthorizationData(isWpCom)
val settings = createGutenbergKitSettings(isWpCom)

return GutenbergKitEditorFragment.newInstance(
getContext(),
isNewPost,
gutenbergWebViewAuthorizationData,
jetpackFeatureRemovalPhaseHelper.shouldShowJetpackPoweredEditorFeatures(),
settings
)
}

private fun createGutenbergWebViewAuthorizationData(isWpCom: Boolean): GutenbergWebViewAuthorizationData {
return GutenbergWebViewAuthorizationData(
siteModel.url,
isWpCom,
accountStore.account.userId,
Expand All @@ -2518,21 +2527,28 @@ class EditPostActivity : BaseAppCompatActivity(), EditorFragmentActivity, Editor
userAgent.toString(),
isJetpackSsoEnabled
)
}

private fun createGutenbergKitSettings(isWpCom: Boolean): MutableMap<String, Any?> {
val postType = if (editPostRepository.isPage) "page" else "post"
val siteApiRoot = if (isWpCom) "https://public-api.wordpress.com/" else ""
val authToken = accountStore.accessToken
val authHeader = "Bearer $authToken"
val siteApiNamespace = arrayOf("sites/${site.siteId}", "sites/${UrlUtils.removeScheme(siteModel.url)}")
val siteURL = siteModel.url
val siteApiRoot = if (isWpCom) "https://public-api.wordpress.com/"
else siteModel.wpApiRestUrl ?: "$siteURL/wp-json/"
Comment on lines +2535 to +2536
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a future improvement, I'd love for us to be a bit more clear on when the editor is fully supported and we know the logic is correct and when it's not or we are making a guess.

  • Moving siteApiRoot url calculation to a central place with some unit tests would be great
  • Having a isGutenbergKit supported function in a central place would also help, where the function would take a configuration type (with api root, authentication header etc) and decides whether it can move forward or not. We can add comments about each scenario.
  • We can add a way to convert a SiteModel into the configuration type mentioned above.
  • The configuration type then can be passed to relevant places, rather than doing to calculation here or in other fragments

My main feedback - and it's not about this PR - is that I am having a hard time following the current code, mostly because it's only partially implemented. If it was fully implemented and I just needed to process it, than it'd be easy, but that's impossible right now without at least comments for each situation.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. Thank you for the note.

Centralizing and documenting common calculations would definitely help communicate intent. A utility for converting SiteModel to editor configuration would also be helpful, and is necessary for implementing the warmup functionality without further duplication.

// Use the application password for self-hosted sites when available
val authHeader = if (isWpCom) "Bearer ${accountStore.accessToken}" else "Basic "
val siteApiNamespace = if (isWpCom)
arrayOf("sites/${site.siteId}/", "sites/${UrlUtils.removeScheme(siteURL)}/")
else arrayOf()

val languageString = perAppLocaleManager.getCurrentLocaleLanguageCode()
val wpcomLocaleSlug = languageString.replace("_", "-").lowercase()

val settings = mutableMapOf<String, Any?>(
return mutableMapOf(
"postId" to editPostRepository.getPost()?.remotePostId?.toInt(),
"postType" to postType,
"postTitle" to editPostRepository.getPost()?.title,
"postContent" to editPostRepository.getPost()?.content,
"siteURL" to siteURL,
"siteApiRoot" to siteApiRoot,
"namespaceExcludedPaths" to arrayOf("/wpcom/v2/following/recommendations", "/wpcom/v2/following/mine"),
"authHeader" to authHeader,
Expand All @@ -2552,14 +2568,6 @@ class EditPostActivity : BaseAppCompatActivity(), EditorFragmentActivity, Editor
)
)
)

return GutenbergKitEditorFragment.newInstance(
getContext(),
isNewPost,
gutenbergWebViewAuthorizationData,
jetpackFeatureRemovalPhaseHelper.shouldShowJetpackPoweredEditorFeatures(),
settings
)
}

private fun createGutenbergEditorFragment(): GutenbergEditorFragment {
Expand Down
2 changes: 1 addition & 1 deletion gradle/libs.versions.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ google-play-services-auth = '20.4.1'
google-services = '4.4.3'
gravatar = '2.5.0'
greenrobot-eventbus = '3.3.1'
gutenberg-kit = 'v0.4.1'
gutenberg-kit = 'v0.5.0'
gutenberg-mobile = 'v1.121.0'
indexos-media-for-mobile = '43a9026f0973a2f0a74fa813132f6a16f7499c3a'
jackson-databind = '2.12.7.1'
Expand Down
21 changes: 19 additions & 2 deletions ...itor/src/main/java/org/wordpress/android/editor/gutenberg/GutenbergKitEditorFragment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
import org.wordpress.android.util.AppLog.T;
import org.wordpress.android.util.PermissionUtils;
import org.wordpress.android.util.ProfilingUtils;
import org.wordpress.android.util.UrlUtils;
import org.wordpress.android.util.helpers.MediaFile;
import org.wordpress.android.util.helpers.MediaGallery;
import org.wordpress.aztec.IHistoryListener;
Expand All @@ -58,6 +59,7 @@
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.CountDownLatch;

import static org.wordpress.gutenberg.Media.createMediaUsingMimeType;
Expand All @@ -72,6 +74,7 @@ public class GutenbergKitEditorFragment extends EditorFragmentAbstract implement
@Nullable private GutenbergView mGutenbergView;
private static final String GUTENBERG_EDITOR_NAME = "gutenberg";
private static final String KEY_HTML_MODE_ENABLED = "KEY_HTML_MODE_ENABLED";
private static final String KEY_EDITOR_STARTED = "KEY_EDITOR_STARTED";
private static final String KEY_EDITOR_DID_MOUNT = "KEY_EDITOR_DID_MOUNT";
private static final String ARG_IS_NEW_POST = "param_is_new_post";
private static final String ARG_GUTENBERG_WEB_VIEW_AUTH_DATA = "param_gutenberg_web_view_auth_data";
Expand All @@ -90,6 +93,7 @@ public class GutenbergKitEditorFragment extends EditorFragmentAbstract implement
@Nullable private OpenMediaLibraryListener mOpenMediaLibraryListener = null;
@Nullable private LogJsExceptionListener mOnLogJsExceptionListener = null;

private boolean mEditorStarted;
private boolean mEditorDidMount;
@Nullable
private View mRootView;
Expand Down Expand Up @@ -124,6 +128,7 @@ public void onCreate(@Nullable Bundle savedInstanceState) {

if (savedInstanceState != null) {
mHtmlModeEnabled = savedInstanceState.getBoolean(KEY_HTML_MODE_ENABLED);
mEditorStarted = savedInstanceState.getBoolean(KEY_EDITOR_STARTED);
mEditorDidMount = savedInstanceState.getBoolean(KEY_EDITOR_DID_MOUNT);
mFeaturedImageId = savedInstanceState.getLong(ARG_FEATURED_IMAGE_ID);
}
Expand Down Expand Up @@ -260,6 +265,7 @@ public void onAttach(Activity activity) {
@Override
public void onSaveInstanceState(Bundle outState) {
outState.putBoolean(KEY_HTML_MODE_ENABLED, mHtmlModeEnabled);
outState.putBoolean(KEY_EDITOR_STARTED, mEditorStarted);
outState.putBoolean(KEY_EDITOR_DID_MOUNT, mEditorDidMount);
outState.putLong(ARG_FEATURED_IMAGE_ID, mFeaturedImageId);
}
Expand Down Expand Up @@ -508,6 +514,7 @@ public void onDestroy() {
mHistoryChangeListener = null;
mFeaturedImageChangeListener = null;
}
mEditorStarted = false;
super.onDestroy();
}

Expand Down Expand Up @@ -556,7 +563,7 @@ public void onEditorThemeUpdated(Bundle editorTheme) {
}

public void startWithEditorSettings(@NonNull String editorSettings) {
if (mGutenbergView == null) {
if (mGutenbergView == null || mEditorStarted) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Due to the multiple FluxC subscription updates, the existing logic attempts to start the editor twice on open and once on close. This new state guards against unnecessary editor starts.

Additional details in dd36e2c.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change has caused the regression mentioned here.

return;
}

Expand All @@ -565,6 +572,12 @@ public void startWithEditorSettings(@NonNull String editorSettings) {
postId = -1;
}

var siteURL = (String) mSettings.get("siteURL");
var siteApiRoot = (String) mSettings.get("siteApiRoot");
var siteApiNamespace = (String[]) mSettings.get("siteApiNamespace");
var firstNamespace = siteApiNamespace != null && siteApiNamespace.length > 0 ? siteApiNamespace[0] : "";
var editorAssetsEndpoint = siteApiRoot + "wpcom/v2/" + firstNamespace + "editor-assets";

EditorConfiguration config = new EditorConfiguration.Builder()
.setTitle((String) mSettings.get("postTitle"))
.setContent((String) mSettings.get("postContent"))
Expand All @@ -573,14 +586,18 @@ public void startWithEditorSettings(@NonNull String editorSettings) {
.setThemeStyles((Boolean) mSettings.get("themeStyles"))
.setPlugins((Boolean) mSettings.get("plugins"))
.setSiteApiRoot((String) mSettings.get("siteApiRoot"))
.setSiteApiNamespace((String[]) mSettings.get("siteApiNamespace"))
.setSiteApiNamespace((String[]) siteApiNamespace)
.setNamespaceExcludedPaths((String[]) mSettings.get("namespaceExcludedPaths"))
.setAuthHeader((String) mSettings.get("authHeader"))
.setWebViewGlobals((List<WebViewGlobal>) mSettings.get("webViewGlobals"))
.setEditorSettings(editorSettings)
.setLocale((String) mSettings.get("locale"))
.setEditorAssetsEndpoint(editorAssetsEndpoint)
.setCachedAssetHosts(Set.of("s0.wp.com", UrlUtils.getHost(siteURL)))
.setEnableAssetCaching(true)
.build();

mEditorStarted = true;
mGutenbergView.start(config);
}

Expand Down