-
Notifications
You must be signed in to change notification settings - Fork 40
/
app.js
executable file
·244 lines (198 loc) · 7.37 KB
/
app.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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
// Core dependencies
const path = require('path');
const fs = require('fs');
// External dependencies
const bodyParser = require('body-parser');
const cookieParser = require('cookie-parser');
const dotenv = require('dotenv');
const express = require('express');
const nunjucks = require('nunjucks');
const sessionInCookie = require('client-sessions');
const sessionInMemory = require('express-session');
// Run before other code to make sure variables from .env are available
dotenv.config();
// Local dependencies
const packageInfo = require('./package.json');
const authentication = require('./middleware/authentication');
const automaticRouting = require('./middleware/auto-routing');
const config = require('./app/config');
const locals = require('./app/locals');
const routes = require('./app/routes');
const documentationRoutes = require('./docs/documentation_routes');
const utils = require('./lib/utils');
const prototypeAdminRoutes = require('./middleware/prototype-admin-routes');
// Set configuration variables
const port = parseInt(process.env.PORT) || config.port;
const useDocumentation = process.env.SHOW_DOCS || config.useDocumentation;
const onlyDocumentation = process.env.DOCS_ONLY;
// Initialise applications
const app = express();
const documentationApp = express();
// Set up configuration variables
const useAutoStoreData = process.env.USE_AUTO_STORE_DATA || config.useAutoStoreData;
const useCookieSessionStore = process.env.USE_COOKIE_SESSION_STORE || config.useCookieSessionStore;
// Add variables that are available in all views
app.locals.asset_path = '/public/';
app.locals.useAutoStoreData = (useAutoStoreData === 'true');
app.locals.useCookieSessionStore = (useCookieSessionStore === 'true');
app.locals.serviceName = config.serviceName;
// Use cookie middleware to parse cookies
app.use(cookieParser());
// Nunjucks configuration for application
const appViews = [
path.join(__dirname, 'app/views/'),
path.join(__dirname, 'node_modules/nhsuk-frontend/packages/components'),
path.join(__dirname, 'docs/views/'),
path.join(__dirname, 'lib/prototype-admin/'),
];
const nunjucksConfig = {
autoescape: true,
noCache: true,
};
nunjucksConfig.express = app;
let nunjucksAppEnv = nunjucks.configure(appViews, nunjucksConfig);
nunjucksAppEnv.addGlobal('version', packageInfo.version);
// Add Nunjucks filters
utils.addNunjucksFilters(nunjucksAppEnv);
// Session uses service name to avoid clashes with other prototypes
const sessionName = `nhsuk-prototype-kit-${(Buffer.from(config.serviceName, 'utf8')).toString('hex')}`;
const sessionOptions = {
secret: sessionName,
cookie: {
maxAge: 1000 * 60 * 60 * 4, // 4 hours
},
};
// Authentication
app.use(authentication);
// Support session data in cookie or memory
if (useCookieSessionStore === 'true' && !onlyDocumentation) {
app.use(sessionInCookie(Object.assign(sessionOptions, {
cookieName: sessionName,
proxy: true,
requestKey: 'session',
})));
} else {
app.use(sessionInMemory(Object.assign(sessionOptions, {
name: sessionName,
resave: false,
saveUninitialized: false,
})));
}
// Support for parsing data in POSTs
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({
extended: true,
}));
// Automatically store all data users enter
if (useAutoStoreData === 'true') {
app.use(utils.autoStoreData);
utils.addCheckedFunction(nunjucksAppEnv);
}
// Warn if node_modules folder doesn't exist
function checkFiles() {
const nodeModulesExists = fs.existsSync(path.join(__dirname, '/node_modules'));
if (!nodeModulesExists) {
console.error('ERROR: Node module folder missing. Try running `npm install`'); // eslint-disable-line no-console
process.exit(0);
}
// Create template .env file if it doesn't exist
const envExists = fs.existsSync(path.join(__dirname, '/.env'));
if (!envExists) {
fs.createReadStream(path.join(__dirname, '/lib/template.env'))
.pipe(fs.createWriteStream(path.join(__dirname, '/.env')));
}
}
// initial checks
checkFiles();
// Create template session data defaults file if it doesn't exist
const dataDirectory = path.join(__dirname, '/app/data');
const sessionDataDefaultsFile = path.join(dataDirectory, '/session-data-defaults.js');
const sessionDataDefaultsFileExists = fs.existsSync(sessionDataDefaultsFile);
if (!sessionDataDefaultsFileExists) {
console.log('Creating session data defaults file'); // eslint-disable-line no-console
if (!fs.existsSync(dataDirectory)) {
fs.mkdirSync(dataDirectory);
}
fs.createReadStream(path.join(__dirname, '/lib/template.session-data-defaults.js'))
.pipe(fs.createWriteStream(sessionDataDefaultsFile));
}
// Local variables
app.use(locals(config));
// View engine
app.set('view engine', 'html');
documentationApp.set('view engine', 'html');
// Middleware to serve static assets
app.use(express.static(path.join(__dirname, 'public')));
app.use('/nhsuk-frontend', express.static(path.join(__dirname, 'node_modules/nhsuk-frontend/packages')));
app.use('/nhsuk-frontend', express.static(path.join(__dirname, 'node_modules/nhsuk-frontend/dist')));
// Check if the app is documentation only
if (onlyDocumentation === 'true') {
app.get('/', (req, res) => {
// Redirect to the documentation pages if it is
res.redirect('/docs');
});
}
// Use custom application routes
app.use('/', routes);
// Automatically route pages
app.get(/^([^.]+)$/, (req, res, next) => {
automaticRouting.matchRoutes(req, res, next);
});
// Check if the app is using documentation
if (useDocumentation || onlyDocumentation === 'true') {
// Documentation routes
app.use('/docs', documentationApp);
// Nunjucks configuration for documentation
const docViews = [
path.join(__dirname, 'docs/views/'),
path.join(__dirname, 'node_modules/nhsuk-frontend/packages/components'),
];
nunjucksAppEnv = nunjucks.configure(docViews, {
autoescape: true,
express: documentationApp,
});
nunjucksAppEnv.addGlobal('version', packageInfo.version);
// Add Nunjucks filters
utils.addNunjucksFilters(nunjucksAppEnv);
// Automatically store all data users enter
if (useAutoStoreData === 'true') {
documentationApp.use(utils.autoStoreData);
utils.addCheckedFunction(nunjucksAppEnv);
}
// Support for parsing data in POSTs
documentationApp.use(bodyParser.json());
documentationApp.use(bodyParser.urlencoded({
extended: true,
}));
// Custom documentation routes
documentationApp.use('/', documentationRoutes);
// Automatically route documentation pages
documentationApp.get(/^([^.]+)$/, (req, res, next) => {
automaticRouting.matchRoutes(req, res, next);
});
}
// Clear all data in session if you open /examples/passing-data/clear-data
app.post('/examples/passing-data/clear-data', (req, res) => {
req.session.data = {};
res.render('examples/passing-data/clear-data-success');
});
app.use('/prototype-admin', prototypeAdminRoutes);
// Redirect all POSTs to GETs - this allows users to use POST for autoStoreData
app.post(/^\/([^.]+)$/, (req, res) => {
res.redirect(`/${req.params[0]}`);
});
// Catch 404 and forward to error handler
app.use((req, res, next) => {
const err = new Error(`Page not found: ${req.path}`); // eslint-disable-line no-console
err.status = 404;
next(err);
});
// Display error
app.use((err, req, res) => {
console.error(err.message); // eslint-disable-line no-console
res.status(err.status || 500);
res.send(err.message);
});
// Run the application
app.listen(port);
module.exports = app;