Support Custom Dialects

Author: diyaayay

language-server/src/build-server.js

@@ -1,5 +1,6 @@
 import { TextDocuments } from "vscode-languageserver";
 import { TextDocument } from "vscode-languageserver-textdocument";
+import { removeMediaTypePlugin } from "@hyperjump/browser";
 
 // Hyperjump
 import "@hyperjump/json-schema/draft-2020-12";
@@ -22,6 +23,9 @@ import "@hyperjump/json-schema/draft-04";
  * }} Feature
  */
 
+removeMediaTypePlugin("http");
+removeMediaTypePlugin("https");
+
 /** @type (connection: Connection, features: Feature[]) => void */
 export const buildServer = (connection, features) => {
   const documents = new TextDocuments(TextDocument);

language-server/src/features/hover.test.ts

@@ -196,7 +196,7 @@ describe("Feature - Hover", () => {
       ["type", "\"object\""]
     ])("%s should have a message", async (keyword, value) => {
       documentUri = await client.openDocument("./subject.schema.json", `{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",${keyword === "$vocabulary" ? `"$id": "https://example.com/schema",` : ""}
   "${keyword}": ${value}
 }`);
 
@@ -317,7 +317,7 @@ describe("Feature - Hover", () => {
       ["type", "\"object\""]
     ])("%s should have a message", async (keyword, value) => {
       documentUri = await client.openDocument("./subject.schema.json", `{
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",${keyword === "$vocabulary" ? `"$id": "https://example.com/schema",` : ""}
   "${keyword}": ${value}
 }`);
 

language-server/src/features/register-schema.test.ts

@@ -0,0 +1,78 @@
+import { afterEach, beforeEach, describe, expect, test } from "vitest";
+import {
+  PublishDiagnosticsNotification
+} from "vscode-languageserver";
+import { TestClient } from "../test-client.js";
+import documentSettings from "./document-settings.js";
+import semanticTokens from "./semantic-tokens.js";
+import schemaRegistry from "./schema-registry.js";
+import workspace from "./workspace.js";
+import validationErrorsFeature from "./validation-errors.js";
+import { setupWorkspace, tearDownWorkspace } from "../test-utils.js";
+
+import type { Diagnostic } from "vscode-languageserver";
+import type { DocumentSettings } from "./document-settings.js";
+import { resolveIri } from "@hyperjump/uri";
+
+
+describe("Feature - Register Schema", () => {
+  let client: TestClient<DocumentSettings>;
+  let workspaceFolder: string;
+
+  beforeEach(async () => {
+    client = new TestClient([
+      workspace,
+      documentSettings,
+      semanticTokens,
+      schemaRegistry,
+      validationErrorsFeature
+    ]);
+    workspaceFolder = await setupWorkspace({
+      "subjectB.schema.json": ``,
+      "subject.schema.json": ``
+    });
+
+    await client.start({
+      workspaceFolders: [
+        {
+          name: "root",
+          uri: workspaceFolder
+        }
+      ]
+    });
+  });
+
+  afterEach(async () => {
+    await client.stop();
+    await tearDownWorkspace(workspaceFolder);
+  });
+
+  test("Registered schema ", async () => {
+    const diagnosticsPromise = new Promise<Diagnostic[]>((resolve) => {
+      client.onNotification(PublishDiagnosticsNotification.type, (params) => {
+        resolve(params.diagnostics);
+      });
+    });
+
+    const documentUriB = resolveIri("./subjectB.schema.json", `${workspaceFolder}/`);
+
+    await client.openDocument(documentUriB, `{
+      "$id": "https://example.com/my-dialect",
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+    
+      "$vocabulary": {
+        "https://json-schema.org/draft/2020-12/vocab/core": true,
+        "https://json-schema.org/draft/2020-12/vocab/applicator": true,
+        "https://json-schema.org/draft/2020-12/vocab/validation": true
+      }
+    }`);
+
+    const documentUri = resolveIri("./subjectB.schema.json", `${workspaceFolder}/`);
+    await client.openDocument(documentUri, `{
+      "$schema": "https://example.com/my-dialect",
+    }`);
+
+    const diagnostics = await diagnosticsPromise;
+    expect(diagnostics).to.eql([]);
+  });
+});

language-server/src/features/schema-registry.js

@@ -1,5 +1,9 @@
 import { getDocumentSettings } from "./document-settings.js";
 import * as SchemaDocument from "../schema-document.js";
+import { registerSchema, unregisterSchema } from "@hyperjump/json-schema/draft-2020-12";
+import * as SchemaNode from "../schema-node.js";
+import { publishAsync } from "../pubsub.js";
+import { keywordNameFor } from "../util.js";
 
 /**
  * @import { Connection } from "vscode-languageserver"
@@ -12,10 +16,21 @@ import * as SchemaDocument from "../schema-document.js";
 
 /** @type Feature */
 export default {
-  load(_connection, documents) {
+  load(connection, documents) {
     documents.onDidClose(({ document }) => {
       schemaDocuments.delete(document.uri);
     });
+
+    connection.workspace.onDidDeleteFiles(async (params) => {
+      for (const file of params.files) {
+        const textDocument = documents.get(file.uri);
+        const schemaDocument = textDocument && await getSchemaDocument(connection, textDocument);
+        for (const schemaResource of schemaDocument?.schemaResources ?? []) {
+          unregisterSchema(schemaResource.baseUri);
+          await publishAsync("workspaceChanged", { changes: [] });
+        }
+      }
+    });
   },
 
   onInitialize() {
@@ -41,6 +56,13 @@ export const getSchemaDocument = async (connection, textDocument) => {
 
     schemaDocuments.set(textDocument.uri, { version: textDocument.version, schemaDocument });
   }
+  for (const schemaResource of schemaDocument.schemaResources) {
+    const vocabToken = keywordNameFor("https://json-schema.org/keyword/vocabulary", schemaResource.dialectUri);
+    const vocabularyNode = vocabToken && await SchemaNode.step(vocabToken, schemaResource);
+    if (vocabularyNode) {
+      registerSchema(SchemaNode.value(schemaResource), textDocument.uri);
+    }
+  }
 
   return schemaDocument;
 };

language-server/src/features/semantic-tokens.js

@@ -191,7 +191,7 @@ const schemaHandler = function* (schemaResource) {
 };
 
 /** @type (keywordName: string, dialectUri?: string) => string | undefined */
-const keywordIdFor = (keywordName, dialectUri) => {
+export const keywordIdFor = (keywordName, dialectUri) => {
   if (!dialectUri) {
     return;
   }

language-server/src/features/semantic-tokens.test.ts

@@ -114,7 +114,6 @@ describe("Feature - Semantic Tokens", () => {
       await client.closeDocument(documentUri);
     });
 
-
     test.each([
       // Applicators
       ["prefixItems", "[{}]", [1, 2, 9, 1, 0, 1, 2, 13, 1, 0]],
@@ -144,7 +143,7 @@ describe("Feature - Semantic Tokens", () => {
       ["$ref", "\"\"", [1, 2, 9, 1, 0, 1, 2, 6, 1, 0]],
       ["$dynamicRef", "\"\"", [1, 2, 9, 1, 0, 1, 2, 13, 1, 0]],
       ["$dynamicAnchor", "\"foo\"", [1, 2, 9, 1, 0, 1, 2, 16, 1, 0]],
-      ["$vocabulary", "{}", [1, 2, 9, 1, 0, 1, 2, 13, 1, 0]],
+      ["$vocabulary", "{}", [1, 2, 9, 1, 0, 0, 58, 5, 1, 0, 1, 2, 13, 1, 0]],
       ["$comment", "\"\"", [1, 2, 9, 1, 0, 1, 2, 14, 2, 0]],
       ["$defs", "{}", [1, 2, 9, 1, 0, 1, 2, 7, 1, 0]],
 
@@ -187,7 +186,7 @@ describe("Feature - Semantic Tokens", () => {
       ["type", "\"object\"", [1, 2, 9, 1, 0, 1, 2, 6, 1, 0]]
     ])("%s should be highlighted", async (keyword, value, expected) => {
       documentUri = await client.openDocument("./subject.schema.json", `{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",${keyword === "$vocabulary" ? `"$id": "https://example.com/schema",` : ""}
   "${keyword}": ${value}
 }`);
 
@@ -261,7 +260,7 @@ describe("Feature - Semantic Tokens", () => {
       ["$ref", "\"\"", [1, 2, 9, 1, 0, 1, 2, 6, 1, 0]],
       ["$recursiveRef", "\"\"", [1, 2, 9, 1, 0, 1, 2, 15, 1, 0]],
       ["$recursiveAnchor", "true", [1, 2, 9, 1, 0, 1, 2, 18, 1, 0]],
-      ["$vocabulary", "{}", [1, 2, 9, 1, 0, 1, 2, 13, 1, 0]],
+      ["$vocabulary", "{}", [1, 2, 9, 1, 0, 0, 58, 5, 1, 0, 1, 2, 13, 1, 0]],
       ["$comment", "\"\"", [1, 2, 9, 1, 0, 1, 2, 14, 2, 0]],
       ["$defs", "{}", [1, 2, 9, 1, 0, 1, 2, 7, 1, 0]],
 
@@ -300,7 +299,7 @@ describe("Feature - Semantic Tokens", () => {
       ["type", "\"object\"", [1, 2, 9, 1, 0, 1, 2, 6, 1, 0]]
     ])("%s should be highlighted", async (keyword, value, expected) => {
       documentUri = await client.openDocument("./subject.schema.json", `{
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",${keyword === "$vocabulary" ? `"$id": "https://example.com/schema",` : ""}
   "${keyword}": ${value}
 }`);
 

language-server/src/features/unregister-schema.test.ts

@@ -0,0 +1,102 @@
+import { afterEach, beforeEach, describe, expect, test } from "vitest";
+import {
+  DidDeleteFilesNotification,
+  PublishDiagnosticsNotification,
+  WorkDoneProgress,
+  WorkDoneProgressCreateRequest
+} from "vscode-languageserver";
+import { rm } from "node:fs/promises";
+import { fileURLToPath } from "node:url";
+import { TestClient } from "../test-client.js";
+import documentSettings from "./document-settings.js";
+import semanticTokens from "./semantic-tokens.js";
+import schemaRegistry from "./schema-registry.js";
+import workspace from "./workspace.js";
+import validationErrorsFeature from "./validation-errors.js";
+import { setupWorkspace, tearDownWorkspace } from "../test-utils.js";
+
+import type { Diagnostic } from "vscode-languageserver";
+import type { DocumentSettings } from "./document-settings.js";
+import { resolveIri } from "@hyperjump/uri";
+
+
+describe("Feature - Register Schema", () => {
+  let client: TestClient<DocumentSettings>;
+  let workspaceFolder: string;
+
+  beforeEach(async () => {
+    client = new TestClient([
+      workspace,
+      documentSettings,
+      semanticTokens,
+      schemaRegistry,
+      validationErrorsFeature
+    ]);
+    workspaceFolder = await setupWorkspace({
+      "subjectB.schema.json": ``,
+      "subject.schema.json": ``
+    });
+
+    await client.start({
+      workspaceFolders: [
+        {
+          name: "root",
+          uri: workspaceFolder
+        }
+      ]
+    });
+  });
+
+  afterEach(async () => {
+    await client.stop();
+    await tearDownWorkspace(workspaceFolder);
+  });
+
+  test("Unregisterschema ", async () => {
+    const diagnosticsPromise = new Promise<Diagnostic[]>((resolve) => {
+      let diagnostics: Diagnostic[];
+
+      client.onRequest(WorkDoneProgressCreateRequest.type, ({ token }) => {
+        client.onProgress(WorkDoneProgress.type, token, ({ kind }) => {
+          if (kind === "end") {
+            resolve(diagnostics);
+          }
+        });
+      });
+
+      client.onNotification(PublishDiagnosticsNotification.type, (params) => {
+        diagnostics = params.diagnostics;
+      });
+    });
+
+    const documentUriB = resolveIri("./subjectB.schema.json", `${workspaceFolder}/`);
+
+    const subjectDocumentUri = await client.openDocument(documentUriB, `{
+      "$id": "https://example.com/my-dialect",
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+    
+      "$vocabulary": {
+        "https://json-schema.org/draft/2020-12/vocab/core": true,
+        "https://json-schema.org/draft/2020-12/vocab/applicator": true,
+        "https://json-schema.org/draft/2020-12/vocab/validation": true
+      }
+    }`);
+
+    const documentUri = resolveIri("./subject.schema.json", `${workspaceFolder}/`);
+
+    await client.openDocument(documentUri, `{
+      "$schema": "https://example.com/my-dialect",
+    }`);
+
+    await rm(fileURLToPath(subjectDocumentUri));
+
+    await client.sendNotification(DidDeleteFilesNotification.type, {
+      files: [{
+        uri: subjectDocumentUri
+      }]
+    });
+
+    const diagnostics = await diagnosticsPromise;
+    expect(diagnostics[0]?.message).to.eql("Unknown dialect");
+  });
+});