Fix search coming back in notebook and editor

jupyterlab · Nov 27, 2023 · 17b52c5 · 17b52c5
1 parent 4747a9c
commit 17b52c5
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 4 deletions.
diff --git a/packages/documentsearch-extension/src/index.ts b/packages/documentsearch-extension/src/index.ts
@@ -423,7 +423,6 @@ const extension: JupyterFrontEndPlugin<ISearchProviderRegistry> = {
         if (!currentWidget) {
           return;
         }
-
         searchViews.get(currentWidget.id)?.close();
       }
     });

diff --git a/packages/documentsearch/src/searchmodel.ts b/packages/documentsearch/src/searchmodel.ts
@@ -39,7 +39,7 @@ export class SearchDocumentModel
       }
     }
 
-    searchProvider.stateChanged.connect(this.refresh, this);
+    searchProvider.stateChanged.connect(this._onProviderStateChanged, this);
 
     this._searchDebouncer = new Debouncer(() => {
       this._updateSearch().catch(reason => {
@@ -248,7 +248,10 @@ export class SearchDocumentModel
       });
     }
 
-    this.searchProvider.stateChanged.disconnect(this.refresh, this);
+    this.searchProvider.stateChanged.disconnect(
+      this._onProviderStateChanged,
+      this
+    );
 
     this._searchDebouncer.dispose();
     super.dispose();
@@ -258,6 +261,7 @@ export class SearchDocumentModel
    * End the query.
    */
   async endQuery(): Promise<void> {
+    this._searchActive = false;
     await this.searchProvider.endQuery();
     this.stateChanged.emit();
   }
@@ -351,6 +355,7 @@ export class SearchDocumentModel
           )
         : null;
       if (query) {
+        this._searchActive = true;
         await this.searchProvider.startQuery(query, this._filters);
         // Emit state change as the index needs to be updated
         this.stateChanged.emit();
@@ -365,13 +370,20 @@ export class SearchDocumentModel
     }
   }
 
+  private _onProviderStateChanged() {
+    if (this._searchActive) {
+      this.refresh();
+    }
+  }
+
   private _caseSensitive = false;
   private _disposed = new Signal<this, void>(this);
   private _parsingError = '';
   private _preserveCase = false;
   private _initialQuery = '';
   private _filters: IFilters = {};
   private _replaceText: string = '';
+  private _searchActive = false;
   private _searchDebouncer: Debouncer;
   private _searchExpression = '';
   private _useRegex = false;

diff --git a/packages/fileeditor/package.json b/packages/fileeditor/package.json
@@ -40,6 +40,7 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
+    "@jupyter/ydoc": "^1.1.1",
     "@jupyterlab/apputils": "^4.2.0-alpha.3",
     "@jupyterlab/codeeditor": "^4.1.0-alpha.3",
     "@jupyterlab/codemirror": "^4.1.0-alpha.3",

diff --git a/packages/fileeditor/src/searchprovider.ts b/packages/fileeditor/src/searchprovider.ts
@@ -12,6 +12,7 @@ import {
 import { ITranslator } from '@jupyterlab/translation';
 import { Widget } from '@lumino/widgets';
 import { FileEditor } from './widget';
+import { ISharedText, SourceChange } from '@jupyter/ydoc';
 
 /**
  * Helper type
@@ -64,6 +65,7 @@ export class FileEditorSearchProvider
     query: RegExp,
     filters: IFilters | undefined
   ): Promise<void> {
+    this._searchActive = true;
     await super.startQuery(query, filters);
     await this.highlightNext(true, {
       from: 'selection-start',
@@ -72,6 +74,29 @@ export class FileEditorSearchProvider
     });
   }
 
+  /**
+   * Stop the search and clean any UI elements.
+   */
+  async endQuery(): Promise<void> {
+    this._searchActive = false;
+    await super.endQuery();
+  }
+
+  /**
+   * Callback on source change
+   *
+   * @param emitter Source of the change
+   * @param changes Source change
+   */
+  protected async onSharedModelChanged(
+    emitter: ISharedText,
+    changes: SourceChange
+  ): Promise<void> {
+    if (this._searchActive) {
+      super.onSharedModelChanged(emitter, changes);
+    }
+  }
+
   /**
    * Instantiate a search provider for the widget.
    *
@@ -116,4 +141,6 @@ export class FileEditorSearchProvider
     );
     return selection;
   }
+
+  private _searchActive = false;
 }
diff --git a/packages/notebook/src/searchprovider.ts b/packages/notebook/src/searchprovider.ts
@@ -358,6 +358,7 @@ export class NotebookSearchProvider extends SearchProvider<NotebookPanel> {
       return;
     }
     await this.endQuery();
+    this._searchActive = true;
     let cells = this.widget.content.widgets;
 
     this._query = query;
@@ -426,6 +427,7 @@ export class NotebookSearchProvider extends SearchProvider<NotebookPanel> {
       })
     );
 
+    this._searchActive = false;
     this._searchProviders.length = 0;
     this._currentProviderIndex = null;
   }
@@ -552,7 +554,9 @@ export class NotebookSearchProvider extends SearchProvider<NotebookPanel> {
           this.widget.content.isSelectedOrActive(cell)
       )
       .then(() => {
-        void cellSearchProvider.startQuery(this._query, this._filters);
+        if (this._searchActive) {
+          void cellSearchProvider.startQuery(this._query, this._filters);
+        }
       });
   }
 
@@ -914,4 +918,5 @@ export class NotebookSearchProvider extends SearchProvider<NotebookPanel> {
   > | null = null;
   private _selectionSearchMode: 'cells' | 'text' = 'cells';
   private _selectionLock: boolean = false;
+  private _searchActive: boolean = false;
 }
diff --git a/yarn.lock b/yarn.lock
@@ -3459,6 +3459,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@jupyterlab/fileeditor@workspace:packages/fileeditor"
   dependencies:
+    "@jupyter/ydoc": ^1.1.1
     "@jupyterlab/apputils": ^4.2.0-alpha.3
     "@jupyterlab/codeeditor": ^4.1.0-alpha.3
     "@jupyterlab/codemirror": ^4.1.0-alpha.3