Archives
/
iceraven-browser
mirror of https://github.com/fork-maintainers/iceraven-browser
2
0
Fork 0
Code Issues Releases Wiki Activity

[fenix] EXP-2994 Refactor messaging middleware Part I

Browse Source
pull/600/head
James Hugman 2 years ago committed by mergify[bot]
parent e734b41a69
commit d47aa5753e
4 changed files with 78 additions and 41 deletions
Show Stats Download Patch File Download Diff File

3
app/src/main/java/org/mozilla/fenix/gleanplumb/Message.kt
Unescape Escape View File

@ -37,6 +37,9 @@ data class Message(
val surface: MessageSurfaceId
get() = data.surface
val isExpired: Boolean
get() = metadata.displayCount >= maxDisplayCount
/**
* A data class that holds metadata that help to identify if a message should shown.
*

45
app/src/main/java/org/mozilla/fenix/gleanplumb/state/MessagingMiddleware.kt
Unescape Escape View File

@ -10,7 +10,6 @@ import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch
import mozilla.components.lib.state.Middleware
import mozilla.components.lib.state.MiddlewareContext
import org.mozilla.fenix.GleanMetrics.Messaging
import org.mozilla.fenix.components.appstate.AppAction
import org.mozilla.fenix.components.appstate.AppAction.MessagingAction.ConsumeMessageToShow
import org.mozilla.fenix.components.appstate.AppAction.MessagingAction.Evaluate
@ -26,9 +25,10 @@ import org.mozilla.fenix.gleanplumb.NimbusMessagingStorage
typealias AppStoreMiddlewareContext = MiddlewareContext<AppState, AppAction>
class MessagingMiddleware(
private val messagingStorage: NimbusMessagingStorage,
private val coroutineScope: CoroutineScope = CoroutineScope(Dispatchers.IO),
) : Middleware<AppState, AppAction> {
messagingStorage: NimbusMessagingStorage,
coroutineScope: CoroutineScope = CoroutineScope(Dispatchers.IO),
clock: () -> Long = { System.currentTimeMillis() },
) : NimbusMessagingController(messagingStorage, coroutineScope, clock), Middleware<AppState, AppAction> {
override fun invoke(
context: AppStoreMiddlewareContext,
@ -72,35 +72,14 @@ class MessagingMiddleware(
oldMessage: Message,
context: AppStoreMiddlewareContext,
) {
sendShownMessageTelemetry(oldMessage.id)
val newMetadata = oldMessage.metadata.copy(
displayCount = oldMessage.metadata.displayCount + 1,
lastTimeShown = now(),
)
val newMessage = oldMessage.copy(
metadata = newMetadata,
)
val newMessages = if (newMetadata.displayCount < oldMessage.maxDisplayCount) {
val newMessage = onMessageDisplayed(oldMessage)
val newMessages = if (!newMessage.isExpired) {
updateMessage(context, oldMessage, newMessage)
} else {
sendExpiredMessageTelemetry(newMessage.id)
consumeMessageToShowIfNeeded(context, oldMessage)
removeMessage(context, oldMessage)
}
context.dispatch(UpdateMessages(newMessages))
coroutineScope.launch {
messagingStorage.updateMetadata(newMetadata)
}
}
@VisibleForTesting
internal fun sendShownMessageTelemetry(messageId: String) {
Messaging.messageShown.record(Messaging.MessageShownExtra(messageId))
}
@VisibleForTesting
internal fun sendExpiredMessageTelemetry(messageId: String) {
Messaging.messageExpired.record(Messaging.MessageExpiredExtra(messageId))
}
@VisibleForTesting
@ -111,10 +90,7 @@ class MessagingMiddleware(
val newMessages = removeMessage(context, message)
context.dispatch(UpdateMessages(newMessages))
consumeMessageToShowIfNeeded(context, message)
coroutineScope.launch {
val updatedMetadata = message.metadata.copy(dismissed = true)
messagingStorage.updateMetadata(updatedMetadata)
}
onMessageDismissed(message)
}
@VisibleForTesting
@ -123,10 +99,7 @@ class MessagingMiddleware(
context: AppStoreMiddlewareContext,
) {
// Update Nimbus storage.
coroutineScope.launch {
val updatedMetadata = message.metadata.copy(pressed = true)
messagingStorage.updateMetadata(updatedMetadata)
}
onMessageClicked(message)
// Update app state.
val newMessages = removeMessage(context, message)
context.dispatch(UpdateMessages(newMessages))
@ -166,6 +139,4 @@ class MessagingMiddleware(
return removeMessage(context, oldMessage) + updatedMessage
}
@VisibleForTesting
internal fun now(): Long = System.currentTimeMillis()
}

65
app/src/main/java/org/mozilla/fenix/gleanplumb/state/NimbusMessagingController.kt
Unescape Escape View File

@ -0,0 +1,65 @@
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
package org.mozilla.fenix.gleanplumb.state
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch
import org.mozilla.fenix.GleanMetrics.Messaging
import org.mozilla.fenix.gleanplumb.Message
import org.mozilla.fenix.gleanplumb.NimbusMessagingStorage
/**
* Class extracted from [MessagingMiddleware] to do the bookkeeping for message actions, in terms
* of Glean messages and the messaging store.
*/
open class NimbusMessagingController(
protected val messagingStorage: NimbusMessagingStorage,
protected val coroutineScope: CoroutineScope = CoroutineScope(Dispatchers.IO),
private val clock: () -> Long = { System.currentTimeMillis() },
) {
protected fun onMessageDisplayed(oldMessage: Message): Message {
sendShownMessageTelemetry(oldMessage.id)
val newMetadata = oldMessage.metadata.copy(
displayCount = oldMessage.metadata.displayCount + 1,
lastTimeShown = clock(),
)
val newMessage = oldMessage.copy(
metadata = newMetadata,
)
coroutineScope.launch {
messagingStorage.updateMetadata(newMetadata)
}
if (newMessage.isExpired) {
sendExpiredMessageTelemetry(newMessage.id)
}
return newMessage
}
protected fun onMessageDismissed(message: Message) {
coroutineScope.launch {
val updatedMetadata = message.metadata.copy(dismissed = true)
messagingStorage.updateMetadata(updatedMetadata)
}
}
protected fun onMessageClicked(message: Message) {
coroutineScope.launch {
val updatedMetadata = message.metadata.copy(pressed = true)
messagingStorage.updateMetadata(updatedMetadata)
}
}
internal fun sendShownMessageTelemetry(messageId: String) {
Messaging.messageShown.record(Messaging.MessageShownExtra(messageId))
}
internal fun sendExpiredMessageTelemetry(messageId: String) {
Messaging.messageExpired.record(Messaging.MessageExpiredExtra(messageId))
}
}

6
app/src/test/java/org/mozilla/fenix/gleanplumb/state/MessagingMiddlewareTest.kt
Unescape Escape View File

@ -63,6 +63,7 @@ class MessagingMiddlewareTest {
middleware = MessagingMiddleware(
messagingStorage,
coroutineScope,
clock = { 0L },
)
}
@ -144,7 +145,7 @@ class MessagingMiddlewareTest {
}
@Test
fun `GIEN a expiring message WHEN MessageDisplayed THEN update storage`() = runTestOnMain {
fun `GIVEN a expiring message WHEN MessageDisplayed THEN update storage`() = runTestOnMain {
val message = Message(
"control-id",
mockk(relaxed = true),
@ -157,7 +158,6 @@ class MessagingMiddlewareTest {
val messagingState: MessagingState = mockk(relaxed = true)
val spiedMiddleware = spyk(middleware)
every { spiedMiddleware.now() } returns 0L
every { messagingState.messages } returns emptyList()
every { appState.messaging } returns messagingState
every { middlewareContext.state } returns appState
@ -291,7 +291,6 @@ class MessagingMiddlewareTest {
val updatedMessage = oldMessage.copy(metadata = oldMessage.metadata.copy(displayCount = 1))
val spiedMiddleware = spyk(middleware)
every { spiedMiddleware.now() } returns 0
every { style.maxDisplayCount } returns 2
every {
spiedMiddleware.updateMessage(
@ -323,7 +322,6 @@ class MessagingMiddlewareTest {
val updatedMessage = oldMessage.copy(metadata = oldMessage.metadata.copy(displayCount = 1))
val spiedMiddleware = spyk(middleware)
every { spiedMiddleware.now() } returns 0
every { style.maxDisplayCount } returns 1
every {
spiedMiddleware.consumeMessageToShowIfNeeded(

Write Preview
Loading…
Cancel
Save