Session store knex (directus#5432)

* Rotate JPG image on upload directus#4206

* fixes directus#3949 width/height generated for gif and tif

* API hooks for event added for auth.login directus#4079

* updated doc for api hooks for new auth.login event

* Style tweaks

* Update docs

* Tweak docs some more

* Spelling error

* Allow non-required flags and pass to hook

* SDK - Persistent login refresh fixes directus#4113

* Fixed directus#4145 SDK, Token Expired error

* Spell check

* Docs Spell check

* Docs Spell check

* Docs Spell check

* update docs for sdk-js

* To delete all expired session from db on login

* corrected the condition for the delete

* changed the from Date.now to new date .

* Move it inline

* Added Knex option for Session store

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>

Author: workatease

api/package.json

@@ -130,6 +130,7 @@
 		"@keyv/redis": "^2.1.2",
 		"connect-memcached": "^1.0.0",
 		"connect-redis": "^5.2.0",
+		"connect-session-knex": "^2.0.0",
 		"ioredis": "^4.19.2",
 		"keyv-memcache": "^1.0.1",
 		"memcached": "^2.2.2",
@@ -169,4 +170,4 @@
 		"ts-node-dev": "^1.0.0",
 		"typescript": "^4.0.5"
 	}
-}
+}

api/src/middleware/session.ts

@@ -1,7 +1,7 @@
 import expressSession, { Store } from 'express-session';
 import env from '../env';
 import { getConfigFromEnv } from '../utils/get-config-from-env';
-
+import database from '../database';
 let store: Store | undefined = undefined;
 
 if (env.SESSION_STORE === 'redis') {
@@ -17,4 +17,12 @@ if (env.SESSION_STORE === 'memcache') {
 	store = new MemcachedStore(getConfigFromEnv('SESSION_MEMCACHE_'));
 }
 
+if (env.SESSION_STORE === 'database') {
+	const KnexSessionStore = require('connect-session-knex')(expressSession);
+	store = new KnexSessionStore({
+		knex: database,
+		tablename: 'oauth_sessions', // optional. Defaults to 'sessions'
+	});
+}
+
 export const session = expressSession({ store, secret: env.SECRET as string, saveUninitialized: false, resave: false });

docs/reference/environment-variables.md

@@ -164,9 +164,9 @@ Alternatively, you can provide the individual connection parameters:
 
 Sessions are only used in the oAuth authentication flow.
 
-| Variable        | Description                                                               | Default Value |
-| --------------- | ------------------------------------------------------------------------- | ------------- |
-| `SESSION_STORE` | Where to store the session data. Either `memory`, `redis`, or `memcache`. | `memory`      |
+| Variable        | Description                                                                          | Default Value |
+| --------------- | ------------------------------------------------------------------------------------ | ------------- |
+| `SESSION_STORE` | Where to store the session data. Either `memory`, `redis`, `memcache` or `database`. | `memory`      |
 
 Based on the `SESSION_STORE` used, you must also provide the following configurations:
 
@@ -194,6 +194,10 @@ Alternatively, you can provide the individual connection parameters:
 | ------------------ | ---------------------------------- | ------------- |
 | `SESSION_MEMCACHE` | Location of your memcache instance | ---           |
 
+### Database
+
+No additional configuration required.
+
 ## File Storage
 
 | Variable            | Description                                                                                                           | Default Value |