Schema based linting (#681)

Author: anderson4j

packages/language-server/src/server.ts

@@ -244,14 +244,8 @@ connection.onNotification(
     version: number;
     schema: DbSchema;
   }) => {
-    neo4jSchemaPoller.events.once(
-      'schemaFetched',
-      // oxlint-disable-next-line typescript-eslint/no-meaningless-void-operator
-      void symbolFetcher.queueSymbolJob(
-        params.query,
-        params.uri,
-        params.schema,
-      ),
+    neo4jSchemaPoller.events.once('schemaFetched', () =>
+      symbolFetcher.queueSymbolJob(params.query, params.uri, params.schema),
     );
   },
 );

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

@@ -307,11 +307,11 @@ const parameterCompletions = (
         ? { insertText: `$${backtickedName}` }
         : {};
       // If there is a preceding token and it's not empty, compute the suffix
-      if (previousToken.type !== CypherLexer.SPACE) {
+      if (previousToken && tokens && previousToken.type !== CypherLexer.SPACE) {
         const param = maybeInsertText.insertText ?? `$${paramName}`;
         const hasDollar =
           previousToken.type === CypherLexer.DOLLAR ||
-          tokens.at(previousToken.tokenIndex - 1).type === CypherLexer.DOLLAR;
+          tokens.at(previousToken.tokenIndex - 1)?.type === CypherLexer.DOLLAR;
         // If the $ symbol is already there, we need to have the insert
         // text without the starting $ in VSCode, otherwise when we have
         // 'RETURN $' and we get offered $param we would complete

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

@@ -5,13 +5,7 @@ import {
 } from 'vscode-languageserver-types';
 import { DbSchema } from '../dbSchema.js';
 import { ParsedStatement } from '../cypherLanguageService.js';
-import {
-  ConditionNode,
-  isLabelLeaf,
-  LabelLeaf,
-  LabelOrCondition,
-  SymbolsInfo,
-} from '../types.js';
+import { isLabelLeaf, LabelOrCondition, SymbolsInfo } from '../types.js';
 import { findParent } from '../helpers.js';
 import {
   NodePatternContext,
@@ -26,6 +20,11 @@ import {
   isNotAnyNode,
   removeInnerAnys,
 } from '../labelTreeRewriting.js';
+import {
+  getNodesFromRelsSet,
+  getRelsFromNodesSets,
+  walkCNFTree,
+} from '../labelTreeWalking.js';
 
 export function getShortPathCompletions(
   lastNode: RelationshipPatternContext,
@@ -202,120 +201,6 @@ const reltypesToCompletions = (reltypes: string[] = []) =>
 export const allReltypeCompletions = (dbSchema: DbSchema) =>
   reltypesToCompletions(dbSchema.relationshipTypes);
 
-function walkCNFTree(
-  incomingLabels: Map<string, Set<string>>,
-  outGoingLabels: Map<string, Set<string>>,
-  labelTree: LabelOrCondition,
-): { inLabels: Set<string>; outLabels: Set<string> } {
-  //Bail if tree is not CNF
-  if (isLabelLeaf(labelTree) || labelTree.condition !== 'and') {
-    let inLabels = new Set<string>();
-    let outLabels = new Set<string>();
-    incomingLabels.values().forEach((x) => (inLabels = inLabels.union(x)));
-    outGoingLabels.values().forEach((x) => (outLabels = outLabels.union(x)));
-
-    return { inLabels, outLabels };
-  }
-  const notLabels: LabelLeaf[] = [];
-  const literalLabels: LabelLeaf[] = [];
-  const orNodes: ConditionNode[] = [];
-
-  labelTree.children.forEach((c) => {
-    if (isLabelLeaf(c)) {
-      literalLabels.push(c);
-    } else if (
-      c.condition === 'not' &&
-      c.children.length === 1 &&
-      isLabelLeaf(c.children[0])
-    ) {
-      notLabels.push(c.children[0]);
-    } else if (c.condition === 'or') {
-      orNodes.push(c);
-    }
-  });
-
-  let inLabels = new Set<string>();
-  incomingLabels.forEach((part, key) => {
-    if (!notLabels.some((c) => c.value === key)) {
-      inLabels = inLabels.union(part);
-    }
-  });
-  let outLabels = new Set<string>();
-  outGoingLabels.forEach((part, key) => {
-    if (!notLabels.some((c) => c.value === key)) {
-      outLabels = outLabels.union(part);
-    }
-  });
-
-  for (const label of literalLabels) {
-    const incoming = incomingLabels.get(label.value) ?? new Set();
-    const outgoing = outGoingLabels.get(label.value) ?? new Set();
-    inLabels = inLabels.intersection(incoming);
-    outLabels = outLabels.intersection(outgoing);
-  }
-
-  for (const node of orNodes) {
-    let incoming = new Set();
-    let outGoing = new Set();
-    for (const c of node.children) {
-      if (isLabelLeaf(c)) {
-        const newIncoming = incomingLabels.get(c.value) ?? new Set();
-        const newOutgoing = outGoingLabels.get(c.value) ?? new Set();
-        incoming = incoming.union(newIncoming);
-        outGoing = outGoing.union(newOutgoing);
-      }
-    }
-    inLabels = inLabels.intersection(incoming);
-    outLabels = outLabels.intersection(outGoing);
-  }
-  return { inLabels, outLabels };
-}
-
-function getRelsFromNodesSets(dbSchema: DbSchema): {
-  toNodes: Map<string, Set<string>>;
-  fromNodes: Map<string, Set<string>>;
-} {
-  if (dbSchema.graphSchema) {
-    const toNodes: Map<string, Set<string>> = new Map();
-    const fromNodes: Map<string, Set<string>> = new Map();
-    dbSchema.graphSchema.forEach((rel) => {
-      //rels in schema defined like (from)-(relType)->(to)
-      //Means 'from' is "node going to rel", hence why we
-      //pass rel.from into toNodes
-      if (!toNodes.has(rel.from)) {
-        toNodes.set(rel.from, new Set());
-      }
-      if (!fromNodes.has(rel.to)) {
-        fromNodes.set(rel.to, new Set());
-      }
-      toNodes.get(rel.from).add(rel.relType);
-      fromNodes.get(rel.to).add(rel.relType);
-    });
-    return { toNodes, fromNodes };
-  }
-  return undefined;
-}
-
-function getNodesFromRelsSet(dbSchema: DbSchema): {
-  toRels: Map<string, Set<string>>;
-  fromRels: Map<string, Set<string>>;
-} {
-  if (dbSchema.graphSchema) {
-    const toRels: Map<string, Set<string>> = new Map();
-    const fromRels: Map<string, Set<string>> = new Map();
-    dbSchema.graphSchema.forEach((rel) => {
-      if (!toRels.has(rel.relType)) {
-        toRels.set(rel.relType, new Set());
-        fromRels.set(rel.relType, new Set());
-      }
-      toRels.get(rel.relType).add(rel.to);
-      fromRels.get(rel.relType).add(rel.from);
-    });
-    return { toRels, fromRels };
-  }
-  return undefined;
-}
-
 function findLastVariable(
   lastValidElement: NodePatternContext | RelationshipPatternContext,
   symbolsInfo: SymbolsInfo,
@@ -328,7 +213,7 @@ function findLastVariable(
           // Because the anonymous variable created in the AST is "made up", it doesnt have a position of its own in the query.
           // It therefor inherits the parent-nodes (The NodePattern/RelationshipPattern = lastValidElement) position
           entry.definitionPosition >= lastValidElement.start.start &&
-          entry.definitionPosition <= lastValidElement.stop.stop,
+          entry.definitionPosition <= (lastValidElement.stop?.stop ?? -1),
       )
     : symbolsInfo?.symbolTables
         ?.flat()
@@ -350,7 +235,7 @@ export function completeNodeLabel(
     (x) => x instanceof PatternElementContext,
   );
 
-  if (callContext instanceof PatternElementContext) {
+  if (callContext instanceof PatternElementContext && callContext.children) {
     const lastValidElement = callContext.children.toReversed().find((child) => {
       if (child instanceof RelationshipPatternContext) {
         if (child.exception === null) {
@@ -375,11 +260,12 @@ export function completeNodeLabel(
         return allLabelCompletions(dbSchema);
       }
 
-      const direction = lastValidElement.leftArrow()
-        ? 'outgoing'
-        : lastValidElement.rightArrow()
-          ? 'incoming'
-          : 'bidirectional';
+      const direction =
+        lastValidElement.leftArrow() && !lastValidElement.rightArrow()
+          ? 'outgoing'
+          : !lastValidElement.leftArrow() && lastValidElement.rightArrow()
+            ? 'incoming'
+            : 'bidirectional';
 
       // limitation: not checking node label repetition
       const { toRels: nodesToRelsSet, fromRels: nodesFromRelsSet } =
@@ -396,14 +282,6 @@ export function completeNodeLabel(
       } catch {
         return allLabelCompletions(dbSchema);
       }
-      let allIncomingLabels = new Set<string>();
-      nodesToRelsSet.forEach((part) => {
-        allIncomingLabels = allIncomingLabels.union(part);
-      });
-      let allOutGoingLabels = new Set<string>();
-      nodesFromRelsSet.forEach((part) => {
-        allOutGoingLabels = allOutGoingLabels.union(part);
-      });
       const { inLabels, outLabels } = walkCNFTree(
         nodesToRelsSet,
         nodesFromRelsSet,
@@ -438,7 +316,10 @@ export function completeRelationshipType(
     (x) => x instanceof PatternElementContext,
   );
 
-  if (patternContext instanceof PatternElementContext) {
+  if (
+    patternContext instanceof PatternElementContext &&
+    patternContext.children
+  ) {
     const lastValidElement = patternContext.children
       .toReversed()
       .find((child) => {
@@ -455,11 +336,12 @@ export function completeRelationshipType(
     );
     let direction = 'bidirectional';
     if (thisCtx instanceof RelationshipPatternContext) {
-      direction = thisCtx.leftArrow()
-        ? 'outgoing'
-        : thisCtx.rightArrow()
-          ? 'incoming'
-          : 'bidirectional';
+      direction =
+        thisCtx.leftArrow() && !thisCtx.rightArrow()
+          ? 'outgoing'
+          : !thisCtx.leftArrow() && thisCtx.rightArrow()
+            ? 'incoming'
+            : 'bidirectional';
     }
 
     // limitation: bailing out on quantifiers
@@ -493,14 +375,6 @@ export function completeRelationshipType(
       } catch {
         return [];
       }
-      let allIncomingLabels = new Set<string>();
-      relsToNodesSet.forEach((part) => {
-        allIncomingLabels = allIncomingLabels.union(part);
-      });
-      let allOutGoingLabels = new Set<string>();
-      relsFromNodesSet.forEach((part) => {
-        allOutGoingLabels = allOutGoingLabels.union(part);
-      });
       const { inLabels, outLabels } = walkCNFTree(
         relsToNodesSet,
         relsFromNodesSet,

packages/language-support/src/cypherLanguageService.ts

@@ -802,7 +802,7 @@ function parseToCommand(
   return { type: 'parse-error', start: stmts.start, stop: stmts.stop };
 }
 
-function translateTokensToRange(
+export function translateTokensToRange(
   start: Token,
   stop: Token,
 ): Pick<SyntaxDiagnostic, 'range' | 'offsets'> {

packages/language-support/src/labelTreeRewriting.ts

@@ -134,7 +134,7 @@ export function childAlreadyExists(
   }
 }
 
-function equalConditions(c1: LabelOrCondition, c2: LabelOrCondition) {
+function equalConditions(c1: LabelOrCondition, c2: LabelOrCondition): boolean {
   if (isLabelLeaf(c1)) {
     return isLabelLeaf(c2) && c1.value === c2.value;
   } else if (isLabelLeaf(c2)) {