Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Consider typing for gateway parameter in AS3 #4919

Closed
glasser opened this issue Feb 10, 2021 · 2 comments
Closed

Consider typing for gateway parameter in AS3 #4919

glasser opened this issue Feb 10, 2021 · 2 comments
Projects
Apollo Server 3

Comments

@glasser
Copy link
Member

glasser commented Feb 10, 2021

Right now gateway has a somewhat generic GraphQLService interface but it's unclear that we would support anything other than ApolloGateway. Maybe we should change the type to ApolloGateway (or something named reflecting it if we need to bust cyclic dependencies)? Maybe we should at least make all its methods (like stop) required? Maybe we should add functionality to the plugin interface so that gateway could just be a plugin?
@glasser glasser added this to the Release 3.x milestone Feb 10, 2021
@glasser glasser mentioned this issue Feb 10, 2021
Merged
@glasser glasser added this to To Organize in Apollo Server 3 May 2, 2021
@glasser glasser moved this from To Organize to Potential breaking changes in Apollo Server 3 May 2, 2021
@glasser glasser removed this from the Release 3.x milestone Jun 10, 2021
@glasser
Copy link
Member Author

glasser commented Jun 10, 2021

In #5295 I made its methods required. But let's rename the type too.

glasser added a commit that referenced this issue Jun 10, 2021
@glasser
Rename GraphQLService to GatewayInterface
eb059db 
`GraphQLService` was a confusing name. It's not related to
`GraphQLServiceContext` (which is the type of the argument to
`serverWillStart`) nor is it related to "service", the old name for a
graph in Studio... or "implementing service", the old name for a
subgraph... It's the type of the `gateway` option, so giving it a
gateway name seems reasonable.

But we keep exporting the old name so that we can have builds of
`@apollo/gateway` that work with both AS2 and AS3.

Fixes #4919.
@glasser glasser mentioned this issue Jun 10, 2021
Merged
glasser added a commit that referenced this issue Jun 10, 2021
@glasser
Rename GraphQLService to GatewayInterface (#5296)
e4d4bff 
`GraphQLService` was a confusing name. It's not related to
`GraphQLServiceContext` (which is the type of the argument to
`serverWillStart`) nor is it related to "service", the old name for a
graph in Studio... or "implementing service", the old name for a
subgraph... It's the type of the `gateway` option, so giving it a
gateway name seems reasonable.

But we keep exporting the old name so that we can have builds of
`@apollo/gateway` that work with both AS2 and AS3.

Fixes #4919.
@glasser
Copy link
Member Author

glasser commented Jun 10, 2021

Fixed in AS3.

@glasser glasser closed this as completed Jun 10, 2021
Apollo Server 3 automation moved this from Potential breaking changes to Done Jun 10, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 20, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
None yet
Projects
No open projects
Apollo Server 3
Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@glasser