From 7c44aa8465fbba5a1741a73d1ba675f4077a9de9 Mon Sep 17 00:00:00 2001
From: Sergiy Dubovik <sergiy.dubovik@supercell.com>
Date: Fri, 8 Dec 2023 10:01:40 +0200
Subject: [PATCH] [macos] FlutterKeyboardManager memory leak fix

Break cycle references, due to implicitely captured 'this'
---
 .../Source/FlutterKeyboardManager.mm          | 14 +++++---
 .../Source/FlutterKeyboardManagerTest.mm      | 33 +++++++++++++++++++
 2 files changed, 43 insertions(+), 4 deletions(-)

diff --git a/shell/platform/darwin/macos/framework/Source/FlutterKeyboardManager.mm b/shell/platform/darwin/macos/framework/Source/FlutterKeyboardManager.mm
index 00ba4ac38cc39..fc0e5db075713 100644
--- a/shell/platform/darwin/macos/framework/Source/FlutterKeyboardManager.mm
+++ b/shell/platform/darwin/macos/framework/Source/FlutterKeyboardManager.mm
@@ -123,18 +123,24 @@ - (nonnull instancetype)initWithViewDelegate:(nonnull id<FlutterKeyboardViewDele
         [FlutterMethodChannel methodChannelWithName:@"flutter/keyboard"
                                     binaryMessenger:[_viewDelegate getBinaryMessenger]
                                               codec:[FlutterStandardMethodCodec sharedInstance]];
+
     [keyboardChannel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
       [self handleKeyboardMethodCall:call result:result];
     }];
+
     _primaryResponders = [[NSMutableArray alloc] init];
+
+    __weak __typeof__(self) weakSelf = self;
     [self addPrimaryResponder:[[FlutterEmbedderKeyResponder alloc]
                                   initWithSendEvent:^(const FlutterKeyEvent& event,
                                                       FlutterKeyEventCallback callback,
                                                       void* userData) {
-                                    [_viewDelegate sendKeyEvent:event
-                                                       callback:callback
-                                                       userData:userData];
+                                    __strong __typeof__(weakSelf) strongSelf = weakSelf;
+                                    [strongSelf.viewDelegate sendKeyEvent:event
+                                                                 callback:callback
+                                                                 userData:userData];
                                   }]];
+
     [self
         addPrimaryResponder:[[FlutterChannelKeyResponder alloc]
                                 initWithChannel:[FlutterBasicMessageChannel
@@ -143,6 +149,7 @@ - (nonnull instancetype)initWithViewDelegate:(nonnull id<FlutterKeyboardViewDele
                                                                                getBinaryMessenger]
                                                                      codec:[FlutterJSONMessageCodec
                                                                                sharedInstance]]]];
+
     _pendingEvents = [[NSMutableArray alloc] init];
     _layoutMap = [NSMutableDictionary<NSNumber*, NSNumber*> dictionary];
     [self buildLayout];
@@ -150,7 +157,6 @@ - (nonnull instancetype)initWithViewDelegate:(nonnull id<FlutterKeyboardViewDele
       responder.layoutMap = _layoutMap;
     }
 
-    __weak __typeof__(self) weakSelf = self;
     [_viewDelegate subscribeToKeyboardLayoutChange:^() {
       [weakSelf buildLayout];
     }];
diff --git a/shell/platform/darwin/macos/framework/Source/FlutterKeyboardManagerTest.mm b/shell/platform/darwin/macos/framework/Source/FlutterKeyboardManagerTest.mm
index 5e57509f704c6..53e314480335e 100644
--- a/shell/platform/darwin/macos/framework/Source/FlutterKeyboardManagerTest.mm
+++ b/shell/platform/darwin/macos/framework/Source/FlutterKeyboardManagerTest.mm
@@ -426,9 +426,11 @@ - (bool)getPressedState;
 - (bool)keyboardChannelGetPressedState;
 - (bool)racingConditionBetweenKeyAndText;
 - (bool)correctLogicalKeyForLayouts;
+- (bool)shouldNotHoldStrongReferenceToViewDelegate;
 @end
 
 namespace flutter::testing {
+
 TEST(FlutterKeyboardManagerUnittests, SinglePrimaryResponder) {
   ASSERT_TRUE([[FlutterKeyboardManagerUnittestsObjC alloc] singlePrimaryResponder]);
 }
@@ -461,6 +463,11 @@ - (bool)correctLogicalKeyForLayouts;
   ASSERT_TRUE([[FlutterKeyboardManagerUnittestsObjC alloc] correctLogicalKeyForLayouts]);
 }
 
+TEST(FlutterKeyboardManagerUnittests, ShouldNotHoldStrongReferenceToViewDelegate) {
+  ASSERT_TRUE(
+      [[FlutterKeyboardManagerUnittestsObjC alloc] shouldNotHoldStrongReferenceToViewDelegate]);
+}
+
 }  // namespace flutter::testing
 
 @implementation FlutterKeyboardManagerUnittestsObjC
@@ -809,4 +816,30 @@ - (bool)correctLogicalKeyForLayouts {
   return TRUE;
 }
 
+- (bool)shouldNotHoldStrongReferenceToViewDelegate {
+  __strong FlutterKeyboardManager* strongKeyboardManager;
+  __weak id weakViewDelegate;
+
+  @autoreleasepool {
+    id binaryMessengerMock = OCMStrictProtocolMock(@protocol(FlutterBinaryMessenger));
+    OCMStub([binaryMessengerMock setMessageHandlerOnChannel:[OCMArg any]
+                                       binaryMessageHandler:[OCMArg any]]);
+
+    id viewDelegateMock = OCMStrictProtocolMock(@protocol(FlutterKeyboardViewDelegate));
+    OCMStub([viewDelegateMock getBinaryMessenger]).andReturn(binaryMessengerMock);
+    OCMStub([viewDelegateMock subscribeToKeyboardLayoutChange:[OCMArg any]]);
+
+    LayoutClue layoutClue;
+    OCMStub([viewDelegateMock lookUpLayoutForKeyCode:0 shift:NO])
+        .ignoringNonObjectArgs()
+        .andReturn(layoutClue);
+    FlutterKeyboardManager* keyboardManager =
+        [[FlutterKeyboardManager alloc] initWithViewDelegate:viewDelegateMock];
+    strongKeyboardManager = keyboardManager;
+    weakViewDelegate = viewDelegateMock;
+  }
+
+  return weakViewDelegate == nil;
+}
+
 @end