Fix timezone issue by adding TimezoneProvider, fix tests

features/roomlist/impl/src/main/kotlin/io/element/android/features/roomlist/impl/RoomListPresenter.kt

@@ -51,7 +51,6 @@ import io.element.android.libraries.matrix.api.core.RoomId
 import io.element.android.libraries.matrix.api.encryption.EncryptionService
 import io.element.android.libraries.matrix.api.encryption.RecoveryState
 import io.element.android.libraries.matrix.api.roomlist.RoomList
-import io.element.android.libraries.matrix.api.sync.SyncService
 import io.element.android.libraries.matrix.api.timeline.ReceiptType
 import io.element.android.libraries.preferences.api.store.SessionPreferencesStore
 import io.element.android.libraries.push.api.notifications.NotificationCleaner
@@ -93,7 +92,6 @@ class RoomListPresenter @Inject constructor(
     private val logoutPresenter: Presenter<DirectLogoutState>,
 ) : Presenter<RoomListState> {
     private val encryptionService: EncryptionService = client.encryptionService()
-    private val syncService: SyncService = client.syncService()
 
     @Composable
     override fun present(): RoomListState {

features/roomlist/impl/src/main/kotlin/io/element/android/features/roomlist/impl/datasource/RoomListDataSource.kt

@@ -7,13 +7,11 @@
 
 package io.element.android.features.roomlist.impl.datasource
 
-import android.content.Context
 import io.element.android.features.roomlist.impl.model.RoomListRoomSummary
 import io.element.android.libraries.androidutils.diff.DiffCacheUpdater
 import io.element.android.libraries.androidutils.diff.MutableListDiffCache
 import io.element.android.libraries.androidutils.system.DateTimeObserver
 import io.element.android.libraries.core.coroutine.CoroutineDispatchers
-import io.element.android.libraries.di.ApplicationContext
 import io.element.android.libraries.matrix.api.core.RoomId
 import io.element.android.libraries.matrix.api.notificationsettings.NotificationSettingsService
 import io.element.android.libraries.matrix.api.roomlist.RoomListService
@@ -34,7 +32,6 @@ import javax.inject.Inject
 import kotlin.time.Duration.Companion.seconds
 
 class RoomListDataSource @Inject constructor(
-    @ApplicationContext private val context: Context,
     private val roomListService: RoomListService,
     private val roomListRoomSummaryFactory: RoomListRoomSummaryFactory,
     private val coroutineDispatchers: CoroutineDispatchers,

features/roomlist/impl/src/test/kotlin/io/element/android/features/roomlist/impl/RoomListPresenterTest.kt

@@ -29,6 +29,7 @@ import io.element.android.features.roomlist.impl.model.createRoomListRoomSummary
 import io.element.android.features.roomlist.impl.search.RoomListSearchEvents
 import io.element.android.features.roomlist.impl.search.RoomListSearchState
 import io.element.android.features.roomlist.impl.search.aRoomListSearchState
+import io.element.android.libraries.androidutils.system.DateTimeObserver
 import io.element.android.libraries.architecture.Presenter
 import io.element.android.libraries.dateformatter.api.LastMessageTimestampFormatter
 import io.element.android.libraries.dateformatter.test.A_FORMATTED_DATE
@@ -83,6 +84,7 @@ import io.element.android.tests.testutils.lambda.value
 import io.element.android.tests.testutils.test
 import io.element.android.tests.testutils.testCoroutineDispatchers
 import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.flow.MutableSharedFlow
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.test.TestScope
 import kotlinx.coroutines.test.advanceTimeBy
@@ -655,7 +657,8 @@ class RoomListPresenterTest {
             ),
             coroutineDispatchers = testCoroutineDispatchers(),
             notificationSettingsService = client.notificationSettingsService(),
-            appScope = backgroundScope
+            appScope = backgroundScope,
+            dateTimeObserver = FakeDateTimeObserver(),
         ),
         featureFlagService = featureFlagService,
         indicatorService = DefaultIndicatorService(
@@ -672,3 +675,11 @@ class RoomListPresenterTest {
         logoutPresenter = { aDirectLogoutState() },
     )
 }
+
+class FakeDateTimeObserver : DateTimeObserver {
+    override val changes = MutableSharedFlow<DateTimeObserver.Event>()
+
+    fun given(event: DateTimeObserver.Event) {
+        changes.tryEmit(event)
+    }
+}

libraries/androidutils/src/main/kotlin/io/element/android/libraries/androidutils/system/DateTimeObserver.kt

@@ -11,31 +11,43 @@ import android.content.BroadcastReceiver
 import android.content.Context
 import android.content.Intent
 import android.content.IntentFilter
+import com.squareup.anvil.annotations.ContributesBinding
+import io.element.android.libraries.androidutils.system.DateTimeObserver.Event
+import io.element.android.libraries.di.AppScope
 import io.element.android.libraries.di.ApplicationContext
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.MutableSharedFlow
 import java.time.Instant
 import javax.inject.Inject
 
-class DateTimeObserver @Inject constructor(
-    @ApplicationContext private val context: Context
-) {
+interface DateTimeObserver {
+    val changes: Flow<Event>
+
+    sealed interface Event {
+        data object TimeZoneChanged : Event
+        data class DateChanged(val previous: Instant, val new: Instant) : Event
+    }
+}
+
+@ContributesBinding(AppScope::class)
+class DefaultDateTimeObserver @Inject constructor(
+    @ApplicationContext context: Context
+) : DateTimeObserver {
     private val dateTimeReceiver = object : BroadcastReceiver() {
         private var lastTime = Instant.now()
 
         override fun onReceive(context: Context, intent: Intent) {
             val newDate = Instant.now()
             when (intent.action) {
-                Intent.ACTION_TIMEZONE_CHANGED -> _changes.tryEmit(Event.TimeZoneChanged)
-                Intent.ACTION_DATE_CHANGED -> _changes.tryEmit(Event.DateChanged(lastTime, newDate))
-                Intent.ACTION_TIME_CHANGED -> _changes.tryEmit(Event.DateChanged(lastTime, newDate))
+                Intent.ACTION_TIMEZONE_CHANGED -> changes.tryEmit(Event.TimeZoneChanged)
+                Intent.ACTION_DATE_CHANGED -> changes.tryEmit(Event.DateChanged(lastTime, newDate))
+                Intent.ACTION_TIME_CHANGED -> changes.tryEmit(Event.DateChanged(lastTime, newDate))
             }
             lastTime = newDate
         }
     }
 
-    private val _changes = MutableSharedFlow<Event>(extraBufferCapacity = 10)
-    val changes: Flow<Event> = _changes
+    override val changes = MutableSharedFlow<Event>(extraBufferCapacity = 10)
 
     init {
         context.registerReceiver(dateTimeReceiver, IntentFilter().apply {
@@ -44,9 +56,4 @@ class DateTimeObserver @Inject constructor(
             addAction(Intent.ACTION_TIME_CHANGED)
         })
     }
-
-    sealed interface Event {
-        data object TimeZoneChanged : Event
-        data class DateChanged(val previous: Instant, val new: Instant) : Event
-    }
 }

libraries/dateformatter/impl/src/main/kotlin/io/element/android/libraries/dateformatter/impl/DateFormatters.kt

@@ -11,7 +11,6 @@ import android.text.format.DateFormat
 import android.text.format.DateUtils
 import kotlinx.datetime.Clock
 import kotlinx.datetime.LocalDateTime
-import kotlinx.datetime.TimeZone
 import kotlinx.datetime.toInstant
 import kotlinx.datetime.toJavaLocalDate
 import kotlinx.datetime.toJavaLocalDateTime
@@ -25,7 +24,7 @@ import kotlin.math.absoluteValue
 class DateFormatters @Inject constructor(
     private val locale: Locale,
     private val clock: Clock,
-    private val timeZone: TimeZone,
+    private val timeZoneProvider: TimezoneProvider,
 ) {
     private val onlyTimeFormatter: DateTimeFormatter by lazy {
         DateTimeFormatter.ofLocalizedTime(FormatStyle.SHORT).withLocale(locale)
@@ -70,7 +69,7 @@ class DateFormatters @Inject constructor(
         return if (period.years.absoluteValue >= 1) {
             formatDateWithYear(dateToFormat)
         } else if (useRelative && period.days.absoluteValue < 2 && period.months.absoluteValue < 1) {
-            getRelativeDay(dateToFormat.toInstant(timeZone).toEpochMilliseconds())
+            getRelativeDay(dateToFormat.toInstant(timeZoneProvider.provide()).toEpochMilliseconds())
         } else {
             formatDateWithMonth(dateToFormat)
         }

libraries/dateformatter/impl/src/main/kotlin/io/element/android/libraries/dateformatter/impl/LocalDateTimeProvider.kt

@@ -10,21 +10,20 @@ package io.element.android.libraries.dateformatter.impl
 import kotlinx.datetime.Clock
 import kotlinx.datetime.Instant
 import kotlinx.datetime.LocalDateTime
-import kotlinx.datetime.TimeZone
 import kotlinx.datetime.toLocalDateTime
 import javax.inject.Inject
 
 class LocalDateTimeProvider @Inject constructor(
     private val clock: Clock,
-    private val timezone: TimeZone,
+    private val timezoneProvider: TimezoneProvider,
 ) {
     fun providesNow(): LocalDateTime {
         val now: Instant = clock.now()
-        return now.toLocalDateTime(timezone)
+        return now.toLocalDateTime(timezoneProvider.provide())
     }
 
     fun providesFromTimestamp(timestamp: Long): LocalDateTime {
         val tsInstant = Instant.fromEpochMilliseconds(timestamp)
-        return tsInstant.toLocalDateTime(timezone)
+        return tsInstant.toLocalDateTime(timezoneProvider.provide())
     }
 }

libraries/dateformatter/impl/src/main/kotlin/io/element/android/libraries/dateformatter/impl/TimezoneProvider.kt

@@ -0,0 +1,14 @@
+/*
+ * Copyright 2024 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * Please see LICENSE in the repository root for full details.
+ */
+
+package io.element.android.libraries.dateformatter.impl
+
+import kotlinx.datetime.TimeZone
+
+fun interface TimezoneProvider {
+    fun provide(): TimeZone
+}

libraries/dateformatter/impl/src/main/kotlin/io/element/android/libraries/dateformatter/impl/di/DateFormatterModule.kt

@@ -10,6 +10,7 @@ package io.element.android.libraries.dateformatter.impl.di
 import com.squareup.anvil.annotations.ContributesTo
 import dagger.Module
 import dagger.Provides
+import io.element.android.libraries.dateformatter.impl.TimezoneProvider
 import io.element.android.libraries.di.AppScope
 import kotlinx.datetime.Clock
 import kotlinx.datetime.TimeZone
@@ -25,5 +26,5 @@ object DateFormatterModule {
     fun providesLocale(): Locale = Locale.getDefault()
 
     @Provides
-    fun providesTimezone(): TimeZone = TimeZone.currentSystemDefault()
+    fun providesTimezone(): TimezoneProvider = TimezoneProvider { TimeZone.currentSystemDefault() }
 }

libraries/dateformatter/impl/src/test/kotlin/io/element/android/libraries/dateformatter/impl/DefaultLastMessageTimestampFormatterTest.kt

@@ -93,7 +93,7 @@ class DefaultLastMessageTimestampFormatterTest {
         val now = "1980-04-06T18:35:24.00Z"
         val dat = "1979-04-06T18:35:24.00Z"
         val clock = FakeClock().apply { givenInstant(Instant.parse(now)) }
-        val dateFormatters = DateFormatters(Locale.US, clock, TimeZone.UTC)
+        val dateFormatters = DateFormatters(Locale.US, clock) { TimeZone.UTC }
         assertThat(dateFormatters.formatDateWithFullFormat(Instant.parse(dat).toLocalDateTime(TimeZone.UTC))).isEqualTo("Friday, April 6, 1979")
     }
 
@@ -102,8 +102,8 @@ class DefaultLastMessageTimestampFormatterTest {
      */
     private fun createFormatter(@Suppress("SameParameterValue") currentDate: String): LastMessageTimestampFormatter {
         val clock = FakeClock().apply { givenInstant(Instant.parse(currentDate)) }
-        val localDateTimeProvider = LocalDateTimeProvider(clock, TimeZone.UTC)
-        val dateFormatters = DateFormatters(Locale.US, clock, TimeZone.UTC)
+        val localDateTimeProvider = LocalDateTimeProvider(clock) { TimeZone.UTC }
+        val dateFormatters = DateFormatters(Locale.US, clock) { TimeZone.UTC }
         return DefaultLastMessageTimestampFormatter(localDateTimeProvider, dateFormatters)
     }
 }

samples/minimal/build.gradle.kts

@@ -43,6 +43,7 @@ dependencies {
     implementation(projects.libraries.permissions.noop)
     implementation(projects.libraries.sessionStorage.implMemory)
     implementation(projects.libraries.designsystem)
+    implementation(projects.libraries.androidutils)
     implementation(projects.libraries.architecture)
     implementation(projects.libraries.core)
     implementation(projects.libraries.network)

samples/minimal/src/main/kotlin/io/element/android/samples/minimal/RoomListScreen.kt

@@ -24,6 +24,7 @@ import io.element.android.features.roomlist.impl.filters.RoomListFiltersPresente
 import io.element.android.features.roomlist.impl.filters.selection.DefaultFilterSelectionStrategy
 import io.element.android.features.roomlist.impl.search.RoomListSearchDataSource
 import io.element.android.features.roomlist.impl.search.RoomListSearchPresenter
+import io.element.android.libraries.androidutils.system.DefaultDateTimeObserver
 import io.element.android.libraries.core.coroutine.CoroutineDispatchers
 import io.element.android.libraries.dateformatter.impl.DateFormatters
 import io.element.android.libraries.dateformatter.impl.DefaultLastMessageTimestampFormatter
@@ -59,9 +60,8 @@ class RoomListScreen(
 ) {
     private val clock = Clock.System
     private val locale = Locale.getDefault()
-    private val timeZone = TimeZone.currentSystemDefault()
-    private val dateTimeProvider = LocalDateTimeProvider(clock, timeZone)
-    private val dateFormatters = DateFormatters(locale, clock, timeZone)
+    private val dateTimeProvider = LocalDateTimeProvider(clock) { TimeZone.currentSystemDefault() }
+    private val dateFormatters = DateFormatters(locale, clock) { TimeZone.currentSystemDefault() }
     private val sessionVerificationService = matrixClient.sessionVerificationService()
     private val encryptionService = matrixClient.encryptionService()
     private val stringProvider = AndroidStringProvider(context.resources)
@@ -92,7 +92,8 @@ class RoomListScreen(
             roomListRoomSummaryFactory = roomListRoomSummaryFactory,
             coroutineDispatchers = coroutineDispatchers,
             notificationSettingsService = matrixClient.notificationSettingsService(),
-            appScope = Singleton.appScope
+            appScope = Singleton.appScope,
+            dateTimeObserver = DefaultDateTimeObserver(context),
         ),
         indicatorService = DefaultIndicatorService(
             sessionVerificationService = sessionVerificationService,