Change dependency on Apollo Server 3 to new type package #2044

glasser · 2022-08-06T06:18:06Z

This removes the last dependency on Apollo Server from Apollo Gateway.

Part of apollographql/apollo-server#6057 and
apollographql/apollo-server#6719

The new package @apollo/server-gateway-interface (in the apollo-utils
repo for now, though it should move to the apollo-server repo once AS4
is fully released) defines types that are pretty close to compatible
with the AS3 types previously used here, but don't require a dependency
on the entirety of AS3. This new package will be used by AS4 and AS4
will convert its data into the format described by these types.

This change is entirely a build-time change (other than a slight change
to how a enum is referenced). So the worst case scenario if this differs
unintentionally from the original AS3 definitions is that users can
apply a bit of as any to fix it.

Note that we've removed some <TContext> from types that it turned out
were only ever instantiated with Record<string, any> anyway. They are
left in in RemoteGraphQLDataSource because users making their own data
sources can explicitly specify their context type.

The types in @apollo/server-gateway-interface are pretty close to the
AS3 types (with different names) but there are some slight differences.
The cache scope enum is replaced with any, as enums are not
structurally typed and it is otherwise difficult to type them.
GatewayInterface now expects onSchemaLoadOrUpdate to exist and
doesn't mention the old onSchemaChange.

netlify · 2022-08-06T06:18:20Z

✅ Deploy Preview for apollo-federation-docs canceled.

Name	Link
🔨 Latest commit	`9dc0438`
🔍 Latest deploy log	https://app.netlify.com/sites/apollo-federation-docs/deploys/62f2cd104f6bc90009ddddd7

glasser · 2022-08-06T06:18:54Z

Appears to build and pass tests. Need to test that it actually works in practice with both AS3 and AS4 (and AS4 won't until we post-process the request context after execution).

Need to document and explain why these changes are safe (or ways that they aren't).

codesandbox-ci · 2022-08-06T06:19:05Z

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.

glasser · 2022-08-08T21:28:26Z

gateway-js/src/datasources/RemoteGraphQLDataSource.ts

      const maxAge = parsed['max-age'];
      if (typeof maxAge === 'string' && maxAge.match(/^[0-9]+$/)) {
        hint.maxAge = +maxAge;
      }
      if (parsed['private'] === true) {
-        hint.scope = CacheScope.Private;
+        hint.scope = 'PRIVATE';


This change has a runtime effect, but a trivial one as CacheScope.Private's runtime value is 'PRIVATE'.

glasser · 2022-08-08T21:41:04Z

gateway-js/package.json

@@ -29,15 +29,14 @@
    "@apollo/core-schema": "~0.3.0",
    "@apollo/federation-internals": "file:../internals-js",
    "@apollo/query-planner": "file:../query-planner-js",
+    "@apollo/server-gateway-interface": "https://pkg.csb.dev/apollographql/apollo-server/commit/bdd19924/@apollo/server-gateway-interface",


These will be changed to released packages before merging this PR.

glasser · 2022-08-08T21:42:56Z

gateway-js/package.json

@@ -29,15 +29,14 @@
    "@apollo/core-schema": "~0.3.0",
    "@apollo/federation-internals": "file:../internals-js",
    "@apollo/query-planner": "file:../query-planner-js",
+    "@apollo/server-gateway-interface": "https://pkg.csb.dev/apollographql/apollo-server/commit/bdd19924/@apollo/server-gateway-interface",
+    "@apollo/usage-reporting-protobuf": "https://pkg.csb.dev/apollographql/apollo-server/commit/bdd19924/@apollo/usage-reporting-protobuf",


(This might get changed back to apollo-reporting-protobuf until we have a non-alpha of the above, although the package is pretty much unchanged other than name and it doesn't have any dependencies.)

trevor-scheer

Prettier not enforced in this repo but there are some spots you could touch up if you choose to. This will be backported as well?

trevor-scheer · 2022-08-08T22:02:28Z

gateway-js/src/__tests__/executeQueryPlan.test.ts

@@ -126,7 +126,9 @@ describe('executeQueryPlan', () => {
      overrideResolversInService('accounts', {
        RootQuery: {
          me() {
-            throw new AuthenticationError('Something went wrong');
+            throw new GraphQLError('Something went wrong', {


Is losing the name here anything to worry about?

I hope not? Note that it doesn't affect the JSON output (I think!)

(It is also a test.)

Backport of #2044. This removes the last dependency on Apollo Server from Apollo Gateway. Part of apollographql/apollo-server#6057 and apollographql/apollo-server#6719 The new package `@apollo/server-gateway-interface` (in the apollo-utils repo for now, though it should move to the apollo-server repo once AS4 is fully released) defines types that are pretty close to compatible with the AS3 types previously used here, but don't require a dependency on the entirety of AS3. This new package will be used by AS4 and AS4 will convert its data into the format described by these types. This change is entirely a build-time change (other than a slight change to how a enum is referenced). So the worst case scenario if this differs unintentionally from the original AS3 definitions is that users can apply a bit of `as any` to fix it. Note that we've removed some `<TContext>` from types that it turned out were only ever instantiated with `Record<string, any>` anyway. They are left in in RemoteGraphQLDataSource because users making their own data sources can explicitly specify their context type. The types in `@apollo/server-gateway-interface` are pretty close to the AS3 types (with different names) but there are some slight differences. The cache scope enum is replaced with `any`, as enums are not structurally typed and it is otherwise difficult to type them. `GatewayInterface` now expects `onSchemaLoadOrUpdate` to exist and doesn't mention the old `onSchemaChange`. For now, we leave `apollo-reporting-protobuf` alone, so we don't have a direct dependency on a prerelease.

Backport of #2044. Some tweaks for graphql@15 and Node 12 support. This removes the last dependency on Apollo Server from Apollo Gateway. Part of apollographql/apollo-server#6057 and apollographql/apollo-server#6719 The new package `@apollo/server-gateway-interface` (in the apollo-utils repo for now, though it should move to the apollo-server repo once AS4 is fully released) defines types that are pretty close to compatible with the AS3 types previously used here, but don't require a dependency on the entirety of AS3. This new package will be used by AS4 and AS4 will convert its data into the format described by these types. This change is entirely a build-time change (other than a slight change to how a enum is referenced). So the worst case scenario if this differs unintentionally from the original AS3 definitions is that users can apply a bit of `as any` to fix it. Note that we've removed some `<TContext>` from types that it turned out were only ever instantiated with `Record<string, any>` anyway. They are left in in RemoteGraphQLDataSource because users making their own data sources can explicitly specify their context type. The types in `@apollo/server-gateway-interface` are pretty close to the AS3 types (with different names) but there are some slight differences. The cache scope enum is replaced with `any`, as enums are not structurally typed and it is otherwise difficult to type them. `GatewayInterface` now expects `onSchemaLoadOrUpdate` to exist and doesn't mention the old `onSchemaChange`. For now, we leave `apollo-reporting-protobuf` alone, so we don't have a direct dependency on a prerelease.

This removes the last dependency on Apollo Server from Apollo Gateway. Part of apollographql/apollo-server#6057 and apollographql/apollo-server#6719 The new package `@apollo/server-gateway-interface` (in the apollo-utils repo for now, though it should move to the apollo-server repo once AS4 is fully released) defines types that are pretty close to compatible with the AS3 types previously used here, but don't require a dependency on the entirety of AS3. This new package will be used by AS4 and AS4 will convert its data into the format described by these types. This change is entirely a build-time change (other than a slight change to how a enum is referenced). So the worst case scenario if this differs unintentionally from the original AS3 definitions is that users can apply a bit of `as any` to fix it. Note that we've removed some `<TContext>` from types that it turned out were only ever instantiated with `Record<string, any>` anyway. They are left in in RemoteGraphQLDataSource because users making their own data sources can explicitly specify their context type. The types in `@apollo/server-gateway-interface` are pretty close to the AS3 types (with different names) but there are some slight differences. The cache scope enum is replaced with `any`, as enums are not structurally typed and it is otherwise difficult to type them. `GatewayInterface` now expects `onSchemaLoadOrUpdate` to exist and doesn't mention the old `onSchemaChange`. For now, we leave `apollo-reporting-protobuf` alone, so we don't have a direct dependency on a prerelease.

glasser force-pushed the glasser/server-gateway-interface branch from 3f0b29e to 25c7017 Compare August 8, 2022 21:40

glasser requested a review from trevor-scheer August 8, 2022 21:40

glasser commented Aug 8, 2022

View reviewed changes

trevor-scheer approved these changes Aug 8, 2022

View reviewed changes

glasser force-pushed the glasser/server-gateway-interface branch from 3ff0891 to 8b11d11 Compare August 8, 2022 23:32

glasser force-pushed the glasser/server-gateway-interface branch from 8b11d11 to effd384 Compare August 8, 2022 23:57

glasser marked this pull request as ready for review August 8, 2022 23:58

glasser mentioned this pull request Aug 8, 2022

V0: Change dependency on Apollo Server 3 to new type package #2050

Merged

glasser force-pushed the glasser/server-gateway-interface branch from effd384 to 9dc0438 Compare August 9, 2022 21:09

glasser merged commit 7ccaa89 into main Aug 9, 2022

glasser deleted the glasser/server-gateway-interface branch August 9, 2022 21:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change dependency on Apollo Server 3 to new type package #2044

Change dependency on Apollo Server 3 to new type package #2044

glasser commented Aug 6, 2022 •

edited

Loading

netlify bot commented Aug 6, 2022 •

edited

Loading

glasser commented Aug 6, 2022

codesandbox-ci bot commented Aug 6, 2022 •

edited

Loading

glasser Aug 8, 2022

glasser Aug 8, 2022

glasser Aug 8, 2022

trevor-scheer left a comment

trevor-scheer Aug 8, 2022

glasser Aug 8, 2022

glasser Aug 8, 2022

Change dependency on Apollo Server 3 to new type package #2044

Change dependency on Apollo Server 3 to new type package #2044

Conversation

glasser commented Aug 6, 2022 • edited Loading

netlify bot commented Aug 6, 2022 • edited Loading

✅ Deploy Preview for apollo-federation-docs canceled.

glasser commented Aug 6, 2022

codesandbox-ci bot commented Aug 6, 2022 • edited Loading

glasser Aug 8, 2022

Choose a reason for hiding this comment

glasser Aug 8, 2022

Choose a reason for hiding this comment

glasser Aug 8, 2022

Choose a reason for hiding this comment

trevor-scheer left a comment

Choose a reason for hiding this comment

trevor-scheer Aug 8, 2022

Choose a reason for hiding this comment

glasser Aug 8, 2022

Choose a reason for hiding this comment

glasser Aug 8, 2022

Choose a reason for hiding this comment

glasser commented Aug 6, 2022 •

edited

Loading

netlify bot commented Aug 6, 2022 •

edited

Loading

codesandbox-ci bot commented Aug 6, 2022 •

edited

Loading