feat: upgrade dependencies to support Apollo Server 3 and latest Apollo Gateway

Author: sjungling

@types/graphql-upload-extension/index.d.ts

@@ -2,7 +2,7 @@ import 'graphql-upload';
 
 declare module 'graphql-upload' {
   // eslint-disable-next-line import/prefer-default-export
-  export class Upload {
+  export interface Upload {
     promise: Promise<FileUpload>;
   }
 }

README.md

@@ -1,23 +1,23 @@
-# Apollo federation file upload
+# Apollo Federation file upload
 
 This library makes it easier to support file uploads to your federated
 micro-services. It uses the [Apollo](https://www.apollographql.com/docs/apollo-server/data/file-uploads/) server's solution.
-It works by simple redirecting the file uploaded stream to the micro-service.
-This package do not use third-party services to send the package to your
+It works by simply redirecting the file uploaded stream to the micro-service.
+This package does not use third-party services to send the package to your
 micro-services.
 
 ## Using HTTP Transfer-Encoding: chunked
 
-By default the FileUploadDataSource will use chunked transfers and we
-advice that you do not change this setup. However, for some reason
-you can't support this kind of transfer one can provide the `useChunkedTransfer`
-option to the `FileUploadDataSource` constructor as `false` to do not
-use chunked transfer (See the example below on how to set this property).
-Be advised once again, that this can lead to DDOS attacks.
+By default, the `FileUploadDataSource` uses chunked transfers; we
+advise that you do not change this setup. However, for some reason
+you can't support this kind of transfer, one can provide the `useChunkedTransfer`
+option to the `FileUploadDataSource` constructor as `false` to not
+use chunked transfer (See the example below on setting this property).
+Be advised once again that this can lead to DDOS attacks.
 
 ## Example
 
-On your Gateway you must add the FileUploadDataSource in order
+On your Gateway, you must add the `FileUploadDataSource` in order
 to the micro-service be able to receive the uploaded file(s).
 
 
@@ -34,8 +34,7 @@ const runServer = async () => {
       serviceList: [
         /* The services ... */
       ],
-    }),
-    subscriptions: false,
+    })
   });
 
   const { url } = await server.listen();

lib/FileUploadDataSource.ts

@@ -1,5 +1,8 @@
-import { RemoteGraphQLDataSource } from '@apollo/gateway';
-import { GraphQLResponse, GraphQLRequestContext } from 'apollo-server-types';
+import {
+  GraphQLDataSourceProcessOptions,
+  RemoteGraphQLDataSource,
+} from '@apollo/gateway';
+import { GraphQLResponse } from 'apollo-server-types';
 import { FileUpload, Upload } from 'graphql-upload';
 import { Request, Headers, Response } from 'apollo-server-env';
 import { isObject } from '@apollo/gateway/dist/utilities/predicates';
@@ -21,11 +24,6 @@ export type FileUploadDataSourceArgs = ConstructorArgs & {
   useChunkedTransfer?: boolean;
 };
 
-interface DataSourceArgs {
-  request: GraphQLRequestContext['request'];
-  context: GraphQLRequestContext['context'];
-}
-
 type AddDataHandler = (
   form: FormData,
   resolvedFiles: FileUpload[],
@@ -148,7 +146,9 @@ export default class FileUploadDataSource extends RemoteGraphQLDataSource {
       : addDataToForm;
   }
 
-  async process(args: DataSourceArgs): Promise<GraphQLResponse> {
+  async process(
+    args: GraphQLDataSourceProcessOptions,
+  ): Promise<GraphQLResponse> {
     const fileVariables = FileUploadDataSource.extractFileVariables(
       args.request.variables,
     );
@@ -159,7 +159,7 @@ export default class FileUploadDataSource extends RemoteGraphQLDataSource {
   }
 
   private async processFiles(
-    args: DataSourceArgs,
+    args: GraphQLDataSourceProcessOptions,
     fileVariables: FileVariablesTuple[],
   ): Promise<GraphQLResponse> {
     const { context, request } = args;
@@ -215,7 +215,7 @@ export default class FileUploadDataSource extends RemoteGraphQLDataSource {
     const options = {
       ...request.http,
       // Apollo types are not up-to-date, make TS happy
-      body: (form as unknown) as string,
+      body: form as unknown as string,
     };
 
     const httpRequest = new Request(request.http.url, options);
@@ -240,7 +240,7 @@ export default class FileUploadDataSource extends RemoteGraphQLDataSource {
 
       return response;
     } catch (error) {
-      this.didEncounterError(error, httpRequest, httpResponse);
+      this.didEncounterError(error as Error, httpRequest, httpResponse);
       throw error;
     }
   }

lib/FormData.ts

@@ -11,14 +11,14 @@ export default class FormData extends BaseFormData {
       if (err || !Number.isNaN(length)) {
         callback(err, length);
       } else {
-        callback(null, (null as unknown) as number);
+        callback(null, null as unknown as number);
       }
     };
     super.getLength(cb);
   }
 
   getLengthSync(): number {
     const len = super.getLengthSync();
-    return Number.isNaN(len) ? ((null as unknown) as number) : len;
+    return Number.isNaN(len) ? (null as unknown as number) : len;
   }
 }

package.json

@@ -22,10 +22,10 @@
     "lodash.set": "^4.3.2"
   },
   "peerDependencies": {
-    "@apollo/gateway": "^0.24.4",
-    "apollo-server-env": "^3.0.0",
-    "apollo-server-types": "^0.6.3",
-    "graphql-upload": "^11.0.0"
+    "@apollo/gateway": "^0.41.0",
+    "apollo-server-env": "^4.0.3",
+    "apollo-server-types": "^3.2.0",
+    "graphql-upload": "^12.0.0"
   },
   "husky": {
     "hooks": {
@@ -35,38 +35,38 @@
     }
   },
   "devDependencies": {
-    "@apollo/federation": "^0.22.0",
-    "@commitlint/cli": "^12.0.1",
-    "@commitlint/config-angular": "^12.0.1",
+    "@apollo/federation": "^0.32.0",
+    "@commitlint/cli": "^13.1.0",
+    "@commitlint/config-angular": "^13.1.0",
     "@istanbuljs/nyc-config-typescript": "^1.0.1",
-    "@types/graphql-upload": "^8.0.4",
+    "@types/graphql-upload": "^8.0.7",
     "@types/lodash.clonedeep": "^4.5.6",
     "@types/lodash.set": "^4.3.6",
-    "@types/newman": "^5.1.3",
-    "@types/node": "^14.14.33",
-    "@typescript-eslint/eslint-plugin": "^4.17.0",
-    "@typescript-eslint/parser": "^4.17.0",
-    "apollo-graphql": "^0.6.1",
-    "apollo-server-core": "^2.21.1",
-    "apollo-server-express": "^2.21.1",
+    "@types/newman": "^5.1.4",
+    "@types/node": "^16.9.1",
+    "@typescript-eslint/eslint-plugin": "^4.31.0",
+    "@typescript-eslint/parser": "^4.31.0",
+    "apollo-graphql": "^0.9.3",
+    "apollo-server-core": "^3.3.0",
+    "apollo-server-express": "^3.3.0",
     "dotenv-safe": "^8.2.0",
-    "eslint": "^7.21.0",
+    "eslint": "^7.32.0",
     "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-config-prettier": "^8.1.0",
+    "eslint-config-prettier": "^8.3.0",
     "eslint-import-resolver-typescript": "^2.4.0",
     "eslint-plugin-filenames": "^1.3.2",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-prettier": "^3.3.1",
-    "express": "^4.17.1",
-    "graphql": "^14.7.0",
-    "husky": "^4.3.8",
+    "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-prettier": "^4.0.0",
+    "express": "4.17.1",
+    "graphql": "^15.5.3",
+    "husky": "^7.0.0",
     "install-peers-cli": "^2.2.0",
-    "newman": "^5.2.2",
+    "newman": "^5.3.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
-    "prettier": "^2.2.1",
-    "source-map-support": "^0.5.19",
-    "ts-node": "^9.1.1",
+    "prettier": "^2.4.0",
+    "source-map-support": "^0.5.20",
+    "ts-node": "^10.2.1",
     "typescript": "^4.2.3"
   }
 }

test/gateway.ts

@@ -39,9 +39,8 @@ const gateway = async (): Promise<
   const server = new ApolloServer({
     gateway: apolloGateway,
     plugins: [ApolloServerPluginInlineTraceDisabled()],
-    subscriptions: false,
-    uploads: false,
   });
+  await server.start();
   server.applyMiddleware({ app, path: '/' });
 
   const expressServer = await new Promise<http.Server>(resolve => {

test/gen-service.ts

@@ -135,9 +135,8 @@ const genService = (
           typeDefs,
         },
       ]),
-      subscriptions: false,
-      uploads: false,
     });
+    await server.start();
     server.applyMiddleware({ app });
 
     const expressServer = await new Promise<http.Server>(resolve => {

tsconfig.json

@@ -19,7 +19,8 @@
     "strictPropertyInitialization": false,
     "declaration": true,
     "baseUrl": ".",
-    "outDir": "./build"
+    "outDir": "./build",
+    "skipLibCheck": true
   },
   "include": [
     "lib",