[BM-667] Feedback - baby device side

app/src/main/kotlin/co/netguru/baby/monitor/client/application/di/SharedPreferencesModule.kt

@@ -17,10 +17,19 @@ class SharedPreferencesModule {
     fun provideConfigurationSharedPreferences(app: App): SharedPreferences =
         app.getSharedPreferences(app.packageName + CONFIGURATION_PREFERENCES, Context.MODE_PRIVATE)
 
+    @FeedbackPreferencesQualifier
+    @Singleton
+    @Provides
+    fun provideFeedbackSharedPreferences(app: App): SharedPreferences =
+        app.getSharedPreferences(app.packageName + FEEDBACK_PREFERENCES, Context.MODE_PRIVATE)
+
     companion object {
         private const val CONFIGURATION_PREFERENCES = "configuration"
+        private const val FEEDBACK_PREFERENCES = "feedback"
     }
 }
 
 @Qualifier
 annotation class ConfigurationPreferencesQualifier
+@Qualifier
+annotation class FeedbackPreferencesQualifier

app/src/main/kotlin/co/netguru/baby/monitor/client/application/firebase/FirebaseRepository.kt

@@ -5,7 +5,7 @@ import android.net.Uri
 import co.netguru.baby.monitor.client.R
 import co.netguru.baby.monitor.client.application.App
 import co.netguru.baby.monitor.client.common.RunsInBackground
-import co.netguru.baby.monitor.client.feature.voiceAnalysis.WavFileGenerator
+import co.netguru.baby.monitor.client.feature.recording.RecordingFileController
 import com.google.firebase.FirebaseApp
 import com.google.firebase.storage.FirebaseStorage
 import com.google.firebase.storage.StorageMetadata
@@ -24,7 +24,8 @@ class FirebaseRepository(
     private val context: Context
 ) {
     private var storageRef: StorageReference? = null
-    private val directory = context.getDir(WavFileGenerator.DIRECTORY_NAME, Context.MODE_PRIVATE)
+    private val directory = context.getDir(RecordingFileController.UPLOAD_RECORDINGS_DIRECTORY,
+        Context.MODE_PRIVATE)
     internal val compositeDisposable = CompositeDisposable()
 
     fun initializeApp(app: App) {
@@ -54,7 +55,7 @@ class FirebaseRepository(
         }
     }
 
-    internal fun isUploadEnablad() = preferencesWrapper.isUploadEnablad()
+    internal fun isUploadEnabled() = preferencesWrapper.isUploadEnabled()
 
     internal fun setUploadEnabled(enable: Boolean) {
         preferencesWrapper.setUploadEnabled(enable)
@@ -63,7 +64,7 @@ class FirebaseRepository(
 
     @RunsInBackground
     internal fun continueUploadingAfterProcessRestartIfNeeded() {
-        if (!preferencesWrapper.isUploadEnablad()) {
+        if (!preferencesWrapper.isUploadEnabled()) {
             return
         }
         if (!preferencesWrapper.isFirebaseSessionResumable()) {

app/src/main/kotlin/co/netguru/baby/monitor/client/application/firebase/FirebaseSharedPreferencesWrapper.kt

@@ -37,7 +37,7 @@ class FirebaseSharedPreferencesWrapper @Inject constructor(
                 getFileUriString() == null
     }
 
-    fun isUploadEnablad() = preferences.getBoolean(
+    fun isUploadEnabled() = preferences.getBoolean(
             FIREBASE_UPLOAD_ENABLED,
             false
     )

app/src/main/kotlin/co/netguru/baby/monitor/client/common/TimestampProvider.kt

@@ -0,0 +1,7 @@
+package co.netguru.baby.monitor.client.common
+
+import javax.inject.Inject
+
+class TimestampProvider @Inject constructor() {
+    fun timestamp() = System.currentTimeMillis()
+}

app/src/main/kotlin/co/netguru/baby/monitor/client/feature/babynotification/BabyMonitorMessagingService.kt

@@ -47,6 +47,11 @@ class BabyMonitorMessagingService : FirebaseMessagingService() {
                 message.data
             )
             NotificationType.LOW_BATTERY_NOTIFICATION -> handleLowBatteryNotification(message.data)
+            NotificationType.CRY_NOTIFICATION_WITH_FEEDBACK_REQUEST,
+            NotificationType.NOISE_NOTIFICATION_WITH_FEEDBACK_REQUEST -> {
+                // TODO handle notification with feedback request
+                handleBabyEvent(message.data)
+            }
             else -> {
                 message.notification?.let {
                     handleRemoteNotification(

app/src/main/kotlin/co/netguru/baby/monitor/client/feature/babynotification/NotifyBabyEventUseCase.kt

@@ -1,6 +1,8 @@
 package co.netguru.baby.monitor.client.feature.babynotification
 
+import co.netguru.baby.monitor.client.feature.feedback.SavedRecordingDetails
 import co.netguru.baby.monitor.client.feature.firebasenotification.FirebaseNotificationSender
+import co.netguru.baby.monitor.client.feature.firebasenotification.NotificationData
 import co.netguru.baby.monitor.client.feature.firebasenotification.NotificationType
 import io.reactivex.Completable
 import io.reactivex.schedulers.Schedulers
@@ -15,14 +17,30 @@ class NotifyBabyEventUseCase(
     private val babyEvents: PublishSubject<BabyEvent> = PublishSubject.create()
 
     private fun fetchClientsAndPostNotification(babyEvent: BabyEvent): Completable {
-        val (notificationTitle, notificationType) = when (babyEvent) {
-            BabyEvent.BabyCrying -> notificationTexts[CRY_TITLE_KEY] to NotificationType.CRY_NOTIFICATION
-            BabyEvent.NoiseDetected -> notificationTexts[NOISE_TITLE_KEY] to NotificationType.NOISE_NOTIFICATION
+        val notificationTitle = when (babyEvent) {
+            BabyEvent.BabyCrying, is BabyEvent.BabyCryingFeedback
+            -> notificationTexts[CRY_TITLE_KEY]
+            BabyEvent.NoiseDetected, is BabyEvent.NoiseDetectedFeedback
+            -> notificationTexts[NOISE_TITLE_KEY]
+        }
+        val notificationType = when (babyEvent) {
+            BabyEvent.BabyCrying -> NotificationType.CRY_NOTIFICATION
+            BabyEvent.NoiseDetected -> NotificationType.NOISE_NOTIFICATION
+            is BabyEvent.BabyCryingFeedback -> NotificationType.CRY_NOTIFICATION_WITH_FEEDBACK_REQUEST
+            is BabyEvent.NoiseDetectedFeedback -> NotificationType.NOISE_NOTIFICATION_WITH_FEEDBACK_REQUEST
+        }
+        val feedbackRecordingFile = when (babyEvent) {
+            is BabyEvent.BabyCryingFeedback -> babyEvent.recordingName
+            is BabyEvent.NoiseDetectedFeedback -> babyEvent.recordingName
+            else -> ""
         }
         return notificationSender.broadcastNotificationToFcm(
-            notificationTitle ?: error("Notification title missing"),
-            notificationTexts[NOTIFICATION_TEXT_KEY] ?: error("Notification text missing"),
-            notificationType
+            NotificationData(
+                notificationTitle ?: error("Notification title missing"),
+                notificationTexts[NOTIFICATION_TEXT_KEY] ?: error("Notification text missing"),
+                notificationType,
+                feedbackRecordingFile
+            )
         )
     }
 
@@ -37,15 +55,33 @@ class NotifyBabyEventUseCase(
             .retry()
     }
 
-    fun notifyBabyCrying() =
-        babyEvents.onNext(BabyEvent.BabyCrying)
+    fun notifyBabyCrying(savedRecordingDetails: SavedRecordingDetails? = null) {
+        val babyEvent = savedRecordingDetails?.let {
+            if (it.shouldAskForFeedback) {
+                BabyEvent.BabyCryingFeedback(it.fileName)
+            } else {
+                null
+            }
+        } ?: BabyEvent.BabyCrying
+        babyEvents.onNext(babyEvent)
+    }
 
-    fun notifyNoiseDetected() =
-        babyEvents.onNext(BabyEvent.NoiseDetected)
+    fun notifyNoiseDetected(savedRecordingDetails: SavedRecordingDetails? = null) {
+        val noiseEvent = savedRecordingDetails?.let {
+            if (it.shouldAskForFeedback) {
+                BabyEvent.NoiseDetectedFeedback(it.fileName)
+            } else {
+                null
+            }
+        } ?: BabyEvent.NoiseDetected
+        babyEvents.onNext(noiseEvent)
+    }
 
     private sealed class BabyEvent {
         object BabyCrying : BabyEvent()
         object NoiseDetected : BabyEvent()
+        data class BabyCryingFeedback(val recordingName: String) : BabyEvent()
+        data class NoiseDetectedFeedback(val recordingName: String) : BabyEvent()
     }
 
     companion object {

app/src/main/kotlin/co/netguru/baby/monitor/client/feature/batterylevel/NotifyLowBatteryUseCase.kt

@@ -1,6 +1,7 @@
 package co.netguru.baby.monitor.client.feature.batterylevel
 
 import co.netguru.baby.monitor.client.feature.firebasenotification.FirebaseNotificationSender
+import co.netguru.baby.monitor.client.feature.firebasenotification.NotificationData
 import co.netguru.baby.monitor.client.feature.firebasenotification.NotificationType
 import timber.log.Timber
 import javax.inject.Inject
@@ -10,9 +11,11 @@ class NotifyLowBatteryUseCase @Inject constructor(
 ) {
     fun notifyLowBattery(title: String, text: String) =
         notificationSender.broadcastNotificationToFcm(
-            title = title,
-            text = text,
-            notificationType = NotificationType.LOW_BATTERY_NOTIFICATION
+            notificationData = NotificationData(
+                title,
+                text,
+                NotificationType.LOW_BATTERY_NOTIFICATION
+            )
         ).also {
             Timber.d("notifyLowBattery($title, $text)")
         }

app/src/main/kotlin/co/netguru/baby/monitor/client/feature/feedback/FeedbackController.kt

@@ -0,0 +1,43 @@
+package co.netguru.baby.monitor.client.feature.feedback
+
+import co.netguru.baby.monitor.client.application.firebase.FirebaseSharedPreferencesWrapper
+import co.netguru.baby.monitor.client.feature.machinelearning.MachineLearning
+import co.netguru.baby.monitor.client.feature.recording.RecordingFileController
+import io.reactivex.Single
+import javax.inject.Inject
+
+class FeedbackController @Inject constructor(
+    private val feedbackFrequencyUseCase: FeedbackFrequencyUseCase,
+    private val firebaseSharedPreferencesWrapper: FirebaseSharedPreferencesWrapper,
+    private val recordingFileController: RecordingFileController
+) {
+    fun handleRecording(
+        recordingData: ByteArray,
+        fromMachineLearning: Boolean
+    ): Single<SavedRecordingDetails> {
+        return if (userEnabledRecordingUpload()) {
+            when {
+                feedbackFrequencyUseCase.shouldAskForFeedback() -> {
+                    recordingFileController.saveRecording(recordingData)
+                        .map { SavedRecordingDetails(it, true) }
+                }
+                fromMachineLearning -> {
+                    recordingFileController.saveRecording(recordingData)
+                        .map { SavedRecordingDetails(it) }
+                }
+                else -> {
+                    Single.just(SavedRecordingDetails(RECORDING_NOT_SAVED))
+                }
+            }
+        } else {
+            Single.just(SavedRecordingDetails(RECORDING_NOT_SAVED))
+        }
+    }
+
+    private fun userEnabledRecordingUpload() = firebaseSharedPreferencesWrapper.isUploadEnabled()
+
+    companion object {
+        const val DATA_SIZE = MachineLearning.DATA_SIZE
+        const val RECORDING_NOT_SAVED = ""
+    }
+}

app/src/main/kotlin/co/netguru/baby/monitor/client/feature/feedback/FeedbackFrequencyUseCase.kt

@@ -0,0 +1,61 @@
+package co.netguru.baby.monitor.client.feature.feedback
+
+import android.content.SharedPreferences
+import co.netguru.baby.monitor.client.application.di.FeedbackPreferencesQualifier
+import co.netguru.baby.monitor.client.common.TimestampProvider
+import co.netguru.baby.monitor.client.common.extensions.edit
+import java.util.concurrent.TimeUnit
+import javax.inject.Inject
+
+class FeedbackFrequencyUseCase @Inject constructor(
+    @FeedbackPreferencesQualifier
+    private val sharedPreferences: SharedPreferences,
+    private val timestampProvider: TimestampProvider
+) {
+    fun shouldAskForFeedback(): Boolean {
+        val currentCounter = sharedPreferences.getInt(NOTIFICATION_COUNTER_KEY, 0)
+        val lastFeedbackTimestamp = sharedPreferences.getLong(FEEDBACK_TIMESTAMP_KEY, 0)
+        return enoughTimePassed(lastFeedbackTimestamp) && currentCounter > NO_FEEDBACK_COUNTER_LIMIT
+    }
+
+    fun notificationSent() {
+        incrementCounter()
+    }
+
+    fun feedbackRequestSent() {
+        updateTimestamp()
+        clearNotificationCounter()
+    }
+
+    private fun enoughTimePassed(lastFeedbackTimestamp: Long) =
+        timestampProvider.timestamp() > lastFeedbackTimestamp + TimeUnit.HOURS.toMillis(
+            NO_FEEDBACK_REQUEST_HOURS
+        )
+
+    private fun updateTimestamp() {
+        sharedPreferences.edit {
+            putLong(FEEDBACK_TIMESTAMP_KEY, timestampProvider.timestamp())
+        }
+    }
+
+    private fun clearNotificationCounter() {
+        sharedPreferences.edit {
+            putInt(NOTIFICATION_COUNTER_KEY, CLEAR_COUNTER_VALUE)
+        }
+    }
+
+    private fun incrementCounter() {
+        val currentCounter = sharedPreferences.getInt(NOTIFICATION_COUNTER_KEY, 0)
+        sharedPreferences.edit {
+            putInt(NOTIFICATION_COUNTER_KEY, currentCounter + 1)
+        }
+    }
+
+    companion object {
+        internal const val FEEDBACK_TIMESTAMP_KEY = "feedback_timestamp"
+        internal const val NOTIFICATION_COUNTER_KEY = "notification_counter"
+        internal const val CLEAR_COUNTER_VALUE = 0
+        internal const val NO_FEEDBACK_REQUEST_HOURS = 3L
+        internal const val NO_FEEDBACK_COUNTER_LIMIT = 3
+    }
+}

app/src/main/kotlin/co/netguru/baby/monitor/client/feature/feedback/SavedRecordingDetails.kt

@@ -0,0 +1,6 @@
+package co.netguru.baby.monitor.client.feature.feedback
+
+data class SavedRecordingDetails(
+    val fileName: String,
+    val shouldAskForFeedback: Boolean = false
+)