After the device is manually powered off and on multiple times, an "Unable to parse preferences proto" error appears. [345367390]

Duplicate

of 346197747

Bug

Status Update

No update yet.

Description

yu...@gmail.com

created issue #1

Jun 6, 2024 10:04AM

DataStore Component used: androidx.datastore:datastore-preferences DataStore Version used: 1.1.0-beta02和1.1.1 Devices/Android versions reproduced on: Android 7.1

This is the error log:

2024-06-06 13:49:16.406 System.err            W  androidx.datastore.core.CorruptionException: Unable to parse preferences proto.
2024-06-06 13:49:16.407 System.err            W  	at androidx.datastore.preferences.PreferencesMapCompat$Companion.readFrom(PreferencesMapCompat.kt:34)
2024-06-06 13:49:16.407 System.err            W  	at androidx.datastore.preferences.core.PreferencesSerializer.readFrom(PreferencesSerializer.jvm.kt:46)
2024-06-06 13:49:16.408 System.err            W  	at androidx.datastore.core.okio.OkioReadScope.readData$suspendImpl(OkioStorage.kt:180)
2024-06-06 13:49:16.408 System.err            W  	at androidx.datastore.core.okio.OkioReadScope.readData(OkioStorage.kt)
2024-06-06 13:49:16.408 System.err            W  	at androidx.datastore.core.StorageConnectionKt$readData$2.invokeSuspend(StorageConnection.kt:74)
2024-06-06 13:49:16.408 System.err            W  	at androidx.datastore.core.StorageConnectionKt$readData$2.invoke(StorageConnection.kt)
2024-06-06 13:49:16.408 System.err            W  	at androidx.datastore.core.StorageConnectionKt$readData$2.invoke(StorageConnection.kt)
2024-06-06 13:49:16.408 System.err            W  	at androidx.datastore.core.okio.OkioStorageConnection.readScope(OkioStorage.kt:113)
2024-06-06 13:49:16.408 System.err            W  	at androidx.datastore.core.StorageConnectionKt.readData(StorageConnection.kt:74)
2024-06-06 13:49:16.409 System.err            W  	at androidx.datastore.core.DataStoreImpl.readDataFromFileOrDefault(DataStoreImpl.kt:331)
2024-06-06 13:49:16.409 System.err            W  	at androidx.datastore.core.DataStoreImpl.readDataOrHandleCorruption(DataStoreImpl.kt:373)
2024-06-06 13:49:16.409 System.err            W  	at androidx.datastore.core.DataStoreImpl.access$readDataOrHandleCorruption(DataStoreImpl.kt:53)
2024-06-06 13:49:16.409 System.err            W  	at androidx.datastore.core.DataStoreImpl$InitDataStore$doRun$initData$1.invokeSuspend(DataStoreImpl.kt:445)
2024-06-06 13:49:16.409 System.err            W  	at androidx.datastore.core.DataStoreImpl$InitDataStore$doRun$initData$1.invoke(DataStoreImpl.kt)
2024-06-06 13:49:16.409 System.err            W  	at androidx.datastore.core.DataStoreImpl$InitDataStore$doRun$initData$1.invoke(DataStoreImpl.kt)
2024-06-06 13:49:16.409 System.err            W  	at androidx.datastore.core.SingleProcessCoordinator.lock(SingleProcessCoordinator.kt:41)
2024-06-06 13:49:16.410 System.err            W  	at androidx.datastore.core.DataStoreImpl$InitDataStore.doRun(DataStoreImpl.kt:442)
2024-06-06 13:49:16.410 System.err            W  	at androidx.datastore.core.RunOnce.runIfNeeded(DataStoreImpl.kt:505)
2024-06-06 13:49:16.410 System.err            W  	at androidx.datastore.core.DataStoreImpl.readAndInitOrPropagateAndThrowFailure(DataStoreImpl.kt:274)
2024-06-06 13:49:16.410 System.err            W  	at androidx.datastore.core.DataStoreImpl.access$readAndInitOrPropagateAndThrowFailure(DataStoreImpl.kt:53)
2024-06-06 13:49:16.410 System.err            W  	at androidx.datastore.core.DataStoreImpl$readState$2.invokeSuspend(DataStoreImpl.kt:226)
2024-06-06 13:49:16.410 System.err            W  	at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)
2024-06-06 13:49:16.410 System.err            W  	at kotlinx.coroutines.DispatchedTask.run(DispatchedTask.kt:108)
2024-06-06 13:49:16.410 System.err            W  	at kotlinx.coroutines.internal.LimitedDispatcher$Worker.run(LimitedDispatcher.kt:115)
2024-06-06 13:49:16.411 System.err            W  	at kotlinx.coroutines.scheduling.TaskImpl.run(Tasks.kt:103)
2024-06-06 13:49:16.411 System.err            W  	at kotlinx.coroutines.scheduling.CoroutineScheduler.runSafely(CoroutineScheduler.kt:584)
2024-06-06 13:49:16.411 System.err            W  	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.executeTask(CoroutineScheduler.kt:793)
2024-06-06 13:49:16.411 System.err            W  	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.runWorker(CoroutineScheduler.kt:697)
2024-06-06 13:49:16.411 System.err            W  	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.run(CoroutineScheduler.kt:684)
2024-06-06 13:49:16.412 System.err            W  Caused by: androidx.datastore.preferences.protobuf.InvalidProtocolBufferException: Protocol message contained an invalid tag (zero).
2024-06-06 13:49:16.412 System.err            W  	at androidx.datastore.preferences.protobuf.CodedInputStream$StreamDecoder.readTag(CodedInputStream.java:2107)
2024-06-06 13:49:16.412 System.err            W  	at androidx.datastore.preferences.protobuf.CodedInputStreamReader.getFieldNumber(CodedInputStreamReader.java:82)
2024-06-06 13:49:16.412 System.err            W  	at androidx.datastore.preferences.protobuf.MessageSchema.mergeFromHelper(MessageSchema.java:3913)
2024-06-06 13:49:16.413 System.err            W  	at androidx.datastore.preferences.protobuf.MessageSchema.mergeFrom(MessageSchema.java:3895)
2024-06-06 13:49:16.413 System.err            W  	at androidx.datastore.preferences.protobuf.GeneratedMessageLite.parsePartialFrom(GeneratedMessageLite.java:1648)
2024-06-06 13:49:16.413 System.err            W  	at androidx.datastore.preferences.protobuf.GeneratedMessageLite.parseFrom(GeneratedMessageLite.java:1784)
2024-06-06 13:49:16.413 System.err            W  	at androidx.datastore.preferences.PreferencesProto$PreferenceMap.parseFrom(PreferencesProto.java:196)
2024-06-06 13:49:16.413 System.err            W  	at androidx.datastore.preferences.PreferencesMapCompat$Companion.readFrom(PreferencesMapCompat.kt:32)
2024-06-06 13:49:16.413 System.err            W  	... 28 more
2024-06-06 13:49:16.414 System.err            W  java.util.NoSuchElementException: Expected at least one element
2024-06-06 13:49:16.414 System.err            W  	at kotlinx.coroutines.flow.FlowKt__ReduceKt.first(Reduce.kt:96)
2024-06-06 13:49:16.414 System.err            W  	at kotlinx.coroutines.flow.FlowKt.first(Unknown Source)
2024-06-06 13:49:16.414 System.err            W  	at kotlinx.coroutines.flow.FlowKt__ReduceKt$first$1.invokeSuspend(Reduce.kt)
2024-06-06 13:49:16.414 System.err            W  	at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)
2024-06-06 13:49:16.414 System.err            W  	at kotlinx.coroutines.DispatchedTask.run(DispatchedTask.kt:106)
2024-06-06 13:49:16.415 System.err            W  	at kotlinx.coroutines.scheduling.CoroutineScheduler.runSafely(CoroutineScheduler.kt:584)
2024-06-06 13:49:16.415 System.err            W  	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.executeTask(CoroutineScheduler.kt:793)
2024-06-06 13:49:16.415 System.err            W  	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.runWorker(CoroutineScheduler.kt:697)
2024-06-06 13:49:16.415 System.err            W  	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.run(CoroutineScheduler.kt:684)

My app is using DataStore to store user information. When I start the app, I read user_info and display the logged in and unlogged in status in the UI. Here is my UserRepository related code:

val Context.userDataStore by preferencesDataStore("user_info")

class UserRepository(context: Context) {

    private val dataStore = context.userDataStore

    private object PreferencesKeys {

        var EMAIL = stringPreferencesKey("email")

        var PICTURE = stringPreferencesKey("picture")

        var NAME = stringPreferencesKey("name")

        var BIRTHDAY = stringPreferencesKey("birthday")

        var COUNTRY_CODE = stringPreferencesKey("country_code")

    }

    val userInfoFlow: Flow<UserInfo?> = dataStore.data.catch {
        emptyPreferences()
        it.printStackTrace()
    }.map {
        val email = it[PreferencesKeys.EMAIL]
        if (email == null) {
            null
        } else {
            UserInfo(
                it[PreferencesKeys.BIRTHDAY] ?: "",
                it[PreferencesKeys.COUNTRY_CODE] ?: "",
                email,
                it[PreferencesKeys.NAME] ?: "N/A",
                it[PreferencesKeys.PICTURE] ?: "",
            )
        }
    }

    suspend fun save(userInfo: UserInfo) {
        dataStore.edit {
            it[PreferencesKeys.BIRTHDAY] = userInfo.birthday
            it[PreferencesKeys.COUNTRY_CODE] = userInfo.countryCode
            it[PreferencesKeys.EMAIL] = userInfo.email
            it[PreferencesKeys.NAME] = userInfo.name
            it[PreferencesKeys.PICTURE] = userInfo.picture
        }
    }

    suspend fun clear() {
        dataStore.edit {
            it.clear()
        }
    }

}

The UserRepository class is used in two places in the whole project. The first is to execute a one-time Worker task when starting the app, and the second is to display the avatar when the side menu is displayed to determine if there is a login. The following is the relevant code:

Execute a one-time Worker task-related code when starting the app

class SyncUserInfoWorker(context: Context, params: WorkerParameters) :
    CoroutineWorker(context, params) {

    private val api = /*****/

    private val userRepository = UserRepository(applicationContext)

    override suspend fun doWork(): Result {
        return try {
            val currentUserInfo = userRepository.userInfoFlow.first()
            if (currentUserInfo != null) {
                val userInfo = api.getUserProfile()
                userRepository.save(userInfo)
                Result.success()
            } else {
                Result.failure()
            }
        } catch (e: Exception) {
            e.printStackTrace()
            Result.failure()
        }
    }

}

DrawerLayout menu related code:

class MainViewModel(application: Application) : AndroidViewModel(application) {

    val repository = UserRepository(application.applicationContext)

    val drawerItems = repository.userInfoFlow.map {
        if (it != null) {
            ArrayList<DrawerListItem>().apply {
                add(DrawerListItem.UserInfo(it.picture, it.name))
                add(DrawerListItem.Home(R.drawable.ic_home, R.string.Home))
                add(DrawerListItem.History(R.drawable.ic_history, R.string.Training_History))
                add(DrawerListItem.Settings(R.drawable.ic_setting, R.string.Setting))
            }
        } else {
            ArrayList<DrawerListItem>().apply {
                add(DrawerListItem.NotLogin(R.drawable.ic_user_photo, R.string.Not_logged_in))
                add(DrawerListItem.Home(R.drawable.ic_home, R.string.Home))
                add(DrawerListItem.Settings(R.drawable.ic_setting, R.string.Setting))
            }
        }
    }.asLiveData()

}

An error occurred when executing the Worker code. The repository.userInfoFlow.map code was not executed, resulting in the drawerItems list returning an empty list and the UI not being displayed. This problem is a very serious error in my app😭

When I saw the error log, I tried to use ReplaceFileCorruptionHandler to handle this problem and modified the code as follows:

val Context.userDataStore by preferencesDataStore("user_info",
    corruptionHandler = ReplaceFileCorruptionHandler { corruptionException ->
        corruptionException.printStackTrace()
        return@ReplaceFileCorruptionHandler emptyPreferences()
    })

This makes my drawerItems no longer an empty list, and repository.userInfoFlow.map is also executed normally, but the data stored in user_info is lost. Currently, this problem only occurs on devices with RK3368 chips. I don’t know if it is related to a DataStore storage data loss that I reported before. It is difficult for me to tell whether it is a problem with RK3368 or DataStore. I come here to seek a solution🙏

Comments

el...@google.com <el...@google.com> #2Feb 20, 2025 05:12PM

The root cause for this is

https://youtrack.jetbrains.com/issue/KT-32031

el...@google.com <el...@google.com> #3Feb 20, 2025 05:17PM

Status: Duplicate of

346197747

This is now fixed by Change-Id: I0ba284f52e62015af95aff8c5e83539b5a888e81 ; the fix will go out in 4.0 Canary 8. Thanks for the report!

Message last modified on Feb 20, 2025 05:20PM

Issue 345367390

Description

Issue summary

Comments

el...@google.com <el...@google.com> #2Feb 20, 2025 05:12PM

el...@google.com <el...@google.com> #3Feb 20, 2025 05:17PM

Add comment

Issue metadata