apollo-server/packages/apollo-server-hapi
Evans Hauser 65d7b100e4
CDN cache-control headers (#1138)
* core: return response object from runHttpQuery

* core: change gqlResponse to graphqlResponse and add custom RequestInit type

* core: add cache-control headers based on the calcualted maxAge

* core: add extensions check during cache-control header creation

* core: create headers when cacheControl is not enabled otherwise pass through extensions

* express: initial tests of CDN cach-contol headers

* core: fixed tests with applyMiddleware and pass cacheControl config

* core: cache hint fixes, ignore when no maxAge, and check for rootKeys

* core: check for hints of length 0

* core: node 10 fails file upload test for some stream reason

* docs: add cdn caching section to features

* add space after // in comments

* fix feedback: proxy alignment and response creation

Adds cache-control toggles for http header calculation and stripping out
the cache control extensions from the respose.

Brings the default calculation of headers in line with the proxy.

* fix links in comments

* fix tests with null dereference

* update cdn docs and migration guide to include latest cdn configuration

* add not for engine migration to set engine to false

* add engine set to false in migration guide

* express: fixed tests

* address feedback to use omit and documentation

* docs: cdn caching is alternative to full response caching

* add back epipe check in upload tests
2018-06-21 13:29:14 -07:00
..
src CDN cache-control headers (#1138) 2018-06-21 13:29:14 -07:00
.npmignore include readme for npm packages 2017-10-23 15:13:31 -07:00
package.json v2.0.0-rc.0 2018-06-14 23:18:07 -07:00
README.md Remove packages for frameworks that don't yet support 2.0 2018-06-13 13:45:10 -07:00
tsconfig.json Specify full path in tsconfig imports 2018-06-14 11:57:30 -07:00

title description
Hapi Setting up Apollo Server with Hapi

npm version Build Status Coverage Status Get on Slack

This is the Hapi integration of Apollo Server. Apollo Server is a community-maintained open-source Apollo Server that works with many Node.js HTTP server frameworks. Read the docs. Read the CHANGELOG.

npm install apollo-server-hapi@beta

Usage

After constructing Apollo server, a hapi server can be enabled with a call to registerServer. Ensure that autoListen is set to false in the Hapi.server constructor.

The code below requires Hapi 17 or higher.

const { registerServer, ApolloServer, gql } = require('apollo-server-hapi');

const HOST = 'localhost';

const typeDefs = gql`
  type Query {
    hello: String
  }
`;

const resolvers = {
  Query: {
    hello: () => 'hello',
  },
}

async function StartServer() {
  const server = new ApolloServer({ typeDefs, resolvers });

  await registerServer({
    server,
    //Hapi Server constructor options
    options: {
      host: HOST,
    },
  });

  server.listen().then(({ url }) => {
    console.log(`🚀  Server ready at ${url}`);
  });
}

StartServer().catch(error => console.log(error));

For more advanced use cases or migrating from 1.x, a Hapi server can be constructed and passed into registerServer.

const { ApolloServer, gql, registerServer } = require('apollo-server-hapi');
const Hapi = require('hapi');

async function StartServer() {
  const server = new ApolloServer({ typeDefs, resolvers });

  const app = new Hapi.server({
    //autoListen must be set to false, since Apollo Server will setup the listener
    autoListen: false,
    host: HOST,
  });

  await registerServer({
    server,
    app,
  });

  server.listen().then(({ url }) => {
    console.log(`🚀  Server ready at ${url}`);
  });
}

StartServer().catch(error => console.log(error));

Context

The context is created for each request. The following code snippet shows the creation of a context. The arguments are the request, the request, and h, the response toolkit.

new ApolloServer({
  typeDefs,
  resolvers,
  context: async ({ request, h }) => {
    return { ... };
  },
})

Principles

Apollo Server is built with the following principles in mind:

  • By the community, for the community: Apollo Server's development is driven by the needs of developers
  • Simplicity: by keeping things simple, Apollo Server is easier to use, easier to contribute to, and more secure
  • Performance: Apollo Server is well-tested and production-ready - no modifications needed

Anyone is welcome to contribute to Apollo Server, just read CONTRIBUTING.md, take a look at the roadmap and make your first PR!