RealmFileException: Unable to open a realm at path

[vernazza]

Goal

Open a realm database

Actual Results

In a few devices, Realm cannot initialize the file and it throws an exception:

Fatal Exception: io.realm.exceptions.RealmFileException: Unable to open a realm at path '/data/user/0/my.package.name/files/default.realm': Realm file initial open failed Path:Exception backtrace:
<backtrace not supported on this platform>. (Realm file initial open failed Path: /data/user/0/my.package.name/files/default.realm
Exception backtrace:
<backtrace not supported on this platform>) (/data/user/0/my.package.name/files/default.realm) in /tmp/realm-java/realm/realm-library/src/main/cpp/io_realm_internal_OsSharedRealm.cpp line 107
       at io.realm.internal.OsSharedRealm.nativeGetSharedRealm(OsSharedRealm.java)
       at io.realm.internal.OsSharedRealm.<init>(OsSharedRealm.java:173)
       at io.realm.internal.OsSharedRealm.getInstance(OsSharedRealm.java:249)
       at io.realm.BaseRealm.<init>(BaseRealm.java:138)
       at io.realm.BaseRealm.<init>(BaseRealm.java:105)
       at io.realm.Realm.<init>(Realm.java:159)
       at io.realm.Realm.createInstance(Realm.java:495)
       at io.realm.RealmCache.createInstance(RealmCache.java:481)
       at io.realm.RealmCache.doCreateRealmOrGetFromCache(RealmCache.java:448)
       at io.realm.RealmCache.createRealmOrGetFromCache(RealmCache.java:412)
       at io.realm.Realm.getDefaultInstance(Realm.java:403)

Steps & Code to Reproduce

I cannot replicate the problem. I have the crash reports from open test users.
This is how I initialize the DB in the app

       Realm.init(this)
       val realmConfiguration = RealmConfiguration.Builder()
                .encryptionKey(....)
                .assetFile("database/deploy.realm")
                .build()

        Realm.setDefaultConfiguration(realmConfiguration)

Then, later, the first time I do
Realm.getDefaultInstance()
it crashes for some users.

Version of Realm and tooling

Realm version(s): 10.3.1

Realm Sync feature enabled: No

Android Studio version: 4.1.2

Android Build Tools version: 4.1.2

Gradle version: 6.8.1

Which Android version and device(s):
at the moment it happened on different Samsung models with Android 10
Affected users are about 0.3% of the open tests user base

[clementetb]

Thanks for reporting the issue, we are currently investigating it.

Are the affected users not able to use the app, or are these random crashes?

[vernazza]

They can't use the app, because those who are having this problem are having it every time the app tries to open the DB.
I also tried to wrap the opening in a try/catch block, and try again, but the result is the same.

The Init block is in the Application OnCreate function.

[rorbech]

@vernazza Does the issue happen on fresh installs/reinstalls or are they ending up there after a while?

If on fresh installs would you be able to list the exact devices it is happening on?
Or if after a while would you be able to get hold of a realm file exhibiting this behavior?

[vernazza]

Actually they are not fresh installs, but before that version, realm was not used, so it's the first time that those users use realm.

The problem seems to be on the creation of the DB file.

The devices that had the problems are Samsung Galaxy A51, Samsung Galaxy S9, Huaweu JNY-LX1. All 3 are Android 10

[rorbech]

Are you by any chance able to get a realm file from a device where this happens are able to share it or open it on a local device? And do you know whether it reoccurs if the app is uninstalled and installed again?

[vernazza]

Update.
The devices where I'm getting the problem are:
56% android 10,
43% android 9
1% Android 7

Models:

• Samsung Galaxy a51
• Samsung Galaxy S9
• Samsung Galaxy S8+
• Samsung Galaxy S8
• Samsung Galaxy A10
• Huawey JNY-LX1
• A-gold F1

So, it doesn't seem to be related to a specific vendor or to a specific OS

[vernazza]

Sorry, where it happens the DB is not created, so there is nothing to retrieve.
Anyway, I could not replicate the problem and I have only the crash reports, so I don't know if uninstalling fixes the problem.

[adhiamboperes]

I have been getting the same exception since migrating to realm 10.3.0

Implementation

class App : Application() {   
     override fun onCreate() {
        super.onCreate()
    
      val realmConfiguration: RealmConfiguration = RealmConfiguration.Builder()
                  .name(App.instance.getString(R.string.app_name))
                  .schemaVersion(1)
                  .deleteRealmIfMigrationNeeded()
                  .build()
                  
           Realm.init(this)
           Realm.setDefaultConfiguration(realmConfiguration)
    }
}

Calling Function

    // update cart with latest values
    private fun updateLocalCart(updatedCart: Cart) {
        Realm.getDefaultInstance().use { realm ->
            realm.executeTransaction { r->
                val c = r.where<Cart>().findFirst()
                c?.orderItems?.apply {
                    clear()
                    addAll(updatedCart.orderItems)
                }

                c?.totalAmount = updatedCart.totalAmount

                val totalItems = c?.orderItems?.size ?: 0

                cartValue.postValue(Pair(totalItems, c?.totalAmount ?: 0.0))
            }
        }
    }

Full trace

Fatal Exception: io.realm.exceptions.RealmFileException: Unable to open a realm at path '/data/user/0/com.company.app/files/AppName': Realm file initial open failed Path:Exception backtrace:
<backtrace not supported on this platform>. (Realm file initial open failed Path: /data/user/0/com.company.app/files/AppName
Exception backtrace:
<backtrace not supported on this platform>) (/data/user/0/com.company.app/files/AppName) in /tmp/realm-java/realm/realm-library/src/main/cpp/io_realm_internal_OsSharedRealm.cpp line 107
       at io.realm.internal.OsSharedRealm.nativeGetSharedRealm(OsSharedRealm.java)
       at io.realm.internal.OsSharedRealm.<init>(OsSharedRealm.java:8)
       at io.realm.internal.OsSharedRealm.getInstance(OsSharedRealm.java:2)
       at io.realm.BaseRealm.<init>(BaseRealm.java:12)
       at io.realm.Realm.<init>(Realm.java:4)
       at io.realm.Realm.createInstance(Realm.java:14)
       at io.realm.RealmCache.createInstance(RealmCache.java:14)
       at io.realm.RealmCache.doCreateRealmOrGetFromCache(RealmCache.java:14)
       at io.realm.RealmCache.createRealmOrGetFromCache(RealmCache.java:14)
       at io.realm.Realm.getDefaultInstance(Realm.java:2)
       at com.company.app.ui.fragment.cart.CartViewModel.updateLocalCart(CartViewModel.java:1)
       at com.company.app.ui.fragment.cart.CartViewModel$getCart$1.invokeSuspend(CartViewModel.java:10)
       at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(BaseContinuationImpl.java:2)
       at kotlinx.coroutines.DispatchedTask.run(DispatchedTask.java)
       at kotlinx.coroutines.scheduling.CoroutineScheduler.runSafely(CoroutineScheduler.java)
       at kotlinx.coroutines.scheduling.CoroutineScheduler$Worker.executeTask(CoroutineScheduler.java:5)

Affected devices
Lenovo, Huawei, Oppo, Infinix Mobility

Affected OSes

Android 5.1.1(29%), 9(14%) and 7(57%)

Tooling

• Gradle 6.5
• Realm 10.3.0
• Realm Sync feature enabled: No
• Android Studio version: 4.1.2
• Android Build Tools version: 4.1.2

This is happenning in production and I'm yet to reproduce it on debug.

+++ Our users have reported that the app works if they uninstall and reinstall

[edualonso]

Hello @adhiamboperes. Just out of curiosity: you mention you started seeing this crash after migrating to 10.3.1. Which version did you migrate from? And to be 100% sure, you were and are not using encryption in the database, right?

[adhiamboperes]

I am seeing this in v10.3.0. i updated from realm v10.2.0 @edualonso

[vernazza]

It seems that the problem is related to an incomplete DB while copying from the assets.
I didn't have a chance to get a corrupted file, but I added some logs to check the file size and I see that it's smaller than the deployed one (I'm not deleting data from the DB, so it can't be smaller).

I solved my problem like this:

   fun getRealmDefaultInstance(): Realm {
        return try {
            Realm.getDefaultInstance()
        } catch (e: io.realm.exceptions.RealmFileException) {            
            //The file is probably malformed. Delete it and try again
            Realm.getDefaultConfiguration()?.let{Realm.deleteRealm(it)}
            Realm.getDefaultInstance()
        }
    }

and calling this instead of Realm.GetDefaultInstance()

BTW, I also tried reverting to Realm 10.0.0 and I kept getting the problem.

[adhiamboperes]

Thanks @vernazza , I'll try this fix and update if it helps

[evjava]

Reproduced today. Crash happened in production and probably on the fresh install.

Realm version: 10.3.1
Realm Sync feature enabled: No
Android Studio version: 4.2
buildToolsVersion: 30.0.2
Gradle version: 6.8

Device: OUKITEL WP7, Android 9

init process:

Realm.init(this)
...
val configuration = RealmConfiguration.Builder()
  .schemaVersion(..)
  .migration(..)
  .name(Realm.DEFAULT_REALM_NAME)
  .build()
val realm = Realm.getInstance(configuration)

[mahmoudElfeel67]

@clementetb i am also facing this issue

Unable to open a realm at path '/data/user/0/com.bloomer.alaWad3k/files/conetent_db/Db83.realm': Realm file initial open failed: Top ref outside file (size = 1081344). top_ref[0]: FFFFFFFFFFFFFFFF, top_ref[1]: 4088E8, mnemonic: 54 2D 44 42, fmt[0]: 22, fmt[1]: 22, flags: 1 Path:Exception backtrace: <backtrace not supported on this platform> Path: /data/user/0/com.bloomer.alaWad3k/files/conetent_db/Db83.realm Exception backtrace: <backtrace not supported on this platform>. (Realm file initial open failed: Top ref outside file (size = 1081344). top_ref[0]: FFFFFFFFFFFFFFFF, top_ref[1]: 4088E8, mnemonic: 54 2D 44 42, fmt[0]: 22, fmt[1]: 22, flags: 1 Path: /data/user/0/com.bloomer.alaWad3k/files/conetent_db/Db83.realm Exception backtrace: <backtrace not supported on this platform> Path: /data/user/0/com.bloomer.alaWad3k/files/conetent_db/Db83.realm Exception backtrace: <backtrace not supported on this platform>) (/data/user/0/com.bloomer.alaWad3k/files/conetent_db/Db83.realm) in /tmp/realm-java/realm/realm-library/src/main/cpp/io_realm_internal_OsSharedRealm.cpp line 107