graphiql > gui and make content-type check only if necessary

packages/apollo-server/src/express.ts

@@ -3,7 +3,7 @@ import * as cors from 'cors';
 import { json } from 'body-parser';
 import { createServer, Server as HttpServer } from 'http';
 import { graphqlExpress } from 'apollo-server-express';
-import graphiql from 'graphql-playground-middleware-express';
+import gui from 'graphql-playground-middleware-express';
 import * as accepts from 'accepts';
 
 import { ApolloServerBase } from './utils/ApolloServer';
@@ -22,21 +22,21 @@ export class ApolloServer extends ApolloServerBase<
     const path = config.path || '/graphql';
 
     app.use(path, cors(config.cors), json(), (req, res, next) => {
-      // only show graphiql if we want html for a GET
-      const accept = accepts(req);
-      const types = accept.types() as string[];
-      const isHTML =
-        types.find(
-          (x: string) => x === 'text/html' || x === 'application/json',
-        ) === 'text/html';
+      if (config.gui !== false && req.method === 'GET') {
+        //perform more expensive content-type check only if necessary
+        const accept = accepts(req);
+        const types = accept.types() as string[];
+        const prefersHTML =
+          types.find(
+            (x: string) => x === 'text/html' || x === 'application/json',
+          ) === 'text/html';
 
-      // make sure we check to see if graphiql should be on
-      // change opts.graphiql type to be boolean
-      if (config.graphiql !== false && req.method === 'GET' && isHTML) {
-        return graphiql({
-          endpoint: path,
-          subscriptionsEndpoint: config.subscriptions && path,
-        })(req, res, next);
+        if (prefersHTML) {
+          return gui({
+            endpoint: path,
+            subscriptionsEndpoint: config.subscriptions && path,
+          })(req, res, next);
+        }
       }
       return graphqlExpress(request)(req, res, next);
     });

packages/apollo-server/src/koa.ts

@@ -6,7 +6,7 @@ import * as accepts from 'accepts';
 
 import { createServer, Server as HttpServer } from 'http';
 import { graphqlKoa } from 'apollo-server-koa';
-import graphiql from 'graphql-playground-middleware-koa';
+import gui from 'graphql-playground-middleware-koa';
 
 import { ApolloServerBase } from './utils/ApolloServer';
 import { MiddlewareRegistrationOptions } from './utils/types';
@@ -28,20 +28,22 @@ export class ApolloServer extends ApolloServerBase<
     router.use(path, cors(config.cors));
     router.use(path, koaBody());
     router.all(path, async (ctx, next) => {
-      const accept = accepts(ctx.req);
-      const types = accept.types() as string[];
-      const isHTML =
-        types.find(
-          (x: string) => x === 'text/html' || x === 'application/json',
-        ) === 'text/html';
+      // make sure we check to see if graphql gui should be on
+      if (config.gui !== false && ctx.req.method === 'GET') {
+        //perform more expensive content-type check only if necessary
+        const accept = accepts(ctx.req);
+        const types = accept.types() as string[];
+        const prefersHTML =
+          types.find(
+            (x: string) => x === 'text/html' || x === 'application/json',
+          ) === 'text/html';
 
-      // make sure we check to see if graphiql should be on
-      // change opts.graphiql type to be boolean
-      if (config.graphiql !== false && ctx.req.method === 'GET' && isHTML) {
-        return graphiql({
-          endpoint: path,
-          subscriptionsEndpoint: config.subscriptions && path,
-        })(ctx, next);
+        if (prefersHTML) {
+          return gui({
+            endpoint: path,
+            subscriptionsEndpoint: config.subscriptions && path,
+          })(ctx, next);
+        }
       }
       return graphqlKoa(request)(ctx, next);
     });

packages/apollo-server/src/utils/ApolloServer.ts

@@ -92,7 +92,7 @@ export class ApolloServerBase<
       ...requestOptions
     } = config;
 
-    // if this is local dev, we want graphiql and introspection to be turned on
+    // if this is local dev, we want graphql gui and introspection to be turned on
     // in production, you can manually turn these on by passing { enableIntrospection: true }
     // to the constructor of ApolloServer
     // we use this.disableTools to track this internally for later use when
@@ -186,7 +186,7 @@ export class ApolloServerBase<
       cors: this.cors,
       subscriptions: true,
       ...opts,
-      graphiql: opts.graphiql && !this.disableTools,
+      gui: opts.gui && !this.disableTools,
       app: this.app,
       request: this.request.bind(this),
     };

packages/apollo-server/src/utils/types.ts

@@ -76,7 +76,7 @@ export interface ListenOptions {
 
 export interface MiddlewareOptions {
   path?: string;
-  graphiql?: boolean;
+  gui?: boolean;
   subscriptions?: boolean;
 }
 
@@ -86,7 +86,7 @@ export interface MiddlewareRegistrationOptions<
   Cors = CorsOptions
 > {
   path?: string;
-  graphiql?: boolean;
+  gui?: boolean;
   subscriptions?: boolean;
   cors?: Cors;
   app: Server;