Merge pull request #3597 from ilandikov/feat-auto-update-global-filter

feat: redraw search results after global filter is edited

Author: claremacrae

src/Config/SettingsTab.ts

@@ -110,12 +110,20 @@ export class SettingsTab extends PluginSettingTab {
                 // wide enough for the whole string to be visible.
                 text.setPlaceholder(i18n.t('settings.globalFilter.filter.placeholder'))
                     .setValue(GlobalFilter.getInstance().get())
-                    .onChange(async (value) => {
-                        updateSettings({ globalFilter: value });
-                        GlobalFilter.getInstance().set(value);
-                        await this.plugin.saveSettings();
-                        setSettingVisibility(globalFilterHidden, value.length > 0);
-                    });
+                    .onChange(
+                        debounce(
+                            async (value) => {
+                                updateSettings({ globalFilter: value });
+                                GlobalFilter.getInstance().set(value);
+                                await this.plugin.saveSettings();
+                                setSettingVisibility(globalFilterHidden, value.length > 0);
+
+                                this.events.triggerReloadVault();
+                            },
+                            500,
+                            true,
+                        ),
+                    );
             });
 
         globalFilterHidden = new Setting(containerEl)

src/Obsidian/Cache.ts

@@ -17,6 +17,8 @@ import { DateFallback } from '../DateTime/DateFallback';
 import { getSettings } from '../Config/Settings';
 import { Lazy } from '../lib/Lazy';
 import { Logger, logging } from '../lib/logging';
+import { PerformanceTracker } from '../lib/PerformanceTracker';
+import { GlobalFilter } from '../Config/GlobalFilter';
 import type { TasksEvents } from './TasksEvents';
 import { FileParser } from './FileParser';
 
@@ -31,9 +33,11 @@ export class Cache {
 
     private readonly metadataCache: MetadataCache;
     private readonly metadataCacheEventReferences: EventRef[];
+
     private readonly vault: Vault;
     private readonly workspace: Workspace;
     private readonly vaultEventReferences: EventRef[];
+
     private readonly events: TasksEvents;
     private readonly eventsEventReferences: EventRef[];
 
@@ -72,9 +76,11 @@ export class Cache {
 
         this.metadataCache = metadataCache;
         this.metadataCacheEventReferences = [];
+
         this.vault = vault;
         this.workspace = workspace;
         this.vaultEventReferences = [];
+
         this.events = events;
         this.eventsEventReferences = [];
 
@@ -227,11 +233,20 @@ export class Cache {
             handler({ tasks: this.tasks, state: this.state });
         });
         this.eventsEventReferences.push(requestReference);
+
+        // The caller is responsible for debouncing this:
+        const reloadVaultReference = this.events.onReloadVault(async () => await this.loadVault());
+        this.eventsEventReferences.push(reloadVaultReference);
     }
 
     private loadVault(): Promise<void> {
         this.logger.debug('Cache.loadVault()');
         return this.tasksMutex.runExclusive(async () => {
+            const measureLoad = new PerformanceTracker(
+                `Loading vault with global filter '${GlobalFilter.getInstance().get()}'`,
+            );
+            measureLoad.start();
+
             this.state = State.Initializing;
             this.logger.debug('Cache.loadVault(): state = Initializing');
 
@@ -244,6 +259,11 @@ export class Cache {
             // TODO Why is this displayed twice:
             this.logger.debug('Cache.loadVault(): state = Warm');
 
+            // Report that we have finished loading before notifying subscribers,
+            // so we don't double-count things like redrawing search results.
+            // These have their own timer code.
+            measureLoad.finish();
+
             // Notify that the cache is now warm:
             this.notifySubscribers();
         });

src/Obsidian/TasksEvents.ts

@@ -8,6 +8,7 @@ enum Event {
     CacheUpdate = 'obsidian-tasks-plugin:cache-update',
     RequestCacheUpdate = 'obsidian-tasks-plugin:request-cache-update',
     ReloadOpenSearchResults = 'obsidian-tasks-plugin:reload-open-search-results',
+    ReloadVault = 'obsidian-tasks-plugin:reload-vault',
 }
 
 interface CacheUpdateData {
@@ -69,6 +70,20 @@ export class TasksEvents {
         this.obsidianEvents.trigger(Event.ReloadOpenSearchResults);
     }
 
+    // ------------------------------------------------------------------------
+    // ReloadVault event
+
+    public onReloadVault(handler: () => void): EventRef {
+        this.logger.debug('TasksEvents.onReloadVault()');
+        const name = Event.ReloadVault;
+        return this.obsidianEvents.on(name, handler);
+    }
+
+    public triggerReloadVault(): void {
+        this.logger.debug('TasksEvents.triggerReloadVault()');
+        this.obsidianEvents.trigger(Event.ReloadVault);
+    }
+
     public off(eventRef: EventRef): void {
         this.logger.debug('TasksEvents.off()');
         this.obsidianEvents.offref(eventRef);