vscode-apollo 2.5.6 → 2.6.0

package/.circleci/config.yml

@@ -8,6 +8,10 @@ executors:
     docker:
       - image: cimg/node:22.12.0
     working_directory: ~/vscode-graphql
+  node24:
+    docker:
+      - image: cimg/node:24.4.0
+    working_directory: ~/vscode-graphql
 
 commands:
   npm-install:
@@ -53,12 +57,25 @@ jobs:
           name: Test
           command: npm run test --  --runInBand
 
+  textmate:
+    executor: node24
+    steps:
+      - checkout
+      - npm-install
+      - run:
+          name: Build TextMate Grammar
+          command: npm run build:textmate
+      - run:
+          name: Test TextMate Grammar
+          command: npm run test:textmate
+
 workflows:
   build-test-deploy:
     jobs:
       - lint
       - typescript
       - test
+      - textmate
   security-scans:
     jobs:
       - secops/gitleaks:

package/.github/workflows/E2E.yml

@@ -5,7 +5,7 @@ on:
     branches:
       - main
 jobs:
-  test:
+  e2e:
     name: Run E2E tests
     runs-on: "${{ matrix.os }}"
     strategy:
@@ -22,7 +22,8 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           cache: "npm"
-      - run: npm install
+          node-version: 24
+      - run: npm ci
       - run: echo 'APOLLO_KEY="service:bob-123:489fhseo4"' > ./sampleWorkspace/spotifyGraph/.env
         shell: bash
 

package/.github/workflows/build-prs.yml

@@ -10,7 +10,8 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           cache: "npm"
-      - run: npm install
+          node-version: 24
+      - run: npm ci
       - run: echo PKG_VERSION="$(git show --no-patch --format=0.0.0-build-%ct.pr-${{ github.event.pull_request.number }}.commit-%h)" >> $GITHUB_ENV
       - run: npm pkg set "version=${{ env.PKG_VERSION }}"
       - run: npx -y @vscode/vsce package --out vscode-apollo-${{ env.PKG_VERSION }}.vsix

package/.prettierignore

@@ -1,3 +1,6 @@
 src/language-server/graphqlTypes.ts
 src/language-server/__tests__/fixtures/documents/commentWithTemplate.ts
+schemas/*.json
+syntaxes/*.json
+src/__tests__/fixtures/textmate/*
 README.md

package/.semgrepignore

@@ -0,0 +1,2 @@
+sampleWorkspace/connectors-community/**
+syntaxes/build.ts

package/.vscode/settings.json

@@ -2,7 +2,9 @@
 {
   "editor.tabSize": 2,
   "editor.insertSpaces": true,
-  "editor.rulers": [110],
+  "editor.rulers": [
+    110
+  ],
   "editor.wordWrapColumn": 110,
   "files.trimTrailingWhitespace": true,
   "files.insertFinalNewline": true,
@@ -12,5 +14,8 @@
     "node_modules": false
   },
   "typescript.tsdk": "node_modules/typescript/lib",
-  "debug.node.autoAttach": "on"
+  "debug.node.autoAttach": "on",
+  "yaml.schemas": {
+    "https://raw.githubusercontent.com/martinring/tmlanguage/master/tmlanguage.json": "/syntaxes/*.yaml"
+  }
 }

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 2.6.0
+
+### Minor Changes
+
+- [#230](https://github.com/apollographql/vscode-graphql/pull/230) [`8626acc`](https://github.com/apollographql/vscode-graphql/commit/8626accc9cdca451a3ecc23a3351d6f138337275) Thanks [@phryneas](https://github.com/phryneas)! - Add syntax highlighting for the Apollo Connectors Mapping language
+
 ## 2.5.6
 
 ### Patch Changes

package/apollo.connectors.mapping.configuration.json

@@ -0,0 +1,10 @@
+{
+  "comments": {
+    "lineComment": "#"
+  },
+  "brackets": [
+    ["[", "]"],
+    ["{", "}"],
+    ["(", ")"]
+  ]
+}

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.5.6",
+  "version": "2.6.0",
   "referenceID": "87197759-7617-40d0-b32e-46d378e907c7",
   "author": "Apollo GraphQL <opensource@apollographql.com>",
   "license": "MIT",
@@ -16,11 +16,13 @@
   "types": "lib/index.d.ts",
   "scripts": {
     "build": "node ./src/build.js",
-    "build:full": "npm run typecheck && rimraf lib  && npm run build --",
+    "build:full": "npm run typecheck && rimraf lib  && npm run build -- && npm run build:textmate",
     "build:production": "npm run build:full -- --production",
+    "build:textmate": "node ./syntaxes/build.ts",
     "watch": "rimraf lib; npm-run-all -p watch:*",
     "watch:esbuild": "npm run build -- --watch",
     "watch:tsc": "npm run typecheck -- --watch",
+    "watch:textmate-yaml": "npm run build:textmate -- --debug --watch",
     "sampleWorkspace:run": "node src/__e2e__/mockServer.js",
     "changeset-version": "changeset version && npm i",
     "changeset-publish": "npm run build -- --production && changeset publish",
@@ -29,7 +31,11 @@
     "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",
+    "test:textmate": "npm run test:textmate-ts && npm run test:textmate-connectors-mapping && npm run test:textmate-graphql-connectors-mapping",
+    "test:textmate-ts": "npx vscode-tmgrammar-snap -s source.ts -g src/language-server/__tests__/fixtures/TypeScript.tmLanguage.json src/language-server/__tests__/fixtures/documents/*.ts",
+    "test:textmate-connectors-mapping": "npm run build:textmate -- --snapshot connectors.mapping.yaml; npx vscode-tmgrammar-test src/__tests__/fixtures/textmate/*.connectors.mapping",
+    "test:textmate-graphql-connectors-mapping": "npm run build:textmate -- --snapshot connectors.mapping.yaml; npx vscode-tmgrammar-test src/__tests__/fixtures/textmate/*.graphql",
+    "update-connectors-community": "git subtree pull --prefix sampleWorkspace/connectors-community https://github.com/apollographql/connectors-community.git main --squash",
     "codegen": "graphql-codegen",
     "vscode:prepublish": "npm run build:production"
   },
@@ -93,6 +99,7 @@
     "jest-environment-node": "29.7.0",
     "memfs": "4.15.0",
     "npm-run-all": "4.1.5",
+    "oniguruma-parser": "^0.12.1",
     "prettier": "3.4.2",
     "rimraf": "6.0.1",
     "ts-jest": "29.2.5",
@@ -172,6 +179,16 @@
         ],
         "configuration": "./graphql.configuration.json"
       },
+      {
+        "id": "apollo.connectors.mapping",
+        "aliases": [
+          "[Apollo Connectors Mapping Syntax]"
+        ],
+        "filenames": [
+          "test.apollo.connectors.mapping"
+        ],
+        "configuration": "./apollo.connectors.mapping.configuration.json"
+      },
       {
         "id": "jsonc",
         "filenames": [
@@ -185,6 +202,23 @@
         "scopeName": "source.graphql",
         "path": "./syntaxes/graphql.json"
       },
+      {
+        "language": "apollo.connectors.mapping",
+        "scopeName": "source.apollo.connectors.mapping",
+        "path": "./syntaxes/connectors.mapping.json"
+      },
+      {
+        "injectTo": [
+          "source.graphql"
+        ],
+        "scopeName": "source.apollo.connectors.graphql",
+        "path": "./syntaxes/graphql.connectors.json",
+        "embeddedLanguages": {
+          "meta.embedded.block.connectors.mapping.graphql": "apollo.connectors.mapping",
+          "meta.embedded.line.connectors.mapping.graphql": "apollo.connectors.mapping",
+          "meta.embedded.string.connectors.mapping.selectionstring.graphql": "apollo.connectors.mapping"
+        }
+      },
       {
         "injectTo": [
           "source.js",

package/sampleWorkspace/connectors-community/.github/ISSUE_TEMPLATE/connector-bug-report.md

@@ -0,0 +1,36 @@
+---
+name: Connector Bug Report
+about: Create a report to help us fix a connector issue
+title: "[Connector Name] - Bug Title"
+labels: bug
+assignees: michael-watson
+
+---
+
+**Connector**:
+**Connector Module**: *if any*
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Start [Connector Name] name
+2. Execute this operation:
+
+```graphql
+query {
+
+}
+```
+
+3. Results:
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context or recommended fixes**
+Add any other context about the problem here.

package/sampleWorkspace/connectors-community/.github/ISSUE_TEMPLATE/new-connector.md

@@ -0,0 +1,10 @@
+---
+name: New Connector
+about: To create a new connector that is available in the connectors-community
+title: "{NAME} Connector"
+labels: new
+assignees: ''
+
+---
+
+

package/sampleWorkspace/connectors-community/.github/renovate.json5

@@ -0,0 +1,3 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json"
+}

package/sampleWorkspace/connectors-community/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+    "recommendations": ["apollographql.vscode-apollo","redhat.vscode-yaml"]
+}

package/sampleWorkspace/connectors-community/.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+  "terminal.integrated.profiles.osx": {
+    "graphos": {
+      "path": "zsh",
+      "args": ["-l"],
+      "env": {
+        "APOLLO_KEY": "",
+        "APOLLO_GRAPH_REF": "",
+      }
+    }
+  },
+  "terminal.integrated.defaultProfile.osx": "graphos"
+}

package/sampleWorkspace/connectors-community/.vscode/tasks.json

@@ -0,0 +1,10 @@
+{
+    "version": "2.0.0",
+    "tasks": [{
+        "label": "rover dev",
+        "command": "rover", // Could be any other shell command
+        "args": ["dev", "--supergraph-config","supergraph.yaml", "--router-config","router.yaml"],
+        "type": "shell",
+        "problemMatcher": [],
+    }]
+}

package/sampleWorkspace/connectors-community/README.md

@@ -0,0 +1,108 @@
+# Apollo Connectors Community
+
+This repository is for builders to share API connectors to help accelerate the community with rich starting points. The basic workflow functionality below can help a builder get a new project started in seconds with a fantastic developer experience. 
+
+The template for creating with `connectors-community` includes:
+
+- A fully working local instance with everything you need to connect to any REST API, just add your APOLLO_KEY and GRAPH_REF and you are ready to go
+  - If you want to start with an existing/prebuilt connector in this repo, you can start with that schema and supergraph
+  - If you want to create a new connector, the steps to set up your local environment with Rover CLI can be found in our [Getting Started documentation](https://www.apollographql.com/docs/quickstart)
+- A graph in GraphOS created with API keys synced to your local project
+- a dockerfile for [easy deployment](https://www.apollographql.com/docs/graphos/connectors/deployment#router-deployment)
+- VS Code supercharged `.vscode` folder
+  - `dev` command with hot reloading for all the related files available as a Task
+  - Custom terminal profile created that includes GraphOS API keys
+  - Recommendations for the Apollo extension
+
+Everything's configured—it all just works. 💪
+
+## Set up your environment
+
+1. If you have not installed Rover before, install [Rover CLI](https://www.apollographql.com/docs/quickstart):
+
+```sh
+curl -sSL https://rover.apollo.dev/nix/latest | sh 
+```
+2. Run `rover init`
+3. Select the option 'Create a new graph'
+4. Select the option 'Start with one or more REST API's
+5. Name your graph
+
+Next Rover will generate a GRAPH_REF and APOLLO_KEY for you and provide a command to run from the terminal.
+
+It is a best practice to take these values and add them to your terminal environment.  For VSCode, that looks like this:
+
+In VScode > settings.js add the configuration below then restart VSCode.
+
+```
+{
+
+ "terminal.integrated.profiles.osx": {
+
+   "graphos": {
+
+     "path": "zsh",
+
+     "args": ["-l"],
+
+     "env": {
+
+       "APOLLO_KEY": "<YOUR_KEY>",
+
+       "APOLLO_GRAPH_REF": "<GRAPH_REF>"
+
+     }
+
+   }
+
+ },
+
+ "terminal.integrated.defaultProfile.osx": "graphos"
+
+}
+```
+
+Graph development is supported in other IDE's. All directions here are for VSCode.  For more details or working in other environments see [IDE Support Documentation.](https://www.apollographql.com/docs/ide-support)
+
+## Adding and Running a Prebuilt Connector
+
+1. From the connectors folder, choose the prebuilt Connector you want to work with and add all graphql files plus the supergraph.yaml to your new project.
+2. Next open your terminal and run the following:
+
+```
+rover dev --supergraph-config supergraph.yaml
+```
+
+## Tip for VSCode users
+
+1. Install the [VSCode extension](https://www.apollographql.com/docs/ide-support/vs-code) to provide a better development expereince when working with Connectors including syntax highlighting and realt-time feedback.
+   This extension requires a configuration file in the root named `apollo.config.json` with the following inside:
+```
+{
+  "rover": {}
+}
+```
+
+2. You can also configure the `rover dev` task for VS Code in the `.vscode/tasks.json` folder:
+
+```json
+{
+    "version": "2.0.0",
+    "tasks": [{
+        "label": "rover dev",
+        "command": "rover", // Could be any other shell command
+        "args": ["dev", "--supergraph-config","supergraph.yaml", "--router-config","./connectors/stripe/router.yaml"],
+        "type": "shell",
+        "problemMatcher": [],
+    }]
+}
+```
+## Contributing a connector to the community
+
+We welcome any and all contributions! There are only a couple requirements:
+
+1. *We need to be able to recreate your connector work*. Ideally we can hit some live endpoints. That isn't always possible with some APIs, but if we have an OpenAPI specification with example definitions, we can have a mocked REST API that a connector is built with.
+2. *The connector must be working and complete*. You don't have to implement the entire API to contribute, just a portion of it. We just want to ensure that whatever you have implemented is used in the schema; the goal is to try and avoid unused definitions that should be pruned.
+
+That's it! Feel free to open an issue with the ["New Connector" template](./connectors/.template) or a PR with your work. The Apollo DevRel team will help usher your contribution through the process and promote your work to the broader community. If you need some help, you can open a post on the [Apollo Community Forum](https://community.apollographql.com/c/connectors/29) and add the `connectors` tag to it. 
+

package/sampleWorkspace/connectors-community/apollo.config.json

@@ -0,0 +1,5 @@
+{
+  "rover": {
+    "supergraphConfig": "./supergraph.yaml"
+  }
+}

package/sampleWorkspace/connectors-community/connectors/.template/Dockerfile

@@ -0,0 +1,5 @@
+FROM ghcr.io/apollographql/router:v2.2.0
+
+COPY router.yaml /config.yaml
+
+CMD ["--config", "/config.yaml"]

package/sampleWorkspace/connectors-community/connectors/.template/README

@@ -0,0 +1,46 @@
+# {TEMPLATE} REST Connector
+
+This connector currently covers the {XXX object/functionality} in the {TEMPLATE} API.
+
+## Prerequisites
+
+To use the connector, you need {API key or other prereq}.
+
+## Additional Setup for VS Code Task runner
+
+Edit your `.vscode/settings.json` to include the following keys:
+
+```
+{
+  "terminal.integrated.profiles.osx": {
+    "graphos": {
+      "path": "zsh",
+      "args": ["-l"],
+      "env": {
+        "API_KEY": "",
+        "APOLLO_KEY": "",
+        ...
+      }
+    }
+  },
+  "terminal.integrated.defaultProfile.osx": "graphos"
+}
+```
+
+Once you've set this up, you can execute the `Tasks: Run Task` command in VS Code to run the `rover dev` task.
+Alternatively, you can open a new terminal window in VS Code with the `graphos` profile, then run `rover dev --supergraph-config supergraph.yaml --router-config router.yaml`.
+
+## Contributing
+
+
+The following schema modules can be added to this connector:
+
+- Example 1
+- Example 2
+
+To contribute them, make sure to:
+
+1. Add a schema designed for the module as a new `.graphql` file.
+2. Update the `router.yaml` and `supergraph.yaml` files accordingly.
+
+See [REST API reference]() for other modules that can be implemented. You can use the current modules in this folder as examples to work with. 

package/sampleWorkspace/connectors-community/connectors/.template/connector.graphql

@@ -0,0 +1,31 @@
+extend schema
+  @link(url: "https://specs.apollo.dev/federation/v2.10", import: ["@key", "@requires"])
+  @link(
+    url: "https://specs.apollo.dev/connect/v0.2"
+    import: ["@source", "@connect"]
+  )
+  @source(
+    name: "jsonPlaceholder"
+    http: {
+      baseURL: "https://jsonplaceholder.typicode.com/"
+    }
+  )
+
+type Post {
+  id: ID!
+  body: String
+  title: String
+}
+
+type Query {
+  posts: [Post]
+    @connect(
+      source: "jsonPlaceholder"
+      http: { GET: "/posts" }
+      selection: """
+        id
+        title
+        body
+      """
+    )
+}

package/sampleWorkspace/connectors-community/connectors/.template/router.yaml

@@ -0,0 +1,18 @@
+supergraph:
+  listen: 0.0.0.0:${env.PORT:-4000}
+
+headers:
+  all:
+    request:
+      - propagate:
+          matching: .*
+telemetry:
+  instrumentation:
+    spans: 
+      mode: spec_compliant
+
+# connectors:
+#   sources:
+#     connectorName.sourceName:
+#       $config:
+#         apiKey: ${env.API_KEY}

package/sampleWorkspace/connectors-community/connectors/.template/supergraph.yaml

@@ -0,0 +1,6 @@
+federation_version: =2.11.0
+subgraphs:
+  connector:
+    routing_url: http://connector
+    schema:
+      file: connector.graphql

package/sampleWorkspace/connectors-community/connectors/JSONPlaceholder/README

@@ -0,0 +1,12 @@
+# JSONPlaceholder REST Connector
+
+This connector brings [{JSON} Placeholder](https://jsonplaceholder.typicode.com/), which provides fake data for testing and prototyping to GraphQL!
+
+The GET operation has been implemented for
+
+- Users
+- ToDos
+- Posts
+- Comments
+- Albums
+- Photos

package/sampleWorkspace/connectors-community/connectors/JSONPlaceholder/albums.graphql

@@ -0,0 +1,48 @@
+extend schema
+  @link(
+    url: "https://specs.apollo.dev/federation/v2.10"
+    import: ["@key"]
+  )
+  @link(
+    url: "https://specs.apollo.dev/connect/v0.2"
+    import: ["@connect", "@source"]
+  )
+# A @source directive defines a shared data source for multiple connectors.
+  @source(
+    name: "JSONPlaceholder"
+    http: { baseURL: "https://jsonplaceholder.typicode.com/" }
+  )
+
+  type Album @key(fields: "id") {
+    id: ID!
+    userId: ID!
+    title: String
+  }
+
+  type User @key(fields: "id") {
+    id: ID!
+    albums: [Album]
+    @connect(
+      source: "JSONPlaceholder"
+      http: { GET: "/users/{$this.id}/albums" }
+      selection: """
+        id
+        userId
+        title
+      """
+    )
+  }
+
+  type Query {
+    getAlbum(id: ID!): Album
+    @connect(
+      source: "JSONPlaceholder"
+      http: { GET: "/albums/{$args.id}" }
+      selection: """
+        id
+        userId
+        title
+    """
+    entity: true
+    )
+  }

package/sampleWorkspace/connectors-community/connectors/JSONPlaceholder/comments.graphql

@@ -0,0 +1,54 @@
+extend schema
+  @link(
+    url: "https://specs.apollo.dev/federation/v2.10"
+    import: ["@key"]
+  )
+  @link(
+    url: "https://specs.apollo.dev/connect/v0.2"
+    import: ["@connect", "@source"]
+  )
+# A @source directive defines a shared data source for multiple connectors.
+  @source(
+    name: "JSONPlaceholder"
+    http: { baseURL: "https://jsonplaceholder.typicode.com/" }
+  )
+
+  type Comment {
+    id: ID!
+    postId: ID!
+    name: String
+    email: String
+    body: String
+  }
+
+  type Post @key(fields: "id") {
+    id: ID!
+    comments: [Comment]
+    @connect(
+      source: "JSONPlaceholder"
+      http: { GET: "/posts/{$this.id}/comments" }
+      selection: """
+        id
+        postId
+        name
+        email
+        body
+      """
+    )
+  }
+
+  type Query {
+    getComment(id: ID!): Comment
+    @connect(
+      source: "JSONPlaceholder"
+      http: { GET: "/comments/{$args.id}" }
+      selection: """
+        id
+        postId
+        name
+        email
+        body
+    """
+    entity: true
+    )
+  }