Merge pull request #1331 from MichalLytek/graphql-v16

Upgrade codebase to GraphQL v16

.github/workflows/main.yml

@@ -14,7 +14,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.13, 10.x, 11.x, 12.x, 13.x, 14.x, 15.x]
+        node-version: [14.x, 16.x, 18.x]
 
     steps:
       - uses: actions/checkout@v1

CHANGELOG.md

@@ -2,13 +2,9 @@
 
 ## Unreleased
 <!-- here goes all the unreleased changes descriptions -->
-### Fixes
-- support overwriting fields of extended types (#1109)
-- properly execute args validation for nullable items array (#1328)
-
-## v1.2.0-rc.1
 ### Features
 - **Breaking Change**: `AuthChecker` type is now "function or class" - update to `AuthCheckerFn` if the function form is needed in the code
+- **Breaking Change**: update `graphql-js` peer dependency to `^16.6.0`
 - support class-based auth checker, which allows for dependency injection
 - allow defining directives for interface types and theirs fields, with inheritance for object types fields (#744)
 - allow deprecating input fields and args (#794)
@@ -21,8 +17,11 @@
 - fix throwing error when schema with dynamic default value was built again (#787)
 - fix converting inputs with fields of nested array type (#801)
 - disable broken exposing input types fields under a changed name via `@Field({ name: "..." })`
+- support overwriting fields of extended types (#1109)
+- properly execute args validation for nullable items array (#1328)
 ### Others
-- **Breaking Change**: update `graphql-js` peer dependency to `^15.5.0`
+- **Breaking Change**: update `class-validator` peer dependency to `>=0.14.0`
+- **Breaking Change**: change build config to ES2019 - drop support for Node.js < 14.5
 
 ## v1.1.1
 ### Fixes

babel.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  presets: [["@babel/preset-env", { targets: { node: "current" } }], "@babel/preset-typescript"],
+  plugins: [
+    "babel-plugin-transform-typescript-metadata",
+    ["@babel/plugin-syntax-decorators", { legacy: true }],
+  ],
+};

docs/authorization.md

@@ -157,6 +157,8 @@ const server = new ApolloServer({
   },
 });
 
+await server.start();
+
 // Mount a jwt or other authentication middleware that is run before the GraphQL execution
 app.use(
   path,

docs/bootstrap.md

@@ -88,10 +88,7 @@ async function bootstrap() {
   // ... Building schema here
 
   // Create the GraphQL server
-  const server = new ApolloServer({
-    schema,
-    playground: true,
-  });
+  const server = new ApolloServer({ schema });
 
   // Start the server
   const { url } = await server.listen(PORT);

docs/complexity.md

@@ -41,8 +41,8 @@ async function bootstrap() {
     // Create a plugin that will allow for query complexity calculation for every request
     plugins: [
       {
-        requestDidStart: () => ({
-          didResolveOperation({ request, document }) {
+        requestDidStart: async () => ({
+          async didResolveOperation({ request, document }) {
             /**
              * This provides GraphQL query analysis to be able to react on complex queries to your GraphQL server.
              * This can be used to protect your GraphQL servers against resource exhaustion and DoS attacks.

docs/dependency-injection.md

@@ -122,7 +122,7 @@ const server = new ApolloServer({
 
 We also have to dispose the container after the request has been handled and the response is ready. Otherwise, there would be a huge memory leak as the new instances of services and resolvers have been created for each request but they haven't been cleaned up.
 
-Apollo Server since version 2.2.0 has a [plugins](https://www.apollographql.com/docs/apollo-server/integrations/plugins/) feature that supports [`willSendResponse`](https://www.apollographql.com/docs/apollo-server/integrations/plugins/#willsendresponse) lifecycle event. We can leverage it to clean up the container after handling the request.
+Apollo Server has a [plugins](https://www.apollographql.com/docs/apollo-server/integrations/plugins/) feature that supports [`willSendResponse`](https://www.apollographql.com/docs/apollo-server/integrations/plugins/#willsendresponse) lifecycle event. We can leverage it to clean up the container after handling the request.
 
 Example using `TypeDI` and `apollo-server` with plugins approach:
 
@@ -134,8 +134,8 @@ const server = new ApolloServer({
   // ... schema and context here
   plugins: [
     {
-      requestDidStart: () => ({
-        willSendResponse(requestContext) {
+      requestDidStart: async () => ({
+        async willSendResponse(requestContext) {
           // remember to dispose the scoped container to prevent memory leaks
           Container.reset(requestContext.context.requestId);
         },

docs/examples.md

@@ -41,7 +41,6 @@ All examples have an `examples.gql` file with sample queries/mutations/subscript
 - [Typegoose](https://github.com/MichalLytek/type-graphql/tree/master/examples/typegoose)
 - [Apollo federation](https://github.com/MichalLytek/type-graphql/tree/master/examples/apollo-federation)
 - [Apollo Cache Control](https://github.com/MichalLytek/type-graphql/tree/master/examples/apollo-cache)
-- [Apollo Client state](https://github.com/MichalLytek/type-graphql/tree/master/examples/apollo-client)
-- [GraphQL Modules](https://github.com/MichalLytek/type-graphql/tree/master/examples/graphql-modules)
+- [Apollo Client local state](https://github.com/MichalLytek/type-graphql/tree/master/examples/apollo-client)
 
 _\* Note that we need to edit the TypeORM example's `index.ts` with the credentials of our local database_

docs/installation.md

@@ -39,19 +39,19 @@ It's important to set these options in the `tsconfig.json` file of our project:
 }
 ```
 
-`TypeGraphQL` is designed to work with Node.js LTS (10.3+, 12+) and the latest stable releases. It uses features from ES2018 so we should set our `tsconfig.json` file appropriately:
+`TypeGraphQL` is designed to work with Node.js LTS and the latest stable releases. It uses features from ES2019 so we should set our `tsconfig.json` file appropriately:
 
 ```js
 {
-  "target": "es2018" // or newer if your node.js version supports this
+  "target": "es2019" // or newer if your node.js version supports this
 }
 ```
 
 Due to using the `graphql-subscription` dependency that relies on an `AsyncIterator`, we may also have to provide the `esnext.asynciterable` to the `lib` option:
 
 ```json
 {
-  "lib": ["es2018", "esnext.asynciterable"]
+  "lib": ["es2019", "esnext.asynciterable"]
 }
 ```
 
@@ -60,9 +60,9 @@ All in all, the minimal `tsconfig.json` file example looks like this:
 ```json
 {
   "compilerOptions": {
-    "target": "es2018",
+    "target": "es2019",
     "module": "commonjs",
-    "lib": ["es2018", "esnext.asynciterable"],
+    "lib": ["es2019", "esnext.asynciterable"],
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true
   }

docs/subscriptions.md

@@ -178,21 +178,8 @@ const schema = await buildSchema({
 
 The [bootstrap guide](bootstrap.md) and all the earlier examples used [`apollo-server`](https://github.com/apollographql/apollo-server) to create an HTTP endpoint for our GraphQL API.
 
-Fortunately, to make subscriptions work, we don't need to manually provide a transport layer that doesn't have constraints of HTTP and can do a push-based communication (WebSockets).
-The `apollo-server` package has built-in subscriptions support using websockets, so it works out of the box without any changes to our bootstrap config. However, if we want, we can provide the `subscriptions` property of the config object:
-
-```typescript
-// Create GraphQL server
-const server = new ApolloServer({
-  schema,
-  subscriptions: {
-    path: "/subscriptions",
-    // other options and hooks, like `onConnect`
-  },
-});
-```
-
-And it's done! We have a working GraphQL subscription server on `/subscriptions`, along with the normal HTTP GraphQL server.
+However, beginning in Apollo Server 3, subscriptions are not supported by the "batteries-included" apollo-server package. To enable subscriptions, you need to follow the guide on their docs page:
+https://www.apollographql.com/docs/apollo-server/data/subscriptions/#enabling-subscriptions
 
 ## Examples
 

examples/README.md

@@ -41,7 +41,6 @@ All examples has a `examples.gql` file with sample queries/mutations/subscriptio
 - [Typegoose](./typegoose)
 - [Apollo federation](./apollo-federation)
 - [Apollo Cache Control](./apollo-cache)
-- [Apollo Client state](./apollo-client)
-- [GraphQL Modules](./graphql-modules)
+- [Apollo Client local state](./apollo-client)
 
 _\* Note that you need to edit the TypeORM examples `index.ts` with credentials to your local database_

examples/apollo-cache/cache-control.ts

@@ -1,4 +1,4 @@
-import { CacheHint } from "apollo-cache-control";
+import type { CacheHint } from "apollo-server-types";
 import { Directive } from "../../src";
 
 export function CacheControl({ maxAge, scope }: CacheHint) {

examples/apollo-cache/index.ts

@@ -1,5 +1,6 @@
 import "reflect-metadata";
 import { ApolloServer } from "apollo-server";
+import { ApolloServerPluginCacheControl } from "apollo-server-core";
 import responseCachePlugin from "apollo-server-plugin-response-cache";
 import { buildSchema } from "../../src";
 
@@ -12,11 +13,12 @@ async function bootstrap() {
 
   const server = new ApolloServer({
     schema,
-    tracing: true,
-    // turn on cache headers
-    cacheControl: true,
-    // add in-memory cache plugin
-    plugins: [responseCachePlugin()],
+    plugins: [
+      // turn on cache headers
+      ApolloServerPluginCacheControl(),
+      // add in-memory cache plugin
+      responseCachePlugin(),
+    ],
   });
 
   const { url } = await server.listen(4000);

examples/apollo-client/.parcelrc

@@ -0,0 +1,8 @@
+{
+  "extends": "@parcel/config-default",
+  "transformers": {
+    "*.{ts,tsx}": [
+      "@parcel/transformer-typescript-tsc"
+    ]
+  }
+}