Editing pass over the full exported API #6551
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 0118bb4:
|
- The `context` function for `startStandaloneServer` now is passed an argument whose TS type only promises that req and res are core `http` objects rather than Express objects. (While we do currently implement `startStandaloneServer` using Express, this change means we do not have to commit to continuing that choice.) - Actually export `expressMiddleware`. - Move all publicly exported TypeScript-only types (ie, not actual classes) into `externalTypes` (other than types associated with specific plugins). - Rename `ExpressContext` to `ExpressContextFunctionArgument` - Get `WithRequired` from new `@apollo/utils.withrequired` (and don't export it). - Rename GraphQLServiceContext (the argument to serverWillStart) to GraphQLServerContext (matching GraphQLRequestContext) - Rename GraphQLServiceConfig to GatewayLoadResult and remove the unused `schema` field. - Don't export the various interfaces like `ApolloServerOptionsWithSchema` publicly. - Generally reduce depth of imports; eg, in tests import from the top level when possible, to make it clear when an import actually has to be deep because it's not part of the external API - ApolloServer._start is now private rather than protected (no subclasses!) - In tests, simplify makeGatewayMock to take some configuration as an argument rather than a later resolveLoad call; don't make this mock handle `load()` throwing, which is implemented directly in the one test that needed it.
glasser
force-pushed
the
glasser/v4-api-overview
branch
from
a4079b1
to
0118bb4
Compare
|
@trevor-scheer Merging while you're out but this will definitely enjoy your review! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
contextfunction forstartStandaloneServernow is passed anargument whose TS type only promises that req and res are core
httpobjects rather than Express objects. (While we do currently implement
startStandaloneServerusing Express, this change means we do nothave to commit to continuing that choice.)
expressMiddleware.classes) into
externalTypes(other than types associated withspecific plugins).
ExpressContexttoExpressContextFunctionArgumentWithRequiredfrom new@apollo/utils.withrequired(and don'texport it).
GraphQLServerContext (matching GraphQLRequestContext)
schemafield.ApolloServerOptionsWithSchemapublicly.level when possible, to make it clear when an import actually has to
be deep because it's not part of the external API
subclasses!)
argument rather than a later resolveLoad call; don't make this mock
handle
load()throwing, which is implemented directly in the onetest that needed it.