Fix WorkspaceDocument Leak (#1808)

Author: thecoolwinter

CodeEdit.xcodeproj/project.pbxproj

@@ -1,5 +1,5 @@
 {
-  "originHash" : "f3dd40f19b32a2b522dee7a1e94ceb60afbdb1a028938883adffc7328ef9d804",
+  "originHash" : "a33fcca819dee4c816b1474e19017510b1d62b170c921187042e0675d3f4b0b3",
   "pins" : [
     {
       "identity" : "anycodable",
@@ -31,10 +31,10 @@
     {
       "identity" : "codeeditsourceeditor",
       "kind" : "remoteSourceControl",
-      "location" : "https://github.com/CodeEditApp/CodeEditSourceEditor.git",
+      "location" : "https://github.com/CodeEditApp/CodeEditSourceEditor",
       "state" : {
-        "revision" : "cf85789d527d569e94edfd674c5ac8071b244dd9",
-        "version" : "0.7.3"
+        "revision" : "4e014f71d7be053ea8d05f6c0e45be268f9a0d64",
+        "version" : "0.7.4"
       }
     },
     {
@@ -136,15 +136,6 @@
         "version" : "1.3.0"
       }
     },
-    {
-      "identity" : "mainoffender",
-      "kind" : "remoteSourceControl",
-      "location" : "https://github.com/mattmassicotte/MainOffender",
-      "state" : {
-        "revision" : "8de872d9256ff7f9913cbc5dd560568ab164be45",
-        "version" : "0.2.1"
-      }
-    },
     {
       "identity" : "processenv",
       "kind" : "remoteSourceControl",
@@ -258,17 +249,17 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/ChimeHQ/TextFormation",
       "state" : {
-        "revision" : "f6faed6abd768ae95b70d10113d4008a7cac57a7",
-        "version" : "0.8.2"
+        "revision" : "b1ce9a14bd86042bba4de62236028dc4ce9db6a1",
+        "version" : "0.9.0"
       }
     },
     {
       "identity" : "textstory",
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/ChimeHQ/TextStory",
       "state" : {
-        "revision" : "8883fa739aa213e70e6cb109bfbf0a0b551e4cb5",
-        "version" : "0.8.0"
+        "revision" : "8dc9148b46fcf93b08ea9d4ef9bdb5e4f700e008",
+        "version" : "0.9.0"
       }
     }
   ],

CodeEdit.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -13,7 +13,7 @@ final class AppDelegate: NSObject, NSApplicationDelegate, ObservableObject {
     private let updater = SoftwareUpdater()
 
     @Environment(\.openWindow)
-    private var openWindow
+    var openWindow
 
     func applicationDidFinishLaunching(_ notification: Notification) {
         setupServiceContainer()
@@ -209,8 +209,8 @@ final class AppDelegate: NSObject, NSApplicationDelegate, ObservableObject {
             defaults.removeObject(forKey: "openInCEFiles")
         }
 
-        DispatchQueue.main.asyncAfter(deadline: .now() + 1) {
-            self.checkForFilesToOpen()
+        DispatchQueue.main.asyncAfter(deadline: .now() + 1) { [weak self] in
+            self?.checkForFilesToOpen()
         }
     }
 

CodeEdit/AppDelegate.swift

@@ -85,11 +85,11 @@ final class CEWorkspaceFile: Codable, Comparable, Hashable, Identifiable, Editor
     /// Returns a parent ``CEWorkspaceFile``.
     ///
     /// If the item already is the top-level ``CEWorkspaceFile`` this returns `nil`.
-    var parent: CEWorkspaceFile?
+    weak var parent: CEWorkspaceFile?
 
     private let fileDocumentSubject = PassthroughSubject<CodeFileDocument?, Never>()
 
-    var fileDocument: CodeFileDocument? {
+    weak var fileDocument: CodeFileDocument? {
         didSet {
             fileDocumentSubject.send(fileDocument)
         }

CodeEdit/Features/CEWorkspace/Models/CEWorkspaceFile.swift

@@ -387,6 +387,7 @@ final class CEWorkspaceFileManager {
     }
 
     deinit {
+        fsEventStream?.cancel()
         observers.removeAllObjects()
     }
 }

CodeEdit/Features/CEWorkspace/Models/CEWorkspaceFileManager.swift

@@ -10,20 +10,12 @@ import Combine
 
 /// The CodeEdit workspace settings model.
 final class CEWorkspaceSettings: ObservableObject {
-    @ObservedObject private var workspace: WorkspaceDocument
     @Published public var preferences: CEWorkspaceSettingsData = .init()
 
-    private var storeTask: AnyCancellable!
+    private var storeTask: AnyCancellable?
     private let fileManager = FileManager.default
 
-    private var folderURL: URL? {
-        guard let workspaceURL = workspace.fileURL else {
-            return nil
-        }
-
-        return workspaceURL
-            .appendingPathComponent(".codeedit", isDirectory: true)
-    }
+    private(set) var folderURL: URL?
 
     private var settingsURL: URL? {
         folderURL?
@@ -32,15 +24,23 @@ final class CEWorkspaceSettings: ObservableObject {
     }
 
     init(workspaceDocument: WorkspaceDocument) {
-        self.workspace = workspaceDocument
-
+        folderURL = workspaceDocument.fileURL?.appendingPathComponent(".codeedit", isDirectory: true)
         loadSettings()
 
         self.storeTask = self.$preferences.throttle(for: 2.0, scheduler: RunLoop.main, latest: true).sink {
             try? self.savePreferences($0)
         }
     }
 
+    func cleanUp() {
+        storeTask?.cancel()
+        storeTask = nil
+    }
+
+    deinit {
+        cleanUp()
+    }
+
     /// Load and construct ``CEWorkspaceSettings`` model from `.codeedit/settings.json`
     private func loadSettings() {
         if let settingsURL = settingsURL {

CodeEdit/Features/CEWorkspace/Models/CEWorkspaceSettings.swift

@@ -11,8 +11,8 @@ import Combine
 
 /// A view that pops up a branch picker.
 struct ToolbarBranchPicker: View {
-    private var workspaceFileManager: CEWorkspaceFileManager?
-    private var sourceControlManager: SourceControlManager?
+    private weak var workspaceFileManager: CEWorkspaceFileManager?
+    private weak var sourceControlManager: SourceControlManager?
 
     @Environment(\.controlActiveState)
     private var controlActive

CodeEdit/Features/CodeEditUI/Views/ToolbarBranchPicker.swift

@@ -31,7 +31,7 @@ struct QuickActionsView: View {
 
     func callHandler(command: Command) {
         closePalette()
-        command.closureWrapper.call()
+        command.closureWrapper()
         selectedItem = nil
         state.commandQuery = ""
         state.filteredCommands = []

CodeEdit/Features/Commands/Views/QuickActionsView.swift

@@ -14,8 +14,8 @@ final class CodeEditSplitViewController: NSSplitViewController {
     static let snapWidth: CGFloat = 272
     static let minSnapWidth: CGFloat = snapWidth - 10
 
-    private var workspace: WorkspaceDocument
-    private var navigatorViewModel: NavigatorSidebarViewModel
+    private weak var workspace: WorkspaceDocument?
+    private weak var navigatorViewModel: NavigatorSidebarViewModel?
     private weak var windowRef: NSWindow?
     private unowned var hapticPerformer: NSHapticFeedbackPerformer
 
@@ -47,12 +47,20 @@ final class CodeEditSplitViewController: NSSplitViewController {
             return
         }
 
+        guard let workspace,
+              let navigatorViewModel,
+              let editorManager = workspace.editorManager,
+              let statusBarViewModel = workspace.statusBarViewModel,
+              let utilityAreaModel = workspace.utilityAreaModel else {
+            return
+        }
+
         splitView.translatesAutoresizingMaskIntoConstraints = false
 
         let settingsView = SettingsInjector {
             NavigatorAreaView(workspace: workspace, viewModel: navigatorViewModel)
                 .environmentObject(workspace)
-                .environmentObject(workspace.editorManager)
+                .environmentObject(editorManager)
         }
 
         let navigator = NSSplitViewItem(sidebarWithViewController: NSHostingController(rootView: settingsView))
@@ -64,12 +72,12 @@ final class CodeEditSplitViewController: NSSplitViewController {
         addSplitViewItem(navigator)
 
         let workspaceView = SettingsInjector {
-            WindowObserver(window: windowRef) {
+            WindowObserver(window: WindowBox(value: windowRef)) {
                 WorkspaceView()
                     .environmentObject(workspace)
-                    .environmentObject(workspace.editorManager)
-                    .environmentObject(workspace.statusBarViewModel)
-                    .environmentObject(workspace.utilityAreaModel)
+                    .environmentObject(editorManager)
+                    .environmentObject(statusBarViewModel)
+                    .environmentObject(utilityAreaModel)
             }
         }
 
@@ -82,7 +90,7 @@ final class CodeEditSplitViewController: NSSplitViewController {
         let inspectorView = SettingsInjector {
             InspectorAreaView(viewModel: InspectorAreaViewModel())
                 .environmentObject(workspace)
-                .environmentObject(workspace.editorManager)
+                .environmentObject(editorManager)
         }
 
         let inspector = NSSplitViewItem(inspectorWithViewController: NSHostingController(rootView: inspectorView))
@@ -98,6 +106,8 @@ final class CodeEditSplitViewController: NSSplitViewController {
     override func viewWillAppear() {
         super.viewWillAppear()
 
+        guard let workspace else { return }
+
         let navigatorWidth = workspace.getFromWorkspaceState(.splitViewWidth) as? CGFloat
         splitView.setPosition(navigatorWidth ?? Self.minSidebarWidth, ofDividerAt: 0)
 
@@ -178,16 +188,16 @@ final class CodeEditSplitViewController: NSSplitViewController {
             let panel = splitView.subviews[0]
             let width = panel.frame.size.width
             if width > 0 {
-                workspace.addToWorkspaceState(key: .splitViewWidth, value: width)
+                workspace?.addToWorkspaceState(key: .splitViewWidth, value: width)
             }
         }
     }
 
     func saveNavigatorCollapsedState(isCollapsed: Bool) {
-        workspace.addToWorkspaceState(key: .navigatorCollapsed, value: isCollapsed)
+        workspace?.addToWorkspaceState(key: .navigatorCollapsed, value: isCollapsed)
     }
 
     func saveInspectorCollapsedState(isCollapsed: Bool) {
-        workspace.addToWorkspaceState(key: .inspectorCollapsed, value: isCollapsed)
+        workspace?.addToWorkspaceState(key: .inspectorCollapsed, value: isCollapsed)
     }
 }