making plugins work with apollo server 3

[tubbo]

I couldn't figure out how to make my existing apollo 2 plugins work with apollo server 3. Everything I did turned into a type nightmare. The major issue was the requirement that all plugins had to be async now which totally screwed up everything I was doing.

Ended up just disabling my logging and error reporting plugin because I didn't feel like going through nine layers of type definitions to figure out what I was missing. Just don't have the time or money to be searching through type files to see what the magic types are to pass to Promise.resolve() that will make TS stop yelling at me.

Is anyone else having problems with the apollo 3 upgrade?

[glasser]

Generally just adding async to all the functions should do the trick. If you share a particular example of something that doesn't work, we can try to help you.

[tubbo]

@glasser I did try just wrapping the return value in Promise.resolve() and then I tried adding async to all of the methods, to no success. This was five days ago. Today, I opened the branch again to find out that builds are running as expected, tests are passing...I'm really not sure what was going on there, but I was definitely extremely confused and the problem was symptomizing in Apollo. Pretty sure everything is fine now...definitely not an Apollo problem.

Apologies for my brash tone here, it was not necessary.

[glasser]

That's great to hear!

[tubbo]

hmm, I guess I was mistaken again because as soon as I merged the pkg upgrade/my changes to accommodate the new APIs, our deployments stopped working. We get this error in Docker and nowhere else:

Error: #18 20.83 src/http/graphql/directives/auth.ts(2,29): error TS2307: Cannot find module 'graphql-tools' or its corresponding type declarations.
Error: #18 20.84 src/http/graphql/extensions/error-reporting.ts(15,3): error TS2322: Type '() => *** didEncounterErrors(*** errors, operation, request ***: *** errors: any; operation: any; request: any; ***): void; ***' is not assignable to type '(requestContext: GraphQLRequestContext<Record<string, any>>) => Promise<void | GraphQLRequestListener<Record<string, any>>>'.
#18 20.84   Type '*** didEncounterErrors(*** errors, operation, request ***: *** errors: any; operation: any; request: any; ***): void; ***' is missing the following properties from type 'Promise<void | GraphQLRequestListener<Record<string, any>>>': then, catch, [Symbol.toStringTag], finally
Error: #18 20.84 src/http/graphql/extensions/error-reporting.ts(17,28): error TS7031: Binding element 'errors' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/error-reporting.ts(17,36): error TS7031: Binding element 'operation' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/error-reporting.ts(17,47): error TS7031: Binding element 'request' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(20,3): error TS2322: Type '() => void' is not assignable to type '(service: GraphQLServiceContext) => Promise<void | GraphQLServerListener>'.
#18 20.84   Type 'void' is not assignable to type 'Promise<void | GraphQLServerListener>'.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(28,3): error TS2322: Type '() => *** didResolveSource(*** source ***: *** source: any; ***): void; didResolveOperation(*** operation, operationName, request: *** variables ***, ***: *** operation: any; operationName: any; request: *** variables: any; ***; ***): void; didEncounterErrors(*** errors ***: *** errors: any; ***): void; parsingDidStart(): (error: any) => void; valid...' is not assignable to type '(requestContext: GraphQLRequestContext<Record<string, any>>) => Promise<void | GraphQLRequestListener<Record<string, any>>>'.
#18 20.84   Type '*** didResolveSource(*** source ***: *** source: any; ***): void; didResolveOperation(*** operation, operationName, request: *** variables ***, ***: *** operation: any; operationName: any; request: *** variables: any; ***; ***): void; didEncounterErrors(*** errors ***: *** errors: any; ***): void; parsingDidStart(): (error: any) => void; validationD...' is missing the following properties from type 'Promise<void | GraphQLRequestListener<Record<string, any>>>': then, catch, [Symbol.toStringTag], finally
Error: #18 20.84 src/http/graphql/extensions/logging.ts(41,26): error TS7031: Binding element 'source' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(46,9): error TS7031: Binding element 'operation' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(47,9): error TS7031: Binding element 'operationName' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(48,20): error TS7031: Binding element 'variables' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(57,28): error TS7031: Binding element 'errors' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(64,17): error TS7006: Parameter 'error' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(77,17): error TS7006: Parameter 'errors' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(87,27): error TS7031: Binding element 'operationName' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(87,42): error TS7031: Binding element 'operation' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(90,17): error TS7006: Parameter 'error' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(100,26): error TS7031: Binding element 'operation' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(100,37): error TS7031: Binding element 'operationName' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/schema.ts(1,38): error TS2307: Cannot find module 'graphql-tools' or its corresponding type declarations.
#18 21.07 error Command failed with exit code 2.
#18 21.07 info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
#18 ERROR: process "/bin/sh -c yarn build" did not complete successfully: exit code: 2
------
 > [build 6/6] RUN yarn build:
Error: #18 20.84 src/http/graphql/extensions/logging.ts(64,17): error TS7006: Parameter 'error' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(77,17): error TS7006: Parameter 'errors' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(87,27): error TS7031: Binding element 'operationName' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(87,42): error TS7031: Binding element 'operation' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(90,17): error TS7006: Parameter 'error' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(100,26): error TS7031: Binding element 'operation' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/extensions/logging.ts(100,37): error TS7031: Binding element 'operationName' implicitly has an 'any' type.
Error: #18 20.84 src/http/graphql/schema.ts(1,38): error TS2307: Cannot find module 'graphql-tools' or its corresponding type declarations.

This is after adding async to each of the methods. I have no idea why it won't accept the new promisified type.

[glasser]

It's hard to evaluate just errors without code, but eg

Type '() => void' is not assignable to type '(service: GraphQLServiceContext) => Promise<void | GraphQLServerListener>'.
#18 20.84   Type 'void' is not assignable to type 'Promise<void | GraphQLServerListener>'.

looks like the function on the left is not async: an async function would look like () => Promise<void> rather than () => void.

Also looks like you have an issue with the graphql-tools library. (Note that AS2 depended on graphql-tools but AS3 does not; it uses a newer version of graphql-tools for a few things but via specific broken-out libraries like @graphql-tools/schema.)

[tubbo]

@glasser

Also looks like you have an issue with the graphql-tools library.

This was the 🔑 right here...it turns out that I had a rogue apollo-server-testing still hanging around in my root workspace which caused all kinds of havoc in the "real world" when we built our API with Docker. The migration guide suggested that one might be OK still relying on this package, but I did not have that experience. Perhaps it's because of my use of TypeScript, who knows. Anyway, thank you for helping out as we migrated to AS3! And sorry for not posting code earlier.