Fix stale Spotlight results for posts and sites

Modules/Sources/WordPressData/Swift/AbstractPost+Searchable.swift

@@ -21,12 +21,7 @@ extension AbstractPost: SearchableItemConvertable {
     }
 
     public var searchDomain: String? {
-        if let dotComID = blog.dotComID, dotComID.intValue > 0 {
-            return dotComID.stringValue
-        } else {
-            // This is a self-hosted site, set domain to the xmlrpc string
-            return blog.xmlrpc
-        }
+        return blog.searchDomain
     }
 
     public var searchTitle: String? {
@@ -78,3 +73,16 @@ fileprivate extension AbstractPost {
         return "[\(AbstractPost.title(for: status))] \(title)"
     }
 }
+
+extension Blog {
+    /// The Spotlight domain identifier shared by every item indexed for this
+    /// site, so the site's items can be removed together.
+    public var searchDomain: String? {
+        if let dotComID, dotComID.intValue > 0 {
+            return dotComID.stringValue
+        } else {
+            // This is a self-hosted site, set domain to the xmlrpc string
+            return xmlrpc
+        }
+    }
+}

Tests/KeystoneTests/Tests/Services/PostCoordinatorTests.swift

@@ -320,6 +320,13 @@ class PostCoordinatorTests: CoreDataTestCase {
 
     /// Scenario: syncing changes to an existing draft that was permanently deleted.
     func testSyncPermanentlyDeletedPost() async throws {
+        let searchManager = SearchManagerSpy()
+        coordinator = PostCoordinator(
+            mediaCoordinator: mediaCoordinator,
+            coreDataStack: contextManager,
+            searchManager: searchManager
+        )
+
         // GIVEN a draft post that needs sync
         let post = PostBuilder(mainContext, blog: blog).build()
         post.postID = 974
@@ -330,6 +337,7 @@ class PostCoordinatorTests: CoreDataTestCase {
 
         let revision1 = post.createRevision()
         revision1.content = "content-b"
+        let searchableIdentifier = try XCTUnwrap(post.uniqueIdentifier)
 
         // GIVEN a server where the post was deleted
         stub(condition: isPath("/rest/v1.2/sites/80511/posts/974")) { _ in
@@ -357,6 +365,7 @@ class PostCoordinatorTests: CoreDataTestCase {
 
         // THEN post got deleted from the database
         XCTAssertNil(post.managedObjectContext)
+        XCTAssertEqual(searchManager.deletedIdentifiers, [searchableIdentifier])
     }
 
     func testPauseSyncing() async throws {
@@ -615,6 +624,18 @@ class PostCoordinatorTests: CoreDataTestCase {
     }
 }
 
+private final class SearchManagerSpy: SearchManaging {
+    private(set) var deletedIdentifiers: [String] = []
+
+    func indexItem(_ item: SearchableItemConvertable) {}
+
+    func deleteSearchableItem(_ item: SearchableItemConvertable) {}
+
+    func deleteSearchableItems(withIdentifiers identifiers: [String]) {
+        deletedIdentifiers.append(contentsOf: identifiers)
+    }
+}
+
 private let mediaResponse = """
     {
       "media": [

WordPress/Classes/Services/BlogService.m

@@ -317,6 +317,7 @@ - (void)removeBlog:(Blog *)blog
     [self unscheduleBloggingRemindersFor:blog];
     [self removeWordPressApiCachedDataForBlog:blog];
     [self evictWordPressClientForBlog:blog];
+    [[SearchManager shared] deleteSearchableItemsForBlog:blog];
 
     WPAccount *account = blog.account;
 
@@ -385,6 +386,7 @@ - (void)mergeBlogs:(NSArray<RemoteBlog *> *)blogs withAccountID:(NSManagedObject
             if ([toDelete containsObject:blog.dotComID]) {
                 [self unscheduleBloggingRemindersFor:blog];
                 [self evictWordPressClientForBlog:blog];
+                [[SearchManager shared] deleteSearchableItemsForBlog:blog];
                 // Consider switching this to a call to removeBlog in the future
                 // to consolidate behaviour @frosty
                 [context deleteObject:blog];

WordPress/Classes/Services/PostCoordinator.swift

@@ -13,6 +13,14 @@ protocol PostCoordinatorDelegate: AnyObject {
     func postCoordinator(_ postCoordinator: PostCoordinator, promptForPasswordForBlog blog: Blog)
 }
 
+protocol SearchManaging {
+    func indexItem(_ item: SearchableItemConvertable)
+    func deleteSearchableItem(_ item: SearchableItemConvertable)
+    func deleteSearchableItems(withIdentifiers identifiers: [String])
+}
+
+extension SearchManager: SearchManaging {}
+
 class PostCoordinator: NSObject {
 
     enum SavingError: Error, LocalizedError, CustomNSError {
@@ -56,6 +64,7 @@ class PostCoordinator: NSObject {
 
     private let mediaCoordinator: MediaCoordinator
     private let actionDispatcherFacade: ActionDispatcherFacade
+    private let searchManager: SearchManaging
 
     /// The initial sync retry delay. By default, 15 seconds.
     var syncRetryDelay: TimeInterval = 15
@@ -64,10 +73,12 @@ class PostCoordinator: NSObject {
 
     init(mediaCoordinator: MediaCoordinator? = nil,
          actionDispatcherFacade: ActionDispatcherFacade = ActionDispatcherFacade(),
-         coreDataStack: CoreDataStackSwift = ContextManager.shared) {
+         coreDataStack: CoreDataStackSwift = ContextManager.shared,
+         searchManager: SearchManaging = SearchManager.shared) {
         self.coreDataStack = coreDataStack
         self.mediaCoordinator = mediaCoordinator ?? MediaCoordinator.shared
         self.actionDispatcherFacade = actionDispatcherFacade
+        self.searchManager = searchManager
 
         super.init()
 
@@ -97,7 +108,7 @@ class PostCoordinator: NSObject {
         } else if post.status == .publish {
             notifyNewPostPublished()
         }
-        SearchManager.shared.indexItem(post)
+        searchManager.indexItem(post)
         AppRatingUtility.shared.incrementSignificantEvent()
     }
 
@@ -127,13 +138,17 @@ class PostCoordinator: NSObject {
             let repository = PostRepository(coreDataStack: coreDataStack)
             try await repository.save(post, changes: changes)
 
+            // Keep Spotlight current for every save, not only for the
+            // transition to scheduled or published, so edits to the title
+            // or content of an existing post reach the index.
+            searchManager.indexItem(post)
+
             if previousStatus != post.status && post.isStatus(in: [.scheduled, .publish]) {
                 if post.status == .scheduled {
                     notifyNewPostScheduled()
                 } else if post.status == .publish {
                     notifyNewPostPublished()
                 }
-                SearchManager.shared.indexItem(post)
                 AppRatingUtility.shared.incrementSignificantEvent()
             }
             show(PostCoordinator.makeUploadSuccessNotice(for: post, previousStatus: previousStatus))
@@ -217,9 +232,13 @@ class PostCoordinator: NSObject {
     }
 
     private func handlePermanentlyDeleted(_ post: AbstractPost) {
+        let searchableIdentifier = post.uniqueIdentifier
         let context = coreDataStack.mainContext
         context.deleteObject(post)
         ContextManager.shared.saveContextAndWait(context)
+        if let searchableIdentifier {
+            searchManager.deleteSearchableItems(withIdentifiers: [searchableIdentifier])
+        }
     }
 
     private func show(_ notice: Notice) {
@@ -892,7 +911,7 @@ class PostCoordinator: NSObject {
             try await PostRepository(coreDataStack: coreDataStack).trash(post)
 
             MediaCoordinator.shared.cancelUploadOfAllMedia(for: post)
-            SearchManager.shared.deleteSearchableItem(post)
+            searchManager.deleteSearchableItem(post)
         } catch {
             trackError(error, operation: "post-trash", post: post)
             handleError(error, for: post)
@@ -906,8 +925,14 @@ class PostCoordinator: NSObject {
         setUpdating(true, for: post)
         defer { setUpdating(false, for: post) }
 
+        // Capture the identifier first: the managed object is gone once the
+        // deletion succeeds.
+        let searchableIdentifier = post.uniqueIdentifier
         do {
             try await PostRepository(coreDataStack: coreDataStack).delete(post)
+            if let searchableIdentifier {
+                searchManager.deleteSearchableItems(withIdentifiers: [searchableIdentifier])
+            }
         } catch {
             trackError(error, operation: "post-delete", post: post)
             handleError(error, for: post)

WordPress/Classes/Utility/Spotlight/SearchManager.swift

@@ -59,7 +59,16 @@ import WordPressData
     ///   - items: items to remove
     ///
     @objc func deleteSearchableItems(_ items: [SearchableItemConvertable]) {
-        let ids = items.map({ $0.uniqueIdentifier }).compactMap({ $0 })
+        deleteSearchableItems(withIdentifiers: items.compactMap { $0.uniqueIdentifier })
+    }
+
+    /// Remove items from the on-device index by their unique identifiers.
+    /// Use this when the item's managed object is already gone.
+    ///
+    /// - Parameters:
+    ///   - ids: unique identifiers of the items to remove
+    ///
+    @objc func deleteSearchableItems(withIdentifiers ids: [String]) {
         guard !ids.isEmpty else {
             return
         }
@@ -72,6 +81,20 @@ import WordPressData
         })
     }
 
+    /// Removes every item indexed for a site. Call it before the site is
+    /// deleted from Core Data, while its domain is still available.
+    ///
+    /// - Parameters:
+    ///   - blog: the site being removed
+    ///
+    @objc(deleteSearchableItemsForBlog:)
+    func deleteSearchableItems(for blog: Blog) {
+        guard let domain = blog.searchDomain else {
+            return
+        }
+        deleteAllSearchableItemsFromDomain(domain)
+    }
+
     /// Removes all items with the given domain identifier from the on-device index
     ///
     /// - Parameters: