@neo4j-cypher/react-codemirror 2.0.0-next.7 → 2.0.0-next.9

package/src/CypherEditor.tsx

@@ -1,3 +1,4 @@
+import { insertNewline } from '@codemirror/commands';
 import {
   Annotation,
   Compartment,
@@ -9,9 +10,10 @@ import {
   KeyBinding,
   keymap,
   lineNumbers,
+  placeholder,
   ViewUpdate,
 } from '@codemirror/view';
-import type { DbSchema } from '@neo4j-cypher/language-support';
+import { type DbSchema } from '@neo4j-cypher/language-support';
 import debounce from 'lodash.debounce';
 import { Component, createRef } from 'react';
 import {
@@ -23,6 +25,7 @@ import { cleanupWorkers } from './lang-cypher/syntaxValidation';
 import { basicNeo4jSetup } from './neo4jSetup';
 import { getThemeExtension } from './themes';
 
+type DomEventHandlers = Parameters<typeof EditorView.domEventHandlers>[0];
 export interface CypherEditorProps {
   /**
    * The prompt to show on single line editors
@@ -42,7 +45,14 @@ export interface CypherEditorProps {
    */
   onExecute?: (cmd: string) => void;
   /**
-   * The editor history navigateable via up/down arrow keys. Order newest to oldest.
+   * If true, pressing enter will add a new line to the editor and cmd/ctrl + enter will execute the query.
+   * Otherwise pressing enter on a single line will execute the query.
+   *
+   * @default false
+   */
+  newLineOnEnter?: boolean;
+  /**
+   * The editor history navigable via up/down arrow keys. Order newest to oldest.
    * Add to this list with the `onExecute` callback for REPL style history.
    */
   history?: string[];
@@ -75,6 +85,21 @@ export interface CypherEditorProps {
    * @default true
    */
   lint?: boolean;
+  /**
+   * Whether the signature help tooltip should be shown below the text.
+   * If false, it will be shown above.
+   *
+   * @default true
+   */
+  showSignatureTooltipBelow?: boolean;
+  /**
+   * Internal feature flags for the editor. Don't use in production
+   *
+   */
+  featureFlags?: {
+    consoleCommands?: boolean;
+    signatureInfoOnAutoCompletions?: boolean;
+  };
   /**
    * The schema to use for autocompletion and linting.
    *
@@ -102,29 +127,122 @@ export interface CypherEditorProps {
    * @param {ViewUpdate} viewUpdate - the view update from codemirror
    */
   onChange?(value: string, viewUpdate: ViewUpdate): void;
+
+  /**
+   * Map of event handlers to add to the editor.
+   *
+   * Note that the props are compared by reference, meaning object defined inline
+   * will cause the editor to re-render (much like the style prop does in this example:
+   * <div style={{}} />
+   *
+   * Memoize the object if you want/need to avoid this.
+   *
+   * @example
+   * // listen to blur events
+   * <CypherEditor domEventHandlers={{blur: () => console.log("blur event fired")}} />
+   */
+  domEventHandlers?: DomEventHandlers;
+  /**
+   * Placeholder text to display when the editor is empty.
+   */
+  placeholder?: string;
+  /**
+   * Whether the editor should show line numbers.
+   *
+   * @default true
+   */
+  lineNumbers?: boolean;
+  /**
+   * Whether the editor is read-only.
+   *
+   * @default false
+   */
+  readonly?: boolean;
+
+  /**
+   * String value to assign to the aria-label attribute of the editor
+   */
+  ariaLabel?: string;
 }
 
-const executeKeybinding = (onExecute?: (cmd: string) => void) =>
-  onExecute
-    ? [
-        {
-          key: 'Ctrl-Enter',
-          mac: 'Mod-Enter',
-          preventDefault: true,
-          run: (view: EditorView) => {
-            const doc = view.state.doc.toString();
-            if (doc.trim() !== '') {
-              onExecute(doc);
-            }
+const executeKeybinding = (
+  onExecute?: (cmd: string) => void,
+  newLineOnEnter?: boolean,
+  flush?: () => void,
+) => {
+  const keybindings: Record<string, KeyBinding> = {
+    'Shift-Enter': {
+      key: 'Shift-Enter',
+      run: insertNewline,
+    },
+    'Ctrl-Enter': {
+      key: 'Ctrl-Enter',
+      run: () => true,
+    },
+    Enter: {
+      key: 'Enter',
+      run: insertNewline,
+    },
+  };
+
+  if (onExecute) {
+    keybindings['Ctrl-Enter'] = {
+      key: 'Ctrl-Enter',
+      mac: 'Mod-Enter',
+      preventDefault: true,
+      run: (view: EditorView) => {
+        const doc = view.state.doc.toString();
+        if (doc.trim() !== '') {
+          flush?.();
+          onExecute(doc);
+        }
 
-            return true;
-          },
+        return true;
+      },
+    };
+
+    if (!newLineOnEnter) {
+      keybindings['Enter'] = {
+        key: 'Enter',
+        preventDefault: true,
+        run: (view: EditorView) => {
+          const doc = view.state.doc.toString();
+          if (doc.includes('\n')) {
+            // Returning false means the event will mark the event
+            // as not handled and the default behavior will be executed
+            return false;
+          }
+
+          if (doc.trim() !== '') {
+            flush?.();
+            onExecute(doc);
+          }
+
+          return true;
         },
-      ]
-    : [];
+      };
+    }
+  }
+
+  return Object.values(keybindings);
+};
 
 const themeCompartment = new Compartment();
 const keyBindingCompartment = new Compartment();
+const lineNumbersCompartment = new Compartment();
+const readOnlyCompartment = new Compartment();
+const placeholderCompartment = new Compartment();
+const domEventHandlerCompartment = new Compartment();
+
+const formatLineNumber =
+  (prompt?: string) => (a: number, state: EditorState) => {
+    if (state.doc.lines === 1 && prompt !== undefined) {
+      return prompt;
+    }
+
+    return a.toString();
+  };
+
 type CypherEditorState = { cypherSupportEnabled: boolean };
 
 const ExternalEdit = Annotation.define<boolean>();
@@ -147,6 +265,8 @@ export class CypherEditor extends Component<
   editorView: React.MutableRefObject<EditorView> = createRef();
   private schemaRef: React.MutableRefObject<CypherConfig> = createRef();
 
+  private latestDispatchedValue: string | undefined;
+
   /**
    * Focus the editor
    */
@@ -185,13 +305,22 @@ export class CypherEditor extends Component<
     schema: {},
     overrideThemeBackgroundColor: false,
     lineWrap: false,
+    showSignatureTooltipBelow: true,
     extraKeybindings: [],
     history: [],
     theme: 'light',
+    lineNumbers: true,
+    newLineOnEnter: false,
   };
 
   private debouncedOnChange = this.props.onChange
-    ? debounce(this.props.onChange, 200)
+    ? debounce(
+        ((value, viewUpdate) => {
+          this.latestDispatchedValue = value;
+          this.props.onChange(value, viewUpdate);
+        }) satisfies CypherEditorProps['onChange'],
+        200,
+      )
     : undefined;
 
   componentDidMount(): void {
@@ -202,12 +331,20 @@ export class CypherEditor extends Component<
       overrideThemeBackgroundColor,
       schema,
       lint,
+      showSignatureTooltipBelow,
+      featureFlags,
       onExecute,
+      newLineOnEnter,
     } = this.props;
 
     this.schemaRef.current = {
       schema,
       lint,
+      showSignatureTooltipBelow,
+      featureFlags: {
+        consoleCommands: true,
+        ...featureFlags,
+      },
       useLightVersion: false,
       setUseLightVersion: (newVal) => {
         if (this.schemaRef.current !== undefined) {
@@ -237,10 +374,17 @@ export class CypherEditor extends Component<
         ]
       : [];
 
+    this.latestDispatchedValue = this.props.value;
+
     this.editorState.current = EditorState.create({
       extensions: [
         keyBindingCompartment.of(
-          keymap.of([...executeKeybinding(onExecute), ...extraKeybindings]),
+          keymap.of([
+            ...executeKeybinding(onExecute, newLineOnEnter, () =>
+              this.debouncedOnChange.flush(),
+            ),
+            ...extraKeybindings,
+          ]),
         ),
         historyNavigation(this.props),
         basicNeo4jSetup(),
@@ -249,15 +393,25 @@ export class CypherEditor extends Component<
         cypher(this.schemaRef.current),
         lineWrap ? EditorView.lineWrapping : [],
 
-        lineNumbers({
-          formatNumber: (a, state) => {
-            if (state.doc.lines === 1 && this.props.prompt !== undefined) {
-              return this.props.prompt;
-            }
-
-            return a.toString();
-          },
-        }),
+        lineNumbersCompartment.of(
+          this.props.lineNumbers
+            ? lineNumbers({ formatNumber: formatLineNumber(this.props.prompt) })
+            : [],
+        ),
+        readOnlyCompartment.of(EditorState.readOnly.of(this.props.readonly)),
+        placeholderCompartment.of(
+          this.props.placeholder ? placeholder(this.props.placeholder) : [],
+        ),
+        domEventHandlerCompartment.of(
+          this.props.domEventHandlers
+            ? EditorView.domEventHandlers(this.props.domEventHandlers)
+            : [],
+        ),
+        this.props.ariaLabel
+          ? EditorView.contentAttributes.of({
+              'aria-label': this.props.ariaLabel,
+            })
+          : [],
       ],
       doc: this.props.value,
     });
@@ -285,7 +439,11 @@ export class CypherEditor extends Component<
     // Handle externally set value
     const currentCmValue = this.editorView.current.state?.doc.toString() ?? '';
 
-    if (this.props.value !== undefined && currentCmValue !== this.props.value) {
+    if (
+      this.props.value !== undefined &&
+      this.props.value !== this.latestDispatchedValue
+    ) {
+      this.debouncedOnChange?.cancel();
       this.editorView.current.dispatch({
         changes: {
           from: 0,
@@ -313,6 +471,35 @@ export class CypherEditor extends Component<
       });
     }
 
+    if (
+      prevProps.lineNumbers !== this.props.lineNumbers ||
+      prevProps.prompt !== this.props.prompt
+    ) {
+      this.editorView.current.dispatch({
+        effects: lineNumbersCompartment.reconfigure(
+          this.props.lineNumbers
+            ? lineNumbers({ formatNumber: formatLineNumber(this.props.prompt) })
+            : [],
+        ),
+      });
+    }
+
+    if (prevProps.readonly !== this.props.readonly) {
+      this.editorView.current.dispatch({
+        effects: readOnlyCompartment.reconfigure(
+          EditorState.readOnly.of(this.props.readonly),
+        ),
+      });
+    }
+
+    if (prevProps.placeholder !== this.props.placeholder) {
+      this.editorView.current.dispatch({
+        effects: placeholderCompartment.reconfigure(
+          this.props.placeholder ? placeholder(this.props.placeholder) : [],
+        ),
+      });
+    }
+
     if (
       prevProps.extraKeybindings !== this.props.extraKeybindings ||
       prevProps.onExecute !== this.props.onExecute
@@ -320,13 +507,27 @@ export class CypherEditor extends Component<
       this.editorView.current.dispatch({
         effects: keyBindingCompartment.reconfigure(
           keymap.of([
-            ...executeKeybinding(this.props.onExecute),
+            ...executeKeybinding(
+              this.props.onExecute,
+              this.props.newLineOnEnter,
+              () => this.debouncedOnChange.flush(),
+            ),
             ...this.props.extraKeybindings,
           ]),
         ),
       });
     }
 
+    if (prevProps.domEventHandlers !== this.props.domEventHandlers) {
+      this.editorView.current.dispatch({
+        effects: domEventHandlerCompartment.reconfigure(
+          this.props.domEventHandlers
+            ? EditorView.domEventHandlers(this.props.domEventHandlers)
+            : [],
+        ),
+      });
+    }
+
     // This component rerenders on every keystroke and comparing the
     // full lists of editor strings on every render could be expensive.
     const didChangeHistoryEstimate =
@@ -346,6 +547,7 @@ export class CypherEditor extends Component<
     */
     this.schemaRef.current.schema = this.props.schema;
     this.schemaRef.current.lint = this.props.lint;
+    this.schemaRef.current.featureFlags = this.props.featureFlags;
   }
 
   componentWillUnmount(): void {

package/src/e2e_tests/autoCompletion.spec.tsx

@@ -1,9 +1,8 @@
 import { testData } from '@neo4j-cypher/language-support';
 import { expect, test } from '@playwright/experimental-ct-react';
+import type { Page } from '@playwright/test';
 import { CypherEditor } from '../CypherEditor';
 
-test.use({ viewport: { width: 500, height: 500 } });
-
 test('hello world end 2 end test', async ({ mount }) => {
   const component = await mount(<CypherEditor value="hello world" />);
   await expect(component).toContainText('hello world');
@@ -235,35 +234,207 @@ test('completes allShortestPaths correctly', async ({ page, mount }) => {
   );
 });
 
-test('can complete pattern snippet', async ({ page, mount }) => {
-  await mount(<CypherEditor />);
+async function getInfoTooltip(page: Page, methodName: string) {
+  const infoTooltip = page.locator('.cm-completionInfo');
+  const firstOption = page.locator('li[aria-selected="true"]');
+  let selectedOption = firstOption;
+
+  while (!(await infoTooltip.textContent()).includes(methodName)) {
+    await page.keyboard.press('ArrowDown');
+    const currentSelected = page.locator('li[aria-selected="true"]');
+    expect(currentSelected).not.toBe(selectedOption);
+    expect(currentSelected).not.toBe(firstOption);
+    selectedOption = currentSelected;
+  }
+
+  return infoTooltip;
+}
+
+test('shows signature help information on auto-completion for procedures', async ({
+  page,
+  mount,
+}) => {
+  await mount(
+    <CypherEditor
+      schema={testData.mockSchema}
+      featureFlags={{
+        signatureInfoOnAutoCompletions: true,
+      }}
+    />,
+  );
+  const procName = 'apoc.periodic.iterate';
+  const procedure = testData.mockSchema.procedures[procName];
+
   const textField = page.getByRole('textbox');
+  await textField.fill('CALL apoc.periodic.');
 
-  await textField.fill('MATCH ()-[]->()');
+  await expect(page.locator('.cm-tooltip-autocomplete')).toBeVisible();
 
-  await page.locator('.cm-tooltip-autocomplete').getByText('-[]->()').click();
-  await expect(page.locator('.cm-tooltip-autocomplete')).not.toBeVisible();
+  const infoTooltip = await getInfoTooltip(page, procName);
+  await expect(infoTooltip).toContainText(procedure.signature);
+  await expect(infoTooltip).toContainText(procedure.description);
+});
 
-  await textField.press('Tab');
-  await textField.press('Tab');
-  await textField.press('Tab');
+test('shows signature help information on auto-completion for functions', async ({
+  page,
+  mount,
+}) => {
+  await mount(
+    <CypherEditor
+      schema={testData.mockSchema}
+      featureFlags={{
+        signatureInfoOnAutoCompletions: true,
+      }}
+    />,
+  );
+  const fnName = 'apoc.coll.combinations';
+  const fn = testData.mockSchema.functions[fnName];
+
+  const textField = page.getByRole('textbox');
+  await textField.fill('RETURN apoc.coll.');
 
-  await expect(textField).toHaveText('MATCH ()-[]->()-[ ]->( )');
+  await expect(page.locator('.cm-tooltip-autocomplete')).toBeVisible();
+
+  const infoTooltip = await getInfoTooltip(page, fnName);
+  await expect(infoTooltip).toContainText(fn.signature);
+  await expect(infoTooltip).toContainText(fn.description);
 });
 
-test('does not automatically open completion panel for expressions after snippet trigger char', async ({
+test('shows deprecated procedures as strikethrough on auto-completion', async ({
   page,
   mount,
 }) => {
-  await mount(<CypherEditor />);
+  const procName = 'apoc.trigger.resume';
+
+  await mount(
+    <CypherEditor
+      schema={{
+        procedures: { [procName]: testData.mockSchema.procedures[procName] },
+      }}
+      featureFlags={{
+        signatureInfoOnAutoCompletions: true,
+      }}
+    />,
+  );
   const textField = page.getByRole('textbox');
+  await textField.fill('CALL apoc.trigger.');
 
-  await textField.fill('RETURN (1)');
+  // We need to assert on the element having the right class
+  // and trusting the CSS is making this truly strikethrough
+  await expect(page.locator('.cm-deprecated-completion')).toBeVisible();
+});
 
-  // expect the panel to not show up
-  await expect(page.locator('.cm-tooltip-autocomplete')).not.toBeVisible();
+test('shows deprecated function as strikethrough on auto-completion', async ({
+  page,
+  mount,
+}) => {
+  const fnName = 'apoc.create.uuid';
+
+  await mount(
+    <CypherEditor
+      schema={{
+        functions: { [fnName]: testData.mockSchema.functions[fnName] },
+      }}
+      featureFlags={{
+        signatureInfoOnAutoCompletions: true,
+      }}
+    />,
+  );
+  const textField = page.getByRole('textbox');
+  await textField.fill('RETURN apoc.create.');
+
+  // We need to assert on the element having the right class
+  // and trusting the CSS is making this truly strikethrough
+  await expect(page.locator('.cm-deprecated-completion')).toBeVisible();
+});
+
+test('does not signature help information on auto-completion if flag not enabled explicitly', async ({
+  page,
+  mount,
+}) => {
+  await mount(<CypherEditor schema={testData.mockSchema} />);
+
+  const textField = page.getByRole('textbox');
+  await textField.fill('CALL apoc.periodic.');
+
+  await expect(page.locator('.cm-tooltip-autocomplete')).toBeVisible();
+  await expect(page.locator('.cm-completionInfo')).not.toBeVisible();
+});
+
+test('does not signature help information on auto-completion if docs and signature are empty', async ({
+  page,
+  mount,
+}) => {
+  await mount(
+    <CypherEditor
+      schema={testData.mockSchema}
+      featureFlags={{
+        signatureInfoOnAutoCompletions: true,
+      }}
+    />,
+  );
+
+  const textField = page.getByRole('textbox');
+  await textField.fill('C');
+
+  await expect(page.locator('.cm-tooltip-autocomplete')).toBeVisible();
+  await expect(page.locator('.cm-completionInfo')).not.toBeVisible();
+});
+
+test('shows signature help information on auto-completion if description is not empty, signature is', async ({
+  page,
+  mount,
+}) => {
+  await mount(
+    <CypherEditor
+      schema={{
+        procedures: {
+          'db.ping': {
+            ...testData.emptyProcedure,
+            description: 'foo',
+            signature: '',
+            name: 'db.ping',
+          },
+        },
+      }}
+      featureFlags={{
+        signatureInfoOnAutoCompletions: true,
+      }}
+    />,
+  );
+
+  const textField = page.getByRole('textbox');
+  await textField.fill('CALL db.');
+
+  await expect(page.locator('.cm-tooltip-autocomplete')).toBeVisible();
+  await expect(page.locator('.cm-completionInfo')).toBeVisible();
+});
+
+test('shows signature help information on auto-completion if signature is not empty, description is', async ({
+  page,
+  mount,
+}) => {
+  await mount(
+    <CypherEditor
+      schema={{
+        procedures: {
+          'db.ping': {
+            ...testData.emptyProcedure,
+            description: '',
+            signature: 'foo',
+            name: 'db.ping',
+          },
+        },
+      }}
+      featureFlags={{
+        signatureInfoOnAutoCompletions: true,
+      }}
+    />,
+  );
+
+  const textField = page.getByRole('textbox');
+  await textField.fill('CALL db.');
 
-  // unless manually triggered
-  await textField.press('Control+ ');
   await expect(page.locator('.cm-tooltip-autocomplete')).toBeVisible();
+  await expect(page.locator('.cm-completionInfo')).toBeVisible();
 });