Skip to content

Commit fb04d48

Browse files
committed
Fix for Android release builds hanging UI on StorageCipher initialization.
Basic architecture example taken from flutter/flutter#22024 (comment)
1 parent 24fa2a9 commit fb04d48

1 file changed

Lines changed: 128 additions & 45 deletions

File tree

‎android/src/main/java/com/it_nomads/fluttersecurestorage/FlutterSecureStoragePlugin.java‎

Lines changed: 128 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
import android.annotation.SuppressLint;
44
import android.content.Context;
55
import android.content.SharedPreferences;
6+
import android.os.Handler;
7+
import android.os.Looper;
68
import android.util.Base64;
79
import android.util.Log;
810
import androidx.annotation.NonNull;
@@ -31,8 +33,10 @@ public class FlutterSecureStoragePlugin implements MethodCallHandler, FlutterPlu
3133
private StorageCipher storageCipher;
3234
private static final String ELEMENT_PREFERENCES_KEY_PREFIX = "VGhpcyBpcyB0aGUgcHJlZml4IGZvciBhIHNlY3VyZSBzdG9yYWdlCg";
3335
private static final String SHARED_PREFERENCES_NAME = "FlutterSecureStorage";
36+
private static Context applicationContext; //Necessary for deferred initialization of storageCipher
3437

3538
public static void registerWith(Registrar registrar) {
39+
applicationContext = registrar.context().getApplicationContext();
3640
FlutterSecureStoragePlugin instance = new FlutterSecureStoragePlugin();
3741
instance.initInstance(registrar.messenger(), registrar.context());
3842
}
@@ -43,7 +47,6 @@ public void initInstance(BinaryMessenger messenger, Context context) {
4347
charset = Charset.forName("UTF-8");
4448

4549
StorageCipher18Implementation.moveSecretFromPreferencesIfNeeded(preferences, context);
46-
storageCipher = new StorageCipher18Implementation(context);
4750

4851
channel = new MethodChannel(messenger, "plugins.it_nomads.com/flutter_secure_storage");
4952
channel.setMethodCallHandler(this);
@@ -52,6 +55,23 @@ public void initInstance(BinaryMessenger messenger, Context context) {
5255
}
5356
}
5457

58+
/**
59+
* This must be run in a separate Thread from an async method to avoid hanging UI thread on
60+
* live devices in release mode.
61+
* The most convenient place for that appears to be onMethodCall().
62+
*/
63+
private void ensureInitStorageCipher() {
64+
if(storageCipher == null) {
65+
try {
66+
Log.i("FlutterSecureStoragePl", "Initializing StorageCipher");
67+
storageCipher = new StorageCipher18Implementation(applicationContext);
68+
Log.i("FlutterSecureStoragePl", "StorageCipher initialization complete");
69+
} catch (Exception e) {
70+
Log.e("FlutterSecureStoragePl", "StorageCipher initialization failed", e);
71+
}
72+
}
73+
}
74+
5575
@Override
5676
public void onAttachedToEngine(@NonNull FlutterPluginBinding binding) {
5777
initInstance(binding.getBinaryMessenger(), binding.getApplicationContext());
@@ -64,50 +84,9 @@ public void onDetachedFromEngine(@NonNull FlutterPluginBinding binding) {
6484
}
6585

6686
@Override
67-
public void onMethodCall(MethodCall call, Result result) {
68-
try {
69-
switch (call.method) {
70-
case "write": {
71-
String key = getKeyFromCall(call);
72-
Map arguments = (Map) call.arguments;
73-
74-
String value = (String) arguments.get("value");
75-
write(key, value);
76-
result.success(null);
77-
break;
78-
}
79-
case "read": {
80-
String key = getKeyFromCall(call);
81-
82-
String value = read(key);
83-
result.success(value);
84-
break;
85-
}
86-
case "readAll": {
87-
Map<String, String> value = readAll();
88-
result.success(value);
89-
break;
90-
}
91-
case "delete": {
92-
String key = getKeyFromCall(call);
93-
94-
delete(key);
95-
result.success(null);
96-
break;
97-
}
98-
case "deleteAll": {
99-
deleteAll();
100-
result.success(null);
101-
break;
102-
}
103-
default:
104-
result.notImplemented();
105-
break;
106-
}
107-
108-
} catch (Exception e) {
109-
result.error("Exception encountered", call.method, e);
110-
}
87+
public void onMethodCall(@NonNull MethodCall call, @NonNull Result rawResult) {
88+
MethodResultWrapper result = new MethodResultWrapper(rawResult);
89+
new Thread(new MethodRunner(call, result)).start();
11190
}
11291

11392
private String getKeyFromCall(MethodCall call) {
@@ -173,4 +152,108 @@ private String decodeRawValue(String value) throws Exception {
173152

174153
return new String(result, charset);
175154
}
155+
156+
/**
157+
* Wraps the functionality of onMethodCall() in a Runnable for execution in a new Thread.
158+
*/
159+
class MethodRunner implements Runnable {
160+
private final MethodCall call;
161+
private final Result result;
162+
163+
MethodRunner(MethodCall call, Result result) {
164+
this.call = call;
165+
this.result = result;
166+
}
167+
168+
@Override
169+
public void run() {
170+
try {
171+
ensureInitStorageCipher();
172+
switch (call.method) {
173+
case "write": {
174+
String key = getKeyFromCall(call);
175+
Map arguments = (Map) call.arguments;
176+
177+
String value = (String) arguments.get("value");
178+
write(key, value);
179+
result.success(null);
180+
break;
181+
}
182+
case "read": {
183+
String key = getKeyFromCall(call);
184+
185+
String value = read(key);
186+
result.success(value);
187+
break;
188+
}
189+
case "readAll": {
190+
Map<String, String> value = readAll();
191+
result.success(value);
192+
break;
193+
}
194+
case "delete": {
195+
String key = getKeyFromCall(call);
196+
197+
delete(key);
198+
result.success(null);
199+
break;
200+
}
201+
case "deleteAll": {
202+
deleteAll();
203+
result.success(null);
204+
break;
205+
}
206+
default:
207+
result.notImplemented();
208+
break;
209+
}
210+
211+
} catch (Exception e) {
212+
result.error("Exception encountered", call.method, e);
213+
}
214+
}
215+
}
216+
217+
/**
218+
* MethodChannel.Result wrapper that responds on the platform thread.
219+
*/
220+
class MethodResultWrapper implements Result {
221+
222+
private Result methodResult;
223+
private final Handler handler = new Handler(Looper.getMainLooper());
224+
225+
MethodResultWrapper(Result methodResult) {
226+
this.methodResult = methodResult;
227+
}
228+
229+
@Override
230+
public void success(final Object result) {
231+
handler.post(new Runnable() {
232+
@Override
233+
public void run() {
234+
methodResult.success(result);
235+
}
236+
});
237+
}
238+
239+
@Override
240+
public void error(final String errorCode, final String errorMessage, final Object errorDetails) {
241+
handler.post(new Runnable() {
242+
@Override
243+
public void run() {
244+
methodResult.error(errorCode, errorMessage, errorDetails);
245+
}
246+
});
247+
}
248+
249+
@Override
250+
public void notImplemented() {
251+
handler.post(new Runnable() {
252+
@Override
253+
public void run() {
254+
methodResult.notImplemented();
255+
}
256+
});
257+
}
258+
}
176259
}

0 commit comments

Comments
 (0)