connect-session-firebase

Connect Session Firebase

connect-session-firebase is a Connect/Express compatible session store backed by the Firebase SDK.

It is a fork of connect-firebase by ca98am79 due to incompatibility with the latest version of Firebase. The dependency version and package version will match the latest major.minor version of Firebase.

Installation

firebase must be added as a peer dependency, or you're gonna have a bad time. connect-session-firebase expects a matching major.minor version of Firebase.

$ npm install firebase connect-session-firebase --save

Options

• database A pre-initialized Firebase Database app instance.
• sessions (optional) A child reference string for session storage. (defaults to "sessions")
• reapInterval (optional) how often expired sessions should be cleaned up (defaults to 21600000) (6 hours in milliseconds)

Usage

• Connect

const connect = require('connect');
const FirebaseStore = require('connect-session-firebase')(connect);
const firebase = require('firebase');
const ref = firebase.initializeApp({
  serviceAccount: 'path/to/serviceAccountCredentials.json',
  databaseURL: 'https://databaseName.firebaseio.com'
});

connect()
  .use(connect.cookieParser())
  .use(connect.session({
    store: new FirebaseStore({
      database: ref.database()
    }),
    secret: 'keyboard cat'
  }));

• Express

  NOTE: In Express 4 express-session must be passed to the function connect-session-firebase exports in order to extend express-session.Store:

const express = require('express');
const session = require('express-session');
const FirebaseStore = require('connect-session-firebase')(session);
const firebase = require('firebase');
const ref = firebase.initializeApp({
  serviceAccount: 'path/to/serviceAccountCredentials.json',
  databaseURL: 'https://databaseName.firebaseio.com'
});

express()
  .use(session({
    store: new FirebaseStore({
      database: ref.database()
    }),
    secret: 'keyboard cat'
    resave: true,
    saveUninitialized: true
  }));

Tests

To run tests against connect-session-firebase you will need your own Firebase Database available. With 3.0.0, connecting to the database requires a serviceAccount object which is provisioned in a JSON file through the Firebase IAM & Admin Console. From 3.1.0, serviceAccount is optional for unauthenticated access.

Checkout the repo locally and create two files in the project root:

• .env
• serviceAccountCredentials.json

With the content:

.env

FIREBASE_SERVICE_ACCOUNT=./serviceAccountCredentials.json
FIREBASE_DATABASE_URL=https://[databaseName].firebaseio.com

serviceAccountCredentials.json

{
  "type": "service_account",
  "project_id": "",
  "private_key_id": "",
  "private_key": "",
  "client_email": "",
  "client_id": "",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "token_uri": "https://accounts.google.com/o/oauth2/token",
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
  "client_x509_cert_url": ""
}

Install the dev dependencies:

$ npm install

Run the tests:

$ npm test

License

connect-session-firebase is licensed under the MIT license.