FastifySession RedisStore

Features

Redis session store for fastify.

• Requires @mgcrea/fastify-session to handle sessions.

• Relies on ioredis to interact with redis.

• Built with TypeScript for static type checking with exported types along the library.

Usage

npm install @mgcrea/fastify-session @mgcrea/fastify-session-redis-store
# or
pnpm add @mgcrea/fastify-session @mgcrea/fastify-session-redis-store

npm install ioredis --save; npm install @types/ioredis --save-dev
# or
pnpm add ioredis; pnpm add --save-dev @types/ioredis

import createFastify, { FastifyInstance, FastifyServerOptions } from "fastify";
import fastifyCookie from "fastify-cookie";
import RedisStore from "@mgcrea/fastify-session-redis-store";
import fastifySession from "@mgcrea/fastify-session";
import Redis from "ioredis";
import { IS_PROD, IS_TEST, REDIS_URI, SESSION_TTL } from "./config/env";

const SESSION_TTL = 864e3; // 1 day in seconds

export const buildFastify = (options?: FastifyServerOptions): FastifyInstance => {
  const fastify = createFastify(options);

  fastify.register(fastifyCookie);
  fastify.register(fastifySession, {
    store: new RedisStore({ client: new Redis(REDIS_URI), ttl: SESSION_TTL }),
    secret: "a secret with minimum length of 32 characters",
    cookie: { maxAge: SESSION_TTL },
  });

  return fastify;
};

Authors

• Olivier Louvignes <[email protected]>

Credits

• tj/connect-redis

License

The MIT License

Copyright (c) 2020 Olivier Louvignes <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.