Add support for Apollo Connectors Mapping Syntax

.github/workflows/E2E.yml

@@ -5,7 +5,7 @@ on:
     branches:
       - main
 jobs:
-  test:
+  e2e:
     name: Run E2E tests
     runs-on: ubuntu-latest
     strategy:
@@ -30,3 +30,15 @@ jobs:
       - run: xvfb-run -a npm run test:extension
         env:
           VSCODE_VERSION: "${{ matrix.version }}"
+  test:
+    name: Run other tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          cache: "npm"
+      - run: npm install
+      - run: npm run build:production
+      - run: yarn test
+      - run: yarn test:textmate

.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"
+  }
 }

apollo.jsonselection.configuration.json

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

package.json

@@ -21,6 +21,7 @@
     "watch": "rimraf lib; npm-run-all -p watch:*",
     "watch:esbuild": "npm run build -- --watch",
     "watch:tsc": "npm run typecheck -- --watch",
+    "watch:textmate-yaml": "fswatch syntaxes/*.yaml | sed -u -e 's/\\.yaml$//' | xargs -I {} bash -c \"npx js-yaml {}.yaml > {}.json && echo {}\"",
     "sampleWorkspace:run": "node src/__e2e__/mockServer.js",
     "changeset-version": "changeset version && npm i",
     "changeset-publish": "npm run build -- --production && changeset publish",
@@ -29,7 +30,10 @@
     "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-jsonselection && npm run test:textmate-graphql-jsonselection",
+    "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-jsonselection": "npx vscode-tmgrammar-snap -s source.apollo.connectors.mapping src/__tests__/fixtures/textmate/*.jsonselection",
+    "test:textmate-graphql-jsonselection": "npx vscode-tmgrammar-snap -s source.graphql src/__tests__/fixtures/textmate/*.graphql",
     "codegen": "graphql-codegen",
     "vscode:prepublish": "npm run build:production"
   },
@@ -154,6 +158,16 @@
         ],
         "configuration": "./graphql.configuration.json"
       },
+      {
+        "id": "apollo.connectors.mapping",
+        "aliases": [
+          "[Apollo Connectors Mapping Syntax]"
+        ],
+        "filenames": [
+          "test.apollo.jsonselection"
+        ],
+        "configuration": "./apollo.jsonselection.configuration.json"
+      },
       {
         "id": "jsonc",
         "filenames": [
@@ -167,6 +181,22 @@
         "scopeName": "source.graphql",
         "path": "./syntaxes/graphql.json"
       },
+      {
+        "language": "apollo.connectors.mapping",
+        "scopeName": "source.apollo.connectors.mapping",
+        "path": "./syntaxes/connectors.jsonselection.json"
+      },
+      {
+        "injectTo": [
+          "source.graphql"
+        ],
+        "scopeName": "source.apollo.connectors.graphql",
+        "path": "./syntaxes/graphql.connectors.json",
+        "embeddedLanguages": {
+          "meta.embedded.block.jsonselection.graphql": "apollo.connectors.mapping",
+          "meta.embedded.block.string.jsonselection.graphql": "apollo.connectors.mapping"
+        }
+      },
       {
         "injectTo": [
           "source.js",

sampleWorkspace/sampleWorkspace.code-workspace

@@ -23,6 +23,9 @@
     },
     {
       "path": "../src/language-server/__tests__/fixtures/documents"
+    },
+    {
+      "path": "../src/__tests__/fixtures"
     }
   ],
   "settings": {}

src/__tests__/fixtures/textmate/test.apollo.jsonselection

@@ -0,0 +1,137 @@
+# Examples from https://github.com/apollographql/router/blob/next/apollo-federation/src/sources/connect/json_selection/README.md
+
+id
+name
+abc: some.nested.path { a b c }
+id
+name
+some.nested.path { a b c }
+names: {
+  first: firstName
+  last: lastName
+}
+# Also allowed:
+firstName
+lastName
+postID
+title
+author: {
+  id: authorID
+  name: authorName
+}
+      title
+      year: publication.year
+      authorName: author.name
+id
+created
+model
+
+# The { role content } SubSelection is mandatory so the output keys
+# can be statically determined:
+choices->first.message { role content }
+
+# Multiple PathWithSubSelections are allowed in the same SubSelection:
+choices->last.message { lastContent: content }
+      # For some reason /users/{$args.id} returns an object with name
+      # and email but no id, so we inject the id manually:
+      id: $args.id
+      name
+      email
+id name friends: friend_ids { id: $ }
+items: data.nested.items { id name }
+firstItem: data.nested.items->first { id name }
+firstItemName: data.nested.items->first.name
+$.data { id name }
+id: data.id
+name: data.name
+all: $.first->and($.second)->and($.third)
+wrapped: field->echo({ fieldValue: @ })
+children: parent->echo([@.child1, @.child2, @.child3])
+doubled: numbers->map({ value: @->mul(2) })
+types: values->map(@->typeof)
+__typename: $("Product")
+condition: $(true)
+alphabetSlice: $("abcdefghijklmnopqrstuvwxyz")->slice($args.start, $args.end)
+suffix: results.slice($(-1)->mul($args.suffixLength))
+# The ->echo method returns its first input argument as-is, ignoring
+# the input data. Useful for embedding literal values, as in
+# $->echo("give me this string"), or wrapping the input value.
+__typename: $->echo("Book")
+wrapped: field->echo({ fieldValue: @ })
+
+# Returns the type of the data as a string, e.g. "object", "array",
+# "string", "number", "boolean", or "null". Note that `typeof null` is
+# "object" in JavaScript but "null" for our purposes.
+typeOfValue: value->typeof
+
+# When invoked against an array, ->map evaluates its first argument
+# against each element of the array, binding the element values to `@`,
+# and returns an array of the results. When invoked against a non-array,
+# ->map evaluates its first argument against that value and returns the
+# result without wrapping it in an array.
+doubled: numbers->map(@->mul(2))
+types: values->map(@->typeof)
+
+# Returns true if the data is deeply equal to the first argument, false
+# otherwise. Equality is solely value-based (all JSON), no references.
+isObject: value->typeof->eq("object")
+
+# Takes any number of pairs [candidate, value], and returns value for
+# the first candidate that equals the input data. If none of the
+# pairs match, a runtime error is reported, but a single-element
+# [<default>] array as the final argument guarantees a default value.
+__typename: kind->match(
+    ["dog", "Canine"],
+    ["cat", "Feline"],
+    ["Exotic"]
+)
+
+# Like ->match, but expects the first element of each pair to evaluate
+# to a boolean, returning the second element of the first pair whose
+# first element is true. This makes providing a final catch-all case
+# easy, since the last pair can be [true, <default>].
+__typename: kind->matchIf(
+    [@->eq("dog"), "Canine"],
+    [@->eq("cat"), "Feline"],
+    [true, "Exotic"]
+)
+
+# Arithmetic methods, supporting both integers and floating point values,
+# similar to JavaScript.
+sum: $.a->add($.b)->add($.c)
+difference: $.a->sub($.b)->sub($.c)
+product: $.a->mul($.b, $.c)
+quotient: $.a->div($.b)
+remainder: $.a->mod($.b)
+
+# Array/string methods
+first: list->first
+last: list->last
+index3: list->get(3)
+secondToLast: list->get(-2)
+slice: list->slice(0, 5)
+substring: string->slice(2, 5)
+arraySize: array->size
+stringLength: string->size
+
+# Object methods
+aValue: $->echo({ a: 123 })->get("a")
+hasKey: object->has("key")
+hasAB: object->has("a")->and(object->has("b"))
+numberOfProperties: object->size
+keys: object->keys
+values: object->values
+entries: object->entries
+keysFromEntries: object->entries.key
+valuesFromEntries: object->entries.value
+
+# Logical methods
+negation: $.condition->not
+bangBang: $.condition->not->not
+disjunction: $.a->or($.b)->or($.c)
+conjunction: $.a->and($.b, $.c)
+aImpliesB: $.a->not->or($.b)
+excludedMiddle: $.toBe->or($.toBe->not)->eq(true)
+
+# Tests from https://github.com/apollographql/router/blob/next/apollo-federation/src/sources/connect/url_template.rs
+