项目作者: benweier

项目描述 :
A Connect/Express session store powered by the Firebase Cloud Firestore.
高级语言: JavaScript
项目地址: git://github.com/benweier/connect-session-firestore.git
创建时间: 2018-03-14T07:57:05Z
项目社区:https://github.com/benweier/connect-session-firestore

开源协议:MIT License

下载


Connect Session Firestore

Travis
Codecov
Greenkeeper badge

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

Installation

firebase-admin must be added as a peer dependency, or you’re gonna have a bad time.

  1. $ npm install firebase-admin connect-session-firestore --save

Options

  • database A pre-initialized Firebase Cloud Firestore app.
  • sessions (optional) A document 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)
  • reapCallback (optional) A callback function to execute whenever a session clean up occurs

Usage

Initialize firebase-admin database and pass the instance to FirestoreStore. Connecting to the database requires a credential cert via a JSON file from the Firebase IAM & Admin Console.

  1. const connect = require('connect');
  2. const FirestoreStore = require('connect-session-firestore')(connect);
  3. const firebase = require('firebase-admin');
  4. const ref = firebase.initializeApp({
  5. credential: firebase.credential.cert('path/to/serviceAccountCredentials.json'),
  6. databaseURL: 'https://databaseName.firebaseio.com'
  7. });
  8. connect()
  9. .use(connect.cookieParser())
  10. .use(connect.session({
  11. store: new FirestoreStore({
  12. database: ref.firestore()
  13. }),
  14. secret: 'keyboard cat'
  15. }));
  • Express

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

  1. const express = require('express');
  2. const session = require('express-session');
  3. const FirestoreStore = require('connect-session-firestore')(session);
  4. const firebase = require('firebase-admin');
  5. const ref = firebase.initializeApp({
  6. credential: firebase.credential.cert('path/to/serviceAccountCredentials.json'),
  7. databaseURL: 'https://databaseName.firebaseio.com'
  8. });
  9. express()
  10. .use(session({
  11. store: new FirestoreStore({
  12. database: ref.firestore()
  13. }),
  14. secret: 'keyboard cat'
  15. resave: true,
  16. saveUninitialized: true
  17. }));

Tests

To run tests against connect-session-firestore you will need your own Firebase Database app available.

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

  • .env
  • serviceAccountCredentials.json

With the content:

.env

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

serviceAccountCredentials.json

  1. {
  2. "type": "service_account",
  3. "project_id": "",
  4. "private_key_id": "",
  5. "private_key": "",
  6. "client_email": "",
  7. "client_id": "",
  8. "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  9. "token_uri": "https://accounts.google.com/o/oauth2/token",
  10. "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
  11. "client_x509_cert_url": ""
  12. }

Install the dev dependencies:

  1. $ npm install

Run the tests:

  1. $ npm test

License

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