hazelcast-store is a Hazelcast session store backed by hazelcast-client.
NOTE: This is a first pass, use at your own risk. I will be glad to accept pull requests to fix bugs or add new features.
Setup
npm install hazelcast-store express-session
Pass the express-session
store into hazelcast-store
to create a HazelcastStore
constructor, which then creates a new Store instance to pass to express sessions. Note: since the Hazelcast Client generation is asynchronous it's a little tricky to add early in the app.use() chain. See below for a method to add the HazelcastClient to the HazelcastStore after creation.
const session = require('express-session');
const HazelcastStore = require('hazelcast-store')(session);
const hzStore = new HazelcastStore({ ttl: 15*60*1000, debugPrefix: 'oc' });
app.use(session({ store: hzStore, secret: 'argle bargle' }));
Example implementation of Hazelcast Client and setting it on the HazelcastStore
const HazelcastClient = require('hazelcast-client').Client;
const HazelcastConfig = require('hazelcast-client').Config;
const clientConfig = new HazelcastConfig.ClientConfig();
clientConfig.networkConfig.addresses = [{host: '127.0.0.1', 5701}];
HazelcastClient.newHazelcastClient(clientConfig).then((hzInstance) => {
hazelcastStore.setClient(hzInstance);
});
Options
A full initialized Hazelcast Client is required. This client is either passed directly using the client
param or can be added after creating the HazelcastStore using the store.addClient() method. This method is probably the easiest because the code that creates an instance of the Hazelcast client is asynchronous.
The following additional params are optional:
ttl
Hazelcast session TTL (expiration) in milli-secondsdebugPrefix
prefix to use with debug module so this module's output can be seen with your app's debug outputdisableTTL
Disables setting TTL, keys will stay in Hazelcast until evicted by other means (overides ttl
)prefix
Key prefix defaulting to "sess:"logErrors
Whether or not to log client errors. (default: false
)
- If
true
, a default logging function (console.error
) is provided. - If a function, it is called anytime an error occurs (useful for custom logging)
- If
false
, no logging occurs.
TODO
- Custom serialization
- Possily implement touch() method. Is express-sessions even using it any more? Doesn't seem like it
- Implement clear(), all() and length()
- Handle hazelcast down/unreachable? (Most likely node will just throw an error)
License
MIT