Merge pull request #14766 from wordpress-mobile/update/editor-session-analytic-properties

Add can_view_editor_onboarding property to editor session events

Author: dcalhoun

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

@@ -964,7 +964,7 @@ protected void onPause() {
     protected void onDestroy() {
         if (!mIsConfigChange && (mRestartEditorOption == RestartEditorOptions.NO_RESTART)) {
             if (mPostEditorAnalyticsSession != null) {
-                mPostEditorAnalyticsSession.end();
+                mPostEditorAnalyticsSession.end(canViewEditorOnboarding());
             }
         }
 
@@ -2296,9 +2296,7 @@ private GutenbergPropsBuilder getGutenbergPropsBuilder() {
         boolean isFreeWPCom = mSite.isWPCom() && SiteUtils.onFreePlan(mSite);
         boolean isWPComSite = mSite.isWPCom() || mSite.isWPComAtomic();
 
-        boolean canViewEditorOnboarding = (
-                mAccountStore.getAccount().getUserId() % 100 >= (100 - EDITOR_ONBOARDING_PHASE_PERCENTAGE)
-                || BuildConfig.DEBUG) && !AppPrefs.hasLaunchedGutenbergEditor();
+        boolean enableEditorOnboarding = canViewEditorOnboarding() && !AppPrefs.hasLaunchedGutenbergEditor();
 
         return new GutenbergPropsBuilder(
                 mContactInfoBlockFeatureConfig.isEnabled() && SiteUtils.supportsContactInfoFeature(mSite),
@@ -2314,10 +2312,15 @@ private GutenbergPropsBuilder getGutenbergPropsBuilder() {
                 postType,
                 featuredImageId,
                 themeBundle,
-                canViewEditorOnboarding
+                enableEditorOnboarding
         );
     }
 
+    private Boolean canViewEditorOnboarding() {
+        return (mAccountStore.getAccount().getUserId() % 100 >= (100 - EDITOR_ONBOARDING_PHASE_PERCENTAGE)
+                || BuildConfig.DEBUG);
+    }
+
     // Moved from EditPostContentFragment
     public static final String NEW_MEDIA_POST = "NEW_MEDIA_POST";
     public static final String NEW_MEDIA_POST_EXTRA_IDS = "NEW_MEDIA_POST_EXTRA_IDS";
@@ -3249,7 +3252,7 @@ private void onEditorFinalTouchesBeforeShowing() {
                 ((GutenbergEditorFragment) mEditorFragment).resetUploadingMediaToFailed(mediaIds);
             }
         } else if (mShowAztecEditor && mEditorFragment instanceof AztecEditorFragment) {
-            mPostEditorAnalyticsSession.start(null);
+            mPostEditorAnalyticsSession.start(null, canViewEditorOnboarding());
         }
     }
 
@@ -3262,7 +3265,7 @@ public void onEditorFragmentContentReady(
         // It assumes this is being called when the editor has finished loading
         // If you need to refactor this, please ensure that the startup_time_ms property
         // is still reflecting the actual startup time of the editor
-        mPostEditorAnalyticsSession.start(unsupportedBlocksList);
+        mPostEditorAnalyticsSession.start(unsupportedBlocksList, canViewEditorOnboarding());
         presentNewPageNoticeIfNeeded();
 
         // don't start listening for Story events just now if we're waiting for a block to be replaced,

WordPress/src/main/java/org/wordpress/android/ui/posts/PostEditorAnalyticsSession.java

@@ -23,6 +23,7 @@ public class PostEditorAnalyticsSession implements Serializable {
     private static final String KEY_EDITOR = "editor";
     private static final String KEY_HAS_UNSUPPORTED_BLOCKS = "has_unsupported_blocks";
     private static final String KEY_UNSUPPORTED_BLOCKS = "unsupported_blocks";
+    private static final String KEY_CAN_VIEW_EDITOR_ONBOARDING = "can_view_editor_onboarding";
     private static final String KEY_POST_TYPE = "post_type";
     private static final String KEY_OUTCOME = "outcome";
     private static final String KEY_SESSION_ID = "session_id";
@@ -94,12 +95,15 @@ public static PostEditorAnalyticsSession getNewPostEditorAnalyticsSession(
         return new PostEditorAnalyticsSession(editor, post, site, isNewPost);
     }
 
-    public void start(ArrayList<Object> unsupportedBlocksList) {
+    public void start(ArrayList<Object> unsupportedBlocksList, Boolean canViewEditorOnboarding) {
         if (!mStarted) {
             mHasUnsupportedBlocks = unsupportedBlocksList != null && unsupportedBlocksList.size() > 0;
             Map<String, Object> properties = getCommonProperties();
             properties.put(KEY_UNSUPPORTED_BLOCKS,
                     unsupportedBlocksList != null ? unsupportedBlocksList : new ArrayList<>());
+            if (canViewEditorOnboarding != null) {
+                properties.put(KEY_CAN_VIEW_EDITOR_ONBOARDING, canViewEditorOnboarding);
+            }
             // Note that start time only counts when the analytics session was created and not when the editor
             // activity started. We are mostly interested in measuring the loading times for the block editor,
             // where the main bottleneck seems to be initializing React Native and doing the initial load of Gutenberg.
@@ -138,7 +142,7 @@ public void applyTemplate(String template) {
         AnalyticsTracker.track(Stat.EDITOR_SESSION_TEMPLATE_APPLY, properties);
     }
 
-    public void end() {
+    public void end(Boolean canViewEditorOnboarding) {
         // don't try to send an "end" event if the session wasn't started in the first place
         if (mStarted) {
             if (mOutcome == null) {
@@ -148,6 +152,9 @@ public void end() {
             }
             Map<String, Object> properties = getCommonProperties();
             properties.put(KEY_OUTCOME, mOutcome.toString().toLowerCase(Locale.ROOT));
+            if (canViewEditorOnboarding != null) {
+                properties.put(KEY_CAN_VIEW_EDITOR_ONBOARDING, canViewEditorOnboarding);
+            }
             AnalyticsTracker.track(Stat.EDITOR_SESSION_END, properties);
         } else {
             AppLog.e(T.EDITOR, "A non-started editor session cannot be attempted to be ended");

WordPress/src/main/java/org/wordpress/android/ui/stories/StoryComposerViewModel.kt

@@ -114,7 +114,7 @@ class StoryComposerViewModel @Inject constructor(
                 editPostRepository.getPost(),
                 site
         )
-        this.postEditorAnalyticsSession?.start(null)
+        this.postEditorAnalyticsSession?.start(null, null)
     }
 
     private fun createPostEditorAnalyticsSessionTracker(
@@ -185,6 +185,6 @@ class StoryComposerViewModel @Inject constructor(
     override fun onCleared() {
         super.onCleared()
         lifecycleOwner.lifecycleRegistry.currentState = Lifecycle.State.DESTROYED
-        postEditorAnalyticsSession?.end()
+        postEditorAnalyticsSession?.end(null)
     }
 }

build.gradle

@@ -8,7 +8,7 @@ buildscript {
     ext.wordPressUtilsVersion = 'develop-bb54ee34c5fec5fa7375ce90a356adb5adbdcae0'
     ext.wordPressLoginVersion = '0.0.2'
     ext.detektVersion = '1.15.0'
-    ext.gutenbergMobileVersion = 'v1.56.0-alpha3'
+    ext.gutenbergMobileVersion = 'v1.56.0-alpha4'
 
     repositories {
         maven {

libs/editor/WordPressEditor/src/main/java/org/wordpress/android/editor/gutenberg/GutenbergPropsBuilder.kt

@@ -21,7 +21,7 @@ data class GutenbergPropsBuilder(
     private val postType: String,
     private val featuredImageId: Int,
     private val editorTheme: Bundle?,
-    private val canViewEditorOnboarding: Boolean
+    private val enableEditorOnboarding: Boolean
 ) : Parcelable {
     fun build(activity: Activity, isHtmlModeEnabled: Boolean) = GutenbergProps(
             enableContactInfoBlock = enableContactInfoBlock,
@@ -40,6 +40,6 @@ data class GutenbergPropsBuilder(
             translations = GutenbergUtils.getTranslations(activity),
             isDarkMode = GutenbergUtils.isDarkMode(activity),
             htmlModeEnabled = isHtmlModeEnabled,
-            canViewEditorOnboarding = canViewEditorOnboarding
+            enableEditorOnboarding = enableEditorOnboarding
     )
 }