[local_auth] Fixes show dialog when biometrics is not enrolled on Android devices. #6041

vcrash · 2022-06-26T12:02:04Z

Description

Added AuthenticationErrorHandler class to encapsulate error handling logic which can be reused in several places.
It can help to avoid applying different error processing logic for same kind of errors in different places.
Added AuthResultErrorCodes class containing result error codes constants. These error codes are matching to those in error_codes.dart.

Related issues

flutter/flutter#96646

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

… AuthenticationErrorHandler class so it can be reused.

…Callback calls

…al_auth/local_auth_android/errors_handling_publish

…al_auth/local_auth_android/errors_handling_publish # Conflicts: # packages/local_auth/local_auth_android/CHANGELOG.md

stuartmorgan-g · 2022-06-30T20:28:08Z

@camsim99 Since you are looking at local_auth at the moment, maybe you could do the initial review here?

camsim99

Thanks for doing this -- this is a lot cleaner! For the most part, I just had some comments on the structure of the error codes and some nits.

camsim99 · 2022-07-07T21:22:27Z

...al_auth_android/android/src/main/java/io/flutter/plugins/localauth/AuthResultErrorCodes.java

+package io.flutter.plugins.localauth;
+
+/** Exception codes for `PlatformException` in Flutter returned by `authenticate`. */
+class AuthResultErrorCodes {


Could this be converted to an enum since it's just values?

We can make this enum. But probably we need to move all possible error codes to this class first. Android plugin still can throw errors with codes which are not contained in error_codes.dart so they can be unexpected in Flutter part. If we make it enum we probably want to be sure that no other error codes are used and the set of enum values is full.

camsim99 · 2022-07-07T21:25:29Z

...al_auth_android/android/src/main/java/io/flutter/plugins/localauth/AuthResultErrorCodes.java

+  static final String LOCKED_OUT = "LockedOut";
+
+  /**
+   * Indicates the API is locked out more persistently than [lockedOut]. Strong authentication like


Suggested change

* Indicates the API is locked out more persistently than [lockedOut]. Strong authentication like

* Indicates the API is locked out more persistently than {@code lockedOut}. Strong authentication like

changed to @link

camsim99 · 2022-07-07T21:29:26Z

...al_auth_android/android/src/main/java/io/flutter/plugins/localauth/AuthResultErrorCodes.java

+  static final String PERMANENTLY_LOCKED_OUT = "PermanentlyLockedOut";
+
+  /** Indicates that the biometricOnly parameter can"t be true on Windows */
+  static final String BIOMETRIC_ONLY_NOT_SUPPORTED = "biometricOnlyNotSupported";


I don't think we need this since it's Windows only and it's already defined for Windows in error_codes.dart.

Ok, I now recognize these are the same error codes defined there. I would remove the codes not used here and add a reference to the Dart error codes, unless there is a way to avoid the redundancy. @stuartmorgan what do you think?

Agreed, we should only define strings we are actually using, and referencing the Dart file that these need to be synchronized with in a comment is definitely helpful.

We don't currently have a way to avoid the redundancy. (There's a proposal for constants in Pigeon that would let us address that problem.)

We still have some error codes in Android plugin which are not contained in error_codes.dart such as "NotSupported", "NoHardware" and others. Should we add all of them to AuthResultErrorCodes.java or just keep here values matching those in error_codes.dart?

@camsim99 @stuartmorgan Any thoughts?

I think including them is fine. Maybe just note that those are Android only or Android-specific?

...al_auth_android/android/src/main/java/io/flutter/plugins/localauth/AuthResultErrorCodes.java

packages/local_auth/local_auth/CHANGELOG.md

...h_android/android/src/main/java/io/flutter/plugins/localauth/AuthenticationErrorHandler.java

camsim99 · 2022-07-07T21:46:49Z

...h/local_auth_android/android/src/main/java/io/flutter/plugins/localauth/LocalAuthPlugin.java

@@ -174,7 +175,9 @@ public void onError(String code, String error) {
        if (!hasBiometricHardware()) {
          completionHandler.onError("NoHardware", "No biometric hardware found");
        }
-        completionHandler.onError("NotEnrolled", "No biometrics enrolled on this device.");
+        final AuthenticationErrorHandler errorHandler = new AuthenticationErrorHandler();


Can this be made a class field? The newer local auth APIs have more errors that will need to be handled, see #6059

camsim99 · 2022-07-07T21:49:36Z

...al_auth_android/android/src/main/java/io/flutter/plugins/localauth/AuthenticationHelper.java

@@ -129,39 +129,51 @@ private void stop() {
  @SuppressLint("SwitchIntDef")
  @Override
  public void onAuthenticationError(int errorCode, CharSequence errString) {
+    final AuthenticationErrorHandler errorHandler = new AuthenticationErrorHandler();
+    final Runnable onStopCallback = new Runnable() {


What does this callback contribute to the error handling? Is it needed?

Since we moved part of error handling logic to AuthenticationErrorHandler class we need this callback to call stop() method of the AuthenticationHelper.

Gotcha. Thanks!

stuartmorgan-g · 2022-08-22T20:27:15Z

What's the status of this PR? It's not clear to me if all of the last round of review comments have been addressed yet, and it looks like some of the tests don't compile.

vcrash · 2022-09-10T08:44:35Z

Closing this PR since the issue is not reproducing in local_auth 2.1.2. Further refactoring is not seems to be directly related to this issue.

vcrash added 12 commits June 2, 2022 13:34

[local_auth_android] Error handling logic has been partially moved to…

ccba658

… AuthenticationErrorHandler class so it can be reused.

local_auth_android dependency ref update

4efaafb

code formatting

0b3023d

AuthenticationErrorHandler test

56cded3

Plugin version increased

ee5e3f3

[local_auth_android] AuthenticationErrorHandlerTest: verifying onStop…

7bec877

…Callback calls

Merge branch 'local_auth/local_auth_android/errors_handling' into loc…

36dc18b

…al_auth/local_auth_android/errors_handling_publish

Package-private access level for AuthenticationErrorHandler class

90d07fa

Merge branch 'local_auth/local_auth_android/errors_handling' into loc…

bdfc076

…al_auth/local_auth_android/errors_handling_publish

[local_auth_android] CHANGELOG updates

7de3cb7

[local_auth_android] added handleCredentialsNotAvailableError method doc

db1ebff

Merge branch 'local_auth/local_auth_android/errors_handling' into loc…

732e2b0

…al_auth/local_auth_android/errors_handling_publish

vcrash requested review from blasten and stuartmorgan-g as code owners June 26, 2022 12:02

github-actions bot added p: local_auth platform-android labels Jun 26, 2022

vcrash added 2 commits June 26, 2022 17:44

Merge branch 'main' into local_auth/local_auth_android/errors_handling

da691c6

Merge branch 'local_auth/local_auth_android/errors_handling' into loc…

6c9b7b4

…al_auth/local_auth_android/errors_handling_publish # Conflicts: # packages/local_auth/local_auth_android/CHANGELOG.md

stuartmorgan-g requested review from camsim99 and removed request for blasten June 30, 2022 20:27

camsim99 suggested changes Jul 7, 2022

View reviewed changes

vcrash added 2 commits July 16, 2022 22:36

[local_auth] removed version update

f2d13c1

[local_auth_android] javadoc update

ffa598d

vcrash closed this Sep 10, 2022

	* Indicates the API is locked out more persistently than [lockedOut]. Strong authentication like
	* Indicates the API is locked out more persistently than {@code lockedOut}. Strong authentication like

[local_auth] Fixes show dialog when biometrics is not enrolled on Android devices. #6041

[local_auth] Fixes show dialog when biometrics is not enrolled on Android devices. #6041

Uh oh!

Conversation

vcrash commented Jun 26, 2022

Description

Related issues

Pre-launch Checklist

Uh oh!

stuartmorgan-g commented Jun 30, 2022

Uh oh!

camsim99 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

camsim99 Jul 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g commented Aug 22, 2022

Uh oh!

vcrash commented Sep 10, 2022

Uh oh!

Uh oh!

camsim99 Jul 7, 2022 •

edited

Loading