Unable to read data saved with v5.5.8 after upgrading to v5.6.2 (Android)

[malwatte]

I'm running into an issue when upgrading react-native-sensitive-info on Android and hoping for some guidance.

We are upgrading:

react-native: 0.74.7 → 0.77.3
react-native-sensitive-info: 5.5.8 → 5.6.2

Issue

On Android, the app using v5.6.2 is unable to read data that was saved by the older app using v5.5.8.
This works perfectly fine on iOS, but fails on Android.

How data was saved (old app – v5.5.8)

SInfo.setItem(
  'TEST_DATA_KEY',
  'test_data_123',
  {
    sharedPreferencesName: 'TEST_DATA_KEY',
    keychainService: 'USER_SETTINGS_KEYCHAIN',
  },
)
  .then(() => {
    console.log('Data Saved!');
  })
  .catch(err => {
    console.log(err);
  });

How data is read (new app – v5.6.2)
This is how I'm reading the data:

SInfo.getItem(
  'TEST_DATA_KEY',
  {
    keychainService: 'USER_SETTINGS_KEYCHAIN',
  },
)
  .then(res => {
    console.log(res);
  })
  .catch(err => {
    console.log(err);
  });

Error
Failed to retrieve "TEST_DATA_KEY": Secret 'TEST_DATA_KEY' not found in service 'USER_SETTINGS_KEYCHAIN'

Environment
Device: Pixel 8
Android version: Android 16
iOS: Works as expected

From the release notes, I noticed there were changes to how data is stored, and it says automatic migration should happen, but I can't get it to work.

Any help or guidance would be greatly appreciated.
Thanks in advance! 🙏

[ThomasReyskens]

I had the same problem...
Wrote some native helper functions to make it work:

 // Legacy SharedPreferences name used by react-native-sensitive-info v5.5.x
  private val LEGACY_PREFS_NAME = "shared_preferences"

/**
   * Reads a value from the legacy SharedPreferences used by react-native-sensitive-info v5.5.x.
   * This is used for migrating existing users to the new storage mechanism.
   */
  @ReactMethod
  fun getLegacySecureValue(key: String, promise: Promise) {
    try {
      val prefs: SharedPreferences = reactApplicationContext.getSharedPreferences(
        LEGACY_PREFS_NAME,
        Context.MODE_PRIVATE
      )
      val value = prefs.getString(key, null)
      promise.resolve(value)
    } catch (e: Exception) {
      promise.reject("E_LEGACY_READ_ERROR", "Failed to read legacy value: ${e.message}", e)
    }
  }

  /**
   * Deletes a value from the legacy SharedPreferences.
   * Called after successful migration to clean up old data.
   */
  @ReactMethod
  fun deleteLegacySecureValue(key: String, promise: Promise) {
    try {
      val prefs: SharedPreferences = reactApplicationContext.getSharedPreferences(
        LEGACY_PREFS_NAME,
        Context.MODE_PRIVATE
      )
      prefs.edit().remove(key).apply()
      promise.resolve(null)
    } catch (e: Exception) {
      promise.reject("E_LEGACY_DELETE_ERROR", "Failed to delete legacy value: ${e.message}", e)
    }
  }

  /**
   * Clears all values from the legacy SharedPreferences.
   * Can be called after migration is complete.
   */
  @ReactMethod
  fun clearLegacySecureStorage(promise: Promise) {
    try {
      val prefs: SharedPreferences = reactApplicationContext.getSharedPreferences(
        LEGACY_PREFS_NAME,
        Context.MODE_PRIVATE
      )
      prefs.edit().clear().apply()
      promise.resolve(null)
    } catch (e: Exception) {
      promise.reject("E_LEGACY_CLEAR_ERROR", "Failed to clear legacy storage: ${e.message}", e)
    }
  }

Hope this helps you..