@player-lang/json-language-service 0.0.2-next.0

package/src/plugins/__tests__/duplicate-id-plugin.test.ts

@@ -0,0 +1,195 @@
+import { test, expect, describe, beforeEach } from "vitest";
+import { TextDocument } from "vscode-languageserver-textdocument";
+import {
+  ReferenceAssetsWebPluginManifest,
+  Types,
+} from "@player-lang/static-xlrs";
+import { PlayerLanguageService } from "../..";
+import { toTextDocument } from "../../utils";
+
+const simpleDupIDDocument = toTextDocument(
+  JSON.stringify(
+    {
+      views: [
+        {
+          id: "no",
+          type: "bar",
+          foo: {
+            asset: {
+              id: "bar",
+            },
+          },
+          bar: {
+            asset: {
+              id: "bar",
+            },
+          },
+        },
+      ],
+    },
+    null,
+    2,
+  ),
+);
+
+const dupIDDocumentWithTemplate = toTextDocument(
+  JSON.stringify(
+    {
+      id: "test",
+      views: [
+        {
+          id: "root",
+          type: "info",
+          primaryInfo: {
+            asset: {
+              id: "root-primaryInfo-collection",
+              type: "collection",
+              template: [
+                {
+                  data: "some.data",
+                  output: "values",
+                  value: {
+                    asset: {
+                      id: "root-primaryInfo-collection-values-collection",
+                      type: "collection",
+                      template: [
+                        {
+                          data: "some.other.data",
+                          output: "values",
+                          value: {
+                            asset: {
+                              id: "root-primaryInfo-collection-values-collection-values-text",
+                              type: "text",
+                              value: "something",
+                            },
+                          },
+                        },
+                        {
+                          data: "some.other.data",
+                          output: "values",
+                          value: {
+                            asset: {
+                              id: "root-primaryInfo-collection-values-_index_collection-values_index1_-text",
+                              type: "text",
+                              value: "something",
+                            },
+                          },
+                        },
+                      ],
+                    },
+                  },
+                },
+              ],
+            },
+          },
+        },
+      ],
+      navigation: {
+        BEGIN: "FLOW_1",
+        FLOW_1: {
+          VIEW_1: {
+            ref: "root",
+            state_type: "VIEW",
+            transitions: {
+              "*": "END_Done",
+            },
+          },
+          END_Done: {
+            state_type: "END",
+            outcome: "done",
+          },
+          startState: "VIEW_1",
+        },
+      },
+    },
+    null,
+    2,
+  ),
+);
+
+describe("duplicate-id-plugin", () => {
+  let service: PlayerLanguageService;
+
+  beforeEach(async () => {
+    service = new PlayerLanguageService();
+    await service.setAssetTypesFromModule([
+      Types,
+      ReferenceAssetsWebPluginManifest,
+    ]);
+  });
+
+  test("finds dupe ids", async () => {
+    const validations = await service.validateTextDocument(simpleDupIDDocument);
+
+    expect(validations).toHaveLength(10);
+    expect(validations?.map((v) => v.message)).toMatchInlineSnapshot(`
+      [
+        "Content Validation Error - missing: Property "id" missing from type "Flow"",
+        "Content Validation Error - missing: Property "navigation" missing from type "Flow"",
+        "View is not reachable",
+        "Warning - View Type bar was not loaded into Validator definitions",
+        "Warning - Asset Type undefined was not loaded into Validator definitions",
+        "Asset Validation Error - missing: Property "type" missing from type "Asset"",
+        "The id "bar" is already in use in this view.",
+        "The id "bar" is already in use in this view.",
+        "Warning - Asset Type undefined was not loaded into Validator definitions",
+        "Asset Validation Error - missing: Property "type" missing from type "Asset"",
+      ]
+    `);
+  });
+
+  test("finds templates with missing index segments", async () => {
+    const validations = await service.validateTextDocument(
+      dupIDDocumentWithTemplate,
+    );
+
+    expect(validations).toHaveLength(2);
+    expect(validations?.map((v) => v.message)).toMatchInlineSnapshot(`
+      [
+        "The id for this templated elements is missing the following index segments: _index_",
+        "The id for this templated elements is missing the following index segments: _index_, _index1_",
+      ]
+    `);
+  });
+
+  test("fixes dup ids", async () => {
+    const diags = await service.validateTextDocument(simpleDupIDDocument);
+
+    const actions = await service.getCodeActionsInRange(simpleDupIDDocument, {
+      diagnostics: diags ?? [],
+    });
+
+    expect(actions).toHaveLength(2);
+    const editActions = actions[0].edit?.changes?.[simpleDupIDDocument.uri];
+
+    const appliedAction = TextDocument.applyEdits(
+      simpleDupIDDocument,
+      editActions ?? [],
+    );
+
+    expect(appliedAction).toStrictEqual(
+      JSON.stringify(
+        {
+          views: [
+            {
+              id: "no",
+              type: "bar",
+              foo: {
+                asset: {
+                  id: "foo-asset",
+                },
+              },
+              bar: {
+                asset: {
+                  id: "bar",
+                },
+              },
+            },
+          ],
+        },
+        null,
+        2,
+      ),
+    );
+  });
+});

package/src/plugins/__tests__/missing-asset-wrapper-plugin.test.ts

@@ -0,0 +1,190 @@
+import { test, expect, describe, beforeEach } from "vitest";
+import { TextDocument } from "vscode-languageserver-textdocument";
+import {
+  ReferenceAssetsWebPluginManifest,
+  Types,
+} from "@player-lang/static-xlrs";
+import { PlayerLanguageService } from "../..";
+import { toTextDocument } from "../../utils";
+
+const simpleAssetWrapperDocument = toTextDocument(
+  JSON.stringify(
+    {
+      id: "foo",
+      navigation: {
+        BEGIN: "FLOW_1",
+        FLOW_1: {
+          startState: "VIEW_1",
+          VIEW_1: {
+            state_type: "VIEW",
+            ref: "input",
+            transitions: {},
+          },
+        },
+      },
+      views: [
+        {
+          id: "input",
+          type: "input",
+          binding: "foo.bar",
+          label: {
+            id: "input-label",
+            type: "text",
+            value: "Label",
+          },
+        },
+      ],
+    },
+    null,
+    2,
+  ),
+);
+
+describe("missing-asset-wrapper", () => {
+  let service: PlayerLanguageService;
+
+  beforeEach(async () => {
+    service = new PlayerLanguageService();
+    await service.setAssetTypesFromModule([
+      Types,
+      ReferenceAssetsWebPluginManifest,
+    ]);
+  });
+
+  test("adds validation for the asset wrapper", async () => {
+    const validations = await service.validateTextDocument(
+      simpleAssetWrapperDocument,
+    );
+
+    expect(validations).toHaveLength(2);
+    expect(validations?.map((v) => v.message)).toMatchInlineSnapshot(`
+      [
+        "View Validation Error - value: Does not match any of the expected types for type: 'AssetWrapperOrSwitch'",
+        "Expected: AssetWrapper & object literal | StaticSwitch & object literal | DynamicSwitch & object literal",
+      ]
+    `);
+  });
+
+  test("fixes the violation", async () => {
+    const diags = await service.validateTextDocument(
+      simpleAssetWrapperDocument,
+    );
+
+    expect(diags).toMatchInlineSnapshot(`
+      [
+        {
+          "message": "View Validation Error - value: Does not match any of the expected types for type: 'AssetWrapperOrSwitch'",
+          "range": {
+            "end": {
+              "character": 7,
+              "line": 22,
+            },
+            "start": {
+              "character": 15,
+              "line": 18,
+            },
+          },
+          "severity": 1,
+        },
+        {
+          "message": "Expected: AssetWrapper & object literal | StaticSwitch & object literal | DynamicSwitch & object literal",
+          "range": {
+            "end": {
+              "character": 7,
+              "line": 22,
+            },
+            "start": {
+              "character": 15,
+              "line": 18,
+            },
+          },
+          "severity": 3,
+        },
+      ]
+    `);
+
+    const actions = await service.getCodeActionsInRange(
+      simpleAssetWrapperDocument,
+      {
+        diagnostics: diags ?? [],
+      },
+    );
+
+    expect(actions).toMatchInlineSnapshot(`
+      [
+        {
+          "edit": {
+            "changes": {
+              "foo": [
+                {
+                  "newText": "{
+              "asset": {
+                "id": "input-label",
+                "type": "text",
+                "value": "Label"
+              }
+            }",
+                  "range": {
+                    "end": {
+                      "character": 7,
+                      "line": 22,
+                    },
+                    "start": {
+                      "character": 15,
+                      "line": 18,
+                    },
+                  },
+                },
+              ],
+            },
+          },
+          "kind": "quickfix",
+          "title": "Wrap in "asset"",
+        },
+      ]
+    `);
+
+    const editActions =
+      actions[0]?.edit?.changes?.[simpleAssetWrapperDocument.uri];
+
+    const appliedAction = TextDocument.applyEdits(
+      simpleAssetWrapperDocument,
+      editActions ?? [],
+    );
+
+    expect(appliedAction).toStrictEqual(
+      JSON.stringify(
+        {
+          id: "foo",
+          navigation: {
+            BEGIN: "FLOW_1",
+            FLOW_1: {
+              startState: "VIEW_1",
+              VIEW_1: {
+                state_type: "VIEW",
+                ref: "input",
+                transitions: {},
+              },
+            },
+          },
+          views: [
+            {
+              id: "input",
+              type: "input",
+              binding: "foo.bar",
+              label: {
+                asset: {
+                  id: "input-label",
+                  type: "text",
+                  value: "Label",
+                },
+              },
+            },
+          ],
+        },
+        null,
+        2,
+      ),
+    );
+  });
+});

package/src/plugins/__tests__/nav-state-plugin.test.ts

@@ -0,0 +1,136 @@
+import { test, expect, describe, beforeEach } from "vitest";
+import {
+  ReferenceAssetsWebPluginManifest,
+  Types,
+} from "@player-lang/static-xlrs";
+import { PlayerLanguageService } from "../..";
+import { toTextDocument } from "../../utils";
+
+describe("nav-state-plugin", () => {
+  let service: PlayerLanguageService;
+
+  beforeEach(async () => {
+    service = new PlayerLanguageService();
+    await service.setAssetTypesFromModule([
+      Types,
+      ReferenceAssetsWebPluginManifest,
+    ]);
+  });
+
+  test("validates node transitions", async () => {
+    const testDocument = toTextDocument(
+      JSON.stringify(
+        {
+          id: "foo",
+          views: [{ id: "view-1", type: "view" }],
+          navigation: {
+            BEGIN: "FLOW_1",
+            FLOW_1: {
+              startState: "VIEW_1",
+              VIEW_1: {
+                state_type: "VIEW",
+                ref: "view-1",
+                transitions: {
+                  next: "ACTION_1",
+                },
+              },
+            },
+          },
+        },
+        null,
+        2,
+      ),
+    );
+
+    const diags = await service.validateTextDocument(testDocument);
+
+    expect(diags).toHaveLength(2);
+    expect(diags?.map((m) => m.message)).toMatchInlineSnapshot(`
+      [
+        "Warning - View Type view was not loaded into Validator definitions",
+        "Node "ACTION_1" not found",
+      ]
+    `);
+  });
+
+  test("validates node transitions with multiple flows", async () => {
+    const testDocument = toTextDocument(
+      JSON.stringify(
+        {
+          id: "foo",
+          views: [
+            { id: "view-1", type: "view" },
+            { id: "view-2", type: "view" },
+          ],
+          navigation: {
+            BEGIN: "FLOW_1",
+            FLOW_1: {
+              startState: "VIEW_1",
+              VIEW_1: {
+                state_type: "VIEW",
+                ref: "view-1",
+                transitions: {
+                  next: "END_Done",
+                },
+              },
+              END_Done: {
+                state_type: "END",
+                outcome: "done",
+              },
+            },
+            FLOW_2: {
+              startState: "VIEW_2",
+              VIEW_2: {
+                state_type: "VIEW",
+                ref: "view-2",
+                transitions: {
+                  back: "END_Back",
+                },
+              },
+              END_Back: {
+                state_type: "END",
+                outcome: "done",
+              },
+            },
+          },
+        },
+        null,
+        2,
+      ),
+    );
+    const diags = await service.validateTextDocument(testDocument);
+
+    expect(diags?.filter((d) => d.severity !== 2)).toMatchInlineSnapshot(`
+      [
+        {
+          "message": "Warning - View Type view was not loaded into Validator definitions",
+          "range": {
+            "end": {
+              "character": 5,
+              "line": 6,
+            },
+            "start": {
+              "character": 4,
+              "line": 3,
+            },
+          },
+          "severity": 1,
+        },
+        {
+          "message": "Warning - View Type view was not loaded into Validator definitions",
+          "range": {
+            "end": {
+              "character": 5,
+              "line": 10,
+            },
+            "start": {
+              "character": 4,
+              "line": 7,
+            },
+          },
+          "severity": 1,
+        },
+      ]
+    `);
+  });
+});

package/src/plugins/__tests__/view-node-plugin.test.ts

@@ -0,0 +1,154 @@
+import { test, expect, describe, beforeEach } from "vitest";
+import { Position } from "vscode-languageserver-types";
+import {
+  ReferenceAssetsWebPluginManifest,
+  Types,
+} from "@player-lang/static-xlrs";
+import { PlayerLanguageService } from "../..";
+import { toTextDocument } from "../../utils";
+
+describe("duplicate-id-plugin", () => {
+  let service: PlayerLanguageService;
+
+  beforeEach(async () => {
+    service = new PlayerLanguageService();
+    await service.setAssetTypesFromModule([
+      Types,
+      ReferenceAssetsWebPluginManifest,
+    ]);
+  });
+
+  test("validates view ids", async () => {
+    const textDocument = toTextDocument(
+      JSON.stringify({
+        id: "test",
+        views: [
+          {
+            id: "yes",
+            type: "view",
+          },
+          {
+            // Should warn
+            id: "no",
+            type: "view",
+          },
+        ],
+        navigation: {
+          BEGIN: "FLOW_1",
+          FLOW_1: {
+            startState: "VIEW_1",
+            VIEW_1: {
+              state_type: "VIEW",
+              ref: "yes",
+              transitions: {},
+            },
+            VIEW_2: {
+              state_type: "VIEW",
+              // Should error
+              ref: "nope",
+              transitions: {},
+            },
+          },
+        },
+      }),
+    );
+
+    const validations = await service.validateTextDocument(textDocument);
+    expect(validations).toHaveLength(4);
+    expect(validations?.map((v) => v.message)).toMatchInlineSnapshot(`
+      [
+        "Warning - View Type view was not loaded into Validator definitions",
+        "View is not reachable",
+        "Warning - View Type view was not loaded into Validator definitions",
+        "View with id: nope does not exist.",
+      ]
+    `);
+  });
+
+  test("completes view ids in view obj", async () => {
+    const textDocument = toTextDocument(
+      JSON.stringify(
+        {
+          views: [
+            {
+              id: "",
+              type: "view",
+            },
+          ],
+          navigation: {
+            BEGIN: "FLOW_1",
+            FLOW_1: {
+              startState: "VIEW_1",
+              VIEW_1: {
+                state_type: "VIEW",
+                ref: "view-1",
+                transitions: {},
+              },
+              VIEW_2: {
+                state_type: "VIEW",
+                ref: "other-view",
+                transitions: {},
+              },
+            },
+          },
+        },
+        null,
+        2,
+      ),
+    );
+
+    const completions = await service.getCompletionsAtPosition(
+      textDocument,
+      Position.create(3, 13),
+    );
+
+    expect(completions.items?.map((i) => i.label)).toContain("view-1");
+    expect(completions.items?.map((i) => i.label)).toContain("other-view");
+    expect(completions.items?.map((i) => i.label)).toMatchInlineSnapshot(`
+      [
+        "view-1",
+        "other-view",
+      ]
+    `);
+  });
+
+  test("completes view ids in view nodes", async () => {
+    const textDocument = toTextDocument(
+      JSON.stringify(
+        {
+          views: [
+            {
+              id: "view-1",
+              type: "view",
+            },
+          ],
+          navigation: {
+            BEGIN: "FLOW_1",
+            FLOW_1: {
+              startState: "VIEW_1",
+              VIEW_1: {
+                state_type: "VIEW",
+                ref: "",
+                transitions: {},
+              },
+            },
+          },
+        },
+        null,
+        2,
+      ),
+    );
+
+    const completions = await service.getCompletionsAtPosition(
+      textDocument,
+      Position.create(13, 15),
+    );
+
+    expect(completions.items?.map((i) => i.label)).toContain("view-1");
+    expect(completions.items?.map((i) => i.label)).toMatchInlineSnapshot(`
+      [
+        "view-1",
+      ]
+    `);
+  });
+});