App preferences migration (#93)

* adopt DataStore for preference storage, create migration utility for V1 to V2 settings migrations

* orchestrate cleaning up v1 settings during migration, roll the device token

* enable installer creation for vnext-kmp PRs

* introduce file based logging to detect migration issues

* make it possible to access logs and data folders in Settings

* change package name to "pretixSCAN Desktop" for Windows

* Update publish pipeline to new package names

---------

Co-authored-by: Martin Gross <[email protected]>

Author: kkostov

.github/workflows/publish.yml

@@ -7,6 +7,7 @@ on:
       - master
       - main
       - update-tornadofx
+      - vnext-kmp
 
 # prevent duplicate runs on the same branch
 concurrency:
@@ -36,7 +37,8 @@ jobs:
 
       - name: Package App
         working-directory: ./pretixscan
-        run: ./gradlew packageDistributionForCurrentOS
+        shell: bash
+        run: ./gradlew packageDistributionForCurrentOS -PappPackageName="${{ runner.os == 'Windows' && 'pretixSCAN Desktop' || 'pretixSCAN' }}"
 
       - name: Read version
         working-directory: ./pretixscan
@@ -55,7 +57,7 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: pretixSCAN-${{ env.pretixVersion }}-win-x86_64.msi
-          path: ./pretixscan/composeApp/build/compose/binaries/main/msi/pretixSCAN-${{ env.pretixVersion }}.msi
+          path: ./pretixscan/composeApp/build/compose/binaries/main/msi/pretixSCAN Desktop-${{ env.pretixVersion }}.msi
 
       - name: Upload Linux amd64
         if: matrix.os == 'ubuntu-latest'

pretixscan/.gitignore

@@ -0,0 +1 @@
+composeApp/*.preferences_pb

pretixscan/README.md

@@ -35,7 +35,7 @@ KMP provides for various native distributions to be created, please refer to the
 For example, create a distribution package for the current OS:
 
 ```bash
-./gradlew packageDistributionForCurrentOS
+./gradlew packageDistributionForCurrentOS -PappPackageName="pretixSCAN"
 ```
 
 By default, packages are created under `pretixscan/composeApp/build/compose/binaries`.

pretixscan/composeApp/build.gradle.kts

@@ -37,6 +37,9 @@ kotlin {
             implementation(libs.vanniktech.multiplatform.locale)
             implementation(libs.kotlinx.serialization.json)
 
+            api(libs.datastore.core)
+            api(libs.datastore.preferences)
+
             // play short audio files
             implementation(libs.gadulka)
 
@@ -150,8 +153,12 @@ compose.desktop {
         mainClass = "eu.pretix.desktop.MainKt"
 
         nativeDistributions {
+            // On Windows, we need the packageName to be set as 'pretixSCAN Desktop' in order to avoid a conflict with v1
+
+            val packageNameValue = findProperty("appPackageName")?.toString() ?: "pretixSCAN-default"
+
             targetFormats(TargetFormat.Dmg, TargetFormat.Msi, TargetFormat.Deb)
-            packageName = "pretixSCAN"
+            packageName = packageNameValue
             packageVersion = version
             vendor = "pretix GmbH"
             copyright = "pretix.eu, Raphael Michel"
@@ -164,23 +171,34 @@ compose.desktop {
             macOS {
                 iconFile.set(File("logo/pretix_app_icon.icns"))
             }
+
             windows {
                 iconFile.set(File("logo/pretix_app_icon.ico"))
 
                 // MSI specific configuration
                 console = false
                 dirChooser = true
                 perUserInstall = false
-                menuGroup = "pretixSCAN"
+                menuGroup = "pretixSCAN Desktop"
                 shortcut = true
 
                 // Upgrade settings - consistent UUID for upgrade support
                 upgradeUuid = "550e8400-e29b-41d4-a716-446655440000"
 
             }
+
             linux {
                 iconFile.set(File("logo/pretix_app_icon.png"))
             }
         }
     }
+}
+
+// Validate packageName is provided for packaging tasks
+tasks.matching { it.name.contains("package", ignoreCase = true) }.configureEach {
+    doFirst {
+        if (findProperty("appPackageName") == null) {
+            throw GradleException("Package name must be provided via -PappPackageName=<name> for packaging tasks")
+        }
+    }
 }

pretixscan/composeApp/src/commonMain/composeResources/values/strings.xml

@@ -9,8 +9,10 @@
     <string name="progress_registering">Registering device with server…</string>
     <string name="error_access_revoked">Device access has been revoked, you need to register the device with the server again.</string>
     <string name="error_unknown_exception">An unknown error has occurred</string>
+    <string name="error_connecting_token">Connection Error</string>
     <string name="error_not_synchronized">Your device has not been properly synchronized with the server</string>
     <string name="action_label_ok">OK</string>
+    <string name="action_label_back">Back</string>
     <string name="action_label_settings">Settings</string>
     <string name="action_label_statistics">Statistics</string>
     <string name="action_label_scantype_entry">Switch to entry scanning</string>
@@ -47,12 +49,12 @@
     <string name="settings_label_auto_switch">Automatic event selection</string>
     <string name="settings_summary_auto_switch">With this option, pretixSCAN will ask the server during synchronization if the server suggests switching the app to a different event and check-in list and then switches automatically.</string>
     <plurals name="sync_status_time_minutes">
-        <item quantity="one">synchronized %d minute ago</item>
-        <item quantity="other">synchronized %d minutes ago</item>
+        <item quantity="one">synchronized %1$d minute ago</item>
+        <item quantity="other">synchronized %1$d minutes ago</item>
     </plurals>
     <plurals name="sync_status_time_hours">
-        <item quantity="one">synchronized %d hour ago</item>
-        <item quantity="other">synchronized %d hours ago</item>
+        <item quantity="one">synchronized %1$d hour ago</item>
+        <item quantity="other">synchronized %1$d hours ago</item>
     </plurals>
     <plurals name="sync_status_time_days">
         <item quantity="one">synchronized %1$d day ago</item>
@@ -95,6 +97,7 @@
     <string name="settings_label_sync">Synchronization</string>
     <string name="settings_label_ui">User interface</string>
     <string name="settings_label_about">About this app</string>
+    <string name="settings_label_diagnostics">Diagnostics</string>
     <string name="settings_label_licenses">Author and licenses</string>
     <string name="settings_label_device_camera">Use device camera</string>
     <string name="settings_label_scan_offline">Offline scanning</string>
@@ -169,6 +172,8 @@
     <string name="full_delete">Delete all local data and reset device</string>
     <string name="full_delete_confirm">Do you really want to reset the device? You will need to pair it with the online system again.</string>
     <string name="full_delete_action">Logout and reset</string>
+    <string name="open_data_folder_action">Open data folder</string>
+    <string name="open_logs_folder_action">Open logs folder</string>
     <string name="label_shop_active">Active</string>
     <string name="label_shop_inactive">Shop deactivated</string>
     <string name="settings_label_search_disable">Disable search</string>

pretixscan/composeApp/src/commonMain/kotlin/eu/pretix/KoinModules.kt

@@ -3,6 +3,7 @@ package eu.pretix
 import di.platformModules
 import eu.pretix.desktop.app.sync.syncModule
 import eu.pretix.desktop.cache.di.cacheModules
+import eu.pretix.desktop.migration.di.migrationModule
 import eu.pretix.desktop.webcam.webCamModule
 import eu.pretix.scan.main.mainModule
 import eu.pretix.scan.settings.settingsModule
@@ -14,6 +15,7 @@ import org.koin.core.KoinApplication
 fun KoinApplication.initModules() {
     modules(platformModules)
     modules(cacheModules)
+    modules(migrationModule)
     modules(pretixModules)
     modules(ticketsModule)
     modules(syncModule)

pretixscan/composeApp/src/commonMain/kotlin/eu/pretix/PretixModules.kt

@@ -2,7 +2,7 @@ package eu.pretix
 
 import eu.pretix.desktop.app.DesktopSentryImpl
 import eu.pretix.desktop.cache.AppCache
-import eu.pretix.desktop.cache.AppConfig
+import eu.pretix.desktop.cache.DataStoreConfigStore
 import eu.pretix.libpretixsync.SentryInterface
 import eu.pretix.libpretixsync.api.HttpClientFactory
 import eu.pretix.libpretixsync.api.PretixApi
@@ -15,6 +15,9 @@ import eu.pretix.libpretixsync.sync.FileStorage
 import eu.pretix.scan.tickets.data.PrintLayoutFetcher
 import org.koin.core.module.Module
 import org.koin.dsl.module
+import java.util.logging.Logger
+
+private val log = Logger.getLogger("PretixModules")
 
 
 val pretixModules: List<Module>
@@ -24,10 +27,10 @@ val pretixModules: List<Module>
                 DesktopSentryImpl()
             }
             factory<EventManager> {
-                EventManager(get<PretixApi>(), get<AppConfig>(), false)
+                EventManager(get<PretixApi>(), get<DataStoreConfigStore>(), false)
             }
             factory<PretixApi> {
-                val config = get<AppConfig>()
+                val config = get<DataStoreConfigStore>()
                 if (!config.isConfigured) {
                     throw UnsupportedOperationException("Invalid operation: PretixApi can only be used once the device has been initialised using SetupManager.")
                 }
@@ -40,21 +43,21 @@ val pretixModules: List<Module>
                 )
             }
             factory<TicketCheckProvider> {
-                val config = get<AppConfig>()
+                val config = get<DataStoreConfigStore>()
                 if (!config.isConfigured) {
                     throw UnsupportedOperationException("Invalid operation: TicketCheckProvider can only be used once the device has been initialised.")
                 }
 
                 val appCache = get<AppCache>()
 
                 if (config.proxyMode) {
-                    println("Resolving TicketCheckProvider in proxy mode")
+                    log.info("Resolving TicketCheckProvider in proxy mode")
                     ProxyCheckProvider(config, get<HttpClientFactory>())
                 } else if (config.offlineMode) {
-                    println("Resolving TicketCheckProvider in offline mode")
+                    log.info("Resolving TicketCheckProvider in offline mode")
                     AsyncCheckProvider(config, appCache.db)
                 } else {
-                    println("Resolving TicketCheckProvider in online mode")
+                    log.info("Resolving TicketCheckProvider in online mode")
                     OnlineCheckProvider(
                         config,
                         get<HttpClientFactory>(),

pretixscan/composeApp/src/commonMain/kotlin/eu/pretix/desktop/app/navigation/Navigation.kt

@@ -3,14 +3,14 @@ package eu.pretix.desktop.app.navigation
 import androidx.compose.animation.fadeIn
 import androidx.compose.animation.fadeOut
 import androidx.compose.foundation.layout.fillMaxSize
-import androidx.compose.runtime.Composable
+import androidx.compose.runtime.*
 import androidx.compose.ui.Modifier
 import androidx.navigation.NavHostController
 import androidx.navigation.compose.NavHost
 import androidx.navigation.compose.composable
 import eu.pretix.desktop.app.sync.SyncRoot
 import eu.pretix.desktop.app.ui.ScreenRoot
-import eu.pretix.desktop.cache.AppConfig
+import eu.pretix.desktop.cache.DataStoreConfigStore
 import eu.pretix.scan.main.presentation.MainScreen
 import eu.pretix.scan.settings.presentation.SettingsScreen
 import eu.pretix.scan.setup.SetupScreen
@@ -23,12 +23,10 @@ fun Navigation(
     navHostController: NavHostController,
     modifier: Modifier = Modifier,
 ) {
-    // determine the starting screen based on whether the app is configured or not
-    val appConfig = koinInject<AppConfig>()
+    val appConfig = koinInject<DataStoreConfigStore>()
     val startDestination: String = if (appConfig.isConfigured) Route.Main.route else Route.Welcome.route
 
     SyncRoot(navHostController) {
-        // setup navigation graph
         NavHost(
             navController = navHostController,
             startDestination = startDestination,

pretixscan/composeApp/src/commonMain/kotlin/eu/pretix/desktop/app/sync/SyncProgressPanel.kt renamed to pretixscan/composeApp/src/commonMain/kotlin/eu/pretix/desktop/app/sync/SyncProgressView.kt

@@ -83,7 +83,6 @@ fun SyncedTimeAgo(never: Boolean, daysAgo: Int, hoursAgo: Int, minutesAgo: Int)
         }
 
         statusHelper.isDaysAgo() -> {
-            println("days ago ${statusHelper.daysAgo()}")
             Text(
                 pluralStringResource(
                     Res.plurals.sync_status_time_days,

pretixscan/composeApp/src/commonMain/kotlin/eu/pretix/desktop/app/sync/SyncRoot.kt

@@ -36,7 +36,6 @@ fun SyncRoot(
     }
 
     val showMainSyncProgress by viewModel.showMainSyncProgress.collectAsState()
-    println("Current sync state: $syncState")
 
     Box(Modifier.fillMaxSize()) {
         // render child content