Oppia Android Promoted Stories Domain Layer

domain/src/main/java/org/oppia/android/domain/topic/StoryProgressController.kt

@@ -35,6 +35,7 @@ const val RATIOS_EXPLORATION_ID_0 = "2mzzFVDLuAj8"
 const val RATIOS_EXPLORATION_ID_1 = "5NWuolNcwH6e"
 const val RATIOS_EXPLORATION_ID_2 = "k2bQ7z5XHNbK"
 const val RATIOS_EXPLORATION_ID_3 = "tIoSb3HZFN6e"
+const val UPCOMING_TOPIC_ID_1 = "test_topic_id_2"
 
 private const val CACHE_NAME = "topic_progress_database"
 private const val RETRIEVE_TOPIC_PROGRESS_LIST_DATA_PROVIDER_ID =

domain/src/main/java/org/oppia/android/domain/topic/StoryProgressTestHelper.kt

@@ -26,8 +26,8 @@ class StoryProgressTestHelper @Inject constructor(
    * @param profileId the profile we are setting partial progress of the fraction story for
    * @param timestampOlderThanOneWeek if the timestamp for this topic progress is more than one week ago
    */
-  fun markPartialStoryProgressForFractions(profileId: ProfileId, timestampOlderThanAWeek: Boolean) {
-    val timestamp = if (!timestampOlderThanAWeek) {
+  fun markChapDoneFrac0Story0Exp0(profileId: ProfileId, timestampOlderThanOneWeek: Boolean) {
+    val timestamp = if (!timestampOlderThanOneWeek) {
       getCurrentTimestamp()
     } else {
       getOldTimestamp()
@@ -41,13 +41,37 @@ class StoryProgressTestHelper @Inject constructor(
     )
   }
 
+  /**
+   * Mark a partial story progress for a particular profile.
+   *
+   * @param profileId the profile we are setting partial progress of the fraction story for
+   * @param timestampOlderThanOneWeek if the timestamp for this topic progress is more than one week ago
+   */
+  fun markChapDoneFrac0Story0Expl(profileId: ProfileId, timestampOlderThanOneWeek: Boolean) {
+    val timestamp = if (!timestampOlderThanOneWeek) {
+      getCurrentTimestamp()
+    } else {
+      getOldTimestamp()
+    }
+    storyProgressController.recordCompletedChapter(
+      profileId,
+      FRACTIONS_TOPIC_ID,
+      FRACTIONS_STORY_ID_0,
+      FRACTIONS_EXPLORATION_ID_1,
+      timestamp
+    )
+  }
+
   /**
    * Creates a partial topic progress for a particular profile.
    *
    * @param profileId the profile we are setting partial progress of the fraction topic for
-   * @param timestampOlderThanOneWeek if the timestamp for this topic progress is more than one week ago
+   * @param timestampOlderThanAWeek if the timestamp for this topic progress is more than one week ago
    */
-  fun markPartialTopicProgressForFractions(profileId: ProfileId, timestampOlderThanAWeek: Boolean) {
+  fun markPartialTopicProgressForFractions(
+    profileId: ProfileId,
+    timestampOlderThanAWeek: Boolean
+  ) {
     val timestamp = if (!timestampOlderThanAWeek) {
       getCurrentTimestamp()
     } else {
@@ -66,7 +90,7 @@ class StoryProgressTestHelper @Inject constructor(
    *  Marks full story progress for a particular profile.
    *
    * @param profileId the profile we are setting full on the fraction story progress for
-   * @param timestampOlderThanOneWeek if the timestamp for completing the story is more than one week ago
+   * @param timestampOlderThanAWeek if the timestamp for completing the story is more than one week ago
    */
   fun markFullStoryProgressForFractions(profileId: ProfileId, timestampOlderThanAWeek: Boolean) {
     val timestamp = if (!timestampOlderThanAWeek) {
@@ -97,8 +121,8 @@ class StoryProgressTestHelper @Inject constructor(
    * @param profileId the profile we are setting fraction topic progress for
    * @param timestampOlderThanOneWeek if the timestamp for completing the topic is more than one week ago
    */
-  fun markFullTopicProgressForFractions(profileId: ProfileId, timestampOlderThanAWeek: Boolean) {
-    val timestamp = if (!timestampOlderThanAWeek) {
+  fun markFullTopicProgressForFractions(profileId: ProfileId, timestampOlderThanOneWeek: Boolean) {
+    val timestamp = if (!timestampOlderThanOneWeek) {
       getCurrentTimestamp()
     } else {
       getOldTimestamp()
@@ -232,10 +256,55 @@ class StoryProgressTestHelper @Inject constructor(
   }
 
   /**
-   * Marks one story progress full in ratios exploration for a particular profile.
+   * Marks full topic progress on the second test topic for a particular profile.
+   *
+   * @param profileId the profile we are setting topic progress for
+   * @param timestampOlderThanOneWeek if the timestamp for completing the topic is from more than one week ago
+   */
+  fun markFullProgressForSecondTestTopic(profileId: ProfileId, timestampOlderThanOneWeek: Boolean) {
+    val timestamp = if (!timestampOlderThanOneWeek) {
+      getCurrentTimestamp()
+    } else {
+      getOldTimestamp()
+    }
+    storyProgressController.recordCompletedChapter(
+      profileId,
+      TEST_TOPIC_ID_1,
+      TEST_STORY_ID_2,
+      TEST_EXPLORATION_ID_4,
+      timestamp
+    )
+  }
+
+  /**
+   * Marks recently played on the second test topic for a particular profile.
+   *
+   * @param profileId the profile we are setting topic progress for
+   * @param timestampOlderThanOneWeek if the timestamp for completing the topic is from more than one week ago
+   */
+  fun markRecentlyPlayedForSecondTestTopic(
+    profileId: ProfileId,
+    timestampOlderThanOneWeek: Boolean
+  ) {
+    val timestamp = if (!timestampOlderThanOneWeek) {
+      getCurrentTimestamp()
+    } else {
+      getOldTimestamp()
+    }
+    storyProgressController.recordRecentlyPlayedChapter(
+      profileId,
+      TEST_TOPIC_ID_1,
+      TEST_STORY_ID_2,
+      TEST_EXPLORATION_ID_4,
+      timestamp
+    )
+  }
+
+  /**
+   * Marks one story progress fully complete in the ratios topic for a particular profile.
    *
    * @param profileId the profile we are setting topic progress on ratios for
-   * @param timestampOlderThanOneWeek if the timestamp for this progress is from more than one week ago
+   * @param timestampOlderThanAWeek if the timestamp for this progress is from more than one week ago
    */
   fun markFullStoryPartialTopicProgressForRatios(
     profileId: ProfileId,
@@ -253,7 +322,54 @@ class StoryProgressTestHelper @Inject constructor(
       RATIOS_EXPLORATION_ID_0,
       timestamp
     )
+    storyProgressController.recordCompletedChapter(
+      profileId,
+      RATIOS_TOPIC_ID,
+      RATIOS_STORY_ID_0,
+      RATIOS_EXPLORATION_ID_1,
+      timestamp
+    )
+  }
 
+  /**
+   * Marks one story progress full in ratios exploration for a particular profile.
+   *
+   * @param profileId the profile we are setting topic progress on ratios for
+   * @param timestampOlderThanOneWeek if the timestamp for this progress is from more than one week ago
+   */
+  fun markChapDoneOfRatiosStory0Exp0(
+    profileId: ProfileId,
+    timestampOlderThanOneWeek: Boolean
+  ) {
+    val timestamp = if (!timestampOlderThanOneWeek) {
+      getCurrentTimestamp()
+    } else {
+      getOldTimestamp()
+    }
+    storyProgressController.recordCompletedChapter(
+      profileId,
+      RATIOS_TOPIC_ID,
+      RATIOS_STORY_ID_0,
+      RATIOS_EXPLORATION_ID_0,
+      timestamp
+    )
+  }
+
+  /**
+   * Marks one story progress full in ratios exploration for a particular profile.
+   *
+   * @param profileId the profile we are setting topic progress on ratios for
+   * @param timestampOlderThanOneWeek if the timestamp for this progress is from more than one week ago
+   */
+  fun markChapDoneOfRatiosStory0Exp1(
+    profileId: ProfileId,
+    timestampOlderThanOneWeek: Boolean
+  ) {
+    val timestamp = if (!timestampOlderThanOneWeek) {
+      getCurrentTimestamp()
+    } else {
+      getOldTimestamp()
+    }
     storyProgressController.recordCompletedChapter(
       profileId,
       RATIOS_TOPIC_ID,
@@ -267,10 +383,13 @@ class StoryProgressTestHelper @Inject constructor(
    * Marks two partial story progress in ratios exploration for a particular profile.
    *
    * @param profileId the profile we are setting topic progress on ratios for
-   * @param timestampOlderThanOneWeek if the timestamp for the progress on the two stories is from more than one week
+   * @param timestampOlderThanAWeek if the timestamp for the progress on the two stories is from more than one week
    *        ago.
    */
-  fun markTwoPartialStoryProgressForRatios(profileId: ProfileId, timestampOlderThanAWeek: Boolean) {
+  fun markTwoPartialStoryProgressForRatios(
+    profileId: ProfileId,
+    timestampOlderThanAWeek: Boolean
+  ) {
     val timestamp = if (!timestampOlderThanAWeek) {
       getCurrentTimestamp()
     } else {
@@ -297,7 +416,7 @@ class StoryProgressTestHelper @Inject constructor(
    * Marks exploration [FRACTIONS_EXPLORATION_ID_0] as recently played for a particular profile.
    *
    * @param profileId the profile we are setting recently played for
-   * @param timestampOlderThanOneWeek if the timestamp for the recently played story is more than a week ago
+   * @param timestampOlderThanAWeek if the timestamp for the recently played story is more than a week ago
    */
   fun markRecentlyPlayedForFractionsStory0Exploration0(
     profileId: ProfileId,
@@ -321,7 +440,7 @@ class StoryProgressTestHelper @Inject constructor(
    * Marks exploration [RATIOS_EXPLORATION_ID_0] as recently played for a particular profile.
    *
    * @param profileId the profile we are setting recently played for
-   * @param timestampOlderThanOneWeek if the timestamp for the recently played story is more than a week ago
+   * @param timestampOlderThanAWeek if the timestamp for the recently played story is more than a week ago
    */
   fun markRecentlyPlayedForRatiosStory0Exploration0(
     profileId: ProfileId,
@@ -350,9 +469,9 @@ class StoryProgressTestHelper @Inject constructor(
    */
   fun markRecentlyPlayedForRatiosStory0Exploration0AndStory1Exploration2(
     profileId: ProfileId,
-    timestampOlderThanAWeek: Boolean
+    timestampOlderThanOneWeek: Boolean
   ) {
-    val timestamp = if (!timestampOlderThanAWeek) {
+    val timestamp = if (!timestampOlderThanOneWeek) {
       getCurrentTimestamp()
     } else {
       getOldTimestamp()
@@ -379,7 +498,7 @@ class StoryProgressTestHelper @Inject constructor(
    * Marks first exploration in all stories of Ratios & Fractions as recently played for a particular profile.
    *
    * @param profileId the profile we are setting recently played for.
-   * @param timestampOlderThanOneWeek the timestamp for the recently played explorations is more than a week ago.
+   * @param timestampOlderThanAWeek the timestamp for the recently played explorations is more than a week ago.
    */
   fun markRecentlyPlayedForFirstExplorationInAllStoriesInFractionsAndRatios(
     profileId: ProfileId,
@@ -420,7 +539,7 @@ class StoryProgressTestHelper @Inject constructor(
    * Marks one explorations in each of the two two test topics as recently played for a particular profile.
    *
    * @param profileId the profile we are setting recently played for
-   * @param timestampOlderThanOneWeek if the timestamp for the recently played story is more than a week ago
+   * @param timestampOlderThanAWeek if the timestamp for the recently played story is more than a week ago
    */
   fun markRecentlyPlayedForOneExplorationInTestTopics1And2(
     profileId: ProfileId,
@@ -446,4 +565,76 @@ class StoryProgressTestHelper @Inject constructor(
       timestamp
     )
   }
+
+  /**
+   * Marks one exploration in first test topic as completed played for a particular profile.
+   *
+   * @param profileId the profile we are setting recently played for
+   * @param timestampOlderThanOneWeek if the timestamp for the recently played story is more than a week ago
+   */
+  fun markChapterDoneFirstTestTopicStory0Exploration0(
+    profileId: ProfileId,
+    timestampOlderThanOneWeek: Boolean
+  ) {
+    val timestamp = if (!timestampOlderThanOneWeek) {
+      getCurrentTimestamp()
+    } else {
+      getOldTimestamp()
+    }
+    storyProgressController.recordCompletedChapter(
+      profileId,
+      TEST_TOPIC_ID_0,
+      TEST_STORY_ID_0,
+      TEST_EXPLORATION_ID_2,
+      timestamp
+    )
+  }
+
+  /**
+   * Marks one exploration in first test topic as completed played for a particular profile.
+   *
+   * @param profileId the profile we are setting recently played for
+   * @param timestampOlderThanOneWeek if the timestamp for the recently played story is more than a week ago
+   */
+  fun markRecentlyPlayedFirstTestTopicStory1Exploration1(
+    profileId: ProfileId,
+    timestampOlderThanOneWeek: Boolean
+  ) {
+    val timestamp = if (!timestampOlderThanOneWeek) {
+      getCurrentTimestamp()
+    } else {
+      getOldTimestamp()
+    }
+    storyProgressController.recordRecentlyPlayedChapter(
+      profileId,
+      TEST_TOPIC_ID_0,
+      TEST_STORY_ID_1,
+      TEST_EXPLORATION_ID_1,
+      timestamp
+    )
+  }
+
+  /**
+   * Marks one explorations in first test topic as completed for a particular profile.
+   *
+   * @param profileId the profile we are setting recently played for
+   * @param timestampOlderThanOneWeek if the timestamp for the recently played story is more than a week ago
+   */
+  fun markChapterDoneFirstTestTopicStory0Exploration1(
+    profileId: ProfileId,
+    timestampOlderThanOneWeek: Boolean
+  ) {
+    val timestamp = if (!timestampOlderThanOneWeek) {
+      getCurrentTimestamp()
+    } else {
+      getOldTimestamp()
+    }
+    storyProgressController.recordCompletedChapter(
+      profileId,
+      TEST_TOPIC_ID_0,
+      TEST_STORY_ID_0,
+      TEST_EXPLORATION_ID_5,
+      timestamp
+    )
+  }
 }

domain/src/main/java/org/oppia/android/domain/topic/TopicController.kt

@@ -248,11 +248,6 @@ class TopicController @Inject constructor(
       )
     }
 
-    // If there is no completed chapter, it cannot be an ongoing-topic.
-    if (completedChapterProgressList.isEmpty()) {
-      return false
-    }
-
     // If there is at least 1 completed chapter and 1 not-completed chapter, it is definitely an
     // ongoing-topic.
     if (startedChapterProgressList.isNotEmpty()) {