Fixes part of #1433: Including Console Logger into Oppia Logger (#3104)

* Using OppiaLogger as the central logging tool * Fixing Lint Issues * nit change * Included tests for Console Logger Methods * Suggested Changes
oppia · May 13, 2021 · 56537c6 · 56537c6
1 parent 7a2cede
commit 56537c6
Show file tree

Hide file tree

Showing 57 changed files with 404 additions and 214 deletions.
diff --git a/...c/main/java/org/oppia/android/app/administratorcontrols/AdministratorControlsViewModel.kt b/...c/main/java/org/oppia/android/app/administratorcontrols/AdministratorControlsViewModel.kt
@@ -15,19 +15,21 @@ import org.oppia.android.app.administratorcontrols.administratorcontrolsitemview
 import org.oppia.android.app.fragment.FragmentScope
 import org.oppia.android.app.model.DeviceSettings
 import org.oppia.android.app.model.ProfileId
+import org.oppia.android.app.shim.IntentFactoryShim
+import org.oppia.android.domain.oppialogger.OppiaLogger
 import org.oppia.android.domain.profile.ProfileManagementController
 import org.oppia.android.util.data.AsyncResult
 import org.oppia.android.util.data.DataProviders.Companion.toLiveData
-import org.oppia.android.util.logging.ConsoleLogger
 import javax.inject.Inject
 
 /** [ViewModel] for [AdministratorControlsFragment]. */
 @FragmentScope
 class AdministratorControlsViewModel @Inject constructor(
   private val activity: AppCompatActivity,
   private val fragment: Fragment,
-  private val logger: ConsoleLogger,
-  private val profileManagementController: ProfileManagementController
+  private val oppiaLogger: OppiaLogger,
+  private val profileManagementController: ProfileManagementController,
+  private val IntentFactoryShim: IntentFactoryShim
 ) {
   private val routeToProfileListListener = activity as RouteToProfileListListener
   private val loadProfileListListener = activity as LoadProfileListListener
@@ -50,7 +52,7 @@ class AdministratorControlsViewModel @Inject constructor(
     deviceSettingsResult: AsyncResult<DeviceSettings>
   ): DeviceSettings {
     if (deviceSettingsResult.isFailure()) {
-      logger.e(
+      oppiaLogger.e(
         "AdministratorControlsFragment",
         "Failed to retrieve profile",
         deviceSettingsResult.getErrorOrNull()!!
@@ -74,7 +76,7 @@ class AdministratorControlsViewModel @Inject constructor(
     itemViewModelList.add(
       AdministratorControlsDownloadPermissionsViewModel(
         fragment,
-        logger,
+        oppiaLogger,
         profileManagementController,
         userProfileId,
         deviceSettings

diff --git a/...s/administratorcontrolsitemviewmodel/AdministratorControlsDownloadPermissionsViewModel.kt b/...s/administratorcontrolsitemviewmodel/AdministratorControlsDownloadPermissionsViewModel.kt
@@ -5,14 +5,14 @@ import androidx.fragment.app.Fragment
 import androidx.lifecycle.Observer
 import org.oppia.android.app.model.DeviceSettings
 import org.oppia.android.app.model.ProfileId
+import org.oppia.android.domain.oppialogger.OppiaLogger
 import org.oppia.android.domain.profile.ProfileManagementController
 import org.oppia.android.util.data.DataProviders.Companion.toLiveData
-import org.oppia.android.util.logging.ConsoleLogger
 
 /** [ViewModel] for the recycler view in [AdministratorControlsFragment]. */
 class AdministratorControlsDownloadPermissionsViewModel(
   private val fragment: Fragment,
-  private val logger: ConsoleLogger,
+  private val oppiaLogger: OppiaLogger,
   private val profileManagementController: ProfileManagementController,
   private val userProfileId: ProfileId,
   deviceSettings: DeviceSettings
@@ -30,7 +30,7 @@ class AdministratorControlsDownloadPermissionsViewModel(
         fragment,
         Observer {
           if (it.isFailure()) {
-            logger.e(
+            oppiaLogger.e(
               "AdministratorControlsFragment",
               "Failed to update topic update on wifi permission",
               it.getErrorOrNull()!!
@@ -48,7 +48,7 @@ class AdministratorControlsDownloadPermissionsViewModel(
       fragment,
       Observer {
         if (it.isFailure()) {
-          logger.e(
+          oppiaLogger.e(
             "AdministratorControlsFragment",
             "Failed to update topic auto update permission",
             it.getErrorOrNull()!!

diff --git a/app/src/main/java/org/oppia/android/app/completedstorylist/CompletedStoryListViewModel.kt b/app/src/main/java/org/oppia/android/app/completedstorylist/CompletedStoryListViewModel.kt
@@ -8,10 +8,10 @@ import org.oppia.android.app.model.CompletedStoryList
 import org.oppia.android.app.model.ProfileId
 import org.oppia.android.app.shim.IntentFactoryShim
 import org.oppia.android.app.viewmodel.ObservableViewModel
+import org.oppia.android.domain.oppialogger.OppiaLogger
 import org.oppia.android.domain.topic.TopicController
 import org.oppia.android.util.data.AsyncResult
 import org.oppia.android.util.data.DataProviders.Companion.toLiveData
-import org.oppia.android.util.logging.ConsoleLogger
 import org.oppia.android.util.parser.html.StoryHtmlParserEntityType
 import javax.inject.Inject
 
@@ -21,7 +21,7 @@ class CompletedStoryListViewModel @Inject constructor(
   private val activity: AppCompatActivity,
   private val intentFactoryShim: IntentFactoryShim,
   private val topicController: TopicController,
-  private val logger: ConsoleLogger,
+  private val oppiaLogger: OppiaLogger,
   @StoryHtmlParserEntityType private val entityType: String
 ) : ObservableViewModel() {
   /** [internalProfileId] needs to be set before any of the live data members can be accessed. */
@@ -49,7 +49,7 @@ class CompletedStoryListViewModel @Inject constructor(
     completedStoryListResult: AsyncResult<CompletedStoryList>
   ): CompletedStoryList {
     if (completedStoryListResult.isFailure()) {
-      logger.e(
+      oppiaLogger.e(
         "CompletedStoryListFragment",
         "Failed to retrieve CompletedStory list: ",
         completedStoryListResult.getErrorOrNull()!!

diff --git a/app/src/main/java/org/oppia/android/app/customview/LessonThumbnailImageView.kt b/app/src/main/java/org/oppia/android/app/customview/LessonThumbnailImageView.kt
@@ -9,8 +9,8 @@ import org.oppia.android.R
 import org.oppia.android.app.model.LessonThumbnail
 import org.oppia.android.app.model.LessonThumbnailGraphic
 import org.oppia.android.app.shim.ViewComponentFactory
+import org.oppia.android.domain.oppialogger.OppiaLogger
 import org.oppia.android.util.gcsresource.DefaultResourceBucketName
-import org.oppia.android.util.logging.ConsoleLogger
 import org.oppia.android.util.parser.image.DefaultGcsPrefix
 import org.oppia.android.util.parser.image.ImageLoader
 import org.oppia.android.util.parser.image.ImageTransformation
@@ -49,7 +49,7 @@ class LessonThumbnailImageView @JvmOverloads constructor(
   lateinit var gcsPrefix: String
 
   @Inject
-  lateinit var logger: ConsoleLogger
+  lateinit var oppiaLogger: OppiaLogger
 
   fun setEntityId(entityId: String) {
     this.entityId = entityId
@@ -78,7 +78,7 @@ class LessonThumbnailImageView @JvmOverloads constructor(
       ::resourceBucketName.isInitialized &&
       ::gcsPrefix.isInitialized &&
       ::imageLoader.isInitialized &&
-      ::logger.isInitialized
+      ::oppiaLogger.isInitialized
     ) {
       loadLessonThumbnail()
     }
@@ -127,8 +127,8 @@ class LessonThumbnailImageView @JvmOverloads constructor(
         .createViewComponent(this).inject(this)
       checkIfLoadingIsPossible()
     } catch (e: IllegalStateException) {
-      if (::logger.isInitialized)
-        logger.e(
+      if (::oppiaLogger.isInitialized)
+        oppiaLogger.e(
           "LessonThumbnailImageView",
           "Throws exception on attach to window",
           e

diff --git a/app/src/main/java/org/oppia/android/app/drawer/NavigationDrawerFragmentPresenter.kt b/app/src/main/java/org/oppia/android/app/drawer/NavigationDrawerFragmentPresenter.kt
@@ -32,11 +32,11 @@ import org.oppia.android.app.topic.TopicActivity
 import org.oppia.android.app.viewmodel.ViewModelProvider
 import org.oppia.android.databinding.DrawerFragmentBinding
 import org.oppia.android.databinding.NavHeaderNavigationDrawerBinding
+import org.oppia.android.domain.oppialogger.OppiaLogger
 import org.oppia.android.domain.profile.ProfileManagementController
 import org.oppia.android.domain.topic.TopicController
 import org.oppia.android.util.data.AsyncResult
 import org.oppia.android.util.data.DataProviders.Companion.toLiveData
-import org.oppia.android.util.logging.ConsoleLogger
 import org.oppia.android.util.statusbar.StatusBarColor
 import javax.inject.Inject
 
@@ -50,7 +50,7 @@ class NavigationDrawerFragmentPresenter @Inject constructor(
   private val fragment: Fragment,
   private val profileManagementController: ProfileManagementController,
   private val topicController: TopicController,
-  private val logger: ConsoleLogger,
+  private val oppiaLogger: OppiaLogger,
   private val headerViewModelProvider: ViewModelProvider<NavigationDrawerHeaderViewModel>,
   private val footerViewModelProvider: ViewModelProvider<NavigationDrawerFooterViewModel>
 ) : NavigationView.OnNavigationItemSelectedListener {
@@ -131,7 +131,7 @@ class NavigationDrawerFragmentPresenter @Inject constructor(
 
   private fun processGetProfileResult(profileResult: AsyncResult<Profile>): Profile {
     if (profileResult.isFailure()) {
-      logger.e(
+      oppiaLogger.e(
         "NavigationDrawerFragment",
         "Failed to retrieve profile",
         profileResult.getErrorOrNull()!!
@@ -160,7 +160,7 @@ class NavigationDrawerFragmentPresenter @Inject constructor(
     completedStoryListResult: AsyncResult<CompletedStoryList>
   ): CompletedStoryList {
     if (completedStoryListResult.isFailure()) {
-      logger.e(
+      oppiaLogger.e(
         "NavigationDrawerFragment",
         "Failed to retrieve completed story list",
         completedStoryListResult.getErrorOrNull()!!
@@ -189,7 +189,7 @@ class NavigationDrawerFragmentPresenter @Inject constructor(
     ongoingTopicListResult: AsyncResult<OngoingTopicList>
   ): OngoingTopicList {
     if (ongoingTopicListResult.isFailure()) {
-      logger.e(
+      oppiaLogger.e(
         "NavigationDrawerFragment",
         "Failed to retrieve ongoing topic list",
         ongoingTopicListResult.getErrorOrNull()!!

diff --git a/app/src/main/java/org/oppia/android/app/home/HomeFragmentPresenter.kt b/app/src/main/java/org/oppia/android/app/home/HomeFragmentPresenter.kt
@@ -25,7 +25,6 @@ import org.oppia.android.databinding.WelcomeBinding
 import org.oppia.android.domain.oppialogger.OppiaLogger
 import org.oppia.android.domain.profile.ProfileManagementController
 import org.oppia.android.domain.topic.TopicListController
-import org.oppia.android.util.logging.ConsoleLogger
 import org.oppia.android.util.parser.html.StoryHtmlParserEntityType
 import org.oppia.android.util.parser.html.TopicHtmlParserEntityType
 import org.oppia.android.util.system.OppiaClock
@@ -39,7 +38,6 @@ class HomeFragmentPresenter @Inject constructor(
   private val profileManagementController: ProfileManagementController,
   private val topicListController: TopicListController,
   private val oppiaClock: OppiaClock,
-  private val logger: ConsoleLogger,
   private val oppiaLogger: OppiaLogger,
   @TopicHtmlParserEntityType private val topicEntityType: String,
   @StoryHtmlParserEntityType private val storyEntityType: String
@@ -60,7 +58,7 @@ class HomeFragmentPresenter @Inject constructor(
       activity,
       fragment,
       oppiaClock,
-      logger,
+      oppiaLogger,
       internalProfileId,
       profileManagementController,
       topicListController,

diff --git a/app/src/main/java/org/oppia/android/app/home/HomeViewModel.kt b/app/src/main/java/org/oppia/android/app/home/HomeViewModel.kt
@@ -21,12 +21,12 @@ import org.oppia.android.app.model.PromotedActivityList
 import org.oppia.android.app.model.PromotedStoryList
 import org.oppia.android.app.model.TopicList
 import org.oppia.android.app.viewmodel.ObservableViewModel
+import org.oppia.android.domain.oppialogger.OppiaLogger
 import org.oppia.android.domain.profile.ProfileManagementController
 import org.oppia.android.domain.topic.TopicListController
 import org.oppia.android.util.data.DataProvider
 import org.oppia.android.util.data.DataProviders.Companion.combineWith
 import org.oppia.android.util.data.DataProviders.Companion.toLiveData
-import org.oppia.android.util.logging.ConsoleLogger
 import org.oppia.android.util.parser.html.StoryHtmlParserEntityType
 import org.oppia.android.util.parser.html.TopicHtmlParserEntityType
 import org.oppia.android.util.system.OppiaClock
@@ -42,7 +42,7 @@ class HomeViewModel(
   private val activity: AppCompatActivity,
   private val fragment: Fragment,
   private val oppiaClock: OppiaClock,
-  private val logger: ConsoleLogger,
+  private val oppiaLogger: OppiaLogger,
   private val internalProfileId: Int,
   private val profileManagementController: ProfileManagementController,
   private val topicListController: TopicListController,
@@ -95,7 +95,7 @@ class HomeViewModel(
   val homeItemViewModelListLiveData: LiveData<List<HomeItemViewModel>> by lazy {
     Transformations.map(homeItemViewModelListDataProvider.toLiveData()) { itemListResult ->
       if (itemListResult.isFailure()) {
-        logger.e(
+        oppiaLogger.e(
           "HomeFragment",
           "No home fragment available -- failed to retrieve fragment data.",
           itemListResult.getErrorOrNull()

diff --git a/app/src/main/java/org/oppia/android/app/home/promotedlist/ComingSoonTopicsListView.kt b/app/src/main/java/org/oppia/android/app/home/promotedlist/ComingSoonTopicsListView.kt
@@ -10,7 +10,7 @@ import org.oppia.android.app.recyclerview.BindableAdapter
 import org.oppia.android.app.recyclerview.StartSnapHelper
 import org.oppia.android.app.shim.ViewBindingShim
 import org.oppia.android.app.shim.ViewComponentFactory
-import org.oppia.android.util.logging.ConsoleLogger
+import org.oppia.android.domain.oppialogger.OppiaLogger
 import javax.inject.Inject
 
 private const val COMING_SOON_TOPIC_LIST_VIEW_TAG = "ComingSoonTopicsListView"
@@ -29,7 +29,7 @@ class ComingSoonTopicsListView @JvmOverloads constructor(
   lateinit var bindingInterface: ViewBindingShim
 
   @Inject
-  lateinit var logger: ConsoleLogger
+  lateinit var oppiaLogger: OppiaLogger
 
   override fun onAttachedToWindow() {
     super.onAttachedToWindow()
@@ -60,7 +60,7 @@ class ComingSoonTopicsListView @JvmOverloads constructor(
       adapter = createAdapter()
     }
     if (newDataList == null) {
-      logger.w(COMING_SOON_TOPIC_LIST_VIEW_TAG, "Failed to resolve upcoming topic list data")
+      oppiaLogger.w(COMING_SOON_TOPIC_LIST_VIEW_TAG, "Failed to resolve upcoming topic list data")
     } else {
       (adapter as BindableAdapter<*>).setDataUnchecked(newDataList)
     }

diff --git a/app/src/main/java/org/oppia/android/app/home/promotedlist/PromotedStoryListView.kt b/app/src/main/java/org/oppia/android/app/home/promotedlist/PromotedStoryListView.kt
@@ -10,7 +10,7 @@ import org.oppia.android.app.recyclerview.BindableAdapter
 import org.oppia.android.app.recyclerview.StartSnapHelper
 import org.oppia.android.app.shim.ViewBindingShim
 import org.oppia.android.app.shim.ViewComponentFactory
-import org.oppia.android.util.logging.ConsoleLogger
+import org.oppia.android.domain.oppialogger.OppiaLogger
 import javax.inject.Inject
 
 private const val PROMOTED_STORY_LIST_VIEW_TAG = "PromotedStoryListView"
@@ -29,7 +29,7 @@ class PromotedStoryListView @JvmOverloads constructor(
   lateinit var bindingInterface: ViewBindingShim
 
   @Inject
-  lateinit var logger: ConsoleLogger
+  lateinit var oppiaLogger: OppiaLogger
 
   override fun onAttachedToWindow() {
     super.onAttachedToWindow()
@@ -60,7 +60,7 @@ class PromotedStoryListView @JvmOverloads constructor(
       adapter = createAdapter()
     }
     if (newDataList == null) {
-      logger.w(PROMOTED_STORY_LIST_VIEW_TAG, "Failed to resolve new story list data")
+      oppiaLogger.w(PROMOTED_STORY_LIST_VIEW_TAG, "Failed to resolve new story list data")
     } else {
       (adapter as BindableAdapter<*>).setDataUnchecked(newDataList)
     }

diff --git a/...rc/main/java/org/oppia/android/app/home/recentlyplayed/RecentlyPlayedFragmentPresenter.kt b/...rc/main/java/org/oppia/android/app/home/recentlyplayed/RecentlyPlayedFragmentPresenter.kt
@@ -18,10 +18,10 @@ import org.oppia.android.app.model.PromotedActivityList
 import org.oppia.android.app.model.PromotedStory
 import org.oppia.android.databinding.RecentlyPlayedFragmentBinding
 import org.oppia.android.domain.exploration.ExplorationDataController
+import org.oppia.android.domain.oppialogger.OppiaLogger
 import org.oppia.android.domain.topic.TopicListController
 import org.oppia.android.util.data.AsyncResult
 import org.oppia.android.util.data.DataProviders.Companion.toLiveData
-import org.oppia.android.util.logging.ConsoleLogger
 import org.oppia.android.util.parser.html.StoryHtmlParserEntityType
 import javax.inject.Inject
 
@@ -30,7 +30,7 @@ import javax.inject.Inject
 class RecentlyPlayedFragmentPresenter @Inject constructor(
   private val activity: AppCompatActivity,
   private val fragment: Fragment,
-  private val logger: ConsoleLogger,
+  private val oppiaLogger: OppiaLogger,
   private val explorationDataController: ExplorationDataController,
   private val topicListController: TopicListController,
   @StoryHtmlParserEntityType private val entityType: String
@@ -223,14 +223,14 @@ class RecentlyPlayedFragmentPresenter @Inject constructor(
       fragment,
       Observer<AsyncResult<Any?>> { result ->
         when {
-          result.isPending() -> logger.d("RecentlyPlayedFragment", "Loading exploration")
-          result.isFailure() -> logger.e(
+          result.isPending() -> oppiaLogger.d("RecentlyPlayedFragment", "Loading exploration")
+          result.isFailure() -> oppiaLogger.e(
             "RecentlyPlayedFragment",
             "Failed to load exploration",
             result.getErrorOrNull()!!
           )
           else -> {
-            logger.d("RecentlyPlayedFragment", "Successfully loaded exploration")
+            oppiaLogger.d("RecentlyPlayedFragment", "Successfully loaded exploration")
             routeToExplorationListener.routeToExploration(
               internalProfileId,
               topicId,

diff --git a/app/src/main/java/org/oppia/android/app/ongoingtopiclist/OngoingTopicListViewModel.kt b/app/src/main/java/org/oppia/android/app/ongoingtopiclist/OngoingTopicListViewModel.kt
@@ -8,10 +8,10 @@ import org.oppia.android.app.model.OngoingTopicList
 import org.oppia.android.app.model.ProfileId
 import org.oppia.android.app.shim.IntentFactoryShim
 import org.oppia.android.app.viewmodel.ObservableViewModel
+import org.oppia.android.domain.oppialogger.OppiaLogger
 import org.oppia.android.domain.topic.TopicController
 import org.oppia.android.util.data.AsyncResult
 import org.oppia.android.util.data.DataProviders.Companion.toLiveData
-import org.oppia.android.util.logging.ConsoleLogger
 import org.oppia.android.util.parser.html.TopicHtmlParserEntityType
 import javax.inject.Inject
 
@@ -20,7 +20,7 @@ import javax.inject.Inject
 class OngoingTopicListViewModel @Inject constructor(
   private val activity: AppCompatActivity,
   private val topicController: TopicController,
-  private val logger: ConsoleLogger,
+  private val oppiaLogger: OppiaLogger,
   private val intentFactoryShim: IntentFactoryShim,
   @TopicHtmlParserEntityType private val entityType: String
 ) : ObservableViewModel() {
@@ -49,7 +49,7 @@ class OngoingTopicListViewModel @Inject constructor(
     ongoingTopicListResult: AsyncResult<OngoingTopicList>
   ): OngoingTopicList {
     if (ongoingTopicListResult.isFailure()) {
-      logger.e(
+      oppiaLogger.e(
         "OngoingTopicListFragment",
         "Failed to retrieve OngoingTopicList: ",
         ongoingTopicListResult.getErrorOrNull()!!