README.md

Apollo Server Integration for Hapi

Introduction

An Apollo Server integration for use with Hapi.

This is a simple package that easily allows you to connect your own Hapi server implementation to an Apollo Server instance.

Requirements

• Node.js v16 or later
• Hapi v20.x or later
• GraphQL.js v16 or later
• Apollo Server v4 or later

Installation

npm install @as-integrations/hapi @apollo/server graphql @hapi/hapi

Usage

Setup Hapi & Apollo Server like you usually would and then connect the two by using the hapiApollo plugin:

import { Server } from '@hapi/hapi';
import { ApolloServer, BaseContext } from "@apollo/server";
import hapiApollo from "@as-integrations/hapi";
// ...

// create the apollo server instance and start it
const apolloServer = new ApolloServer<BaseContext>({
  typeDefs,
  resolvers,
});

await apolloServer.start();

// create the hapi server
const hapi = new Server({
  host: 'localhost',
  port: 5000
});

// ...

// register the plugin with the hapi server and provide the apollo instance in plugin config
await hapi.register({
  plugin: hapiApollo,
  options: {
    apolloServer,
    path: '/graphql'
  }
});

await hapi.start();

Note: You must call and await apollo.start() before using the integration.

ES5 Usage

If you are using ES5 or are otherwise using require() to use this module, you may need reference the default export like so:

const hapiApollo = require("@as-integrations/hapi").default;

Context

Apollo Server v4 has moved context setup outside of the ApolloServer constructor.

Define you're own context function and pass it in to the context option for the plugin.

For example:

await hapi.register({
  plugin: hapiPlugin,
  options: {
    context: async ({ request }) => ({
      token: request.headers.token
    }),
    apolloServer
  }
});

Route Configuration

Additional configuration for Hapi routes that are created by this module can be passed via getRoute (get / options routes) or postRoute (post route). Both support options, rules, and vhost configuration.

For example, to add a max upload size to the post route:

await hapi.register({
  plugin: hapiPlugin,
  options: {
    context: async ({ request }) => ({
      token: request.headers.token
    }),
    apolloServer,
    postRoute: {
      options: {
        payload: {
          maxBytes: 1024
        }
      }
    }
  }
});

Contributors

• David Castro (arimus)
• Trevor Scheer (trevor-scheer)
• GeekOffice (GeekOffice)