Skip to content

fix(status-bar): avoid retain cycle between StatusBar and the bridge #2569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
puneet25 wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −16
Open

fix(status-bar): avoid retain cycle between StatusBar and the bridge #2569

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions status-bar/ios/Sources/StatusBarPlugin/StatusBar.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ import Capacitor

public class StatusBar {

private var bridge: CAPBridgeProtocol
// Weak to avoid a retain cycle: the bridge owns this object transitively
// (bridge -> plugins -> StatusBarPlugin -> statusBar), so a strong back
// reference would keep the whole bridge alive forever.
private weak var bridge: CAPBridgeProtocol?
private var isOverlayingWebview = true
private var backgroundColor = UIColor.black
private var backgroundView: UIView?
Expand All @@ -23,7 +26,7 @@ public class StatusBar {
self?.handleViewDidAppear(config: config)
})
observers.append(NotificationCenter.default.addObserver(forName: .capacitorStatusBarTapped, object: .none, queue: .none) { [weak self] _ in
self?.bridge.triggerJSEvent(eventName: "statusTap", target: "window")
self?.bridge?.triggerJSEvent(eventName: "statusTap", target: "window")
})
observers.append(NotificationCenter.default.addObserver(forName: .capacitorViewWillTransition, object: .none, queue: .none) { [weak self] _ in
self?.handleViewWillTransition()
Expand All @@ -44,7 +47,7 @@ public class StatusBar {
}

func setStyle(_ style: UIStatusBarStyle) {
bridge.statusBarStyle = style
bridge?.statusBarStyle = style
}

func setBackgroundColor(_ color: UIColor) {
Expand All @@ -54,17 +57,17 @@ public class StatusBar {

func setAnimation(_ animation: String) {
if animation == "SLIDE" {
bridge.statusBarAnimation = .slide
bridge?.statusBarAnimation = .slide
} else if animation == "NONE" {
bridge.statusBarAnimation = .none
bridge?.statusBarAnimation = .none
} else {
bridge.statusBarAnimation = .fade
bridge?.statusBarAnimation = .fade
}
}

func hide(animation: String) {
setAnimation(animation)
if bridge.statusBarVisible {
if let bridge, bridge.statusBarVisible {
bridge.statusBarVisible = false
DispatchQueue.main.asyncAfter(deadline: .now() + 0.1) { [weak self] in
self?.resizeWebView()
Expand All @@ -76,7 +79,7 @@ public class StatusBar {

func show(animation: String) {
setAnimation(animation)
if !bridge.statusBarVisible {
if let bridge, !bridge.statusBarVisible {
bridge.statusBarVisible = true
DispatchQueue.main.asyncAfter(deadline: .now() + 0.1) { [self] in
resizeWebView()
Expand All @@ -91,7 +94,7 @@ public class StatusBar {

func getInfo() -> StatusBarInfo {
let style: String
switch bridge.statusBarStyle {
switch bridge?.statusBarStyle ?? .default {
case .default:
style = "DEFAULT"
case .lightContent:
Expand All @@ -104,7 +107,7 @@ public class StatusBar {

return StatusBarInfo(
overlays: isOverlayingWebview,
visible: bridge.statusBarVisible,
visible: bridge?.statusBarVisible ?? false,
style: style,
color: UIColor.capacitor.hex(fromColor: backgroundColor),
height: getStatusBarFrame().size.height
Expand All @@ -118,19 +121,19 @@ public class StatusBar {
backgroundView?.removeFromSuperview()
} else {
initializeBackgroundViewIfNeeded()
bridge.webView?.superview?.addSubview(backgroundView!)
bridge?.webView?.superview?.addSubview(backgroundView!)
}
resizeWebView()
}

private func resizeWebView() {
let bounds: CGRect? = bridge.viewController?.view.window?.windowScene?.keyWindow?.bounds
let bounds: CGRect? = bridge?.viewController?.view.window?.windowScene?.keyWindow?.bounds

guard
let webView = bridge.webView,
let webView = bridge?.webView,
let bounds = bounds
else { return }
bridge.viewController?.view.frame = bounds
bridge?.viewController?.view.frame = bounds
webView.frame = bounds
let statusBarHeight = getStatusBarFrame().size.height
var webViewFrame = webView.frame
Expand All @@ -154,15 +157,15 @@ public class StatusBar {
}

private func getStatusBarFrame() -> CGRect {
return bridge.viewController?.view.window?.windowScene?.statusBarManager?.statusBarFrame ?? .zero
return bridge?.viewController?.view.window?.windowScene?.statusBarManager?.statusBarFrame ?? .zero
}

private func initializeBackgroundViewIfNeeded() {
if backgroundView == nil {
backgroundView = UIView(frame: getStatusBarFrame())
backgroundView!.backgroundColor = backgroundColor
backgroundView!.autoresizingMask = [.flexibleWidth, .flexibleBottomMargin]
backgroundView!.isHidden = !bridge.statusBarVisible
backgroundView!.isHidden = !(bridge?.statusBarVisible ?? false)
}
}
}