IssueTracker

• DataStore Component used: androidx.datastore:datastore-preferences

• DataStore Version used: 1.1.1

• Devices/Android versions reproduced on:

  • Device: PAX A920Pro 2GB RAM
  • Android: 8.1.0

• If this is a bug in the library, we would appreciate if you could attach:

  • Sample project to trigger the issue -> Can't share the project.
  • A screenrecord or screenshots showing the issue (if UI related). -> Can't reproduce it, happens in some of our terminals, and after several weeks daily working with the same version.

The issue happened in an Android app, that is always in foreground, without the use of multiprocess (service with different PID), using a singleton of DataStore (provided with Hilt) and just one file, the only thing we did is use the normal read and write from multiple CoroutineScopes, not even that many or that continuously (the scope provided to the datastore instance creation was a new instance of CoroutineScope(SupervisorJob() + Dispatchers.IO + CoroutineExceptionHandler...) the CoroutineExceptionHandler just log the error)

We are using SingleProcessDataStore and were considering migrating to MultiProcessDataStore but it seems it won't solve anything since we only have one service, we are sure that service was not the issue, and has no PID manually assigned.

The issue (ommited data in log since is the same -> 11-06 08:30:15.784 1989 1989 E AndroidRuntime:):

Process: com.enterprise.product, PID: 1989
java.lang.RuntimeException: Unable to create application com.enterprise.product.App: androidx.datastore.core.CorruptionException: Unable to parse preferences proto.
	at android.app.ActivityThread.handleBindApplication(ActivityThread.java:5939)
	at android.app.ActivityThread.-wrap2(Unknown Source:0)
	at android.app.ActivityThread$H.handleMessage(ActivityThread.java:1720)
	at android.os.Handler.dispatchMessage(Handler.java:106)
	at android.os.Looper.loop(Looper.java:164)
	at android.app.ActivityThread.main(ActivityThread.java:6756)
	at java.lang.reflect.Method.invoke(Native Method)
	at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:449)
	at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:807)
Caused by: androidx.datastore.core.CorruptionException: Unable to parse preferences proto.
	at androidx.datastore.preferences.PreferencesMapCompat$Companion.readFrom(PreferencesMapCompat.kt:34)
	at androidx.datastore.preferences.core.PreferencesSerializer.readFrom(PreferencesSerializer.jvm.kt:46)
	at androidx.datastore.core.okio.OkioReadScope.readData$suspendImpl(OkioStorage.kt:180)
	at androidx.datastore.core.okio.OkioReadScope.readData(Unknown Source:0)
	at androidx.datastore.core.StorageConnectionKt$readData$2.invokeSuspend(StorageConnection.kt:74)
	at androidx.datastore.core.StorageConnectionKt$readData$2.invoke(Unknown Source:9)
	at androidx.datastore.core.StorageConnectionKt$readData$2.invoke(Unknown Source:10)
	at androidx.datastore.core.okio.OkioStorageConnection.readScope(OkioStorage.kt:113)
	at androidx.datastore.core.StorageConnectionKt.readData(StorageConnection.kt:74)
	at androidx.datastore.core.DataStoreImpl.readDataFromFileOrDefault(DataStoreImpl.kt:331)
	at androidx.datastore.core.DataStoreImpl.readDataOrHandleCorruption(DataStoreImpl.kt:373)
	at androidx.datastore.core.DataStoreImpl.access$readDataOrHandleCorruption(DataStoreImpl.kt:53)
	at androidx.datastore.core.DataStoreImpl$InitDataStore$doRun$initData$1.invokeSuspend(DataStoreImpl.kt:445)
	at androidx.datastore.core.DataStoreImpl$InitDataStore$doRun$initData$1.invoke(Unknown Source:8)
	at androidx.datastore.core.DataStoreImpl$InitDataStore$doRun$initData$1.invoke(Unknown Source:2)
	at androidx.datastore.core.SingleProcessCoordinator.lock(SingleProcessCoordinator.kt:41)
	at androidx.datastore.core.DataStoreImpl$InitDataStore.doRun(DataStoreImpl.kt:442)
	at androidx.datastore.core.RunOnce.runIfNeeded(DataStoreImpl.kt:505)
	at androidx.datastore.core.DataStoreImpl.readAndInitOrPropagateAndThrowFailure(DataStoreImpl.kt:274)
	at androidx.datastore.core.DataStoreImpl.access$readAndInitOrPropagateAndThrowFailure(DataStoreImpl.kt:53)
	at androidx.datastore.core.DataStoreImpl$readState$2.invokeSuspend(DataStoreImpl.kt:226)
	at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)
	at kotlinx.coroutines.DispatchedTask.run(DispatchedTask.kt:104)
	at kotlinx.coroutines.internal.LimitedDispatcher$Worker.run(LimitedDispatcher.kt:111)
	at kotlinx.coroutines.scheduling.TaskImpl.run(Tasks.kt:99)
	at kotlinx.coroutines.scheduling.CoroutineScheduler.runSafely(CoroutineScheduler.kt:584)
	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.executeTask(CoroutineScheduler.kt:811)
	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.runWorker(CoroutineScheduler.kt:715)
	at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.run(CoroutineScheduler.kt:702)
Caused by: androidx.datastore.preferences.protobuf.InvalidProtocolBufferException: Protocol message contained an invalid tag (zero).
	at androidx.datastore.preferences.protobuf.CodedInputStream$StreamDecoder.readTag(CodedInputStream.java:2107)
	at androidx.datastore.preferences.protobuf.CodedInputStreamReader.getFieldNumber(CodedInputStreamReader.java:82)
	at androidx.datastore.preferences.protobuf.MessageSchema.mergeFromHelper(MessageSchema.java:3913)
	at androidx.datastore.preferences.protobuf.MessageSchema.mergeFrom(MessageSchema.java:3895)
	at androidx.datastore.preferences.protobuf.GeneratedMessageLite.parsePartialFrom(GeneratedMessageLite.java:1648)
	at androidx.datastore.preferences.protobuf.GeneratedMessageLite.parseFrom(GeneratedMessageLite.java:1784)
	at androidx.datastore.preferences.PreferencesProto$PreferenceMap.parseFrom(PreferencesProto.java:196)
	at androidx.datastore.preferences.PreferencesMapCompat$Companion.readFrom(PreferencesMapCompat.kt:32)
	... 28 more

Are you going to tackle this any time soon or should be moving to another solution? The corruption handler is just a fallback to default status which implies a data loss.

We can't afford to use any kind of storage that has data corruption, since data loss is not an option for our clients. We are temporarily migrating our DataStore data to Room while we find a better solution, and is really an inconvenience.

In many years of development never had this issue using Shared Preferences, nor with SQLiteOpenHelper or Room, the thing is we are now moving to Kotlin Multiplatform and there is still the need of an easy way to persist data that doesn't need the complexity of a relational database like the Room ORM (entities, daos, migrations, queries and such), we are using both datastore and Room at the same time in our products.