Marked IgnorePatternModel with @mainactor. More documentation. Refactored Limiter to use Timer API and removed unused throttle method.

Author: austincondiff

CodeEdit/Features/Settings/Pages/SourceControlSettings/Models/IgnorePatternModel.swift

@@ -8,8 +8,12 @@
 import Foundation
 
 /// A model to manage Git ignore patterns for a file, including loading, saving, and monitoring changes.
+@MainActor
 class IgnorePatternModel: ObservableObject {
+    /// Indicates whether patterns are currently being loaded from the Git ignore file.
     @Published var loadingPatterns: Bool = false
+
+    /// A collection of Git ignore patterns being managed by this model.
     @Published var patterns: [GlobPattern] = [] {
         didSet {
             if !loadingPatterns {
@@ -19,11 +23,19 @@ class IgnorePatternModel: ObservableObject {
             }
         }
     }
+
+    /// Tracks the selected patterns by their unique identifiers (UUIDs).
     @Published var selection: Set<UUID> = []
 
+    /// A client for interacting with the Git configuration.
     private let gitConfig = GitConfigClient(shellClient: currentWorld.shellClient)
+
+    /// A file system monitor for detecting changes to the Git ignore file.
     private var fileMonitor: DispatchSourceFileSystemObject?
 
+    /// Task tracking the current save operation
+    private var savingTask: Task<Void, Never>?
+
     init() {
         Task {
             try? await startFileMonitor()
@@ -32,7 +44,9 @@ class IgnorePatternModel: ObservableObject {
     }
 
     deinit {
-        stopFileMonitor()
+        Task { @MainActor [weak self] in
+            self?.stopFileMonitor()
+        }
     }
 
     /// Resolves the URL for the Git ignore file.
@@ -69,9 +83,7 @@ class IgnorePatternModel: ObservableObject {
         )
 
         source.setEventHandler {
-            Task {
-                await self.loadPatterns()
-            }
+            Task { await self.loadPatterns() }
         }
 
         source.setCancelHandler {
@@ -91,40 +103,30 @@ class IgnorePatternModel: ObservableObject {
 
     /// Loads patterns from the Git ignore file into the `patterns` property.
     func loadPatterns() async {
-        await MainActor.run { loadingPatterns = true } // Ensure `loadingPatterns` is updated on the main thread
+        loadingPatterns = true
 
         do {
             let fileURL = try await gitIgnoreURL()
             guard FileManager.default.fileExists(atPath: fileURL.path) else {
-                await MainActor.run {
-                    patterns = []
-                    loadingPatterns = false // Update on the main thread
-                }
+                patterns = []
+                loadingPatterns = false
                 return
             }
 
             if let content = try? String(contentsOf: fileURL) {
-                let parsedPatterns = content.split(separator: "\n")
+                patterns = content.split(separator: "\n")
                     .map { $0.trimmingCharacters(in: .whitespacesAndNewlines) }
                     .filter { !$0.isEmpty && !$0.starts(with: "#") }
                     .map { GlobPattern(value: String($0)) }
-
-                await MainActor.run {
-                    patterns = parsedPatterns // Update `patterns` on the main thread
-                    loadingPatterns = false  // Ensure `loadingPatterns` is updated on the main thread
-                }
+                loadingPatterns = false
             } else {
-                await MainActor.run {
-                    patterns = []
-                    loadingPatterns = false
-                }
-            }
-        } catch {
-            print("Error loading patterns: \(error)")
-            await MainActor.run {
                 patterns = []
                 loadingPatterns = false
             }
+        } catch {
+            print("Error loading patterns: \(error)")
+            patterns = []
+            loadingPatterns = false
         }
     }
 
@@ -137,9 +139,16 @@ class IgnorePatternModel: ObservableObject {
 
     /// Saves the current patterns back to the Git ignore file.
     func savePatterns() {
-        Task {
+        // Cancel the existing task if it exists
+        savingTask?.cancel()
+
+        // Start a new task for saving patterns
+        savingTask = Task {
             stopFileMonitor()
-            defer { Task { try? await startFileMonitor() } }
+            defer {
+                savingTask = nil // Clear the task when done
+                Task { try? await startFileMonitor() }
+            }
 
             do {
                 let fileURL = try await gitIgnoreURL()
@@ -283,13 +292,12 @@ class IgnorePatternModel: ObservableObject {
     }
 
     /// Adds a new, empty pattern to the list of patterns.
-    @MainActor
     func addPattern() {
         patterns.append(GlobPattern(value: ""))
     }
+
     /// Removes the specified patterns from the list of patterns.
     /// - Parameter selection: The set of UUIDs for the patterns to remove. If `nil`, no patterns are removed.
-    @MainActor
     func removePatterns(_ selection: Set<UUID>? = nil) {
         let patternsToRemove = selection?.compactMap { getPattern(for: $0) } ?? []
         patterns.removeAll { patternsToRemove.contains($0) }

CodeEdit/Features/Settings/Pages/SourceControlSettings/SourceControlGitView.swift

@@ -55,6 +55,8 @@ struct SourceControlGitView: View {
             }
         }
         .onAppear {
+            // Intentionally using an onAppear with a Task instead of just a .task modifier.
+            // When we did this it was executing too often.
             Task {
                 authorName = try await gitConfig.get(key: "user.name", global: true) ?? ""
                 authorEmail = try await gitConfig.get(key: "user.email", global: true) ?? ""

CodeEdit/Utils/Limiter.swift

@@ -11,7 +11,7 @@ import Foundation
 // TODO: Look into improving this API by using async by default so `Task` isn't needed when used.
 enum Limiter {
     // Keep track of debounce timers and throttle states
-    private static var debounceTimers: [AnyHashable: AnyCancellable] = [:]
+    private static var debounceTimers: [AnyHashable: Timer] = [:]
     private static var throttleLastExecution: [AnyHashable: Date] = [:]
 
     /// Debounces an action with a specified duration and identifier.
@@ -21,31 +21,10 @@ enum Limiter {
     ///   - action: The action to be executed after the debounce period.
     static func debounce(id: AnyHashable, duration: TimeInterval, action: @escaping () -> Void) {
         // Cancel any existing debounce timer for the given ID
-        debounceTimers[id]?.cancel()
-
+        debounceTimers[id]?.invalidate()
         // Start a new debounce timer for the given ID
-        debounceTimers[id] = Timer.publish(every: duration, on: .main, in: .common)
-            .autoconnect()
-            .first()
-            .sink { _ in
-                action()
-                debounceTimers[id] = nil
-            }
-    }
-
-    /// Throttles an action with a specified duration and identifier.
-    /// - Parameters:
-    ///   - id: A unique identifier for the throttled action.
-    ///   - duration: The throttle duration in seconds.
-    ///   - action: The action to be executed after the throttle period.
-    static func throttle(id: AnyHashable, duration: TimeInterval, action: @escaping () -> Void) {
-        // Check the time of the last execution for the given ID
-        if let lastExecution = throttleLastExecution[id], Date().timeIntervalSince(lastExecution) < duration {
-            return // Skip this call if it's within the throttle duration
+        debounceTimers[id] = Timer.scheduledTimer(withTimeInterval: duration, repeats: false) { _ in
+            action()
         }
-
-        // Update the last execution time and perform the action
-        throttleLastExecution[id] = Date()
-        action()
     }
 }