Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hendrysadrak/firestore-store
express-session store for Firebase Cloud Firestore
https://github.com/hendrysadrak/firestore-store
connect express express-session expressjs firebase firestore firestore-store nodejs
Last synced: 4 days ago
JSON representation
express-session store for Firebase Cloud Firestore
- Host: GitHub
- URL: https://github.com/hendrysadrak/firestore-store
- Owner: hendrysadrak
- License: mit
- Created: 2018-03-14T08:22:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-11T11:49:11.000Z (11 months ago)
- Last Synced: 2024-10-28T12:15:51.838Z (17 days ago)
- Topics: connect, express, express-session, expressjs, firebase, firestore, firestore-store, nodejs
- Language: JavaScript
- Homepage: https://npm.im/firestore-store
- Size: 680 KB
- Stars: 48
- Watchers: 5
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# firestore-store [](https://travis-ci.org/hendrysadrak/firestore-store)
**Firestore session store for Express.js / Connect.**
Source of this library is written in **ES6** but commonjs exports are used. If you have any problems or questions let me know in [issues](https://github.com/hendrysadrak/firestore-store/issues).
- [Installation](#installation)
- [Usage](#usage-with-expressjs--connect)
- [Options](#options)
- [Compatibility](#compatibility)
- [Changelog](https://github.com/hendrysadrak/firestore-store/releases)
- [Examples](/examples)
- [Support](#support)
- [License](#license)
## Installation
`firebase-admin` is a required peer dependency for `firestore-store`.
```bash
npm install firebase-admin firestore-store --save
```
## Usage with Express.js / Connect
Initialize `firebase-admin` firestore database.
```javascript
const admin = require("firebase-admin");
const firebase = admin.initializeApp({
credential: admin.credential.cert("path/to/serviceAccountCredentials.json"),
databaseURL: "https://.firebaseio.com",
});
const database = firebase.firestore();
```
Pass `express-session` to `firestore-store`
```javascript
const session = require("express-session");
const FirestoreStore = require("firestore-store")(session);
```
Pass database reference to the FirestoreStore.
```javascript
express() // or connect
.use(
session({
store: new FirestoreStore({
database: database,
}),
secret: "keyboard cat",
resave: true,
saveUninitialized: true,
})
);
```
## Usage in Cloud Functions or Cloud Run
When using Firebase Hosting together with Cloud Functions or Cloud Run, cookies are stripped from incoming requests. This would normally prevent the session lookup mechanism from working. However, when using `__session` as the name, the value will be passed through to the app.
```javascript
express() // or connect
.use(
session({
store: new FirestoreStore({
database: database,
}),
name: "__session", // ← required for Cloud Functions / Cloud Run
secret: "keyboard cat",
resave: true,
saveUninitialized: true,
})
);
```
Refer to [Using Cookies in the Firebase Documentation on Caching](https://firebase.google.com/docs/hosting/manage-cache#using_cookies)
## Options
```javascript
const store = new FirestoreStore(options);
```
#### options.database (required)
Firestore reference.
#### options.collection (default: 'sessions', optional)
Collection name to use for sessions.
#### options.parser (default: DocParser, optional)
Parser used to save or read session info from session document. If you need custom functionality or want to add more properties you can implement such a parser yourself. Required is to have `read` and `save` methods. Check default parser [DocParser](lib/doc-parser.js)
##### Example of a custom parser adding `dateModified` field:
```javascript
const parser = {
read(doc) {
return JSON.parse(doc.session);
},
save(doc) {
return {
session: JSON.stringify(doc),
dateModified: Date.now(),
};
},
};
const store = new FirestoreStore({ parser });
```
##### Example of a custom parser storing the session in the firestore without stringifying:
> https://github.com/hendrysadrak/firestore-store/issues/57#issue-718419725
```javascript
const parser = {
read(doc) {
return doc;
},
save(doc) {
return JSON.parse(JSON.stringify(doc));
},
};
const store = new FirestoreStore({ parser });
```
## Compatibility
This store implements all the **required, recommended and optional** [methods](https://github.com/expressjs/session#session-store-implementation) of the express-session store.
Currently tested with node.js version 10, 12 & 14. Travis is used for running tests https://travis-ci.org/hendrysadrak/firestore-store
## Support
If you have any problems or questions let me know in [issues](https://github.com/hendrysadrak/firestore-store/issues).
If you see it as a useful library star :star: it on [Github](https://github.com/hendrysadrak/firestore-store) so I know to put more time into supporting it.
## License
MIT License