@mcf/server-boilerplate-middleware

Boilerplate middleware for Node projects in MyCareersFuture.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
324Jun 11, 2021May 10, 2018Minified + gzip package size for @mcf/server-boilerplate-middleware in KB

Readme

npm version

Boilerplate Middleware

Boilerplate middleware for Node projects in MyCareersFuture.

Scope

  • express compatible server
  • cookie handling
  • json body data handling ("application/json")
  • form body data handling ("application/x-www-form-urlencoded")
  • basic http header security
  • content security policy
  • cross-origin-resource-sharing support
  • application metrics
  • server request logging
  • distributed tracing
  • endpoint: /healthz
  • endpoint protection for /healthz
  • endpoint: /readyz
  • endpoint protection for /readyz
  • endpoint: /metrics
  • endpoint protection for /metrics

Installation

Install it via npm or yarn:

npm i @mcf/server-boilerplate-middleware
# or
yarn add @mcf/server-boilerplate-middleware

Usage

import {createServer} from '@mcf/server-boilerplate-middleware';
const server = createServer();
// ...

API

The returned server is an Express server with the following additional APIs.

Options

Options are passed into the constructor function to create the server

import {createServer} from '@mcf/server-boilerplate-middleware';
const {server} = createServer({
  ...options,
});

enableCookieParser : Boolean

Type Default Example
Boolean true serverBoilerplate({enableCookieParser: true})

enableCompression : Boolean

Type Default Example
Boolean true serverBoilerplate({enableCompression: true})

enableCSP : Boolean

Type Default Example
Boolean true serverBoilerplate({enableCSP: true})

enableCORS : Boolean

Type Default Example
Boolean true serverBoilerplate({enableCORS: true})

enableHttpHeadersSecurity : Boolean

Type Default Example
Boolean true serverBoilerplate({enableHttpHeadersSecurity: true})

enableMetrics : Boolean

Type Default Example
Boolean true serverBoilerplate({enableMetrics: true})

enableSerializer : Boolean

Type Default Example
Boolean true serverBoilerplate({enableSerializer: true})

enableServerLogging : Boolean

Type Default Example
Boolean true serverBoilerplate({enableServerLogging: true})

enableXray : Boolean

Type Default Example
Boolean true serverBoilerplate({enableXray: true})

compressionOptions : Object

This configuration is only relevant if the enableCompression parameter was not set to false

Key Type Notes Defaults To
chunkSize Number size in bytes of chunk 16384
level Number 0-9 - see https://www.npmjs.com/package/compression for more information 9
threshold Number minimum size in bytes before compression kicks in 102400

Defaults to:

const conpressionOptions = {
  chunkSize: 16 * 1024, // 16kb
  level: 9,
  threshold: 300 * 1024, // 300kb
}

cspOptions : Object

This option is only relevant if the enableCSP flag is not set to false.

Key Type Notes Defaults To
childSrc Array<String> populates the child-src value of the CSP header ['\'none\'']
connectSrc Array<String> populates the connect-src value of the CSP header ['\'none\'']
defaultSrc Array<String> populates the default-src value of the CSP header ['\'none\'']
fontSrc Array<String> populates the font-src value of the CSP header ['\'none\'']
imgSrc Array<String> populates the img-src value of the CSP header ['\'none\'']
scriptSrc Array<String> populates the script-src value of the CSP header ['\'none\'']
styleSrc Array<String> populates the style-src value of the CSP header ['\'none\'']
reportUri String populates the report-uri value of the CSP header '/csp-report'

Defaults to:

const cspOptions = {
  childSrc: ['\'none\''],
  connectSrc: ['\'none\''],
  defaultSrc: ['\'none\''],
  fontSrc: ['\'none\''],
  imgSrc: ['\'none\''],
  scriptSrc: ['\'none\''],
  styleSrc: ['\'none\''],
  reportUri: '/csp-report',
}

The above configuration produces the following CSP:

"child-src 'none'; connect-src 'none'; default-src 'none'; font-src 'none'; img-src 'none'; script-src 'none'; style-src 'none'; report-uri /csp-report"

corsOptions : Object

This configuration is only relevant if the enableCORS parameter was not set to false

Key Type Notes Defaults To
allowedHeaders Array<String> provides the Access-Control-Allow-Headers header value []
allowedMethods Array<String> provides the Access-Control-Allow-Methods header value ['GET', 'POST', 'PATCH', 'PUT', 'DELETE', 'OPTIONS']
allowedOrigins Array<String> provides the Access-Control-Allow-Origins header value []
credentials Boolean provides the Access-Control-Allow-Credentials header value true
preflightContinue Boolean decides whether to pass the request on or respond with 204 false

Defaults to:

const corsOptions = {
  allowedHeaders: [],
  allowedMethods: ['GET', 'POST', 'PATCH', 'PUT', 'DELETE', 'OPTIONS'],
  allowedOrigins: [],
  credentials: true,
  preflightContinue: false,
}

metricsOptions : Object

This configuration is only relevant if the enableMetrics parameter was not set to false

Key Type Notes Defaults To
livenessCheckEndpoint String defines the liveness check endpoint for ignoring in metrics '/healthz'
metricsEndpoint String defines the metrics endpoint for ignoring in metrics '/metrics'
probeIntervalInMilliseconds Number defines interval between metrics scrape 3000
readinessCheckEndpoint String defines the readiness check endpoint for ignoring in metrics '/readyz'
pushgatewayUrl String defines the pushgateway URL - when this is not null, the pushgateway is considered activated null
pushgatewayJobName String defines the job name of the job being pushed to the pushgateway - use this to define the application instance when running in a cluster `process.env.USER
pushgatewayTimeout Number defines the timeout of the pushgateway if enabled 10000

Defaults to:

const metricsOptions = {
  livenessCheckEndpoint: '/healthz',
  metricsEndpoint: '/metrics',
  probeIntervalInMilliseconds: 3000,
  readinessCheckEndpoint: '/readyz',
  pushgatewayUrl: null,
  pushgatewayJobName: process.env.USER || 'unknown',
  pushgatewayTimeout: 10000,
}

loggingOptions : Object

This configuration is only relevant if the enableServerLogging parameter was not set to false

Key Type Notes Defaults To
additionalTokenizers Array of Tokenizers Additional tokenizers with the schema {id: string, fn: (req: Request, res: Response) => any} []
logger IApplicationLogger Used by the server to create a child logger undefined
logStream String Specifies a stream to use instead of the default console. For example, use this to link Morgan up with Winston null
hostnameType String If set to "os", the os.hostname() will be used. For all other values, process.env[hostnameType] is used. "os"

Defaults to:

const loggingOptions = {
  additionalTokenizers: [],
  logger: createLogger(),
  logStream: null,
  hostnameType: 'os',
}

Development

Installing Dependencies

Run the following from the root of the repository to initialise the dependencies since Lerna manages the dependencies for us across the multiple packages:

npx lerna bootstrap

Running Tests

To run the tests during development, use at the root directory:

npx lerna run --scope @mcf/server-boilerplate-middleware test:watch

To run the tests on the built package, use:

npx lerna run --scope @mcf/server-boilerplate-middleware test

To run a test server using the boilerplate server, use:

npx lerna run --scope @mcf/server-boilerplate-middleware start

Building

npx lerna run --scope @mcf/server-boilerplate-middleware build

Integration Example

Run the following to setup an example environment:

Open a new terminal and run the following to create server a on port 11111:

SVC_ID=a PORT=11111 npm start;

Open another terminal and run the following to create server b on port 22222:

RSVC_ID=a SVC_ID=b PORT=22222 PROXY_PORT=11111 npm start;

Verify that your local Zipkin instance works and then run the following in yet another terminal to demonstrate tracing:

curl "http://localhost:22222/proxy";

ChangeLog

0.8.x

0.8.5

  • removed zipkin
  • added aws xray tracing

0.8.2-4

  • added keepalive and header timeout configuration

0.8.1

  • changed configuration signature for tracing

0.7.x

0.7.0

  • added distributed tracing capabilities
  • server instance now exports the following methods:
    • .getTracer()
    • .getContext()
    • .getRequest()

0.6.x

0.6.4

  • added :logStream property in loggingOptions options for providing Morgan with a custom logger to use

    0.6.0

  • added Morgan server request logging

    0.5.x

    0.5.3

  • changed the preflightContinue option to be false by default

    0.5.1

  • added features to accommodate a push gateway model (see pushgatewayUrl, pushgatewayTimeout and pushgatewayJobName for more info)
  • if pushgatewayUrl is defined in the metricsOptions options property, the push gateway metrics flow model is activated, metrics will be pushed every :probeIntervalInMilliseconds milliseconds`

    0.5.0

  • added Prometheus metrics (see enableMetrics and metricsOptions properties)

    0.4.0

  • added CORS support (see enableCORS and corsOptions)

    0.3.x

    0.3.1

  • added gzip compression module

    0.3.0

  • refactored security module into two submodules: http headers and csp
  • also changed API for content security policy (CSP)
  • added new flag, enableCSP, for server initialisation

    0.2.x

    0.2.1

  • added connect-src to CSP configuration

    0.2.0

  • fixed ci pipeline problems, no changes to functionality, we can now expect stably numbered patch releases

    0.1.x

    0.1.0

  • added content security policy configuration for:
    • 'default-src'
    • 'child-src'
    • 'font-src'
    • 'img-src'
    • 'script-src'
    • 'style-src'
    • 'report-uri'
  • added basic http security headers
    • hides 'x-powered-by'
    • adds 'x-xss-protection: 1; mode=block'
    • adds 'x-content-type-options : nosniff'
    • adds 'x-dns-prefetch-control : off'
    • adds 'x-download-options : noopen'
    • adds 'x-frame-options : SAMEORIGIN'
    • adds 'strict-transport-security : max-age=15552000; includeSubDomains'
  • added body data parsing suport for Content-Type: application/json
  • added body data parsing suport for Content-Type: application/x-www-form-urlencoded
  • added cookie parsing superpowers

0.0.x

0.0.4

  • fixed behaviour to allow import via require('@mcf/server-boilerplate-middleware') without a .default property

0.0.2

  • initial commit with an Express compatible server

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.