Hooks refactoring #236

Bugfix

Fix #233

• Upgrade to Pino 5 logger. https://github.com/pinojs/pino/releases/tag/v5.0.0
• Don't check custom logger instance with Joi because it produces side-effects and causes an error. #221
• Don't handle errors as success payload in case of:
  • Promise.reject('success')
  • cb('success', null)

Breaking changes

• PrettyLog is disabled by default. You have to install pino-pretty in order to archive the same result. More informations here
• Only native error objects can be responded. In case of an invalid error, the server will log an error and the client will timeout.

Fixed

• Don't swallow onServerPreResponse error it has precedence over other extension errors.

Miscellaneous

• Add more test
• Add example for server extensions

• #220 Set metadata context correctly when subsequent calls use different values for the same metadata properties'

• Validate typescript types on ci and test hook
• Improve typescript types

• Add pattern, transport properties to client request object.
• Remove getter and setters
• Update docs and examples.

Fixed

• Hemera should emit an error when nats connection was closed so process watchers can restart it accordingly.

• Fix logging message
• Add logs for server and client hooks (Request- started, received, responded, completed)
• Improve knabe plugin

• Improved request logs.
• New option traceLog to attach tracing information to each log.

• Remove this.request$.parentId because it's duplicated. The parent relationship is tracked in this.trace$.parentSpanId
• Update docs
• Improve tests

• Improve nats-hemera types #209
• Softening logger interface #208

Avoid to create separate promise in catch case when callback-style is used. Perf gains ~10%.

• Update deps
• Use strict mode in index.js

• improve TS types

Remove redundant error log #207

• Allow to pass a stream to default logger Pino
• Refactor logger configuration
• Improve tests

• Refactor plugin dependencies
• Add decorator dependencies
• Simplify hemera-plugin

PR: #200

• Remove expectedMessages$ from Add object.
• Don't assign default inbox queue to Add object.

Fixed regression of maxMessages$: -1

Update pino dependency

Refactor shutdown routine with avvio

Improvements

• Improve extension and middleware performance by using a self-written iterator.
• Improve error messages to be more expressive.

Bug fixes

Async/Await Client and Server extensions should not be fulfilled when a native error object was returned.

• Implement not found pattern

Other changes

• 5.0.0-rc.7
• 5.0.0-rc.6
• 5.0.0-rc.5
• 5.0.0-rc.4
• 5.0.0-rc.3
• 5.0.0-rc.2
• 5.0.0-rc.1

• Ship typescript typings for nats-hemera
• Return this in setter functions in nats-hemera

• Rename hemera error BusinessError to ResponseError
• Update docs

I'm really happy to announce the new Hemera 5 release!

This release is a ground-breaking refactoring of the core. The goal was to simplify but also make the lifecycle of extensions and middlwares more predictable.

In summary:

• Refactor extension lifecycle and handling
• Refactor plugin management
• Simplify payload validator and codec interface
• Brand new Documentation with https://docusaurus.io/

Breaking changes:

• Removed Reply.end()
• Removed hemera.root property
• Removed Hemera.reply() in favor of hemera.reply.next() to send multiple responses in a row
• Removed configuration properties crashOnFatal, shouldCrash. The developer is responsible to catch these errors
• Removed CodecPipeline
• Removed encoder, decoder. We provide setter functions for client and server encoding
• Remove support to register multiple plugins at once with hemera.use
• Remove plugin$, plugins property, remove hemera.setOption(), hemera.setConfig() methods
• Remove functionality to to send a response inside serverPreResponse. This was confusing because the payload is already set at this point
• Load plugins only on hemera.ready() not when hemera.use() is called
• We break the support of simple return values in add or middlewares without the use of callback or promises

New features:

• Implement schemaCompiler to archive better abstraction for payload validators
• Support for async schemaCompiler
• Encapsulate extensions, codec and schemaCompiler
• Provide setter functions for client and server encoding

Modified packages

• hemera-joi Remove post validation
• Remove support for hemera-nsq and hemera-controlplane
• hemera-plugin you can skip the creation of a plugin scope with scoped:false

Bug fixes

• Fixed issue in add middleware. Passed errors didn't lead to cancellation

Breaking changes

• Use of callback-style with act(...) won't return a promise anymore rather undefined
• Use of promise-style with act(...) will return to a fulfilled promise a context object with two properties data and context. On a rejection, only the error is returned.
  • data message response
  • context hemera instance with the right meta$, context$ and trace$ informations.

Migration Guide

Don't mix callback and promise style and work in case of promise with the result object

Before

const result = await hemera.act({
  topic: "math",
  cmd: "add"
}, async function (err, resp) {
	// code ...
})

After with promise

const result = await hemera.act({
  topic: "math",
  cmd: "add"
})
// code ...
result.data
result.context

After with callback

hemera.act({
  topic: "math",
  cmd: "add"
}, function (err, resp) {
	// code ...
})

• Support of custom parent span via context$
• Remove hemera version from span tags
• Use pattern as span operation name
• Add HEMERA_OP_TYPE, HEMERA_ACT_EXPECTEDMSG and HEMERA_CONTEXT tags

• Implement onAdd extensions #188
• Expose matchedAction which represent the matched action behind the pattern

Add promise support for hemera.ready() when no callback is passed.

• Upgrade nats-hemera dependencies
• Upgrade dev-dependencies from Repository

Upgrade avvio to v5.1