bump to @apollo/server v4

README.md

@@ -91,7 +91,7 @@ Sometimes you don't want to trace everything, so we provide ways to select if yo
 If you construct the extension with `shouldTraceRequest` you get the option to opt-in or out on a request basis.
 When you don't start the span for the request the field resolvers will also not be used.
 
-The function is called with the same arguments as the `requestDidStart` function extensions can provide, which is documented [here](https://github.com/apollographql/apollo-server/blob/master/packages/graphql-extensions/src/index.ts#L35).
+The function is called with the same arguments as the `requestDidStart` function extensions can provide, which is documented [here](https://github.com/apollographql/apollo-server/blob/a1d549e/packages/server/src/externalTypes/plugins.ts#L52).
 
 When the request is not traced there will also be no traces of the field resolvers.
 
@@ -101,7 +101,7 @@ There might be certain field resolvers that are not worth the tracing, e.g. when
 
 ## Modifying span metadata
 
-If you'd like to add custom tags or logs to span you can construct the extension with `onRequestResolve`. The function is called with two arguments: span and infos `onRequestResolve?: (span: Span, info: RequestStart)`
+If you'd like to add custom tags or logs to span you can construct the extension with `onRequestResolve`. The function is called with two arguments: span and infos `onRequestResolve?: (span: Span, info: GraphQLRequestContext)`
 
 ## Using your own request span
 

package.json

@@ -32,26 +32,21 @@
   "author": "Daniel Schmidt <[email protected]>",
   "license": "MIT",
   "peerDependencies": {
-    "apollo-server": ">=3.0.0",
-    "apollo-server-env": "*",
+    "@apollo/server": ">=4.0.0",
     "graphql": ">=0.10.x",
     "opentracing": "*"
   },
-  "dependencies": {
-    "apollo-server-plugin-base": "^3.0.0",
-    "apollo-server-types": "^3.0.0"
-  },
   "devDependencies": {
+    "@apollo/server": "4.5.0",
     "@commitlint/config-conventional": "11.0.0",
     "@commitlint/travis-cli": "11.0.0",
     "@types/jest": "26.0.24",
     "@types/node": "14.18.38",
     "@types/supertest": "2.0.12",
     "all-contributors-cli": "6.24.0",
-    "apollo-server": "3.12.0",
-    "apollo-server-env": "4.2.1",
     "express": "4.18.2",
-    "graphql": "15.8.0",
+    "body-parser": "^1.20.2",
+    "graphql": "16.6.0",
     "graphql-tools": "6.2.6",
     "jest": "27.5.1",
     "opentracing": "0.14.7",

src/__tests__/__snapshots__/integration-test.ts.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`integration with apollo-server alias with fragment works 1`] = `
+exports[`integration with @apollo/server alias with fragment works 1`] = `
 request:1
    finished: true
 
@@ -13,7 +13,7 @@ request:1
 
 `;
 
-exports[`integration with apollo-server alias works 1`] = `
+exports[`integration with @apollo/server alias works 1`] = `
 request:1
    finished: true
 
@@ -29,7 +29,7 @@ request:1
 
 `;
 
-exports[`integration with apollo-server correct span nesting 1`] = `
+exports[`integration with @apollo/server correct span nesting 1`] = `
 request:1
    finished: true
 
@@ -45,7 +45,7 @@ request:1
 
 `;
 
-exports[`integration with apollo-server does not start a field resolver span if the parent field resolver was not traced 1`] = `
+exports[`integration with @apollo/server does not start a field resolver span if the parent field resolver was not traced 1`] = `
 request:1
    finished: true
 
@@ -58,7 +58,7 @@ request:1
 
 `;
 
-exports[`integration with apollo-server implements traces for arrays 1`] = `
+exports[`integration with @apollo/server implements traces for arrays 1`] = `
 request:1
    finished: true
 
@@ -86,7 +86,7 @@ request:1
 
 `;
 
-exports[`integration with apollo-server onFieldResolve & onFieldResolveFinish 1`] = `
+exports[`integration with @apollo/server onFieldResolve & onFieldResolveFinish 1`] = `
 request:1
    finished: true
 
@@ -123,7 +123,7 @@ request:1
 
 `;
 
-exports[`integration with apollo-server onRequestError 1`] = `
+exports[`integration with @apollo/server onRequestError 1`] = `
 request:1
    finished: true
    logs:
@@ -135,7 +135,7 @@ request:1
 
 `;
 
-exports[`integration with apollo-server onRequestResolve 1`] = `
+exports[`integration with @apollo/server onRequestResolve 1`] = `
 request:1
    finished: true
    logs:
@@ -159,7 +159,7 @@ request:1
 
 `;
 
-exports[`integration with apollo-server picks up external spans 1`] = `
+exports[`integration with @apollo/server picks up external spans 1`] = `
 external:-1
    finished: false
 

src/__tests__/integration-test.ts

@@ -1,10 +1,12 @@
 import * as express from "express";
 import * as request from "supertest";
-import { ApolloServer } from "apollo-server-express";
+import { ApolloServer } from "@apollo/server";
+import { expressMiddleware } from '@apollo/server/express4';
+import { json } from 'body-parser';
 import { Tracer } from "opentracing";
 import { MockSpan, MockSpanTree } from "../test/types";
 import spanSerializer from "../test/span-serializer";
-import ApolloOpentracing, { InitOptions, SpanContext } from "../";
+import ApolloOpentracing, { InitOptions } from "../";
 
 expect.addSnapshotSerializer(spanSerializer);
 
@@ -147,16 +149,18 @@ class MockTracer {
   }
 }
 
-async function createApp<InstanceContext extends SpanContext>({
+interface EmptyContext {}
+
+async function createApp({
   tracer,
   ...params
 }: { tracer: MockTracer } & Omit<
-  InitOptions<InstanceContext>,
+  InitOptions<EmptyContext>,
   "server" | "local"
 >) {
   const app = express();
 
-  const server = new ApolloServer({
+  const server = new ApolloServer<EmptyContext>({
     typeDefs: `
       type A {
         one: String
@@ -221,12 +225,12 @@ async function createApp<InstanceContext extends SpanContext>({
     ],
   });
   await server.start();
-  server.applyMiddleware({ app });
+  app.use('/graphql', json(), expressMiddleware(server));
 
   return app;
 }
 
-describe("integration with apollo-server", () => {
+describe("integration with @apollo/server", () => {
   it("closes all spans", async () => {
     const tracer = new MockTracer();
     const app = await createApp({ tracer });

src/context.ts

@@ -1,6 +1,16 @@
 import { Span } from "opentracing";
 import { GraphQLResolveInfo, ResponsePath } from "graphql";
-import { GraphQLRequestContext } from "apollo-server-plugin-base";
+import { ContextForApolloOpenTracing, WithRequiredSpanContext, hasSpanContext, addSpanContext } from './index';
+
+/**
+ * Object containing private methods that this library uses, that will be attatched to the GQL context object.
+ * (Will be namespaced using a symbol to hide this from users)
+ */
+export interface SpanContext {
+  getSpanByPath(info: ResponsePath): Span | undefined;
+  addSpan(span: Span, info: GraphQLResolveInfo): void;
+}
+
 function isArrayPath(path: ResponsePath) {
   return typeof path.key === "number";
 }
@@ -19,40 +29,23 @@ export function buildPath(path: ResponsePath | undefined) {
   return segments.reverse().join(".");
 }
 
-export interface SpanContext extends Object {
-  _spans: Map<string, Span>;
-  getSpanByPath(info: ResponsePath): Span | undefined;
-  addSpan(span: Span, info: GraphQLResolveInfo): void;
-  // Passed in from the outside context
-  requestSpan?: Span;
-}
-
-function isSpanContext(obj: any): obj is SpanContext {
-  return (
-    obj.getSpanByPath instanceof Function && obj.addSpan instanceof Function
-  );
-}
-
-export function requestIsInstanceContextRequest<CTX extends SpanContext>(
-  request: GraphQLRequestContext<CTX | Object>
-): request is GraphQLRequestContext<CTX> {
-  return isSpanContext(request.context);
-}
-
-// TODO: think about using symbols to hide these
-export function addContextHelpers(obj: any): SpanContext {
-  if (isSpanContext(obj)) {
-    return obj;
+export function addContextHelpers<Context extends ContextForApolloOpenTracing>(
+  contextValue: Context
+): WithRequiredSpanContext<Context> {
+  if (hasSpanContext(contextValue)) {
+    return contextValue;
   }
 
-  obj._spans = new Map<string, Span>();
-  obj.getSpanByPath = function (path: ResponsePath): Span | undefined {
-    return this._spans.get(buildPath(isArrayPath(path) ? path.prev : path));
-  };
-
-  obj.addSpan = function (span: Span, info: GraphQLResolveInfo): void {
-    this._spans.set(buildPath(info.path), span);
+  const spans = new Map<string, Span>();
+  const spanContext: SpanContext = {
+    getSpanByPath: (path: ResponsePath): Span | undefined => {
+      return spans.get(buildPath(isArrayPath(path) ? path.prev : path));
+    },
+    addSpan: (span: Span, info: GraphQLResolveInfo): void => {
+      spans.set(buildPath(info.path), span);
+    },
   };
 
-  return obj;
+  addSpanContext(contextValue, spanContext);
+  return contextValue;
 }