forked from alphagov/pay-direct-debit-frontend
-
Notifications
You must be signed in to change notification settings - Fork 0
/
server.js
194 lines (168 loc) · 6.34 KB
/
server.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
// Node.js core dependencies
const path = require('path')
// Please leave here even though it looks unused - this enables Node.js metrics to be pushed to Hosted Graphite
if (!process.env.DISABLE_APPMETRICS) {
require('./common/utils/metrics').metrics()
}
// npm dependencies
const express = require('express')
const favicon = require('serve-favicon')
const bodyParser = require('body-parser')
const i18n = require('i18n')
const argv = require('minimist')(process.argv.slice(2))
const staticify = require('staticify')(path.join(__dirname, 'public'))
const compression = require('compression')
const nunjucks = require('nunjucks')
const Sentry = require('@sentry/node')
// Local dependencies
const router = require('./app/router')
const noCache = require('./common/utils/no-cache')
const correlationHeader = require('./common/middleware/correlation-header/correlation-header')
const cookieConfig = require('./common/config/cookies')
const logger = require('./app/utils/logger')(__filename)
const loggingMiddleware = require('./common/middleware/logging_middleware')
// Global constants
const unconfiguredApp = express()
const oneYear = 86400000 * 365
const publicCaching = { maxAge: oneYear }
const PORT = (process.env.PORT || 3000)
const { NODE_ENV } = process.env
const CSS_PATH = staticify.getVersionedPath('/stylesheets/application.min.css')
const JAVASCRIPT_PATH = staticify.getVersionedPath('/javascripts/application.min.js')
const ANALYTICS_TRACKING_ID = process.env.ANALYTICS_TRACKING_ID || ''
function warnIfAnalyticsNotSet () {
if (ANALYTICS_TRACKING_ID === '') {
logger.warn('Google Analytics Tracking ID [ANALYTICS_TRACKING_ID] is not set')
}
}
// Define app views
const APP_VIEWS = [
path.join(__dirname, 'node_modules/govuk-frontend/'),
__dirname
]
function initialiseGlobalMiddleware (app) {
app.set('settings', { getVersionedPath: staticify.getVersionedPath })
app.use(favicon(path.join(__dirname, '/node_modules/govuk-frontend/govuk/assets/images', 'favicon.ico')))
app.use(compression())
app.use(staticify.middleware)
if (process.env.DISABLE_REQUEST_LOGGING !== 'true') {
app.use(/\/((?!images|public|stylesheets|javascripts).)*/, loggingMiddleware())
}
app.use(function (req, res, next) {
res.locals.asset_path = '/public/'
res.locals.analyticsTrackingId = ANALYTICS_TRACKING_ID
noCache(res)
next()
})
app.use(bodyParser.json())
app.use(bodyParser.urlencoded({ extended: true }))
app.use('*', correlationHeader)
}
function initialiseCookies (app) {
cookieConfig.configureSessionCookie(app)
}
function initialiseI18n (app) {
i18n.configure({
locales: ['en'],
directory: path.join(__dirname, '/locales'),
objectNotation: true,
defaultLocale: 'en',
register: global
})
app.use(i18n.init)
}
function initialiseProxy (app) {
app.enable('trust proxy')
}
function initialiseTemplateEngine (app) {
// Configure nunjucks
// see https://mozilla.github.io/nunjucks/api.html#configure
const nunjucksConfiguration = {
express: app, // the express app that nunjucks should install to
autoescape: true, // controls if output with dangerous characters are escaped automatically
throwOnUndefined: false, // throw errors when outputting a null/undefined value
trimBlocks: true, // automatically remove trailing newlines from a block/tag
lstripBlocks: true, // automatically remove leading whitespace from a block/tag
watch: false, // reload templates when they are changed (server-side). To use watch, make sure optional dependency chokidar is installed
noCache: NODE_ENV !== 'production' // never use a cache and recompile templates each time (server-side)
}
// Initialise nunjucks environment
const nunjucksEnvironment = nunjucks.configure(APP_VIEWS, nunjucksConfiguration)
// Set view engine
app.set('view engine', 'njk')
// Version static assets on production for better caching
// if it's not production we want to re-evaluate the assets on each file change
nunjucksEnvironment.addGlobal('css_path', NODE_ENV === 'production' ? CSS_PATH : staticify.getVersionedPath('/stylesheets/application.min.css'))
nunjucksEnvironment.addGlobal('js_path', NODE_ENV === 'production' ? JAVASCRIPT_PATH : staticify.getVersionedPath('/javascripts/application.js'))
}
function initialisePublic (app) {
app.use('/public', express.static(path.join(__dirname, '/public')))
app.use('/', express.static(path.join(__dirname, '/node_modules/govuk-frontend/govuk/')))
app.use('/javascripts', express.static(path.join(__dirname, '/public/assets/javascripts'), publicCaching))
app.use('/images', express.static(path.join(__dirname, '/public/images'), publicCaching))
app.use('/stylesheets', express.static(path.join(__dirname, '/public/assets/stylesheets'), publicCaching))
}
function initialiseRoutes (app) {
router.bind(app)
}
function initialiseSentry () {
Sentry.init({
dsn: process.env.SENTRY_DSN,
environment: process.env.ENVIRONMENT,
beforeSend (event) {
if (event.request) {
delete event.request // This can include sensitive data such as card numbers
}
return event
}
})
}
const configureSentryRequestHandler = function configureSentryRequestHandler (app) {
app.use(Sentry.Handlers.requestHandler())
}
const configureSentryErrorHandler = function configureSentryErrorHandler (app) {
app.use(Sentry.Handlers.errorHandler())
}
function listen () {
const app = initialise()
app.listen(PORT)
logger.info('Listening on port ' + PORT)
}
/**
* Configures app
* @return app
*/
function initialise () {
const app = unconfiguredApp
initialiseSentry()
configureSentryRequestHandler(app) // The request handler must be the first middleware on the app
app.disable('x-powered-by')
initialiseProxy(app)
initialiseCookies(app)
initialiseI18n(app)
initialiseGlobalMiddleware(app)
initialiseTemplateEngine(app)
initialisePublic(app)
initialiseRoutes(app) // this needs to be at the bottom otherwise all assets in public 404
configureSentryErrorHandler(app) // Sentry's error handler must be before any other error middleware and after all controllers
warnIfAnalyticsNotSet()
return app
}
/**
* Starts app after ensuring DB is up
*/
function start () {
listen()
}
/**
* -i flag. Immediately invoke start.
* Allows script to be run by task runner
*/
if (argv.i) {
start()
}
module.exports = {
start: start,
getApp: initialise,
staticify: staticify
}