rascal 14.4.0 → 14.4.1

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 14.4.1
+
+- Bump dependencies / fix audit warnings
+- Fix busy publisher example to consistenly use regular channels - See https://github.com/guidesmiths/rascal/issues/194
+
 ## 14.4.0
 
 - Report validation error when no vhosts are specified - See https://github.com/guidesmiths/rascal/issues/181

package/README.md

@@ -49,7 +49,7 @@ A **publication** is a named configuration for publishing a message, including t
 
 ### Breaking Changes in Rascal@14
 
-Rascal@15 waits for inflight messages to be acknowledged before closing subscriber channels. Prior to this version Rascal just waited an arbitary amount of time. If you application does not acknowledge a message for some reason (quite likely in tests) calling `subscription.cancel`, `broker.unsubscribeAll`, `broker.bounce`, `broker.shutdown` or `broker.nuke` will wait indefinitely. You can specify a `closeTimeout` in your subscription config, however if this is exceeded the `subscription.cancel` and `broker.unsubscribeAll` methods will yield an error, while the `broker.bounce`, `broker.shutdown` and `broker.nuke` methods will emit an error, but attempt to continue. In both cases the error will have a code of `ETIMEDOUT` and message stating `Callback function "waitForUnacknowledgedMessages" timed out`.
+Rascal@14 waits for inflight messages to be acknowledged before closing subscriber channels. Prior to this version Rascal just waited an arbitary amount of time. If your application does not acknowledge a message for some reason (quite likely in tests) calling `subscription.cancel`, `broker.unsubscribeAll`, `broker.bounce`, `broker.shutdown` or `broker.nuke` will wait indefinitely. You can specify a `closeTimeout` in your subscription config, however if this is exceeded the `subscription.cancel` and `broker.unsubscribeAll` methods will yield an error via callback or rejection, while the `broker.bounce`, `broker.shutdown` and `broker.nuke` methods will emit an error event, but attempt to continue. In both cases the error will have a code of `ETIMEDOUT`.
 
 ### Special Note
 
@@ -696,7 +696,7 @@ Define any further configuration in an options block
 }
 ```
 
-To define a queue with extentions add arguments to the options block
+To define a queue with extensions such as `x-queue-type` add arguments to the options block, e.g.
 
 ```json
 {
@@ -875,7 +875,7 @@ await broker.publish('p1', 'some message', {
 
 The callback parameters are err (indicating the publication could not be found) and publication. Listen to the publication's "success" event to obtain confirmation that the message was successfully published (when using confirm channels) and the "error" event to handle errors. The "return" event will be emitted when the message was successfully published but not routed. It is possible to access the messageId from all handlers, either via the supplied messageId or the returned message itself (see below)
 
-If you specify the "mandatory" option (or use Rascal's defaults) you can also listen for returned messages (i.e. messages that were not delivered to any queues)
+If you specify the "mandatory" option (or use Rascal's defaults) you can also listen for returned messages (i.e. messages that were not delivered to any queues). Before a message is returned, you will still get the "success" event, since the message was successfully published. A common mistake is to resolve a promise from the "success" event handler and reject from the "return" event handler, since the latter would have no effect.
 
 ```js
 broker.publish('p1', 'some message', (err, publication) => {

package/examples/busy-publisher/config.json

@@ -3,7 +3,7 @@
   "vhosts": {
     "/": {
       "publicationChannelPools": {
-        "confirmPool": {
+        "regularPool": {
           "max": 10,
           "min": 10,
           "evictionRunIntervalMillis": 1000,

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "rascal",
-  "version": "14.4.0",
+  "version": "14.4.1",
   "description": "A config driven wrapper for amqplib supporting multi-host connections, automatic error recovery, redelivery flood protection, transparent encryption / decryption,  channel pooling and publication timeouts",
   "main": "index.js",
   "dependencies": {
-    "async": "^3.2.1",
+    "async": "^3.2.3",
     "debug": "^4.1.1",
     "forward-emitter": "^0.1.1",
     "generic-pool": "^3.7.1",