@graphql-hive/importer and point to exact syntax error while parsing config (#462)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: enisdenjo

.changeset/@graphql-hive_gateway-462-dependencies.md

@@ -0,0 +1,8 @@
+---
+'@graphql-hive/gateway': patch
+---
+
+dependencies updates: 
+
+- Added dependency [`@graphql-hive/importer@workspace:^` ↗︎](https://www.npmjs.com/package/@graphql-hive/importer/v/workspace:^) (to `dependencies`)
+- Removed dependency [`@graphql-mesh/include@^0.2.3` ↗︎](https://www.npmjs.com/package/@graphql-mesh/include/v/0.2.3) (from `dependencies`)

.changeset/lemon-zebras-smoke.md

@@ -0,0 +1,5 @@
+---
+'@graphql-hive/gateway': patch
+---
+
+Use `@graphql-hive/importer` for importing configs and transpiling TypeScript files

.changeset/plenty-timers-nail.md

@@ -0,0 +1,5 @@
+---
+'@graphql-hive/gateway': minor
+---
+
+Point to exact location of syntax error when parsing malformed config files

.changeset/strong-ghosts-talk.md

@@ -0,0 +1,5 @@
+---
+'@graphql-hive/importer': major
+---
+
+Improving Hive's importing capabilities allowing it to parse TypeScript files

.prettierignore

@@ -9,3 +9,6 @@ __generated__
 .wrangler/
 *.Dockerfile
 /examples/
+/packages/importer/tests/fixtures/syntax-error.ts
+/e2e/config-syntax-error/gateway.config.ts
+/e2e/config-syntax-error/custom-resolvers.ts

e2e/config-syntax-error/config-syntax-error.e2e.ts

@@ -0,0 +1,38 @@
+import { createTenv } from '@internal/e2e';
+import { isCI } from '@internal/testing';
+import { expect, it } from 'vitest';
+
+const { gateway, service, gatewayRunner } = createTenv(__dirname);
+
+it.skipIf(
+  // for whatever reason docker in CI sometimes (sometimes is the keyword, more than less)
+  // doesnt provide all the logs and throws errors with weird messages and I dont know where from or why
+  // see https://github.com/graphql-hive/gateway/actions/runs/12830196184/job/35777821364
+  isCI() && gatewayRunner === 'docker',
+)(
+  'should point to exact location of syntax error when parsing a malformed config',
+  async () => {
+    await expect(
+      gateway({
+        supergraph: {
+          with: 'mesh',
+          services: [await service('hello')],
+        },
+        runner: {
+          docker: {
+            volumes: [
+              {
+                host: 'custom-resolvers.ts',
+                container: '/gateway/custom-resolvers.ts',
+              },
+            ],
+          },
+        },
+      }),
+    ).rejects.toThrowError(
+      gatewayRunner === 'bun' || gatewayRunner === 'bun-docker'
+        ? /error: Expected "{" but found "hello"(.|\n)*\/custom-resolvers.ts:8:11/
+        : /SyntaxError \[Error\]: Error transforming .*(\/|\\)custom-resolvers.ts: Unexpected token, expected "{" \(8:11\)/,
+    );
+  },
+);

e2e/config-syntax-error/custom-resolvers.ts

@@ -0,0 +1,12 @@
+// @ts-nocheck -- syntax error intentionally
+
+import { GatewayContext } from '@graphql-hive/gateway';
+import { IResolvers } from '@graphql-tools/utils';
+
+export const customResolvers: IResolvers<unknown, GatewayContext> = {
+  Query: {
+    bye() hello {
+      return 'world';
+    },
+  },
+};

e2e/config-syntax-error/gateway.config.ts

@@ -0,0 +1,6 @@
+import { defineConfig } from '@graphql-hive/gateway';
+import { customResolvers } from './custom-resolvers';
+
+export const gatewayConfig = defineConfig({
+  additionalResolvers: [customResolvers],
+});

e2e/config-syntax-error/mesh.config.ts

@@ -0,0 +1,22 @@
+import {
+  defineConfig,
+  loadGraphQLHTTPSubgraph,
+} from '@graphql-mesh/compose-cli';
+import { Opts } from '@internal/testing';
+
+const opts = Opts(process.argv);
+
+export const composeConfig = defineConfig({
+  subgraphs: [
+    {
+      sourceHandler: loadGraphQLHTTPSubgraph('hello', {
+        endpoint: `http://localhost:${opts.getServicePort('hello')}/graphql`,
+      }),
+    },
+  ],
+  additionalTypeDefs: /* GraphQL */ `
+    extend type Query {
+      bye: String!
+    }
+  `,
+});

e2e/config-syntax-error/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@e2e/config-syntax-error",
+  "private": true,
+  "dependencies": {
+    "@graphql-mesh/compose-cli": "^1.2.13",
+    "@graphql-tools/utils": "^10.7.2",
+    "graphql": "^16.9.0",
+    "tslib": "^2.8.1"
+  }
+}