[version-0.x] Fix TS issues with gateway 0.29+ in AS2 #1964

smyrick · 2022-07-06T19:34:26Z

If you use gateway version 0.29.0+ with Apollo Server 2 you will start relying on apollo-server-types both ^0.9.0 OR ^3.0.0. See code

apollo-server-types@0.9.0 -> AS2
apollo-server-types@3.0.0 -> AS3

federation/gateway-js/package.json

Line 41 in 7f5565a

"apollo-server-types": "^0.9.0 || ^3.0.0",

Normally in dependencies this would be ok, that we can use either version, however the underlying dependency apollo-server-env also has a major version change. We updated the GraphQLRequest.headers to instead defined in apollo-server-env to be the Headers from node-fetch. This was an unintentional "breaking change" that got populated. It appears to have no affect on runtime of most users but what it does break is Typescript compile steps. So if users have a tsc step they can't even use these versions together.

My fix is to instead have npm pull in the dependency of one or the other, we pull in both libs and define in the typed source code that the types themselves could be one or the other.

I believe we should also apply this fix to main if we want @apollo/gateway v2 to still work with AS2.

netlify · 2022-07-06T19:34:29Z

👷 Deploy request for apollo-federation-docs pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	`e1540c9`

codesandbox-ci · 2022-07-06T19:35:07Z

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.

smyrick · 2022-07-06T20:20:28Z

I could use some other eyes on this because I am not sure if this is still considered a major change since I did update the typing info in a lot of places

benweatherman

🐐

I believe we should also apply this fix to main if we want @apollo/gateway v2 to still work with AS2.

AS2 doesn't support graphql@16, and @apollo/gateway@2 requires it, so I think we're OK to keep this v0.x only.

As for breaking change or not, since these are mostly types my hunch is that they get compiled away. Any code that's working today should continue to work. We can check the built output to make sure the differences aren't breaking.

.gitignore

gateway-js/src/config.ts

smyrick · 2022-07-07T23:45:47Z

gateway-js/src/datasources/RemoteGraphQLDataSource.ts

@@ -116,11 +127,15 @@ export class RemoteGraphQLDataSource<
 // Special handling of cache-control headers in response. Requires
 // Apollo Server 3, so we check to make sure the method we want is
 // there.
+
+ // @ts-ignore
+ const cachePolicy = options.incomingRequestContext?.overallCachePolicy;


We need to ignore this because TS is complaining the field doesn't exist in types from AS2, which was hidden before.

benweatherman · 2022-07-08T00:20:46Z

Here's the diff of this code vs @apollo/gateway@0.51.0. It seems like mostly types, other than a few JS changes (which were changed in the typescript code, so they make sense).

Mind double-checking to make sure I didn't miss anything?

diff -bur --exclude '*.map' dist/config.d.ts dist-shane/config.d.ts
--- dist/config.d.ts	1985-10-26 03:15:00.000000000 -0500
+++ dist-shane/config.d.ts	2022-07-07 19:01:24.000000000 -0500
@@ -1,9 +1,8 @@
 import { GraphQLError, GraphQLSchema } from 'graphql';
 import { HeadersInit } from 'node-fetch';
-import { GraphQLRequestContextExecutionDidStart } from 'apollo-server-types';
 import type { Logger } from '@apollo/utils.logger';
 import { ServiceDefinition } from '@apollo/federation';
-import { GraphQLDataSource } from './datasources/types';
+import { GraphQLDataSource, GraphQLRequestContextExecutionDidStart } from './datasources/types';
 import { QueryPlan } from '@apollo/query-planner';
 import { OperationContext } from './operationContext';
 import { ServiceMap } from './executeQueryPlan';
diff -bur --exclude '*.map' dist/datasources/RemoteGraphQLDataSource.d.ts dist-shane/datasources/RemoteGraphQLDataSource.d.ts
--- dist/datasources/RemoteGraphQLDataSource.d.ts	1985-10-26 03:15:00.000000000 -0500
+++ dist-shane/datasources/RemoteGraphQLDataSource.d.ts	2022-07-07 19:01:24.000000000 -0500
@@ -1,8 +1,13 @@
-import { GraphQLRequestContext, GraphQLResponse, ValueOrPromise } from 'apollo-server-types';
+import { ValueOrPromise } from 'apollo-server-types';
 import { ApolloError } from 'apollo-server-errors';
-import { GraphQLDataSource, GraphQLDataSourceProcessOptions } from './types';
+import { GraphQLDataSource, GraphQLDataSourceProcessOptions, GraphQLRequest, GraphQLResponse } from './types';
 import { Request as NodeFetchRequest } from 'node-fetch';
 import { Fetcher, FetcherResponse } from '@apollo/utils.fetcher';
+export declare type RequiredGraphQLRequestContext<TContext> = {
+    request: GraphQLRequest;
+    response: GraphQLResponse;
+    context: TContext;
+};
 export declare class RemoteGraphQLDataSource<TContext extends Record<string, any> = Record<string, any>> implements GraphQLDataSource<TContext> {
     fetcher: Fetcher;
     constructor(config?: Partial<RemoteGraphQLDataSource<TContext>> & object & ThisType<RemoteGraphQLDataSource<TContext>>);
@@ -13,7 +18,7 @@
     private sendRequest;
     willSendRequest?(options: GraphQLDataSourceProcessOptions<TContext>): ValueOrPromise<void>;
     private respond;
-    didReceiveResponse?(requestContext: Required<Pick<GraphQLRequestContext<TContext>, 'request' | 'response' | 'context'>>): ValueOrPromise<GraphQLResponse>;
+    didReceiveResponse?(requestContext: RequiredGraphQLRequestContext<TContext>): ValueOrPromise<GraphQLResponse>;
     didEncounterError(error: Error, _fetchRequest: NodeFetchRequest, _fetchResponse?: FetcherResponse, _context?: TContext): void;
     parseBody(fetchResponse: FetcherResponse, _fetchRequest?: NodeFetchRequest, _context?: TContext): Promise<object | string>;
     errorFromResponse(response: FetcherResponse): Promise<ApolloError>;
diff -bur --exclude '*.map' dist/datasources/RemoteGraphQLDataSource.js dist-shane/datasources/RemoteGraphQLDataSource.js
--- dist/datasources/RemoteGraphQLDataSource.js	1985-10-26 03:15:00.000000000 -0500
+++ dist-shane/datasources/RemoteGraphQLDataSource.js	2022-07-07 19:01:24.000000000 -0500
@@ -4,7 +4,7 @@
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RemoteGraphQLDataSource = void 0;
-const apollo_server_types_1 = require("apollo-server-types");
+const apollo_server_types_3_1 = require("apollo-server-types-3");
 const apollo_server_errors_1 = require("apollo-server-errors");
 const predicates_1 = require("../utilities/predicates");
 const types_1 = require("./types");
@@ -47,10 +47,11 @@
             throw new Error('Missing query');
         }
         const { query, ...requestWithoutQuery } = request;
+        const cachePolicy = (_b = options.incomingRequestContext) === null || _b === void 0 ? void 0 : _b.overallCachePolicy;
         const overallCachePolicy = this.honorSubgraphCacheControlHeader &&
             options.kind === types_1.GraphQLDataSourceRequestKind.INCOMING_OPERATION &&
-            ((_b = options.incomingRequestContext.overallCachePolicy) === null || _b === void 0 ? void 0 : _b.restrict)
-            ? options.incomingRequestContext.overallCachePolicy
+            (cachePolicy === null || cachePolicy === void 0 ? void 0 : cachePolicy.restrict)
+            ? cachePolicy
             : null;
         if (this.apq) {
             const apqHash = (0, utils_createhash_1.createHash)('sha256').update(request.query).digest('hex');
@@ -129,10 +130,10 @@
                 hint.maxAge = +maxAge;
             }
             if (parsed['private'] === true) {
-                hint.scope = apollo_server_types_1.CacheScope.Private;
+                hint.scope = apollo_server_types_3_1.CacheScope.Private;
             }
             if (parsed['public'] === true) {
-                hint.scope = apollo_server_types_1.CacheScope.Public;
+                hint.scope = apollo_server_types_3_1.CacheScope.Public;
             }
             overallCachePolicy.restrict(hint);
         }
diff -bur --exclude '*.map' dist/datasources/types.d.ts dist-shane/datasources/types.d.ts
--- dist/datasources/types.d.ts	1985-10-26 03:15:00.000000000 -0500
+++ dist-shane/datasources/types.d.ts	2022-07-07 19:01:24.000000000 -0500
@@ -1,4 +1,9 @@
-import { GraphQLResponse, GraphQLRequestContext } from 'apollo-server-types';
+import { GraphQLRequest as GraphQLRequest1, GraphQLResponse as GraphQLResponse1, GraphQLRequestContext as GraphQLRequestContext1, GraphQLRequestContextExecutionDidStart as GraphQLRequestContextExecutionDidStart1 } from 'apollo-server-types';
+import { GraphQLRequest as GraphQLRequest3, GraphQLResponse as GraphQLResponse3, GraphQLRequestContext as GraphQLRequestContext3, GraphQLRequestContextExecutionDidStart as GraphQLRequestContextExecutionDidStart3 } from 'apollo-server-types-3';
+export declare type GraphQLRequest = GraphQLRequest1 | GraphQLRequest3;
+export declare type GraphQLResponse = GraphQLResponse1 | GraphQLResponse3;
+export declare type GraphQLRequestContext<TContext> = GraphQLRequestContext1<TContext> | GraphQLRequestContext3<TContext>;
+export declare type GraphQLRequestContextExecutionDidStart<TContext> = GraphQLRequestContextExecutionDidStart1<TContext> | GraphQLRequestContextExecutionDidStart3<TContext>;
 export interface GraphQLDataSource<TContext extends Record<string, any> = Record<string, any>> {
     process(options: GraphQLDataSourceProcessOptions<TContext>): Promise<GraphQLResponse>;
 }
@@ -8,7 +13,7 @@
     LOADING_SCHEMA = "loading schema"
 }
 export declare type GraphQLDataSourceProcessOptions<TContext extends Record<string, any> = Record<string, any>> = {
-    request: GraphQLRequestContext<TContext>['request'];
+    request: GraphQLRequest;
 } & ({
     kind: GraphQLDataSourceRequestKind.INCOMING_OPERATION;
     incomingRequestContext: GraphQLRequestContext<TContext>;
diff -bur --exclude '*.map' dist/executeQueryPlan.d.ts dist-shane/executeQueryPlan.d.ts
--- dist/executeQueryPlan.d.ts	1985-10-26 03:15:00.000000000 -0500
+++ dist-shane/executeQueryPlan.d.ts	2022-07-07 19:01:24.000000000 -0500
@@ -1,6 +1,6 @@
-import { GraphQLExecutionResult, GraphQLRequestContext, VariableValues } from 'apollo-server-types';
+import { GraphQLExecutionResult, VariableValues } from 'apollo-server-types';
 import { GraphQLFieldResolver } from 'graphql';
-import { GraphQLDataSource } from './datasources/types';
+import { GraphQLDataSource, GraphQLRequestContext } from './datasources/types';
 import { OperationContext } from './operationContext';
 import { FetchNode, QueryPlan } from '@apollo/query-planner';
 export declare type ServiceMap = {
diff -bur --exclude '*.map' dist/index.d.ts dist-shane/index.d.ts
--- dist/index.d.ts	1985-10-26 03:15:00.000000000 -0500
+++ dist-shane/index.d.ts	2022-07-07 19:01:24.000000000 -0500
@@ -1,9 +1,9 @@
 import { GraphQLService, Unsubscriber } from 'apollo-server-core';
-import { GraphQLExecutionResult, GraphQLRequestContextExecutionDidStart } from 'apollo-server-types';
+import { GraphQLExecutionResult } from 'apollo-server-types';
 import { GraphQLSchema } from 'graphql';
 import { buildOperationContext } from './operationContext';
 import { executeQueryPlan, ServiceMap } from './executeQueryPlan';
-import { GraphQLDataSource } from './datasources/types';
+import { GraphQLDataSource, GraphQLRequestContextExecutionDidStart } from './datasources/types';
 import { ServiceEndpointDefinition, Experimental_DidFailCompositionCallback, Experimental_DidResolveQueryPlanCallback, Experimental_DidUpdateSupergraphCallback, Experimental_UpdateComposition, CompositionInfo, GatewayConfig } from './config';
 import { IntrospectAndCompose, LocalCompose } from './supergraphManagers';
 declare type DataSourceMap = {
@@ -81,7 +81,7 @@
     private updateWithSchemaAndNotify;
     serviceHealthCheck(serviceMap?: DataSourceMap): Promise<{
         name: string;
-        response: import("apollo-server-types").GraphQLResponse;
+        response: import("./datasources/types").GraphQLResponse;
     }[]>;
     private serviceListFromSupergraphSdl;
     private serviceListFromComposedSchema;

smyrick · 2022-07-12T20:01:00Z

You can reproduce the error here running npm run compile

https://stackblitz.com/edit/apolloserver-2-with-gateway-45?file=README.md

I am pulling this setup and this PR package to test locally

smyrick · 2022-07-12T23:18:05Z

gateway-js/src/config.ts

- readonly requestContext: GraphQLRequestContextExecutionDidStart<
- Record<string, any>
- >;
+ readonly requestContext: GraphQLRequestContext<Record<string, any>>;


This is a change in type because we don't need the guarantee of the other fields here, only the request. Plus this now matches up with the other usages

This newer version has the optional field 'referencedFieldsByType' which was added in AS3 usage reporting

smyrick · 2022-07-19T18:08:41Z

I had to fix the types in make-fetch-happen first: DefinitelyTyped/DefinitelyTyped#61233

smyrick · 2022-08-15T19:00:36Z

This PR has drastically been affected by this PR: #2050

While using gateway 0.52.0 does not solve the TS issues with Apollo Server 2 the changes have become so big that I am going to completely open a new branch. The changes will be here for reference though

smyrick added 3 commits July 6, 2022 12:08

WIP: got headers error to show in source code

c26a053

Fix headers TS compatability

dbe78d0

Remove extra ts type info

2e847f6

smyrick added 2 commits July 7, 2022 14:53

Move union types to shared types.ts

327e785

Remove ide files from repo

37d9902

benweatherman approved these changes Jul 7, 2022

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

gateway-js/src/config.ts Outdated Show resolved Hide resolved

smyrick added 2 commits July 7, 2022 16:41

Reformat with prettier

7adb5a6

Remove adding .idea to gitignore

988a6a7

smyrick commented Jul 7, 2022

View reviewed changes

smyrick added 5 commits July 12, 2022 13:15

Add type definition to ApolloGateway.load()

5ceb743

Set load return type to match apollo-server interface

7979ae7

Include GraphQLExecutor in types which fails to compile

c7ad23d

Update type for requestContext

2708635

Move type def imports back to main package

71bfe50

smyrick commented Jul 12, 2022

View reviewed changes

smyrick added 7 commits July 14, 2022 12:37

Update @types/make-fetch-happen

7876037

Update types to compile, failing unit tests

627765c

Update tests to hard set generic

49cfe3a

Revert changes from RequestContext to RequestConctextDidStart

1e0654f

Revert as much as possible

0cf47b6

Update lock file, only failing reporting test

b4bfcad

Update protobuf imports to specfically support v3

e4b66fc

This newer version has the optional field 'referencedFieldsByType' which was added in AS3 usage reporting

smyrick added 2 commits July 19, 2022 12:18

Remove unneeded dep from federation-js

a205271

Make server-core import both deps

74dee0a

smyrick added 4 commits July 19, 2022 12:27

Add optional dep options

c29416b

Add octokit dep to fix node 12

b52bd45

Remove node 12 strict requirement

e33c928

Update idea folder for commit

e1540c9

smyrick closed this Aug 15, 2022

smyrick deleted the 0x-as2-typescript-fix branch August 15, 2022 19:00

smyrick mentioned this pull request Aug 17, 2022

Typescript does not compile with gateway 0.x and Apollo Server v2 #2077

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[version-0.x] Fix TS issues with gateway 0.29+ in AS2 #1964

[version-0.x] Fix TS issues with gateway 0.29+ in AS2 #1964

smyrick commented Jul 6, 2022 •

edited

Loading

netlify bot commented Jul 6, 2022 •

edited

Loading

codesandbox-ci bot commented Jul 6, 2022 •

edited

Loading

smyrick commented Jul 6, 2022

benweatherman left a comment •

edited

Loading

smyrick Jul 7, 2022

benweatherman commented Jul 8, 2022

smyrick commented Jul 12, 2022 •

edited

Loading

smyrick Jul 12, 2022

smyrick commented Jul 19, 2022

smyrick commented Aug 15, 2022 •

edited

Loading

[version-0.x] Fix TS issues with gateway 0.29+ in AS2 #1964

[version-0.x] Fix TS issues with gateway 0.29+ in AS2 #1964

Conversation

smyrick commented Jul 6, 2022 • edited Loading

netlify bot commented Jul 6, 2022 • edited Loading

👷 Deploy request for apollo-federation-docs pending review.

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

smyrick commented Jul 6, 2022

benweatherman left a comment • edited Loading

Choose a reason for hiding this comment

smyrick Jul 7, 2022

Choose a reason for hiding this comment

benweatherman commented Jul 8, 2022

smyrick commented Jul 12, 2022 • edited Loading

smyrick Jul 12, 2022

Choose a reason for hiding this comment

smyrick commented Jul 19, 2022

smyrick commented Aug 15, 2022 • edited Loading

smyrick commented Jul 6, 2022 •

edited

Loading

netlify bot commented Jul 6, 2022 •

edited

Loading

codesandbox-ci bot commented Jul 6, 2022 •

edited

Loading

benweatherman left a comment •

edited

Loading

smyrick commented Jul 12, 2022 •

edited

Loading

smyrick commented Aug 15, 2022 •

edited

Loading