vscode-apollo 2.3.4 → 2.3.6

package/.github/workflows/E2E.yml

@@ -8,6 +8,9 @@ jobs:
   test:
     name: Run E2E tests
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: ["1.90.0", "stable", "insiders"]
     steps:
       - run: sudo apt update && sudo apt install -y libasound2 libgbm1 libgtk-3-0 libnss3 xvfb expect
       - uses: actions/checkout@v4
@@ -25,3 +28,5 @@ jobs:
           expect eof
           EOF
       - run: xvfb-run -a npm run test:extension
+        env:
+          VSCODE_VERSION: "${{ matrix.version }}"

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 2.3.6
+
+### Patch Changes
+
+- [#216](https://github.com/apollographql/vscode-graphql/pull/216) [`1add31e0`](https://github.com/apollographql/vscode-graphql/commit/1add31e0e9bc2da92ea7c3a1c65206cc5d95bb68) Thanks [@phryneas](https://github.com/phryneas)! - Add JSON schema for `supergraph.yaml`.
+
+## 2.3.5
+
+### Patch Changes
+
+- [#226](https://github.com/apollographql/vscode-graphql/pull/226) [`57c51c81`](https://github.com/apollographql/vscode-graphql/commit/57c51c81ec56d68c2226f0b169ed849fcbdaad55) Thanks [@yesmeck](https://github.com/yesmeck)! - Fixes config files being unable to load in old VSCode versions
+
 ## 2.3.4
 
 ### Patch 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.3.4",
+  "version": "2.3.6",
   "referenceID": "87197759-7617-40d0-b32e-46d378e907c7",
   "author": "Apollo GraphQL <opensource@apollographql.com>",
   "license": "MIT",
@@ -258,6 +258,10 @@
       {
         "fileMatch": "apollo.config.yaml",
         "url": "./schemas/apollo.config.schema.json"
+      },
+      {
+        "fileMatch": "supergraph.yaml",
+        "url": "./schemas/supergraph_config_schema.json"
       }
     ],
     "commands": [

package/schemas/supergraph_config_schema.json

@@ -0,0 +1,119 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "SupergraphConfig",
+  "description": "The configuration for a single supergraph composed of multiple subgraphs.",
+  "type": "object",
+  "required": [
+    "subgraphs"
+  ],
+  "properties": {
+    "federation_version": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/FederationVersion"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "subgraphs": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/definitions/SubgraphConfig"
+      }
+    }
+  },
+  "definitions": {
+    "FederationVersion": {
+      "pattern": "^(1|2|=2\\.\\d+\\.\\d+.*)$"
+    },
+    "SchemaSource": {
+      "description": "Options for getting SDL: the graph registry, a file, or an introspection URL.\n\nNOTE: Introspection strips all comments and directives from the SDL.",
+      "anyOf": [
+        {
+          "type": "object",
+          "required": [
+            "file"
+          ],
+          "properties": {
+            "file": {
+              "type": "string"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "subgraph_url"
+          ],
+          "properties": {
+            "introspection_headers": {
+              "type": [
+                "object",
+                "null"
+              ],
+              "additionalProperties": {
+                "type": "string"
+              }
+            },
+            "subgraph_url": {
+              "type": "string",
+              "format": "uri"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "graphref",
+            "subgraph"
+          ],
+          "properties": {
+            "graphref": {
+              "type": "string"
+            },
+            "subgraph": {
+              "type": "string"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "sdl"
+          ],
+          "properties": {
+            "sdl": {
+              "type": "string"
+            }
+          }
+        }
+      ]
+    },
+    "SubgraphConfig": {
+      "description": "Config for a single [subgraph](https://www.apollographql.com/docs/federation/subgraphs/)",
+      "type": "object",
+      "required": [
+        "schema"
+      ],
+      "properties": {
+        "routing_url": {
+          "description": "The routing URL for the subgraph. This will appear in supergraph SDL and instructs the graph router to send all requests for this subgraph to this URL.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "schema": {
+          "description": "The location of the subgraph's SDL",
+          "allOf": [
+            {
+              "$ref": "#/definitions/SchemaSource"
+            }
+          ]
+        }
+      }
+    }
+  }
+}

package/src/__e2e__/runTests.js

@@ -28,6 +28,7 @@ async function main() {
     const exitCode = await runTests({
       extensionDevelopmentPath,
       extensionTestsPath,
+      version: process.env.VSCODE_VERSION || "stable",
       launchArgs: [
         "--disable-extensions",
         `${extensionDevelopmentPath}/sampleWorkspace/sampleWorkspace.code-workspace`,

package/src/language-server/config/cache-busting-resolver.js

@@ -1,7 +1,62 @@
 // @ts-check
 const { pathToFileURL } = require("node:url");
 
-/** @import { ResolveContext, ResolutionResult, LoadResult, ImportContext } from "./cache-busting-resolver.types" */
+/** @import { ResolveContext, ResolutionResult, LoadResult, ImportContext, ImportAttributes, ImportAssertions, LegacyResolveContext, LegacyImportContext, Format } from "./cache-busting-resolver.types" */
+
+/**
+ * importAssertions was renamed to importAttributes after following versions of Node.js.
+ * Once we hit a minimum of v1.92 of VSCode, we can remove the legacy check and
+ * use `importAttributes` directly.
+ *
+ * - v21.0.0
+ * - v20.10.0
+ * - v18.19.0
+ *
+ * @see https://github.com/apollographql/vscode-graphql/issues/225
+ * @see https://nodejs.org/docs/latest/api/module.html#resolvespecifier-context-nextresolve
+ *
+ * @param {ResolveContext|ImportContext|LegacyResolveContext|LegacyImportContext} context
+ * @returns {context is ResolveContext|ImportContext}
+ */
+function isImportAttributesAvailable(context) {
+  return "importAttributes" in context;
+}
+
+/**
+ * @param {ResolveContext|ImportContext} context
+ * @returns {"importAttributes"|"importAssertions"}
+ */
+function resolveImportAttributesKeyName(context) {
+  if (isImportAttributesAvailable(context)) {
+    return "importAttributes";
+  }
+  return "importAssertions";
+}
+
+/**
+ * @param {ResolveContext|ImportContext|LegacyResolveContext|LegacyImportContext} context
+ * @returns {ImportAttributes|ImportAssertions}
+ */
+function resolveImportAttributes(context) {
+  if (isImportAttributesAvailable(context)) {
+    return context.importAttributes;
+  }
+  return context.importAssertions;
+}
+
+/**
+ * @param {ImportAttributes|ImportAssertions} importAttributes
+ * @returns {Format|null}
+ */
+function resolveConfigFormat(importAttributes) {
+  const [as, format] = importAttributes.as
+    ? importAttributes.as.split(":")
+    : [];
+  if (as === "cachebust" && format) {
+    return /** @type {Format} */ (format);
+  }
+  return null;
+}
 
 /**
  * @param {string} specifier
@@ -21,14 +76,16 @@ function bustFileName(specifier) {
  * @returns {Promise<ResolutionResult>}
  */
 async function resolve(specifier, context, nextResolve) {
-  if (context.importAttributes.as !== "cachebust") {
+  const importAttributes = resolveImportAttributes(context);
+  const format = resolveConfigFormat(importAttributes);
+  if (!format) {
     return nextResolve(specifier, context);
   }
   // no need to resolve at all, we have all necessary information
   return {
     url: bustFileName(specifier),
-    format: context.importAttributes.format,
-    importAttributes: context.importAttributes,
+    format,
+    [resolveImportAttributesKeyName(context)]: importAttributes,
     shortCircuit: true,
   };
 }
@@ -41,13 +98,19 @@ async function resolve(specifier, context, nextResolve) {
  * @returns {Promise<LoadResult>}
  */
 async function load(url, context, nextLoad) {
-  if (context.importAttributes.as !== "cachebust") {
+  const importAttributes = resolveImportAttributes(context);
+  const format = resolveConfigFormat(importAttributes);
+  if (!format) {
     return nextLoad(url, context);
   }
+  const contents =
+    "contents" in importAttributes
+      ? importAttributes.contents
+      : Object.keys(importAttributes).find((key) => key != "as");
   return {
-    format: context.format || "module",
+    format,
     shortCircuit: true,
-    source: context.importAttributes.contents,
+    source: /** @type {string} */ (contents),
   };
 }
 

package/src/language-server/config/cache-busting-resolver.types.ts

@@ -2,13 +2,20 @@ import { pathToFileURL } from "node:url";
 
 export type ImportAttributes =
   | {
-      as: "cachebust";
+      as: `cachebust:${Format}`;
       contents: string;
       format: Format;
     }
   | { as?: undefined };
 
-type Format =
+export type ImportAssertions =
+  | {
+      as: `cachebust:${Format}`;
+      [key: string]: string;
+    }
+  | { as?: undefined };
+
+export type Format =
   | "builtin"
   | "commonjs"
   | "json"
@@ -17,12 +24,23 @@ type Format =
   | null
   | undefined;
 
+export interface LegacyResolveContext {
+  conditions: string[];
+  importAssertions: ImportAssertions;
+  parentURL?: string;
+}
+
 export interface ResolveContext {
   conditions: string[];
   importAttributes: ImportAttributes;
   parentURL?: string;
 }
 
+export interface LegacyImportContext {
+  conditions: string[];
+  importAssertions: ImportAssertions;
+  format: Format;
+}
 export interface ImportContext {
   conditions: string[];
   importAttributes: ImportAttributes;

package/src/language-server/config/loadTsConfig.ts

@@ -3,16 +3,19 @@ import { dirname, extname } from "node:path";
 import typescript from "typescript";
 import { pathToFileURL } from "node:url";
 import { register } from "node:module";
-import { ImportAttributes } from "./cache-busting-resolver.types";
+import {
+  ImportAssertions,
+  ImportAttributes,
+} from "./cache-busting-resolver.types";
 // implementation based on https://github.com/cosmiconfig/cosmiconfig/blob/a5a842547c13392ebb89a485b9e56d9f37e3cbd3/src/loaders.ts
 // Copyright (c) 2015 David Clark licensed MIT. Full license can be found here:
 // https://github.com/cosmiconfig/cosmiconfig/blob/a5a842547c13392ebb89a485b9e56d9f37e3cbd3/LICENSE
 
-if (process.env.JEST_WORKER_ID === undefined) {
+try {
   register(
     pathToFileURL(require.resolve("./config/cache-busting-resolver.js")),
   );
-} else {
+} catch {
   register(pathToFileURL(require.resolve("./cache-busting-resolver.js")));
 }
 
@@ -114,10 +117,15 @@ async function loadCachebustedJs(
       // @ts-ignore
       {
         with: {
-          as: "cachebust",
+          as: `cachebust:${type}`,
           contents,
           format: type,
         } satisfies ImportAttributes,
+        assert: {
+          as: `cachebust:${type}`,
+          contents,
+          format: type,
+        } satisfies ImportAssertions,
       }
     )
   ).default;