System.ArgumentException: Handle must be valid. Parameter name: instance when calling SecureStorage.GetAsync

[harindaka]

Description

Steps to Reproduce

Random. I have a code which makes 2 calls to SecureStorage.GetAsync in the ViewModel each time a Xamarin Forms Page loads. I'm able to crash the app by repeatedly navigating to and back from this page (repeated calls to SecureStorage.GetAsync). Most of the time it works as expected until the exception occurs

Expected Behavior

No errors

Actual Behavior

Throws the following exception at random and crashes.
Handle must be valid. Parameter name: instance

At the call to

await SecureStorage.GetAsync

{System.ArgumentException: Handle must be valid.
Parameter name: instance
  at Java.Interop.JniEnvironment+InstanceMethods.CallObjectMethod (Java.Interop.JniObjectReference instance, Java.Interop.JniMethodInfo method, Java.Interop.JniArgumentValue* args) [0x00009] in <7802aa64ad574c33adca332a3fa9706a>:0 
  at Android.Runtime.JNIEnv.CallObjectMethod (System.IntPtr jobject, System.IntPtr jmethod, Android.Runtime.JValue* parms) [0x0000e] in <263adecfa58f4c449f1ff56156d886fd>:0 
  at Android.Content.ISharedPreferencesInvoker.GetString (System.String key, System.String defValue) [0x0006c] in <263adecfa58f4c449f1ff56156d886fd>:0 
  at Xamarin.Essentials.SecureStorage.PlatformGetAsync (System.String key) [0x0001a] in <e3b2ff3137884401ace22dbf653e6c03>:0 
  at Xamarin.Essentials.SecureStorage.GetAsync (System.String key) [0x00013] in <e3b2ff3137884401ace22dbf653e6c03>:0 
  at SolutionAccelerators.Utilities.Encryption.EncryptionUtility+<ReadRijndael256KeyAsync>d__12.MoveNext () [0x0000f] in /source/SolutionAccelerators/Utilities/Encryption/EncryptionUtility.cs:173 
--- End of stack trace from previous location where exception was thrown ---
  at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw () [0x0000c] in <f32579baafc1404fa37ba3ec1abdc0bd>:0 
  at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess (System.Threading.Tasks.Task task) [0x0003e] in <f32579baafc1404fa37ba3ec1abdc0bd>:0 
  at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification (System.Threading.Tasks.Task task) [0x00028] in <f32579baafc1404fa37ba3ec1abdc0bd>:0 
  at System.Runtime.CompilerServices.TaskAwaiter.ValidateEnd (System.Threading.Tasks.Task task) [0x00008] in <f32579baafc1404fa37ba3ec1abdc0bd>:0 
  at System.Runtime.CompilerServices.TaskAwaiter`1[TResult].GetResult () [0x00000] in <f32579baafc1404fa37ba3ec1abdc0bd>:0 
  at SolutionAccelerators.Utilities.Encryption.EncryptionUtility+<DecryptRijndael256Async>d__10.MoveNext () [0x000b9] in /source/SolutionAccelerators/Utilities/Encryption/EncryptionUtility.cs:137 }

Basic Information

• Version with issue: 0.7.0.17-preview
• Last known good version: ?
• IDE: Visual Studio for Mac
• Platform Target Frameworks: Android
  • iOS: N/A
  • Android: 8.1
  • UWP: N/A
• Android Support Library Version:
• Nuget Packages:
• Affected Devices: Moto Z Play

[jamesmontemagno]

Can you please test with 0.8.0-preview as we made some changes there.

[harindaka]

@jamesmontemagno Yes I can confirm that the issue is still in 0.8.0-preview. It's still random though. I still need to navigate back and forth to the same screen multiple times as mentioned earlier which in turn issues multiple calls to await SecureStorage.GetAsync in order to reproduce it. I pass in a non null class level private string variable as the key parameter to GetAsync if that is relevant.

[jamesmontemagno]

What version of Android is your device running? They run through separate paths.

Is this happening when you navigate from screen to screen and it has not completed the Get?

A small repro would be awesome is possible :)

Also did you call the Init call from https://docs.microsoft.com/en-us/xamarin/essentials/get-started?tabs=windows%2Candroid

Is this Xamarin.Forms or Xamarin.Android based app?

[jamesmontemagno]

Interesting, so this is lower down in the actual Preference class itself.... Seems like something like: https://stackoverflow.com/questions/43855538/handle-must-be-valid-exception-xamarin?rq=1

It could have something to do with calling across different screens. Investigating more.

[harindaka]

@jamesmontemagno interesting indeed. Would this be related to garbage collection?

Here are the answers to your previous questions

1. Version of Android is 8.0 (Moto Z Play)
2. Happens when I navigate from one screen to another then go back (rinse and repeat to reproduce) SecureStorage.GetAsync gets called when the second page's viewmodel gets created. Call originates from within the viewmodel in the order viewmodel -> settingsutility -> SecureStorage.GetAsync. No direct calls to SecureStorage.GetAsync from Page 2.
3. Will try to come up with a small project to reproduce this if I get the time
4. Yes Init is called properly. SecureStorage.GetAsync also works most of the time. Issue is random.
5. It's a Xamarin.Forms project

Also did you note the last comment in the link that you posted which says

Had this issue also with SharedPreferences, as soon as I tried to access it from multiple classes. SharedPreferences is a singleton, so I made my PreferencesManager class a singleton, and it resolved this issue.

[jamesmontemagno]

I believe that we have a fix #386 and will have a build for you to test soon once it is in master!

I believe using our own internal preference will lock correctly and prevent this edge case.

[harindaka]

@jamesmontemagno Thats great! Let me know if and when I can test and confirm :)

[jamesmontemagno]

0.9.0 should have it in there :) available righ tnow :)

[harindaka]

@jamesmontemagno I can confirm that 0.9.0 seems to have fixed this issue. I can no longer reproduce it. Thanks!

[jamesmontemagno]

Awesome! Thanks you for testing it out :)

[KurasovAnton]

Hi @jamesmontemagno , we still receiving the logs with this defect

Xam.Plugin.SecureStorage 1.0.13
Devices:
Pixel 2 - Android 11
Samsung galaxy s5 - Android 6.0.1

Issue:
SettingsImplementation.AddOrUpdateValueCore (System.String key, System.Object value, System.TypeCode typeCode, System.String fileName)
System.ArgumentException: Handle must be valid. Parameter name: type

Stack trace:

Java.Interop
JniEnvironment+InstanceMethods.GetMethodID (Java.Interop.JniObjectReference type, System.String name, System.String signature)
Android.Runtime
JNIEnv.GetMethodID (System.IntPtr kls, System.String name, System.String signature)
Android.Content
ISharedPreferencesInvoker.Edit ()
Plugin.Settings
SettingsImplementation.AddOrUpdateValueCore (System.String key, System.Object value, System.TypeCode typeCode, System.String fileName)
Plugin.Settings
SettingsImplementation.AddOrUpdateValueInternal[T] (System.String key, T value, System.String fileName)
Plugin.Settings
SettingsImplementation.AddOrUpdateValue (System.String key, System.String value, System.String fileName)

Also, the calls to the ISettingStorage SetValue and GetValue methods, wrapped with lock statements