feat!: use redis as backend for koa-session #2693

BlairCurrey · 2024-05-01T13:48:38Z

Changes proposed in this pull request

use redis for koa-session backend

Context

fixes #2673

corresponding helm-chart issue created as well: interledger/helm-charts#38

Checklist

netlify · 2024-05-01T13:48:56Z

✅ Deploy Preview for brilliant-pasca-3e80ec ready!

Name	Link
🔨 Latest commit	`e2c92c1`
🔍 Latest deploy log	https://app.netlify.com/sites/brilliant-pasca-3e80ec/deploys/663bbbd46bed690008159496
😎 Deploy Preview	https://deploy-preview-2693--brilliant-pasca-3e80ec.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

BlairCurrey

I believe I will need to update this repo's helm values.yaml after they are added to our helm chart repo. Assuming it mirrors our backend, I believe we just need to add the same redis config that we have for rafiki-backend.

golobitch · 2024-05-02T12:02:18Z

I already prepared PR for helm charts. So that we will be able to merge it after this one is merged.

mkurapov · 2024-05-03T08:52:52Z

packages/auth/src/app.ts

@@ -342,12 +344,26 @@ export class App {

    koa.use(cors())
    koa.keys = [this.config.cookieKey]
+
+    const redis = await this.container.use('redis')
    koa.use(
      session(
        {
          key: 'sessionId',


How does this correspond to what is stored inside redis? The key I see in redis is a UUID -> where does "sessionId" come into play?

This is the original configuration and from what I can tell the key name does not correspond to anything in redis, it's just for the http cookie returned to the client:

The value there would be the UUID key you see in redis.

mkurapov · 2024-05-03T09:03:50Z

packages/auth/src/app.ts

+              return data ? JSON.parse(data) : null
+            },
+            async set(key, session) {
+              await redis.set(key, JSON.stringify(session))


How does expiry/TTL of the session get saved in redis?

Testing the flow showed that it was being expired but it looks like it was just the http cookie. Redis key was not actually expiring. Changed it to make the record expire in redis. 05fcb02

This does not set expiry on redis key. With set command, that would be done either via EX options of set command or through some expiry command. If we know the TTL of the session I would rewrite this code to be like this:

const op = redis.multi() op.hmset(key, session) op.expire(key, expirationInMilliseconds) await op.exec()

mkurapov · 2024-05-03T09:19:43Z

localenv/cloud-nine-wallet/docker-compose.yml

@@ -85,8 +85,10 @@ services:
      TRUST_PROXY: ${TRUST_PROXY}
      AUTH_DATABASE_URL: postgresql://cloud_nine_wallet_auth:cloud_nine_wallet_auth@shared-database/cloud_nine_wallet_auth
      AUTH_SERVER_DOMAIN: ${CLOUD_NINE_AUTH_SERVER_DOMAIN:-http://localhost:3006}
+      REDIS_URL: redis://shared-redis:6379/0


do we want to distinguish this from the cloud-nine-backend one?

That's a good question. Not sure how much it matters TBH but I suppose its consistent with what we're currently doing, so I changed it to:

c9 backend: 0

c9 auth: 1

hlb backend: 2

hlb auth: 3

mkurapov · 2024-05-03T17:31:04Z

packages/auth/src/app.ts

+              const data = await redis.get(key)
+              return data ? JSON.parse(data) : null
+            },
+            async set(key, session) {


I see there is a third parameter maxAge possible in this function. Do we want to include that here?

I assumed I would use that then purposefully did not after seeing it could be undefined or "session" depending on how we actually configure it. The type here doesnt account for how we actually configure it, so I didn't want to handle scenarios like session or undefined (which should never happen) when we know we want to expire it. I suppose an alternative would be handling session and undefined by defaulting back to expireInMs, but I figured it was just simpler to control both the session max age and redis ttl from 1 variable. If we did handle it by defaulting back to expireInMs then it would basically be: set it to maxAge when maxAge is a number (which will match our configuration) or set it to match our configuration.

Does that make sense? Open to feedback here if anyone sees a better way.

mkurapov · 2024-05-03T17:33:50Z

packages/auth/src/app.ts

+              // Add a delay to cookie age to ensure redis record expires after cookie
+              const expireInMs = maxAgeMs + 10 * 1000
+              await redis.psetex(key, expireInMs, JSON.stringify(session))
+            },


Suggested change

},

await redis.set(key, JSON.stringify(session), 'PX', expireInMs)

I think psetex is deprecated based on the docs. (sorry for the odd diff)

psetex is not deprecated per my knowledge, but it is not wise to use it, since it will be deprecated and removed.
From the docs:

Note: Since the SET command options can replace SETNX, SETEX, PSETEX, GETSET, it is possible that in future versions of Redis these commands will be deprecated and finally removed.

BTW, no need to do stringify on session object. Instead, you can just use hmset(key, session)

Updated to hmset as suggested except I used hset. apparently hmset, like psetex is marked as deprecated in redis docs https://redis.io/docs/latest/commands/hmset/

dda0079

mkurapov · 2024-05-03T17:35:46Z

packages/auth/src/app.ts

+              // Add a delay to cookie age to ensure redis record expires after cookie
+              const expireInMs = maxAgeMs + 10 * 1000


If I understand correctly, this is to possibly allow the "final" request with the to-be-expired cookie parameter to complete before deleting it in redis?

Yeah basically. could potentially be shorter I guess - just needs to be long enough to cover the time between finding the non-expired koa-session in the server and retrieving the redis record. no harm in having a little extra buffer though I figure.

njlie

LGTM

feat: use redis as backend for koa-session

e1a0ef7

BlairCurrey requested review from mkurapov, sabineschaller and njlie May 1, 2024 13:48

github-actions bot added type: tests Testing related type: source Changes business logic pkg: auth Changes in the GNAP auth package. labels May 1, 2024

feat(documentation): update auth to include redis

15e4fa6

github-actions bot added pkg: documentation Changes in the documentation package. type: documentation (archived) Improvements or additions to documentation labels May 1, 2024

BlairCurrey requested a review from golobitch May 1, 2024 14:28

BlairCurrey commented May 1, 2024

View reviewed changes

BlairCurrey added 3 commits May 1, 2024 10:33

chore(documentation): use larger img

ed94f55

feat: add tls configuration to redis

1970190

feat(documentation): add redis tls env vars

a5908b0

BlairCurrey mentioned this pull request May 1, 2024

Add Redis, env vars to Auth interledger/helm-charts#38

Closed

golobitch mentioned this pull request May 2, 2024

feat(rafiki-auth): redis values interledger/helm-charts#39

Merged

mkurapov reviewed May 3, 2024

View reviewed changes

BlairCurrey added 3 commits May 3, 2024 09:41

Merge branch 'main' into bc/2673/koa-session-redis

7e5783d

feat: seperate redis db for auth/backend

926fe1a

feat(auth): add expiration to redis keys

05fcb02

BlairCurrey requested a review from mkurapov May 3, 2024 16:15

BlairCurrey mentioned this pull request May 3, 2024

feat(helm): add redis to auth values #2702

Merged

5 tasks

mkurapov reviewed May 3, 2024

View reviewed changes

feat(auth): store sessions as hash, not string

dda0079

BlairCurrey requested a review from mkurapov May 6, 2024 15:57

Merge branch 'main' into bc/2673/koa-session-redis

e2c92c1

mkurapov approved these changes May 10, 2024

View reviewed changes

njlie approved these changes May 10, 2024

View reviewed changes

BlairCurrey merged commit 1a0d384 into main May 13, 2024
44 checks passed

BlairCurrey deleted the bc/2673/koa-session-redis branch May 13, 2024 16:15

sabineschaller added the breaking Issue/PR that introduces breaking changes label Jun 24, 2024

sabineschaller changed the title ~~feat: use redis as backend for koa-session~~ feat!: use redis as backend for koa-session Jun 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: use redis as backend for koa-session #2693

feat!: use redis as backend for koa-session #2693

BlairCurrey commented May 1, 2024 •

edited

Loading

netlify bot commented May 1, 2024 •

edited

Loading

BlairCurrey left a comment

golobitch commented May 2, 2024

mkurapov May 3, 2024

BlairCurrey May 3, 2024 •

edited

Loading

mkurapov May 3, 2024

BlairCurrey May 3, 2024

golobitch May 3, 2024

mkurapov May 3, 2024

BlairCurrey May 3, 2024 •

edited

Loading

mkurapov May 3, 2024

BlairCurrey May 6, 2024 •

edited

Loading

mkurapov May 3, 2024 •

edited

Loading

golobitch May 3, 2024

golobitch May 3, 2024

BlairCurrey May 6, 2024 •

edited

Loading

mkurapov May 3, 2024

BlairCurrey May 6, 2024

njlie left a comment

	},
	await redis.set(key, JSON.stringify(session), 'PX', expireInMs)

		// Add a delay to cookie age to ensure redis record expires after cookie
		const expireInMs = maxAgeMs + 10 * 1000

feat!: use redis as backend for koa-session #2693

feat!: use redis as backend for koa-session #2693

Conversation

BlairCurrey commented May 1, 2024 • edited Loading

Changes proposed in this pull request

Context

Checklist

netlify bot commented May 1, 2024 • edited Loading

✅ Deploy Preview for brilliant-pasca-3e80ec ready!

BlairCurrey left a comment

Choose a reason for hiding this comment

golobitch commented May 2, 2024

Choose a reason for hiding this comment

BlairCurrey May 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BlairCurrey May 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BlairCurrey May 6, 2024 • edited Loading

Choose a reason for hiding this comment

mkurapov May 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BlairCurrey May 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

njlie left a comment

Choose a reason for hiding this comment

BlairCurrey commented May 1, 2024 •

edited

Loading

netlify bot commented May 1, 2024 •

edited

Loading

BlairCurrey May 3, 2024 •

edited

Loading

BlairCurrey May 3, 2024 •

edited

Loading

BlairCurrey May 6, 2024 •

edited

Loading

mkurapov May 3, 2024 •

edited

Loading

BlairCurrey May 6, 2024 •

edited

Loading