Fix that the overlay panel is not visible

Author: intitni

OverlayWindow/Sources/OverlayWindow/IDEWorkspaceWindowOverlayWindowController.swift

@@ -5,10 +5,12 @@ import Foundation
 import SwiftUI
 import XcodeInspector
 
+@MainActor
 public protocol IDEWorkspaceWindowOverlayWindowControllerContentProvider {
     associatedtype Content: View
     func createWindow() -> NSWindow?
     func createContent() -> Content
+    func destroy()
 
     init(windowInspector: WorkspaceXcodeWindowInspector, application: NSRunningApplication)
 }
@@ -38,64 +40,60 @@ final class IDEWorkspaceWindowOverlayWindowController {
     ) {
         self.inspector = inspector
         self.application = application
-        contentProviders = contentProviderFactory(inspector, application)
-
-        // Create the invisible panel
-        let panel = NSPanel(
-            contentRect: .zero,
-            styleMask: [.borderless],
-            backing: .buffered,
-            defer: false
-        )
-        panel.isReleasedWhenClosed = false
-        panel.isOpaque = false
-        panel.backgroundColor = .clear
-        panel.hasShadow = false
-        panel.ignoresMouseEvents = true
-        panel.alphaValue = 0
-        panel.collectionBehavior = [.canJoinAllSpaces, .transient]
-        panel.level = widgetLevel(0)
-        panel.setIsVisible(true)
-        maskPanel = panel
-
-        panel.contentView = NSHostingView(
-            rootView: ZStack {
+        let contentProviders = contentProviderFactory(inspector, application)
+        self.contentProviders = contentProviders
+
+        let panel = OverlayPanel(
+            contentRect: .init(x: 0, y: 0, width: 200, height: 200)
+        ) {
+            ZStack {
+                Text("Hello World")
+                    .padding()
+                    .background(
+                        Rectangle()
+                            .fill(.black)
+                            .opacity(0.3)
+                    )
                 ForEach(0..<contentProviders.count, id: \.self) { (index: Int) in
-                    self.contentProviders[index].contentBody
+                    contentProviders[index].contentBody
                 }
             }
+            .background {
+                Rectangle().fill(.green.opacity(0.2))
+            }
             .allowsHitTesting(false)
-        )
-        
+        }
+        maskPanel = panel
+
         for contentProvider in contentProviders {
             if let window = contentProvider.createWindow() {
                 panel.addChildWindow(window, ordered: .above)
             }
         }
 
-        // Listen to AX notifications for window move/resize
         let windowElement = inspector.uiElement
         let stream = AXNotificationStream(
             app: application,
             element: windowElement,
             notificationNames: kAXMovedNotification, kAXResizedNotification
         )
 
-        axNotificationTask = Task { [weak self] in
+        axNotificationTask = Task { [weak panel] in
             for await notification in stream {
-                guard let self else { return }
+                guard let panel else { return }
+                if Task.isCancelled { return }
                 switch notification.name {
                 case kAXMovedNotification, kAXResizedNotification:
                     if let rect = windowElement.rect {
-                        self.maskPanel.setFrame(rect, display: false)
+                        panel.setFrame(rect, display: false)
                     }
                 default: continue
                 }
             }
         }
 
         if let rect = windowElement.rect {
-            maskPanel.setFrame(rect, display: false)
+            panel.setFrame(rect, display: false)
         }
     }
 
@@ -111,40 +109,29 @@ final class IDEWorkspaceWindowOverlayWindowController {
         }
     }
 
-    /// Make the window the top most window and visible.
     func access() {
         lastAccessDate = Date()
-        maskPanel.level = widgetLevel(0)
+        maskPanel.level = overlayLevel(0)
         maskPanel.setIsVisible(true)
         maskPanel.orderFrontRegardless()
     }
 
-    /// Stop keeping the window the top most window, do not change visibility.
     func dim() {
         maskPanel.level = .normal
     }
 
-    /// Hide the window.
     func hide() {
         maskPanel.setIsVisible(false)
         maskPanel.level = .normal
     }
 
-    /// Destroy the controller and clean up resources.
     func destroy() {
         axNotificationTask?.cancel()
         maskPanel.close()
+        for contentProvider in contentProviders {
+            contentProvider.destroy()
+        }
         isDestroyed = true
     }
 }
 
-func widgetLevel(_ addition: Int) -> NSWindow.Level {
-    let minimumWidgetLevel: Int
-    #if DEBUG
-    minimumWidgetLevel = NSWindow.Level.floating.rawValue + 1
-    #else
-    minimumWidgetLevel = NSWindow.Level.floating.rawValue
-    #endif
-    return .init(minimumWidgetLevel + addition)
-}
-

OverlayWindow/Sources/OverlayWindow/OverlayPanel.swift

@@ -0,0 +1,58 @@
+import AppKit
+import SwiftUI
+
+@MainActor
+final class OverlayPanel<Content: View>: NSPanel {
+    init(
+        contentRect: NSRect,
+        @ViewBuilder content: () -> Content
+    ) {
+        super.init(
+            contentRect: contentRect,
+            styleMask: [
+                .borderless,
+                .nonactivatingPanel,
+                .fullSizeContentView,
+            ],
+            backing: .buffered,
+            defer: false
+        )
+
+        isReleasedWhenClosed = false
+        isOpaque = false
+        backgroundColor = .clear
+        hasShadow = true
+        alphaValue = 1.0
+        collectionBehavior = [.fullScreenAuxiliary]
+        isFloatingPanel = true
+        titleVisibility = .hidden
+        titlebarAppearsTransparent = true
+        animationBehavior = .utilityWindow
+
+        standardWindowButton(.closeButton)?.isHidden = true
+        standardWindowButton(.miniaturizeButton)?.isHidden = true
+        standardWindowButton(.zoomButton)?.isHidden = true
+
+        contentView = NSHostingView(
+            rootView: content()
+        )
+    }
+
+    override var canBecomeKey: Bool {
+        return true
+    }
+
+    override var canBecomeMain: Bool {
+        return false
+    }
+}
+
+func overlayLevel(_ addition: Int) -> NSWindow.Level {
+    let minimumWidgetLevel: Int
+    #if DEBUG
+    minimumWidgetLevel = NSWindow.Level.floating.rawValue + 1
+    #else
+    minimumWidgetLevel = NSWindow.Level.floating.rawValue
+    #endif
+    return .init(minimumWidgetLevel + addition)
+}

OverlayWindow/Sources/OverlayWindow/OverlayWindowController.swift

@@ -5,10 +5,11 @@ import XcodeInspector
 
 @MainActor
 public final class OverlayWindowController {
-    public typealias IDEWorkspaceWindowOverlayWindowControllerContentProviderFactory = @Sendable (
-        _ windowInspector: WorkspaceXcodeWindowInspector,
-        _ application: NSRunningApplication
-    ) -> any IDEWorkspaceWindowOverlayWindowControllerContentProvider
+    public typealias IDEWorkspaceWindowOverlayWindowControllerContentProviderFactory =
+        @MainActor @Sendable (
+            _ windowInspector: WorkspaceXcodeWindowInspector,
+            _ application: NSRunningApplication
+        ) -> any IDEWorkspaceWindowOverlayWindowControllerContentProvider
 
     static var ideWindowOverlayWindowControllerContentProviderFactories:
         [IDEWorkspaceWindowOverlayWindowControllerContentProviderFactory] = []
@@ -21,10 +22,12 @@ public final class OverlayWindowController {
         observeEvents()
     }
 
-    public static func registerIDEWorkspaceWindowOverlayWindowControllerContentProviderFactory(
+    public nonisolated static func registerIDEWorkspaceWindowOverlayWindowControllerContentProviderFactory(
         _ factory: @escaping IDEWorkspaceWindowOverlayWindowControllerContentProviderFactory
     ) {
-        ideWindowOverlayWindowControllerContentProviderFactories.append(factory)
+        Task { @MainActor in
+            ideWindowOverlayWindowControllerContentProviderFactories.append(factory)
+        }
     }
 }
 
@@ -102,11 +105,10 @@ private extension OverlayWindowController {
         let newController = IDEWorkspaceWindowOverlayWindowController(
             inspector: inspector,
             application: application,
-            contentProviderFactory: { [ideWindowOverlayWindowControllerContentProviderFactories]
+            contentProviderFactory: {
                 windowInspector, application in
-                    ideWindowOverlayWindowControllerContentProviderFactories.map {
-                        $0(windowInspector, application)
-                    }
+                OverlayWindowController.ideWindowOverlayWindowControllerContentProviderFactories
+                    .map { $0(windowInspector, application) }
             }
         )
         newController.access()

Tool/Package.swift

@@ -34,7 +34,7 @@ let package = Package(
         .library(
             name: "SuggestionProvider",
             targets: ["SuggestionProvider", "GitHubCopilotService", "CodeiumService"]
-        ), 
+        ),
         .library(
             name: "AppMonitoring",
             targets: [