#12617

pending completion

Build # #12617

Build Type

push

circleci

Committed by

web-flow

Commit Message

Merge pull request #2875 from mozilla/MNTOR-1269/fix-redis-locale-store-bug

fix redis overwriting `AsyncLocalStore`

Run Details

282 of 1398 branches covered (20.17%)

Branch coverage included in aggregate %.

10 of 10 new or added lines in 2 files covered. (100.0%)

959 of 3805 relevant lines covered (25.2%)

2.1 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/app.js

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

import crypto from 'node:crypto'

import express from 'express'
import session from 'express-session'
import helmet from 'helmet'
import accepts from 'accepts'
import { createClient } from 'redis'
import RedisStore from 'connect-redis'
import cookieParser from 'cookie-parser'
import rateLimit from 'express-rate-limit'
import Sentry from '@sentry/node'
import '@sentry/tracing'

import AppConstants from './app-constants.js'
import { localStorage } from './utils/local-storage.js'
import { errorHandler } from './middleware/error.js'
import { doubleCsrfProtection } from './utils/csrf.js'
import { initFluentBundles, updateLocale, getMessageWithLocale, getMessage } from './utils/fluent.js'
import { loadBreachesIntoApp } from './utils/hibp.js'
import { RateLimitError } from './utils/error.js'
import { initEmail } from './utils/email.js'
import indexRouter from './routes/index.js'

const app = express()
const isDev = AppConstants.NODE_ENV === 'dev'

// init sentry
Sentry.init({
  dsn: AppConstants.SENTRY_DSN,
  environment: AppConstants.NODE_ENV,
  debug: isDev,
  beforeSend (event, hint) {
    if (!hint.originalException.locales || hint.originalException.locales[0] === 'en') return event // return if no localization or localization is in english

    // try to force an english translation for the error message if localized
    if (hint.originalException.fluentID) {
      event.exception.values[0].value = getMessageWithLocale(hint.originalException.fluentID, 'en') || getMessage(hint.originalException.fluentID)
    }

    return event
  }
})

// Determine from where to serve client code/assets:
// Build script is triggered for `npm start` and assets are served from /dist.
// Build script is NOT run for `npm run dev`, assets are served from /src, and nodemon restarts server without build (faster dev).
const staticPath =
  process.env.npm_lifecycle_event === 'start' ? '../dist' : './client'

await initFluentBundles()

async function getRedisStore () {
  if (['', 'redis-mock'].includes(AppConstants.REDIS_URL)) {
    // allow mock redis for setups without local redis server
    const { redisMockClient } = await import('./utils/redis-mock.js')
    return new RedisStore({ client: redisMockClient })
  }

  const redisClient = createClient({ url: AppConstants.REDIS_URL })
  await redisClient.connect().catch(console.error)
  return new RedisStore({ client: redisClient })
}

// middleware
app.use(
  helmet({
    crossOriginEmbedderPolicy: false
  })
)

app.use(
  Sentry.Handlers.requestHandler({
    request: ['headers', 'method', 'url'], // omit cookies, data, query_string
    user: ['id'] // omit username, email
  })
)

const imgSrc = [
  "'self'"
]

if (AppConstants.FXA_ENABLED) {
  const fxaSrc = new URL(AppConstants.OAUTH_PROFILE_URI).origin
  imgSrc.push(fxaSrc)
}

// Support GA4 per https://developers.google.com/tag-platform/tag-manager/web/csp
imgSrc.push('www.googletagmanager.com')

// disable forced https to allow localhost on Safari
app.use((_req, res, _next) => {
  res.locals.nonce = crypto.randomBytes(16).toString('hex')
  helmet.contentSecurityPolicy({
    directives: {
      upgradeInsecureRequests: isDev ? null : [],
      scriptSrc: [
        "'self'",
        // Support GA4 per https://developers.google.com/tag-platform/tag-manager/web/csp
        `'nonce-${res.locals.nonce}'`
      ],
      imgSrc,
      connectSrc: [
        "'self'",
        // Support GA4 per https://developers.google.com/tag-platform/tag-manager/web/csp
        'https://*.google-analytics.com',
        'https://*.analytics.google.com',
        'https://*.googletagmanager.com'
      ]
    }
  })(_req, res, _next)
})

// fallback to default 'no-referrer' only when 'strict-origin-when-cross-origin' not available
app.use(
  helmet.referrerPolicy({
    policy: ['no-referrer', 'strict-origin-when-cross-origin']
  })
)

// When a text/html request is received, negotiate and store the requested language
// Using asyncLocalStorage avoids having to pass req context down through every function (e.g. getMessage())
app.use((req, res, next) => {
  if (!req.headers.accept?.startsWith('text/html')) return next()

  localStorage.run(new Map(), () => {
    req.locale = updateLocale(accepts(req).languages())
    localStorage.getStore().set('locale', req.locale)
    next()
  })
})

// MNTOR-1009, 1117:
// Because of proxy settings, request / cookies are not persisted between calls
// Setting the trust proxy to high and securing the cookie allowed the cookie to persist
// If cookie.secure is set as true, for nodejs behind proxy, "trust proxy" needs to be set
app.set('trust proxy', 1)

// session
const SESSION_DURATION_HOURS = AppConstants.SESSION_DURATION_HOURS || 48
app.use(
  session({
    cookie: {
      maxAge: SESSION_DURATION_HOURS * 60 * 60 * 1000, // 48 hours
      rolling: true,
      sameSite: 'lax',
      secure: !isDev
    },
    resave: false,
    saveUninitialized: true,
    secret: AppConstants.COOKIE_SECRET,
    store: await getRedisStore()
  })
)

// Load breaches into namespaced cache
try {
  await loadBreachesIntoApp(app)
} catch (error) {
  console.error('Error loading breaches into app.locals', error)
}

app.use(express.static(staticPath))
app.use(express.json())
app.use(cookieParser(AppConstants.COOKIE_SECRET))
app.use(doubleCsrfProtection)

const apiLimiter = rateLimit({
  windowMs: 15 * 60 * 1000, // 15 minutes
  max: 100, // Limit each IP to 100 requests per `window` (here, per 15 minutes)
  standardHeaders: true, // Return rate limit info in the `RateLimit-*` headers
  legacyHeaders: false // Disable the `X-RateLimit-*` headers
})

app.use('/api', apiLimiter)

// routing
app.use('/', indexRouter)

// sentry error handler
app.use(Sentry.Handlers.errorHandler({
  shouldHandleError (error) {
    if (error instanceof RateLimitError) return true
  }
}))

// app error handler
app.use(errorHandler)

app.listen(AppConstants.PORT, async function () {
  console.info(`MONITOR V2: Server listening at ${this.address().port}`)
  console.info(`Static files served from ${staticPath}`)
  try {
    await initEmail()
    console.info('Email initialized')
  } catch (ex) {
    console.error('try-initialize-email-error', { ex })
  }
})

1	/* This Source Code Form is subject to the terms of the Mozilla Public
2	* License, v. 2.0. If a copy of the MPL was not distributed with this
3	* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
4
5	import crypto from 'node:crypto'
6
7	import express from 'express'
8	import session from 'express-session'
9	import helmet from 'helmet'
10	import accepts from 'accepts'
11	import { createClient } from 'redis'
12	import RedisStore from 'connect-redis'
13	import cookieParser from 'cookie-parser'
14	import rateLimit from 'express-rate-limit'
15	import Sentry from '@sentry/node'
16	import '@sentry/tracing'
17
18	import AppConstants from './app-constants.js'
19	import { localStorage } from './utils/local-storage.js'
20	import { errorHandler } from './middleware/error.js'
21	import { doubleCsrfProtection } from './utils/csrf.js'
22	import { initFluentBundles, updateLocale, getMessageWithLocale, getMessage } from './utils/fluent.js'
23	import { loadBreachesIntoApp } from './utils/hibp.js'
24	import { RateLimitError } from './utils/error.js'
25	import { initEmail } from './utils/email.js'
26	import indexRouter from './routes/index.js'
27
28	const app = express()	×
29	const isDev = AppConstants.NODE_ENV === 'dev'	×
30
31	// init sentry
32	Sentry.init({	×
33	dsn: AppConstants.SENTRY_DSN,
34	environment: AppConstants.NODE_ENV,
35	debug: isDev,
36	beforeSend (event, hint) {
37	if (!hint.originalException.locales \|\| hint.originalException.locales[0] === 'en') return event // return if no localization or localization is in english	×
38
39	// try to force an english translation for the error message if localized
40	if (hint.originalException.fluentID) {	×
41	event.exception.values[0].value = getMessageWithLocale(hint.originalException.fluentID, 'en') \|\| getMessage(hint.originalException.fluentID)	×
42	}
43
44	return event	×
45	}
46	})
47
48	// Determine from where to serve client code/assets:
49	// Build script is triggered for `npm start` and assets are served from /dist.
50	// Build script is NOT run for `npm run dev`, assets are served from /src, and nodemon restarts server without build (faster dev).
51	const staticPath =
52	process.env.npm_lifecycle_event === 'start' ? '../dist' : './client'	×
53
54	await initFluentBundles()	×
55
56	async function getRedisStore () {
57	if (['', 'redis-mock'].includes(AppConstants.REDIS_URL)) {	×
58	// allow mock redis for setups without local redis server
59	const { redisMockClient } = await import('./utils/redis-mock.js')	×
60	return new RedisStore({ client: redisMockClient })	×
61	}
62
63	const redisClient = createClient({ url: AppConstants.REDIS_URL })	×
64	await redisClient.connect().catch(console.error)	×
65	return new RedisStore({ client: redisClient })	×
66	}
67
68	// middleware
69	app.use(	×
70	helmet({
71	crossOriginEmbedderPolicy: false
72	})
73	)
74
75	app.use(	×
76	Sentry.Handlers.requestHandler({
77	request: ['headers', 'method', 'url'], // omit cookies, data, query_string
78	user: ['id'] // omit username, email
79	})
80	)
81
82	const imgSrc = [	×
83	"'self'"
84	]
85
86	if (AppConstants.FXA_ENABLED) {	×
87	const fxaSrc = new URL(AppConstants.OAUTH_PROFILE_URI).origin	×
88	imgSrc.push(fxaSrc)	×
89	}
90
91	// Support GA4 per https://developers.google.com/tag-platform/tag-manager/web/csp
92	imgSrc.push('www.googletagmanager.com')	×
93
94	// disable forced https to allow localhost on Safari
95	app.use((_req, res, _next) => {	×
96	res.locals.nonce = crypto.randomBytes(16).toString('hex')	×
97	helmet.contentSecurityPolicy({	×
98	directives: {
99	upgradeInsecureRequests: isDev ? null : [],	×
100	scriptSrc: [
101	"'self'",
102	// Support GA4 per https://developers.google.com/tag-platform/tag-manager/web/csp
103	`'nonce-${res.locals.nonce}'`
104	],
105	imgSrc,
106	connectSrc: [
107	"'self'",
108	// Support GA4 per https://developers.google.com/tag-platform/tag-manager/web/csp
109	'https://*.google-analytics.com',
110	'https://*.analytics.google.com',
111	'https://*.googletagmanager.com'
112	]
113	}
114	})(_req, res, _next)
115	})
116
117	// fallback to default 'no-referrer' only when 'strict-origin-when-cross-origin' not available
118	app.use(	×
119	helmet.referrerPolicy({
120	policy: ['no-referrer', 'strict-origin-when-cross-origin']
121	})
122	)
123
124	// When a text/html request is received, negotiate and store the requested language
125	// Using asyncLocalStorage avoids having to pass req context down through every function (e.g. getMessage())
126	app.use((req, res, next) => {	×
127	if (!req.headers.accept?.startsWith('text/html')) return next()	×
128
129	localStorage.run(new Map(), () => {	×
130	req.locale = updateLocale(accepts(req).languages())	×
131	localStorage.getStore().set('locale', req.locale)	×
132	next()	×
133	})
134	})
135
136	// MNTOR-1009, 1117:
137	// Because of proxy settings, request / cookies are not persisted between calls
138	// Setting the trust proxy to high and securing the cookie allowed the cookie to persist
139	// If cookie.secure is set as true, for nodejs behind proxy, "trust proxy" needs to be set
140	app.set('trust proxy', 1)	×
141
142	// session
143	const SESSION_DURATION_HOURS = AppConstants.SESSION_DURATION_HOURS \|\| 48	×
144	app.use(	×
145	session({
146	cookie: {
147	maxAge: SESSION_DURATION_HOURS * 60 * 60 * 1000, // 48 hours
148	rolling: true,
149	sameSite: 'lax',
150	secure: !isDev
151	},
152	resave: false,
153	saveUninitialized: true,
154	secret: AppConstants.COOKIE_SECRET,
155	store: await getRedisStore()
156	})
157	)
158
159	// Load breaches into namespaced cache
160	try {	×
161	await loadBreachesIntoApp(app)	×
162	} catch (error) {
163	console.error('Error loading breaches into app.locals', error)	×
164	}
165
166	app.use(express.static(staticPath))	×
167	app.use(express.json())	×
168	app.use(cookieParser(AppConstants.COOKIE_SECRET))	×
169	app.use(doubleCsrfProtection)	×
170
171	const apiLimiter = rateLimit({	×
172	windowMs: 15 * 60 * 1000, // 15 minutes
173	max: 100, // Limit each IP to 100 requests per `window` (here, per 15 minutes)
174	standardHeaders: true, // Return rate limit info in the `RateLimit-*` headers
175	legacyHeaders: false // Disable the `X-RateLimit-*` headers
176	})
177
178	app.use('/api', apiLimiter)	×
179
180	// routing
181	app.use('/', indexRouter)	×
182
183	// sentry error handler
184	app.use(Sentry.Handlers.errorHandler({	×
185	shouldHandleError (error) {
186	if (error instanceof RateLimitError) return true	×
187	}
188	}))
189
190	// app error handler
191	app.use(errorHandler)	×
192
193	app.listen(AppConstants.PORT, async function () {	×
194	console.info(`MONITOR V2: Server listening at ${this.address().port}`)	×
195	console.info(`Static files served from ${staticPath}`)	×
196	try {	×
197	await initEmail()	×
198	console.info('Email initialized')	×
199	} catch (ex) {
200	console.error('try-initialize-email-error', { ex })	×
201	}
202	})

mozilla / blurts-server / #12617

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous