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

135 lines
3.6 KiB
TypeScript
Raw Normal View History

import * as hapi from 'hapi';
import { createServer, Server as HttpServer } from 'http';
import { ApolloServerBase, EngineLauncherOptions } from 'apollo-server-core';
import { parseAll } from 'accept';
import { renderPlaygroundPage } from 'graphql-playground-html';
import { graphqlHapi } from './hapiApollo';
export interface ServerRegistration {
app?: hapi.Server;
//The options type should exclude port
options?: hapi.ServerOptions;
server: ApolloServerBase<hapi.Request>;
path?: string;
cors?: boolean;
}
export interface HapiListenOptions {
port?: number | string;
host?: string; // default: ''. This is where engineproxy listens.
pipePath?: string;
graphqlPaths?: string[]; // default: ['/graphql']
innerHost?: string; // default: '127.0.0.1'. This is where Node listens.
launcherOptions?: EngineLauncherOptions;
}
export const registerServer = async ({
app,
options,
server,
cors,
path,
}: ServerRegistration) => {
if (!path) path = '/graphql';
let hapiApp: hapi.Server;
if (app) {
hapiApp = app;
if (options) {
console.warn(`A Hapi Server was passed in, so the options are ignored`);
}
} else if (options) {
if ((options as any).port) {
throw new Error(`
The options for registerServer should not include a port, since autoListen is set to false. Please set the port under the http options in listen:
const server = new ApolloServer({ typeDefs, resolvers });
registerServer({
server,
options,
});
server.listen({ http: { port: YOUR_PORT_HERE } });
`);
}
hapiApp = new hapi.Server({ ...options, autoListen: false });
} else {
hapiApp = new hapi.Server({ autoListen: false });
}
await hapiApp.ext({
type: 'onRequest',
method: function(request, h) {
if (request.path !== path) {
return h.continue;
}
if (!server.disableTools && request.method === 'get') {
//perform more expensive content-type check only if necessary
const accept = parseAll(request.headers);
const types = accept.mediaTypes as string[];
const prefersHTML =
types.find(
(x: string) => x === 'text/html' || x === 'application/json',
) === 'text/html';
if (prefersHTML) {
return h
.response(
renderPlaygroundPage({
subscriptionsEndpoint: server.subscriptionsPath,
endpoint: path,
version: '1.4.0',
}),
)
.type('text/html')
.takeover();
}
}
return h.continue;
},
});
await hapiApp.register({
plugin: graphqlHapi,
options: {
path: path,
graphqlOptions: server.request.bind(server),
route: {
cors: typeof cors === 'boolean' ? cors : true,
},
},
});
server.use({ path, getHttp: () => hapiApp.listener });
const listen = server.listen.bind(server);
server.listen = async options => {
//requires that autoListen is false, so that
//hapi sets up app.listener without start
await hapiApp.start();
//While this is not strictly necessary, it ensures that apollo server calls
//listen first, setting the port. Otherwise the hapi server constructor
//sets the port
if (hapiApp.listener.listening) {
throw Error(
`
Ensure that constructor of Hapi server sets autoListen to false, as follows:
const app = Hapi.server({
autoListen: false,
//other parameters
});
`,
);
}
//starts the hapi listener at a random port when engine proxy used,
//otherwise will start the server at the provided port
return listen({ ...options });
};
};