From bdc7c018eb5e38b4085689943cd46ccdc7e916df Mon Sep 17 00:00:00 2001 From: Sheen Capadngan Date: Tue, 18 Jun 2024 20:36:09 +0800 Subject: [PATCH] misc: added comment regarding session and redis usage --- backend/src/ee/routes/v1/oidc-router.ts | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/backend/src/ee/routes/v1/oidc-router.ts b/backend/src/ee/routes/v1/oidc-router.ts index 36ad8a085..8b68a8aef 100644 --- a/backend/src/ee/routes/v1/oidc-router.ts +++ b/backend/src/ee/routes/v1/oidc-router.ts @@ -22,6 +22,12 @@ export const registerOidcRouter = async (server: FastifyZodProvider) => { const appCfg = getConfig(); const redis = new Redis(appCfg.REDIS_URL); const passport = new Authenticator({ key: "oidc", userProperty: "passportUser" }); + + /* + - OIDC protocol cannot work without sessions: https://github.com/panva/node-openid-client/issues/190 + - Current redis usage is not ideal and will eventually have to be refactored to use a better structure + - Fastify session <> Redis structure is based on the ff: https://github.com/fastify/session/blob/master/examples/redis.js + */ const redisStore = new RedisStore({ client: redis, prefix: "oidc-session:",