@cap-js-community/event-queue

@cap-js-community/event-queue

The Event-Queue is a framework built on top of CAP Node.js, designed specifically for efficient and streamlined asynchronous event processing. With a focus on load balancing, this package ensures optimal event distribution across all available application instances. By providing managed transactions similar to CAP handlers, the Event-Queue framework simplifies event processing, enhancing the overall performance of your application.

Additionally, Event-Queue provides support for periodic events, allowing for processing at defined intervals. This feature further extends its capabilities in load balancing and transaction management, ensuring that even regularly occurring tasks are handled efficiently and effectively without overloading any single instance. This makes it an ideal solution for applications needing consistent, reliable event processing.

Getting started

• Run npm add @cap-js-community/event-queue in @sap/cds project
• Activate the cds-plugin in the cds section of the package.json.

As cds-plugin

For detailed information check out the documentation.

{
  "cds": {
    "eventQueue": {
      "plugin": true,
      "configFilePath": "./srv/eventQueueConfig.yml"
    }
  }
}

Features

Learn more about features in the documentation. To compare the event-queue with other SAP products head over to Distinction from other solutions.

• load balancing and concurrency control of event processing across app instances
• periodic events similar to running cron jobs for business processes
• managed transactions for event processing
• async processing of processing intensive tasks for better UI responsiveness
• push/pull mechanism for reducing delay between publish an event and processing
• cluster published events during processing (e.g. for combining multiple E-Mail events to one E-Mail)
• plug and play via cds-plugin

Documentation

Head over to our Documentation to learn more.

Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.

Code of Conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.

Licensing

Copyright 2023 SAP SE or an SAP affiliate company and @cap-js-community/event-queue contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.

Changelog

v1.2.0 - 2024-01-26

Added

• option to set user for all created cds contexts and with that the user for updating the managed database fields.

Changed

• rework initialization via cds-plugin.