vscode-apollo 2.2.1 → 2.3.1

package/src/build.js

@@ -1,11 +1,19 @@
 const esbuild = require("esbuild");
+const { zodToJsonSchema } = require("zod-to-json-schema");
+const { writeFileSync } = require("fs");
+const importFresh = require("import-fresh");
 
 const production = process.argv.includes("--production");
 const watch = process.argv.includes("--watch");
 
 async function main() {
   const ctx = await esbuild.context({
-    entryPoints: ["src/extension.ts", "src/language-server/server.ts"],
+    entryPoints: [
+      "src/extension.ts",
+      "src/language-server/server.ts",
+      "src/language-server/config/config.ts",
+      "src/language-server/config/cache-busting-resolver.js",
+    ],
     bundle: true,
     format: "cjs",
     minify: production,
@@ -19,6 +27,8 @@ async function main() {
     plugins: [
       /* add to the end of plugins array */
       esbuildProblemMatcherPlugin,
+      buildJsonSchemaPlugin,
+      resolvePlugin,
     ],
   });
   if (watch) {
@@ -51,6 +61,48 @@ const esbuildProblemMatcherPlugin = {
   },
 };
 
+const buildJsonSchemaPlugin = {
+  name: "build-json-schema",
+  setup(build) {
+    build.onEnd(() => {
+      const {
+        configSchema,
+        clientConfig,
+        // roverConfig,
+        engineConfig,
+        baseConfig,
+        // @ts-ignore
+      } = importFresh("../lib/language-server/config/config.js");
+
+      const jsonSchema = zodToJsonSchema(configSchema, {
+        errorMessages: true,
+        definitions: {
+          clientConfig,
+          //roverConfig,
+          engineConfig,
+          baseConfig,
+        },
+      });
+      writeFileSync(
+        "./schemas/apollo.config.schema.json",
+        JSON.stringify(jsonSchema, null, 2),
+      );
+    });
+  },
+};
+
+const resolvePlugin = {
+  name: "resolve",
+  setup(build) {
+    build.onResolve(
+      { filter: /^jsonc-parser$/ },
+      async ({ path, ...options }) => {
+        return build.resolve("jsonc-parser/lib/esm/main.js", options);
+      },
+    );
+  },
+};
+
 main().catch((e) => {
   console.error(e);
   process.exit(1);

package/src/language-server/__e2e__/clientSchema.e2e.ts

@@ -1,24 +1,45 @@
 import { TextEditor } from "vscode";
-import { closeAllEditors, openEditor, testCompletion, getHover } from "./utils";
+import {
+  closeAllEditors,
+  openEditor,
+  getCompletionItems,
+  getHover,
+  getPositionForEditor,
+  GetPositionFn,
+} from "./utils";
 
 let editor: TextEditor;
+let getPosition: GetPositionFn;
 beforeAll(async () => {
   closeAllEditors();
   editor = await openEditor("clientSchema/src/test.js");
+  getPosition = getPositionForEditor(editor);
 });
 
 test("completion", async () => {
-  // dro|id
-  await testCompletion(editor, [4, 7], [["droid", "Droid"]]);
-  // na|me
-  await testCompletion(editor, [5, 8], [["name", "String!"]]);
-  // mo|del
-  await testCompletion(editor, [6, 8], [["model", "String"]]);
+  expect(
+    (await getCompletionItems(editor, getPosition("dro|id")))[0],
+  ).toStrictEqual({
+    label: "droid",
+    detail: "Droid",
+  });
+  expect(
+    (await getCompletionItems(editor, getPosition("na|me")))[0],
+  ).toStrictEqual({
+    label: "name",
+    detail: "String!",
+  });
+  expect(
+    (await getCompletionItems(editor, getPosition("mo|del")))[0],
+  ).toStrictEqual({
+    label: "model",
+    detail: "String",
+  });
 });
 
 test("hover", async () => {
-  // featu|reFlagDefer
-  expect(await getHover(editor, [3, 10])).toMatchInlineSnapshot(`
+  expect(await getHover(editor, getPosition("featu|reFlagDefer")))
+    .toMatchInlineSnapshot(`
 "\`\`\`graphql
 Query.featureFlagDefer: Boolean!
 \`\`\`
@@ -32,8 +53,8 @@ Query.featureFlagDefer: Boolean!
 Whether to use defer"
 `);
 
-  // @c|lient(always: false)
-  expect(await getHover(editor, [3, 24])).toMatchInlineSnapshot(`
+  expect(await getHover(editor, getPosition("@c|lient(always: false)")))
+    .toMatchInlineSnapshot(`
 "\`\`\`graphql
 @client(always: Boolean)
 \`\`\`
@@ -43,8 +64,8 @@ Whether to use defer"
 Direct the client to resolve this field locally, either from the cache or local resolvers."
 `);
 
-  // @client(alwa|ys: false)
-  expect(await getHover(editor, [3, 33])).toMatchInlineSnapshot(`
+  expect(await getHover(editor, getPosition("@client(alwa|ys: false)")))
+    .toMatchInlineSnapshot(`
 "\`\`\`graphql
 always: Boolean
 \`\`\`
@@ -55,8 +76,8 @@ When true, the client will never use the cache for this value. See
 https://www.apollographql.com/docs/react/local-state/local-resolvers/#forcing-resolvers-with-clientalways-true"
 `);
 
-  // @expo|rt(as: "defer")
-  expect(await getHover(editor, [3, 49])).toMatchInlineSnapshot(`
+  expect(await getHover(editor, getPosition('@expo|rt(as: "defer")')))
+    .toMatchInlineSnapshot(`
 "\`\`\`graphql
 @export(as: String!)
 \`\`\`
@@ -66,7 +87,9 @@ https://www.apollographql.com/docs/react/local-state/local-resolvers/#forcing-re
 Export this locally resolved field as a variable to be used in the remainder of this query. See
 https://www.apollographql.com/docs/react/local-state/local-resolvers/#using-client-fields-as-variables"
 `);
-  expect(await getHover(editor, [3, 53])).toMatchInlineSnapshot(`
+
+  expect(await getHover(editor, getPosition('@export(a|s: "defer")')))
+    .toMatchInlineSnapshot(`
 "\`\`\`graphql
 as: String!
 \`\`\`
@@ -76,8 +99,8 @@ as: String!
 The variable name to export this field as."
 `);
 
-  // @nonre|active
-  expect(await getHover(editor, [7, 28])).toMatchInlineSnapshot(`
+  expect(await getHover(editor, getPosition("@nonre|active")))
+    .toMatchInlineSnapshot(`
 "\`\`\`graphql
 @nonreactive
 \`\`\`
@@ -89,8 +112,9 @@ This allows parent components to fetch data to be rendered by their children wit
 https://www.apollographql.com/docs/react/data/directives#nonreactive"
 `);
 
-  // @def|er(if: $defer, label: "fc")
-  expect(await getHover(editor, [8, 14])).toMatchInlineSnapshot(`
+  expect(
+    await getHover(editor, getPosition('@def|er(if: $defer, label: "fc")')),
+  ).toMatchInlineSnapshot(`
 "\`\`\`graphql
 @defer(if: Boolean, label: String)
 \`\`\`
@@ -101,8 +125,10 @@ This directive enables your queries to receive data for specific fields incremen
 This is helpful whenever some fields in a query take much longer to resolve than others.
 https://www.apollographql.com/docs/react/data/directives#defer"
 `);
-  //@defer(i|f: $defer, label: "fc")
-  expect(await getHover(editor, [8, 18])).toMatchInlineSnapshot(`
+
+  expect(
+    await getHover(editor, getPosition('@defer(i|f: $defer, label: "fc")')),
+  ).toMatchInlineSnapshot(`
 "\`\`\`graphql
 if: Boolean
 \`\`\`
@@ -111,8 +137,10 @@ if: Boolean
 
 When true fragment may be deferred, if omitted defaults to true."
 `);
-  //@defer(if: $defer, labe|l: "fc")
-  expect(await getHover(editor, [8, 33])).toMatchInlineSnapshot(`
+
+  expect(
+    await getHover(editor, getPosition('@defer(if: $defer, labe|l: "fc")')),
+  ).toMatchInlineSnapshot(`
 "\`\`\`graphql
 label: String
 \`\`\`
@@ -123,8 +151,9 @@ A unique label across all @defer and @stream directives in an operation.
 This label should be used by GraphQL clients to identify the data from patch responses and associate it with the correct fragment.
 If provided, the GraphQL Server must add it to the payload."
 `);
-  // @connec|tion(key: "feed")
-  expect(await getHover(editor, [9, 53])).toMatchInlineSnapshot(`
+
+  expect(await getHover(editor, getPosition('@connec|tion(key: "feed")')))
+    .toMatchInlineSnapshot(`
 "\`\`\`graphql
 @connection(key: String!, filter: [String!])
 \`\`\`
@@ -134,8 +163,9 @@ If provided, the GraphQL Server must add it to the payload."
 Specify a custom store key for this result. See
 https://www.apollographql.com/docs/react/caching/advanced-topics/#the-connection-directive"
 `);
-  // @connection(ke|y: "feed")
-  expect(await getHover(editor, [9, 61])).toMatchInlineSnapshot(`
+
+  expect(await getHover(editor, getPosition('@connection(ke|y: "feed")')))
+    .toMatchInlineSnapshot(`
 "\`\`\`graphql
 key: String!
 \`\`\`

package/src/language-server/__e2e__/httpSchema.e2e.ts

@@ -1,19 +1,38 @@
 import { TextEditor } from "vscode";
-import { closeAllEditors, openEditor, testCompletion, getHover } from "./utils";
+import {
+  closeAllEditors,
+  openEditor,
+  getCompletionItems,
+  getHover,
+  getPositionForEditor,
+  GetPositionFn,
+} from "./utils";
 
 let editor: TextEditor;
+let getPosition: GetPositionFn;
 beforeAll(async () => {
   closeAllEditors();
   editor = await openEditor("httpSchema/src/test.js");
+  getPosition = getPositionForEditor(editor);
 });
 
 test("completion", async () => {
-  await testCompletion(editor, [3, 7], [["books", "[Book]"]]);
-  await testCompletion(editor, [5, 9], [["author", "String"]]);
+  expect(
+    (await getCompletionItems(editor, getPosition("bo|oks")))[0],
+  ).toStrictEqual({
+    label: "books",
+    detail: "[Book]",
+  });
+  expect(
+    (await getCompletionItems(editor, getPosition("au|thor")))[0],
+  ).toStrictEqual({
+    label: "author",
+    detail: "String",
+  });
 });
 
 test("hover", async () => {
-  expect(await getHover(editor, [5, 9])).toMatchInlineSnapshot(`
+  expect(await getHover(editor, getPosition("au|thor"))).toMatchInlineSnapshot(`
 "\`\`\`graphql
 Book.author: String
 \`\`\`"

package/src/language-server/__e2e__/localSchema.e2e.ts

@@ -1,19 +1,38 @@
 import { TextEditor } from "vscode";
-import { closeAllEditors, openEditor, testCompletion, getHover } from "./utils";
+import {
+  closeAllEditors,
+  openEditor,
+  getCompletionItems,
+  getHover,
+  GetPositionFn,
+  getPositionForEditor,
+} from "./utils";
 
 let editor: TextEditor;
+let getPosition: GetPositionFn;
 beforeAll(async () => {
   closeAllEditors();
   editor = await openEditor("localSchema/src/test.js");
+  getPosition = getPositionForEditor(editor);
 });
 
 test("completion", async () => {
-  await testCompletion(editor, [3, 7], [["droid", "Droid"]]);
-  await testCompletion(editor, [4, 8], [["name", "String!"]]);
+  expect(
+    (await getCompletionItems(editor, getPosition("dro|id")))[0],
+  ).toStrictEqual({
+    label: "droid",
+    detail: "Droid",
+  });
+  expect(
+    (await getCompletionItems(editor, getPosition("na|me")))[0],
+  ).toStrictEqual({
+    label: "name",
+    detail: "String!",
+  });
 });
 
 test("hover", async () => {
-  expect(await getHover(editor, [4, 8])).toMatchInlineSnapshot(`
+  expect(await getHover(editor, getPosition("na|me"))).toMatchInlineSnapshot(`
 "\`\`\`graphql
 Droid.name: String!
 \`\`\`

package/src/language-server/__e2e__/localSchemaArray.e2e.ts

@@ -1,20 +1,45 @@
 import { TextEditor } from "vscode";
-import { closeAllEditors, openEditor, testCompletion, getHover } from "./utils";
+import {
+  closeAllEditors,
+  openEditor,
+  getCompletionItems,
+  getHover,
+  GetPositionFn,
+  getPositionForEditor,
+} from "./utils";
 
 let editor: TextEditor;
+let getPosition: GetPositionFn;
 beforeAll(async () => {
   closeAllEditors();
   editor = await openEditor("localSchemaArray/src/test.js");
+  getPosition = getPositionForEditor(editor);
 });
 
 test("completion", async () => {
-  await testCompletion(editor, [3, 7], [["droid", "Droid"]]);
-  await testCompletion(editor, [4, 8], [["name", "String!"]]);
-  await testCompletion(editor, [6, 7], [["planets", "[Planet]"]]);
+  expect(
+    (await getCompletionItems(editor, getPosition("dro|id")))[0],
+  ).toStrictEqual({
+    label: "droid",
+    detail: "Droid",
+  });
+  expect(
+    (await getCompletionItems(editor, getPosition("d|Name: name")))[0],
+  ).toStrictEqual({
+    label: "name",
+    detail: "String!",
+  });
+  expect(
+    (await getCompletionItems(editor, getPosition("pl|anet")))[0],
+  ).toStrictEqual({
+    label: "planets",
+    detail: "[Planet]",
+  });
 });
 
 test("hover", async () => {
-  expect(await getHover(editor, [4, 8])).toMatchInlineSnapshot(`
+  expect(await getHover(editor, getPosition("d|Name: name")))
+    .toMatchInlineSnapshot(`
 "\`\`\`graphql
 Droid.name: String!
 \`\`\`
@@ -23,7 +48,7 @@ Droid.name: String!
 
 What others call this droid"
 `);
-  expect(await getHover(editor, [6, 7])).toMatchInlineSnapshot(`
+  expect(await getHover(editor, getPosition("pl|anet"))).toMatchInlineSnapshot(`
 "\`\`\`graphql
 Query.planets: [Planet]
 \`\`\`"

package/src/language-server/__e2e__/rover.e2e.ts

@@ -0,0 +1,150 @@
+import { test as origTest } from "@jest/globals";
+import { load } from "js-yaml";
+import { readFileSync } from "node:fs";
+import { execFileSync } from "node:child_process";
+import { join } from "node:path";
+import { ParsedApolloConfigFormat } from "../config";
+import { TextEditor } from "vscode";
+import {
+  closeAllEditors,
+  openEditor,
+  getCompletionItems,
+  getHover,
+  getPositionForEditor,
+  GetPositionFn,
+  getFullSemanticTokens,
+  getDefinitions,
+} from "./utils";
+
+// we want to skip these tests unless the user running them has a rover config profile named "VSCode-E2E"
+let test = origTest.skip;
+try {
+  const roverProjectDir = join(__dirname, "../../../sampleWorkspace/rover");
+  const config = load(
+    readFileSync(join(roverProjectDir, "apollo.config.yaml"), "utf-8"),
+  ) as ParsedApolloConfigFormat;
+  const roverBin = join(roverProjectDir, config.rover!.bin);
+  const result = execFileSync(roverBin, [
+    "config",
+    "list",
+    "--format=json",
+  ]).toString("utf8");
+  const parsed = JSON.parse(result);
+  if (parsed.data.profiles.includes("VSCode-E2E")) {
+    test = origTest;
+  }
+} catch (e) {}
+if (test === origTest.skip) {
+  console.info(
+    "Skipping rover E2E tests: no profile with the name 'VSCode-E2E'\n" +
+      "You can create one by running `rover config auth --profile VSCode-E2E`",
+  );
+}
+
+let editor: TextEditor;
+let getPosition: GetPositionFn;
+beforeAll(async () => {
+  closeAllEditors();
+  editor = await openEditor("rover/src/test.graphql");
+  getPosition = getPositionForEditor(editor);
+});
+
+test("hover", async () => {
+  expect(await getHover(editor, getPosition("@over|ride(from")))
+    .toMatchInlineSnapshot(`
+"The [\`@override\`](https://www.apollographql.com/docs/federation/federated-schemas/federated-directives/#override) directive indicates that an object field is now resolved by this subgraph instead of another subgraph where it's also defined. This enables you to migrate a field from one subgraph to another.
+
+You can apply \`@override\` to entity fields and fields of the root operation types (such as \`Query\` and \`Mutation\`). A second \`label\` argument can be used to progressively override a field. See [the docs](https://www.apollographql.com/docs/federation/entities/migrate-fields/#incremental-migration-with-progressive-override) for more information.
+***
+\`\`\`graphql
+directive @override(from: String!, label: String) on FIELD_DEFINITION
+\`\`\`"
+`);
+});
+
+test("completion", async () => {
+  expect(await getCompletionItems(editor, getPosition("@over|ride(from")))
+    .toMatchInlineSnapshot(`
+[
+  {
+    "detail": undefined,
+    "label": "@deprecated",
+  },
+  {
+    "detail": undefined,
+    "label": "@external",
+  },
+  {
+    "detail": undefined,
+    "label": "@federation__authenticated",
+  },
+  {
+    "detail": undefined,
+    "label": "@federation__inaccessible",
+  },
+  {
+    "detail": undefined,
+    "label": "@federation__policy(…)",
+  },
+  {
+    "detail": undefined,
+    "label": "@federation__provides(…)",
+  },
+  {
+    "detail": undefined,
+    "label": "@federation__requiresScopes(…)",
+  },
+  {
+    "detail": undefined,
+    "label": "@federation__tag(…)",
+  },
+  {
+    "detail": undefined,
+    "label": "@override(…)",
+  },
+  {
+    "detail": undefined,
+    "label": "@requires(…)",
+  },
+  {
+    "detail": undefined,
+    "label": "@shareable",
+  },
+]
+`);
+});
+
+test("semantic tokens", async () => {
+  const tokens = await getFullSemanticTokens(editor);
+  expect(tokens[0]).toStrictEqual({
+    startPosition: getPosition('fields: "|a"'),
+    endPosition: getPosition('fields: "a|"'),
+    tokenType: "property",
+    tokenModifiers: [],
+  });
+  expect(tokens[1]).toStrictEqual({
+    startPosition: getPosition('fields: "|c"'),
+    endPosition: getPosition('fields: "c|"'),
+    tokenType: "property",
+    tokenModifiers: [],
+  });
+});
+
+test("definitions", async () => {
+  const definitions = await getDefinitions(editor, getPosition("a: |A"));
+
+  expect(definitions[0].targetUri.toString()).toBe(
+    editor.document.uri.toString(),
+  );
+  expect(
+    editor.document.getText(definitions[0].targetSelectionRange!),
+  ).toMatchInlineSnapshot(`"A"`);
+  expect(editor.document.getText(definitions[0].targetRange))
+    .toMatchInlineSnapshot(`
+"type A @key(fields: "a") {
+  a: ID @override(from: "DNE")
+  b: String! @requires(fields: "c") @shareable
+  c: String! @external
+}"
+`);
+});

package/src/language-server/__e2e__/studioGraph.e2e.ts

@@ -2,15 +2,14 @@ import { TextEditor } from "vscode";
 import {
   closeAllEditors,
   openEditor,
-  testCompletion,
+  getCompletionItems,
   getHover,
   getExtension,
   getOutputChannelDocument,
   reloadService,
+  getPositionForEditor,
 } from "./utils";
 import mocks from "../../__e2e__/mocks.js";
-import vscode from "vscode";
-import { scheduler } from "node:timers/promises";
 
 const mockPort = Number(process.env.MOCK_SERVER_PORT);
 beforeAll(async () => {
@@ -19,13 +18,26 @@ beforeAll(async () => {
 
 test("completion", async () => {
   const editor = await openEditor("spotifyGraph/src/test.js");
-  await testCompletion(editor, [4, 9], [["profile", "CurrentUserProfile!"]]);
-  await testCompletion(editor, [6, 15], [["displayName", "String"]]);
+  const getPosition = getPositionForEditor(editor);
+  expect(
+    (await getCompletionItems(editor, getPosition("pr|ofile")))[0],
+  ).toStrictEqual({
+    label: "profile",
+    detail: "CurrentUserProfile!",
+  });
+  expect(
+    (await getCompletionItems(editor, getPosition("dis|playName")))[0],
+  ).toStrictEqual({
+    label: "displayName",
+    detail: "String",
+  });
 });
 
 test("hover", async () => {
   const editor = await openEditor("spotifyGraph/src/test.js");
-  expect(await getHover(editor, [4, 9])).toMatchInlineSnapshot(`
+  const getPosition = getPositionForEditor(editor);
+  expect(await getHover(editor, getPosition("pr|ofile")))
+    .toMatchInlineSnapshot(`
 "\`\`\`graphql
 CurrentUser.profile: CurrentUserProfile!
 \`\`\`