[webview_flutter_wkwebview] Implement one callback method for review of the design

packages/webview_flutter/webview_flutter_wkwebview/example/ios/RunnerTests/FWFNavigationDelegateHostApiTests.m

@@ -8,21 +8,96 @@
 
 #import <OCMock/OCMock.h>
 
+// Used to test that a FlutterBinaryMessenger with a strong reference to a host api won't
+// lead to a circular reference.
+@interface FWFTestMessenger : NSObject <FlutterBinaryMessenger>
+@property(strong, nullable) id hostApi;
+@end
+
+@implementation FWFTestMessenger
+- (void)cleanUpConnection:(FlutterBinaryMessengerConnection)connection {
+}
+
+- (void)sendOnChannel:(nonnull NSString *)channel message:(NSData *_Nullable)message {
+}
+
+- (void)sendOnChannel:(nonnull NSString *)channel
+              message:(NSData *_Nullable)message
+          binaryReply:(FlutterBinaryReply _Nullable)callback {
+}
+
+- (FlutterBinaryMessengerConnection)setMessageHandlerOnChannel:(nonnull NSString *)channel
+                                          binaryMessageHandler:
+                                              (FlutterBinaryMessageHandler _Nullable)handler {
+  return 0;
+}
+@end
+
 @interface FWFNavigationDelegateHostApiTests : XCTestCase
 @end
 
 @implementation FWFNavigationDelegateHostApiTests
 - (void)testCreateWithIdentifier {
   FWFInstanceManager *instanceManager = [[FWFInstanceManager alloc] init];
-  FWFNavigationDelegateHostApiImpl *hostApi =
-      [[FWFNavigationDelegateHostApiImpl alloc] initWithInstanceManager:instanceManager];
+  FWFNavigationDelegateHostApiImpl *hostApi = [[FWFNavigationDelegateHostApiImpl alloc]
+      initWithBinaryMessenger:OCMProtocolMock(@protocol(FlutterBinaryMessenger))
+              instanceManager:instanceManager];
 
   FlutterError *error;
-  [hostApi createWithIdentifier:@0 error:&error];
+  [hostApi createWithIdentifier:@0 didFinishNavigationIdentifier:nil error:&error];
   FWFNavigationDelegate *navigationDelegate =
       (FWFNavigationDelegate *)[instanceManager instanceForIdentifier:0];
 
   XCTAssertTrue([navigationDelegate conformsToProtocol:@protocol(WKNavigationDelegate)]);
   XCTAssertNil(error);
 }
+
+- (void)testDidFinishNavigation {
+  FWFInstanceManager *instanceManager = [[FWFInstanceManager alloc] init];
+  FWFNavigationDelegateHostApiImpl *hostApi = [[FWFNavigationDelegateHostApiImpl alloc]
+      initWithBinaryMessenger:OCMProtocolMock(@protocol(FlutterBinaryMessenger))
+              instanceManager:instanceManager];
+
+  FlutterError *error;
+  [hostApi createWithIdentifier:@0 didFinishNavigationIdentifier:@1 error:&error];
+  FWFNavigationDelegate *navigationDelegate =
+      (FWFNavigationDelegate *)[instanceManager instanceForIdentifier:0];
+  id mockDelegate = OCMPartialMock(navigationDelegate);
+
+  FWFNavigationDelegateFlutterApiImpl *flutterApi = [[FWFNavigationDelegateFlutterApiImpl alloc]
+      initWithBinaryMessenger:OCMProtocolMock(@protocol(FlutterBinaryMessenger))
+              instanceManager:instanceManager];
+  id mockFlutterApi = OCMPartialMock(flutterApi);
+
+  OCMStub([mockDelegate navigationDelegateApi]).andReturn(mockFlutterApi);
+
+  WKWebView *mockWebView = OCMClassMock([WKWebView class]);
+  OCMStub([mockWebView URL]).andReturn([NSURL URLWithString:@"https://flutter.dev/"]);
+  [instanceManager addInstance:mockWebView withIdentifier:2];
+
+  [mockDelegate webView:mockWebView didFinishNavigation:OCMClassMock([WKNavigation class])];
+  OCMVerify([mockFlutterApi didFinishNavigationFunctionWithIdentifier:@1
+                                                    webViewIdentifier:@2
+                                                                  URL:@"https://flutter.dev/"
+                                                           completion:OCMOCK_ANY]);
+}
+
+- (void)testInstanceCanBeReleasedWhenInstanceManagerIsReleased {
+  FWFTestMessenger *testMessenger = [[FWFTestMessenger alloc] init];
+  FWFInstanceManager *instanceManager = [[FWFInstanceManager alloc] init];
+  FWFNavigationDelegateHostApiImpl *hostApi =
+      [[FWFNavigationDelegateHostApiImpl alloc] initWithBinaryMessenger:testMessenger
+                                                        instanceManager:instanceManager];
+
+  testMessenger.hostApi = hostApi;
+
+  FlutterError *error;
+  [hostApi createWithIdentifier:@0 didFinishNavigationIdentifier:nil error:&error];
+  FWFNavigationDelegate __weak *navigationDelegate =
+      (FWFNavigationDelegate *)[instanceManager instanceForIdentifier:0];
+
+  XCTAssertNotNil(navigationDelegate);
+  instanceManager = nil;
+  XCTAssertNil(navigationDelegate);
+}
 @end

packages/webview_flutter/webview_flutter_wkwebview/ios/Classes/FWFGeneratedWebKitApis.h

@@ -302,10 +302,9 @@ extern void FWFWKScriptMessageHandlerHostApiSetup(
 NSObject<FlutterMessageCodec> *FWFWKNavigationDelegateHostApiGetCodec(void);
 
 @protocol FWFWKNavigationDelegateHostApi
-- (void)createWithIdentifier:(NSNumber *)instanceId error:(FlutterError *_Nullable *_Nonnull)error;
-- (void)setDidFinishNavigationForDelegateWithIdentifier:(NSNumber *)instanceId
-                                     functionIdentifier:(nullable NSNumber *)functionInstanceId
-                                                  error:(FlutterError *_Nullable *_Nonnull)error;
+- (void)createWithIdentifier:(NSNumber *)instanceId
+    didFinishNavigationIdentifier:(nullable NSNumber *)didFinishNavigationInstanceId
+                            error:(FlutterError *_Nullable *_Nonnull)error;
 @end
 
 extern void FWFWKNavigationDelegateHostApiSetup(
@@ -317,10 +316,10 @@ NSObject<FlutterMessageCodec> *FWFWKNavigationDelegateFlutterApiGetCodec(void);
 
 @interface FWFWKNavigationDelegateFlutterApi : NSObject
 - (instancetype)initWithBinaryMessenger:(id<FlutterBinaryMessenger>)binaryMessenger;
-- (void)didFinishNavigationForDelegateWithIdentifier:(NSNumber *)functionInstanceId
-                                   webViewIdentifier:(NSNumber *)webViewInstanceId
-                                                 URL:(nullable NSString *)url
-                                          completion:(void (^)(NSError *_Nullable))completion;
+- (void)didFinishNavigationFunctionWithIdentifier:(NSNumber *)functionInstanceId
+                                webViewIdentifier:(NSNumber *)webViewInstanceId
+                                              URL:(nullable NSString *)url
+                                       completion:(void (^)(NSError *_Nullable))completion;
 @end
 /// The codec used by FWFNSObjectHostApi.
 NSObject<FlutterMessageCodec> *FWFNSObjectHostApiGetCodec(void);
@@ -343,6 +342,12 @@ NSObject<FlutterMessageCodec> *FWFNSObjectHostApiGetCodec(void);
 extern void FWFNSObjectHostApiSetup(id<FlutterBinaryMessenger> binaryMessenger,
                                     NSObject<FWFNSObjectHostApi> *_Nullable api);
 
+/// The codec used by FWFNSObjectFlutterApi.
+NSObject<FlutterMessageCodec> *FWFNSObjectFlutterApiGetCodec(void);
+
+@interface FWFNSObjectFlutterApi : NSObject
+- (instancetype)initWithBinaryMessenger:(id<FlutterBinaryMessenger>)binaryMessenger;
+@end
 /// The codec used by FWFFunctionFlutterApi.
 NSObject<FlutterMessageCodec> *FWFFunctionFlutterApiGetCodec(void);
 

packages/webview_flutter/webview_flutter_wkwebview/ios/Classes/FWFGeneratedWebKitApis.m

@@ -1130,41 +1130,19 @@ void FWFWKNavigationDelegateHostApiSetup(id<FlutterBinaryMessenger> binaryMessen
         binaryMessenger:binaryMessenger
                   codec:FWFWKNavigationDelegateHostApiGetCodec()];
     if (api) {
-      NSCAssert([api respondsToSelector:@selector(createWithIdentifier:error:)],
+      NSCAssert([api respondsToSelector:@selector(createWithIdentifier:
+                                            didFinishNavigationIdentifier:error:)],
                 @"FWFWKNavigationDelegateHostApi api (%@) doesn't respond to "
-                @"@selector(createWithIdentifier:error:)",
+                @"@selector(createWithIdentifier:didFinishNavigationIdentifier:error:)",
                 api);
       [channel setMessageHandler:^(id _Nullable message, FlutterReply callback) {
         NSArray *args = message;
         NSNumber *arg_instanceId = GetNullableObjectAtIndex(args, 0);
+        NSNumber *arg_didFinishNavigationInstanceId = GetNullableObjectAtIndex(args, 1);
         FlutterError *error;
-        [api createWithIdentifier:arg_instanceId error:&error];
-        callback(wrapResult(nil, error));
-      }];
-    } else {
-      [channel setMessageHandler:nil];
-    }
-  }
-  {
-    FlutterBasicMessageChannel *channel = [[FlutterBasicMessageChannel alloc]
-           initWithName:@"dev.flutter.pigeon.WKNavigationDelegateHostApi.setDidFinishNavigation"
-        binaryMessenger:binaryMessenger
-                  codec:FWFWKNavigationDelegateHostApiGetCodec()];
-    if (api) {
-      NSCAssert(
-          [api respondsToSelector:@selector
-               (setDidFinishNavigationForDelegateWithIdentifier:functionIdentifier:error:)],
-          @"FWFWKNavigationDelegateHostApi api (%@) doesn't respond to "
-          @"@selector(setDidFinishNavigationForDelegateWithIdentifier:functionIdentifier:error:)",
-          api);
-      [channel setMessageHandler:^(id _Nullable message, FlutterReply callback) {
-        NSArray *args = message;
-        NSNumber *arg_instanceId = GetNullableObjectAtIndex(args, 0);
-        NSNumber *arg_functionInstanceId = GetNullableObjectAtIndex(args, 1);
-        FlutterError *error;
-        [api setDidFinishNavigationForDelegateWithIdentifier:arg_instanceId
-                                          functionIdentifier:arg_functionInstanceId
-                                                       error:&error];
+        [api createWithIdentifier:arg_instanceId
+            didFinishNavigationIdentifier:arg_didFinishNavigationInstanceId
+                                    error:&error];
         callback(wrapResult(nil, error));
       }];
     } else {
@@ -1217,10 +1195,10 @@ - (instancetype)initWithBinaryMessenger:(NSObject<FlutterBinaryMessenger> *)bina
   }
   return self;
 }
-- (void)didFinishNavigationForDelegateWithIdentifier:(NSNumber *)arg_functionInstanceId
-                                   webViewIdentifier:(NSNumber *)arg_webViewInstanceId
-                                                 URL:(nullable NSString *)arg_url
-                                          completion:(void (^)(NSError *_Nullable))completion {
+- (void)didFinishNavigationFunctionWithIdentifier:(NSNumber *)arg_functionInstanceId
+                                webViewIdentifier:(NSNumber *)arg_webViewInstanceId
+                                              URL:(nullable NSString *)arg_url
+                                       completion:(void (^)(NSError *_Nullable))completion {
   FlutterBasicMessageChannel *channel = [FlutterBasicMessageChannel
       messageChannelWithName:
           @"dev.flutter.pigeon.WKNavigationDelegateFlutterApi.didFinishNavigation"
@@ -1369,6 +1347,52 @@ void FWFNSObjectHostApiSetup(id<FlutterBinaryMessenger> binaryMessenger,
     }
   }
 }
+@interface FWFNSObjectFlutterApiCodecReader : FlutterStandardReader
+@end
+@implementation FWFNSObjectFlutterApiCodecReader
+@end
+
+@interface FWFNSObjectFlutterApiCodecWriter : FlutterStandardWriter
+@end
+@implementation FWFNSObjectFlutterApiCodecWriter
+@end
+
+@interface FWFNSObjectFlutterApiCodecReaderWriter : FlutterStandardReaderWriter
+@end
+@implementation FWFNSObjectFlutterApiCodecReaderWriter
+- (FlutterStandardWriter *)writerWithData:(NSMutableData *)data {
+  return [[FWFNSObjectFlutterApiCodecWriter alloc] initWithData:data];
+}
+- (FlutterStandardReader *)readerWithData:(NSData *)data {
+  return [[FWFNSObjectFlutterApiCodecReader alloc] initWithData:data];
+}
+@end
+
+NSObject<FlutterMessageCodec> *FWFNSObjectFlutterApiGetCodec() {
+  static dispatch_once_t sPred = 0;
+  static FlutterStandardMessageCodec *sSharedObject = nil;
+  dispatch_once(&sPred, ^{
+    FWFNSObjectFlutterApiCodecReaderWriter *readerWriter =
+        [[FWFNSObjectFlutterApiCodecReaderWriter alloc] init];
+    sSharedObject = [FlutterStandardMessageCodec codecWithReaderWriter:readerWriter];
+  });
+  return sSharedObject;
+}
+
+@interface FWFNSObjectFlutterApi ()
+@property(nonatomic, strong) NSObject<FlutterBinaryMessenger> *binaryMessenger;
+@end
+
+@implementation FWFNSObjectFlutterApi
+
+- (instancetype)initWithBinaryMessenger:(NSObject<FlutterBinaryMessenger> *)binaryMessenger {
+  self = [super init];
+  if (self) {
+    _binaryMessenger = binaryMessenger;
+  }
+  return self;
+}
+@end
 @interface FWFFunctionFlutterApiCodecReader : FlutterStandardReader
 @end
 @implementation FWFFunctionFlutterApiCodecReader

packages/webview_flutter/webview_flutter_wkwebview/ios/Classes/FWFNavigationDelegateHostApi.h

@@ -7,13 +7,25 @@
 
 #import "FWFGeneratedWebKitApis.h"
 #import "FWFInstanceManager.h"
+#import "FWFObjectHostApi.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
+/**
+ * Flutter api implementation for WKNavigationDelegate.
+ *
+ * Handles making callbacks to Dart for a WKNavigationDelegate.
+ */
+@interface FWFNavigationDelegateFlutterApiImpl : FWFWKNavigationDelegateFlutterApi
+- (instancetype)initWithBinaryMessenger:(id<FlutterBinaryMessenger>)binaryMessenger
+                        instanceManager:(FWFInstanceManager *)instanceManager;
+@end
+
 /**
  * Implementation of WKNavigationDelegate for FWFNavigationDelegateHostApiImpl.
  */
-@interface FWFNavigationDelegate : NSObject <WKNavigationDelegate>
+@interface FWFNavigationDelegate : FWFObject <WKNavigationDelegate>
+@property(readonly, nonnull) FWFNavigationDelegateFlutterApiImpl *navigationDelegateApi;
 @end
 
 /**
@@ -22,7 +34,8 @@ NS_ASSUME_NONNULL_BEGIN
  * Handles creating WKNavigationDelegate that intercommunicate with a paired Dart object.
  */
 @interface FWFNavigationDelegateHostApiImpl : NSObject <FWFWKNavigationDelegateHostApi>
-- (instancetype)initWithInstanceManager:(FWFInstanceManager *)instanceManager;
+- (instancetype)initWithBinaryMessenger:(id<FlutterBinaryMessenger>)binaryMessenger
+                        instanceManager:(FWFInstanceManager *)instanceManager;
 @end
 
 NS_ASSUME_NONNULL_END