vscode-apollo 1.19.2 → 1.20.0

package/src/language-server/__tests__/diagnostics.test.ts

@@ -0,0 +1,86 @@
+import { Source, buildClientSchema } from "graphql";
+import { GraphQLDocument } from "../document";
+import { collectExecutableDefinitionDiagnositics } from "../diagnostics";
+import { starwarsSchema } from "./fixtures/starwarsSchema";
+
+const schema = buildClientSchema(starwarsSchema);
+
+const validDocument = new GraphQLDocument(
+  new Source(`
+    query HeroAndFriendsNames {
+      hero {
+        name
+        friends {
+          name
+        }
+      }
+    }`)
+);
+const invalidDocument = new GraphQLDocument(
+  new Source(`
+    query HeroAndFriendsNames {
+      hero {
+        nam         # Missing letter 'e'
+        friend {    # Missing letter 's'
+          name
+        }
+      }
+    }`)
+);
+const documentWithTypes = new GraphQLDocument(
+  new Source(`
+    type SomeType {
+      thing: String
+    }
+     enum SomeEnum {
+      THING_ONE
+      THING_TWO
+    }
+     query HeroAndFriendsNames {
+      hero {
+        name
+        friends {
+          name
+        }
+      }
+    }`)
+);
+const documentWithOffset = new GraphQLDocument(
+  new Source(`query QueryWithOffset { hero { nam } }`, "testDocument", {
+    line: 5,
+    column: 10,
+  })
+);
+describe("Language server diagnostics", () => {
+  describe("#collectExecutableDefinitionDiagnositics", () => {
+    it("returns no diagnostics for a correct document", () => {
+      const diagnostics = collectExecutableDefinitionDiagnositics(
+        schema,
+        validDocument
+      );
+      expect(diagnostics.length).toEqual(0);
+    });
+    it("returns two diagnostics for a document with two errors", () => {
+      const diagnostics = collectExecutableDefinitionDiagnositics(
+        schema,
+        invalidDocument
+      );
+      expect(diagnostics.length).toEqual(2);
+    });
+    it("returns no diagnostics for a document that includes type definitions", () => {
+      const diagnostics = collectExecutableDefinitionDiagnositics(
+        schema,
+        documentWithTypes
+      );
+      expect(diagnostics.length).toEqual(0);
+    });
+    it("correctly offsets locations", () => {
+      const diagnostics = collectExecutableDefinitionDiagnositics(
+        schema,
+        documentWithOffset
+      );
+      expect(diagnostics.length).toEqual(1);
+      expect(diagnostics[0].range.start.character).toEqual(40);
+    });
+  });
+});

package/src/language-server/__tests__/document.test.ts

@@ -0,0 +1,187 @@
+import { extractGraphQLDocuments } from "../document";
+import { TextDocument, Position } from "vscode-languageserver";
+
+describe("extractGraphQLDocuments", () => {
+  describe("extracting documents from JavaScript template literals", () => {
+    const mockTextDocument = (text: string): TextDocument => ({
+      getText: jest.fn().mockReturnValue(text),
+      offsetAt(): number {
+        return 0;
+      },
+      positionAt(): Position {
+        return {
+          character: 0,
+          line: 0,
+        };
+      },
+      languageId: "javascript",
+      lineCount: 0,
+      uri: "",
+      version: 1,
+    });
+
+    it("works with placeholders that span multiple rows", () => {
+      const textDocument = mockTextDocument(`
+      gql\`
+        {
+          hero {
+            ...Hero_character
+          }
+        }
+
+        \${Hero.fragments
+          .character}
+      \`
+    `);
+      const documents = extractGraphQLDocuments(textDocument);
+
+      expect(documents?.length).toEqual(1);
+      expect(documents?.[0].syntaxErrors.length).toBe(0);
+      expect(documents?.[0].ast?.definitions.length).toBe(1);
+    });
+
+    it("works with multiple placeholders in a document", () => {
+      const textDocument = mockTextDocument(`
+      gql\`
+        {
+          hero {
+            ...Hero_character
+          }
+        }
+
+        \${Hero.fragments.character}
+
+        {
+          reviews(episode: NEWHOPE) {
+            ...ReviewList_reviews
+          }
+        }
+
+        \${ReviewList.fragments.reviews}
+      \`
+    `);
+      const documents = extractGraphQLDocuments(textDocument);
+
+      expect(documents?.length).toEqual(1);
+      expect(documents?.[0].syntaxErrors.length).toBe(0);
+      expect(documents?.[0].ast?.definitions.length).toBe(2);
+    });
+
+    it("works with a custom tagname", () => {
+      const textDocument = mockTextDocument(`
+      gqltag\`
+        {
+          hero {
+            ...Hero_character
+          }
+        }
+
+        \${Hero.fragments.character}
+
+        {
+          reviews(episode: NEWHOPE) {
+            ...ReviewList_reviews
+          }
+        }
+
+        \${ReviewList.fragments.reviews}
+      \`
+    `);
+      const documents = extractGraphQLDocuments(textDocument, "gqltag");
+
+      expect(documents?.length).toEqual(1);
+      expect(documents?.[0].syntaxErrors.length).toBe(0);
+      expect(documents?.[0].ast?.definitions.length).toBe(2);
+    });
+
+    it("works with parens", () => {
+      const textDocument = mockTextDocument(`
+      gql(\`
+        {
+          hero {
+            ...Hero_character
+          }
+        }
+
+        \${Hero.fragments.character}
+
+        {
+          reviews(episode: NEWHOPE) {
+            ...ReviewList_reviews
+          }
+        }
+
+      \${ReviewList.fragments.reviews}
+    \`)
+    `);
+      const documents = extractGraphQLDocuments(textDocument);
+
+      expect(documents?.length).toEqual(1);
+      expect(documents?.[0].syntaxErrors.length).toBe(0);
+      expect(documents?.[0].ast?.definitions.length).toBe(2);
+    });
+  });
+
+  describe("extracting documents from ReasonML extension nodes", () => {
+    const mockTextDocument = (text: string): TextDocument => ({
+      getText: jest.fn().mockReturnValue(text),
+      offsetAt(): number {
+        return 0;
+      },
+      positionAt(): Position {
+        return {
+          character: 0,
+          line: 0,
+        };
+      },
+      languageId: "reason",
+      lineCount: 0,
+      uri: "",
+      version: 1,
+    });
+
+    it("works with ReasonRelay nodes", () => {
+      const textDocument = mockTextDocument(`
+      module Query = [%relay.query
+      {|
+        query SomeQuery {
+          id
+        }
+      |}
+      ];
+
+      module Fragment = [%relay.fragment
+      {|
+        fragment X on Hero {
+          id
+        }
+      |}
+      ];
+    `);
+      const documents = extractGraphQLDocuments(textDocument);
+
+      expect(documents?.length).toEqual(2);
+      expect(documents?.[0].syntaxErrors.length).toBe(0);
+      expect(documents?.[1].syntaxErrors.length).toBe(0);
+      expect(documents?.[0].ast?.definitions.length).toBe(1);
+      expect(documents?.[1].ast?.definitions.length).toBe(1);
+    });
+
+    it("works with graphql_ppx style node", () => {
+      const textDocument = mockTextDocument(`
+      module Query = [%graphql
+      {|
+        query SomeQuery {
+          id
+        }
+      |}
+      ];
+    `);
+      const documents = extractGraphQLDocuments(textDocument);
+
+      expect(documents?.length).toEqual(1);
+      expect(documents?.[0].syntaxErrors.length).toBe(0);
+      expect(documents?.[0].ast?.definitions.length).toBe(1);
+    });
+  });
+});

package/src/language-server/__tests__/fileSet.test.ts

@@ -0,0 +1,46 @@
+import { FileSet } from "../fileSet";
+import URI from "vscode-uri";
+
+describe("fileSet", () => {
+  describe("includesFile", () => {
+    it("matches includes starting with ./", () => {
+      const fileSet = new FileSet({
+        excludes: [],
+        includes: ["./src/**/*.tsx"],
+        rootURI: URI.parse("/project"),
+      });
+      const file = "file:///project/src/Component.tsx";
+      expect(fileSet.includesFile(file)).toBe(true);
+    });
+
+    it("matches includes not starting with ./", () => {
+      const fileSet = new FileSet({
+        excludes: [],
+        includes: ["src/**/*.tsx"],
+        rootURI: URI.parse("/project"),
+      });
+      const file = "file:///project/src/Component.tsx";
+      expect(fileSet.includesFile(file)).toBe(true);
+    });
+
+    it("does not match excludes starting with ./", () => {
+      const fileSet = new FileSet({
+        excludes: ["./src/Component.tsx"],
+        includes: ["./src/**/*.tsx"],
+        rootURI: URI.parse("/project"),
+      });
+      const file = "file:///project/src/Component.tsx";
+      expect(fileSet.includesFile(file)).toBe(false);
+    });
+
+    it("does not match excludes not starting with ./", () => {
+      const fileSet = new FileSet({
+        excludes: ["src/Component.tsx"],
+        includes: ["src/**/*.tsx"],
+        rootURI: URI.parse("/project"),
+      });
+      const file = "file:///project/src/Component.tsx";
+      expect(fileSet.includesFile(file)).toBe(false);
+    });
+  });
+});