Merge pull request #878 from DimensionDev/feature/inapp_changelog

Tlaster · web-flow · commit a727bb9e5d7e · 2025-04-21T17:24:11.000+09:00
add in app changelog
diff --git a/app/src/main/java/dev/dimension/flare/data/model/AppSettings.kt b/app/src/main/java/dev/dimension/flare/data/model/AppSettings.kt
@@ -0,0 +1,43 @@
+package dev.dimension.flare.data.model
+
+import android.content.Context
+import androidx.datastore.core.DataStore
+import androidx.datastore.core.Serializer
+import androidx.datastore.dataStore
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.withContext
+import kotlinx.serialization.ExperimentalSerializationApi
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.decodeFromByteArray
+import kotlinx.serialization.encodeToByteArray
+import kotlinx.serialization.protobuf.ProtoBuf
+import java.io.InputStream
+import java.io.OutputStream
+
+@Serializable
+internal data class AppSettings(
+    val version: String,
+)
+
+@OptIn(ExperimentalSerializationApi::class)
+private object PreferencesSerializer : Serializer<AppSettings> {
+    override suspend fun readFrom(input: InputStream): AppSettings = ProtoBuf.decodeFromByteArray(input.readBytes())
+
+    override suspend fun writeTo(
+        t: AppSettings,
+        output: OutputStream,
+    ) = withContext(Dispatchers.IO) {
+        output.write(ProtoBuf.encodeToByteArray(t))
+    }
+
+    override val defaultValue: AppSettings
+        get() =
+            AppSettings(
+                version = "",
+            )
+}
+
+internal val Context.appSettings: DataStore<AppSettings> by dataStore(
+    fileName = "app_settings.pb",
+    serializer = PreferencesSerializer,
+)
diff --git a/app/src/main/java/dev/dimension/flare/data/repository/SettingsRepository.kt b/app/src/main/java/dev/dimension/flare/data/repository/SettingsRepository.kt
@@ -1,12 +1,14 @@
 package dev.dimension.flare.data.repository
 
 import android.content.Context
+import dev.dimension.flare.data.model.AppSettings
 import dev.dimension.flare.data.model.AppearanceSettings
 import dev.dimension.flare.data.model.TabSettings
+import dev.dimension.flare.data.model.appSettings
 import dev.dimension.flare.data.model.appearanceSettings
 import dev.dimension.flare.data.model.tabSettings
 
-class SettingsRepository(
+internal class SettingsRepository(
     private val context: Context,
 ) {
     private val appearanceSettingsStore by lazy {
@@ -15,6 +17,12 @@ class SettingsRepository(
     val appearanceSettings by lazy {
         appearanceSettingsStore.data
     }
+    private val appSettingsStore by lazy {
+        context.appSettings
+    }
+    val appSettings by lazy {
+        appSettingsStore.data
+    }
 
     suspend fun updateAppearanceSettings(block: AppearanceSettings.() -> AppearanceSettings) {
         appearanceSettingsStore.updateData(block)
@@ -31,4 +39,8 @@ class SettingsRepository(
     suspend fun updateTabSettings(block: TabSettings.() -> TabSettings) {
         tabSettingsStore.updateData(block)
     }
+
+    suspend fun updateAppSettings(block: AppSettings.() -> AppSettings) {
+        appSettingsStore.updateData(block)
+    }
 }
diff --git a/app/src/main/java/dev/dimension/flare/ui/screen/home/ChangeLogState.kt b/app/src/main/java/dev/dimension/flare/ui/screen/home/ChangeLogState.kt
@@ -0,0 +1,59 @@
+package dev.dimension.flare.ui.screen.home
+
+import android.content.Context
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.remember
+import androidx.compose.runtime.rememberCoroutineScope
+import androidx.compose.ui.text.AnnotatedString
+import androidx.compose.ui.text.fromHtml
+import dev.dimension.flare.BuildConfig
+import dev.dimension.flare.data.repository.SettingsRepository
+import dev.dimension.flare.ui.model.UiState
+import dev.dimension.flare.ui.model.collectAsUiState
+import dev.dimension.flare.ui.model.map
+import kotlinx.coroutines.launch
+import org.koin.compose.koinInject
+
+@Composable
+internal fun changeLogPresenter(
+    context: Context = koinInject(),
+    repository: SettingsRepository = koinInject(),
+): ChangeLogState {
+    val scope = rememberCoroutineScope()
+    val appSettings by repository.appSettings.collectAsUiState()
+    val shouldShowChangeLog =
+        remember(appSettings) {
+            appSettings.map {
+                it.version != BuildConfig.VERSION_NAME
+            }
+        }
+    val changeLog =
+        remember(BuildConfig.VERSION_NAME) {
+            runCatching {
+                val id = context.resources.getIdentifier("changelog_${BuildConfig.VERSION_NAME}", "string", context.packageName)
+                context.getString(id)
+            }.getOrNull()?.let {
+                AnnotatedString.fromHtml(it)
+            }
+        }
+    return object : ChangeLogState {
+        override val shouldShowChangeLog: UiState<Boolean> = shouldShowChangeLog
+        override val changeLog: AnnotatedString? = changeLog
+
+        override fun dismissChangeLog() {
+            scope.launch {
+                repository.updateAppSettings {
+                    copy(version = BuildConfig.VERSION_NAME)
+                }
+            }
+        }
+    }
+}
+
+interface ChangeLogState {
+    val shouldShowChangeLog: UiState<Boolean>
+    val changeLog: AnnotatedString?
+
+    fun dismissChangeLog()
+}
diff --git a/app/src/main/java/dev/dimension/flare/ui/screen/home/HomeTimelineScreen.kt b/app/src/main/java/dev/dimension/flare/ui/screen/home/HomeTimelineScreen.kt
@@ -5,6 +5,8 @@ import androidx.compose.animation.scaleIn
 import androidx.compose.animation.scaleOut
 import androidx.compose.animation.slideInVertically
 import androidx.compose.animation.slideOutVertically
+import androidx.compose.foundation.layout.Arrangement
+import androidx.compose.foundation.layout.Column
 import androidx.compose.foundation.layout.PaddingValues
 import androidx.compose.foundation.layout.Spacer
 import androidx.compose.foundation.layout.fillMaxSize
@@ -16,11 +18,13 @@ import androidx.compose.foundation.lazy.staggeredgrid.LazyStaggeredGridState
 import androidx.compose.foundation.lazy.staggeredgrid.rememberLazyStaggeredGridState
 import androidx.compose.foundation.pager.HorizontalPager
 import androidx.compose.foundation.pager.rememberPagerState
+import androidx.compose.material3.Button
 import androidx.compose.material3.DrawerState
 import androidx.compose.material3.ExperimentalMaterial3Api
 import androidx.compose.material3.FilledTonalButton
 import androidx.compose.material3.FloatingActionButton
 import androidx.compose.material3.IconButton
+import androidx.compose.material3.MaterialTheme
 import androidx.compose.material3.SecondaryScrollableTabRow
 import androidx.compose.material3.Tab
 import androidx.compose.material3.Text
@@ -67,6 +71,7 @@ import dev.dimension.flare.ui.component.FlareTopAppBar
 import dev.dimension.flare.ui.component.LocalBottomBarHeight
 import dev.dimension.flare.ui.component.RefreshContainer
 import dev.dimension.flare.ui.component.ThemeWrapper
+import dev.dimension.flare.ui.component.status.AdaptiveCard
 import dev.dimension.flare.ui.component.status.LazyStatusVerticalStaggeredGrid
 import dev.dimension.flare.ui.component.status.status
 import dev.dimension.flare.ui.model.UiState
@@ -81,6 +86,7 @@ import dev.dimension.flare.ui.presenter.home.UserPresenter
 import dev.dimension.flare.ui.presenter.home.UserState
 import dev.dimension.flare.ui.presenter.invoke
 import dev.dimension.flare.ui.screen.settings.TabTitle
+import dev.dimension.flare.ui.theme.screenHorizontalPadding
 import kotlinx.collections.immutable.toImmutableList
 import kotlinx.coroutines.flow.distinctUntilChanged
 import kotlinx.coroutines.flow.drop
@@ -274,6 +280,44 @@ internal fun TimelineItemContent(
                 contentPadding = contentPadding,
                 modifier = Modifier.fillMaxSize(),
             ) {
+                state.shouldShowChangeLog.onSuccess {
+                    state.changeLog?.let { changelog ->
+                        if (it) {
+                            item {
+                                AdaptiveCard {
+                                    Column(
+                                        modifier =
+                                            Modifier
+                                                .padding(
+                                                    horizontal = screenHorizontalPadding,
+                                                ).padding(top = 16.dp, bottom = 8.dp),
+                                        verticalArrangement = Arrangement.spacedBy(8.dp),
+                                    ) {
+                                        Text(
+                                            stringResource(R.string.changelog_title),
+                                            style = MaterialTheme.typography.titleMedium,
+                                        )
+                                        Text(
+                                            stringResource(R.string.changelog_message),
+                                            style = MaterialTheme.typography.bodySmall,
+                                        )
+                                        Text(changelog)
+                                        Button(
+                                            onClick = {
+                                                state.dismissChangeLog()
+                                            },
+                                        ) {
+                                            Text(
+                                                stringResource(android.R.string.ok),
+                                            )
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+
                 status(state.listState)
             }
             state.listState.onSuccess {
@@ -358,6 +402,7 @@ private fun timelinePresenter(
 
 @Composable
 internal fun timelineItemPresenter(timelineTabItem: TimelineTabItem): TimelineItemState {
+    val changeLogState = changeLogPresenter()
     val timelinePresenter =
         remember(timelineTabItem) {
             timelineTabItem.createPresenter()
@@ -396,7 +441,7 @@ internal fun timelineItemPresenter(timelineTabItem: TimelineTabItem): TimelineIt
             showNewToots = false
         }
     }
-    return object : TimelineItemState {
+    return object : TimelineItemState, ChangeLogState by changeLogState {
         override val listState = state.listState
         override val showNewToots = showNewToots
         override val isRefreshing = state.listState.isRefreshing
@@ -417,7 +462,7 @@ internal fun timelineItemPresenter(timelineTabItem: TimelineTabItem): TimelineIt
 }
 
 @Immutable
-internal interface TimelineItemState {
+internal interface TimelineItemState : ChangeLogState {
     val listState: PagingState<UiTimeline>
     val showNewToots: Boolean
     val isRefreshing: Boolean
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
@@ -292,4 +292,7 @@
 
     <string name="emoji_picker_recent">Recent</string>
     <string name="emoji_picker_search">Search</string>
+
+    <string name="changelog_title">Welcome back!</string>
+    <string name="changelog_message">We have made some changes since you last logged in. Here are the details:</string>
 </resources>
diff --git a/shared/ui/component/src/commonMain/kotlin/dev/dimension/flare/ui/component/status/LazyStatusItems.kt b/shared/ui/component/src/commonMain/kotlin/dev/dimension/flare/ui/component/status/LazyStatusItems.kt
@@ -201,8 +201,8 @@ public fun LazyStaggeredGridScope.status(
 
 @Composable
 public fun AdaptiveCard(
-    content: @Composable () -> Unit,
     modifier: Modifier = Modifier,
+    content: @Composable () -> Unit,
 ) {
     val bigScreen = isBigScreen()
     if (bigScreen) {
