Symbol fetches in React Codemirror (#661)

* make lint call need parserWrapper

* move applySyntaxColouring to parserwrapper

* move sighelp to parserWrapper

* move autocompletion to parserWrapper

* add symbolfetcher to cyphereditor

* update version

* update versions in react-codemirrors dependencies. Will this work, or do I need to verdaccio publish?

* add logging to symbolfetcher

* move so language server and codemirrors use helper methods everywhere. Rename ParserWrapper to CypherHelper

* Revert "add logging to symbolfetcher"

This reverts commit c100cac.

* rename parserWrapper file and imports

* replace defaultCypherHelper with per-codemirror in parser-adapter

* revert package.json versions

* fix extra letter

* cleanup

* add changesets

* add err  to msg when symbol fetcher fails

* format

* Rename CypherHelper to CypherLanguageService. add default parsingresult when not using languageservice.

* remove leftover "new CypherLanguageService" from tests, move up slicing of query to pre-parse in completions + add slicing to completionsAssertionHelper

* rename SymbolFetcher in codemirror to CodemirrorSymbolFetcher, to separate it from the slightly different symbol fetcher used in language-server

* format codemirror

* make each parsing call take consoleCommandsEnabled, to prevent caching issues

* remove caching

* rename helpers in cypherLanguageService and rename syntaxColouring -> syntaxHighlighting

* rewrite to use object parameter for optional values

* remove _internalFeatureFlags usages outside of testing / debugging

* format

* move consoleCommandsEnabled to constructor, clean up API signatures

Move consoleCommandsEnabled from per-call option to CypherLanguageService
constructor since it's an environment-level concern. Apply consistent
(query, dbSchema, options?) pattern with destructured defaults across all
standalone functions and class methods. Fix stale schema reference in
CodemirrorSymbolFetcher, remove dead consoleCommands field in signatureHelp,
replace deprecated trimLeft() with trimStart(), and update stale comment
in featureFlags.ts.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* review fixes: worker pool cleanup, private fields, remove global mutable flag

- Add terminate() to CodemirrorSymbolFetcher and call in componentWillUnmount
- Make parsingResult and symbolsInfo private on CypherLanguageService
- Remove _internalFeatureFlags.consoleCommands global mutable state from tests,
  pass consoleCommandsEnabled explicitly via function parameters instead
- Remove double-slicing in autocomplete test helpers
- Update changeset to document renamed/removed exports and changed signatures

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* Update .changeset/seven-cats-shout.md

Co-authored-by: Isak Nilsson <143806924+anderson4j@users.noreply.github.com>

---------

Co-authored-by: Oskar Damkjaer <oskar.damkjaer@gmail.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Oskar Damkjær <OskarDamkjaer@users.noreply.github.com>

Author: 3 people

.changeset/funny-tips-glow.md

@@ -0,0 +1,5 @@
+---
+"@neo4j-cypher/react-codemirror": patch
+---
+
+Rewrite global parserWrapper to instantiated languageService and add symbol fetching to react-codemirror

.changeset/seven-cats-shout.md

@@ -0,0 +1,13 @@
+---
+"@neo4j-cypher/react-codemirror-playground": patch
+"@neo4j-cypher/language-support": patch
+"@neo4j-cypher/language-server": patch
+"@neo4j-cypher/lint-worker": patch
+---
+
+Rewrite global parserWrapper for instantiated CypherLanguageService objects
+
+Breaking changes for direct consumers of `@neo4j-cypher/language-support`:
+- Removed export: `parserWrapper`. The same `ParsingResult` as `parserWrapper.parse` would yield can still be received by `createParsingResult` in `CypherLanguageService`. Instances of the new CypherLanguageService class provide helpers for linting/highlighting/completions/signature info where parsing is handled internally.
+- Renamed exports: `applySyntaxColouring` → `highlightSyntax`, `syntaxColouringLegend` → `syntaxHighlightingLegend`
+- `autocomplete()`, `lintCypherQuery()`, `highlightSyntax()`, and `getSignatureInfo()` now take an options object as the third parameter instead of positional args

packages/language-server/src/autocompletion.ts

@@ -6,12 +6,10 @@ import {
 } from 'vscode-languageserver/node';
 
 import type { CompletionItem } from '@neo4j-cypher/language-support';
-import {
-  autocomplete,
-  shouldAutoCompleteYield,
-} from '@neo4j-cypher/language-support';
+import { shouldAutoCompleteYield } from '@neo4j-cypher/language-support';
 import { Neo4jSchemaPoller } from '@neo4j-cypher/query-tools';
 import { TextDocument } from 'vscode-languageserver-textdocument';
+import { languageService } from './server';
 
 export function doAutoCompletion(
   documents: TextDocuments<TextDocument>,
@@ -30,11 +28,15 @@ export function doAutoCompletion(
     const manualOrCharacterOrInwordTriggered =
       completionParams.context?.triggerCharacter !== ' ';
     if (yieldTriggered || manualOrCharacterOrInwordTriggered) {
-      const completions: CompletionItem[] = autocomplete(
+      const completions: CompletionItem[] = languageService.autocomplete(
         textDocument.getText(),
         neo4j.metadata?.dbSchema ?? {},
-        offset,
-        completionParams.context.triggerKind === CompletionTriggerKind.Invoked,
+        {
+          caretPosition: offset,
+          manual:
+            completionParams.context.triggerKind ===
+            CompletionTriggerKind.Invoked,
+        },
       );
 
       const result = completions.map((item) => {

packages/language-server/src/linting.ts

@@ -1,7 +1,5 @@
 import {
-  _internalFeatureFlags,
   clampUnsafePositions,
-  parserWrapper,
   SymbolTable,
 } from '@neo4j-cypher/language-support';
 import { Neo4jSchemaPoller } from '@neo4j-cypher/query-tools';
@@ -15,6 +13,7 @@ import {
   LinterTask,
   LintWorker,
 } from '@neo4j-cypher/lint-worker';
+import { languageService } from './server';
 
 const defaultWorkerPath = join(__dirname, 'lintWorker.cjs');
 
@@ -59,11 +58,9 @@ async function rawLintDocument(
     const proxyWorker = (await pool.proxy()) as unknown as LintWorker;
 
     const fixedDbSchema = convertDbSchema(dbSchema, linterVersion);
-    lastSemanticJob = proxyWorker.lintCypherQuery(
-      query,
-      fixedDbSchema,
-      _internalFeatureFlags,
-    );
+    lastSemanticJob = proxyWorker.lintCypherQuery(query, fixedDbSchema, {
+      consoleCommands: false,
+    });
     const result = await lastSemanticJob;
 
     //marks the entire text if any position is negative
@@ -74,7 +71,7 @@ async function rawLintDocument(
 
     // Pass the computed symbol tables to the parser
     if (result.symbolTables) {
-      parserWrapper.setSymbolsInfo(
+      languageService.setSymbolsInfo(
         {
           query,
           symbolTables: result.symbolTables,

packages/language-server/src/server.ts

@@ -13,16 +13,16 @@ import {
 import { TextDocument } from 'vscode-languageserver-textdocument';
 import {
   DbSchema,
-  parserWrapper,
   SymbolTable,
-  syntaxColouringLegend,
+  syntaxHighlightingLegend,
+  CypherLanguageService,
 } from '@neo4j-cypher/language-support';
 import { Neo4jSchemaPoller } from '@neo4j-cypher/query-tools';
 import { doAutoCompletion } from './autocompletion';
 import { formatDocument } from './formatting';
 import { cleanupWorkers, lintDocument, setLintWorker } from './linting';
 import { doSignatureHelp } from './signatureHelp';
-import { applySyntaxColouringForDocument } from './syntaxColouring';
+import { highlightSyntaxForDocument } from './syntaxHighlighting';
 import {
   LintWorkerSettings,
   Neo4jConnectionSettings,
@@ -35,6 +35,9 @@ import { join } from 'path';
 
 const defaultWorkerPath: string = join(__dirname, 'lintWorker.cjs');
 let workerPath = defaultWorkerPath;
+export const languageService = new CypherLanguageService({
+  consoleCommandsEnabled: false,
+});
 
 class SymbolFetcher {
   private processing = false;
@@ -86,7 +89,7 @@ class SymbolFetcher {
           result.symbolTables &&
           !(this.nextJob && this.nextJob.uri != docUri)
         ) {
-          parserWrapper.setSymbolsInfo(
+          languageService.setSymbolsInfo(
             {
               query,
               symbolTables: result.symbolTables,
@@ -158,7 +161,7 @@ connection.onInitialize(() => {
       },
       semanticTokensProvider: {
         documentSelector: [{ language: 'cypher' }],
-        legend: syntaxColouringLegend,
+        legend: syntaxHighlightingLegend,
         range: false,
         full: {
           delta: false,
@@ -181,7 +184,7 @@ connection.onInitialized(() => {
 
   const registrationOptions: SemanticTokensRegistrationOptions = {
     documentSelector: [{ language: 'cypher' }],
-    legend: syntaxColouringLegend,
+    legend: syntaxHighlightingLegend,
     range: false,
     full: {
       delta: false,
@@ -201,10 +204,8 @@ connection.onDidChangeConfiguration((params) => {
 
 documents.onDidChangeContent((change) => lintSingleDocument(change.document));
 
-// Trigger the syntax colouring
-connection.languages.semanticTokens.on(
-  applySyntaxColouringForDocument(documents),
-);
+// Trigger the syntax highlighting
+connection.languages.semanticTokens.on(highlightSyntaxForDocument(documents));
 
 // Trigger the signature help, providing info about functions / procedures
 connection.onSignatureHelp(doSignatureHelp(documents, neo4jSchemaPoller));

packages/language-server/src/signatureHelp.ts

@@ -1,4 +1,3 @@
-import { signatureHelp } from '@neo4j-cypher/language-support';
 import {
   SignatureHelp,
   SignatureHelpParams,
@@ -7,6 +6,7 @@ import {
 
 import { Neo4jSchemaPoller } from '@neo4j-cypher/query-tools';
 import { TextDocument } from 'vscode-languageserver-textdocument';
+import { languageService } from './server';
 
 export const emptyResult: SignatureHelp = {
   signatures: [],
@@ -26,10 +26,10 @@ export function doSignatureHelp(
     const position = params.position;
     const offset = textDocument.offsetAt(position);
 
-    return signatureHelp(
+    return languageService.getSignatureHelp(
       textDocument.getText(),
       neo4j.metadata?.dbSchema ?? {},
-      offset,
+      { caretPosition: offset },
     );
   };
 }

…s/language-server/src/syntaxColouring.ts …anguage-server/src/syntaxHighlighting.tspackages/language-server/src/syntaxColouring.ts renamed to packages/language-server/src/syntaxHighlighting.ts packages/language-server/src/syntaxColouring.ts renamed to packages/language-server/src/syntaxHighlighting.ts

@@ -1,22 +1,20 @@
-import {
-  applySyntaxColouring,
-  mapCypherToSemanticTokenIndex,
-} from '@neo4j-cypher/language-support';
+import { mapCypherToSemanticTokenIndex } from '@neo4j-cypher/language-support';
 import {
   SemanticTokensBuilder,
   SemanticTokensParams,
   TextDocument,
   TextDocuments,
 } from 'vscode-languageserver';
+import { languageService } from './server';
 
-export function applySyntaxColouringForDocument(
+export function highlightSyntaxForDocument(
   documents: TextDocuments<TextDocument>,
 ) {
   return (params: SemanticTokensParams) => {
     const textDocument = documents.get(params.textDocument.uri);
     if (textDocument === undefined) return { data: [] };
 
-    const tokens = applySyntaxColouring(textDocument.getText());
+    const tokens = languageService.highlightSyntax(textDocument.getText());
 
     const builder = new SemanticTokensBuilder();
 

packages/language-support/src/autocompletion/autocompletion.ts

@@ -1,29 +1,42 @@
 import { DbSchema } from '../dbSchema.js';
 import { findCaret } from '../helpers.js';
-import { parserWrapper } from '../parserWrapper.js';
-import { CompletionItem } from '../types.js';
+import {
+  createParsingResult,
+  ParsingResult,
+} from '../cypherLanguageService.js';
+import { CompletionItem, SymbolsInfo } from '../types.js';
 import { completionCoreCompletion } from './completionCoreCompletions.js';
 
 export function autocomplete(
   query: string,
   dbSchema: DbSchema,
-  caretPosition: number = query.length,
-  manual = false,
+  {
+    symbolsInfo,
+    parsingResult,
+    caretPosition = query.length,
+    manual = false,
+    consoleCommandsEnabled = true,
+  }: {
+    symbolsInfo?: SymbolsInfo;
+    parsingResult?: ParsingResult;
+    caretPosition?: number;
+    manual?: boolean;
+    consoleCommandsEnabled?: boolean;
+  } = {},
 ): CompletionItem[] {
-  // TODO This is a temporary hack because completions are not working well
-  query = query.slice(0, caretPosition);
-  const parsingResult = parserWrapper.parse(query);
-  const symbolsInfo = parserWrapper.symbolsInfo;
+  const resolvedParsingResult =
+    parsingResult ?? createParsingResult(query, { consoleCommandsEnabled });
+
   /* We try to locate the statement where the caret is and the token of the caret
 
-     The reason for doing that is we need a way to "resynchronise" when the 
+     The reason for doing that is we need a way to "resynchronise" when the
      previous statements have errors and the parser fails from them onwards:
 
      MATCH (m) REUT m; CREATE (n) R
-                                  ^ we should still be getting autocompletions here   
+                                  ^ we should still be getting autocompletions here
 
   */
-  const caret = findCaret(parsingResult, caretPosition);
+  const caret = findCaret(resolvedParsingResult, caretPosition);
   if (caret) {
     const statement = caret.statement;
     const caretToken = caret.token;
@@ -33,6 +46,7 @@ export function autocomplete(
       caretToken,
       symbolsInfo,
       manual,
+      consoleCommandsEnabled,
     );
   }
 

packages/language-support/src/autocompletion/completionCoreCompletions.ts

@@ -24,15 +24,14 @@ import {
   tokenNames,
 } from '../lexerSymbols.js';
 
-import { getMethodName, ParsedStatement } from '../parserWrapper.js';
+import { getMethodName, ParsedStatement } from '../cypherLanguageService.js';
 
 import type { CandidateRule } from '../../../../vendor/antlr4-c3/dist/esm/index.js';
 import {
   CandidatesCollection,
   CodeCompletionCore,
   Token,
 } from '../../../../vendor/antlr4-c3/dist/esm/index.js';
-import { _internalFeatureFlags } from '../featureFlags.js';
 import {
   CompletionItem,
   CypherVersion,
@@ -463,6 +462,7 @@ export function completionCoreCompletion(
   caretToken: Token,
   symbolsInfo: SymbolsInfo | undefined,
   manualTrigger = false,
+  consoleCommandsEnabled = true,
 ): CompletionItem[] {
   const cypherVersion = resolveCypherVersion(
     parsingResult.cypherVersion,
@@ -518,7 +518,7 @@ export function completionCoreCompletion(
     CypherParser.RULE_relType,
     // Either enable the helper rules for lexer clashes,
     // or collect all console commands like below with symbolicNameString
-    ...(_internalFeatureFlags.consoleCommands
+    ...(consoleCommandsEnabled
       ? [
           CypherParser.RULE_useCompletionRule,
           CypherParser.RULE_listCompletionRule,

packages/language-support/src/autocompletion/schemaBasedCompletions.ts

@@ -4,7 +4,7 @@ import {
   InsertTextFormat,
 } from 'vscode-languageserver-types';
 import { DbSchema } from '../dbSchema.js';
-import { ParsedStatement } from '../parserWrapper.js';
+import { ParsedStatement } from '../cypherLanguageService.js';
 import {
   ConditionNode,
   isLabelLeaf,