[webview_flutter_android] [webview_flutter_wkwebview] Platform implementations for supporting permission requests (#3792)

Platform implementation portion of flutter/packages#3543

Author: bparrishMines

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.4.0
+
+* Adds support for `PlatformWebViewController.setOnPlatformPermissionRequest`.
+
 ## 3.3.0
 
 * Adds support for `PlatformNavigationDelegate.onUrlChange`.

README.md

@@ -34,12 +34,12 @@ Then you will have access to the native class `FWFWebViewFlutterWKWebViewExterna
 This package uses [pigeon][3] to generate the communication layer between Flutter and the host
 platform (iOS). The communication interface is defined in the `pigeons/web_kit.dart`
 file. After editing the communication interface regenerate the communication layer by running
-`flutter pub run pigeon --input pigeons/web_kit.dart`.
+`dart run pigeon --input pigeons/web_kit.dart`.
 
 Besides [pigeon][3] this package also uses [mockito][4] to generate mock objects for testing
 purposes. To generate the mock objects run the following command:
 ```bash
-flutter pub run build_runner build --delete-conflicting-outputs
+dart run build_runner build --delete-conflicting-outputs
 ```
 
 If you would like to contribute to the plugin, check out our [contribution guide][5].

example/ios/Runner/Info.plist

@@ -45,5 +45,7 @@
 	<true/>
 	<key>UIApplicationSupportsIndirectInputEvents</key>
 	<true/>
+    <key>NSCameraUsageDescription</key>
+    <string>If you want to use the camera, you have to give permission.</string>
 </dict>
 </plist>

example/ios/RunnerTests/FWFDataConvertersTests.m

@@ -13,7 +13,7 @@ @interface FWFDataConvertersTests : XCTestCase
 
 @implementation FWFDataConvertersTests
 - (void)testFWFNSURLRequestFromRequestData {
-  NSURLRequest *request = FWFNSURLRequestFromRequestData([FWFNSUrlRequestData
+  NSURLRequest *request = FWFNativeNSURLRequestFromRequestData([FWFNSUrlRequestData
               makeWithUrl:@"https://flutter.dev"
                httpMethod:@"post"
                  httpBody:[FlutterStandardTypedData typedDataWithBytes:[NSData data]]
@@ -27,16 +27,16 @@ - (void)testFWFNSURLRequestFromRequestData {
 
 - (void)testFWFNSURLRequestFromRequestDataDoesNotOverrideDefaultValuesWithNull {
   NSURLRequest *request =
-      FWFNSURLRequestFromRequestData([FWFNSUrlRequestData makeWithUrl:@"https://flutter.dev"
-                                                           httpMethod:nil
-                                                             httpBody:nil
-                                                  allHttpHeaderFields:@{}]);
+      FWFNativeNSURLRequestFromRequestData([FWFNSUrlRequestData makeWithUrl:@"https://flutter.dev"
+                                                                 httpMethod:nil
+                                                                   httpBody:nil
+                                                        allHttpHeaderFields:@{}]);
 
   XCTAssertEqualObjects(request.HTTPMethod, @"GET");
 }
 
 - (void)testFWFNSHTTPCookieFromCookieData {
-  NSHTTPCookie *cookie = FWFNSHTTPCookieFromCookieData([FWFNSHttpCookieData
+  NSHTTPCookie *cookie = FWFNativeNSHTTPCookieFromCookieData([FWFNSHttpCookieData
       makeWithPropertyKeys:@[ [FWFNSHttpCookiePropertyKeyEnumData
                                makeWithValue:FWFNSHttpCookiePropertyKeyEnumName] ]
             propertyValues:@[ @"cookieName" ]]);
@@ -45,7 +45,7 @@ - (void)testFWFNSHTTPCookieFromCookieData {
 }
 
 - (void)testFWFWKUserScriptFromScriptData {
-  WKUserScript *userScript = FWFWKUserScriptFromScriptData([FWFWKUserScriptData
+  WKUserScript *userScript = FWFNativeWKUserScriptFromScriptData([FWFWKUserScriptData
        makeWithSource:@"mySource"
         injectionTime:[FWFWKUserScriptInjectionTimeEnumData
                           makeWithValue:FWFWKUserScriptInjectionTimeEnumAtDocumentStart]
@@ -70,7 +70,7 @@ - (void)testFWFWKNavigationActionDataFromNavigationAction {
   OCMStub([mockNavigationAction targetFrame]).andReturn(mockFrameInfo);
 
   FWFWKNavigationActionData *data =
-      FWFWKNavigationActionDataFromNavigationAction(mockNavigationAction);
+      FWFWKNavigationActionDataFromNativeWKNavigationAction(mockNavigationAction);
   XCTAssertNotNil(data);
   XCTAssertEqual(data.navigationType, FWFWKNavigationTypeReload);
 }
@@ -82,7 +82,7 @@ - (void)testFWFNSUrlRequestDataFromNSURLRequest {
   request.HTTPBody = [@"aString" dataUsingEncoding:NSUTF8StringEncoding];
   request.allHTTPHeaderFields = @{@"a" : @"field"};
 
-  FWFNSUrlRequestData *data = FWFNSUrlRequestDataFromNSURLRequest(request);
+  FWFNSUrlRequestData *data = FWFNSUrlRequestDataFromNativeNSURLRequest(request);
   XCTAssertEqualObjects(data.url, @"https://www.flutter.dev/");
   XCTAssertEqualObjects(data.httpMethod, @"POST");
   XCTAssertEqualObjects(data.httpBody.data, [@"aString" dataUsingEncoding:NSUTF8StringEncoding]);
@@ -93,7 +93,7 @@ - (void)testFWFWKFrameInfoDataFromWKFrameInfo {
   WKFrameInfo *mockFrameInfo = OCMClassMock([WKFrameInfo class]);
   OCMStub([mockFrameInfo isMainFrame]).andReturn(YES);
 
-  FWFWKFrameInfoData *targetFrameData = FWFWKFrameInfoDataFromWKFrameInfo(mockFrameInfo);
+  FWFWKFrameInfoData *targetFrameData = FWFWKFrameInfoDataFromNativeWKFrameInfo(mockFrameInfo);
   XCTAssertEqualObjects(targetFrameData.isMainFrame, @YES);
 }
 
@@ -102,7 +102,7 @@ - (void)testFWFNSErrorDataFromNSError {
                                        code:23
                                    userInfo:@{NSLocalizedDescriptionKey : @"description"}];
 
-  FWFNSErrorData *data = FWFNSErrorDataFromNSError(error);
+  FWFNSErrorData *data = FWFNSErrorDataFromNativeNSError(error);
   XCTAssertEqualObjects(data.code, @23);
   XCTAssertEqualObjects(data.domain, @"domain");
   XCTAssertEqualObjects(data.localizedDescription, @"description");
@@ -113,8 +113,46 @@ - (void)testFWFWKScriptMessageDataFromWKScriptMessage {
   OCMStub([mockScriptMessage name]).andReturn(@"name");
   OCMStub([mockScriptMessage body]).andReturn(@"message");
 
-  FWFWKScriptMessageData *data = FWFWKScriptMessageDataFromWKScriptMessage(mockScriptMessage);
+  FWFWKScriptMessageData *data = FWFWKScriptMessageDataFromNativeWKScriptMessage(mockScriptMessage);
   XCTAssertEqualObjects(data.name, @"name");
   XCTAssertEqualObjects(data.body, @"message");
 }
+
+- (void)testFWFWKSecurityOriginDataFromWKSecurityOrigin {
+  WKSecurityOrigin *mockSecurityOrigin = OCMClassMock([WKSecurityOrigin class]);
+  OCMStub([mockSecurityOrigin host]).andReturn(@"host");
+  OCMStub([mockSecurityOrigin port]).andReturn(2);
+  OCMStub([mockSecurityOrigin protocol]).andReturn(@"protocol");
+
+  FWFWKSecurityOriginData *data =
+      FWFWKSecurityOriginDataFromNativeWKSecurityOrigin(mockSecurityOrigin);
+  XCTAssertEqualObjects(data.host, @"host");
+  XCTAssertEqualObjects(data.port, @(2));
+  XCTAssertEqualObjects(data.protocol, @"protocol");
+}
+
+- (void)testFWFWKPermissionDecisionFromData API_AVAILABLE(ios(15.0)) {
+  XCTAssertEqual(FWFNativeWKPermissionDecisionFromData(
+                     [FWFWKPermissionDecisionData makeWithValue:FWFWKPermissionDecisionDeny]),
+                 WKPermissionDecisionDeny);
+  XCTAssertEqual(FWFNativeWKPermissionDecisionFromData(
+                     [FWFWKPermissionDecisionData makeWithValue:FWFWKPermissionDecisionGrant]),
+                 WKPermissionDecisionGrant);
+  XCTAssertEqual(FWFNativeWKPermissionDecisionFromData(
+                     [FWFWKPermissionDecisionData makeWithValue:FWFWKPermissionDecisionPrompt]),
+                 WKPermissionDecisionPrompt);
+}
+
+- (void)testFWFWKMediaCaptureTypeDataFromWKMediaCaptureType API_AVAILABLE(ios(15.0)) {
+  XCTAssertEqual(
+      FWFWKMediaCaptureTypeDataFromNativeWKMediaCaptureType(WKMediaCaptureTypeCamera).value,
+      FWFWKMediaCaptureTypeCamera);
+  XCTAssertEqual(
+      FWFWKMediaCaptureTypeDataFromNativeWKMediaCaptureType(WKMediaCaptureTypeMicrophone).value,
+      FWFWKMediaCaptureTypeMicrophone);
+  XCTAssertEqual(
+      FWFWKMediaCaptureTypeDataFromNativeWKMediaCaptureType(WKMediaCaptureTypeCameraAndMicrophone)
+          .value,
+      FWFWKMediaCaptureTypeCameraAndMicrophone);
+}
 @end

example/ios/RunnerTests/FWFUIDelegateHostApiTests.m

@@ -97,4 +97,45 @@ - (void)testOnCreateWebViewForDelegateWithIdentifier {
                                                    isKindOfClass:[FWFWKNavigationActionData class]]
                                     completion:OCMOCK_ANY]);
 }
+
+- (void)testRequestMediaCapturePermissionForOrigin API_AVAILABLE(ios(15.0)) {
+  FWFInstanceManager *instanceManager = [[FWFInstanceManager alloc] init];
+
+  FWFUIDelegate *mockDelegate = [self mockDelegateWithManager:instanceManager identifier:0];
+  FWFUIDelegateFlutterApiImpl *mockFlutterAPI = [self mockFlutterApiWithManager:instanceManager];
+
+  OCMStub([mockDelegate UIDelegateAPI]).andReturn(mockFlutterAPI);
+
+  WKWebView *mockWebView = OCMClassMock([WKWebView class]);
+  [instanceManager addDartCreatedInstance:mockWebView withIdentifier:1];
+
+  WKSecurityOrigin *mockSecurityOrigin = OCMClassMock([WKSecurityOrigin class]);
+  OCMStub([mockSecurityOrigin host]).andReturn(@"");
+  OCMStub([mockSecurityOrigin port]).andReturn(0);
+  OCMStub([mockSecurityOrigin protocol]).andReturn(@"");
+
+  WKFrameInfo *mockFrameInfo = OCMClassMock([WKFrameInfo class]);
+  OCMStub([mockFrameInfo isMainFrame]).andReturn(YES);
+
+  [mockDelegate webView:mockWebView
+      requestMediaCapturePermissionForOrigin:mockSecurityOrigin
+                            initiatedByFrame:mockFrameInfo
+                                        type:WKMediaCaptureTypeMicrophone
+                             decisionHandler:^(WKPermissionDecision decision){
+                             }];
+
+  OCMVerify([mockFlutterAPI
+      requestMediaCapturePermissionForDelegateWithIdentifier:@0
+                                           webViewIdentifier:@1
+                                                      origin:[OCMArg isKindOfClass:
+                                                                         [FWFWKSecurityOriginData
+                                                                             class]]
+                                                       frame:[OCMArg
+                                                                 isKindOfClass:[FWFWKFrameInfoData
+                                                                                   class]]
+                                                        type:[OCMArg isKindOfClass:
+                                                                         [FWFWKMediaCaptureTypeData
+                                                                             class]]
+                                                  completion:OCMOCK_ANY]);
+}
 @end

example/lib/main.dart

@@ -137,6 +137,14 @@ Page resource error:
           );
         },
       ))
+      ..setOnPlatformPermissionRequest(
+        (PlatformWebViewPermissionRequest request) {
+          debugPrint(
+            'requesting permissions for ${request.types.map((WebViewPermissionResourceType type) => type.name)}',
+          );
+          request.grant();
+        },
+      )
       ..loadRequest(LoadRequestParams(
         uri: Uri.parse('https://flutter.dev'),
       ));

example/pubspec.yaml

@@ -10,7 +10,7 @@ dependencies:
   flutter:
     sdk: flutter
   path_provider: ^2.0.6
-  webview_flutter_platform_interface: ^2.1.0
+  webview_flutter_platform_interface: ^2.3.0
   webview_flutter_wkwebview:
     # When depending on this package from a real application you should use:
     #   webview_flutter: ^x.y.z