Repository navigation
Expand file tree
/
Copy pathserver.js
More file actions
327 lines (283 loc) · 10 KB
/
Copy pathserver.js
File metadata and controls
327 lines (283 loc) · 10 KB
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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
require("dotenv").config({ quiet: true });
const fs = require("fs");
const bodyParser = require("body-parser");
const bodyParserErrorHandler = require("express-body-parser-error-handler");
const cors = require("cors");
const yaml = require("js-yaml");
const helmet = require("helmet");
const { Elm } = require(process.env.SERVER_APP || "./server-app");
const jsonUtils = require("./lib/json");
const rateLimit = require("express-rate-limit");
const {
API_DOCS_URL,
createCSPDirectives,
grantGenericApiAccess,
extractTokenFromHeaders,
handleDetailedImpactsRequest,
} = require("./lib/http");
// monitoring
const { setupSentry } = require("./lib/sentry"); // MUST be required BEFORE express
const { createMatomoTracker } = require("./lib/matomo");
const { createPlausibleTracker } = require("./lib/plausible");
const {
filterLegacyFood1Paths,
getDetailedProcessesAsString,
getProcessesAsString,
} = require("./lib");
const {
applyGenericSectorsToOpenApi,
getEnabledGenericSectorEntries,
isGenericSectorEnabled,
parseGenericSectorFromUrl,
} = require("./lib/sectors");
const express = require("express");
const expressHost = "0.0.0.0";
const expressPort = 8001;
// Env vars
const {
ENABLE_FOOD_SECTION,
ENABLE_FOOD1_API_DOCS,
NODE_ENV,
RATELIMIT_MAX_RPM,
RATELIMIT_WHITELIST,
} = process.env;
const INTERNAL_BACKEND_URL = "http://localhost:8002";
const app = express(); // web app
const api = express(); // api app
// Rate-limiting
const rateLimitWhitelist = RATELIMIT_WHITELIST?.split(",").filter(Boolean) ?? [];
const rateLimitMaxRPM = parseInt(RATELIMIT_MAX_RPM, 10) || 5000;
// Make rate-limiting working with X-Forwarded-For headers
app.set("trust proxy", 1);
app.use(
rateLimit({
windowMs: 60 * 1000, // 1 minute
max: rateLimitMaxRPM,
message: { error: `This server is rate-limited to ${rateLimitMaxRPM}rpm, please slow down.` },
skip: ({ ip }) => NODE_ENV !== "production" || rateLimitWhitelist.includes(ip),
}),
);
// Sentry monitoring
setupSentry(app);
// Plausible API tracker
const plausibleTracker = createPlausibleTracker(process.env);
// Matomo
const matomoTracker = createMatomoTracker(process.env);
// Middleware
const jsonErrorHandler = bodyParserErrorHandler({
onError: (err, req, res, next) => {
res.status(400).send({
error: { decoding: `Format JSON invalide : ${err.message}` },
documentation: API_DOCS_URL,
});
},
});
// Web
// Note: helmet middlewares have to be called *after* the Sentry middleware
// but *before* other middlewares to be applied effectively
app.use(
helmet({
crossOriginEmbedderPolicy: false,
hsts: false,
xssFilter: false,
contentSecurityPolicy: {
useDefaults: true,
directives: createCSPDirectives(process.env),
},
}),
);
// Deny public access to detailed impacts as a static asset
// Note: counter intuitively, this must be registered *before* the static file serving
// middleware, otherwise it's ignored
app.get("/data/processes_impacts.json", (_, res) => res.sendStatus(404));
app.use(
express.static("dist", {
setHeaders: (res) => {
// Note: helmet sets this header to `0` by default and doesn't allow overriding
// this value
res.set("X-XSS-Protection", "1; mode=block");
},
}),
);
// Redirects: Web
app.get("/accessibilite", (_, res) => res.redirect("/#/pages/accessibilité"));
app.get("/mentions-legales", (_, res) => res.redirect("/#/pages/mentions-légales"));
app.get("/stats", (_, res) => res.redirect("/#/stats"));
// API
const openApiContents = processOpenApi(
yaml.load(fs.readFileSync("openapi.yaml")),
require("./package.json").version,
);
function processOpenApi(contents, versionNumber) {
// Add app version info to openapi docs
contents.info.version = versionNumber;
// Remove food1 api docs if disabled from env
if (ENABLE_FOOD_SECTION !== "True" || ENABLE_FOOD1_API_DOCS !== "True") {
contents.paths = filterLegacyFood1Paths(contents.paths);
}
applyGenericSectorsToOpenApi(contents);
return contents;
}
// Processes
//
// Merge generic and legacy format for the time being. To do so we need to parse the JSON
// concat the arrays and the stringify again the whole thing
// Elm decoders should handle the differences between the two formats
const processesImpacts = getDetailedProcessesAsString();
const processes = getProcessesAsString();
const resolveProcesses = async (headers) => {
const token = extractTokenFromHeaders(headers);
if (NODE_ENV === "test") {
// bypass validation in test env
return { status: 200, body: processesImpacts || processes };
} else if (!token) {
// no token passed: serve public file
return { status: 200, body: processes };
} else {
// validate token
try {
const { status } = await fetch(`${INTERNAL_BACKEND_URL}/api/tokens/validate`, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({ token }),
});
return handleDetailedImpactsRequest(status, processesImpacts);
} catch (error) {
console.error("Error validating token from the auth backend", error);
return handleDetailedImpactsRequest(500);
}
}
};
/**
* Generic API requires a validated beta or superuser token.
*/
async function checkGenericApiAccess(token) {
// bypass betauser checks in tests
if (NODE_ENV === "test") {
return null;
}
try {
const tokenRes = await fetch(`${INTERNAL_BACKEND_URL}/api/tokens/validate`, {
method: "POST",
body: JSON.stringify({ token }),
});
const claims = tokenRes.status === 201 ? await tokenRes.json() : {};
return grantGenericApiAccess(tokenRes.status, claims);
} catch (error) {
console.error("Error validating token from the auth backend", error);
return {
status: 500,
body: {
error: { server: `Erreur du serveur d'authentification: ${error.message}` },
documentation: API_DOCS_URL,
},
};
}
}
app.get("/processes/processes.json", async (req, res) => {
const selected = await resolveProcesses(req.headers);
if (selected.status === 200) {
// Note: JSON parsing is done in Elm land
return res.status(200).contentType("text/plain").send(JSON.stringify(selected.body));
} else {
return res.status(selected.status).json(selected.body);
}
});
/**
* Initialize the Elm server worker app.
*
* Note: This process loads the bundle optionally set by `SERVER_APP` or the one from
* `server-app.js` by default. `elm make` only ever compiles a single entry module into
* that file, so the bundle contains either `ServerProd` or `ServerTest`, never *both*.
*/
function initElmApp(Elm) {
if (Elm.ServerProd) {
return Elm.ServerProd.init();
} else if (Elm.ServerTest) {
return Elm.ServerTest.init();
} else {
throw new Error("The Elm bundle has no ServerProd or ServerTest entry point.");
}
}
const elmApp = initElmApp(Elm);
elmApp.ports.output.subscribe(({ status, body, jsResponseHandler }) => {
return jsResponseHandler({ status, body });
});
api.get("/", async (req, res) => {
matomoTracker.track(200, req);
await plausibleTracker.captureEvent(200, req);
res.status(200).send(openApiContents);
});
const respondWithFormattedJSON = (res, status, body) => {
res.status(status);
res.setHeader("Content-Type", "application/json");
res.send(jsonUtils.serialize(body));
};
api.get("/generic/scopes", async (req, res) => {
const token = extractTokenFromHeaders(req.headers);
if (!token && NODE_ENV !== "test") {
return res.status(401).send({
error: { authorization: "Un token valide est requis pour utiliser l’API" },
documentation: API_DOCS_URL,
});
}
const rejected = await checkGenericApiAccess(token);
if (rejected) {
return res.status(rejected.status).send(rejected.body);
}
matomoTracker.track(200, req);
await plausibleTracker.captureEvent(200, req);
respondWithFormattedJSON(res, 200, getEnabledGenericSectorEntries());
});
// Redirects: API
api.get(/^\/countries$/, (_, res) => res.redirect("textile/countries"));
api.get(/^\/materials$/, (_, res) => res.redirect("textile/materials"));
api.get(/^\/products$/, (_, res) => res.redirect("textile/products"));
const cleanRedirect = (url) => (url.startsWith("/") ? url : "");
api.get(/^\/simulator(.*)$/, ({ url }, res) => res.redirect(`/api/textile${cleanRedirect(url)}`));
// Note: Text/JSON request body parser (JSON is decoded in Elm)
api.all(/(.*)/, bodyParser.json(), jsonErrorHandler, async (req, res) => {
const token = extractTokenFromHeaders(req.headers);
if (!token && NODE_ENV !== "test") {
return res.status(401).send({
error: { authorization: "Un token valide est requis pour utiliser l’API" },
documentation: API_DOCS_URL,
});
}
const sector = parseGenericSectorFromUrl(req.url);
if (sector) {
if (!isGenericSectorEnabled(sector)) {
return res.status(403).send({
error: { scope: `Le périmètre "${sector}" n'est pas activé sur cette instance.` },
documentation: API_DOCS_URL,
});
}
const rejected = await checkGenericApiAccess(token);
if (rejected) {
return res.status(rejected.status).send(rejected.body);
}
}
// retrieve detailed impacts; if for whatever reason they're not available, use non-detailed ones
const detailsRes = await resolveProcesses(req.headers);
const finalProcesses = detailsRes?.status === 200 ? detailsRes.body : processes;
elmApp.ports.input.send({
method: req.method,
protocol: req.protocol,
host: req.get("host"),
url: req.url,
version: null, // note: no way to infer a version number from the request containing none
body: req.body,
processes: finalProcesses,
jsResponseHandler: async ({ status, body }) => {
matomoTracker.track(status, req);
await plausibleTracker.captureEvent(status, req);
respondWithFormattedJSON(res, status, body);
},
});
});
api.use(cors()); // Enable CORS for all API requests
app.use("/api", api);
const server = app.listen(expressPort, expressHost, () => {
console.log(`Server listening at http://${expressHost}:${expressPort} (NODE_ENV=${NODE_ENV})`);
});
module.exports = server;