FastifySession KnexStore

Currently tested with the following knex adapters

• postgres:
• sqlite3:
• mariadb|mysql2:

Knex session store for fastify.

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

• Relies on knex to interact with database of your choice.

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

Usage

npm install fastify-session-knex-store

npm install knex --save
# or
yarn add knex

Also you'll need to install knex adapter of your choice. Refer to Knex docs

import createFastify, { FastifyInstance, FastifyServerOptions } from 'fastify';
import fastifyCookie from 'fastify-cookie';
import KnexStore from 'fastify-session-knex-store';
import fastifySession from '@mgcrea/fastify-session';
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 KnexStore({ client: new Knex({
        client: 'postgresql', // or the other options supported by knex
        connection: {
            host: DB_HOST,
            port: DB_PORT,
            user: DB_USER,
            password: DB_PASSWORD,
            database: DB_DATABASE
        },
    }), ttl: SESSION_TTL }),
    secret: 'a secret with minimum length of 32 characters',
    cookie: { maxAge: SESSION_TTL },
  });

  return fastify;
};

Development

Testing

Tests run against a postgres database by default.

Default details is

• username: knex
• password: password
• database: fastify_session

so you'll need to configure a database where this works, or you can pass in any DATABASE_URL when running tests,

Running yarn test is equivalent to:

DATABASE_CLIENT=pg DATABASE_URL=postgresql://knex:password@localhost:5432/fastify_session

If you need to run with a different adapter, add the adapter to dev-dependencies

yarn add mysql2

and then configure a correct url for your adapter

DATABASE_CLIENT=mysql2 DATABASE_URL=mysql://USER:PASSWORD@localhost:3306/DATABASE_NAME?charset=utf8

Authors

• Christopher Kolstad <[email protected]>

Credits

• mcgrea/fastify-session-redis-store

License

The MIT License

Copyright (c) 2021 Christopher Kolstad <[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.