Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

connect-session-knex

Package Overview
Dependencies
Maintainers
1
Versions
49
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

connect-session-knex - npm Package Compare versions

Comparing version 1.5.0 to 1.6.0

893

index.js

@@ -1,3 +0,5 @@

'use strict';
var util = require('util');
"use strict";
var Bluebird = require("bluebird");
var resolve = Bluebird.resolve;
var util = require("util");

@@ -7,425 +9,528 @@ var oneDay = 86400000;

module.exports = function(connect) {
/**
* Connect's Store.
*/
var Store = connect.session ? connect.session.Store : connect.Store;
/**
* Connect's Store.
*/
var Store = (connect.session) ? connect.session.Store : connect.Store;
/*
* Return datastore appropriate string of the current time
* @api private
* @return {String | date}
*/
function dateAsISO(knex, aDate) {
var date;
if (aDate != null) {
date = new Date(aDate);
} else {
date = new Date();
}
if (isOracle(knex)) {
return date;
}
return isMySQL(knex) || isMSSQL(knex)
? date
.toISOString()
.slice(0, 19)
.replace("T", " ")
: date.toISOString();
}
/*
* Return datastore appropriate string of the current time
* @api private
* @return {String | date}
*/
function dateAsISO(knex, aDate) {
var date;
if (aDate != null) {
date = new Date(aDate);
} else {
date = new Date();
}
if(isOracle(knex)){
return date;
}
return isMySQL(knex) || isMSSQL(knex) ? date.toISOString().slice(0, 19).replace('T', ' ') : date.toISOString();
}
/*
* Return dialect-aware type name for timestamp
* @return {String} type name for timestamp
* @api private
*/
function timestampTypeName(knex) {
return isMySQL(knex) || isMSSQL(knex)
? "DATETIME"
: isPostgres(knex)
? "timestamp with time zone"
: "timestamp";
}
/*
* Return dialect-aware type name for timestamp
* @return {String} type name for timestamp
* @api private
*/
function timestampTypeName(knex) {
return isMySQL(knex) || isMSSQL(knex) ? 'DATETIME' : isPostgres(knex) ? 'timestamp with time zone' : 'timestamp';
}
/*
* Return condition for filtering by expiration
* @return {String} expired sql condition string
* @api private
*/
function expiredCondition(knex) {
var condition = "CAST(? as " + timestampTypeName(knex) + ") <= expired";
if (isSqlite3(knex)) {
// sqlite3 date condition is a special case.
condition = "datetime(?) <= datetime(expired)";
} else if (isOracle(knex)) {
condition = "CAST(? as " + timestampTypeName(knex) + ') <= "expired"';
}
return condition;
}
/*
* Return condition for filtering by expiration
* @return {String} expired sql condition string
* @api private
*/
function expiredCondition(knex) {
var condition ='CAST(? as '+timestampTypeName(knex)+') <= expired';
if(isSqlite3(knex)) { // sqlite3 date condition is a special case.
condition = 'datetime(?) <= datetime(expired)';
} else if (isOracle(knex)) {
condition = 'CAST(? as '+timestampTypeName(knex)+') <= "expired"';
}
return condition;
}
/*
* Returns true if the specified knex instance is using sqlite3.
* @return {bool}
* @api private
*/
function isSqlite3(knex) {
return knex.client.dialect === "sqlite3";
}
/*
* Returns true if the specified knex instance is using sqlite3.
* @return {bool}
* @api private
*/
function isSqlite3(knex) {
return knex.client.dialect === 'sqlite3';
}
/*
* Returns true if the specified knex instance is using mysql.
* @return {bool}
* @api private
*/
function isMySQL(knex) {
return ["mysql", "mariasql", "mariadb"].indexOf(knex.client.dialect) > -1;
}
/*
* Returns true if the specified knex instance is using mysql.
* @return {bool}
* @api private
*/
function isMySQL(knex) {
return ['mysql', 'mariasql', 'mariadb'].indexOf(knex.client.dialect) > -1;
}
/*
* Returns true if the specified knex instance is using mssql.
* @return {bool}
* @api private
*/
function isMSSQL(knex) {
return ["mssql"].indexOf(knex.client.dialect) > -1;
}
/*
* Returns true if the specified knex instance is using mssql.
* @return {bool}
* @api private
*/
function isMSSQL(knex) {
return ['mssql'].indexOf(knex.client.dialect) > -1;
}
/*
* Returns true if the specified knex instance is using postgresql.
* @return {bool}
* @api private
*/
function isPostgres(knex) {
return ["postgresql"].indexOf(knex.client.dialect) > -1;
}
/*
* Returns true if the specified knex instance is using postgresql.
* @return {bool}
* @api private
*/
function isPostgres(knex) {
return ['postgresql'].indexOf(knex.client.dialect) > -1;
}
/*
* Returns true if the specified knex instance is using oracle.
* @return {bool}
* @api private
*/
function isOracle(knex) {
return ["oracle", "oracledb"].indexOf(knex.client.dialect) > -1;
}
/*
* Returns true if the specified knex instance is using oracle.
* @return {bool}
* @api private
*/
function isOracle(knex) {
return ['oracle', 'oracledb'].indexOf(knex.client.dialect) > -1;
}
/*
* Returns PostgreSQL fast upsert query.
* @return {string}
* @api private
*/
function getPostgresFastQuery(tablename, sidfieldname) {
return (
"with new_values (" +
sidfieldname +
", expired, sess) as (" +
" values (?, ?::timestamp with time zone, ?::json)" +
"), " +
"upsert as " +
"( " +
" update " +
tablename +
" cs set " +
" " +
sidfieldname +
" = nv." +
sidfieldname +
", " +
" expired = nv.expired, " +
" sess = nv.sess " +
" from new_values nv " +
" where cs." +
sidfieldname +
" = nv." +
sidfieldname +
" " +
" returning cs.* " +
")" +
"insert into " +
tablename +
" (" +
sidfieldname +
", expired, sess) " +
"select " +
sidfieldname +
", expired, sess " +
"from new_values " +
"where not exists (select 1 from upsert up where up." +
sidfieldname +
" = new_values." +
sidfieldname +
")"
);
}
/*
* Returns PostgreSQL fast upsert query.
* @return {string}
* @api private
*/
function getPostgresFastQuery(tablename, sidfieldname) {
return 'with new_values (' + sidfieldname + ', expired, sess) as (' +
' values (?, ?::timestamp with time zone, ?::json)' +
'), ' +
'upsert as ' +
'( ' +
' update ' + tablename + ' cs set ' +
' ' + sidfieldname + ' = nv.' + sidfieldname + ', ' +
' expired = nv.expired, ' +
' sess = nv.sess ' +
' from new_values nv ' +
' where cs.' + sidfieldname + ' = nv.' + sidfieldname + ' ' +
' returning cs.* ' +
')' +
'insert into ' + tablename + ' (' + sidfieldname + ', expired, sess) ' +
'select ' + sidfieldname + ', expired, sess ' +
'from new_values ' +
'where not exists (select 1 from upsert up where up.' + sidfieldname + ' = new_values.' + sidfieldname + ')';
}
/*
* Returns SQLite fast upsert query.
* @return {string}
* @api private
*/
function getSqliteFastQuery(tablename, sidfieldname) {
return (
"insert or replace into " +
tablename +
" (" +
sidfieldname +
", expired, sess) values (?, ?, ?);"
);
}
/*
* Returns SQLite fast upsert query.
* @return {string}
* @api private
*/
function getSqliteFastQuery(tablename, sidfieldname) {
return 'insert or replace into ' + tablename + ' (' + sidfieldname + ', expired, sess) values (?, ?, ?);';
}
/*
* Returns MySQL fast upsert query.
* @return {string}
* @api private
*/
function getMysqlFastQuery(tablename, sidfieldname) {
return (
"insert into " +
tablename +
" (" +
sidfieldname +
", expired, sess) values (?, ?, ?) on duplicate key update expired=values(expired), sess=values(sess);"
);
}
/*
* Returns MySQL fast upsert query.
* @return {string}
* @api private
*/
function getMysqlFastQuery(tablename, sidfieldname) {
return 'insert into ' + tablename + ' (' + sidfieldname + ', expired, sess) values (?, ?, ?) on duplicate key update expired=values(expired), sess=values(sess);';
}
/*
* Returns MSSQL fast upsert query.
* @return {string}
* @api private
*/
function getMssqlFastQuery(tablename, sidfieldname) {
return (
"merge " +
tablename +
" as T " +
"using (values (?, ?, ?)) as S (" +
sidfieldname +
", expired, sess) " +
"on (T." +
sidfieldname +
" = S." +
sidfieldname +
") " +
"when matched then " +
"update set expired = S.expired, sess = S.sess " +
"when not matched by target then " +
"insert (" +
sidfieldname +
", expired, sess) values (S." +
sidfieldname +
", S.expired, S.sess) " +
"output inserted.*;"
);
}
/*
* Returns MSSQL fast upsert query.
* @return {string}
* @api private
*/
function getMssqlFastQuery(tablename, sidfieldname) {
return 'merge ' + tablename + ' as T ' +
'using (values (?, ?, ?)) as S (' + sidfieldname + ', expired, sess) ' +
'on (T.' + sidfieldname + ' = S.' + sidfieldname + ') ' +
'when matched then ' +
'update set expired = S.expired, sess = S.sess ' +
'when not matched by target then ' +
'insert (' + sidfieldname + ', expired, sess) values (S.' + sidfieldname + ', S.expired, S.sess) ' +
'output inserted.*;';
}
/*
* Remove expired sessions from database.
* @param {Object} store
* @param {number} interval
* @api private
*/
function dbCleanup(store, interval) {
return store.ready
.then(function() {
var condition =
"expired < CAST(? as " + timestampTypeName(store.knex) + ")";
if (isSqlite3(store.knex)) {
// sqlite3 date condition is a special case.
condition = "datetime(expired) < datetime(?)";
} else if (isOracle(store.knex)) {
condition =
'"expired" < CAST(? as ' + timestampTypeName(store.knex) + ")";
}
return store
.knex(store.tablename)
.del()
.whereRaw(condition, dateAsISO(store.knex));
})
.finally(function() {
KnexStore.nextDbCleanup = setTimeout(
dbCleanup,
interval,
store,
interval
).unref();
});
}
/*
* Remove expired sessions from database.
* @param {Object} store
* @param {number} interval
* @api private
*/
function dbCleanup(store, interval) {
return store.ready.then(function () {
var condition = 'expired < CAST(? as ' + timestampTypeName(store.knex) + ')';
if(isSqlite3(store.knex)) { // sqlite3 date condition is a special case.
condition = 'datetime(expired) < datetime(?)';
} else if (isOracle(store.knex)) {
condition = '"expired" < CAST(? as ' + timestampTypeName(store.knex) + ')';
}
return store.knex(store.tablename).del()
.whereRaw(condition, dateAsISO(store.knex));
}).finally(function() {
KnexStore.nextDbCleanup = setTimeout(dbCleanup, interval, store, interval).unref();
});
}
/*
* Initialize KnexStore with the given options.
*
* @param {Object} options
* @api public
*/
function KnexStore(options) {
var self = this;
/*
* Initialize KnexStore with the given options.
*
* @param {Object} options
* @api public
*/
function KnexStore(options) {
var self = this;
options = options || {};
Store.call(self, options);
options = options || {};
Store.call(self, options);
if (!options.clearInterval) {
// Time to run clear expired function.
options.clearInterval = 60000;
}
if (!options.clearInterval) {
// Time to run clear expired function.
options.clearInterval = 60000;
}
self.createtable = options.hasOwnProperty("createtable")
? options.createtable
: true;
self.tablename = options.tablename || "sessions";
self.sidfieldname = options.sidfieldname || "sid";
self.knex =
options.knex ||
require("knex")({
client: "sqlite3",
// debug: true,
connection: {
filename: "connect-session-knex.sqlite"
}
});
self.createtable = options.hasOwnProperty('createtable') ? options.createtable : true;
self.tablename = options.tablename || 'sessions';
self.sidfieldname = options.sidfieldname || 'sid';
self.knex = options.knex || require('knex')({
client: 'sqlite3',
// debug: true,
connection: {
filename: "connect-session-knex.sqlite"
}
});
self.ready = self.knex.schema
.hasTable(self.tablename)
.then(function(exists) {
if (!exists && self.createtable) {
return self.knex.schema.createTable(self.tablename, function(table) {
table.string(self.sidfieldname).primary();
if (isMSSQL(self.knex)) {
table.text("sess").notNullable();
} else {
table.json("sess").notNullable();
}
if (isMySQL(self.knex) || isMSSQL(self.knex)) {
table
.dateTime("expired")
.notNullable()
.index();
} else {
table
.timestamp("expired")
.notNullable()
.index();
}
});
}
return exists;
})
.then(function(exists) {
if (exists) {
dbCleanup(self, options.clearInterval);
}
return null;
});
}
self.ready = self.knex.schema.hasTable(self.tablename)
.then(function (exists) {
if (!exists && self.createtable) {
return self.knex.schema.createTable(self.tablename, function (table) {
table.string(self.sidfieldname).primary();
if (isMSSQL(self.knex)) {
table.text('sess').notNullable();
} else {
table.json('sess').notNullable();
}
if (isMySQL(self.knex) || isMSSQL(self.knex)) {
table.dateTime('expired').notNullable().index();
} else {
table.timestamp('expired').notNullable().index();
}
});
}
return exists;
})
.then(function (exists) {
if (exists) {
dbCleanup(self, options.clearInterval);
}
return null;
});
}
// KnexStore.prototype.__proto__ = Store.prototype;
util.inherits(KnexStore, Store);
// KnexStore.prototype.__proto__ = Store.prototype;
util.inherits(KnexStore, Store);
/*
* Attempt to fetch session by the given sid.
*
* @param {String} sid
* @param {Function} fn
* @api public
*/
KnexStore.prototype.get = function(sid, fn) {
var self = this;
return self.ready.then(function() {
var condition = expiredCondition(self.knex);
return resolve(self.knex
.select("sess")
.from(self.tablename)
.where(self.sidfieldname, "=", sid)
.andWhereRaw(condition, dateAsISO(self.knex))
.then(function(response) {
var ret;
if (response[0]) {
ret = response[0].sess;
if (typeof ret === "string") {
ret = JSON.parse(ret);
}
}
return ret;
}))
.asCallback(fn);
});
};
/*
* Attempt to fetch session by the given sid.
*
* @param {String} sid
* @param {Function} fn
* @api public
*/
KnexStore.prototype.get = function(sid, fn) {
var self = this;
return self.ready.then(function () {
var condition = expiredCondition(self.knex);
return self.knex
.select('sess')
.from(self.tablename)
.where(self.sidfieldname, '=', sid)
.andWhereRaw(condition, dateAsISO(self.knex))
.then(function (response) {
var ret;
if (response[0]) {
ret = response[0].sess;
if (typeof ret === "string") {
ret = JSON.parse(ret);
}
}
return ret;
})
.asCallback(fn);
});
};
/*
* Commit the given `sess` object associated with the given `sid`.
*
* @param {String} sid
* @param {Session} sess
* @param {Function} fn
* @api public
*/
KnexStore.prototype.set = function(sid, sess, fn) {
var self = this;
var maxAge = sess.cookie.maxAge;
var now = new Date().getTime();
var expired = maxAge ? now + maxAge : now + oneDay;
sess = JSON.stringify(sess);
var dbDate = dateAsISO(self.knex, expired);
/*
* Commit the given `sess` object associated with the given `sid`.
*
* @param {String} sid
* @param {Session} sess
* @param {Function} fn
* @api public
*/
KnexStore.prototype.set = function(sid, sess, fn) {
var self = this;
var maxAge = sess.cookie.maxAge;
var now = new Date().getTime();
var expired = maxAge ? now + maxAge : now + oneDay;
sess = JSON.stringify(sess);
if (isSqlite3(self.knex)) {
// sqlite optimized query
return self.ready.then(function() {
return resolve(self.knex
.raw(getSqliteFastQuery(self.tablename, self.sidfieldname), [
sid,
dbDate,
sess
])
.then(function(result) {
return [1];
}))
.asCallback(fn);
});
} else if (
isPostgres(self.knex) &&
parseFloat(self.knex.client.version) >= 9.2
) {
// postgresql optimized query
return self.ready.then(function() {
return resolve(self.knex
.raw(getPostgresFastQuery(self.tablename, self.sidfieldname), [
sid,
dbDate,
sess
]))
.asCallback(fn);
});
} else if (isMySQL(self.knex)) {
// mysql/mariaDB optimized query
return self.ready.then(function() {
return resolve(self.knex
.raw(getMysqlFastQuery(self.tablename, self.sidfieldname), [
sid,
dbDate,
sess
]))
.asCallback(fn);
});
} else if (isMSSQL(self.knex)) {
// mssql optimized query
return self.ready.then(function() {
return resolve(self.knex
.raw(getMssqlFastQuery(self.tablename, self.sidfieldname), [
sid,
dbDate,
sess
]))
.asCallback(fn);
});
} else {
return self.ready.then(function() {
return resolve(self.knex
.transaction(function(trx) {
return trx
.select("*")
.forUpdate()
.from(self.tablename)
.where(self.sidfieldname, "=", sid)
.then(function(foundKeys) {
if (foundKeys.length === 0) {
return trx.from(self.tablename).insert({
[self.sidfieldname]: sid,
expired: dbDate,
sess: sess
});
} else {
return trx(self.tablename)
.where(self.sidfieldname, "=", sid)
.update({
expired: dbDate,
sess: sess
});
}
});
}))
.asCallback(fn);
});
}
};
var dbDate = dateAsISO(self.knex, expired);
/**
* Touch the given session object associated with the given session ID.
*
* @param {String} sid
* @param {Session} sess
* @param {Function} fn
* @public
*/
KnexStore.prototype.touch = function(sid, sess, fn) {
if (sess && sess.cookie && sess.cookie.expires) {
var condition = expiredCondition(this.knex);
if (isSqlite3(self.knex)) {
// sqlite optimized query
return self.ready.then(function () {
return self.knex.raw(getSqliteFastQuery(self.tablename, self.sidfieldname), [sid, dbDate, sess ])
.then(function (result) {
return [1];
})
.asCallback(fn);
});
} else if (isPostgres(self.knex) && parseFloat(self.knex.client.version) >= 9.2) {
// postgresql optimized query
return self.ready.then(function () {
return self.knex.raw(getPostgresFastQuery(self.tablename, self.sidfieldname), [sid, dbDate, sess ])
.asCallback(fn);
});
} else if (isMySQL(self.knex)) {
// mysql/mariaDB optimized query
return self.ready.then(function () {
return self.knex.raw(getMysqlFastQuery(self.tablename, self.sidfieldname), [sid, dbDate, sess ])
.asCallback(fn);
});
} else if (isMSSQL(self.knex)) {
// mssql optimized query
return self.ready.then(function () {
return self.knex.raw(getMssqlFastQuery(self.tablename, self.sidfieldname), [sid, dbDate, sess ])
.asCallback(fn);
});
} else {
return self.ready.then(function () {
return self.knex.transaction(function (trx) {
return trx.select('*')
.forUpdate()
.from(self.tablename)
.where(self.sidfieldname, '=', sid)
.then(function (foundKeys) {
if (foundKeys.length === 0) {
return trx.from(self.tablename)
.insert({
[self.sidfieldname]: sid,
expired: dbDate,
sess: sess
});
} else {
return trx(self.tablename)
.where(self.sidfieldname, '=', sid)
.update({
expired: dbDate,
sess: sess
});
}
});
})
.asCallback(fn);
});
}
};
return resolve(this.knex(this.tablename)
.where(this.sidfieldname, "=", sid)
.andWhereRaw(condition, dateAsISO(this.knex))
.update({
expired: dateAsISO(this.knex, sess.cookie.expires)
}))
.asCallback(fn);
}
fn();
};
/**
* Touch the given session object associated with the given session ID.
*
* @param {String} sid
* @param {Session} sess
* @param {Function} fn
* @public
*/
KnexStore.prototype.touch = function(sid, sess, fn) {
if (sess && sess.cookie && sess.cookie.expires) {
var condition = expiredCondition(this.knex);
/*
* Destroy the session associated with the given `sid`.
*
* @param {String} sid
* @api public
*/
KnexStore.prototype.destroy = function(sid, fn) {
var self = this;
return self.ready.then(function() {
return resolve(self.knex
.del()
.from(self.tablename)
.where(self.sidfieldname, "=", sid))
.asCallback(fn);
});
};
return this.knex(this.tablename)
.where(this.sidfieldname, '=', sid)
.andWhereRaw(condition, dateAsISO(this.knex))
.update({
expired: dateAsISO(this.knex, sess.cookie.expires)
})
.asCallback(fn);
}
/*
* Fetch number of sessions.
*
* @param {Function} fn
* @api public
*/
KnexStore.prototype.length = function(fn) {
var self = this;
return self.ready.then(function() {
return resolve(self.knex
.count(self.sidfieldname + " as count")
.from(self.tablename)
.then(function(response) {
return response[0].count | 0;
}))
.asCallback(fn);
});
};
fn();
};
/*
* Clear all sessions.
*
* @param {Function} fn
* @api public
*/
KnexStore.prototype.clear = function(fn) {
var self = this;
return self.ready.then(function() {
return resolve(self.knex
.del()
.from(self.tablename))
.asCallback(fn);
});
};
/* stop the dbCleanupTimeout */
KnexStore.prototype.stopDbCleanup = function() {
if (KnexStore.nextDbCleanup) {
clearTimeout(KnexStore.nextDbCleanup);
delete KnexStore.nextDbCleanup;
}
};
/*
* Destroy the session associated with the given `sid`.
*
* @param {String} sid
* @api public
*/
KnexStore.prototype.destroy = function(sid, fn) {
var self = this;
return self.ready.then(function () {
return self.knex.del()
.from(self.tablename)
.where(self.sidfieldname, '=', sid)
.asCallback(fn);
});
};
/*
* Fetch number of sessions.
*
* @param {Function} fn
* @api public
*/
KnexStore.prototype.length = function(fn) {
var self = this;
return self.ready.then(function () {
return self.knex.count(self.sidfieldname + ' as count')
.from(self.tablename)
.then(function (response) {
return response[0].count | 0;
})
.asCallback(fn);
});
};
/*
* Clear all sessions.
*
* @param {Function} fn
* @api public
*/
KnexStore.prototype.clear = function(fn) {
var self = this;
return self.ready.then(function () {
return self.knex.del()
.from(self.tablename)
.asCallback(fn);
});
};
/* stop the dbCleanupTimeout */
KnexStore.prototype.stopDbCleanup = function(){
if(KnexStore.nextDbCleanup){
clearTimeout(KnexStore.nextDbCleanup);
delete KnexStore.nextDbCleanup;
}
};
return KnexStore;
return KnexStore;
};

16

package.json
{
"name": "connect-session-knex",
"description": "A knex.js session store for Express and Connect",
"version": "1.5.0",
"version": "1.6.0",
"main": "index.js",

@@ -24,12 +24,14 @@ "engines": {

"license": "ISC",
"dependencies": {
"bluebird": "^3.7.2"
},
"devDependencies": {
"bluebird": "^3.7.1",
"express": "^4.17.1",
"express-session": "^1.17.0",
"knex": "^0.20.1",
"mysql": "^2.17.1",
"pg": "^7.12.1",
"sqlite3": "^4.1.0",
"tape": "^4.11.0"
"knex": "^0.20.11",
"mysql": "^2.18.1",
"pg": "^7.18.2",
"sqlite3": "^4.1.1",
"tape": "^4.13.2"
}
}
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc