Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 | 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 10x 10x 10x 10x 73x 73x 73x 73x 73x 73x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 9x 9x 1x 1x 9x 9x 9x 97x 97x 97x 85x 85x 12x 12x 12x 9x 32x 32x 32x 32x 32x 32x 9x 4x | const { resolveSchema, isValidVersion } = require('./utils/schema.utils');
const deprecate = require('./utils/deprecation.notice');
const ServerError = require('./utils/server.error');
const invariant = require('./utils/invariant');
const prototypeInjectionHandler = require('./utils/prototype-injection-handler.utils');
const { VERSIONS } = require('../constants');
const compression = require('compression');
const bodyParser = require('body-parser');
const favicon = require('serve-favicon');
const loggers = require('./winston');
const router = require('./router');
const passport = require('passport');
const express = require('express');
const helmet = require('helmet');
const https = require('https');
const http = require('http');
const path = require('path');
const fs = require('fs');
/**
* @name mergeDefaults
* @description Merge defaults into provided config
* @param {Object} config
* @return {Object} config merged with defaults
*/
function mergeDefaults(providedConfig) {
// Define any default settings the server should have to get up and running
let defaults = {
profiles: {},
server: {},
logging: {
level: 'debug',
},
};
return Object.assign(defaults, providedConfig);
}
/**
* @name verifyAndLoadProfiles
* @description Attempt to load profiles
* @param {Object} profiles
* @return {Array<String>} Formatted error messages for all encountered issues
*/
function verifyAndLoadProfiles(profiles) {
let errors = [];
// At this stage, we are only validating the configuration, not the server's
// support for the given profile. We will do that in the when setting up routes
// This may change for future versions when we generate new resources and we
// can more easily perform the validation here
Object.getOwnPropertyNames(profiles).forEach((name) => {
let versions = profiles[name].versions;
let service = profiles[name].service;
let message;
// No service provided, we cannot load it
Iif (!service || !versions) {
message = `Invalid ${name} configuration. Missing service and/or versions.`;
} else {
try {
profiles[name].serviceModule =
typeof service === 'string' ? require(path.resolve(service)) : service;
} catch (err) {
message = `Invalid ${name} configuration. ${err.message}`;
}
}
// Add the error message if we have one
Iif (message) {
errors.push(message);
}
});
return errors;
}
/**
* @name validate
* @description Validate the config and provide defaults for some values
* @param {Object} config
*/
function validate(config) {
// If the ssl config is present, it must have a key and cert
invariant(
!config.server.ssl || (config.server.ssl && config.server.ssl.key && config.server.ssl.cert),
'Invalid SSL Configuration, Please see the Wiki for a guide on how to setup SSL. ' +
'See https://github.com/Asymmetrik/node-fhir-server-core/blob/master/docs/ServerConfiguration.md'
);
// If we have no profiles configured, notify them now
invariant(
Object.keys(config.profiles).length > 0,
'No profiles configured. We do not enable any profiles by default so please ' +
'review the profile wiki for how to enable profiles and capabilities. ' +
'See https://github.com/Asymmetrik/node-fhir-server-core/blob/master/docs/ConfiguringProfiles.md'
);
// We need to verify that each provided key is valid and that the config
// for that profile contains a service that we can load. Let's compile a list
// of errors while loading them.
let errors = verifyAndLoadProfiles(config.profiles);
invariant(
errors.length === 0,
'Encountered the following errors attempting to load your provided profiles:' +
`\n${errors.join('\n')}\n` +
'See https://github.com/Asymmetrik/node-fhir-server-core/blob/master/docs/ConfiguringProfiles.md'
);
}
class Server {
constructor(config = {}, app) {
// Merge in any defaults we want to set at the server level
this.config = mergeDefaults(config);
// Setup a logger for the application
loggers.initialize(this.config.logging);
// Validate the config has minimum required settings to run
validate(this.config);
// TODO: REMOVE: logger in future versions, emit notices for now
this.logger = deprecate(
loggers.get('default'),
'Using the logger this way is deprecated. Please see the documentation on ' +
'BREAKING CHANGES in version 2.0.0 for instructions on how to upgrade.'
);
// Use external express instance or setup new one
this.app = app ? app : express();
// Setup some environment variables handy for setup
let { server = {} } = this.config;
this.env = {
IS_PRODUCTION: !process.env.NODE_ENV || process.env.NODE_ENV === 'production',
USE_HTTPS: server.ssl && server.ssl.key && server.ssl.cert ? server.ssl : undefined,
};
// return self for chaining
return this;
}
// Configure middleware
configureMiddleware() {
//Enable error tracking request handler if supplied in config
Iif (this.config.errorTracking && this.config.errorTracking.requestHandler) {
this.app.use(this.config.errorTracking.requestHandler());
}
// Enable stack traces
this.app.set('showStackError', !this.env.IS_PRODUCTION);
// Add compression
this.app.use(compression({ level: 9 }));
// Enable the body parser
this.app.use(bodyParser.urlencoded({ extended: true }));
this.app.use(bodyParser.json({ type: ['application/fhir+json', 'application/json+fhir'] }));
// Enable @hapi/bourne to protect against prototype injection
this.app.use(prototypeInjectionHandler);
// Set favicon
this.app.use(
favicon(this.config.server.favicon || path.join(__dirname, '../assets/phoenix.ico'))
);
// return self for chaining
return this;
}
// Configure helmet
configureHelmet(helmetConfig) {
/**
* The following headers are turned on by default:
* - dnsPrefetchControl (Controle browser DNS prefetching). https://helmetjs.github.io/docs/dns-prefetch-control
* - frameguard (prevent clickjacking). https://helmetjs.github.io/docs/frameguard
* - hidePoweredBy (remove the X-Powered-By header). https://helmetjs.github.io/docs/hide-powered-by
* - hsts (HTTP strict transport security). https://helmetjs.github.io/docs/hsts
* - ieNoOpen (sets X-Download-Options for IE8+). https://helmetjs.github.io/docs/ienoopen
* - noSniff (prevent clients from sniffing MIME type). https://helmetjs.github.io/docs/dont-sniff-mimetype
* - xssFilter (adds small XSS protections). https://helmetjs.github.io/docs/xss-filter/
*/
this.app.use(
helmet(
helmetConfig || {
// Needs https running first
hsts: this.env.USE_HTTPS,
}
)
);
// return self for chaining
return this;
}
// Configure session
configureSession(session) {
// Session config can come from the core config as well, let's handle both cases
let { server = {} } = this.config;
// If a session was passed in the config, let's use it
Iif (session || server.sessionStore) {
this.app.use(session || server.sessionStore);
}
// return self for chaining
return this;
}
// Configure authorization
configureAuthorization() {
// return self for chaining
return this;
}
configurePassport() {
if (this.config.auth && this.config.auth.strategy) {
let { strategy } = require(path.resolve(this.config.auth.strategy.service));
passport.use(strategy);
}
// return self for chaining
return this;
}
// Setup a public directory for static assets
setPublicDirectory(publicDirectory = '') {
// Public config can come from the core config as well, let's handle both cases
let { server = {} } = this.config;
if (publicDirectory || server.publicDirectory) {
this.app.use(express.static(publicDirectory || server.publicDirectory));
}
// return self for chaining
return this;
}
// Setup profile routes
setProfileRoutes() {
router.setRoutes(this);
// return self for chaining
return this;
}
// Setup custom logging
configureLoggers(fun) {
fun(loggers.container, loggers.transports);
// return self for chaining
return this;
}
// Setup error routes
setErrorRoutes() {
let logger = loggers.get('default');
//Enable error tracking error handler if supplied in config
Iif (this.config.errorTracking && this.config.errorTracking.errorHandler) {
this.app.use(this.config.errorTracking.errorHandler());
}
// Generic catch all error handler
// Errors should be thrown with next and passed through
this.app.use((err, req, res, next) => {
// get base from URL instead of params since it might not be forwarded
const base = req.url.split('/')[1];
// Get an operation outcome for this instance
const OperationOutcome = resolveSchema(
isValidVersion(base) ? base : VERSIONS['4_0_1'],
'operationoutcome'
);
// If there is an error and it is an OperationOutcome
if (err && err.resourceType === OperationOutcome.resourceType) {
const status = err.statusCode || 500;
res.status(status).json(err);
} else if (err instanceof ServerError) {
const status = err.statusCode || 500;
res.status(status).json(new OperationOutcome(err));
} else Eif (err) {
const error = new OperationOutcome({
statusCode: 500,
issue: [
{
severity: 'error',
code: 'internal',
details: {
text: `Unexpected: ${err.message}`,
},
},
],
});
logger.error(error);
res.status(error.statusCode).json(error);
} else {
next();
}
});
// Nothing has responded by now, respond with 404
this.app.use((req, res) => {
// get base from URL instead of params since it might not be forwarded
const base = req.url.split('/')[1] || VERSIONS['4_0_1'];
let OperationOutcome;
if (Object.keys(VERSIONS).includes(base)) {
OperationOutcome = resolveSchema(base, 'operationoutcome');
} else E{
// if it's a misplaced URL, just return an R4 OperationOutcome
OperationOutcome = resolveSchema('4_0_1', 'operationoutcome');
}
// Get an operation outcome for this instance
const error = new OperationOutcome({
statusCode: 404,
issue: [
{
severity: 'error',
code: 'not-found',
details: {
text: `Invalid url: ${req.path}`,
},
},
],
});
logger.error(error);
res.status(error.statusCode).json(error);
});
// return self for chaining
return this;
}
// Start the server
listen(port = process.env.PORT, host = process.env.HOST, callback) {
// port and host will override configuration here if specified,
// if not, the params need to be reassigned appropriately
if (typeof host === 'function') {
callback = host;
host = process.env.HOST;
}
if (typeof port === 'function') {
callback = port;
port = process.env.PORT;
host = process.env.HOST;
}
let server = this.config.server;
// If we are missing a port, let's notify them
invariant(
port || server.port,
'Missing port. Please provide a port when initializing the server. See ' +
'https://github.com/Asymmetrik/node-fhir-server-core/blob/master/docs/ServerConfiguration.md'
);
// Update the express app to be in instance of createServer
this.app = !this.env.USE_HTTPS
? http.createServer(this.app)
: https.createServer(
{
key: fs.readFileSync(server.ssl.key),
cert: fs.readFileSync(server.ssl.cert),
},
this.app
);
// Start the app - will listen on 0.0.0.0 [::] if host is falsy
this.app.listen(port || server.port, host || server.host, callback);
}
}
module.exports = Server;
|