github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-11-07 20:31:06 -05:00
Code Issues Projects Releases Packages Wiki Activity

[web] Simplify removeSessionsFromRedis signature (#18440)

Browse source 
* Simplify `removeSessionsFromRedis` signature

* Update usage of `removeSessionsFromRedis`

* Fix tests around `removeSessionsFromRedis`

* Add comments "remove all sessions except the current session"

GitOrigin-RevId: 03bf99c14faf2c8e403bc4bcc16463a70e031284
This commit is contained in:
Antoine Clausse 2024-05-21 12:42:47 +02:00 committed by Copybot
parent 78a0bc2b05
commit 3300811d3a
7 changed files with 27 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
services/web/app/src/Features/User/UserController.js
View file

@ -130,9 +130,10 @@ async function changePassword(req, res, next) {
// no need to wait, errors are logged and not passed back
_sendSecurityAlertPasswordChanged(user)
await UserSessionsManager.promises.removeSessionsFromRedis(user, req, {
stayLoggedIn: true,
})
await UserSessionsManager.promises.removeSessionsFromRedis(
user,
req.sessionID // remove all sessions except the current session
)
await OneTimeTokenHandler.promises.expireAllTokensForUser(
userId.toString(),
@ -162,9 +163,10 @@ async function clearSessions(req, res, next) {
req.ip,
{ sessions }
)
await UserSessionsManager.promises.removeSessionsFromRedis(user, req, {
stayLoggedIn: true,
})
await UserSessionsManager.promises.removeSessionsFromRedis(
user,
req.sessionID // remove all sessions except the current session
)
await _sendSecurityAlertClearedSessions(user)

3
services/web/app/src/Features/User/UserEmailsController.js
View file

@ -512,8 +512,7 @@ const UserEmailsController = {
const user = SessionManager.getSessionUser(req.session)
UserSessionsManager.removeSessionsFromRedis(
user,
req,
{ stayLoggedIn: true },
req.sessionID, // remove all sessions except the current session
err => {
if (err)
logger.warn(

3
services/web/app/src/Features/User/UserPagesController.js
View file

@ -66,8 +66,7 @@ async function settingsPage(req, res) {
// The user has just deleted their account.
return UserSessionsManager.removeSessionsFromRedis(
{ _id: userId },
req,
{ stayLoggedIn: false },
null,
() => res.redirect('/')
)
}

26
services/web/app/src/Features/User/UserSessionsManager.js
View file

@ -128,12 +128,10 @@ const UserSessionsManager = {
/**
* @param {{_id: string}} user
* @param {(import('express').Request & {sessionID?: string}) | undefined} req - the request object. Can be omitted if stayLoggedIn is false.
* @param {{stayLoggedIn: boolean}?} options
* @param {string | null | undefined} retainSessionID - the session ID to exclude from deletion
* @param {(err: Error | null, data?: unknown) => void} callback
*/
removeSessionsFromRedis(user, req, options, callback) {
const stayLoggedIn = options?.stayLoggedIn ?? false
removeSessionsFromRedis(user, retainSessionID, callback) {
if (!user) {
return callback(null)
}
@ -146,13 +144,12 @@ const UserSessionsManager = {
})
return callback(err)
}
const keysToDelete =
stayLoggedIn && req?.sessionID
? _.without(
sessionKeys,
UserSessionsManager._sessionKey(req.sessionID)
)
: sessionKeys
const keysToDelete = retainSessionID
? _.without(
sessionKeys,
UserSessionsManager._sessionKey(retainSessionID)
)
: sessionKeys
if (keysToDelete.length === 0) {
logger.debug(
{ userId: user._id },
@ -248,8 +245,11 @@ const UserSessionsManager = {
UserSessionsManager.promises = {
getAllUserSessions: promisify(UserSessionsManager.getAllUserSessions),
removeSessionsFromRedis: (user, req = null, options = null) =>
promisify(UserSessionsManager.removeSessionsFromRedis)(user, req, options),
removeSessionsFromRedis: (user, retainSessionID = null) =>
promisify(UserSessionsManager.removeSessionsFromRedis)(
user,
retainSessionID
),
untrackSession: promisify(UserSessionsManager.untrackSession),
}

1
services/web/scripts/clear_sessions_set_must_reconfirm.js
View file

@ -40,7 +40,6 @@ function _handleUser(userId, callback) {
UserSessionsManager.removeSessionsFromRedis(
{ _id: userId },
null,
null,
error => {
if (error) {
console.log(`Failed to clear sessions for ${userId}`, error)

2
services/web/test/unit/src/User/UserEmailsControllerTests.js
View file

@ -566,7 +566,7 @@ describe('UserEmailsController', function () {
this.res.callback = () => {
expect(
this.UserSessionsManager.removeSessionsFromRedis
).to.have.been.calledWith(this.user, this.req)
).to.have.been.calledWith(this.user, this.req.sessionID)
done()
}

11
services/web/test/unit/src/User/UserSessionsManagerTests.js
View file

@ -344,15 +344,13 @@ describe('UserSessionsManager', function () {
beforeEach(function () {
this.sessionKeys = ['sess:one', 'sess:two']
this.currentSessionID = undefined
this.stayLoggedIn = false
this.rclient.smembers.callsArgWith(1, null, this.sessionKeys)
this.rclient.del = sinon.stub().callsArgWith(1, null)
this.rclient.srem = sinon.stub().callsArgWith(2, null)
return (this.call = callback => {
return this.UserSessionsManager.removeSessionsFromRedis(
this.user,
{ sessionID: this.currentSessionID },
{ stayLoggedIn: this.stayLoggedIn },
this.currentSessionID,
callback
)
})
@ -390,14 +388,12 @@ describe('UserSessionsManager', function () {
beforeEach(function () {
this.sessionKeys = ['sess:one', 'sess:two', 'sess:three', 'sess:four']
this.currentSessionID = 'two'
this.stayLoggedIn = true
this.rclient.smembers.callsArgWith(1, null, this.sessionKeys)
this.rclient.del = sinon.stub().callsArgWith(1, null)
return (this.call = callback => {
return this.UserSessionsManager.removeSessionsFromRedis(
this.user,
{ sessionID: this.currentSessionID },
{ stayLoggedIn: this.stayLoggedIn },
this.currentSessionID,
callback
)
})
@ -463,8 +459,7 @@ describe('UserSessionsManager', function () {
return (this.call = callback => {
return this.UserSessionsManager.removeSessionsFromRedis(
null,
{ sessionID: this.currentSessionID },
{ stayLoggedIn: this.stayLoggedIn },
this.currentSessionID,
callback
)
})