@player-tools/complexity-check-plugin 0.8.1--canary.169.3663

package/package.json

@@ -0,0 +1,35 @@
+{
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "src",
+    "types"
+  ],
+  "name": "@player-tools/complexity-check-plugin",
+  "version": "0.8.1--canary.169.3663",
+  "main": "dist/cjs/index.cjs",
+  "dependencies": {
+    "@player-tools/json-language-service": "0.8.1--canary.169.3663",
+    "@player-ui/player": "0.7.3",
+    "jsonc-parser": "^2.3.1",
+    "typescript-template-language-service-decorator": "^2.3.1",
+    "vscode-languageserver-types": "^3.15.1",
+    "typescript": "5.5.4",
+    "tslib": "^2.6.2"
+  },
+  "devDependencies": {
+    "@player-tools/static-xlrs": "workspace:*"
+  },
+  "module": "dist/index.legacy-esm.js",
+  "types": "types/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    "./dist/index.css": "./dist/index.css",
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/cjs/index.cjs"
+    }
+  },
+  "peerDependencies": {}
+}

package/src/__tests__/complexity-check-plugin.test.ts

@@ -0,0 +1,470 @@
+import { test, expect, describe, beforeEach } from "vitest";
+import {
+  ReferenceAssetsWebPluginManifest,
+  Types,
+} from "@player-tools/static-xlrs";
+import {
+  PlayerLanguageService,
+  toTextDocument,
+} from "@player-tools/json-language-service";
+
+import { ComplexityCheck } from "../complexity-check";
+
+describe("complexity plugin", () => {
+  let service: PlayerLanguageService;
+
+  beforeEach(async () => {
+    service = new PlayerLanguageService();
+    service.addLSPPlugin(
+      new ComplexityCheck({
+        maxAcceptableComplexity: 0,
+        options: { verbose: true },
+      })
+    );
+    await service.setAssetTypesFromModule([
+      Types,
+      ReferenceAssetsWebPluginManifest,
+    ]);
+  });
+
+  test("Measures complexity for single view", async () => {
+    const textDocument = toTextDocument(
+      JSON.stringify({
+        id: "test",
+        views: [
+          {
+            id: "yes",
+            type: "info",
+            title: {
+              asset: {
+                id: "info-title",
+                type: "text",
+                value: "{{some.text}}",
+              },
+            },
+            subTitle: {
+              asset: {
+                id: "info-subTitle",
+                type: "text",
+                value: "@[somethingSubtitle]@",
+              },
+            },
+          },
+        ],
+        navigation: {
+          BEGIN: "FLOW_1",
+          FLOW_1: {
+            startState: "ACTION_1",
+            ACTION_1: {
+              state_type: "ACTION",
+              exp: ["something"],
+              transitions: {
+                "*": "VIEW_1",
+              },
+            },
+            VIEW_1: {
+              state_type: "VIEW",
+              ref: "yes",
+              transitions: {
+                "*": "ACTION_2",
+              },
+            },
+            ACTION_2: {
+              state_type: "ACTION",
+              exp: ["{{somethingElse}} = 1", "something else"],
+              transitions: {
+                "*": "VIEW_1",
+              },
+            },
+          },
+        },
+      })
+    );
+
+    const validations = await service.validateTextDocument(textDocument);
+    expect(validations).toHaveLength(1);
+    /**
+     * Score break down
+     * 1 x for each view node (1 total) = 1
+     * 1 x from exps in ACTION states (3 total) = 3
+     * 1 x for each asset node (2 total) = 2
+     * 2 x for each expression (`2 total) = 4
+     * 2 x for each data evaluated (1 total) = 2
+     */
+    expect(validations?.map((v) => v.message)).toMatchInlineSnapshot(`
+      [
+        "Error: Content complexity is 12",
+      ]
+    `);
+  });
+
+  test("Measures complexity for evaluating nested bindings", async () => {
+    const textDocument = toTextDocument(
+      JSON.stringify({
+        id: "test",
+        views: [
+          {
+            id: "yes",
+            type: "info",
+            title: {
+              asset: {
+                id: "info-title",
+                type: "text",
+                value: "{{some.infoText}}",
+              },
+            },
+            subTitle: {
+              asset: {
+                id: "info-subTitle",
+                type: "text",
+                value: "@[something]@",
+              },
+            },
+            body: {
+              asset: {
+                id: "info-body",
+                type: "text",
+                value:
+                  "@[conditional({{bar}} == true, {{foo}} = 1, {{foo}} = 2)]@",
+              },
+            },
+          },
+        ],
+        navigation: {
+          BEGIN: "FLOW_1",
+          FLOW_1: {
+            startState: "ACTION_1",
+            ACTION_1: {
+              state_type: "ACTION",
+              exp: ["something"],
+              transitions: {
+                "*": "VIEW_1",
+              },
+            },
+            VIEW_1: {
+              onStart: [
+                "setDataVal('returns.IRS1040.Return.ReturnData.PPPerson.TaxpayerFilerInfoPP.FieldAttributes.PresidentialElectionCampaignIndPP.Covered', true)",
+                "dob = {{returns.IRS1040.Return.ReturnData.PPPerson.TaxpayerFilerInfoPP.DateOfBirthPP}}",
+                "dob_year = concat(dob[6], dob[7], dob[8], dob[9])",
+                "{{local.taxpayer.age}} = {{returns.IRS1040.Return.ReturnHeader.TaxYr}} - dob_year",
+                "conditional(dob == (concat('01/01/', year_18)), {{local.taxpayer.age}} = 18)",
+              ],
+              state_type: "VIEW",
+              ref: "yes",
+              transitions: {
+                "*": "ACTION_2",
+              },
+            },
+            ACTION_2: {
+              state_type: "ACTION",
+              exp: ["{{something}} = 1", "something else"],
+              transitions: {
+                "*": "VIEW_2",
+              },
+            },
+            VIEW_2: {
+              state_type: "VIEW",
+              ref: "yes",
+              transitions: {
+                "*": "ACTION_3",
+              },
+            },
+            ACTION_3: {
+              state_type: "ACTION",
+              exp: ["{{something}} = 1", "something else"],
+              transitions: {
+                "*": "VIEW_1",
+              },
+            },
+          },
+        },
+      })
+    );
+
+    const validations = await service.validateTextDocument(textDocument);
+    expect(validations).toHaveLength(1);
+    /**
+     * Score break down
+     * 1 x for each view node (1 total) = 1
+     * 1 x from exps in ACTION states (5 total) = 5
+     * 1 x for each asset node (3 total) = 3
+     * 2 x for each expression (2 total) = 4
+     * 2 x for each data evaluated (10 total) = 20
+     */
+    expect(validations?.map((v) => v.message)).toMatchInlineSnapshot(`
+      [
+        "Error: Content complexity is 33",
+      ]
+    `);
+  });
+
+  test("Measures complexity for templates", async () => {
+    const textDocument = toTextDocument(
+      JSON.stringify({
+        id: "test",
+        views: [
+          {
+            id: "yes",
+            type: "info",
+            title: {
+              asset: {
+                id: "info-title",
+                type: "text",
+                value: "{{some.text}}",
+              },
+            },
+            template: [
+              {
+                data: "foo.pets",
+                output: "values",
+                value: {
+                  asset: {
+                    type: "collection",
+                    id: "outer-collection-_index_",
+                    template: [
+                      {
+                        data: "foo.people",
+                        output: "values",
+                        value: {
+                          asset: {
+                            id: "info-title-2",
+                            type: "text",
+                            value: "{{foo.people._index_}}",
+                          },
+                        },
+                      },
+                    ],
+                  },
+                },
+              },
+            ],
+            data: {
+              foo: [1, 2],
+            },
+          },
+        ],
+        navigation: {
+          BEGIN: "FLOW_1",
+          FLOW_1: {
+            startState: "ACTION_1",
+            ACTION_1: {
+              state_type: "ACTION",
+              exp: ["something"],
+              transitions: {
+                "*": "VIEW_1",
+              },
+            },
+            VIEW_1: {
+              state_type: "VIEW",
+              ref: "yes",
+              transitions: {
+                "*": "ACTION_2",
+              },
+            },
+            ACTION_2: {
+              state_type: "ACTION",
+              exp: ["{{somethingElse}} = 1", "something else"],
+              transitions: {
+                "*": "VIEW_1",
+              },
+            },
+          },
+        },
+      })
+    );
+
+    const validations = await service.validateTextDocument(textDocument);
+    expect(validations).toHaveLength(1);
+    /**
+     * Score break down
+     * 1 x for each view node (1 total) = 1
+     * 1 x from exps in ACTION states (3 total) = 3
+     * 1 x for each asset node (1 total) = 1
+     * 2 x for template asset (1 total) = 2
+     * 3 x for nested template asset (1 total) = 3
+     * 2 x for each expression (2 total) = 4
+     * 2 x for each data evaluated (1 total) = 2
+     */
+    expect(validations?.map((v) => v.message)).toMatchInlineSnapshot(`
+      [
+        "Error: Content complexity is 16",
+      ]
+    `);
+  });
+
+  test("Measures asset complexity", async () => {
+    let customService: PlayerLanguageService = new PlayerLanguageService();
+
+    customService = new PlayerLanguageService();
+    customService.addLSPPlugin(
+      new ComplexityCheck({
+        maxAcceptableComplexity: 0,
+        assetComplexity: { text: 1, info: 2, table: 5 },
+        options: { verbose: true },
+      })
+    );
+    await customService.setAssetTypesFromModule([
+      Types,
+      ReferenceAssetsWebPluginManifest,
+    ]);
+
+    const textDocument = toTextDocument(
+      JSON.stringify({
+        id: "test",
+        views: [
+          {
+            id: "yes",
+            type: "info",
+            title: {
+              asset: {
+                id: "info-title",
+                type: "text",
+                value: "{{some.infoText}}",
+              },
+            },
+            subTitle: {
+              asset: {
+                id: "info-subTitle",
+                type: "text",
+                value: "@[something]@",
+              },
+            },
+          },
+        ],
+        navigation: {
+          BEGIN: "FLOW_1",
+          FLOW_1: {
+            startState: "ACTION_1",
+            ACTION_1: {
+              state_type: "ACTION",
+              exp: ["something"],
+              transitions: {
+                "*": "VIEW_1",
+              },
+            },
+            VIEW_1: {
+              state_type: "VIEW",
+              ref: "yes",
+              transitions: {
+                "*": "ACTION_2",
+              },
+            },
+            ACTION_2: {
+              state_type: "ACTION",
+              exp: ["{{somethingElse}} = 1", "something else"],
+              transitions: {
+                "*": "VIEW_1",
+              },
+            },
+          },
+        },
+      })
+    );
+
+    const validations = await customService.validateTextDocument(textDocument);
+    expect(validations).toHaveLength(1);
+    /**
+     * Score break down
+     * 1 x for each view node (1 total) = 1
+     * 2 x for each view type = info (1 total) = 2
+     * 1 x from exps in ACTION states (3 total) = 3
+     * 1 x for each asset node (2 total) = 2
+     * 1 x for each asset type = text (2 total) = 2
+     * 2 x for each expression (2 total) = 4
+     * 2 x for each data evaluated (1 total) = 2
+     */
+    expect(validations?.map((v) => v.message)).toMatchInlineSnapshot(`
+      [
+        "Error: Content complexity is 16",
+      ]
+    `);
+  });
+
+  test("Outputs warning message correctly", async () => {
+    let customService: PlayerLanguageService = new PlayerLanguageService();
+
+    customService = new PlayerLanguageService();
+    customService.addLSPPlugin(
+      new ComplexityCheck({
+        maxAcceptableComplexity: 15,
+        maxWarningLevel: 10,
+        options: { verbose: true },
+      })
+    );
+    await customService.setAssetTypesFromModule([
+      Types,
+      ReferenceAssetsWebPluginManifest,
+    ]);
+
+    const textDocument = toTextDocument(
+      JSON.stringify({
+        id: "test",
+        views: [
+          {
+            id: "yes",
+            type: "info",
+            title: {
+              asset: {
+                id: "info-title",
+                type: "text",
+                value: "{{some.infoText}}",
+              },
+            },
+            subTitle: {
+              asset: {
+                id: "info-subTitle",
+                type: "text",
+                value: "@[something]@",
+              },
+            },
+          },
+        ],
+        navigation: {
+          BEGIN: "FLOW_1",
+          FLOW_1: {
+            startState: "ACTION_1",
+            ACTION_1: {
+              state_type: "ACTION",
+              exp: ["something"],
+              transitions: {
+                "*": "VIEW_1",
+              },
+            },
+            VIEW_1: {
+              state_type: "VIEW",
+              ref: "yes",
+              transitions: {
+                "*": "ACTION_2",
+              },
+            },
+            ACTION_2: {
+              state_type: "ACTION",
+              exp: ["{{somethingElse}} = 1", "something else"],
+              transitions: {
+                "*": "VIEW_1",
+              },
+            },
+          },
+        },
+      })
+    );
+
+    const validations = await customService.validateTextDocument(textDocument);
+    expect(validations).toHaveLength(1);
+    /**
+     * Score break down
+     * 1 x for each view node (1 total) = 1
+     * 2 x for each view type = info (1 total) = 2
+     * 1 x from exps in ACTION states (3 total) = 3
+     * 1 x for each asset node (2 total) = 2
+     * 1 x for each asset type = text (2 total) = 2
+     * 2 x for each expression (2 total) = 4
+     * 2 x for each data evaluated (1 total) = 2
+     */
+    expect(validations?.map((v) => v.message)).toMatchInlineSnapshot(`
+      [
+        "Warning: Content complexity is 12",
+      ]
+    `);
+  });
+});