Backport PR #16682: Prevent replacing code with find and replace in read-only cells (#16696)

meeseeksmachine · itsmevichu · web-flow · commit 7bf7ec50b268 · 2024-08-19T18:56:14.000+01:00
Co-authored-by: Vishnutheep B &lt;vishnutheep@gmail.com&gt;
diff --git a/packages/cells/src/searchprovider.ts b/packages/cells/src/searchprovider.ts
@@ -12,6 +12,7 @@ import {
   GenericSearchProvider,
   IBaseSearchProvider,
   IFilters,
+  IReplaceOptions,
   ISearchMatch
 } from '@jupyterlab/documentsearch';
 import { OutputArea } from '@jupyterlab/outputarea';
@@ -249,6 +250,39 @@ class CodeCellSearchProvider extends CellSearchProvider {
     }
   }
 
+  /**
+   * Replace all matches in the cell source with the provided text
+   *
+   * @param newText The replacement text.
+   * @returns Whether a replace occurred.
+   */
+  async replaceAllMatches(newText: string): Promise<boolean> {
+    if (this.model.getMetadata('editable') === false)
+      return Promise.resolve(false);
+
+    const result = await super.replaceAllMatches(newText);
+    return result;
+  }
+
+  /**
+   * Replace the currently selected match with the provided text.
+   * If no match is selected, it won't do anything.
+   *
+   * @param newText The replacement text.
+   * @returns Whether a replace occurred.
+   */
+  async replaceCurrentMatch(
+    newText: string,
+    loop?: boolean,
+    options?: IReplaceOptions
+  ): Promise<boolean> {
+    if (this.model.getMetadata('editable') === false)
+      return Promise.resolve(false);
+
+    const result = await super.replaceCurrentMatch(newText, loop, options);
+    return result;
+  }
+
   private async _onOutputsChanged(
     outputArea: OutputArea,
     changes: number
@@ -393,12 +427,33 @@ class MarkdownCellSearchProvider extends CellSearchProvider {
    * @returns Whether a replace occurred.
    */
   async replaceAllMatches(newText: string): Promise<boolean> {
+    if (this.model.getMetadata('editable') === false)
+      return Promise.resolve(false);
+
     const result = await super.replaceAllMatches(newText);
     // if the cell is rendered force update
     if ((this.cell as MarkdownCell).rendered) {
       this.cell.update();
     }
+    return result;
+  }
+
+  /**
+   * Replace the currently selected match with the provided text.
+   * If no match is selected, it won't do anything.
+   *
+   * @param newText The replacement text.
+   * @returns Whether a replace occurred.
+   */
+  async replaceCurrentMatch(
+    newText: string,
+    loop?: boolean,
+    options?: IReplaceOptions
+  ): Promise<boolean> {
+    if (this.model.getMetadata('editable') === false)
+      return Promise.resolve(false);
 
+    const result = await super.replaceCurrentMatch(newText, loop, options);
     return result;
   }
 
diff --git a/packages/notebook/test/searchprovider.spec.ts b/packages/notebook/test/searchprovider.spec.ts
@@ -288,6 +288,38 @@ describe('@jupyterlab/notebook', () => {
         expect(source).toBe('rabarbar');
         expect(provider.currentMatchIndex).toBe(null);
       });
+
+      it('should not replace the current match in a read-only cell', async () => {
+        panel.model!.sharedModel.insertCells(0, [
+          {
+            cell_type: 'markdown',
+            source: 'test1',
+            metadata: { editable: false }
+          },
+          { cell_type: 'code', source: 'test2', metadata: { editable: false } }
+        ]);
+
+        await provider.startQuery(/test\d/, undefined);
+        expect(provider.currentMatchIndex).toBe(0);
+        let replaced = await provider.replaceCurrentMatch('bar');
+        expect(replaced).toBe(false);
+        const source = panel.model!.cells.get(0).sharedModel.getSource();
+        expect(source).toBe('test1');
+
+        await provider.highlightNext();
+        expect(provider.currentMatchIndex).toBe(1);
+        replaced = await provider.replaceCurrentMatch('bar');
+        expect(replaced).toBe(false);
+        const source1 = panel.model!.cells.get(1).sharedModel.getSource();
+        expect(source1).toBe('test2');
+
+        await provider.highlightNext();
+        expect(provider.currentMatchIndex).toBe(2);
+        replaced = await provider.replaceCurrentMatch('bar');
+        expect(replaced).toBe(true);
+        const source2 = panel.model!.cells.get(2).sharedModel.getSource();
+        expect(source2).toBe('bar test2');
+      });
     });
 
     describe('#replaceAllMatches()', () => {
@@ -354,6 +386,34 @@ describe('@jupyterlab/notebook', () => {
         expect(source).toBe('test1\nbar2\nbar3\nbar4\ntest5');
         await provider.endQuery();
       });
+
+      it('should not replace all matches in read-only cells', async () => {
+        panel.model!.sharedModel.insertCells(2, [
+          {
+            cell_type: 'markdown',
+            source: 'test1 test2',
+            metadata: { editable: false }
+          },
+          {
+            cell_type: 'code',
+            source: 'test1 test2 test3',
+            metadata: { editable: false }
+          }
+        ]);
+        await provider.startQuery(/test\d/, undefined);
+        await provider.highlightNext();
+        const replaced = await provider.replaceAllMatches('test0');
+        expect(replaced).toBe(true);
+        let source = panel.model!.cells.get(0).sharedModel.getSource();
+        expect(source).toBe('test0 test0');
+        source = panel.model!.cells.get(1).sharedModel.getSource();
+        expect(source).toBe('test0');
+        source = panel.model!.cells.get(2).sharedModel.getSource();
+        expect(source).toBe('test1 test2');
+        source = panel.model!.cells.get(3).sharedModel.getSource();
+        expect(source).toBe('test1 test2 test3');
+        expect(provider.currentMatchIndex).toBe(null);
+      });
     });
 
     describe('#getSelectionState()', () => {
