[local_auth] support localizedFallbackTitle in IOSAuthMessages

packages/local_auth/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.1.9
+
+* Add support `localizedFallbackTitle` in authenticateWithBiometrics on iOS.
+
 ## 1.1.8
 
 * Update minimum Flutter SDK to 2.5 and iOS deployment target to 9.0.

packages/local_auth/example/ios/RunnerTests/FLTLocalAuthPluginTests.m

@@ -56,13 +56,15 @@ - (void)testSuccessfullAuthWithBiometrics {
                                                               arguments:@{
                                                                 @"biometricOnly" : @(YES),
                                                                 @"localizedReason" : reason,
+                                                                @"localizedFallbackTitle" : @"",
                                                               }];
 
   XCTestExpectation* expectation = [self expectationWithDescription:@"Result is called"];
   [plugin handleMethodCall:call
                     result:^(id _Nullable result) {
                       XCTAssertTrue([NSThread isMainThread]);
                       XCTAssertTrue([result isKindOfClass:[NSNumber class]]);
+                      OCMVerify([mockAuthContext setLocalizedFallbackTitle:@""]);
                       XCTAssertTrue([result boolValue]);
                       [expectation fulfill];
                     }];
@@ -95,13 +97,15 @@ - (void)testSuccessfullAuthWithoutBiometrics {
                                                               arguments:@{
                                                                 @"biometricOnly" : @(NO),
                                                                 @"localizedReason" : reason,
+                                                                @"localizedFallbackTitle" : @"",
                                                               }];
 
   XCTestExpectation* expectation = [self expectationWithDescription:@"Result is called"];
   [plugin handleMethodCall:call
                     result:^(id _Nullable result) {
                       XCTAssertTrue([NSThread isMainThread]);
                       XCTAssertTrue([result isKindOfClass:[NSNumber class]]);
+                      OCMVerify([mockAuthContext setLocalizedFallbackTitle:@""]);
                       XCTAssertTrue([result boolValue]);
                       [expectation fulfill];
                     }];
@@ -134,13 +138,15 @@ - (void)testFailedAuthWithBiometrics {
                                                               arguments:@{
                                                                 @"biometricOnly" : @(YES),
                                                                 @"localizedReason" : reason,
+                                                                @"localizedFallbackTitle" : @"",
                                                               }];
 
   XCTestExpectation* expectation = [self expectationWithDescription:@"Result is called"];
   [plugin handleMethodCall:call
                     result:^(id _Nullable result) {
                       XCTAssertTrue([NSThread isMainThread]);
                       XCTAssertTrue([result isKindOfClass:[NSNumber class]]);
+                      OCMVerify([mockAuthContext setLocalizedFallbackTitle:@""]);
                       XCTAssertFalse([result boolValue]);
                       [expectation fulfill];
                     }];
@@ -173,13 +179,58 @@ - (void)testFailedAuthWithoutBiometrics {
                                                               arguments:@{
                                                                 @"biometricOnly" : @(NO),
                                                                 @"localizedReason" : reason,
+                                                                @"localizedFallbackTitle" : @"",
                                                               }];
 
   XCTestExpectation* expectation = [self expectationWithDescription:@"Result is called"];
   [plugin handleMethodCall:call
                     result:^(id _Nullable result) {
                       XCTAssertTrue([NSThread isMainThread]);
                       XCTAssertTrue([result isKindOfClass:[NSNumber class]]);
+                      OCMVerify([mockAuthContext setLocalizedFallbackTitle:@""]);
+                      XCTAssertFalse([result boolValue]);
+                      [expectation fulfill];
+                    }];
+  [self waitForExpectationsWithTimeout:kTimeout handler:nil];
+}
+
+- (void)testLocalizedFallbackTitle {
+  FLTLocalAuthPlugin* plugin = [[FLTLocalAuthPlugin alloc] init];
+  id mockAuthContext = OCMClassMock([LAContext class]);
+  plugin.authContextOverrides = @[ mockAuthContext ];
+
+  const LAPolicy policy = LAPolicyDeviceOwnerAuthentication;
+  NSString* reason = @"a reason";
+  NSString* localizedFallbackTitle = @"a title";
+  OCMStub([mockAuthContext canEvaluatePolicy:policy error:[OCMArg setTo:nil]]).andReturn(YES);
+
+  // evaluatePolicy:localizedReason:reply: calls back on an internal queue, which is not
+  // guaranteed to be on the main thread. Ensure that's handled correctly by calling back on
+  // a background thread.
+  void (^backgroundThreadReplyCaller)(NSInvocation*) = ^(NSInvocation* invocation) {
+    void (^reply)(BOOL, NSError*);
+    [invocation getArgument:&reply atIndex:4];
+    dispatch_async(dispatch_get_global_queue(QOS_CLASS_BACKGROUND, 0), ^{
+      reply(NO, [NSError errorWithDomain:@"error" code:99 userInfo:nil]);
+    });
+  };
+  OCMStub([mockAuthContext evaluatePolicy:policy localizedReason:reason reply:[OCMArg any]])
+      .andDo(backgroundThreadReplyCaller);
+
+  FlutterMethodCall* call =
+      [FlutterMethodCall methodCallWithMethodName:@"authenticate"
+                                        arguments:@{
+                                          @"biometricOnly" : @(NO),
+                                          @"localizedReason" : reason,
+                                          @"localizedFallbackTitle" : localizedFallbackTitle,
+                                        }];
+
+  XCTestExpectation* expectation = [self expectationWithDescription:@"Result is called"];
+  [plugin handleMethodCall:call
+                    result:^(id _Nullable result) {
+                      XCTAssertTrue([NSThread isMainThread]);
+                      XCTAssertTrue([result isKindOfClass:[NSNumber class]]);
+                      OCMVerify([mockAuthContext setLocalizedFallbackTitle:localizedFallbackTitle]);
                       XCTAssertFalse([result boolValue]);
                       [expectation fulfill];
                     }];

packages/local_auth/ios/Classes/FLTLocalAuthPlugin.m

@@ -122,7 +122,7 @@ - (void)authenticateWithBiometrics:(NSDictionary *)arguments
   NSError *authError = nil;
   self.lastCallArgs = nil;
   self.lastResult = nil;
-  context.localizedFallbackTitle = @"";
+  context.localizedFallbackTitle = arguments[@"localizedFallbackTitle"];
 
   if ([context canEvaluatePolicy:LAPolicyDeviceOwnerAuthenticationWithBiometrics
                            error:&authError]) {
@@ -146,7 +146,10 @@ - (void)authenticate:(NSDictionary *)arguments withFlutterResult:(FlutterResult)
   NSError *authError = nil;
   _lastCallArgs = nil;
   _lastResult = nil;
-  context.localizedFallbackTitle = @"";
+  context.localizedFallbackTitle = nil;
+  if (arguments[@"localizedFallbackTitle"] != (NSString *)[NSNull null]) {
+    context.localizedFallbackTitle = arguments[@"localizedFallbackTitle"];
+  }
 
   if ([context canEvaluatePolicy:LAPolicyDeviceOwnerAuthentication error:&authError]) {
     [context evaluatePolicy:kLAPolicyDeviceOwnerAuthentication
@@ -176,6 +179,7 @@ - (void)handleAuthReplyWithSuccess:(BOOL)success
       case LAErrorPasscodeNotSet:
       case LAErrorTouchIDNotAvailable:
       case LAErrorTouchIDNotEnrolled:
+      case LAErrorUserFallback:
       case LAErrorTouchIDLockout:
         [self handleErrors:error flutterArguments:arguments withFlutterResult:result];
         return;

packages/local_auth/lib/auth_strings.dart

@@ -68,12 +68,14 @@ class IOSAuthMessages {
     this.goToSettingsButton,
     this.goToSettingsDescription,
     this.cancelButton,
+    this.localizedFallbackTitle,
   });
 
   final String? lockOut;
   final String? goToSettingsButton;
   final String? goToSettingsDescription;
   final String? cancelButton;
+  final String? localizedFallbackTitle;
 
   Map<String, String> get args {
     return <String, String>{
@@ -82,6 +84,7 @@ class IOSAuthMessages {
       'goToSettingDescriptionIOS':
           goToSettingsDescription ?? iOSGoToSettingsDescription,
       'okButton': cancelButton ?? iOSOkButton,
+      'localizedFallbackTitle': localizedFallbackTitle ?? '',
     };
   }
 }

packages/local_auth/lib/local_auth.dart

@@ -102,7 +102,7 @@ class LocalAuthentication {
   }) async {
     assert(localizedReason.isNotEmpty);
 
-    final Map<String, Object> args = <String, Object>{
+    final Map<String, Object?> args = <String, Object?>{
       'localizedReason': localizedReason,
       'useErrorDialogs': useErrorDialogs,
       'stickyAuth': stickyAuth,

packages/local_auth/pubspec.yaml

@@ -3,7 +3,7 @@ description: Flutter plugin for Android and iOS devices to allow local
   authentication via fingerprint, touch ID, face ID, passcode, pin, or pattern.
 repository: https://github.com/flutter/plugins/tree/master/packages/local_auth
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+local_auth%22
-version: 1.1.8
+version: 1.1.9
 
 environment:
   sdk: ">=2.14.0 <3.0.0"