Skip to content

Commit

Permalink
feat: support for external tupples
Browse files Browse the repository at this point in the history
  • Loading branch information
@d-jeffery
d-jeffery committed Feb 3, 2024
1 parent abd150d commit ec2f2b0
Show file tree
Hide file tree
Showing 2 changed files with 137 additions and 38 deletions.
125 changes: 100 additions & 25 deletions server/src/server.common.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import { TextDocument } from "vscode-languageserver-textdocument";
import { errors, transformer } from "@openfga/syntax-transformer";
import { defaultDocumentationMap } from "./documentation";
import { getDuplicationFix, getMissingDefinitionFix, getReservedTypeNameFix } from "./code-action";
import { LineCounter, YAMLSeq, parseDocument } from "yaml";
import { LineCounter, YAMLSeq, parseDocument, isScalar, visitAsync, Scalar, Pair, Document, visit } from "yaml";
import {
YAMLSourceMap,
YamlStoreValidateResults,
Expand All @@ -31,6 +31,7 @@ import {
validateYamlStore,
getFieldPosition,
getRangeFromToken,
DocumentLoc,
} from "./yaml-utils";
import { getRangeOfWord } from "./helpers";
import { getDiagnosticsForDsl as validateDSL } from "./dsl-utils";
Expand Down Expand Up @@ -100,16 +101,109 @@ export function startServer(connection: _Connection) {
connection.languages.diagnostics.refresh();
});

async function validateYamlSyntaxAndModel(textDocument: TextDocument): Promise<YamlStoreValidateResults> {
const diagnostics: Diagnostic[] = [];
const modelDiagnostics: Diagnostic[] = [];

async function parseYamlStore(
textDocument: TextDocument,
): Promise<{ yamlDoc: Document; lineCounter: LineCounter; parsedDiagnostics: Diagnostic[] }> {
const lineCounter = new LineCounter();
const yamlDoc = parseDocument(textDocument.getText(), {
lineCounter,
keepSourceTokens: true,
});

const parsedDiagnostics: Diagnostic[] = [];

// Basic syntax errors
for (const err of yamlDoc.errors) {
parsedDiagnostics.push({ message: err.message, range: rangeFromLinePos(err.linePos) });
}

const importedDocs = new Map<string, DocumentLoc>();

await visitAsync(yamlDoc, {
async Pair(_, pair) {
if (!isScalar(pair.key) || !isScalar(pair.value) || pair.key.value !== "tuple_file" || !pair.value.source) {
return;
}

const originalRange = pair.key.range;
try {
const result = await getFileContents(URI.parse(textDocument.uri), pair.value.source);
if (pair.value.source.match(/.yaml$/)) {
const file = parseDocument(result.contents);

const diagnosticFromInclusion: Diagnostic[] = [];

diagnosticFromInclusion.push(
...file.errors.map((err) => {
return {
source: "ParseError",
message: "error with external file: " + err.message,
range: getRangeFromToken(originalRange, textDocument),
};
}),
);

if (diagnosticFromInclusion.length) {
parsedDiagnostics.push(...diagnosticFromInclusion);
return undefined;
}

if (originalRange) {
importedDocs.set(pair.value.source, { range: originalRange, doc: file });
}
return visit.SKIP;
}
} catch (err) {
parsedDiagnostics.push({
range: getRangeFromToken(originalRange, textDocument),
message: "error with external file: " + (err as Error).message,
source: "ParseError",
});
}
},
});

// Override all tuples with new location
for (const p of importedDocs.entries()) {
visit(p[1].doc.contents, {
Scalar(key, node) {
node.range = p[1].range;
},
});
}

// Prepare final virtual doc
visit(yamlDoc, {
Pair(_, pair) {
if (!isScalar(pair.key) || !isScalar(pair.value) || pair.key.value !== "tuple_file" || !pair.value.source) {
return;
}

const value = importedDocs.get(pair.value.source);

if (value) {
// Import tuples, and point range at where file field used to exist
const scalar = new Scalar("tuples");
scalar.source = "tuples";
scalar.range = value?.range;

return new Pair(scalar, value?.doc.contents);
}
},
});
return { yamlDoc, lineCounter, parsedDiagnostics };
}

async function validateYamlSyntaxAndModel(textDocument: TextDocument): Promise<YamlStoreValidateResults> {
const diagnostics: Diagnostic[] = [];
const modelDiagnostics: Diagnostic[] = [];

const { yamlDoc, lineCounter, parsedDiagnostics } = await parseYamlStore(textDocument);

if (parsedDiagnostics.length) {
return { diagnostics: parsedDiagnostics };
}

const map = new YAMLSourceMap();
map.doMap(yamlDoc.contents);

Expand All @@ -119,25 +213,6 @@ export function startServer(connection: _Connection) {
return { diagnostics };
}

// Basic syntax errors
for (const err of yamlDoc.errors) {
diagnostics.push({ message: err.message, range: rangeFromLinePos(err.linePos) });
}

const keys = [...map.nodes.keys()].filter((key) => key.includes("tuple_file"));
for (const fileField of keys) {
const fileName = yamlDoc.getIn(fileField.split(".")) as string;
try {
await getFileContents(URI.parse(textDocument.uri), fileName);
} catch (err) {
diagnostics.push({
range: getRangeFromToken(map.nodes.get(fileField), textDocument),
message: "error with external file: " + (err as Error).message,
source: "ParseError",
});
}
}

let model,
modelUri = undefined;

Expand All @@ -147,7 +222,7 @@ export function startServer(connection: _Connection) {
diagnostics.push(...parseYamlModel(yamlDoc, lineCounter));
diagnostics.push(...validateYamlStore(yamlDoc.get("model") as string, yamlDoc, textDocument, map));
} else if (yamlDoc.has("model_file")) {
const position = getFieldPosition(yamlDoc, lineCounter, "model_file");
const position = getFieldPosition(yamlDoc, lineCounter, "model_file")[0];
const modelFile = yamlDoc.get("model_file") as string;

try {
Expand Down
50 changes: 37 additions & 13 deletions server/src/yaml-utils.ts
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,31 @@
import { Range, Position, Diagnostic, DiagnosticSeverity } from "vscode-languageserver";

import { Document, LineCounter, Node, Range as TokenRange, isMap, isPair, isScalar, isSeq } from "yaml";
import {
Document,
LineCounter,
Node,
Pair,
Range as TokenRange,
isMap,
isPair,
isScalar,
isSeq,
parseDocument,
visit,
} from "yaml";
import { LinePos } from "yaml/dist/errors";
import { BlockMap, SourceToken } from "yaml/dist/parse/cst";
import { getDiagnosticsForDsl } from "./dsl-utils";
import { ErrorObject, ValidateFunction } from "ajv";
import { transformer } from "@openfga/syntax-transformer";
import { YamlStoreValidator } from "./openfga-yaml-schema";
import { TextDocument } from "vscode-languageserver-textdocument";
import { URI } from "vscode-uri";

export type DocumentLoc = {
range: TokenRange;
doc: Document;
};

export type YamlStoreValidateResults = {
diagnostics: Diagnostic[];
modelUri?: URI;
Expand All @@ -32,22 +48,31 @@ export function rangeFromLinePos(linePos: [LinePos] | [LinePos, LinePos] | undef
return { start, end };
}

// Only gets the line of 1st depth. This should be deprecated and replaced.
export function parseDocumentWithFixedRange(contents: string, range: TokenRange): Document {
const doc = parseDocument(contents);
visit(doc, (key, node) => {
if (isPair(node) && isScalar(node.key)) {
node.key.range = range;

return new Pair(node);
}
});
return doc;
}

export function getFieldPosition(
yamlDoc: Document,
lineCounter: LineCounter,
field: string,
): { line: number; col: number } {
let position: { line: number; col: number } = { line: 0, col: 0 };

// Get the model token and find its position
(yamlDoc.contents?.srcToken as BlockMap).items.forEach((i) => {
if (i.key?.offset !== undefined && (i.key as SourceToken).source === field) {
position = lineCounter.linePos(i.key?.offset);
): { line: number; col: number }[] {
const positions: { line: number; col: number }[] = [];
visit(yamlDoc, (key, node) => {
if (isPair(node) && isScalar(node.key) && node.key.value === field && node.key.srcToken?.offset) {
positions.push(lineCounter.linePos(node.key.srcToken?.offset));
}
});

return position;
return positions;
}

export function validateYamlStore(
Expand Down Expand Up @@ -115,7 +140,7 @@ export function validateYamlStore(
}

export function parseYamlModel(yamlDoc: Document, lineCounter: LineCounter): Diagnostic[] {
const position = getFieldPosition(yamlDoc, lineCounter, "model");
const position = getFieldPosition(yamlDoc, lineCounter, "model")[0];

// Shift generated diagnostics by line of model, and indent of 2
let dslDiagnostics = getDiagnosticsForDsl(yamlDoc.get("model") as string);
Expand Down Expand Up @@ -172,7 +197,6 @@ export class YAMLSourceMap {

if (isScalar(node) && node.source && node.range) {
this.nodes.set(localPath.join("."), node.range);
return;
}
}
}
Expand Down

0 comments on commit ec2f2b0

Please sign in to comment.