[desktop_webview_window] fix memory leak on macOS after close window

Author: boyan01

packages/desktop_webview_window/example/macos/Podfile.lock

@@ -20,9 +20,9 @@ EXTERNAL SOURCES:
 
 SPEC CHECKSUMS:
   desktop_webview_window: d4365e71bcd4e1aa0c14cf0377aa24db0c16a7e2
-  FlutterMacOS: 57701585bf7de1b3fc2bb61f6378d73bbdea8424
-  path_provider_macos: 160cab0d5461f0c0e02995469a98f24bdb9a3f1f
+  FlutterMacOS: 8f6f14fa908a6fb3fba0cd85dbd81ec4b251fb24
+  path_provider_macos: 3c0c3b4b0d4a76d2bf989a913c2de869c5641a19
 
 PODFILE CHECKSUM: c7161fcf45d4fd9025dc0f48a76d6e64e52f8176
 
-COCOAPODS: 1.11.2
+COCOAPODS: 1.12.1

packages/desktop_webview_window/example/macos/Runner.xcodeproj/project.pbxproj

@@ -3,7 +3,7 @@
 	archiveVersion = 1;
 	classes = {
 	};
-	objectVersion = 51;
+	objectVersion = 54;
 	objects = {
 
 /* Begin PBXAggregateTarget section */
@@ -202,7 +202,7 @@
 			isa = PBXProject;
 			attributes = {
 				LastSwiftUpdateCheck = 0920;
-				LastUpgradeCheck = 1300;
+				LastUpgradeCheck = 1430;
 				ORGANIZATIONNAME = "";
 				TargetAttributes = {
 					33CC10EC2044A3C60003C045 = {
@@ -255,6 +255,7 @@
 /* Begin PBXShellScriptBuildPhase section */
 		3399D490228B24CF009A79C7 /* ShellScript */ = {
 			isa = PBXShellScriptBuildPhase;
+			alwaysOutOfDate = 1;
 			buildActionMask = 2147483647;
 			files = (
 			);
@@ -403,7 +404,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				MACOSX_DEPLOYMENT_TARGET = 10.11;
+				MACOSX_DEPLOYMENT_TARGET = 10.14;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				SDKROOT = macosx;
 				SWIFT_COMPILATION_MODE = wholemodule;
@@ -483,7 +484,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				MACOSX_DEPLOYMENT_TARGET = 10.11;
+				MACOSX_DEPLOYMENT_TARGET = 10.14;
 				MTL_ENABLE_DEBUG_INFO = YES;
 				ONLY_ACTIVE_ARCH = YES;
 				SDKROOT = macosx;
@@ -530,7 +531,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				MACOSX_DEPLOYMENT_TARGET = 10.11;
+				MACOSX_DEPLOYMENT_TARGET = 10.14;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				SDKROOT = macosx;
 				SWIFT_COMPILATION_MODE = wholemodule;

packages/desktop_webview_window/example/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1300"
+   LastUpgradeVersion = "1430"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

packages/desktop_webview_window/example/pubspec.lock

@@ -55,7 +55,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.2.0"
+    version: "0.2.1"
   fake_async:
     dependency: transitive
     description:

packages/desktop_webview_window/macos/Classes/DesktopWebviewWindowPlugin.swift

@@ -278,9 +278,6 @@ public class DesktopWebviewWindowPlugin: NSObject, FlutterPlugin {
   }
 
   func onWebviewWindowClose(viewId: Int64, wc: WebviewWindowController) {
-    wc.destroy()
-    let wc = webviews.removeValue(forKey: viewId)
-    wc?.window?.windowController = nil
-    wc?.window = nil
+    webviews.removeValue(forKey: viewId)
   }
 }

packages/desktop_webview_window/macos/Classes/WebViewLayoutController.swift

@@ -106,7 +106,7 @@ class WebViewLayoutController: NSViewController {
         "id": viewId,
         "canGoBack": webView.canGoBack,
         "canGoForward": webView.canGoForward,
-      ])
+      ] as [String: Any])
     } else if keyPath == "loading" {
       if webView.isLoading {
         methodChannel.invokeMethod("onNavigationStarted", arguments: [
@@ -147,16 +147,9 @@ class WebViewLayoutController: NSViewController {
   }
 
   func destroy() {
-    webView.removeObserver(self, forKeyPath: "canGoBack")
-    webView.removeObserver(self, forKeyPath: "canGoForward")
-    webView.removeObserver(self, forKeyPath: "loading")
-
-    webView.uiDelegate = nil
-    webView.navigationDelegate = nil
-    javaScriptHandlerNames.forEach { name in
-      webView.configuration.userContentController.removeScriptMessageHandler(forName: name)
-    }
-    webView.configuration.userContentController.removeAllUserScripts()
+    webView.stopLoading(self)
+    webView.removeFromSuperview()
+    titleBarController.engine.shutDownEngine()
   }
 
   func reload() {
@@ -188,6 +181,12 @@ class WebViewLayoutController: NSViewController {
       completer(result)
     }
   }
+
+  deinit {
+    #if DEBUG
+      print("\(self) deinited")
+    #endif
+  }
 }
 
 extension WebViewLayoutController: WKNavigationDelegate {
@@ -205,7 +204,7 @@ extension WebViewLayoutController: WKNavigationDelegate {
     methodChannel.invokeMethod("onUrlRequested", arguments: [
       "id": viewId,
       "url": url.absoluteString,
-    ])
+    ] as [String: Any])
 
     decisionHandler(.allow)
   }
@@ -223,9 +222,9 @@ extension WebViewLayoutController: WKUIDelegate {
         "id": viewId,
         "prompt": prompt,
         "defaultText": defaultText ?? "",
-      ]) { result in
-      completionHandler((result as? String) ?? "")
-    }
+      ] as [String: Any]) { result in
+        completionHandler((result as? String) ?? "")
+      }
   }
 
   func webView(_ webView: WKWebView, createWebViewWith configuration: WKWebViewConfiguration, for navigationAction: WKNavigationAction, windowFeatures: WKWindowFeatures) -> WKWebView? {

packages/desktop_webview_window/macos/Classes/WebViewLayoutController.xib

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<document type="com.apple.InterfaceBuilder3.Cocoa.XIB" version="3.0" toolsVersion="19455" targetRuntime="MacOSX.Cocoa" propertyAccessControl="none" useAutolayout="YES" customObjectInstantitationMethod="direct">
+<document type="com.apple.InterfaceBuilder3.Cocoa.XIB" version="3.0" toolsVersion="21701" targetRuntime="MacOSX.Cocoa" propertyAccessControl="none" useAutolayout="YES" customObjectInstantitationMethod="direct">
     <dependencies>
         <deployment identifier="macosx"/>
-        <plugIn identifier="com.apple.InterfaceBuilder.CocoaPlugin" version="19455"/>
+        <plugIn identifier="com.apple.InterfaceBuilder.CocoaPlugin" version="21701"/>
         <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
     </dependencies>
     <objects>

packages/desktop_webview_window/macos/Classes/WebviewWindowController.swift

@@ -17,11 +17,11 @@ class WebviewWindowController: NSWindowController {
   private let width, height: Int
 
   private let titleBarHeight: Int
-  
+
   private let titleBarTopPadding: Int
-  
+
   private let title: String
-  
+
   public weak var webviewPlugin: DesktopWebviewWindowPlugin?
 
   init(viewId: Int64, methodChannel: FlutterMethodChannel,
@@ -36,30 +36,28 @@ class WebviewWindowController: NSWindowController {
     self.titleBarTopPadding = titleBarTopPadding
     self.title = title
     super.init(window: nil)
-  }
-
-  required init?(coder: NSCoder) {
-    fatalError("init(coder:) has not been implemented")
-  }
-
-  public var webViewController: WebViewLayoutController {
-    contentViewController as! WebViewLayoutController
-  }
 
-  override func windowDidLoad() {
-    super.windowDidLoad()
+    let newWindow = NSWindow(contentRect: NSRect(x: 0, y: 0, width: width, height: height), styleMask: [.titled, .closable, .resizable, .fullSizeContentView], backing: .buffered, defer: false)
+    newWindow.delegate = self
+    newWindow.title = title
+    newWindow.titlebarAppearsTransparent = true
+    newWindow.center()
 
-    contentViewController = WebViewLayoutController(
+    let contentViewController = WebViewLayoutController(
       methodChannel: methodChannel,
       viewId: viewId, titleBarHeight: titleBarHeight,
       titleBarTopPadding: titleBarTopPadding)
+    newWindow.contentViewController = contentViewController
 
-    window?.setContentSize(NSSize(width: width, height: height))
-    window?.center()
-    window?.title = title
+    window = newWindow
+  }
+
+  required init?(coder: NSCoder) {
+    fatalError("init(coder:) has not been implemented")
+  }
 
-    window?.isReleasedWhenClosed = false
-    window?.delegate = self
+  public var webViewController: WebViewLayoutController {
+    window?.contentViewController as! WebViewLayoutController
   }
 
   override func keyDown(with event: NSEvent) {
@@ -69,8 +67,10 @@ class WebviewWindowController: NSWindowController {
   }
 
   func destroy() {
+    webViewController.destroy()
+    webviewPlugin = nil
     window?.delegate = nil
-    contentViewController = nil
+    window = nil
   }
 
   func setAppearance(brightness: Int) {
@@ -96,18 +96,13 @@ class WebviewWindowController: NSWindowController {
       print("\(self) deinited")
     #endif
   }
-
-  override var windowNibName: NSNib.Name? {
-    "WebviewWindowController"
-  }
 }
 
 extension WebviewWindowController: NSWindowDelegate {
   func windowWillClose(_ notification: Notification) {
     webViewController.destroy()
     methodChannel.invokeMethod("onWindowClose", arguments: ["id": viewId])
-    DispatchQueue.main.async {
-      self.webviewPlugin?.onWebviewWindowClose(viewId: self.viewId, wc: self)
-    }
+    webviewPlugin?.onWebviewWindowClose(viewId: viewId, wc: self)
+    destroy()
   }
 }