Merge pull request #17290 from wordpress-mobile/issue/reader-saved-posts-sync

develric · web-flow · commit abc636caa91b · 2022-10-14T22:43:59.000+02:00
[Jetpack Focus] Implement reader saved posts ContentProvider and Resolver
diff --git a/WordPress/build.gradle b/WordPress/build.gradle
@@ -123,6 +123,7 @@ android {
         buildConfigField "boolean", "JETPACK_SHARED_LOGIN", "false"
         buildConfigField "boolean", "JETPACK_LOCAL_USER_FLAGS", "false"
         buildConfigField "boolean", "JETPACK_BLOGGING_REMINDERS_SYNC", "false"
+        buildConfigField "boolean", "JETPACK_READER_SAVED_POSTS", "false"
         buildConfigField "boolean", "JETPACK_PROVIDER_SYNC", "false"
 
         // Override these constants in jetpack product flavor to enable/ disable features
diff --git a/WordPress/src/main/java/org/wordpress/android/datasets/wrappers/ReaderDatabaseWrapper.kt b/WordPress/src/main/java/org/wordpress/android/datasets/wrappers/ReaderDatabaseWrapper.kt
@@ -0,0 +1,10 @@
+package org.wordpress.android.datasets.wrappers
+
+import dagger.Reusable
+import org.wordpress.android.datasets.ReaderDatabase
+import javax.inject.Inject
+
+@Reusable
+class ReaderDatabaseWrapper @Inject constructor() {
+    fun reset(retainBookmarkedPosts: Boolean) = ReaderDatabase.reset(retainBookmarkedPosts)
+}
diff --git a/WordPress/src/main/java/org/wordpress/android/datasets/wrappers/ReaderPostTableWrapper.kt b/WordPress/src/main/java/org/wordpress/android/datasets/wrappers/ReaderPostTableWrapper.kt
@@ -29,4 +29,7 @@ class ReaderPostTableWrapper @Inject constructor() {
             ReaderPostTable.getPostsWithTag(readerTag, maxRows, excludeTextColumn)
 
     fun getNumPostsWithTag(readerTag: ReaderTag): Int = ReaderPostTable.getNumPostsWithTag(readerTag)
+
+    fun addOrUpdatePosts(readerTag: ReaderTag, posts: ReaderPostList) =
+            ReaderPostTable.addOrUpdatePosts(readerTag, posts)
 }
diff --git a/WordPress/src/main/java/org/wordpress/android/datasets/wrappers/ReaderTagTableWrapper.kt b/WordPress/src/main/java/org/wordpress/android/datasets/wrappers/ReaderTagTableWrapper.kt
@@ -16,4 +16,8 @@ class ReaderTagTableWrapper @Inject constructor() {
     fun getFollowedTags(): ReaderTagList = ReaderTagTable.getFollowedTags()
 
     fun clearTagLastUpdated(readerTag: ReaderTag) = ReaderTagTable.clearTagLastUpdated(readerTag)
+
+    fun addOrUpdateTag(readerTag: ReaderTag) = ReaderTagTable.addOrUpdateTag(readerTag)
+
+    fun getBookmarkTags(): ReaderTagList? = ReaderTagTable.getBookmarkTags()
 }
diff --git a/WordPress/src/main/java/org/wordpress/android/modules/AppComponent.java b/WordPress/src/main/java/org/wordpress/android/modules/AppComponent.java
@@ -6,6 +6,7 @@
 import org.wordpress.android.push.GCMMessageService;
 import org.wordpress.android.push.GCMRegistrationIntentService;
 import org.wordpress.android.push.NotificationsProcessingService;
+import org.wordpress.android.reader.savedposts.provider.ReaderSavedPostsProvider;
 import org.wordpress.android.sharedlogin.provider.SharedLoginProvider;
 import org.wordpress.android.ui.AddQuickPressShortcutActivity;
 import org.wordpress.android.ui.CommentFullScreenDialogFragment;
@@ -655,4 +656,6 @@ public interface AppComponent {
     void inject(UserFlagsProvider object);
 
     void inject(BloggingRemindersProvider object);
+
+    void inject(ReaderSavedPostsProvider object);
 }
diff --git a/WordPress/src/main/java/org/wordpress/android/reader/savedposts/JetpackReaderSavedPostsFlag.kt b/WordPress/src/main/java/org/wordpress/android/reader/savedposts/JetpackReaderSavedPostsFlag.kt
@@ -0,0 +1,12 @@
+package org.wordpress.android.reader.savedposts
+
+import org.wordpress.android.util.BuildConfigWrapper
+import org.wordpress.android.util.config.JetpackReaderSavedPostsFeatureConfig
+import javax.inject.Inject
+
+class JetpackReaderSavedPostsFlag @Inject constructor(
+    private val jetpackReaderSavedPostsFeatureConfig: JetpackReaderSavedPostsFeatureConfig,
+    private val buildConfigWrapper: BuildConfigWrapper
+) {
+    fun isEnabled() = jetpackReaderSavedPostsFeatureConfig.isEnabled() && buildConfigWrapper.isJetpackApp
+}
diff --git a/WordPress/src/main/java/org/wordpress/android/reader/savedposts/ReaderSavedPostsAnalyticsTracker.kt b/WordPress/src/main/java/org/wordpress/android/reader/savedposts/ReaderSavedPostsAnalyticsTracker.kt
@@ -0,0 +1,34 @@
+package org.wordpress.android.reader.savedposts
+
+import org.wordpress.android.analytics.AnalyticsTracker.Stat
+import org.wordpress.android.reader.savedposts.ReaderSavedPostsAnalyticsTracker.ErrorType.Companion.ERROR_TYPE
+import org.wordpress.android.reader.savedposts.ReaderSavedPostsAnalyticsTracker.ErrorType.Companion.EXPORTED_POSTS
+import org.wordpress.android.util.analytics.AnalyticsTrackerWrapper
+import javax.inject.Inject
+
+class ReaderSavedPostsAnalyticsTracker @Inject constructor(
+    private val analyticsTracker: AnalyticsTrackerWrapper
+) {
+    fun trackStart() = analyticsTracker.track(Stat.READER_SAVED_POSTS_START)
+
+    fun trackSuccess(numPosts: Int) = analyticsTracker.track(
+            Stat.READER_SAVED_POSTS_SUCCESS, mapOf(EXPORTED_POSTS to numPosts)
+    )
+
+    fun trackFailed(errorType: ErrorType) =
+            analyticsTracker.track(Stat.READER_SAVED_POSTS_FAILED, mapOf(ERROR_TYPE to errorType.value))
+
+    sealed class ErrorType(open val value: String) {
+        object QuerySavedPostsError : ErrorType("query_saved_posts_error")
+
+        class GenericError(errorMessage: String?) : ErrorType(
+                "generic_error: ${errorMessage?.take(EXCEPTION_MESSAGE_MAX_LENGTH) ?: ""}"
+        )
+
+        companion object {
+            const val ERROR_TYPE = "error_type"
+            const val EXPORTED_POSTS = "exported_posts"
+            const val EXCEPTION_MESSAGE_MAX_LENGTH = 100
+        }
+    }
+}
diff --git a/WordPress/src/main/java/org/wordpress/android/reader/savedposts/provider/ReaderSavedPostsProvider.kt b/WordPress/src/main/java/org/wordpress/android/reader/savedposts/provider/ReaderSavedPostsProvider.kt
@@ -0,0 +1,61 @@
+package org.wordpress.android.reader.savedposts.provider
+
+import android.database.Cursor
+import android.net.Uri
+import org.wordpress.android.WordPress
+import org.wordpress.android.datasets.wrappers.ReaderPostTableWrapper
+import org.wordpress.android.models.ReaderTag
+import org.wordpress.android.models.ReaderTagType.BOOKMARKED
+import org.wordpress.android.provider.query.QueryContentProvider
+import org.wordpress.android.provider.query.QueryResult
+import org.wordpress.android.util.config.JetpackProviderSyncFeatureConfig
+import org.wordpress.android.util.publicdata.ClientVerification
+import org.wordpress.android.util.publicdata.JetpackPublicData
+import org.wordpress.android.util.signature.SignatureNotFoundException
+import javax.inject.Inject
+
+class ReaderSavedPostsProvider : QueryContentProvider() {
+    @Inject lateinit var queryResult: QueryResult
+    @Inject lateinit var readerPostTableWrapper: ReaderPostTableWrapper
+    @Inject lateinit var jetpackPublicData: JetpackPublicData
+    @Inject lateinit var clientVerification: ClientVerification
+    @Inject lateinit var jetpackProviderSyncFeatureConfig: JetpackProviderSyncFeatureConfig
+
+    override fun onCreate(): Boolean {
+        return true
+    }
+
+    @Suppress("SwallowedException")
+    override fun query(
+        uri: Uri,
+        projection: Array<out String>?,
+        selection: String?,
+        selectionArgs: Array<out String>?,
+        sortOrder: String?
+    ): Cursor? {
+        inject()
+        if (!jetpackProviderSyncFeatureConfig.isEnabled()) {
+            return null
+        }
+        return context?.let {
+            try {
+                if (clientVerification.canTrust(callingPackage)) {
+                    val posts = readerPostTableWrapper.getPostsWithTag(
+                            readerTag = ReaderTag("", "", "", "", BOOKMARKED),
+                            maxRows = 0,
+                            excludeTextColumn = false
+                    )
+                    queryResult.createCursor(posts)
+                } else null
+            } catch (signatureNotFoundException: SignatureNotFoundException) {
+                null
+            }
+        }
+    }
+
+    private fun inject() {
+        if (!this::queryResult.isInitialized) {
+            (context?.applicationContext as WordPress).component().inject(this)
+        }
+    }
+}
diff --git a/WordPress/src/main/java/org/wordpress/android/reader/savedposts/resolver/ReaderSavedPostsResolver.kt b/WordPress/src/main/java/org/wordpress/android/reader/savedposts/resolver/ReaderSavedPostsResolver.kt
@@ -0,0 +1,101 @@
+package org.wordpress.android.reader.savedposts.resolver
+
+import android.database.Cursor
+import org.wordpress.android.R
+import org.wordpress.android.datasets.wrappers.ReaderDatabaseWrapper
+import org.wordpress.android.datasets.wrappers.ReaderPostTableWrapper
+import org.wordpress.android.datasets.wrappers.ReaderTagTableWrapper
+import org.wordpress.android.models.ReaderPostList
+import org.wordpress.android.models.ReaderTag
+import org.wordpress.android.models.ReaderTagType.BOOKMARKED
+import org.wordpress.android.provider.query.QueryResult
+import org.wordpress.android.reader.savedposts.JetpackReaderSavedPostsFlag
+import org.wordpress.android.reader.savedposts.ReaderSavedPostsAnalyticsTracker
+import org.wordpress.android.reader.savedposts.ReaderSavedPostsAnalyticsTracker.ErrorType
+import org.wordpress.android.reader.savedposts.provider.ReaderSavedPostsProvider
+import org.wordpress.android.resolver.ContentResolverWrapper
+import org.wordpress.android.ui.prefs.AppPrefsWrapper
+import org.wordpress.android.util.publicdata.WordPressPublicData
+import org.wordpress.android.viewmodel.ContextProvider
+import javax.inject.Inject
+
+class ReaderSavedPostsResolver @Inject constructor(
+    private val jetpackReaderSavedPostsFlag: JetpackReaderSavedPostsFlag,
+    private val queryResult: QueryResult,
+    private val contextProvider: ContextProvider,
+    private val contentResolverWrapper: ContentResolverWrapper,
+    private val readerSavedPostsAnalyticsTracker: ReaderSavedPostsAnalyticsTracker,
+    private val wordPressPublicData: WordPressPublicData,
+    private val appPrefsWrapper: AppPrefsWrapper,
+    private val readerPostTableWrapper: ReaderPostTableWrapper,
+    private val readerTagTableWrapper: ReaderTagTableWrapper,
+    private val readerDatabaseWrapper: ReaderDatabaseWrapper
+) {
+    fun tryGetReaderSavedPosts(onSuccess: () -> Unit, onFailure: () -> Unit) {
+        val isFeatureFlagEnabled = jetpackReaderSavedPostsFlag.isEnabled()
+        if (!isFeatureFlagEnabled) {
+            onFailure()
+            return
+        }
+        val isFirstTry = appPrefsWrapper.getIsFirstTryReaderSavedPostsJetpack()
+        if (!isFirstTry) {
+            onFailure()
+            return
+        }
+
+        readerSavedPostsAnalyticsTracker.trackStart()
+        appPrefsWrapper.saveIsFirstTryReaderSavedPostsJetpack(false)
+        val savedPostsCursor = getReaderSavedPostsCursor()
+        if (savedPostsCursor != null) {
+            val posts = queryResult.getValue<ReaderPostList>(savedPostsCursor) ?: ReaderPostList()
+
+            updateReaderSavedPosts(onSuccess, onFailure, posts)
+        } else {
+            readerSavedPostsAnalyticsTracker.trackFailed(ErrorType.QuerySavedPostsError)
+            onFailure()
+        }
+    }
+
+    private fun getReaderSavedPostsCursor(): Cursor? {
+        val savedPostsUriValue =
+                "content://${wordPressPublicData.currentPackageId()}.${ReaderSavedPostsProvider::class.simpleName}"
+        return contentResolverWrapper.queryUri(
+                contextProvider.getContext().contentResolver,
+                savedPostsUriValue
+        )
+    }
+
+    @Suppress("TooGenericExceptionCaught", "SwallowedException")
+    private fun updateReaderSavedPosts(
+        onSuccess: () -> Unit,
+        onFailure: () -> Unit,
+        posts: ReaderPostList
+    ) {
+        try {
+            if (posts.isNotEmpty()) {
+                readerDatabaseWrapper.reset(false)
+                readerTagTableWrapper.addOrUpdateTag(
+                        ReaderTag(
+                                "",
+                                contextProvider.getContext().getString(R.string.reader_save_for_later_display_name),
+                                contextProvider.getContext().getString(R.string.reader_save_for_later_title),
+                                "",
+                                BOOKMARKED
+                        )
+                )
+
+                requireNotNull(readerTagTableWrapper.getBookmarkTags()) {
+                    "unexpected null bookmark tags"
+                }.first().let {
+                    readerPostTableWrapper.addOrUpdatePosts(it, posts)
+                }
+            }
+
+            readerSavedPostsAnalyticsTracker.trackSuccess(posts.size)
+            onSuccess()
+        } catch (exception: Exception) {
+            readerSavedPostsAnalyticsTracker.trackFailed(ErrorType.GenericError(exception.message))
+            onFailure()
+        }
+    }
+}
diff --git a/WordPress/src/main/java/org/wordpress/android/sharedlogin/resolver/SharedLoginResolver.kt b/WordPress/src/main/java/org/wordpress/android/sharedlogin/resolver/SharedLoginResolver.kt
@@ -5,6 +5,7 @@ import android.database.Cursor
 import org.wordpress.android.fluxc.Dispatcher
 import org.wordpress.android.fluxc.store.AccountStore
 import org.wordpress.android.provider.query.QueryResult
+import org.wordpress.android.reader.savedposts.resolver.ReaderSavedPostsResolver
 import org.wordpress.android.resolver.ContentResolverWrapper
 import org.wordpress.android.sharedlogin.JetpackSharedLoginFlag
 import org.wordpress.android.sharedlogin.SharedLoginAnalyticsTracker
@@ -29,7 +30,8 @@ class SharedLoginResolver @Inject constructor(
     private val accountActionBuilderWrapper: AccountActionBuilderWrapper,
     private val appPrefsWrapper: AppPrefsWrapper,
     private val sharedLoginAnalyticsTracker: SharedLoginAnalyticsTracker,
-    private val userFlagsResolver: UserFlagsResolver
+    private val userFlagsResolver: UserFlagsResolver,
+    private val readerSavedPostsResolver: ReaderSavedPostsResolver
 ) {
     fun tryJetpackLogin() {
         val isFeatureFlagEnabled = jetpackSharedLoginFlag.isEnabled()
@@ -48,8 +50,22 @@ class SharedLoginResolver @Inject constructor(
             val accessToken = queryResult.getValue<String>(accessTokenCursor) ?: ""
             if (accessToken.isNotEmpty()) {
                 sharedLoginAnalyticsTracker.trackLoginSuccess()
-                dispatchUpdateAccessToken(accessToken)
-                userFlagsResolver.tryGetUserFlags({ reloadMainScreen() }, { reloadMainScreen() })
+                userFlagsResolver.tryGetUserFlags(
+                        {
+                            readerSavedPostsResolver.tryGetReaderSavedPosts(
+                                    {
+                                        dispatchUpdateAccessToken(accessToken)
+                                        reloadMainScreen()
+                                    },
+                                    {
+                                        reloadMainScreen()
+                                    }
+                            )
+                        },
+                        {
+                            reloadMainScreen()
+                        }
+                )
             } else {
                 sharedLoginAnalyticsTracker.trackLoginFailed(ErrorType.WPNotLoggedInError)
             }
diff --git a/WordPress/src/main/java/org/wordpress/android/ui/prefs/AppPrefs.java b/WordPress/src/main/java/org/wordpress/android/ui/prefs/AppPrefs.java
@@ -283,7 +283,10 @@ public enum UndeletablePrefKey implements PrefKey {
         IS_FIRST_TRY_USER_FLAGS_JETPACK,
 
         // Indicates if this is the first time we try sync the blogging reminders in Jetpack automatically
-        IS_FIRST_TRY_BLOGGING_REMINDERS_SYNC_JETPACK
+        IS_FIRST_TRY_BLOGGING_REMINDERS_SYNC_JETPACK,
+
+        // Indicates if this is the first time we try to get the reader saved posts in Jetpack automatically
+        IS_FIRST_TRY_READER_SAVED_POSTS_JETPACK
     }
 
     static SharedPreferences prefs() {
@@ -1459,4 +1462,12 @@ public static Boolean getIsFirstTryBloggingRemindersSyncJetpack() {
     public static void saveIsFirstTryBloggingRemindersSyncJetpack(final boolean isFirstTry) {
         setBoolean(UndeletablePrefKey.IS_FIRST_TRY_BLOGGING_REMINDERS_SYNC_JETPACK, isFirstTry);
     }
+
+    public static Boolean getIsFirstTryReaderSavedPostsJetpack() {
+        return getBoolean(UndeletablePrefKey.IS_FIRST_TRY_READER_SAVED_POSTS_JETPACK, true);
+    }
+
+    public static void saveIsFirstTryReaderSavedPostsJetpack(final boolean isFirstTry) {
+        setBoolean(UndeletablePrefKey.IS_FIRST_TRY_READER_SAVED_POSTS_JETPACK, isFirstTry);
+    }
 }
diff --git a/WordPress/src/main/java/org/wordpress/android/ui/prefs/AppPrefsWrapper.kt b/WordPress/src/main/java/org/wordpress/android/ui/prefs/AppPrefsWrapper.kt
@@ -246,6 +246,11 @@ class AppPrefsWrapper @Inject constructor() {
     fun saveIsFirstTryBloggingRemindersSyncJetpack(isFirstTry: Boolean) =
             AppPrefs.saveIsFirstTryBloggingRemindersSyncJetpack(isFirstTry)
 
+    fun getIsFirstTryReaderSavedPostsJetpack(): Boolean = AppPrefs.getIsFirstTryReaderSavedPostsJetpack()
+
+    fun saveIsFirstTryReaderSavedPostsJetpack(isFirstTry: Boolean) =
+            AppPrefs.saveIsFirstTryReaderSavedPostsJetpack(isFirstTry)
+
     fun getAllPrefs(): Map<String, Any?> = AppPrefs.getAllPrefs()
 
     fun setString(prefKey: PrefKey, value: String) {
diff --git a/WordPress/src/main/java/org/wordpress/android/userflags/provider/UserFlagsProvider.kt b/WordPress/src/main/java/org/wordpress/android/userflags/provider/UserFlagsProvider.kt
@@ -50,7 +50,8 @@ class UserFlagsProvider : QueryContentProvider() {
             UndeletablePrefKey.SWIPE_TO_NAVIGATE_READER.name,
             UndeletablePrefKey.IS_MAIN_FAB_TOOLTIP_DISABLED.name,
             UndeletablePrefKey.SHOULD_SHOW_STORIES_INTRO.name,
-            UndeletablePrefKey.SHOULD_SHOW_STORAGE_WARNING.name
+            UndeletablePrefKey.SHOULD_SHOW_STORAGE_WARNING.name,
+            UndeletablePrefKey.LAST_USED_USER_ID.name
     )
 
     private val userFlagsCompositeKeysSet: Set<String> = setOf(
diff --git a/WordPress/src/main/java/org/wordpress/android/util/config/JetpackReaderSavedPostsFeatureConfig.kt b/WordPress/src/main/java/org/wordpress/android/util/config/JetpackReaderSavedPostsFeatureConfig.kt
@@ -0,0 +1,19 @@
+package org.wordpress.android.util.config
+
+import org.wordpress.android.BuildConfig
+import org.wordpress.android.annotation.Feature
+import javax.inject.Inject
+
+@Feature(JetpackReaderSavedPostsFeatureConfig.JETPACK_READER_SAVED_POSTS_REMOTE_FIELD, false)
+class JetpackReaderSavedPostsFeatureConfig
+@Inject constructor(
+    appConfig: AppConfig
+) : FeatureConfig(
+        appConfig,
+        BuildConfig.JETPACK_READER_SAVED_POSTS,
+        JETPACK_READER_SAVED_POSTS_REMOTE_FIELD
+) {
+    companion object {
+        const val JETPACK_READER_SAVED_POSTS_REMOTE_FIELD = "jetpack_reader_saved_posts_remote_field"
+    }
+}
diff --git a/WordPress/src/test/java/org/wordpress/android/sharedlogin/resolver/SharedLoginResolverTest.kt b/WordPress/src/test/java/org/wordpress/android/sharedlogin/resolver/SharedLoginResolverTest.kt
diff --git a/WordPress/src/wordpress/AndroidManifest.xml b/WordPress/src/wordpress/AndroidManifest.xml
diff --git a/libs/analytics/src/main/java/org/wordpress/android/analytics/AnalyticsTracker.java b/libs/analytics/src/main/java/org/wordpress/android/analytics/AnalyticsTracker.java
diff --git a/libs/analytics/src/main/java/org/wordpress/android/analytics/AnalyticsTrackerNosara.java b/libs/analytics/src/main/java/org/wordpress/android/analytics/AnalyticsTrackerNosara.java

Original file line number	Diff line number	Diff line change
`@@ -29,4 +29,7 @@ class ReaderPostTableWrapper @Inject constructor() {`
`29`	`29`	`ReaderPostTable.getPostsWithTag(readerTag, maxRows, excludeTextColumn)`
`30`	`30`
`31`	`31`	`fun getNumPostsWithTag(readerTag: ReaderTag): Int = ReaderPostTable.getNumPostsWithTag(readerTag)`
	`32`	`+`
	`33`	`+ fun addOrUpdatePosts(readerTag: ReaderTag, posts: ReaderPostList) =`
	`34`	`+ ReaderPostTable.addOrUpdatePosts(readerTag, posts)`
`32`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,4 +16,8 @@ class ReaderTagTableWrapper @Inject constructor() {`
`16`	`16`	`fun getFollowedTags(): ReaderTagList = ReaderTagTable.getFollowedTags()`
`17`	`17`
`18`	`18`	`fun clearTagLastUpdated(readerTag: ReaderTag) = ReaderTagTable.clearTagLastUpdated(readerTag)`
	`19`	`+`
	`20`	`+ fun addOrUpdateTag(readerTag: ReaderTag) = ReaderTagTable.addOrUpdateTag(readerTag)`
	`21`	`+`
	`22`	`+ fun getBookmarkTags(): ReaderTagList? = ReaderTagTable.getBookmarkTags()`
`19`	`23`	`}`