Releases: CAFDataProcessing/worker-document
v3.1.1
v3.1.0
Version Number
3.1.0-68
New Features
- CAF-2931: Add functionality to Document workers to receive Tracking Info
The Document object now exposes the Task associated with it, which allows access to the WorkerTaskData object. - CAF-3113: Changed handling of failures for composite document tasks.
A message marked as poison will now add a failure to the document and return a success response for composite document tasks. - CAF-3257: Document Worker Framework: Document composite document format
The Document Worker contract documentation has been updated to include the new alternative contract format which supports subdocuments.
Known Issues
v3.0.0
Version Number
3.0.0-53
New Features
-
CAF-3253: Compound document support
The Document Worker Framework has been enhanced to be able to manipulate a document's reference and subdocuments. Previously it could only manipulate the fields of a document. A new change-log message format has been introduced which is used to send and receive compound documents.When an existing Document Worker is upgraded to this version of the framework then it will automatically accept compound documents. By default each of the documents in the compound document will be passed to the worker's
processDocument()method individually. This behavior is controllable through configuration. -
CAF-2890: Automatic suspension when unhealthy
The Worker Framework now stops taking in more work if any of its health checks begin to fail. It will not begin to accept new work until all its health checks indicate that it has recovered. This is to prevent trying to execute operations which are likely to fail and to minimize the requirement for later reprocessing. -
CAF-2890: Automatic suspension on transient failures
Transient failures (as indicated by the worker throwing DocumentWorkerTransientException exceptions) are now treated as an indication that the worker is unhealthy. When they occur processing is temporarily suspended to allow the failing downstream service time to recover, and to ensure that there is not an attempt to process more documents whilst there is an issue that is causing transient failures. -
CAF-2952: Priority queue support
The Worker Framework now supports using priority queues with RabbitMQ. When this feature is turned on the priority of a document being processed is gradually increased as it is passed through the workers (up to a configurable maximum). This produces a more even workload across the workers and allows documents to exit the pipeline more quickly. -
CAF-2942: Simplified log level configuration
By default theCAF_LOG_LEVELenvironment variable can now be used to specify the logging level. Previously a separate logging configuration file had to be provided in order to adjust the logging level.
Breaking Changes
-
The CAF Storage module (i.e.
worker-store-cs) is no longer supported. -
The Filesystem Storage module (i.e.
worker-store-fs) replaces the CAF Storage module as the default that is included via thestandard-worker-containermodule.
Known Issues
- None
v2.2.0
Version Number
2.2.0-41
New Features
Known Issues
Notes
- Updated to latest released version of worker-framework
v2.1.0
Version Number
2.1.0-15
New Features
- CAF-2701: Worker archetype container updated with a default JavaScript configuration file. If
CAF_APPNAMEandCAF_CONFIG_PATHare not set at runtime then these will be used. Allows for configuration of worker using environment variables alone. - CAF-2709: Extend Document Worker Archetype for Ease of Deployment. The archetype will now produce a
deploymentfolder which contains a pre-generated compose overlay for a new worker.
v2.0.0
Version Number
2.0.0-5
New Features
- Worker-Document has now been opensourced to github.com/CAFDataProcessing.
- Added Unit-testing support