CHANGELOG.md

@bedrock/core ChangeLog

6.3.0 - 2024-11-19

Added

• Add bedrock.shutdown() call that performs an orderly shutdown and emits various events. This differs from exit() and process.exit() which are more immediate.
• Add bedrock.stopped event, emitted before bedrock.exit.
• Add documentation for bedrock.stop, bedrock.stopped, and bedrock.exit events.

Changed

• Deprecate undocumented bedrock-cli.exit event. Use bedrock.exit instead. If there is use case for this specific event, please file an issue.

6.2.0 - 2024-10-15

Changed

• Use serialize-error@11. No significant changes are expected.

Fixed

• Replace unmaintained uid-number package with passwd-user.

6.1.3 - 2024-03-06

Fixed

• Move eslint plugin to devDependencies.

6.1.2 - 2024-02-28

Fixed

• Publish proper LICENSE file.

6.1.1 - 2024-02-27

Fixed

• Relicense under the Apache-2.0 license.

6.1.0 - 2024-02-12

Changed

• Open Source under BSD-3-Clause license.
• Bump package.json Node.js version to 18.x (LTS).

6.0.1 - 2022-04-29

Fixed

• Fix default CLI command.

6.0.0 - 2022-04-28

Changed

• BREAKING: A number of changes have been made to BedrockError to bring it more inline with modern JavaScript errors and common practice and conventions within bedrock applications. Many of these changes are unlikely to break existing applications, but they could, so they are listed here.
  • toObject conversion now uses serialize-error internally for representing error stack traces.
  • A private or unspecified BedrockError, when converted to an object, now has a type of OperationError (instead of bedrock.InternalServerError. Most bedrock applications do not read or switch off of this value.
  • Using an array for the name of a BedrockError is disallowed, it must be a string. This usage is uncommon and unlikely to impact most applications.
  • When BedrockError is converted to an object, it includes both name and type (as the same value). The use of name is preferred, but type is preserved for backwards compatibility. Applications that strictly disallowed additional properties on errors will need to allow the name property to be present, but the name property is built into JavaScript errors and allowing for additional properties in errors is common practice such that this change is unlikely to affect many applications. The type property may be removed in the future, so applications should normalize to using name.
  • isType, hasType, hasCauseOfType have been removed. Use the nullish coalescing operator and compare against name instead. Subtle mistakes can also be made by writing code that is not specific to the location that particular errors occur in a causal chain, so these functions have been removed to avoid those problems. These functions are already rarely used in modern bedrock modules and applications.
• BREAKING: Top-level variables used in computed config templates must use valid JavaScript variable names, e.g., they cannot include hyphens (-) or periods (.). A future version may remove compute config templates entirely; functions should be used instead for computed configs.
• BREAKING: config.paths.cache and config.paths.log are now listed as requiring overriding in deployments. This replaces the custom code that would log a warning if they were not set.
• BREAKING: Use commander@9. An important change is that bedrock.program no longer has properties for command line options, those are accessed via bedrock.program.opts() instead. See: https://github.com/tj/commander.js/blob/master/CHANGELOG.md
• Calling bedrock.start more than once will cause an error to be thrown. This was already not supported and caused non-deterministic broken behavior, this change just makes it explicit and deterministic (the same clear error is always thrown).
• Replace error serializer/deserializer errio with serialize-error. Should not be a breaking change.

Removed

• BREAKING: Remove winston mail transport. The winston mail transport which is disabled by default and not expected to be used in any applications using 5.x has been removed.
• BREAKING: Remove bedrock.util.callbackify. Import from node.js util if needed.
• BREAKING: Remove bedrock.util.hasValue.
• BREAKING: Remove bedrock.util.delay. Import from npm delay package if needed.
• BREAKING: Remove bedrock.util.uuid. Import from npm uuid package if needed.
• BREAKING: Remove bedrock.util.w3cDate.
• BREAKING: Remove bedrock.util.isObject.
• BREAKING: Remove bedrock.util.clone. Import from npm klona package if needed.
• BREAKING: Remove bedrock.util.boolify.
• BREAKING: Remove runOnceAsync. Use runOnce instead.
• BREAKING: Remove support for callback-based async event listeners. These are not supported and use of them may cause breakage.

5.1.1 - 2022-04-13

Fixed

• Fix imports.

5.1.0 - 2022-04-13

Changed

• Update dependencies:
  • @digitalbazaar/async-node-events.
  • commander@2.

5.0.8 - 2022-04-08

Fixed

• Ensure package.json is loaded properly.

5.0.7 - 2022-04-05

Fixed

• Update local dependencies.

5.0.6 - 2022-04-04

Fixed

• Fix winston child logger defaultMeta override bug. This fix was also backported to 4.5.1.

5.0.5 - 2022-03-31

Fixed

• Remove deprecated config.core.master.

5.0.4 - 2022-03-31

Fixed

• Remove unused dep esm.

5.0.3 - 2022-03-31

Fixed

• Fix index.js dev entry point.
• Fix test coverage scripts.

5.0.2 - 2022-03-31

Fixed

• Fix package.json to reflect node 14.x requirement.

5.0.1 - 2022-03-31

Fixed

• Fix erroneous test import statement.

5.0.0 - 2022-03-31

Changed

• BREAKING: Rename package to @bedrock/core.
• BREAKING: Convert to module (ESM).
• BREAKING: Remove default export.
• BREAKING: Require node 14.x.

4.5.1 - 2022-04-04 (backported fix)

Fixed

• Fix winston child logger defaultMeta override bug.

4.5.0 - 2022-03-22

Added

• Add main export that includes information about the main program module such as its filename. The main program module will be properly computed on bedrock workers to express not the worker filename but the filename of the first loaded module, e.g., if an application foo.js calls bedrock.start, then main includes the full path filename for foo.js whether running in the primary process on a worker process.

Changed

• Change internal implementation to use ESM + transpile using esm.js to CommonJS. Should be a non-breaking change.

4.4.3 - 2021-12-08

Fixed

• Ensure primary process does not exit before logger completes or errors so that the proper error code is returned.
• Ensure an orderly exit is performed when nothing else is scheduled to run on the event loop on the primary process.

4.4.2 - 2021-11-04

Fixed

• Signal handlers that prematurely terminated the primary or its workers have been refactored to allow an orderly exit. The primary and worker internal messaging and exit process has been cleaned up and simplified to help ensure more consistent outcomes and eliminate a number of bugs or unexpected states. Additionally, some unused IPC messages were removed. The expectation is that these changes do not affect existing applications except in those cases where those applications may have been exiting in inconsistent ways; the aim is for those applications to now exit the same way regardless of IPC message delivery order.

4.4.1 - 2021-09-21

Fixed

• Use Infinity for max event listeners instead of using 0 which is a proxy for it (from docs: "The value can be set to Infinity (or 0) to indicate an unlimited number of listeners."). Link: https://nodejs.org/api/events.html#events_emitter_setmaxlisteners_n This addresses problems with libraries (such as esm) that assume Infinity will be used and that make erroneous calculations if 0 is used instead (e.g., the esm library scales the max listeners from Infinity to 1 when the intention was to increase the max listeners by just 1).

4.4.0 - 2021-07-23

Added

• Add new config config.loggers.enableFileTransport with a default of true. One can disable all file based logging by setting this value to false. This is useful for deployment targets such as Kubernetes that are only concerned with console logs.

4.3.0 - 2021-07-02

Added

• Add unhandledRejection handler to deal with uncaught promises by causing the process to exit.

4.2.1 - 2021-07-01

Changed

• Replace 'master' language in process, config, and logging to use 'primary'.
• Backwards compatibility for config.core.master (removal planned for 5.x).

4.2.0 - 2021-06-30

Added

• Add POSIX signal handler to emit bedrock.exit event prior to exiting.

4.1.1 - 2020-12-18

Fixed

• Fix log levels in worker logger.

4.1.0 - 2020-12-09

Added

• Implement ensureConfigOverride configuration setting. This feature provides a mechanism for modules and top level applications to require that certain configuration values are changed during startup. This is useful when a deployment must use a different configuration than the development settings to be valid.

4.0.0 - 2020-12-07

Changed

• BREAKING: Use Winston logger 3.x. Bedrock configs for the various loggers are passed directly into the Winston logger constructors where there have been numerous breaking changes. This applies to config objects suchs as config.loggers.console. See: https://github.com/winstonjs/winston/blob/master/UPGRADE-3.0.md
• Various log formatters may be specified via the Bedrock config. The 'default' formatter produces logs that are equivalent to Bedrock 3.x. Custom formatters must conform to the logform API. See: https://github.com/winstonjs/logform

 // formatter options:
 // default, json, logstash or a custom formatter function
config.loggers.console.bedrock.formatter = 'default';

3.3.1 - 2020-12-07

Changed

• Replace lodash dependency with standalone per method packages.

3.3.0 - 2020-10-22

Added

• Add unique workerId per process.

3.2.0 - 2020-10-15

Added

• Log signal when workers exit.

3.1.2 - 2020-09-09

Changed

• Update winston-mail dependency.

3.1.1 - 2020-05-21

Changed

• Use GitHub Actions for CI testing.
• Update dependencies.

3.1.0 - 2019-11-13

Fixed

• Use workaround for master/worker child logger issue.

Changed

• Switch from getpwnam in posix to uid-number package.

3.0.1 - 2019-11-08

Fixed

• Update bedrock-test dependency.

3.0.0 - 2019-11-08

Changed

• BREAKING: Update Node.js requirement to v10.12.0.
• BREAKING: bedrock.start() now returns a promise instead of using a callback. Top-level code using the callback should change to async/await or then/catch as needed.
• BREAKING: Update async-node-events dependency and update events API.
  • emit is now an async function and used instead of passing a callback for completion. User code must be updated for this change. It is suggested to await the emit calls and use async listeners or Promises.
• BREAKING: runOnce callback form is removed in favor of the runOnceAsync implementation. runOnceAsync remains as an alias for runOnce but is deprecated. Quick fix is to wrap the new runOnce with callbackify and the fn param with promisify.
• Use master/worker child loggers.

Removed

• bedrock.events.emit wrapper. Using default from async-node-events.
• BREAKING: Deprecated event object style.

2.0.0 - 2019-10-22

Changed

• BREAKING: Remove mocha unit test framework. The test framework now resides entirely in the bedrock-test module@4.
• BREAKING: Remove bedrock.jsonld and related configuration. A jsonld document loader is now available in bedrock-jsonld-document-loader@1.

Added

• bedrock.util.hasValue helper API to replace jsonld.hasValue.

1.18.1 - 2019-07-24

Fixed

• Fix memory leak and improve error handling in runOnce and runOnceAsync.

1.18.0 - 2019-07-16

Changed

• Update lodash to 4.17.14.
• Switch to eslint.
• BREAKING: Update Node.js engine requirement to >= 8. Note this is due to the use of async/await when runOnceAsync was added in 1.16.0.

1.17.0 - 2019-05-06

Changed

• Improve callback function detection in events.emit API.

1.16.0 - 2019-04-30

Added

• bedrock.runOnceAsync API which is a promise based version of bedrock.runOnce.

1.15.0 - 2019-03-18

Added

• bedrock.util.delay API which is used to create a promise which resolves after the specified milliseconds.

Changed

• Use uuid-random for bedrock.util.uuid.

1.14.0 - 2018-11-29

Changed

• Change default value of bedrock.config.jsonld.strictSSL from false to true. This means that the jsonld library's document loader will refuse to retrieve documents from sites without proper SSL certificates. This change will impact unit tests in Bedrock modules. The strictSSL flag will need to be set to false in the test.config.js files for affected modules.

1.13.0 - 2018-09-20

Added

• Add bedrock-cli.parsed event.

Changed

• Update copyright notices.
• Style fixes.

1.12.1 - 2018-05-10

Changed

• Update async-node-events to 1.0.0.

1.12.0 - 2018-05-08

Added

• Return Promise from events.emit and events.emitLater that resolves to undefined once the event has been emitted to all listeners or to false if it was canceled.

1.11.0 - 2018-05-08

Added

• Add util.callbackify helper to produce functions that can be called with a callback function or that will return a Promise if the callback function is omitted. This utility function is used in bedrock modules that are written using Promises internally and that expose Promise-based public APIs that also support legacy callback patterns.

1.10.0 - 2018-04-06

Added

• --log-exclude option to eliminate logging from certain modules.

1.9.2 - 2018-03-28

Changed

• Update to newer worker API.
• Improve errors in runOnce calls.
• Use logger to handle uncaught error formatting.

1.9.1 - 2018-03-07

Changed

• Update from istanbul to nyc for coverage.

1.9.0 - 2018-03-01

Changed

• Update jsonld to 1.0.0.

1.8.0 - 2018-02-13

Changed

• Update jsonld to 0.5.x.
• Update many other dependencies.

Added

• --log-only option to log only certain modules.

1.7.1 - 2017-11-13

Fixed

• Update mocha dependency which addresses multiple security vulnerabilities.

1.7.0 - 2017-08-10

Added

• Add assertNoError(err) global test helper which makes an assertion that err should be falsy. If an error does occur, the full error will be logged to the console. The additional logging is helpful when troubleshooting tests that are failing due to a regression. This helper should be used in place of the commonly used should.not.exist(err) assertion.

1.6.0 - 2017-07-27

Changed

• Upgrade test related dependencies: mocha, chai, chai-as-promised.

1.5.0 - 2017-07-24

Added

• Add child(meta) method to create a child logger with common metadata for each logging call. The special module meta key can be used to prefix messages with [module] and is removed from the message details. child(name) is a shortcut for child({module: name}).

1.4.1 - 2017-02-02

Changed

• Deprecated default values for config.paths. A warning will be printed. A future major version will force values to be set by applications.

1.4.0 - 2016-12-09

Added

• Add config.paths with log and cache entries. This is designed to be a simple single point of configuration for the root logging and cache paths.

Changed

• Use computed configs:
  • Add common cache and log paths to config.paths.
  • Use common log path for default log files.

1.3.0 - 2016-12-07

Added

• Add bedrock.util.config utilities:
  • Add bedrock.util.config.Config OO wrapper API.
  • Common bedrock.util.config.main Config wrapper for bedrock.config.
  • See README for usage details.
• ci-test target with tap mocha reporter.

Changed

• Updated dependencies.
• Updated to node >= 6.

1.2.5 - 2016-07-29

Fixed

• Fix chown bug when posix doesn't exist and usernames are used.

1.2.4 - 2016-06-09

Changed

• Improve logging of simple object unhandled errors.

1.2.3 - 2016-06-01

Changed

• Use improved common uncaught exception handler.

1.2.2 - 2016-05-30

Changed

• Update docs.
• Update jscs linter rules.

1.2.1 - 2016-04-04

Fixed

• enableChownDir check typo.

1.2.0 - 2016-03-30

Added

• bedrock.config.loggers.*.bedrock for bedrock specific options.
• Add ...bedrock.enableChownDir boolean option to control chowning file logger directory to runtime userId.

1.1.1 - 2016-02-22

Fixed

• Check config.loggers properties are Objects before accsesing sub-properties. Fixes older configs that set other non-Object meta-data along with loggers.

1.1.0 - 2016-02-11

Added

• Add simpler and more explicit mechanism for adding new winston transports. Now a call to bedrock.loggers.addTransport can be made in event listeners handling the bedrock-loggers.init event.

1.0.10 - 2016-01-31

Changed

• Updated dependencies.

1.0.9 - 2015-10-27

Changed

• Updated jsonld.js to 0.4.2 to get URDNA2015 support.

1.0.8 - 2015-10-15

Changed

• Initialize jsonld document loader in bedrock.init event phase. Done to allow access to fully setup config. Warn if default document loader is used before jsonld initialized.

Fixed

• bedrock.config.jsonld.strictSSL used if available to configure jsonld document loader.

1.0.7 - 2015-10-15

Changed

• exit now calls worker kill() vs disconnect() and process.exit(). Appears to be more correct and works around a bug in node 4.x.

1.0.6 - 2015-09-15

Changed

• Update posix version to be compatible with node 4.0.0.

1.0.5 - 2015-09-14

Changed

• Updated jsonld and other versions.

1.0.4 - 2015-08-27

Changed

• Updated async to version 1.4.x.

1.0.3 - 2015-07-16

Fixed

• Bug that caused workers to not be restarted.

1.0.2 - 2015-07-12

Fixed

• Handle cycles in log message meta data.

1.0.1 - 2015-05-07

Changed

• Update dependencies.

1.0.0 - 2015-04-08

Changed

• BREAKING: A new event bedrock.admin.init was introduced that emits prior to bedrock.init. This new event is emitted while the process has any elevated privileges and after it is handled, elevated privileges are dropped. This changes bedrock.init so that it runs without elevated privileges. This only affected bedrock.server in a negative way; this module has been updated to comply with the change. Also, bedrock.init should no longer be used to emit custom events; these should be deferred to bedrock.start to prevent scenarios where a listener of an event emitted by one module can't use the API of another unrelated module because it hasn't been initialized yet. Deferring custom event emitting to bedrock.start as a best practice avoids this scenario.
• Updated JSCS rules.

0.3.2 - 2015-02-24

Fixed

• Fixed default command after upgrade to commander 2.6.

0.3.1 - 2015-02-23

Changed

• Updated commander to version 2.6.0.

0.3.0 - 2015-02-16

Breaking Changes

• Major package reorganization:
  • Files split into many sub-projects.
  • Bedrock server split into bedrock-* modules.
  • Bedrock frontend components split into bedrock-angular-* modules.
• Infrastructure changed to make composing a project from modules much easier.
• bedrock:
  • New event system for module initialization and communication.
  • Removed old bedrock.modules API.
  • config.app.* changed to config.core.*.
  • config.server.workers changed to config.core.workers.
  • Various code moved to modules or removed (iso8601 library, etc)
  • bedrock.security API removed. Other libraries such as jsonld-signatures can be used.
  • bedrock.tools renamed to bedrock.util; bedrock.tools is deprecated.
  • Config files:
    • Most files moved as examples in bedrock-seed.
    • Some values added as defaults in appropriate modules.
    • configs dir removed.
    • Development uses defaults.
    • Testing uses lib/test.config.js.
  • Removed config.environment in favor of feature flags.
  • config.core.starting.groupId and config.core.starting.userId used for master before logging initialized.
  • config.core.running.groupId and config.core.running.userId used for master and workers after logging initialized.
  • config.core.errors.showStack used to control general error stack traces.
  • config.jsonld.strictSSL used to control strict SSL of jsonld library.
  • config.views.serviceUnavailable to control 503 Service Unavailable for all requests.
  • config.core.masterTitle changed to config.core.master.title.
  • config.core.workerTitle changed to config.core.worker.title.
  • config.core.restartWorkers changed to config.core.worker.restart.
  • Remove uses of MODULE_NS.
  • Remove prefixes from errors and use simpler names.
  • Change many *NotFound error types to just NotFound.
• mail:
  • Per-module mapper files removed.
  • Modules push event handlers to bedrock.config.mail.events array:
    • {type: 'EVENT-TYPE', template: 'TEMPLATE-HANDLER-ID'}
  • Modules set config objects in bedrock.config.mail.templates.config[ID]:
    • {filename: 'FULL-FILENAME', [disabled: true]}
• express:
  • config.server.cache.* renamed to config.express.cache.*.
  • config.server.session.* renamed to config.express.session.*.
  • config.server.static renamed to config.express.static.
  • config.server.staticOptions renamed to config.express.staticOptions.
  • config.express.useSession to control session support.
  • config.express.dumpExceptions to control error exceptions.
  • config.express.showStack to control error stack traces.
• i18n:
  • config.website.i18nPaths renamed to config.i18n.localePath.
  • config.website.writeLocales renamed to config.i18n.writeLocales.
• schemas:
  • Schemas moved to bedrock-validation and other modules.
  • Modules push paths to bedrock.config.validation.schemas.paths array.
• mongodb:
  • config.database changed to config.mongodb.
  • bedrock-mongodb module now uses version 2.x of the Node.js driver, see Migrating to 2.X.
  • Support for mongodb 2.2 has been dropped.
• cli:
  • -R/--reporter changed to --mocha-reporter.
• views:
  • config.website.views moved to config.views.
  • config.views.vars are now shared between client and server templates except for any vars under _private which are server-only.
  • config.views.vars.clientData has been removed.
  • config.views.vars.session moved to config.views.vars.idp.session.
  • A number of unused keys in config.views.vars have been removed: session.auth, session.loaded, serviceHost, serviceDomain, productionMode.

0.2.0 (up to early 2015)

• See git history for changes.