npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@oly_op/apollo-server-fastify

v0.9.0

Published

@oly_op/apollo-server-fastify

Downloads

2

Readme

NPM version NPM downloads

Apollo Server Fastify

Introduction

A community-maintained package for connecting Fastify to Apollo GraphQL server.

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

Requirements

Installation

npm install @oly_op/apollo-server-fastify @apollo/server graphql fastify

Usage

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

import Fastify from "fastify"
import { ApolloServer, BaseContext } from "@apollo/server"
import fastifyApollo, { fastifyApolloDrainPlugin } from "@oly_op/apollo-server-fastify"
// ...

const fastify = Fastify()

const apollo = new ApolloServer<BaseContext>({
  typeDefs,
  resolvers,
  plugins: [
    fastifyApolloDrainPlugin(fastify),
  ],
})

await apollo.start()

// ...

await fastify.register(fastifyApollo(apollo))

Alternatively you can use the exported function fastifyApolloHandler which can be passed into any Fastify route handler. This allows you to explicitly set all routing options, for example the URL path and accepted methods.

Examples shown below:

import { fastifyApolloHandler } from "@oly_op/apollo-server-fastify"

// ... setup Fastify & Apollo

fastify.post("/graphql", fastifyApolloHandler(apollo))

fastify.get("/api", fastifyApolloHandler(apollo))

fastify.route({
  url: "/graphql",
  method: ["GET", "POST", "OPTIONS"],
  handler: fastifyApolloHandler(apollo),
})

Please see the example.

Context

Apollo Server 4 (AS4) has moved context setup outside of the ApolloServer constructor.

Define you're own context function and pass it in to the context option. For example:

import { ApolloServer } from "@apollo/server"
import fastifyApollo, { fastifyApolloHandler, ApolloFastifyContextFunction } from "@oly_op/apollo-server-fastify"
// ...

interface MyContext {
  authorization: JWTPayload | false;
}

const apollo = new ApolloServer<MyContext>({ resolvers, typeDefs })

const myContextFunction: ApolloFastifyContextFunction<MyContext> = async request => ({
  authorization: await isAuthorized(request.headers.authorization),
})

await fastify.register(fastifyApollo(apollo), {
  context: myContextFunction,
})

// OR

await fastify.post("/graphql", fastifyApolloHandler(apollo, {
  context: myContextFunction,
}))

API

All options and generics are optional other than passing in the ApolloServer instance.

fastifyApollo

export default function fastifyApollo<Context extends BaseContext = BaseContext>(
  apollo: ApolloServer<Context>,
): FastifyPluginAsync<ApolloFastifyPluginOptions<Context>>;

fastifyApolloHandler

export function fastifyApolloHandler<Context extends BaseContext = BaseContext>(
  apollo: ApolloServer<Context>,
  options?: ApolloFastifyHandlerOptions<Context>,
): RouteHandlerMethod;

ApolloFastifyContextFunction

export type ApolloFastifyContextFunction<Context> =
  (request: FastifyRequest, reply: FastifyReply) => Promise<Context>;

ApolloFastifyPluginOptions:

  • path
    • type: string | undefined
    • default: "/graphql"
  • method
    • type: HTTPMethod | HTTPMethod[]
    • default: ["GET", "POST", "OPTIONS"]
  • context

HTTPMethod is exported from Fastify.

ApolloFastifyHandlerOptions:

HTTPS/HTTP2

All functions and types optionally allow you to pass in a Server type to Fastify (the default is http.Server).

Node.JS v14

Please pass in forceConnections: true to Fastify to correctly shutdown you're server on close and not hang incoming requests.

Contributors