Technical Analytics: Milestone 1 - Add Feature Flag Statuses and Ability To Sync Them to Cache Store

domain/src/main/java/org/oppia/android/domain/platformparameter/PlatformParameterSingletonImpl.kt

@@ -26,6 +26,8 @@ class PlatformParameterSingletonImpl @Inject constructor() : PlatformParameterSi
     return object : PlatformParameterValue<String> {
       override val value: String
         get() = parameter.string
+      override val isSynced: Boolean
+        get() = parameter.isSynced
     }
   }
 
@@ -38,6 +40,8 @@ class PlatformParameterSingletonImpl @Inject constructor() : PlatformParameterSi
     return object : PlatformParameterValue<Int> {
       override val value: Int
         get() = parameter.integer
+      override val isSynced: Boolean
+        get() = parameter.isSynced
     }
   }
 
@@ -50,6 +54,8 @@ class PlatformParameterSingletonImpl @Inject constructor() : PlatformParameterSi
     return object : PlatformParameterValue<Boolean> {
       override val value: Boolean
         get() = parameter.boolean
+      override val isSynced: Boolean
+        get() = parameter.isSynced
     }
   }
 }

domain/src/main/java/org/oppia/android/domain/platformparameter/syncup/PlatformParameterSyncUpWorker.kt

@@ -81,7 +81,7 @@ class PlatformParameterSyncUpWorker private constructor(
    */
   private fun parseNetworkResponse(response: Map<String, Any>): List<PlatformParameter> {
     return response.map {
-      val platformParameter = PlatformParameter.newBuilder().setName(it.key)
+      val platformParameter = PlatformParameter.newBuilder().setName(it.key).setIsSynced(true)
       when (val value = it.value) {
         is String -> platformParameter.string = value
         is Int -> platformParameter.integer = value
@@ -111,6 +111,7 @@ class PlatformParameterSyncUpWorker private constructor(
       if (response != null) {
         val responseBody = checkNotNull(response.body())
         val platformParameterList = parseNetworkResponse(responseBody)
+
         if (platformParameterList.isEmpty()) {
           throw IllegalArgumentException(EMPTY_RESPONSE_EXCEPTION_MSG)
         }

domain/src/test/java/org/oppia/android/domain/audio/AudioPlayerControllerTest.kt

@@ -843,6 +843,7 @@ class AudioPlayerControllerTest {
       val enableFeature = enableLearnerStudyAnalytics
       return object : PlatformParameterValue<Boolean> {
         override val value: Boolean = enableFeature
+        override val isSynced: Boolean = false
       }
     }
 
@@ -854,6 +855,7 @@ class AudioPlayerControllerTest {
       val enableFeature = enableLearnerStudyAnalytics
       return object : PlatformParameterValue<Boolean> {
         override val value: Boolean = enableFeature
+        override val isSynced: Boolean = false
       }
     }
   }

domain/src/test/java/org/oppia/android/domain/platformparameter/syncup/PlatformParameterSyncUpWorkerTest.kt

@@ -95,21 +95,25 @@ class PlatformParameterSyncUpWorkerTest {
   private val expectedTestStringParameter = PlatformParameter.newBuilder()
     .setName(TEST_STRING_PARAM_NAME)
     .setString(TEST_STRING_PARAM_SERVER_VALUE)
+    .setIsSynced(true)
     .build()
 
   private val expectedTestIntegerParameter = PlatformParameter.newBuilder()
     .setName(TEST_INTEGER_PARAM_NAME)
     .setInteger(TEST_INTEGER_PARAM_SERVER_VALUE)
+    .setIsSynced(true)
     .build()
 
   private val defaultTestIntegerParameter = PlatformParameter.newBuilder()
     .setName(TEST_INTEGER_PARAM_NAME)
     .setInteger(TEST_INTEGER_PARAM_DEFAULT_VALUE)
+    .setIsSynced(false)
     .build()
 
   private val expectedTestBooleanParameter = PlatformParameter.newBuilder()
     .setName(TEST_BOOLEAN_PARAM_NAME)
     .setBoolean(TEST_BOOLEAN_PARAM_SERVER_VALUE)
+    .setIsSynced(true)
     .build()
 
   // Not including "expectedTestBooleanParameter" in this list to prove that a refresh took place
@@ -322,6 +326,89 @@ class PlatformParameterSyncUpWorkerTest {
       .containsEntry(TEST_INTEGER_PARAM_NAME, defaultTestIntegerParameter)
   }
 
+  @Test
+  fun testSyncUpWorker_getFeatureFlags_addSyncStatusFlags_verifyCorrectStatusReturned() {
+    // Set up versionName to get correct network response from mock platform parameter service.
+    setUpApplicationForContext(MockPlatformParameterService.appVersionForCorrectResponse)
+
+    // Empty the Platform Parameter Database to simulate the execution of first SyncUp Work request.
+    platformParameterController.updatePlatformParameterDatabase(listOf())
+
+    val workManager = WorkManager.getInstance(context)
+
+    val inputData = Data.Builder().putString(
+      PlatformParameterSyncUpWorker.WORKER_TYPE_KEY,
+      PlatformParameterSyncUpWorker.PLATFORM_PARAMETER_WORKER
+    ).build()
+
+    val request: OneTimeWorkRequest = OneTimeWorkRequestBuilder<PlatformParameterSyncUpWorker>()
+      .setInputData(inputData)
+      .build()
+
+    // Enqueue the Work Request to fetch and cache the Platform Parameters from Remote Service.
+    workManager.enqueue(request)
+    testCoroutineDispatchers.runCurrent()
+
+    val workInfo = workManager.getWorkInfoById(request.id)
+    assertThat(workInfo.get().state).isEqualTo(WorkInfo.State.SUCCEEDED)
+
+    // Retrieve the previously cached Platform Parameters from Cache Store.
+    monitorFactory.ensureDataProviderExecutes(platformParameterController.getParameterDatabase())
+
+    // Values retrieved from Cache store will be sent to Platform Parameter Singleton by the
+    // Controller in the form of a Map, therefore verify the retrieved values from that Map.
+    val platformParameterMap = platformParameterSingleton.getPlatformParameterMap()
+
+    // Previous String Platform Parameter is still same in the Database.
+    assertThat(platformParameterMap)
+      .containsEntry(TEST_STRING_PARAM_NAME, expectedTestStringParameter)
+
+    // Is synced boolean of the platform parameter is true
+    assertThat(platformParameterMap[TEST_STRING_PARAM_NAME]!!.isSynced).isEqualTo(true)
+  }
+
+  @Test
+  fun testSyncUpWorker_databaseNotEmpty_getEmptyResponse_verifySyncStatusNotUpdated() {
+    // Set up versionName to get incorrect network response from mock platform parameter service.
+    setUpApplicationForContext(MockPlatformParameterService.appVersionForEmptyResponse)
+
+    // Fill the Platform Parameter Database with mock values to simulate the execution of a SyncUp
+    // Work request that is not first.
+    platformParameterController.updatePlatformParameterDatabase(mockPlatformParameterList)
+
+    val workManager = WorkManager.getInstance(context)
+
+    val inputData = Data.Builder().putString(
+      PlatformParameterSyncUpWorker.WORKER_TYPE_KEY,
+      PlatformParameterSyncUpWorker.PLATFORM_PARAMETER_WORKER
+    ).build()
+
+    val request: OneTimeWorkRequest = OneTimeWorkRequestBuilder<PlatformParameterSyncUpWorker>()
+      .setInputData(inputData)
+      .build()
+
+    // Enqueue the Work Request to fetch and cache the Platform Parameters from Remote Service.
+    workManager.enqueue(request)
+    testCoroutineDispatchers.runCurrent()
+
+    val workInfo = workManager.getWorkInfoById(request.id)
+    assertThat(workInfo.get().state).isEqualTo(WorkInfo.State.FAILED)
+
+    val exceptionMessage = fakeExceptionLogger.getMostRecentException().message
+    assertThat(exceptionMessage)
+      .isEqualTo(PlatformParameterSyncUpWorker.EMPTY_RESPONSE_EXCEPTION_MSG)
+
+    // Retrieve the previously cached Platform Parameters from Cache Store.
+    monitorFactory.ensureDataProviderExecutes(platformParameterController.getParameterDatabase())
+
+    // Values retrieved from Cache store will be sent to Platform Parameter Singleton by the
+    // Controller in the form of a Map, therefore verify the retrieved values from that Map.
+    val platformParameterMap = platformParameterSingleton.getPlatformParameterMap()
+
+    // Previous integer sync status is still the same in the database
+    assertThat(platformParameterMap[TEST_INTEGER_PARAM_NAME]!!.isSynced).isEqualTo(false)
+  }
+
   private fun setUpTestApplicationComponent() {
     ApplicationProvider.getApplicationContext<TestApplication>().inject(this)
   }

domain/src/test/java/org/oppia/android/domain/profile/ProfileManagementControllerTest.kt

@@ -1358,6 +1358,7 @@ class ProfileManagementControllerTest {
       val enableFeature = enableLearnerStudyAnalytics
       return object : PlatformParameterValue<Boolean> {
         override val value: Boolean = enableFeature
+        override val isSynced: Boolean = true
       }
     }
 
@@ -1369,6 +1370,7 @@ class ProfileManagementControllerTest {
       val enableFeature = enableLearnerStudyAnalytics
       return object : PlatformParameterValue<Boolean> {
         override val value: Boolean = enableFeature
+        override val isSynced: Boolean = true
       }
     }
   }

model/src/main/proto/platform_parameter.proto

@@ -18,6 +18,8 @@ message PlatformParameter {
     // Indicates a string-typed platform parameter.
     string string = 4;
   }
+  // Indicates that the platform parameter is synced
+  bool is_synced = 5;
 }
 
 // Format of platform parameters stored on disk. It closely resembles the JSON response in cache.

scripts/assets/test_file_exemptions.textproto

@@ -798,10 +798,8 @@ exempted_file_path: "testing/src/main/java/org/oppia/android/testing/network/Moc
 exempted_file_path: "testing/src/main/java/org/oppia/android/testing/network/MockSubtopicService.kt"
 exempted_file_path: "testing/src/main/java/org/oppia/android/testing/network/MockTopicService.kt"
 exempted_file_path: "testing/src/main/java/org/oppia/android/testing/network/RetrofitTestModule.kt"
-exempted_file_path: "testing/src/main/java/org/oppia/android/testing/platformparameter/TestBooleanPlatformParameter.kt"
-exempted_file_path: "testing/src/main/java/org/oppia/android/testing/platformparameter/TestIntegerPlatformParameter.kt"
+exempted_file_path: "testing/src/main/java/org/oppia/android/testing/platformparameter/TestPlatformParameterConstants.kt"
 exempted_file_path: "testing/src/main/java/org/oppia/android/testing/platformparameter/TestPlatformParameterModule.kt"
-exempted_file_path: "testing/src/main/java/org/oppia/android/testing/platformparameter/TestStringPlatformParameter.kt"
 exempted_file_path: "testing/src/main/java/org/oppia/android/testing/robolectric/IsOnRobolectric.kt"
 exempted_file_path: "testing/src/main/java/org/oppia/android/testing/robolectric/RobolectricModule.kt"
 exempted_file_path: "testing/src/main/java/org/oppia/android/testing/threading/BackgroundTestDispatcher.kt"
@@ -887,6 +885,7 @@ exempted_file_path: "utility/src/main/java/org/oppia/android/util/parser/svg/Svg
 exempted_file_path: "utility/src/main/java/org/oppia/android/util/parser/svg/SvgDecoder.kt"
 exempted_file_path: "utility/src/main/java/org/oppia/android/util/parser/svg/SvgPictureDrawable.kt"
 exempted_file_path: "utility/src/main/java/org/oppia/android/util/parser/svg/TextSvgDrawableTranscoder.kt"
+exempted_file_path: "utility/src/main/java/org/oppia/android/util/platformparameter/FeatureFlagConstants.kt"
 exempted_file_path: "utility/src/main/java/org/oppia/android/util/platformparameter/PlatformParameterConstants.kt"
 exempted_file_path: "utility/src/main/java/org/oppia/android/util/platformparameter/PlatformParameterValue.kt"
 exempted_file_path: "utility/src/main/java/org/oppia/android/util/statusbar/StatusBarColor.kt"

testing/src/main/java/org/oppia/android/testing/platformparameter/BUILD.bazel

@@ -10,9 +10,7 @@ kt_android_library(
     name = "test_constants",
     testonly = True,
     srcs = [
-        "TestBooleanPlatformParameter.kt",
-        "TestIntegerPlatformParameter.kt",
-        "TestStringPlatformParameter.kt",
+        "TestPlatformParameterConstants.kt",
     ],
     visibility = [
         "//:oppia_testing_visibility",

testing/src/main/java/org/oppia/android/testing/platformparameter/TestPlatformParameterConstants.kt

@@ -0,0 +1,68 @@
+package org.oppia.android.testing.platformparameter
+
+import javax.inject.Qualifier
+
+/**
+ * Qualifier for test string platform parameter. Only used in tests related to platform parameter.
+ */
+@Qualifier
+annotation class TestStringParam
+
+/**
+ * Name for the test string platform parameter. Only used in tests related to platform parameter.
+ */
+const val TEST_STRING_PARAM_NAME = "test_string_param_name"
+
+/**
+ * Default value for the test string platform parameter. Only used in tests related to platform
+ * parameter.
+ */
+const val TEST_STRING_PARAM_DEFAULT_VALUE = "test_string_param_default_value"
+
+/**
+ * Server value for the test string platform parameter. Only used in tests related to platform
+ * parameter.
+ */
+const val TEST_STRING_PARAM_SERVER_VALUE = "test_string_param_value"
+
+/**
+ * Qualifier for test boolean platform parameter. Only used in tests related to platform parameter.
+ */
+@Qualifier
+annotation class TestBooleanParam
+
+/**
+ * Name for the test boolean platform parameter. Only used in tests related to platform parameter.
+ */
+const val TEST_BOOLEAN_PARAM_NAME = "test_boolean_param_name"
+
+/**
+ * Default value for the test boolean platform parameter. Only used in tests related to platform parameter.
+ */
+const val TEST_BOOLEAN_PARAM_DEFAULT_VALUE = false
+
+/**
+ * Server value for the test boolean platform parameter. Only used in tests related to platform parameter.
+ */
+const val TEST_BOOLEAN_PARAM_SERVER_VALUE = true
+
+/**
+ * Qualifier for test integer platform parameter. Only used in tests related to platform parameter.
+ */
+@Qualifier
+annotation class TestIntegerParam
+
+/**
+ * Name for the test integer platform parameter. Only used in tests related to platform parameter.
+ */
+const val TEST_INTEGER_PARAM_NAME = "test_integer_param_name"
+
+/**
+ * Default value for the test integer platform parameter. Only used in tests related to platform parameter.
+ */
+const val TEST_INTEGER_PARAM_DEFAULT_VALUE = 0
+
+/**
+ * Server value for the test integer platform parameter. Only used in tests related to platform parameter.
+ */
+const val TEST_INTEGER_PARAM_SERVER_VALUE = 1