Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Fixes the find and replace menu from dissapearing (#71780)

daf09bc463118f
diff --git a/frontend/src/metabase/common/components/CodeEditor/CodeEditor.tsx b/frontend/src/metabase/common/components/CodeEditor/CodeEditor.tsx
index 754758b8138..eb30f4077bb 100644
--- a/frontend/src/metabase/common/components/CodeEditor/CodeEditor.tsx
+++ b/frontend/src/metabase/common/components/CodeEditor/CodeEditor.tsx
@@ -1,4 +1,5 @@
import type { Extension } from "@uiw/react-codemirror";
+import { useMemo } from "react";
import { CodeMirror } from "metabase/common/components/CodeMirror";
@@ -39,14 +40,19 @@ export function CodeEditor({
proposedValue,
});
+ const basicSetup = useMemo(
+ () => ({
+ lineNumbers,
+ foldGutter: false,
+ highlightActiveLine: false,
+ highlightActiveLineGutter: false,
+ }),
+ [lineNumbers],
+ );
+
return (
<CodeMirror
- basicSetup={{
- lineNumbers,
- foldGutter: false,
- highlightActiveLine: false,
- highlightActiveLineGutter: false,
- }}
+ basicSetup={basicSetup}
className={className}
extensions={extensions}
id={id}
diff --git a/frontend/src/metabase/common/components/CodeMirror/CodeMirror.unit.spec.tsx b/frontend/src/metabase/common/components/CodeMirror/CodeMirror.unit.spec.tsx
new file mode 100644
index 00000000000..4e062dc93d7
--- /dev/null
+++ b/frontend/src/metabase/common/components/CodeMirror/CodeMirror.unit.spec.tsx
@@ -0,0 +1,91 @@
+jest.unmock("@uiw/react-codemirror");
+
+import {
+ SearchQuery,
+ findNext,
+ openSearchPanel,
+ replaceNext,
+ searchPanelOpen,
+ setSearchQuery,
+} from "@codemirror/search";
+import type { EditorView } from "@codemirror/view";
+import { act, render, waitFor } from "@testing-library/react";
+import { useMemo, useState } from "react";
+
+import { CodeMirror } from "./CodeMirror";
+
+function SearchReplaceHarness({
+ initialValue,
+ onEditorReady,
+}: {
+ initialValue: string;
+ onEditorReady: (view: EditorView) => void;
+}) {
+ const [value, setValue] = useState(initialValue);
+ const basicSetup = useMemo(
+ () => ({
+ lineNumbers: false,
+ foldGutter: false,
+ highlightActiveLine: false,
+ highlightActiveLineGutter: false,
+ }),
+ [],
+ );
+
+ return (
+ <CodeMirror
+ value={value}
+ onChange={setValue}
+ basicSetup={basicSetup}
+ onCreateEditor={(view) => onEditorReady(view)}
+ />
+ );
+}
+
+describe("CodeMirror", () => {
+ it("keeps the find/replace panel open while matches remain and closes after the last replace", async () => {
+ const initialValue = "test1, test2, test1, test3";
+ let editorView: EditorView | undefined;
+
+ render(
+ <SearchReplaceHarness
+ initialValue={initialValue}
+ onEditorReady={(view) => {
+ editorView = view;
+ }}
+ />,
+ );
+
+ await waitFor(() => {
+ expect(editorView).toBeDefined();
+ });
+
+ openSearchPanel(editorView!);
+
+ editorView!.dispatch({
+ effects: setSearchQuery.of(
+ new SearchQuery({
+ search: "test1",
+ replace: "X",
+ }),
+ ),
+ });
+
+ await act(async () => {
+ findNext(editorView!);
+ replaceNext(editorView!);
+ });
+
+ expect(searchPanelOpen(editorView!.state)).toBe(true);
+ expect(editorView!.state.doc.toString()).toBe("X, test2, test1, test3");
+
+ await act(async () => {
+ replaceNext(editorView!);
+ });
+
+ await waitFor(() => {
+ expect(searchPanelOpen(editorView!.state)).toBe(false);
+ });
+ expect(editorView!.state.doc.toString()).toBe("X, test2, X, test3");
+ });
+});
diff --git a/frontend/src/metabase/common/components/CodeMirror/utils.ts b/frontend/src/metabase/common/components/CodeMirror/utils.ts
index a0b79f517a6..62681016eef 100644
--- a/frontend/src/metabase/common/components/CodeMirror/utils.ts
+++ b/frontend/src/metabase/common/components/CodeMirror/utils.ts
@@ -11,8 +11,21 @@ import {
indentUnit,
syntaxHighlighting,
} from "@codemirror/language";
-import { openSearchPanel, searchKeymap } from "@codemirror/search";
-import { EditorView, drawSelection, keymap } from "@codemirror/view";
+import {
+ closeSearchPanel,
+ getSearchQuery,
+ openSearchPanel,
+ search,
+ searchKeymap,
+ searchPanelOpen,
+} from "@codemirror/search";
+import {
+ EditorView,
+ ViewPlugin,
+ type ViewUpdate,
+ drawSelection,
+ keymap,
+} from "@codemirror/view";
import {
type BasicSetupOptions,
type EditorState,
@@ -83,7 +96,9 @@ function useBaseExtensions({
bracketMatching({
brackets: "()",
}),
+ search(),
keyboardShortcuts({ onFormat }),
+ closeSearchPanelAfterLastReplace(),
EditorView.lineWrapping,
highlighting(),
folds(),
@@ -122,6 +137,34 @@ function fonts() {
});
}
+function closeSearchPanelAfterLastReplace() {
+ return ViewPlugin.define((view) => ({
+ update(update: ViewUpdate) {
+ if (
+ !searchPanelOpen(update.startState) ||
+ !update.transactions.some((tr) => tr.isUserEvent("input.replace"))
+ ) {
+ return;
+ }
+
+ const query = getSearchQuery(update.state);
+ if (!query.valid) {
+ return;
+ }
+
+ const cursor = query.getCursor(update.state, 0, update.state.doc.length);
+ const hasMoreMatches = !cursor.next().done;
+
+ if (!hasMoreMatches) {
+ // closeSearchPanel dispatches; cannot run during ViewPlugin.update.
+ queueMicrotask(() => {
+ closeSearchPanel(view);
+ });
+ }
+ },
+ }));
+}
+
function keyboardShortcuts({ onFormat }: { onFormat?: () => void }) {
// Stop Cmd+Enter in CodeMirror from inserting a newline
// Has to be Prec.highest so that it overwrites after the default Cmd+Enter handler