[Feature branch] Year In Review

app/src/main/AndroidManifest.xml

@@ -373,6 +373,9 @@
         <activity
             android:name=".settings.dev.playground.CategoryDeveloperPlayGround"/>
 
+        <activity
+            android:name=".yearinreview.YearInReviewOnboardingActivity"/>
+
         <activity
             android:name=".yearinreview.YearInReviewActivity"/>
 

app/src/main/java/org/wikipedia/activitytab/ActivityTabViewModel.kt

@@ -139,12 +139,12 @@ class ActivityTabViewModel() : ViewModel() {
             val totalTimeSpent = AppDatabase.instance.historyEntryWithImageDao().getTimeSpentSinceTimeStamp(weekAgo)
 
             val thirtyDaysAgo = now - TimeUnit.DAYS.toMillis(30)
-            val articlesReadThisMonth = AppDatabase.instance.historyEntryDao().getDistinctEntriesSince(thirtyDaysAgo) ?: 0
+            val articlesReadThisMonth = AppDatabase.instance.historyEntryDao().getDistinctEntriesCountSince(thirtyDaysAgo) ?: 0
             val articlesReadByWeek = mutableListOf<Int>()
-            articlesReadByWeek.add(AppDatabase.instance.historyEntryDao().getDistinctEntriesSince(weekAgo) ?: 0)
+            articlesReadByWeek.add(AppDatabase.instance.historyEntryDao().getDistinctEntriesCountSince(weekAgo) ?: 0)
             for (i in 1..3) {
                 weekAgo -= weekInMillis
-                val articlesRead = AppDatabase.instance.historyEntryDao().getDistinctEntriesBetween(weekAgo, weekAgo + weekInMillis)
+                val articlesRead = AppDatabase.instance.historyEntryDao().getDistinctEntriesCountBetween(weekAgo, weekAgo + weekInMillis)
                 articlesReadByWeek.add(articlesRead)
             }
             val mostRecentReadTime = AppDatabase.instance.historyEntryDao().getMostRecentEntry()?.timestamp?.toInstant()?.atZone(ZoneId.systemDefault())?.toLocalDateTime()

app/src/main/java/org/wikipedia/categories/db/CategoryDao.kt

@@ -28,6 +28,10 @@ interface CategoryDao {
     @Query("SELECT year, month, title, lang, SUM (count) AS count FROM Category WHERE year = :year AND month = :month GROUP BY title, lang ORDER BY count DESC")
     suspend fun getTopCategoriesByMonth(year: Int, month: Int): List<Category>
 
+    // Get top categories by year
+    @Query("SELECT year, month, title, lang, SUM (count) AS count FROM Category WHERE year = :year GROUP BY title, lang ORDER BY count DESC LIMIT :limit")
+    suspend fun getTopCategoriesByYear(year: Int, limit: Int): List<Category>
+
     @Query("SELECT * FROM Category")
     suspend fun getAllCategories(): List<Category>
 

app/src/main/java/org/wikipedia/history/db/HistoryEntryDao.kt

@@ -25,10 +25,13 @@ interface HistoryEntryDao {
     suspend fun findEntryBy(authority: String, lang: String, apiTitle: String, timestamp: Long): HistoryEntry?
 
     @Query("SELECT COUNT(*) FROM (SELECT DISTINCT HistoryEntry.lang, HistoryEntry.apiTitle FROM HistoryEntry WHERE timestamp BETWEEN :startDate AND :endDate)")
-    suspend fun getDistinctEntriesBetween(startDate: Long?, endDate: Long?): Int
+    suspend fun getDistinctEntriesCountBetween(startDate: Long?, endDate: Long?): Int
 
-    @Query("SELECT DISTINCT displayTitle FROM HistoryEntry LIMIT 3")
-    suspend fun getDisplayTitles(): List<String>
+    @Query("SELECT COUNT(*) FROM (SELECT DISTINCT HistoryEntry.lang, HistoryEntry.apiTitle FROM HistoryEntry WHERE timestamp > :timestamp)")
+    suspend fun getDistinctEntriesCountSince(timestamp: Long): Int?
+
+    @Query("SELECT displayTitle FROM HistoryEntry WHERE timestamp > :timestamp GROUP BY displayTitle ORDER BY COUNT(displayTitle) DESC LIMIT :limit")
+    suspend fun getTopVisitedEntriesSince(limit: Int, timestamp: Long): List<String>
 
     @Query("SELECT COUNT(*) FROM HistoryEntry")
     suspend fun getHistoryCount(): Int
@@ -39,9 +42,6 @@ interface HistoryEntryDao {
     @Query("DELETE FROM HistoryEntry WHERE authority = :authority AND lang = :lang AND namespace = :namespace AND apiTitle = :apiTitle")
     suspend fun deleteBy(authority: String, lang: String, namespace: String?, apiTitle: String)
 
-    @Query("SELECT COUNT(*) FROM (SELECT DISTINCT HistoryEntry.lang, HistoryEntry.apiTitle FROM HistoryEntry WHERE timestamp > :timestamp)")
-    suspend fun getDistinctEntriesSince(timestamp: Long): Int?
-
     @Query("SELECT * FROM HistoryEntry ORDER BY timestamp DESC LIMIT 1")
     suspend fun getMostRecentEntry(): HistoryEntry?
 

app/src/main/java/org/wikipedia/login/LoginActivity.kt

@@ -298,6 +298,7 @@ class LoginActivity : BaseActivity() {
         const val SOURCE_SUGGESTED_EDITS = "suggestededits"
         const val SOURCE_TALK = "talk"
         const val SOURCE_ACTIVITY_TAB = "activity_tab"
+        const val SOURCE_YEAR_IN_REVIEW = "yir"
 
         fun newIntent(context: Context, source: String, createAccountFirst: Boolean = true): Intent {
             return Intent(context, LoginActivity::class.java)

app/src/main/java/org/wikipedia/main/MainFragment.kt

@@ -92,7 +92,7 @@ import org.wikipedia.views.NotificationButtonView
 import org.wikipedia.views.TabCountsView
 import org.wikipedia.views.imageservice.ImageService
 import org.wikipedia.watchlist.WatchlistActivity
-import org.wikipedia.yearinreview.YearInReviewEntryDialog
+import org.wikipedia.yearinreview.YearInReviewOnboardingActivity
 import java.io.File
 import java.util.concurrent.TimeUnit
 
@@ -499,7 +499,7 @@ class MainFragment : Fragment(), BackPressedHandler, MenuProvider, FeedFragment.
     }
 
     override fun yearInReviewClick() {
-        ExclusiveBottomSheetPresenter.show(childFragmentManager, YearInReviewEntryDialog.newInstance())
+        startActivity(YearInReviewOnboardingActivity.newIntent(requireActivity()))
     }
 
     fun setBottomNavVisible(visible: Boolean) {

app/src/main/java/org/wikipedia/navtab/MenuNavTabDialog.kt

@@ -94,6 +94,7 @@ class MenuNavTabDialog : ExtendedBottomSheetDialogFragment() {
             callback()?.yearInReviewClick()
             dismiss()
         }
+        binding.yearInReviewRedDot.isVisible = !Prefs.yearInReviewVisited
 
         binding.mainDrawerEditContainer.setOnClickListener {
             BreadCrumbLogEvent.logClick(requireActivity(), binding.mainDrawerEditContainer)

app/src/main/java/org/wikipedia/page/PageActivity.kt

@@ -86,6 +86,7 @@ import org.wikipedia.views.FrameLayoutNavMenuTriggerer
 import org.wikipedia.views.ObservableWebView
 import org.wikipedia.views.ViewUtil
 import org.wikipedia.watchlist.WatchlistExpiry
+import org.wikipedia.yearinreview.YearInReviewOnboardingActivity
 import java.util.Locale
 
 class PageActivity : BaseActivity(), PageFragment.Callback, LinkPreviewDialog.LoadPageCallback, FrameLayoutNavMenuTriggerer.Callback {
@@ -179,6 +180,12 @@ class PageActivity : BaseActivity(), PageFragment.Callback, LinkPreviewDialog.Lo
         }
     }
 
+    private val yearInReviewLauncher = registerForActivityResult(ActivityResultContracts.StartActivityForResult()) {
+        if (it.resultCode == RESULT_CANCELED) {
+            FeedbackUtil.showMessage(this, getString(R.string.year_in_review_get_started_later))
+        }
+    }
+
     public override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         if (!DeviceUtil.assertAppContext(this)) {
@@ -283,6 +290,8 @@ class PageActivity : BaseActivity(), PageFragment.Callback, LinkPreviewDialog.Lo
             // then we must have been launched with an Intent, so... handle it!
             handleIntent(intent)
         }
+
+        maybeShowYearInReview()
     }
 
     override fun onStart() {
@@ -706,6 +715,12 @@ class PageActivity : BaseActivity(), PageFragment.Callback, LinkPreviewDialog.Lo
             .show()
     }
 
+    private fun maybeShowYearInReview() {
+        if (Prefs.isYearInReviewEnabled && !Prefs.yearInReviewVisited) {
+            yearInReviewLauncher.launch((YearInReviewOnboardingActivity.newIntent(this)))
+        }
+    }
+
     private fun maybeShowThemeTooltip() {
         if (!Prefs.showOneTimeCustomizeToolbarTooltip) {
             return

app/src/main/java/org/wikipedia/readinglist/db/ReadingListPageDao.kt

@@ -98,6 +98,9 @@ interface ReadingListPageDao {
     @Query("SELECT * FROM ReadingListPage WHERE atime > 0 ORDER BY atime DESC LIMIT :limit OFFSET :offset")
     suspend fun getPagesByLocallySavedTime(limit: Int, offset: Int): List<ReadingListPage>
 
+    @Query("SELECT DISTINCT displayTitle FROM ReadingListPage ORDER BY atime DESC LIMIT :limit")
+    suspend fun getLatestArticleTitles(limit: Int): List<String>
+
     suspend fun getAllPagesToBeSaved() = getPagesByStatus(ReadingListPage.STATUS_QUEUE_FOR_SAVE, true)
 
     suspend fun getAllPagesToBeForcedSave() = getPagesByStatus(ReadingListPage.STATUS_QUEUE_FOR_FORCED_SAVE, true)

app/src/main/java/org/wikipedia/settings/Prefs.kt

@@ -29,6 +29,7 @@ import org.wikipedia.util.DateUtil.dbDateParse
 import org.wikipedia.util.ReleaseUtil.isDevRelease
 import org.wikipedia.util.StringUtil
 import org.wikipedia.watchlist.WatchlistFilterTypes
+import org.wikipedia.yearinreview.YearInReviewModel
 import java.util.Date
 
 /** Shared preferences utility for convenient POJO access.  */
@@ -783,7 +784,11 @@ object Prefs {
         get() = PrefsIoUtil.getBoolean(R.string.preference_key_year_in_review_is_enabled, false)
         set(value) = PrefsIoUtil.setBoolean(R.string.preference_key_year_in_review_is_enabled, value)
 
-    var yirSurveyShown
+    var yearInReviewVisited: Boolean
+        get() = PrefsIoUtil.getBoolean(R.string.preference_key_year_in_review_visited, false)
+        set(value) = PrefsIoUtil.setBoolean(R.string.preference_key_year_in_review_visited, value)
+
+    var yearInReviewSurveyShown
         get() = PrefsIoUtil.getBoolean(R.string.preference_key_yir_survey_shown, false)
         set(value) = PrefsIoUtil.setBoolean(R.string.preference_key_yir_survey_shown, value)
 
@@ -858,4 +863,9 @@ object Prefs {
     var isActivityTabOnboardingShown
         get() = PrefsIoUtil.getBoolean(R.string.preference_key_activity_tab_onboarding_shown, false)
         set(value) = PrefsIoUtil.setBoolean(R.string.preference_key_activity_tab_onboarding_shown, value)
+
+    var yearInReviewModelData
+        get() = JsonUtil.decodeFromString<Map<Int, YearInReviewModel>>(PrefsIoUtil.getString(R.string.preference_key_yir_model_data, null))
+            ?: emptyMap()
+        set(modelDataWithYear) = PrefsIoUtil.setString(R.string.preference_key_yir_model_data, JsonUtil.encodeToString(modelDataWithYear))
 }

app/src/main/java/org/wikipedia/settings/dev/DeveloperSettingsPreferenceLoader.kt

@@ -257,6 +257,11 @@ internal class DeveloperSettingsPreferenceLoader(fragment: PreferenceFragmentCom
             fragment.requireActivity().finish()
             true
         }
+        findPreference(R.string.preference_key_yir_model_data).onPreferenceClickListener = Preference.OnPreferenceClickListener {
+            Prefs.yearInReviewModelData = emptyMap()
+            Toast.makeText(activity, "Year in Review data has been reset", Toast.LENGTH_SHORT).show()
+            true
+        }
     }
 
     private fun setUpMediaWikiSettings() {

app/src/main/java/org/wikipedia/yearinreview/YearInReviewActivity.kt

@@ -9,21 +9,15 @@ import androidx.activity.viewModels
 import androidx.compose.animation.EnterTransition
 import androidx.compose.animation.ExitTransition
 import androidx.compose.runtime.collectAsState
-import androidx.compose.runtime.getValue
-import androidx.compose.runtime.mutableStateOf
-import androidx.compose.runtime.remember
 import androidx.compose.runtime.rememberCoroutineScope
-import androidx.compose.runtime.setValue
 import androidx.navigation.compose.NavHost
 import androidx.navigation.compose.composable
 import androidx.navigation.compose.rememberNavController
-import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
 import org.wikipedia.activity.BaseActivity
 import org.wikipedia.analytics.eventplatform.BreadCrumbLogEvent
 import org.wikipedia.analytics.eventplatform.DonorExperienceEvent
 import org.wikipedia.analytics.eventplatform.EventPlatformClient
-import org.wikipedia.analytics.eventplatform.PatrollerExperienceEvent
 import org.wikipedia.compose.theme.BaseTheme
 import org.wikipedia.settings.Prefs
 
@@ -33,68 +27,27 @@ class YearInReviewActivity : BaseActivity() {
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
+        Prefs.yearInReviewVisited = true
+
         setContent {
             BaseTheme {
                 val coroutineScope = rememberCoroutineScope()
                 val navController = rememberNavController()
-                var isSurveyVisible by remember { mutableStateOf(false) }
 
                 BackHandler {
-                    if (viewModel.canShowSurvey) {
-                        isSurveyVisible = true
-                    } else {
-                        endYearInReviewActivity(coroutineScope, this)
-                    }
+                    finish()
                 }
 
-                if (isSurveyVisible) {
-                    Prefs.yirSurveyShown = true
-                    YearInReviewSurvey(
-                        onCancelButtonClick = {
-                            isSurveyVisible = false
-                            endYearInReviewActivity(coroutineScope, this)
-                        },
-                        onSubmitButtonClick = { selectedOption, userInput ->
-                            PatrollerExperienceEvent.logAction(
-                                action = "yir_survey_submit",
-                                activeInterface = "yir_survey_form",
-                                actionData = PatrollerExperienceEvent
-                                    .getActionDataString(
-                                        feedbackOption = selectedOption,
-                                        feedbackText = userInput
-                                    )
-                            )
-                            isSurveyVisible = false
-                            endYearInReviewActivity(coroutineScope, this)
-                        }
-                    )
-                }
+                // TODO: implement survey in the article screen.
 
                 NavHost(
                     navController = navController,
-                    startDestination = YearInReviewNavigation.Onboarding.name,
+                    startDestination = YearInReviewNavigation.ScreenDeck.name,
                     enterTransition = { EnterTransition.None },
                     popEnterTransition = { EnterTransition.None },
                     popExitTransition = { ExitTransition.None },
                     exitTransition = { ExitTransition.None }
                 ) {
-                    composable(route = YearInReviewNavigation.Onboarding.name) {
-                        YearInReviewOnboardingScreen(
-                            contentData = YearInReviewViewModel.getStartedData,
-                            onBackButtonClick = {
-                                if (viewModel.canShowSurvey) {
-                                    isSurveyVisible = true
-                                } else {
-                                    endYearInReviewActivity(coroutineScope, this@YearInReviewActivity)
-                                }
-                            },
-                            onGetStartedClick = {
-                                navController.navigate(
-                                    route = YearInReviewNavigation.ScreenDeck.name
-                                )
-                            }
-                        )
-                    }
                     composable(route = YearInReviewNavigation.ScreenDeck.name) {
                         val screenState = viewModel.uiScreenListState.collectAsState().value
                         YearInReviewScreenDeck(
@@ -105,11 +58,10 @@ class YearInReviewActivity : BaseActivity() {
                                         pagerState.animateScrollToPage(pagerState.currentPage - 1)
                                     }
                                 } else {
-                                    navController.popBackStack()
+                                    finish()
                                 }
                             },
                             onNextButtonClick = { pagerState ->
-                                viewModel.canShowSurvey = true
                                 coroutineScope.launch {
                                     pagerState.animateScrollToPage(pagerState.currentPage + 1)
                                 }
@@ -138,9 +90,5 @@ class YearInReviewActivity : BaseActivity() {
         fun newIntent(context: Context): Intent {
             return Intent(context, YearInReviewActivity::class.java)
         }
-
-        fun endYearInReviewActivity(scope: CoroutineScope, activity: YearInReviewActivity) {
-            activity.finish()
-        }
     }
 }