useAsyncSchema does not await the schema promise

[thomasheyenbrock]

Describe the bug

The useAsyncSchema accepts a promise that resolves to a GraphQL schema as argument. It chains a .then() on this promise (inside the call to setSchema happens), but since the envelop initialisation is synchronous, it might happen that the GraphQL server is handling the first request before the schema promise has resolved. (Or rejected, which is also not handled btw 🤔 )

To Reproduce
Steps to reproduce the behavior:

• This codesandbox demonstrates the issue by throwing in an artificial setTimeout of one second.

Expected behavior

1. When loading an async schema, no request should be handled before the schema is loaded
2. Rejection of the schema promise is handled gracefully

Environment:

• OS: macOS Monterey 12.0.1
• @envelop/core: latest
• NodeJS: 16.13.0

Additional context

I looked a bit into the codebase, here are some loose thoughts around how to achieve the first point I noted under "expected behavior":

• Making the onPluginInit hook async would easily solve this, but it would be a major change (atm the plugin initialisation and the call to envelop is sync). "Remembering" promises returned from that hook and awaiting them when calling getEnveloped would also be a breaking change.
• Maybe this could potentially even break other plugins that call setSchema, because it's non-deterministic in which order these calls will happen?
• I also found this comment to be kinda related, but awaiting the schema to be loaded after calling envelop defeats the purpose of useAsyncSchema (you could just await before and use the sync useSchema)
• Maybe this can also be "solved" by more extensive documentation, i.e. "you need to make sure the schema promise is resolved before starting to handle request.

Would be open to help with this, but right now I'm not what the way forward would be 😄

[saihaj]

This was a mistake to add since validate and parse from graphql-js as synchronous in nature. Dropping this plugin in next major release #1506