Do not duplicate BuildConfig fields in Const.kt

rocka · rocka · commit e2bf8dc230fd · 2024-01-22T23:45:22.000+08:00
diff --git a/app/src/main/java/org/fcitx/fcitx5/android/core/data/DataManager.kt b/app/src/main/java/org/fcitx/fcitx5/android/core/data/DataManager.kt
@@ -13,7 +13,6 @@ import kotlinx.serialization.encodeToString
 import kotlinx.serialization.json.Json
 import org.fcitx.fcitx5.android.BuildConfig
 import org.fcitx.fcitx5.android.core.data.DataManager.dataDir
-import org.fcitx.fcitx5.android.utils.Const
 import org.fcitx.fcitx5.android.utils.FileUtil
 import org.fcitx.fcitx5.android.utils.appContext
 import org.fcitx.fcitx5.android.utils.javaIdRegex
@@ -39,13 +38,13 @@ object DataManager {
     var synced = false
         private set
 
-    // should be consistent with the deserialization in build.gradle.kts (:app)
-    private fun deserializeDataDescriptor(raw: String) = runCatching {
-        json.decodeFromString<DataDescriptor>(raw)
+    // should be consistent with the deserialization in DataDescriptorPlugin (:build-logic)
+    private fun deserializeDataDescriptor(raw: String): DataDescriptor {
+        return json.decodeFromString<DataDescriptor>(raw)
     }
 
-    private fun serializeDataDescriptor(descriptor: DataDescriptor) = runCatching {
-        json.encodeToString(descriptor)
+    private fun serializeDataDescriptor(descriptor: DataDescriptor): String {
+        return json.encodeToString(descriptor)
     }
 
     // If Android version supports direct boot, we put the hierarchy in device encrypted storage
@@ -57,14 +56,12 @@ object DataManager {
         File(appContext.applicationInfo.dataDir)
     }
 
-    private val destDescriptorFile = File(dataDir, Const.dataDescriptorName)
-
-    private fun AssetManager.getDataDescriptor() =
-        open(Const.dataDescriptorName)
+    private fun AssetManager.getDataDescriptor(): DataDescriptor {
+        return open(BuildConfig.DATA_DESCRIPTOR_NAME)
             .bufferedReader()
             .use { it.readText() }
             .let { deserializeDataDescriptor(it) }
-            .getOrThrow()
+    }
 
     private val loadedPlugins = mutableSetOf<PluginDescriptor>()
     private val failedPlugins = mutableMapOf<String, PluginLoadFailed>()
@@ -102,6 +99,7 @@ object DataManager {
         // Parse plugin.xml
         for (packageName in pluginPackages) {
             val res = pm.getResourcesForApplication(packageName)
+
             @SuppressLint("DiscouragedApi")
             val resId = res.getIdentifier("plugin", "xml", packageName)
             if (resId == 0) {
@@ -201,24 +199,15 @@ object DataManager {
         loadedPlugins.clear()
         failedPlugins.clear()
 
+        val destDescriptorFile = File(dataDir, BuildConfig.DATA_DESCRIPTOR_NAME)
+
         // load last run's data descriptor
-        val oldDescriptor =
-            destDescriptorFile
-                .takeIf { it.exists() && it.isFile }
-                ?.runCatching { readText() }
-                ?.getOrNull()
-                ?.let { deserializeDataDescriptor(it) }
-                ?.getOrNull()
-                ?: DataDescriptor("", mapOf(), mapOf())
+        val oldDescriptor = destDescriptorFile
+            .runCatching { deserializeDataDescriptor(bufferedReader().use { it.readText() }) }
+            .getOrElse { DataDescriptor("", emptyMap(), emptyMap()) }
 
         // load app's data descriptor
-        val mainDescriptor =
-            appContext.assets
-                .open(Const.dataDescriptorName)
-                .bufferedReader()
-                .use { it.readText() }
-                .let { deserializeDataDescriptor(it) }
-                .getOrThrow()
+        val mainDescriptor = appContext.assets.getDataDescriptor()
 
         val (parsedDescriptors, failed) = detectPlugins()
         failedPlugins.putAll(failed)
@@ -290,13 +279,15 @@ object DataManager {
             }
         }
         // save the new hierarchy as the data descriptor to be used in the next run
-        destDescriptorFile.writeText(serializeDataDescriptor(newHierarchy.downToDataDescriptor()).getOrThrow())
+        destDescriptorFile.bufferedWriter().use {
+            it.write(serializeDataDescriptor(newHierarchy.downToDataDescriptor()))
+        }
         callbacks.forEach { it() }
         callbacks.clear()
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
             // remove old assets from credential encrypted storage
             val oldDataDir = appContext.dataDir
-            val oldDataDescriptor = oldDataDir.resolve(Const.dataDescriptorName)
+            val oldDataDescriptor = oldDataDir.resolve(BuildConfig.DATA_DESCRIPTOR_NAME)
             if (oldDataDescriptor.exists()) {
                 oldDataDescriptor.delete()
                 oldDataDir.resolve("README.md").delete()
@@ -324,7 +315,7 @@ object DataManager {
 
     fun deleteAndSync() {
         lock.withLock {
-            dataDir.resolve(Const.dataDescriptorName).delete()
+            dataDir.resolve(BuildConfig.DATA_DESCRIPTOR_NAME).delete()
             dataDir.resolve("README.md").delete()
             dataDir.resolve("usr").deleteRecursively()
         }
diff --git a/app/src/main/java/org/fcitx/fcitx5/android/core/data/PluginDescriptor.kt b/app/src/main/java/org/fcitx/fcitx5/android/core/data/PluginDescriptor.kt
@@ -4,8 +4,8 @@
  */
 package org.fcitx.fcitx5.android.core.data
 
+import org.fcitx.fcitx5.android.BuildConfig
 import org.fcitx.fcitx5.android.core.data.PluginDescriptor.Companion.pluginPackagePrefix
-import org.fcitx.fcitx5.android.utils.Const
 
 /**
  * Metadata of a plugin, at `res/xml/plugin.xml`
@@ -35,12 +35,11 @@ data class PluginDescriptor(
     val nativeLibraryDir: String,
     val libraryDependency: Map<String, List<String>>
 ) {
-    val name by lazy {
-        packageName.removePrefix("$pluginPackagePrefix.").removeSuffix(".${Const.buildType}")
-    }
+    val name = packageName.removePrefix(pluginPackagePrefix).removeSuffix(pluginPackageSuffix)
 
     companion object {
-        const val pluginPackagePrefix = "org.fcitx.fcitx5.android.plugin"
+        const val pluginPackagePrefix = "org.fcitx.fcitx5.android.plugin."
+        const val pluginPackageSuffix = ".${BuildConfig.BUILD_TYPE}"
         const val pluginAPI = "0.1"
     }
 }
diff --git a/app/src/main/java/org/fcitx/fcitx5/android/ui/main/AboutFragment.kt b/app/src/main/java/org/fcitx/fcitx5/android/ui/main/AboutFragment.kt
@@ -8,6 +8,7 @@ import android.content.Intent
 import android.net.Uri
 import android.os.Bundle
 import androidx.navigation.fragment.findNavController
+import org.fcitx.fcitx5.android.BuildConfig
 import org.fcitx.fcitx5.android.R
 import org.fcitx.fcitx5.android.ui.common.PaddingPreferenceFragment
 import org.fcitx.fcitx5.android.utils.Const
@@ -37,12 +38,12 @@ class AboutFragment : PaddingPreferenceFragment() {
             addCategory(R.string.version) {
                 isIconSpaceReserved = false
                 addPreference(R.string.current_version, Const.versionName)
-                addPreference(R.string.build_git_hash, Const.buildGitHash) {
-                    val commit = Const.buildGitHash.substringBefore('-')
+                addPreference(R.string.build_git_hash, BuildConfig.BUILD_GIT_HASH) {
+                    val commit = BuildConfig.BUILD_GIT_HASH.substringBefore('-')
                     val uri = Uri.parse("${Const.githubRepo}/commit/${commit}")
                     startActivity(Intent(Intent.ACTION_VIEW, uri))
                 }
-                addPreference(R.string.build_time, formatDateTime(Const.buildTime))
+                addPreference(R.string.build_time, formatDateTime(BuildConfig.BUILD_TIME))
             }
         }
     }
diff --git a/app/src/main/java/org/fcitx/fcitx5/android/utils/Const.kt b/app/src/main/java/org/fcitx/fcitx5/android/utils/Const.kt
@@ -7,14 +7,10 @@ package org.fcitx.fcitx5.android.utils
 import org.fcitx.fcitx5.android.BuildConfig
 
 object Const {
-    const val buildTime = BuildConfig.BUILD_TIME
-    const val buildGitHash = BuildConfig.BUILD_GIT_HASH
     const val versionName = "${BuildConfig.VERSION_NAME}-${BuildConfig.BUILD_TYPE}"
-    const val dataDescriptorName = BuildConfig.DATA_DESCRIPTOR_NAME
     const val githubRepo = "https://github.com/fcitx5-android/fcitx5-android"
     const val licenseSpdxId = "LGPL-2.1-or-later"
     const val licenseUrl = "https://www.gnu.org/licenses/old-licenses/lgpl-2.1"
     const val privacyPolicyUrl = "https://fcitx5-android.github.io/privacy/"
     const val faqUrl = "https://fcitx5-android.github.io/faq/"
-    const val buildType = BuildConfig.BUILD_TYPE
 }
diff --git a/app/src/main/java/org/fcitx/fcitx5/android/utils/DeviceInfo.kt b/app/src/main/java/org/fcitx/fcitx5/android/utils/DeviceInfo.kt
@@ -37,7 +37,7 @@ object DeviceInfo {
         appendLine("Package Name: ${BuildConfig.APPLICATION_ID}")
         appendLine("Version Code: ${BuildConfig.VERSION_CODE}")
         appendLine("Version Name: ${Const.versionName}")
-        appendLine("Build Time: ${iso8601UTCDateTime(Const.buildTime)}")
-        appendLine("Build Git Hash: ${Const.buildGitHash}")
+        appendLine("Build Time: ${iso8601UTCDateTime(BuildConfig.BUILD_TIME)}")
+        appendLine("Build Git Hash: ${BuildConfig.BUILD_GIT_HASH}")
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ import android.content.Intent`
`8`	`8`	`import android.net.Uri`
`9`	`9`	`import android.os.Bundle`
`10`	`10`	`import androidx.navigation.fragment.findNavController`
	`11`	`+import org.fcitx.fcitx5.android.BuildConfig`
`11`	`12`	`import org.fcitx.fcitx5.android.R`
`12`	`13`	`import org.fcitx.fcitx5.android.ui.common.PaddingPreferenceFragment`
`13`	`14`	`import org.fcitx.fcitx5.android.utils.Const`
`@@ -37,12 +38,12 @@ class AboutFragment : PaddingPreferenceFragment() {`
`37`	`38`	`addCategory(R.string.version) {`
`38`	`39`	`isIconSpaceReserved = false`
`39`	`40`	`addPreference(R.string.current_version, Const.versionName)`
`40`		`- addPreference(R.string.build_git_hash, Const.buildGitHash) {`
`41`		`- val commit = Const.buildGitHash.substringBefore('-')`
	`41`	`+ addPreference(R.string.build_git_hash, BuildConfig.BUILD_GIT_HASH) {`
	`42`	`+ val commit = BuildConfig.BUILD_GIT_HASH.substringBefore('-')`
`42`	`43`	`val uri = Uri.parse("${Const.githubRepo}/commit/${commit}")`
`43`	`44`	`startActivity(Intent(Intent.ACTION_VIEW, uri))`
`44`	`45`	`}`
`45`		`- addPreference(R.string.build_time, formatDateTime(Const.buildTime))`
	`46`	`+ addPreference(R.string.build_time, formatDateTime(BuildConfig.BUILD_TIME))`
`46`	`47`	`}`
`47`	`48`	`}`
`48`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ object DeviceInfo {`
`37`	`37`	`appendLine("Package Name: ${BuildConfig.APPLICATION_ID}")`
`38`	`38`	`appendLine("Version Code: ${BuildConfig.VERSION_CODE}")`
`39`	`39`	`appendLine("Version Name: ${Const.versionName}")`
`40`		`- appendLine("Build Time: ${iso8601UTCDateTime(Const.buildTime)}")`
`41`		`- appendLine("Build Git Hash: ${Const.buildGitHash}")`
	`40`	`+ appendLine("Build Time: ${iso8601UTCDateTime(BuildConfig.BUILD_TIME)}")`
	`41`	`+ appendLine("Build Git Hash: ${BuildConfig.BUILD_GIT_HASH}")`
`42`	`42`	`}`
`43`	`43`	`}`