feat: observe key window changes and cache screen size #252
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,28 +16,13 @@ import Foundation | |
| #endif | ||
|
|
||
| class PostHogContext { | ||
| @ReadWriteLock | ||
| private var screenSize: CGSize? | ||
|
|
||
| #if !os(watchOS) | ||
| private let reachability: Reachability? | ||
| #endif | ||
|
|
||
| private lazy var theStaticContext: [String: Any] = { | ||
| // Properties that do not change over the lifecycle of an application | ||
| var properties: [String: Any] = [:] | ||
|
|
@@ -111,11 +96,28 @@ class PostHogContext { | |
| #if !os(watchOS) | ||
| init(_ reachability: Reachability?) { | ||
| self.reachability = reachability | ||
| registerNotifications() | ||
| } | ||
| #else | ||
| init() { | ||
| if #available(watchOS 7.0, *) { | ||
| registerNotifications() | ||
| } else { | ||
| onShouldUpdateScreenSize() | ||
| } | ||
| } | ||
| #endif | ||
|
|
||
| deinit { | ||
| #if !os(watchOS) | ||
| unregisterNotifications() | ||
| #else | ||
| if #available(watchOS 7.0, *) { | ||
| unregisterNotifications() | ||
| } | ||
| #endif | ||
| } | ||
|
|
||
| private lazy var theSdkInfo: [String: Any] = { | ||
| var sdkInfo: [String: Any] = [:] | ||
| sdkInfo["$lib"] = postHogSdkName | ||
|
|
@@ -161,4 +163,115 @@ class PostHogContext { | |
|
|
||
| return properties | ||
| } | ||
|
|
||
| private func registerNotifications() { | ||
| #if os(iOS) || os(tvOS) | ||
| #if os(iOS) | ||
| NotificationCenter.default.addObserver(self, | ||
| selector: #selector(onOrientationDidChange), | ||
| name: UIDevice.orientationDidChangeNotification, | ||
| object: nil) | ||
| #endif | ||
| NotificationCenter.default.addObserver(self, | ||
| selector: #selector(onShouldUpdateScreenSize), | ||
| name: UIWindow.didBecomeKeyNotification, | ||
| object: nil) | ||
| #elseif os(macOS) | ||
| NotificationCenter.default.addObserver(self, | ||
| selector: #selector(onShouldUpdateScreenSize), | ||
| name: NSWindow.didBecomeKeyNotification, | ||
| object: nil) | ||
| NotificationCenter.default.addObserver(self, | ||
| selector: #selector(onShouldUpdateScreenSize), | ||
| name: NSWindow.didChangeScreenNotification, | ||
| object: nil) | ||
| NotificationCenter.default.addObserver(self, | ||
| selector: #selector(onShouldUpdateScreenSize), | ||
| name: NSApplication.didBecomeActiveNotification, | ||
| object: nil) | ||
| #elseif os(watchOS) | ||
| if #available(watchOS 7.0, *) { | ||
| NotificationCenter.default.addObserver(self, | ||
| selector: #selector(onShouldUpdateScreenSize), | ||
| name: WKApplication.didBecomeActiveNotification, | ||
ioannisj marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| object: nil) | ||
| } | ||
| #endif | ||
| } | ||
|
|
||
| private func unregisterNotifications() { | ||
| #if os(iOS) || os(tvOS) | ||
| #if os(iOS) | ||
| NotificationCenter.default.removeObserver(self, | ||
| name: UIDevice.orientationDidChangeNotification, | ||
| object: nil) | ||
| #endif | ||
| NotificationCenter.default.removeObserver(self, | ||
| name: UIWindow.didBecomeKeyNotification, | ||
| object: nil) | ||
|
|
||
| #elseif os(macOS) | ||
| NotificationCenter.default.removeObserver(self, | ||
| name: NSWindow.didBecomeKeyNotification, | ||
| object: nil) | ||
| NotificationCenter.default.removeObserver(self, | ||
| name: NSWindow.didChangeScreenNotification, | ||
| object: nil) | ||
| NotificationCenter.default.removeObserver(self, | ||
| name: NSApplication.didBecomeActiveNotification, | ||
| object: nil) | ||
| #elseif os(watchOS) | ||
| if #available(watchOS 7.0, *) { | ||
| NotificationCenter.default.removeObserver(self, | ||
| name: WKApplication.didBecomeActiveNotification, | ||
| object: nil) | ||
| } | ||
| #endif | ||
| } | ||
|
|
||
| /// Retrieves the current screen size of the application window based on platform | ||
| private func getScreenSize() -> CGSize? { | ||
| #if os(iOS) || os(tvOS) | ||
| return UIApplication.getCurrentWindow(filterForegrounded: false)?.bounds.size | ||
| #elseif os(macOS) | ||
| // NSScreen.frame represents the full screen rectangle and includes any space occupied by menu, dock or camera bezel | ||
| return NSApplication.shared.windows.first { $0.isKeyWindow }?.screen?.frame.size | ||
|
There was a problem hiding this comment. Per documentation, NSApplication.keyWindow is the window that is currently receiving keyboard events, which sounds like the way to go. When testing, however, I run into cases where keyWindow would be nil, but windows[0].isKeyWindow was true. So I opted in for using Also, dropped There was a problem hiding this comment. cool, for macos session replay we can double-check this because if it's wrong, the screen bound will be off since all positions are absolute |
||
| #elseif os(watchOS) | ||
| return WKInterfaceDevice.current().screenBounds.size | ||
| #else | ||
| return nil | ||
| #endif | ||
| } | ||
|
|
||
| #if os(iOS) | ||
| // Special treatment for `orientationDidChangeNotification` since the notification seems to be _sometimes_ called early, before screen bounds are flipped | ||
| @objc private func onOrientationDidChange() { | ||
| updateScreenSize { | ||
| self.getScreenSize().map { size in | ||
| // manually set width and height based on device orientation. (Needed for fast orientation changes) | ||
| if UIDevice.current.orientation.isLandscape { | ||
|
There was a problem hiding this comment. We need to do some manual work here cause on fast orientation changes, sometimes the size is correct for the given orientation and sometimes it's not. On simulator you can quickly rotate the device with command+arrow |
||
| CGSize(width: max(size.width, size.height), height: min(size.height, size.width)) | ||
| } else { | ||
| CGSize(width: min(size.width, size.height), height: max(size.height, size.width)) | ||
|
Comment on lines
+253
to
+255
There was a problem hiding this comment. why do we need the There was a problem hiding this comment. This relates to the comment here. This is an attempt to grab to "correct" size for the current orientation and avoid jumping to next run-loop. If it's landscape we want the width to be the bigger of the two values, if it's portrait we want it to be the min of the two. I'm not sure why this is happening but when the notification fires we sometimes get the correct screen size (for current orientation) and sometimes we get an "old" screen size with wrong proportions. Pushing this to next run-loop resolves the issue so I assume it's related to CoreAnimation works (there's a considerable visual delay in iPhones between orientation change and when the screen begins animating the rotation effect). I think this transformation should be safe for all content size categories for iPhones and iPads https://www.ios-resolution.com/ |
||
| } | ||
| } | ||
| } | ||
| } | ||
| #endif | ||
|
|
||
| @objc private func onShouldUpdateScreenSize() { | ||
| updateScreenSize(getScreenSize) | ||
| } | ||
|
|
||
| private func updateScreenSize(_ getSize: @escaping () -> CGSize?) { | ||
| let block = { | ||
| self.screenSize = getSize() | ||
| } | ||
| // ensure block is executed on `main` since closure accesses non thread-safe UI objects like UIApplication | ||
| if Thread.isMainThread { | ||
| block() | ||
| } else { | ||
| DispatchQueue.main.async(execute: block) | ||
| } | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have been using
NSLockfor almost everything but thePostHogFileBackedQueue(came from the older version)I intend to remove
ReadWriteLocklater sinceNSLockgives the ability of atomicity for multiple operations.No need to change it now but keep that in mind.