overleaf/services/web/app/src/infrastructure/SessionAutostartMiddleware.js
Brian Gough 6c62d4c412 Merge pull request #6100 from overleaf/bg-fix-bot-exception
[web] fix exception when trying to regenerate bot session

GitOrigin-RevId: 753b1dc5cc54263d198181d53bd8dfa02b7dae05
2021-12-15 09:03:00 +00:00

125 lines
3.4 KiB
JavaScript

const Settings = require('@overleaf/settings')
const OError = require('@overleaf/o-error')
const botUserAgents = [
'kube-probe',
'GoogleStackdriverMonitoring',
'GoogleHC',
'Googlebot',
'bingbot',
'facebookexternal',
].map(agent => {
return agent.toLowerCase()
})
// SessionAutostartMiddleware provides a mechanism to force certain routes not
// to get an automatic session where they don't have one already. This allows us
// to work around issues where we might overwrite a user's login cookie with one
// that is hidden by a `SameSite` setting.
//
// When registering a route with disableSessionAutostartForRoute, a callback
// should be provided that handles the case that a session is not available.
// This will be called as a standard middleware with (req, res, next) - calling
// next will continue and sett up a session as normal, otherwise the app can
// perform a different operation as usual
class SessionAutostartMiddleware {
constructor() {
this.middleware = this.middleware.bind(this)
this._cookieName = Settings.cookieName
this._noAutostartCallbacks = new Map()
}
static applyInitialMiddleware(router) {
const middleware = new SessionAutostartMiddleware()
router.sessionAutostartMiddleware = middleware
router.use(middleware.middleware)
}
disableSessionAutostartForRoute(route, method, callback) {
if (typeof callback !== 'function') {
throw new Error('callback not provided when disabling session autostart')
}
if (!this._noAutostartCallbacks[route]) {
this._noAutostartCallbacks[route] = new Map()
}
this._noAutostartCallbacks[route][method] = callback
}
applyDefaultPostGatewayForRoute(route) {
this.disableSessionAutostartForRoute(
route,
'POST',
SessionAutostartMiddleware.genericPostGatewayMiddleware
)
}
autostartCallbackForRequest(req) {
return (
this._noAutostartCallbacks[req.path] &&
this._noAutostartCallbacks[req.path][req.method]
)
}
reqIsBot(req) {
const agent = (req.headers['user-agent'] || '').toLowerCase()
const foundMatch = botUserAgents.find(botAgent => {
return agent.includes(botAgent)
})
if (foundMatch) {
return true
} else {
return false
}
}
middleware(req, _res, next) {
if (!req.signedCookies[this._cookieName]) {
const callback = this.autostartCallbackForRequest(req)
if (callback) {
req.session = {
noSessionCallback: callback,
}
} else if (this.reqIsBot(req)) {
req.session = {
noSessionCallback: (_req, _res, next) => {
next()
},
// prevent exception for bot accesses to /project (which requires
// login and regenerates session)
regenerate: cb => cb(),
}
}
}
next()
}
static invokeCallbackMiddleware(req, res, next) {
if (req.session.noSessionCallback) {
return req.session.noSessionCallback(req, res, next)
}
next()
}
static genericPostGatewayMiddleware(req, res, next) {
if (req.method !== 'POST') {
return next(
new OError('post gateway invoked for non-POST request', {
path: req.path,
method: req.method,
})
)
}
if (req.body.viaGateway) {
return next()
}
res.render('general/post-gateway', { form_data: req.body })
}
}
module.exports = SessionAutostartMiddleware