vscode-apollo 2.0.0 → 2.1.0

package/.circleci/config.yml

@@ -6,7 +6,7 @@ orbs:
 executors:
   node:
     docker:
-      - image: cimg/node:22.5.1
+      - image: cimg/node:22.7.0
     working_directory: ~/vscode-graphql
 
 commands:

package/.vscode/launch.json

@@ -14,7 +14,10 @@
         "${workspaceFolder}/sampleWorkspace/sampleWorkspace.code-workspace"
       ],
       "sourceMaps": true,
-      "env": { "APOLLO_ENGINE_ENDPOINT": "http://localhost:7096/apollo" },
+      "env": {
+        "APOLLO_ENGINE_ENDPOINT": "http://localhost:7096/apollo",
+        "APOLLO_FEATURE_FLAGS": "rover"
+      },
       "outFiles": ["${workspaceRoot}/lib/**/*.js"]
     },
     {

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # CHANGELOG
 
+## 2.1.0
+
+### Minor Changes
+
+- [#179](https://github.com/apollographql/vscode-graphql/pull/179) [`b4687eb`](https://github.com/apollographql/vscode-graphql/commit/b4687eb52458c7fd80f447c8060922e23ef77590) Thanks [@phryneas](https://github.com/phryneas)! - Improve detection of GraphQL inside of JavaScript/TypeScript files.
+  Add support for `/** GraphQL */` annotations before a template string.
+
+### Patch Changes
+
+- [#173](https://github.com/apollographql/vscode-graphql/pull/173) [`415ff4a1`](https://github.com/apollographql/vscode-graphql/commit/415ff4a1bb85adba6fc2da190510c8a4ba3a74d1) Thanks [@phryneas](https://github.com/phryneas)! - Fix a bug where when rapidly changing multiple files some of the changes might have gotten lost.
+
+- [#176](https://github.com/apollographql/vscode-graphql/pull/176) [`cbc1c638`](https://github.com/apollographql/vscode-graphql/commit/cbc1c6384a1275bfc9fddbb0ff2bdfddaa6464f9) Thanks [@phryneas](https://github.com/phryneas)! - Fixed a bug where annotations might have mapped to the wrong position on the first line of an embedded document.
+
+- [#173](https://github.com/apollographql/vscode-graphql/pull/173) [`415ff4a1`](https://github.com/apollographql/vscode-graphql/commit/415ff4a1bb85adba6fc2da190510c8a4ba3a74d1) Thanks [@phryneas](https://github.com/phryneas)! - Fixed a bug where hints on the 0-th line of an embedded GraphQL document were offset incorrectly.
+
+  E.g. in
+
+  ```js
+  const veryLongVariableName = gql`
+    type Foo {
+      baaaaaar: String
+    }
+  `;
+  ```
+
+  the hover on `String` would only appear when hovering characters left of it.
+
+## 2.0.1
+
+### Patch Changes
+
+- [#171](https://github.com/apollographql/vscode-graphql/pull/171) [`37a2b292`](https://github.com/apollographql/vscode-graphql/commit/37a2b292c0de22ee76645fc2dcde03b8f4843051) Thanks [@phryneas](https://github.com/phryneas)! - Also try parsing `.ts` files as CommonJS, not only ESM.
+
 ## 2.0.0
 
 ### Major Changes

package/package.json

@@ -2,7 +2,7 @@
   "name": "vscode-apollo",
   "displayName": "Apollo GraphQL",
   "description": "Rich editor support for GraphQL client and server development that seamlessly integrates with the Apollo platform",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "referenceID": "87197759-7617-40d0-b32e-46d378e907c7",
   "author": "Apollo GraphQL <opensource@apollographql.com>",
   "license": "MIT",
@@ -29,6 +29,7 @@
     "format": "prettier --write .",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest",
     "test:extension": "node src/__e2e__/runTests.js",
+    "test:textmate": "npx vscode-tmgrammar-snap -s source.ts -g src/language-server/__tests__/fixtures/TypeScript.tmLanguage.json src/language-server/__tests__/fixtures/documents/*.ts",
     "codegen": "graphql-codegen",
     "vscode:prepublish": "npm run build:production"
   },
@@ -38,17 +39,19 @@
   "dependencies": {
     "@apollo/client": "3.11.4",
     "@apollo/subgraph": "2.8.4",
-    "@graphql-tools/schema": "10.0.4",
+    "@graphql-tools/schema": "10.0.5",
     "@wry/context": "0.7.4",
     "@wry/equality": "0.5.7",
     "cosmiconfig": "9.0.0",
     "dotenv": "16.4.5",
+    "fractional-indexing": "2.1.0",
     "glob": "11.0.0",
     "graphql": "16.9.0",
     "graphql-language-service": "5.2.2",
     "graphql-tag": "2.12.6",
     "lodash.debounce": "4.0.8",
     "lodash.merge": "4.6.2",
+    "lodash.throttle": "4.1.1",
     "lz-string": "1.5.0",
     "minimatch": "10.0.1",
     "moment": "2.30.1",
@@ -56,6 +59,7 @@
     "vscode-languageserver": "9.0.1",
     "vscode-languageserver-textdocument": "1.0.12",
     "vscode-uri": "3.0.8",
+    "which": "4.0.0",
     "zod": "3.23.8",
     "zod-validation-error": "3.3.1"
   },
@@ -67,6 +71,7 @@
     "@types/jest": "29.5.12",
     "@types/lodash.debounce": "4.0.9",
     "@types/lodash.merge": "4.6.9",
+    "@types/lodash.throttle": "^4.1.9",
     "@types/node": "20.14.10",
     "@types/vscode": "1.90.0",
     "@typescript-eslint/eslint-plugin": "6.9.1",
@@ -87,7 +92,8 @@
     "rimraf": "6.0.1",
     "ts-jest": "29.1.2",
     "ts-node": "^10.9.2",
-    "typescript": "^5.5.3"
+    "typescript": "^5.5.3",
+    "vscode-tmgrammar-test": "^0.1.3"
   },
   "publisher": "apollographql",
   "categories": [

package/renovate.json

@@ -25,6 +25,7 @@
     "@types/vscode",
     "@typescript-eslint/eslint-plugin",
     "@typescript-eslint/parser",
-    "eslint"
+    "eslint",
+    "fractional-indexing"
   ]
 }

package/sampleWorkspace/localSchema/src/test.js

@@ -6,3 +6,6 @@ gql`
     }
   }
 `;
+
+// prettier-ignore
+const verylonglala = gql`type Foo { baaaaaar: String }`

package/sampleWorkspace/rover/apollo.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  rover: {},
+};

package/sampleWorkspace/rover/src/test.graphql

@@ -0,0 +1,14 @@
+"""
+The query type, represents all of the entry points into our object graph
+"""
+type Query {
+  me: User!
+}
+
+"""
+Test
+"""
+type User {
+  id: ID!
+  name: String!
+}

package/sampleWorkspace/rover/src/test.js

@@ -0,0 +1,30 @@
+import gql from "graphql-tag";
+
+sdfsdfs;
+gql`
+  """
+  The query type, represents all of the entry points into our object graph
+  """
+  type Query {
+    me: User!
+  }
+
+  """
+  Test
+  """
+  type User {
+    id: ID!
+    name: String!
+  }
+`;
+
+console.log("foobar!");
+
+gql`
+  type User {
+    lastName: String!
+  }
+`;
+
+// prettier-ignore
+const verylonglala = gql`type Foo { baaaaaar: String }`

package/sampleWorkspace/sampleWorkspace.code-workspace

@@ -1,20 +1,26 @@
 {
-	"folders": [
-		{
-			"path": "localSchema"
-		},
-		{
-			"path": "clientSchema"
-		},
-		{
-			"path": "spotifyGraph"
-		},
-		{
-			"path": "httpSchema"
-		},
-		{
-			"path": "localSchemaArray"
-		}
-	],
-	"settings": {}
-}
+  "folders": [
+    {
+      "path": "localSchema"
+    },
+    {
+      "path": "clientSchema"
+    },
+    {
+      "path": "spotifyGraph"
+    },
+    {
+      "path": "httpSchema"
+    },
+    {
+      "path": "localSchemaArray"
+    },
+    {
+      "path": "rover"
+    },
+    {
+      "path": "../src/language-server/__tests__/fixtures/documents"
+    }
+  ],
+  "settings": {}
+}

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

@@ -1,5 +1,8 @@
-import { extractGraphQLDocuments } from "../document";
+import { readFileSync } from "fs";
+import { extractGraphQLDocuments, GraphQLDocument } from "../document";
 import { TextDocument, Position } from "vscode-languageserver";
+import { join } from "path";
+import { DocumentNode, OperationDefinitionNode } from "graphql";
 
 describe("extractGraphQLDocuments", () => {
   describe("extracting documents from JavaScript template literals", () => {
@@ -38,6 +41,18 @@ describe("extractGraphQLDocuments", () => {
       expect(documents?.length).toEqual(1);
       expect(documents?.[0].syntaxErrors.length).toBe(0);
       expect(documents?.[0].ast?.definitions.length).toBe(1);
+      expect(replaceWhitespaceWithDots(documents![0].source.body))
+        .toMatchInlineSnapshot(`
+"
+········{
+··········hero·{
+············...Hero_character
+··········}
+········}
+
+·············································
+······"
+`);
     });
 
     it("works with multiple placeholders in a document", () => {
@@ -65,6 +80,26 @@ describe("extractGraphQLDocuments", () => {
       expect(documents?.length).toEqual(1);
       expect(documents?.[0].syntaxErrors.length).toBe(0);
       expect(documents?.[0].ast?.definitions.length).toBe(2);
+      expect(replaceWhitespaceWithDots(documents![0].source.body))
+        .toMatchInlineSnapshot(`
+"
+········{
+··········hero·{
+············...Hero_character
+··········}
+········}
+
+··································
+
+········{
+··········reviews(episode:·NEWHOPE)·{
+············...ReviewList_reviews
+··········}
+········}
+
+······································
+······"
+`);
     });
 
     it("works with a custom tagname", () => {
@@ -90,8 +125,28 @@ describe("extractGraphQLDocuments", () => {
       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);
+      expect(documents![0].syntaxErrors.length).toBe(0);
+      expect(documents![0].ast?.definitions.length).toBe(2);
+      expect(replaceWhitespaceWithDots(documents![0].source.body))
+        .toMatchInlineSnapshot(`
+"
+········{
+··········hero·{
+············...Hero_character
+··········}
+········}
+
+··································
+
+········{
+··········reviews(episode:·NEWHOPE)·{
+············...ReviewList_reviews
+··········}
+········}
+
+······································
+······"
+`);
     });
 
     it("works with parens", () => {
@@ -119,6 +174,101 @@ describe("extractGraphQLDocuments", () => {
       expect(documents?.length).toEqual(1);
       expect(documents?.[0].syntaxErrors.length).toBe(0);
       expect(documents?.[0].ast?.definitions.length).toBe(2);
+      expect(replaceWhitespaceWithDots(documents![0].source.body))
+        .toMatchInlineSnapshot(`
+"
+········{
+··········hero·{
+············...Hero_character
+··········}
+········}
+
+··································
+
+········{
+··········reviews(episode:·NEWHOPE)·{
+············...ReviewList_reviews
+··········}
+········}
+
+····································
+····"
+`);
+    });
+
+    test("fixtures", () => {
+      function loadFixture(name: string) {
+        const path = join(__dirname, "fixtures", "documents", name);
+        const body = readFileSync(path, "utf8");
+
+        return extractGraphQLDocuments(
+          TextDocument.create(`file://${path}.js`, "javascript", 1, body),
+        )!;
+      }
+      function documentName(document: GraphQLDocument) {
+        expect(document.syntaxErrors.length).toBe(0);
+        let first = document.ast?.definitions[0];
+        expect(first).toBeDefined();
+        expect(first!.kind).toBe("OperationDefinition");
+        first = first as OperationDefinitionNode;
+        return (first.name && first.name.value) || "Unnamed";
+      }
+
+      expect(loadFixture("commentWithTemplate.ts").map(documentName))
+        .toMatchInlineSnapshot(`
+Array [
+  "Q1",
+  "Q2",
+  "Q3",
+  "Q4",
+  "Q6",
+  "Q8",
+  "Q9",
+  "Q10",
+]
+`);
+      expect(loadFixture("functionCall.ts").map(documentName))
+        .toMatchInlineSnapshot(`
+Array [
+  "Q2",
+  "Q3",
+  "Q4",
+  "Q5",
+  "Q6",
+  "Q7",
+  "Q9",
+  "Q10",
+  "Q11",
+]
+`);
+      expect(loadFixture("taggedTemplate.ts").map(documentName))
+        .toMatchInlineSnapshot(`
+Array [
+  "Foo",
+  "Q1",
+  "Q2",
+  "Q3",
+  "Q4",
+  "Q5",
+  "Q6",
+  "Q7",
+  "Q8",
+  "Q9",
+  "Q10",
+  "Q11",
+]
+`);
+      expect(loadFixture("templateWithComment.ts").map(documentName))
+        .toMatchInlineSnapshot(`
+Array [
+  "Q1",
+  "Q2",
+  "Q3",
+  "Q4",
+  "Q5",
+  "Q6",
+]
+`);
     });
   });
 
@@ -185,3 +335,11 @@ describe("extractGraphQLDocuments", () => {
     });
   });
 });
+
+/**
+ * When editing this file manually, prettier will remove long bouts of whitespace in template strings on save,
+ * which messes up inline snapshots. This function replaces spaces with dots to prevent that.
+ */
+function replaceWhitespaceWithDots(str: string) {
+  return str.replace(/[ ]/g, "·");
+}