CHANGELOG.md

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

12.0.0 / 2022-04-03

Changed

• Update Awilix to v7.

11.0.0 / 2022-02-15

Changed

• Update Awilix to v6.
• Update @meltwater/mlabs-logger to v9.
• Update prom-client to v14.

10.2.0 / 2021-06-04

Added

• Register default execId as hostname.

10.1.0 / 2021-01-05

Changed

• No longer use peer dependencies.

10.0.0 / 2021-01-03

Added

• Publish as both ES and CommonJS module.

Changed

• (Breaking) Renamed export createClient to createHttpClient.
• (Breaking) Update prom-client to v13.
• (Breaking) Use Conditional Exports to provide ES or CommonJS module. Cannot import or require internal paths.
• (Breaking) Drop support for Node.js versions before 12.13.0.

Removed

• (Breaking) The default export.

9.0.0 / 2020-11-17

Changed

• Update all dependencies and test on Node Fermium.
• License to MIT.

8.3.0 / 2020-06-17

Changed

• Update all dependencies.

8.2.1 / 2020-05-05

Fixed

• Disallow invalid metric prefix and coerce to snake case to optimistically fix invalid prefix.

8.2.0 / 2020-04-22

Fixed

• Downgrade to @koa/router v8. See koajs/router#79.

8.1.0 / 2020-04-13

Changed

• Update to @koa/router v9.

8.0.0 / 2020-02-25

Changed

• Replace koa-router with @koa/router.
• Update to uuid v7.
• Update to confit to v3.
• Update to prom-client v12.
• Update to @hapi/boom v9.

7.11.0 / 2019-10-21

Changed

• Update to @hapi/boom v8.

7.10.0 / 2019-09-26

Added

• New option origins to cors config to whitelist origins.

Changed

• Update to koa-helmet v5.

7.9.0 / 2019-05-31

Added

• Merge process.versions into root package data.

7.8.0 / 2019-05-09

Added

• Generate and log execId on every request.

Changed

• Update to Chokidar v3.

7.7.1 / 2019-05-03

Changed

• Move to @hapi/boom from boom,

7.7.0 / 2019-04-19

Changed

• Option to delay startup for startupDelay milliseconds.

7.6.0 / 2019-04-11

Changed

• Open source under the Apache License, Version 2.0!

7.5.0 / 2019-03-28

Changed

• Update to @meltwater/mlabs-health v1.2.0.
• Update to @meltwater/mlabs-logger v5.2.0.
• Update to @koa/cors v3.

7.4.0 / 2019-02-27

Added

• Return watcher and ready from createServer.

Fixed

• Ensure watcher ready event is not missed.

7.3.2 / 2019-02-20

Fixed

• Ensure watcher is ready before loading config.

7.3.1 / 2019-02-20

Fixed

• Race condition on startup config watcher: see paulmillr/chokidar#612.

7.3.0 / 2019-02-15

Added

• shutdownTimeout to prevent stop promise from hanging server.

7.2.0 / 2019-01-18

Added

• Request logs now include reqMethod, reqUrl, and resStatusCode at the top-level.

7.1.1 / 2019-01-05

Changed

• Resolve start and stop only when needed.

7.1.0 / 2019-01-04

Added

• Register the HTTP server as server.

Changed

• Update to makenew-node-lib v5.3.1.

7.0.1 / 2018-12-17

Changed

• Update to makenew-node-lib v5.3.0.

7.0.0 / 2018-10-22

Added

• createHealthCheck function.
• New option exitOnUnhandledRejection (default true).
• App metrics via new dependencies and config options.
• Top level log properties to categorize log messages: isLifecycleLog, isRequestLog, isAppLog, and isHealthLog.

Changed

• (Breaking) Update Awilix peer dependency to version 4.
• (Breaking) Process will exit on unhandledRejection. Disable this with the config option exitOnUnhandledRejection.
• (Breaking) isLifecycle log property renamed to isLifecycleLog.

Fixed

• Use final logger to ensure logging on exit.

6.0.0 / 2018-09-27

Changed

• (Breaking) httpGetJson takes an options object and not a string. The string parameter was incompatible with http.request.
• Update to koa-mount v4.
• Update to new minimum @meltwater package versions.
• Update to @meltwater/mlabs-logger v5.0.0.
• Update to makenew-node-lib v5.1.0.

Fixed

• httpGetJson sends accepts header and properly handles errors.

5.1.0 / 2018-08-30

Changed

• Update to @meltwater/mlabs-logger v5.0.0.
• Update to makenew-node-lib v4.7.2.

5.0.0 / 2018-06-06

Changed

• (Breaking) Health middleware now waits for health checks to resolve before returning health status.
• All previously required dependencies are now optional. If one is unregistered, a default will be registered instead.
• Both configPath and createDependencies are now optional.
• A global reqId is registered for dependencies that need it outside of a request (on startup for example).

Added

• New option exitOnFalseStart (default true). If false, the server will not crash if start rejects, but it will never enter a ready state.

4.0.1 / 2018-05-27

Fixed

• Only call stop and other shutdown logic once.

4.0.0 / 2018-05-25

Added

• Option to shutdown on config changes: shutdownOnChange. Default is true.

3.0.0 / 2018-05-11

Added

• Readiness middleware to track if server is ready to handle requests.
• Option to delay shutdown for shutdownDelay milliseconds.

Changed

• Server will not shutdown on config change: instead it will fail readiness check.
• Koa server starts before registered start function is called.

Fixed

• koaHealthy responded with JSON instead of plain text when requests do not send accept header.

2.3.0 / 2018-04-13

Added

• Serve Prometheus metrics at /metrics by adding a registry to dependencies.

2.2.0 / 2018-04-03

Changed

• Handle errors on server listen by logging and shutting down.

2.1.2 / 2018-03-29

Changed

• Update to koa-helmet v4.
• Update to mlabs-logger v4.1.1.
• Update to makenew-node-lib v4.6.1.

2.1.1 / 2018-02-27

Changed

• Update to @meltwater/phi v2.
• Update to makenew-node-lib v4.5.0.

2.1.0 / 2018-02-25

Changed

• Use default config value when environment variable is empty string.
• Update to makenew-node-lib v4.4.1.

Fixed

• Case where log outputMode would be ignored.

2.0.0 / 2018-02-02

Added

• Filter logs in development with new options logFilters and filter.
• Select logOutputModein development.
• Corresponding overrides for the above with LOG_OUTPUT_MODE and LOG_FILTER.
• Ability to override log version property.
• Convenience method httpGetJson.

Changed

• Update to mlabs-logger version 4 which now uses Pino.
• Default logger properties must be under the base option. The base option will be merged with the standard Pino base defaults.
• (Breaking) Logs are now formatted in development according to log outputMode. No need to pipe logs through an external CLI formatter.
• (Breaking) Remove useProduction logger option and replace with useDev and addReq.
• Update to makenew-node-lib v4.3.4.

1.7.0 / 2018-01-25

Changed

• If ctx.body is set and an error is thrown (either directly or via ctx.status), the body will be respected and sent unmodified instead of sending the standard error payload.

Fixed

• Throw a corresponding Boom error when ctx.status is set. Previously only a 404 status would throw a proper error.

1.6.1 / 2018-01-18

Changed

• Update to makenew-node-lib v4.1.12.

1.6.0 / 2018-01-18

Added

• Log reqName from x-request-name header.
• Log statusCode under http property.

Changed

• Update to makenew-node-lib v4.1.11.

1.5.0 / 2018-01-10

Added

• createServer now returns exit function.

Changed

• Update to makenew-node-lib v4.1.10.

1.4.1 / 2018-01-03

Changed

• Update to makenew-node-lib v4.1.9.
• Update chokidar to version 2.

1.4.0 / 2017-12-14

Changed

• Do not load hidden files (dotfiles) as secrets of configs.

1.3.1 / 2017-12-14

Fixed

• Watching recursive config paths on Linux.

1.3.0 / 2017-12-14

Added

• Override log level with LOG_LEVEL.

1.2.0 / 2017-12-13

Added

• Load all config files under env.d and local.d.
• Load contents of files under secret.d into config.

1.1.0 / 2017-12-12

Added

• All lifecycle logs messages set isLifecycle: true.

Changed

• Update to makenew-node-lib v4.1.8.

1.0.0 / 2017-12-11

• Initial release.