Adapts procedure registry to depend on the cypher version #331

ncordon · 2025-01-22T11:14:12Z

Builds on top of #328.

packages/language-support/src/tests/testData.ts just adds the new shape for the registry in the mockSchema
packages/language-support/src/syntaxValidation/semanticAnalysis.js brings in the new changes to be able to update either the registry for Cypher 5 or Cypher 25.

What

Polls for the procedure registry for both Cypher 5 and Cypher 25 and wires that into the code.

This means for older versions we do SHOW PROCEDURES and SHOW FUNCTIONS and store that under 'cypher 5' in the schema.

For newer versions we poll all of the following queries:

CYPHER 5  SHOW PROCEDURES
CYPHER 25 SHOW PROCEDURES

CYPHER 5  SHOW FUNCTIONS
CYPHER 25 SHOW FUNCTIONS

Why

Starting from neo4j 2025.01 we will support two concurrent cypher versions, which will mean we could have procedures that were deprecated in Cypher 5 and removed in Cypher 25, or even arguments that were deprecated in Cypher 5 and removed in Cypher 25.

…vailable

… into defaultLanguage

… CIP

…epending on the version

changeset-bot · 2025-01-22T11:14:16Z

⚠️ No Changeset found

Latest commit: 3a10389

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

…pendant

…e cypher versions

…o polling-versioned-procs-fns

ncordon · 2025-01-23T14:54:20Z

packages/language-server/src/lintWorker.ts

+  if (featureFlags.cypher25 !== undefined) {
+    _internalFeatureFlags.cypher25 = featureFlags.cypher25;
+  }


We need to pass the feature flags to the lint worker because the _internalFeatureFlags variable from the outside lives in another thread

ncordon · 2025-01-23T14:55:04Z

packages/language-server/src/server.ts

+if (process.env.CYPHER_25 === 'true') {
+  _internalFeatureFlags.cypher25 = true;
+}


This is so we can set the feature flag in the language server from the vscode extension

ncordon · 2025-01-23T14:57:33Z

packages/language-support/package.json

@@ -48,7 +48,7 @@
    "vscode-languageserver-types": "^3.17.3"
  },
  "scripts": {
-    "gen-parser": "antlr4 -Dlanguage=TypeScript -visitor src/antlr-grammar/CypherCmdLexer.g4 src/antlr-grammar/CypherCmdParser.g4 -o src/generated-parser/ -Xexact-output-dir",
+    "gen-parser": "export ANTLR4_TOOLS_ANTLR_VERSION=4.13.2 && antlr4 -Dlanguage=TypeScript -visitor src/antlr-grammar/CypherCmdLexer.g4 src/antlr-grammar/CypherCmdParser.g4 -o src/generated-parser/ -Xexact-output-dir",


This is because https://github.com/antlr/antlr4-tools will resolve and download the most up to date version of antlr if this environment variable is not set. But it was failing to contact the relevant url.

This hardcodes the version we want to use. Which we should do in any case, because we wouldn't want to use a different version for generating the parser and for the antlr4 runtime.

ncordon · 2025-01-23T15:00:52Z

packages/language-support/src/dbSchema.ts

+  procedures?: Partial<Record<CypherVersion, Record<string, Neo4jProcedure>>>;
+  functions?: Partial<Record<CypherVersion, Record<string, Neo4jFunction>>>;


We need a different procedure registry for each version because the same function / procedure could have a different signature in different versions.

At the moment there are not many examples of methods that have different signatures for different versions(just apoc.cypher.runTimeboxed). But there will be in the future.

ncordon · 2025-01-23T15:18:13Z

packages/schema-poller/src/metadataPoller.ts

+    const versions: (CypherVersion | undefined)[] = isNewerNeo4j
+      ? cypherVersions
+      : [undefined];
+
+    versions.forEach((cypherVersion) => {
+      const effectiveCypherVersion: CypherVersion = cypherVersion ?? 'cypher 5';


If we are not connected to a new neo4j, just poll for cypher 5, which means we cannot preprend either CYPHER 5 nor CYPHER 25 to the queries

ncordon · 2025-01-23T15:20:09Z

packages/vscode-extension/src/extension.ts

    debug: {
      module: debugServer,
      transport: TransportKind.ipc,
+      options: { env: { CYPHER_25: 'true' } },


This only affects the server version we use in the tests, not the production one. So we'll have CYPHER_25 support enabled there by default.

ncordon · 2025-01-23T15:20:58Z

packages/vscode-extension/tests/specs/api/syntaxValidation.spec.ts

-          diagnostics = vscode.languages
-            .getDiagnostics()
-            .filter(([uri]) => uri.scheme === 'untitled')
-            .flatMap(([, diagnostics]) => diagnostics);


This was giving problems when having two documents opened that were temporary and not saved to file, because it would collect the diagnostics for both.

…cs-fns

anderson4j

Good stuff! Had some minor suggestions for improvement, and a question or two.

Also think some of the changes though good might have been a bit "off topic" (reformatting tests to use URI/better messages are what I think of at the top of my head). If im correct in thinking these could be their own PR, reviewing would be a little easier if we split these into their own thing

Also I made some comments about "cypher 5" vs "CYPHER 5" merging with my PR before you had done it - they are gone for me since you fixed it, but still in comment count, so ignore if they still pop up on corrected spots

packages/language-support/src/helpers.ts

packages/language-support/src/parserWrapper.ts

packages/language-support/src/signatureHelp.ts

packages/language-support/src/syntaxValidation/semanticAnalysisWrapper.ts

packages/language-support/src/helpers.ts

packages/language-support/src/tests/autocompletion/functionsCompletion.test.ts

packages/react-codemirror/src/CypherEditor.tsx

packages/schema-poller/src/metadataPoller.ts

packages/schema-poller/src/queries/databases.ts

packages/language-support/package.json

anderson4j

Works now!

…cs-fns

anderson4j and others added 8 commits January 13, 2025 12:44

Altered semantic analysis to use default/query-specified version if a…

34f2bb8

…vailable

Merge branch 'main' of https://github.com/neo4j/cypher-language-support…

1f76037

… into defaultLanguage

added tests

d1d0a48

small refactor, fix defaultLanguage to be more like data according to…

d79e282

… CIP

added changeset

b9fc356

Adds some minor nits

d653261

Adds versioned procedure registry

33fd518

Updates the semantic analysis to use different procedure registries d…

e58d2e5

…epending on the version

ncordon added 3 commits January 22, 2025 16:06

Adds tests for procedures / functions dependant on cypher versions

44c0b32

Adds tests for completions and signature help being cypher version de…

6e7e5c6

…pendant

Makes project compile

ff25f9e

ncordon force-pushed the polling-versioned-procs-fns branch from 57c7f5d to ff25f9e Compare January 22, 2025 17:38

ncordon and others added 5 commits January 23, 2025 08:40

Fixes e2e tests

fbdf5bb

Merge branch 'main' into polling-versioned-procs-fns

7cacbcb

Adds integration test to check the poller and VSCode extension can us…

9d29a4b

…e cypher versions

Merge remote-tracking branch 'origin/polling-versioned-procs-fns' int…

ee324f9

…o polling-versioned-procs-fns

Fixes e2e test

6c98b22

ncordon commented Jan 23, 2025

View reviewed changes

ncordon added 2 commits January 23, 2025 15:25

Self review

07f20b7

Adds feature flag to the codemirror wiring

f3b41a1

ncordon force-pushed the polling-versioned-procs-fns branch from bd075b5 to f3b41a1 Compare January 26, 2025 17:14

Fixes feature flag

662b643

ncordon force-pushed the polling-versioned-procs-fns branch from 5084993 to 662b643 Compare January 26, 2025 20:05

Adds more tests for codemirror

cbda4a1

ncordon assigned anderson4j Jan 27, 2025

ncordon added 2 commits January 28, 2025 11:21

Merge remote-tracking branch 'origin/main' into polling-versioned-pro…

ef228ad

…cs-fns

Updates semantic analysis and removes exports

f18041e

anderson4j requested changes Jan 29, 2025

View reviewed changes

ncordon and others added 2 commits January 29, 2025 11:02

Addresses pr review comments

d2704ec

Merge branch 'main' into polling-versioned-procs-fns

f2313a1

anderson4j reviewed Jan 29, 2025

View reviewed changes

packages/language-support/package.json Outdated Show resolved Hide resolved

Sets the env variable with cross-env

d6d9547

ncordon force-pushed the polling-versioned-procs-fns branch from 12d87d9 to d6d9547 Compare January 29, 2025 14:46

anderson4j approved these changes Jan 29, 2025

View reviewed changes

ncordon added 4 commits January 29, 2025 16:36

Updates only needed resolver

74f5ecb

Widens timeout

cacf7a4

Widens timeout even more

fb785f4

Removes helpers test

bdaa8f7

ncordon force-pushed the polling-versioned-procs-fns branch from 720750d to bdaa8f7 Compare January 30, 2025 13:46

ncordon added 2 commits January 30, 2025 13:47

Merge remote-tracking branch 'origin/main' into polling-versioned-pro…

811d70a

…cs-fns

Forces update

3a10389

ncordon force-pushed the polling-versioned-procs-fns branch from c8ccefd to 3a10389 Compare January 30, 2025 14:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adapts procedure registry to depend on the cypher version #331

Adapts procedure registry to depend on the cypher version #331

ncordon commented Jan 22, 2025 •

edited

Loading

changeset-bot bot commented Jan 22, 2025 •

edited

Loading

ncordon Jan 23, 2025

ncordon Jan 23, 2025

ncordon Jan 23, 2025 •

edited

Loading

ncordon Jan 23, 2025 •

edited

Loading

ncordon Jan 23, 2025 •

edited

Loading

ncordon Jan 23, 2025

ncordon Jan 23, 2025 •

edited

Loading

anderson4j left a comment

anderson4j left a comment

		procedures?: Partial<Record<CypherVersion, Record<string, Neo4jProcedure>>>;
		functions?: Partial<Record<CypherVersion, Record<string, Neo4jFunction>>>;

Adapts procedure registry to depend on the cypher version #331

Are you sure you want to change the base?

Adapts procedure registry to depend on the cypher version #331

Conversation

ncordon commented Jan 22, 2025 • edited Loading

What

Why

changeset-bot bot commented Jan 22, 2025 • edited Loading

⚠️ No Changeset found

ncordon Jan 23, 2025

Choose a reason for hiding this comment

ncordon Jan 23, 2025

Choose a reason for hiding this comment

ncordon Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

ncordon Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

ncordon Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

ncordon Jan 23, 2025

Choose a reason for hiding this comment

ncordon Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

anderson4j left a comment

Choose a reason for hiding this comment

anderson4j left a comment

Choose a reason for hiding this comment

ncordon commented Jan 22, 2025 •

edited

Loading

changeset-bot bot commented Jan 22, 2025 •

edited

Loading

ncordon Jan 23, 2025 •

edited

Loading

ncordon Jan 23, 2025 •

edited

Loading

ncordon Jan 23, 2025 •

edited

Loading

ncordon Jan 23, 2025 •

edited

Loading