Header Propagation E2E Test (#680)

Author: ardatan

e2e/header-propagation/gateway.config.ts

@@ -0,0 +1,13 @@
+import { defineConfig } from '@graphql-hive/gateway';
+
+export const gatewayConfig = defineConfig({
+  propagateHeaders: {
+    fromClientToSubgraphs({ request }) {
+      return {
+        authorization: request.headers.get('authorization') ?? 'default',
+        'session-cookie-id':
+          request.headers.get('session-cookie-id') ?? 'default',
+      };
+    },
+  },
+});

e2e/header-propagation/header-propagation.e2e.ts

@@ -0,0 +1,62 @@
+import { createTenv } from '@internal/e2e';
+import { expect, it } from 'vitest';
+
+const { gateway, service } = createTenv(__dirname);
+
+it('propagates headers to subgraphs', async () => {
+  await using gw = await gateway({
+    supergraph: {
+      with: 'apollo',
+      services: [await service('upstream')],
+    },
+  });
+  const result = await gw.execute({
+    query: /* GraphQL */ `
+      query {
+        headers {
+          authorization
+          sessionCookieId
+        }
+      }
+    `,
+    headers: {
+      authorization: 'Bearer token',
+      'session-cookie-id': 'session-cookie',
+    },
+  });
+  expect(result).toEqual({
+    data: {
+      headers: {
+        authorization: 'Bearer token',
+        sessionCookieId: 'session-cookie',
+      },
+    },
+  });
+});
+
+it('sends default headers to subgraphs', async () => {
+  await using gw = await gateway({
+    supergraph: {
+      with: 'apollo',
+      services: [await service('upstream')],
+    },
+  });
+  const result = await gw.execute({
+    query: /* GraphQL */ `
+      query {
+        headers {
+          authorization
+          sessionCookieId
+        }
+      }
+    `,
+  });
+  expect(result).toEqual({
+    data: {
+      headers: {
+        authorization: 'default',
+        sessionCookieId: 'default',
+      },
+    },
+  });
+});

e2e/header-propagation/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@e2e/header-propagation",
+  "private": true,
+  "dependencies": {
+    "graphql": "^16.9.0",
+    "tslib": "^2.8.1"
+  },
+  "devDependencies": {
+    "@apollo/server": "^4.10.3",
+    "@apollo/subgraph": "^2.7.2",
+    "@types/cors": "^2.8.17",
+    "@types/express": "^5.0.0",
+    "cors": "^2.8.5",
+    "express": "^4.21.2"
+  }
+}

e2e/header-propagation/services/upstream.ts

@@ -0,0 +1,68 @@
+import { ApolloServer } from '@apollo/server';
+import {
+  ExpressContextFunctionArgument,
+  expressMiddleware,
+} from '@apollo/server/express4';
+import { buildSubgraphSchema } from '@apollo/subgraph';
+import { GraphQLResolverMap } from '@apollo/subgraph/dist/schema-helper';
+import { Opts } from '@internal/testing';
+import cors from 'cors';
+import express from 'express';
+import { parse } from 'graphql';
+
+const app = express();
+
+const resolvers: GraphQLResolverMap<ExpressContextFunctionArgument> = {
+  Query: {
+    headers: (_source, _args, context) => {
+      return {
+        authorization: context.req.headers.authorization,
+        sessionCookieId: context.req.headers['session-cookie-id'],
+      };
+    },
+  },
+};
+
+const server = new ApolloServer<ExpressContextFunctionArgument>({
+  schema: buildSubgraphSchema({
+    typeDefs: parse(/* GraphQL */ `
+      type Query {
+        headers: Headers!
+      }
+
+      type Headers {
+        authorization: String!
+        sessionCookieId: String!
+      }
+    `),
+    resolvers: resolvers as GraphQLResolverMap<unknown>,
+  }),
+});
+
+async function main() {
+  // Note you must call `start()` on the `ApolloServer`
+  // instance before passing the instance to `expressMiddleware`
+  await server.start();
+
+  // Specify the path where we'd like to mount our server
+  app.use(
+    '/graphql',
+    cors(),
+    express.json(),
+    // @ts-expect-error - Weird typing issue with `expressMiddleware`
+    expressMiddleware(server, { context: (ctx) => ctx }),
+  );
+
+  const opts = Opts(process.argv);
+
+  app.listen(opts.getServicePort('upstream'), () => {
+    console.log(
+      `🚀 Server ready at http://localhost:${opts.getServicePort('upstream')}/graphql`,
+    );
+  });
+}
+
+main().catch((e) => {
+  console.error(e);
+  process.exit(1);
+});

yarn.lock

@@ -2520,6 +2520,21 @@ __metadata:
   languageName: unknown
   linkType: soft
 
+"@e2e/header-propagation@workspace:e2e/header-propagation":
+  version: 0.0.0-use.local
+  resolution: "@e2e/header-propagation@workspace:e2e/header-propagation"
+  dependencies:
+    "@apollo/server": "npm:^4.10.3"
+    "@apollo/subgraph": "npm:^2.7.2"
+    "@types/cors": "npm:^2.8.17"
+    "@types/express": "npm:^5.0.0"
+    cors: "npm:^2.8.5"
+    express: "npm:^4.21.2"
+    graphql: "npm:^16.9.0"
+    tslib: "npm:^2.8.1"
+  languageName: unknown
+  linkType: soft
+
 "@e2e/hmac-auth-https@workspace:e2e/hmac-auth-https":
   version: 0.0.0-use.local
   resolution: "@e2e/hmac-auth-https@workspace:e2e/hmac-auth-https"
@@ -6707,6 +6722,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/cors@npm:^2.8.17":
+  version: 2.8.17
+  resolution: "@types/cors@npm:2.8.17"
+  dependencies:
+    "@types/node": "npm:*"
+  checksum: 10c0/457364c28c89f3d9ed34800e1de5c6eaaf344d1bb39af122f013322a50bc606eb2aa6f63de4e41a7a08ba7ef454473926c94a830636723da45bf786df032696d
+  languageName: node
+  linkType: hard
+
 "@types/docker-modem@npm:*":
   version: 3.0.6
   resolution: "@types/docker-modem@npm:3.0.6"
@@ -10681,7 +10705,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"express@npm:^4.21.1":
+"express@npm:^4.21.1, express@npm:^4.21.2":
   version: 4.21.2
   resolution: "express@npm:4.21.2"
   dependencies: