Improve OSS licenses screen

.github/workflows/CompareScreenshot.yml

@@ -33,7 +33,7 @@ jobs:
  workflow: UnitTest.yml
  branch: main
 
- - run: ./gradlew compareRoborazziDebug compareRoborazziDevDebug --stacktrace -Pscreenshot
+ - run: ./gradlew compareRoborazziDebug compareRoborazziDevRelease --stacktrace -Pscreenshot
 
  - uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
  if: ${{ always() }}

app-android/src/main/java/io/github/droidkaigi/confsched2023/AppModule.kt

@@ -1,10 +1,15 @@
 package io.github.droidkaigi.confsched2023
 
+import android.content.Context
 import dagger.Module
 import dagger.Provides
 import dagger.hilt.InstallIn
+import dagger.hilt.android.qualifiers.ApplicationContext
 import dagger.hilt.components.SingletonComponent
 import io.github.droidkaigi.confsched2023.data.di.AppAndroidBuildConfig
+import io.github.droidkaigi.confsched2023.data.di.AppAndroidOssLicenseConfig
+import io.github.droidkaigi.confsched2023.data.osslicense.OssLicenseDataSource
+import io.github.droidkaigi.confsched2023.license.DefaultOssLicenseDataSource
 import io.github.droidkaigi.confsched2023.model.BuildConfigProvider
 import javax.inject.Singleton
 
@@ -15,6 +20,13 @@ class AppModule {
  @Singleton
  @AppAndroidBuildConfig
  fun provideBuildConfigProvider(): BuildConfigProvider = AppBuildConfigProvider()
+
+ @Provides
+ @Singleton
+ @AppAndroidOssLicenseConfig
+ fun provideOssLicenseDataSourceProvider(
+ @ApplicationContext context: Context,
+ ): OssLicenseDataSource = DefaultOssLicenseDataSource(context)
 }
 
 class AppBuildConfigProvider(

app-android/src/main/java/io/github/droidkaigi/confsched2023/KaigiApp.kt

@@ -31,7 +31,11 @@ import co.touchlab.kermit.Logger
 import com.google.android.gms.oss.licenses.OssLicensesMenuActivity
 import io.github.droidkaigi.confsched2023.about.aboutScreenRoute
 import io.github.droidkaigi.confsched2023.about.navigateAboutScreen
+import io.github.droidkaigi.confsched2023.about.navigateOssLicenseDetailScreen
+import io.github.droidkaigi.confsched2023.about.navigateOssLicenseScreen
 import io.github.droidkaigi.confsched2023.about.nestedAboutScreen
+import io.github.droidkaigi.confsched2023.about.ossLicenseDetailScreen
+import io.github.droidkaigi.confsched2023.about.ossLicenseScreen
 import io.github.droidkaigi.confsched2023.achievements.achievementsScreenRoute
 import io.github.droidkaigi.confsched2023.achievements.navigateAchievementsScreen
 import io.github.droidkaigi.confsched2023.achievements.nestedAchievementsScreen
@@ -125,6 +129,19 @@ private fun KaigiNavHost(
  onBackClick = navController::popBackStack,
  onStaffClick = externalNavController::navigate,
  )
+ ossLicenseScreen(
+ onLicenseClick = { license ->
+ navController.navigateOssLicenseDetailScreen(license)
+ },
+ onUpClick = {
+ navController.navigateUp()
+ },
+ )
+ ossLicenseDetailScreen(
+ onUpClick = {
+ navController.navigateUp()
+ },
+ )
  // For KMP, we are not using navigation abstraction for contributors screen
  composable(contributorsScreenRoute) {
  val lifecycleOwner = LocalLifecycleOwner.current
@@ -171,7 +188,7 @@ private fun NavGraphBuilder.mainScreen(
  Sponsors -> navController.navigateSponsorsScreen()
  CodeOfConduct -> { externalNavController.navigate(url = "$portalBaseUrl/about/code-of-conduct") }
  Contributors -> navController.navigate(contributorsScreenRoute)
- License -> externalNavController.navigateToLicenseScreen()
+ License -> navController.navigateOssLicenseScreen()
  Medium -> externalNavController.navigate(url = "https://medium.com/droidkaigi")
  PrivacyPolicy -> {
  externalNavController.navigate(url = "$portalBaseUrl/about/privacy")

app-android/src/main/java/io/github/droidkaigi/confsched2023/license/DefaultOssLicenseDataSource.kt

@@ -0,0 +1,102 @@
+package io.github.droidkaigi.confsched2023.license
+
+import android.content.Context
+import io.github.droidkaigi.confsched2023.R
+import io.github.droidkaigi.confsched2023.data.osslicense.OssLicenseDataSource
+import io.github.droidkaigi.confsched2023.model.License
+import io.github.droidkaigi.confsched2023.model.OssLicenseGroup
+import io.github.droidkaigi.confsched2023.ui.Inject
+import kotlinx.collections.immutable.toPersistentList
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.withContext
+import okio.BufferedSource
+import okio.buffer
+import okio.source
+
+public class DefaultOssLicenseDataSource @Inject constructor(
+ private val context: Context,
+) : OssLicenseDataSource {
+
+ override suspend fun license(): List<OssLicenseGroup> {
+ return withContext(context = Dispatchers.IO) {
+ readLicenses()
+ .groupByCategory()
+ .map {
+ OssLicenseGroup(
+ title = it.key,
+ licenses = it.value,
+ )
+ }
+ .toPersistentList()
+ }
+ }
+
+ private fun readLicenses(): List<License> {
+ val licenseData = readLicensesFile().toRowList()
+ return readLicensesMetaFile().toRowList()
+ .map {
+ val (position, name) = it.split(' ', limit = 2)
+ val (offset, length) = position.split(':').map { it.toInt() }
+
+ val id = name.replace(' ', '-')
+ val licensesText = kotlin.runCatching {
+ licenseData.subList(offset, offset + length).joinToString()
+ }.getOrNull() ?: ""
+
+ License(
+ id = id,
+ name = name,
+ licensesText = licensesText,
+ )
+ }
+ .distinctBy { it.id }
+ }
+
+ private fun List<License>.groupByCategory(): Map<String, List<License>> {
+ val categoryList = listOf(
+ "Android Support",
+ "Android Datastore",
+ "Android ",
+ "Compose UI",
+ "Compose Material3",
+ "Compose ",
+ "AndroidX lifecycle",
+ "AndroidX ",
+ "Kotlin",
+ "Dagger",
+ "Firebase",
+ "Ktorfit",
+ "okhttp",
+ "ktor",
+ )
+ return groupBy { license ->
+ categoryList.firstOrNull {
+ license.name.startsWith(
+ prefix = it,
+ ignoreCase = true,
+ )
+ } ?: "etc"
+ }
+ }
+
+ private fun readLicensesMetaFile(): BufferedSource {
+ return context.resources.openRawResource(R.raw.third_party_license_metadata)
+ .source()
+ .buffer()
+ }
+
+ private fun readLicensesFile(): BufferedSource {
+ return context.resources.openRawResource(R.raw.third_party_licenses)
+ .source()
+ .buffer()
+ }
+
+ private fun BufferedSource.toRowList(): List<String> {
+ val list: MutableList<String> = mutableListOf()
+ while (true) {
+ val line = readUtf8Line() ?: break
+ list.add(line)
+ }
+ return list
+ }
+}

core/data/src/androidMain/kotlin/io/github/droidkaigi/confsched2023/data/di/BuildConfigProviderModule.kt

@@ -5,14 +5,22 @@ import dagger.Module
 import dagger.Provides
 import dagger.hilt.InstallIn
 import dagger.hilt.components.SingletonComponent
+import io.github.droidkaigi.confsched2023.data.osslicense.OssLicenseDataSource
 import io.github.droidkaigi.confsched2023.model.BuildConfigProvider
+import io.github.droidkaigi.confsched2023.model.License
+import io.github.droidkaigi.confsched2023.model.OssLicenseGroup
+import kotlinx.collections.immutable.PersistentList
+import kotlinx.collections.immutable.persistentListOf
 import java.util.Optional
 import javax.inject.Qualifier
 import javax.inject.Singleton
 
 @Qualifier
 public annotation class AppAndroidBuildConfig
 
+@Qualifier
+public annotation class AppAndroidOssLicenseConfig
+
 @Module
 @InstallIn(SingletonComponent::class)
 public class BuildConfigProviderModule {
@@ -25,6 +33,16 @@ public class BuildConfigProviderModule {
  } else {
  EmptyBuildConfigProvider
  }
+
+ @Provides
+ @Singleton
+ public fun provideOssLicenseRepositoryProvider(
+ @AppAndroidOssLicenseConfig ossLicenseDataSourceOptional: Optional<OssLicenseDataSource>,
+ ): OssLicenseDataSource = if (ossLicenseDataSourceOptional.isPresent) {
+ ossLicenseDataSourceOptional.get()
+ } else {
+ EmptyOssLicenseDataSource
+ }
 }
 
 @InstallIn(SingletonComponent::class)
@@ -35,7 +53,32 @@ public abstract class AppAndroidBuildConfigModule {
  public abstract fun bindBuildConfigProvider(): BuildConfigProvider
 }
 
+@InstallIn(SingletonComponent::class)
+@Module
+public abstract class AppAndroidOssLicenseModule {
+ @BindsOptionalOf
+ @AppAndroidOssLicenseConfig
+ public abstract fun bindOssLicenseDataStoreProvider(): OssLicenseDataSource
+}
+
 private object EmptyBuildConfigProvider : BuildConfigProvider {
  override val versionName: String = ""
  override val debugBuild: Boolean = false
 }
+
+private object EmptyOssLicenseDataSource : OssLicenseDataSource {
+ override suspend fun license(): PersistentList<OssLicenseGroup> {
+ return persistentListOf(
+ OssLicenseGroup(
+ "dummy",
+ listOf(
+ License(
+ "id",
+ "name",
+ "license text",
+ ),
+ ),
+ ),
+ )
+ }
+}

core/data/src/androidMain/kotlin/io/github/droidkaigi/confsched2023/data/osslicense/OssLicenseRepositoryModule.kt

@@ -0,0 +1,22 @@
+package io.github.droidkaigi.confsched2023.data.osslicense
+
+import dagger.Module
+import dagger.Provides
+import dagger.hilt.InstallIn
+import dagger.hilt.components.SingletonComponent
+import io.github.droidkaigi.confsched2023.model.OssLicenseRepository
+import javax.inject.Singleton
+
+@Module
+@InstallIn(SingletonComponent::class)
+public class OssLicenseRepositoryModule {
+ @Provides
+ @Singleton
+ public fun provideOssLicenseRepository(
+ ossLicenseDataSource: OssLicenseDataSource,
+ ): OssLicenseRepository {
+ return DefaultOssLicenseRepository(
+ ossLicenseDataSource,
+ )
+ }
+}

core/data/src/commonMain/kotlin/io/github/droidkaigi/confsched2023/data/osslicense/DefaultOssLicenseRepository.kt

@@ -0,0 +1,26 @@
+package io.github.droidkaigi.confsched2023.data.osslicense
+
+import io.github.droidkaigi.confsched2023.model.OssLicenseGroup
+import io.github.droidkaigi.confsched2023.model.OssLicenseRepository
+import io.github.droidkaigi.confsched2023.ui.Inject
+import kotlinx.collections.immutable.PersistentList
+import kotlinx.collections.immutable.persistentListOf
+import kotlinx.collections.immutable.toPersistentList
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.onStart
+
+public class DefaultOssLicenseRepository @Inject constructor(
+ private val ossLicenseDataSource: OssLicenseDataSource,
+) : OssLicenseRepository {
+
+ private val ossLicenseStateFlow =
+ MutableStateFlow<PersistentList<OssLicenseGroup>>(persistentListOf())
+
+ override fun licenseData(): Flow<PersistentList<OssLicenseGroup>> {
+ return ossLicenseStateFlow.onStart {
+ val ossLicenseData = ossLicenseDataSource.license().toPersistentList()
+ ossLicenseStateFlow.emit(ossLicenseData)
+ }
+ }
+}

core/data/src/commonMain/kotlin/io/github/droidkaigi/confsched2023/data/osslicense/OssLicenseDataSource.kt

@@ -0,0 +1,7 @@
+package io.github.droidkaigi.confsched2023.data.osslicense
+
+import io.github.droidkaigi.confsched2023.model.OssLicenseGroup
+
+public interface OssLicenseDataSource {
+ public suspend fun license(): List<OssLicenseGroup>
+}

core/model/src/commonMain/kotlin/io/github/droidkaigi/confsched2023/model/License.kt

@@ -0,0 +1,12 @@
+package io.github.droidkaigi.confsched2023.model
+
+data class License(
+ val id: String,
+ val name: String,
+ val licensesText: String,
+)
+
+data class OssLicenseGroup(
+ val title: String,
+ val licenses: List<License>,
+)

core/model/src/commonMain/kotlin/io/github/droidkaigi/confsched2023/model/OssLicenseRepository.kt

@@ -0,0 +1,8 @@
+package io.github.droidkaigi.confsched2023.model
+
+import kotlinx.collections.immutable.PersistentList
+import kotlinx.coroutines.flow.Flow
+
+public interface OssLicenseRepository {
+ public fun licenseData(): Flow<PersistentList<OssLicenseGroup>>
+}

core/testing/src/main/java/io/github/droidkaigi/confsched2023/testing/robot/OssLicenseDetailScreenRobot.kt

@@ -0,0 +1,49 @@
+package io.github.droidkaigi.confsched2023.testing.robot
+
+import androidx.compose.ui.test.isRoot
+import androidx.compose.ui.test.junit4.AndroidComposeTestRule
+import com.github.takahirom.roborazzi.captureRoboImage
+import io.github.droidkaigi.confsched2023.about.OssLicenseDetailScreen
+import io.github.droidkaigi.confsched2023.designsystem.theme.KaigiTheme
+import io.github.droidkaigi.confsched2023.testing.RobotTestRule
+import io.github.droidkaigi.confsched2023.testing.coroutines.runTestWithLogging
+import kotlinx.coroutines.test.TestDispatcher
+import javax.inject.Inject
+import kotlin.time.Duration.Companion.seconds
+
+class OssLicenseDetailScreenRobot @Inject constructor(
+ private val testDispatcher: TestDispatcher,
+) {
+ @Inject lateinit var robotTestRule: RobotTestRule
+ private lateinit var composeTestRule: AndroidComposeTestRule<*, *>
+ operator fun invoke(
+ block: OssLicenseDetailScreenRobot.() -> Unit,
+ ) {
+ runTestWithLogging(timeout = 30.seconds) {
+ [email protected] = robotTestRule.composeTestRule
+ block()
+ }
+ }
+
+ fun setupOssLicenseDetailScreenContent() {
+ composeTestRule.setContent {
+ KaigiTheme {
+ OssLicenseDetailScreen(
+ onUpClick = {},
+ )
+ }
+ }
+ waitUntilIdle()
+ }
+
+ fun checkScreenCapture() {
+ composeTestRule
+ .onNode(isRoot())
+ .captureRoboImage()
+ }
+
+ fun waitUntilIdle() {
+ composeTestRule.waitForIdle()
+ testDispatcher.scheduler.advanceUntilIdle()
+ }
+}