Filter the directory change stream

Author: thecoolwinter

CodeEdit/Features/CEWorkspace/Models/CEWorkspaceFileManager+DirectoryEvents.swift

@@ -9,25 +9,35 @@ import Foundation
 
 /// This extension handles the file system events triggered by changes in the root folder.
 extension CEWorkspaceFileManager {
+    struct ResolvedFSEvent: Hashable {
+        let file: CEWorkspaceFile
+        let eventType: FSEvent
+    }
+
     /// Called by `fsEventStream` when an event occurs.
     ///
     /// This method may be called on a background thread, but all work done by this function will be queued on the main
     /// thread.
     /// - Parameter events: An array of events that occurred.
     func fileSystemEventReceived(events: [DirectoryEventStream.Event]) {
         DispatchQueue.main.async {
-            var files: Set<CEWorkspaceFile> = []
+            var files: Set<ResolvedFSEvent> = []
             for event in events {
                 // Event returns file/folder that was changed, but in tree we need to update it's parent
-                guard let parentUrl = URL(string: event.path, relativeTo: self.folderUrl)?.deletingLastPathComponent(),
-                      let parentFileItem = self.flattenedFileItems[parentUrl.path] else {
+                guard let eventFileUrl = URL(string: event.path, relativeTo: self.folderUrl) else {
+                    continue
+                }
+                let parentUrl = eventFileUrl.deletingLastPathComponent()
+                guard let parentFileItem = self.flattenedFileItems[parentUrl.path] else {
                     continue
                 }
 
                 switch event.eventType {
                 case .changeInDirectory, .itemChangedOwner, .itemModified:
-                    // Can be ignored for now, these I think not related to tree changes
                     continue
+//                    if let fileItem = self.flattenedFileItems[eventFileUrl.path] {
+//                        files.insert(ResolvedFSEvent(file: fileItem, eventType: event.eventType))
+//                    }
                 case .rootChanged:
                     // TODO: #1880 - Handle workspace root changing.
                     continue
@@ -38,7 +48,7 @@ extension CEWorkspaceFileManager {
                         // swiftlint:disable:next line_length
                         self.logger.error("Failed to rebuild files for event: \(event.eventType.rawValue), path: \(event.path, privacy: .sensitive)")
                     }
-                    files.insert(parentFileItem)
+                    files.insert(ResolvedFSEvent(file: parentFileItem, eventType: event.eventType))
                 }
             }
             if !files.isEmpty {
@@ -182,13 +192,17 @@ extension CEWorkspaceFileManager {
     }
 
     /// Notify observers that an update occurred in the watched files.
-    func notifyObservers(updatedItems: Set<CEWorkspaceFile>) {
+    func notifyObservers(updatedItems: Set<ResolvedFSEvent>) {
         observers.allObjects.reversed().forEach { delegate in
             guard let delegate = delegate as? CEWorkspaceFileManagerObserver else {
                 observers.remove(delegate)
                 return
             }
-            delegate.fileManagerUpdated(updatedItems: updatedItems)
+            let eventsFilter = delegate.fileManagerEventsFilter()
+            let events = updatedItems.compactMap({ eventsFilter.contains($0.eventType) ? $0.file : nil })
+            if !events.isEmpty {
+                delegate.fileManagerUpdated(updatedItems: Set(events))
+            }
         }
     }
 

CodeEdit/Features/CEWorkspace/Models/CEWorkspaceFileManager+FileManagement.swift

@@ -38,7 +38,10 @@ extension CEWorkspaceFileManager {
             )
 
             try rebuildFiles(fromItem: file.isFolder ? file : file.parent ?? file)
-            notifyObservers(updatedItems: [file.isFolder ? file : file.parent ?? file])
+            notifyObservers(updatedItems: [ResolvedFSEvent(
+                file: file.isFolder ? file : file.parent ?? file,
+                eventType: .itemCreated
+            )])
 
             guard let newFolder = getFile(folderUrl.path(), createIfNotFound: true) else {
                 throw FileManagerError.fileNotFound
@@ -103,7 +106,10 @@ extension CEWorkspaceFileManager {
             }
 
             try rebuildFiles(fromItem: file.isFolder ? file : file.parent ?? file)
-            notifyObservers(updatedItems: [file.isFolder ? file : file.parent ?? file])
+            notifyObservers(updatedItems: [ResolvedFSEvent(
+                file: file.isFolder ? file : file.parent ?? file,
+                eventType: .itemCreated
+            )])
 
             // Create if not found here because this should be indexed if we're creating it.
             // It's not often a user makes a file and then doesn't use it.
@@ -284,13 +290,13 @@ extension CEWorkspaceFileManager {
 
             if let parent = file.parent {
                 try rebuildFiles(fromItem: parent)
-                notifyObservers(updatedItems: [parent])
+                notifyObservers(updatedItems: [ResolvedFSEvent(file: parent, eventType: .changeInDirectory)])
             }
 
             // If we have the new parent file, let's rebuild that directory too
             if let newFileParent = getFile(newLocation.deletingLastPathComponent().path) {
                 try rebuildFiles(fromItem: newFileParent)
-                notifyObservers(updatedItems: [newFileParent])
+                notifyObservers(updatedItems: [ResolvedFSEvent(file: newFileParent, eventType: .changeInDirectory)])
             }
 
             return getFile(newLocation.absoluteURL.path)

CodeEdit/Features/CEWorkspace/Models/CEWorkspaceFileManager.swift

@@ -11,9 +11,16 @@ import AppKit
 import OSLog
 
 protocol CEWorkspaceFileManagerObserver: AnyObject {
+    func fileManagerEventsFilter() -> Set<FSEvent>
     func fileManagerUpdated(updatedItems: Set<CEWorkspaceFile>)
 }
 
+extension CEWorkspaceFileManagerObserver {
+    func fileManagerEventsFilter() -> Set<FSEvent> {
+        FSEvent.all()
+    }
+}
+
 /// This class is used to load, modify, and listen to files on a user's machine.
 ///
 /// The workspace file manager provides an API for:

CodeEdit/Features/CEWorkspace/Models/DirectoryEventStream.swift

@@ -16,6 +16,19 @@ enum FSEvent: String {
     case itemModified
     case itemRemoved
     case itemRenamed
+
+    static func all() -> Set<FSEvent> {
+        [
+            .changeInDirectory,
+            .rootChanged,
+            .itemChangedOwner,
+            .itemCreated,
+            .itemCloned,
+            .itemModified,
+            .itemRemoved,
+            .itemRenamed
+        ]
+    }
 }
 
 /// Creates a stream of events using the File System Events API.

CodeEdit/Features/Documents/WorkspaceDocument/WorkspaceDocument.swift

@@ -164,6 +164,7 @@ final class WorkspaceDocument: NSDocument, ObservableObject, NSToolbarDelegate {
             )
         }
 
+        workspaceFileManager?.addObserver(undoRegistration)
         editorManager?.restoreFromState(self)
         utilityAreaModel?.restoreFromState(self)
     }

CodeEdit/Features/Editor/Models/Restoration/UndoManagerRegistration.swift

@@ -16,20 +16,55 @@ import CodeEditTextView
 /// - `CodeFileDocument` is released once there are no editors viewing it.
 /// Undo stacks need to be retained for the duration of a workspace session, enduring editor closes..
 final class UndoManagerRegistration: ObservableObject {
-    private var managerMap: [CEWorkspaceFile.ID: CEUndoManager] = [:]
+    private var managerMap: [String: CEUndoManager] = [:]
 
     init() { }
 
     /// Find or create a new undo manager.
     /// - Parameter file: The file to create for.
     /// - Returns: The undo manager for the given file.
     func manager(forFile file: CEWorkspaceFile) -> CEUndoManager {
-        if let manager = managerMap[file.id] {
+        manager(forFile: file.url)
+    }
+
+    /// Find or create a new undo manager.
+    /// - Parameter path: The path of the file to create for.
+    /// - Returns: The undo manager for the given file.
+    func manager(forFile path: URL) -> CEUndoManager {
+        if let manager = managerMap[path.absolutePath] {
             return manager
         } else {
             let newManager = CEUndoManager()
-            managerMap[file.id] = newManager
+            managerMap[path.absolutePath] = newManager
             return newManager
         }
     }
+
+    /// Find or create a new undo manager.
+    /// - Parameter path: The path of the file to create for.
+    /// - Returns: The undo manager for the given file.
+    func managerIfExists(forFile path: URL) -> CEUndoManager? {
+        managerMap[path.absolutePath]
+    }
+}
+
+extension UndoManagerRegistration: CEWorkspaceFileManagerObserver {
+    func fileManagerEventsFilter() -> Set<FSEvent> {
+        [.itemModified, .itemRemoved]
+    }
+
+    /// Managers need to be cleared when the following is true:
+    /// - The file is not open in any editors
+    /// - The file is updated externally
+    ///
+    /// To handle this?
+    /// - When we receive a file update, if the file is not open in any editors we clear the undo stack
+    func fileManagerUpdated(updatedItems: Set<CEWorkspaceFile>) {
+        for file in updatedItems where file.fileDocument == nil {
+            if managerMap[file.url.absolutePath] != nil {
+                print("Clearing undo stack for file \(file.fileName())")
+            }
+            managerMap.removeValue(forKey: file.url.absolutePath)
+        }
+    }
 }

CodeEdit/Features/SourceControl/SourceControlManager+GitClient.swift

@@ -135,7 +135,7 @@ extension SourceControlManager {
             return
         }
 
-        var updatedStatusFor: Set<CEWorkspaceFile> = []
+        var updatedStatusFor: Set<CEWorkspaceFileManager.ResolvedFSEvent> = []
         // Refresh status of file manager files
         for changedFile in changedFiles {
             guard let file = fileManager.getFile(changedFile.ceFileKey) else {
@@ -144,13 +144,13 @@ extension SourceControlManager {
             if file.gitStatus != changedFile.anyStatus() {
                 file.gitStatus = changedFile.anyStatus()
             }
-            updatedStatusFor.insert(file)
+            updatedStatusFor.insert(.init(file: file, eventType: .itemModified))
         }
 
         for (_, file) in fileManager.flattenedFileItems
-        where !updatedStatusFor.contains(file) && file.gitStatus != nil {
+        where !updatedStatusFor.contains(.init(file: file, eventType: .itemModified)) && file.gitStatus != nil {
             file.gitStatus = nil
-            updatedStatusFor.insert(file)
+            updatedStatusFor.insert(.init(file: file, eventType: .itemModified))
         }
 
         if updatedStatusFor.isEmpty {