refactor date usage and complete date api

Author: cmonfortep

attributed-metrics/attributed-metrics-impl/build.gradle

@@ -54,6 +54,7 @@ dependencies {
     testImplementation "androidx.lifecycle:lifecycle-runtime-testing:_"
     testImplementation project(path: ':common-test')
     testImplementation project(':data-store-test')
+    testImplementation project(':feature-toggles-test')
     testImplementation CashApp.turbine
     testImplementation Testing.robolectric
     testImplementation(KotlinX.coroutines.test) {

attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/impl/AttributedMetricsState.kt

@@ -19,7 +19,7 @@ package com.duckduckgo.app.attributed.metrics.impl
 import androidx.lifecycle.LifecycleOwner
 import com.duckduckgo.app.attributed.metrics.AttributedMetricsConfigFeature
 import com.duckduckgo.app.attributed.metrics.store.AttributedMetricsDataStore
-import com.duckduckgo.app.attributed.metrics.store.DateProvider
+import com.duckduckgo.app.attributed.metrics.store.AttributedMetricsDateUtils
 import com.duckduckgo.app.di.AppCoroutineScope
 import com.duckduckgo.app.lifecycle.MainProcessLifecycleObserver
 import com.duckduckgo.app.statistics.api.AtbLifecyclePlugin
@@ -33,9 +33,6 @@ import dagger.SingleInstanceIn
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
 import logcat.logcat
-import java.time.LocalDate
-import java.time.format.DateTimeFormatter
-import java.time.temporal.ChronoUnit
 import javax.inject.Inject
 
 /**
@@ -72,7 +69,7 @@ class RealAttributedMetricsState @Inject constructor(
     private val dataStore: AttributedMetricsDataStore,
     private val attributedMetricsConfigFeature: AttributedMetricsConfigFeature,
     private val appBuildConfig: AppBuildConfig,
-    private val dateProvider: DateProvider,
+    private val attributedMetricsDateUtils: AttributedMetricsDateUtils,
 ) : AttributedMetricsState, MainProcessLifecycleObserver, AtbLifecyclePlugin, PrivacyConfigCallbackPlugin {
 
     override fun onCreate(owner: LifecycleOwner) {
@@ -99,7 +96,7 @@ class RealAttributedMetricsState @Inject constructor(
                 logcat(tag = "AttributedMetrics") {
                     "Setting initialization date for Attributed Metrics"
                 }
-                val currentDate = dateProvider.getCurrentDate()
+                val currentDate = attributedMetricsDateUtils.getCurrentDate()
                 dataStore.setInitializationDate(currentDate)
                 if (appBuildConfig.isAppReinstall()) {
                     logcat(tag = "AttributedMetrics") {
@@ -140,10 +137,7 @@ class RealAttributedMetricsState @Inject constructor(
             return
         }
 
-        val initLocalDate = LocalDate.parse(initDate, DATE_FORMATTER)
-        val currentDate = LocalDate.now()
-
-        val daysSinceInit = ChronoUnit.DAYS.between(initLocalDate, currentDate)
+        val daysSinceInit = attributedMetricsDateUtils.daysSince(initDate)
         val isWithinPeriod = daysSinceInit <= COLLECTION_PERIOD_DAYS
         val isClientActive = isWithinPeriod && dataStore.isActive()
 
@@ -154,7 +148,6 @@ class RealAttributedMetricsState @Inject constructor(
     }
 
     companion object {
-        private val DATE_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd")
         private const val COLLECTION_PERIOD_DAYS = 168 // 24 weeks * 7 days (6 months in weeks)
     }
 }

attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/store/AttributedMetricsDateUtils.kt

@@ -0,0 +1,93 @@
+/*
+ * Copyright (c) 2024 DuckDuckGo
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.duckduckgo.app.attributed.metrics.store
+
+import com.duckduckgo.di.scopes.AppScope
+import com.squareup.anvil.annotations.ContributesBinding
+import java.time.LocalDate
+import java.time.format.DateTimeFormatter
+import java.time.temporal.ChronoUnit
+import javax.inject.Inject
+
+/**
+ * Utility interface for handling date operations in the Attributed Metrics feature.
+ *
+ * This interface provides methods for:
+ * - Getting the current date in a standardized format
+ * - Calculating days between dates
+ * - Generating dates relative to the current date
+ *
+ * All dates are handled in the format "yyyy-MM-dd" for consistency across the feature.
+ * This format is used for both storage and calculations.
+ *
+ * Example usage:
+ * ```
+ * // Get today's date
+ * val today = dateUtils.getCurrentDate() // returns "2025-10-03"
+ *
+ * // Get a date 7 days ago
+ * val lastWeek = dateUtils.getDateMinusDays(7) // returns "2025-09-26"
+ *
+ * // Calculate days since a specific date
+ * val daysSince = dateUtils.daysSince("2025-09-01") // returns number of days
+ * ```
+ */
+interface AttributedMetricsDateUtils {
+    /**
+     * Gets the current date formatted as "yyyy-MM-dd".
+     *
+     * @return The current date as a string in the format "yyyy-MM-dd"
+     */
+    fun getCurrentDate(): String
+
+    /**
+     * Calculates the number of days between a given date and the current date.
+     *
+     * @param date The reference date in "yyyy-MM-dd" format
+     * @return The number of days between the reference date and current date.
+     *         Positive if the reference date is in the past,
+     *         negative if it's in the future,
+     *         zero if it's today.
+     */
+    fun daysSince(date: String): Int
+
+    /**
+     * Gets a date that is a specified number of days before the current date.
+     *
+     * @param days The number of days to subtract from the current date
+     * @return The calculated date as a string in "yyyy-MM-dd" format
+     */
+    fun getDateMinusDays(days: Int): String
+}
+
+@ContributesBinding(AppScope::class)
+class RealAttributedMetricsDateUtils @Inject constructor() : AttributedMetricsDateUtils {
+    override fun getCurrentDate(): String = getCurrentLocalDate().format(DATE_FORMATTER)
+
+    override fun daysSince(date: String): Int {
+        val initDate = LocalDate.parse(date, DATE_FORMATTER)
+        return ChronoUnit.DAYS.between(initDate, getCurrentLocalDate()).toInt()
+    }
+
+    override fun getDateMinusDays(days: Int): String = getCurrentLocalDate().minusDays(days.toLong()).format(DATE_FORMATTER)
+
+    private fun getCurrentLocalDate(): LocalDate = LocalDate.now()
+
+    companion object {
+        private val DATE_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd")
+    }
+}

attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/store/DateProvider.kt

@@ -38,11 +38,11 @@ interface EventRepository {
 @ContributesBinding(AppScope::class)
 class RealEventRepository @Inject constructor(
     private val eventDao: EventDao,
-    private val dateProvider: DateProvider,
+    private val attributedMetricsDateUtils: AttributedMetricsDateUtils,
     @AppCoroutineScope private val coroutineScope: CoroutineScope,
 ) : EventRepository {
     override suspend fun collectEvent(eventName: String) {
-        val today = dateProvider.getCurrentDate()
+        val today = attributedMetricsDateUtils.getCurrentDate()
         val currentCount = eventDao.getEventCount(eventName, today)
 
         if (currentCount == null) {
@@ -56,7 +56,7 @@ class RealEventRepository @Inject constructor(
         eventName: String,
         days: Int,
     ): EventStats {
-        val startDay = dateProvider.getDateMinusDays(days)
+        val startDay = attributedMetricsDateUtils.getDateMinusDays(days)
 
         val daysWithEvents = eventDao.getDaysWithEvents(eventName, startDay)
         val totalEvents = eventDao.getTotalEvents(eventName, startDay) ?: 0
@@ -71,7 +71,7 @@ class RealEventRepository @Inject constructor(
 
     override suspend fun deleteOldEvents(olderThanDays: Int) {
         coroutineScope.launch {
-            val cutoffDay = dateProvider.getDateMinusDays(olderThanDays)
+            val cutoffDay = attributedMetricsDateUtils.getDateMinusDays(olderThanDays)
             eventDao.deleteEventsOlderThan(cutoffDay)
         }
     }

attributed-metrics/attributed-metrics-impl/src/main/java/com/duckduckgo/app/attributed/metrics/store/EventRepository.kt

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2025 DuckDuckGo
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.duckduckgo.app.attributed.metrics
+
+import com.duckduckgo.app.attributed.metrics.store.AttributedMetricsDateUtils
+import java.time.LocalDate
+import java.time.format.DateTimeFormatter
+import java.time.temporal.ChronoUnit
+
+class FakeAttributedMetricsDateUtils(var testDate: LocalDate) : AttributedMetricsDateUtils {
+
+    override fun getCurrentDate(): String = getCurrentLocalDate().format(DATE_FORMATTER)
+
+    override fun daysSince(date: String): Int {
+        val initDate = LocalDate.parse(date, DATE_FORMATTER)
+        return ChronoUnit.DAYS.between(initDate, getCurrentLocalDate()).toInt()
+    }
+
+    override fun getDateMinusDays(days: Int): String = getCurrentLocalDate().minusDays(days.toLong()).format(DATE_FORMATTER)
+
+    private fun getCurrentLocalDate(): LocalDate = testDate
+
+    companion object {
+        private val DATE_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd")
+    }
+}