@cap-js-community/event-queue 0.1.54 → 0.1.56

package/README.md

@@ -14,23 +14,7 @@ enhancing the overall performance of your application.
 ## Getting started
 
 - Run `npm add @cap-community/event-queue` in `@sap/cds` project
-- Initialize the event queue for example in the CAP server.js
-- Enhance or create `./srv/server.js`:
-
-### By Code
-
-```js
-const cds = require("@sap/cds");
-const eventQueue = require("@cap-js-community/event-queue");
-
-cds.on("bootstrap", () => {
-  eventQueue.initialize({
-    configFilePath: "./srv/eventConfig.yml",
-  });
-});
-
-module.exports = cds.server;
-```
+- Activate the cds-plugin in the cds section of the package.sjon
 
 ### As cds-plugin
 
@@ -52,92 +36,16 @@ https://cap.cloud.sap/docs/releases/march23#new-cds-plugin-technique
 ## Features
 
 - load balancing of event processing throughout app instances
+- control concurrency in app instances
 - 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
 
-## Initialize event queue configuration
-
-| Property                  | Description                                                                                                                                                                                                                                                                                                                                   |
-| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| configFilePath            | Filepath as a string for the event configuration file. The base path is the root directory of the project.                                                                                                                                                                                                                                    |
-| registerAsEventProcessor  | Allows enabling/disabling the registration of the app instance as an event processor. The interval is based on the `runInterval` parameter. Based on this interval, all events for all tenants will be processed. The default value is `true`.                                                                                                |
-| runInterval               | The interval specified in seconds, indicating how often events are processed for all tenants. If `processEventsAfterPublish` is true, in most situations, only erroneous events are processed during this run. All other events are automatically processed after they have been published (see the parameter `processEventsAfterPublish`).   |
-| processEventsAfterPublish | Allows enabling/disabling the automatic processing of events after they have been published. The behavior depends on whether a Redis service is bound to the app. With Redis, the processing will happen on any available app instance. If Redis is not bound, the processing will happen on the same instance where the event was published. |
-| tableNameEventQueue       | Allows 'Bring your own table'. This is the name of the event queue table. The required fields for this table can be found in the db-folder.                                                                                                                                                                                                   |
-| tableNameEventLock        | Allows 'Bring your own table'. This is the name of the event lock table. The required fields for this table can be found in the db-folder.                                                                                                                                                                                                    |
-| skipCsnCheck              | Specifies whether to skip the CSN check. This might be useful for testing purposes.                                                                                                                                                                                                                                                           |
-| parallelTenantProcessing  | Specifies the limit as an integer on how many tenants are processed on a given app-instance in parallel. The default is 5.                                                                                                                                                                                                                    |
-
-## Persistence
-
-This library needs two tables two work as designed. The event tables contains the data and state about the events for
-processing.
-The second table is for keeping track of semantic locks. This table is used if no redis-instance is available.
-There are two options for getting the required tables into the project.
-
-### Use provided tables
-
-Use the tables provided by this library. For that add the following to `package.json` of the project:
-
-```json
-{
-  "cds": {
-    "requires": {
-      "cds-event-queue": {
-        "model": "@cap-js-community/event-queue"
-      }
-    }
-  }
-}
-```
-
-### Bring your own persistence
-
-The table names can be specified during the initialization of the event queue. It's important that the provided tables
-have the same named fields and types as the default tables.
-
-Own tables can have additional fields but need to meet the minimal requirements. During initialization, the CDS CSN for
-the provided table names is checked to ensure they meet the requirements.
-If you want to skip this check, you can achieve it by using skipCsnCheck (refer to the "Initialize Event Queue
-Configuration" section).
-
-```json
-{
-  "cds": {
-    "eventQueue": {
-      "plugin": true,
-      "configFilePath": "./srv/eventQueueConfig.yml",
-      "tableNameEventQueue": "sap.custom.EventQueue",
-      "tableNameEventLock": "sap.custom.EventLock"
-    }
-  }
-}
-```
-
-## Configure your events
-
-Events are configured in a configuration yml file. In this file all relevant information about how events should be
-processed can be maintained.
-
-```yaml
-events:
-  - type: Notifications
-    subType: Email
-    impl: ./test/asset/EventQueueTest
-```
-
-## Event Configurations
+## Documentation
 
-| Property                | Description                                                                                                                                                                                                                               |
-| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| retryAttempts           | For infinite retries, maintain -1 as 'retryAttempts'. Default retry attempts is 3.                                                                                                                                                        |
-| parallelEventProcessing | How many events of the same type and subType are parallel processed after clustering. Default value is 1 and limit is 10.                                                                                                                 |
-| eventOutdatedCheck      | Checks if the db record for the event has been modified since the selection and right before the processing of the event. Default is true.                                                                                                |
-| commitOnEventLevel      | After processing an event, the associated transaction is committed and the associated status is committed with the same transaction. This should be used if events should be processed atomically. Default is false.                      |
-| selectMaxChunkSize      | Number of events which are selected at once. Default is 100. If it should be checked if there are more open events available, set the parameter checkForNextChunk to true.                                                                |
-| checkForNextChunk       | Determines if after processing a chunk (the size depends on the value of selectMaxChunkSize), a next chunk is being processed if there are more open events and the processing time has not already exceeded 5 minutes. Default is false. |
+Head over to our [Documentation](https://cap-js-community.github.io/event-queue/) to learn more.
 
 ## Support, Feedback, Contributing
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js-community/event-queue",
-  "version": "0.1.54",
+  "version": "0.1.56",
   "description": "event queue for cds",
   "main": "src/index.js",
   "files": [
@@ -32,23 +32,28 @@
   },
   "dependencies": {
     "uuid": "9.0.0",
-    "redis": "4.6.7",
+    "redis": "4.6.8",
     "verror": "1.10.1",
-    "yaml": "2.3.1"
+    "yaml": "2.3.2"
   },
   "devDependencies": {
     "@sap/eslint-plugin-cds": "2.6.3",
-    "@sap/cds-dk": "7.0.3",
+    "@sap/cds-dk": "7.1.1",
     "hdb": "0.19.5",
     "eslint-plugin-node": "11.1.0",
     "sqlite3": "5.1.6",
     "express": "4.18.2",
-    "@sap/cds": "7.1.0",
-    "eslint": "^8.39.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-jest": "^27.2.1",
-    "jest": "^29.5.0",
-    "prettier": "^2.8.8"
+    "@sap/cds": "7.1.2",
+    "eslint": "8.48.0",
+    "eslint-config-prettier": "9.0.0",
+    "eslint-plugin-jest": "27.2.3",
+    "jest": "29.6.4",
+    "prettier": "3.0.3"
+  },
+  "homepage": "https://cap-js-community.github.io/event-queue/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cap-js-community/event-queue.git"
   },
   "cds": {
     "requires": {

package/src/EventQueueProcessorBase.js

@@ -25,6 +25,7 @@ class EventQueueProcessorBase {
   #eventsWithExceededTries = [];
   #exceededTriesExceeded = [];
   #selectedEventMap = {};
+  #queueEntriesWithPayloadMap = {};
 
   constructor(context, eventType, eventSubType, config) {
     this.__context = context;
@@ -37,7 +38,6 @@ class EventQueueProcessorBase {
     this.__commitedStatusMap = {};
     this.__eventType = eventType;
     this.__eventSubType = eventSubType;
-    this.__queueEntriesWithPayloadMap = {};
     this.__config = config ?? {};
     this.__parallelEventProcessing = this.__config.parallelEventProcessing ?? DEFAULT_PARALLEL_EVENT_PROCESSING;
     if (this.__parallelEventProcessing > LIMIT_PARALLEL_EVENT_PROCESSING) {
@@ -164,7 +164,7 @@ class EventQueueProcessorBase {
       );
       return;
     }
-    this.__queueEntriesWithPayloadMap[queueEntry.ID] = {
+    this.#queueEntriesWithPayloadMap[queueEntry.ID] = {
       queueEntry,
       payload,
     };
@@ -190,8 +190,8 @@ class EventQueueProcessorBase {
    * This can be useful for e.g. multiple tasks have been scheduled and always the same user should be informed.
    * In this case the events should be clustered together and only one mail should be sent.
    */
-  clusterQueueEntries() {
-    Object.entries(this.__queueEntriesWithPayloadMap).forEach(([key, { queueEntry, payload }]) => {
+  clusterQueueEntries(queueEntriesWithPayloadMap) {
+    Object.entries(queueEntriesWithPayloadMap).forEach(([key, { queueEntry, payload }]) => {
       this.addEntryToProcessingMap(key, queueEntry, payload);
     });
   }
@@ -795,7 +795,7 @@ class EventQueueProcessorBase {
   }
 
   get queueEntriesWithPayloadMap() {
-    return this.__queueEntriesWithPayloadMap;
+    return this.#queueEntriesWithPayloadMap;
   }
 
   get eventProcessingMap() {

package/src/config.js

@@ -2,7 +2,7 @@
 
 const cds = require("@sap/cds");
 
-const { getEnvInstance: getEnvInstance } = require("./shared/env");
+const { getEnvInstance } = require("./shared/env");
 const redis = require("./shared/redis");
 
 let instance;

package/src/processEventQueue.js

@@ -76,7 +76,7 @@ const processEventQueue = async (context, eventType, eventSubType, startTime = n
         await executeInNewTransaction(context, `eventQueue-processing-${eventType}##${eventSubType}`, async (tx) => {
           eventTypeInstance.processEventContext = tx.context;
           try {
-            eventTypeInstance.clusterQueueEntries();
+            eventTypeInstance.clusterQueueEntries(eventTypeInstance.queueEntriesWithPayloadMap);
             await processEventMap(eventTypeInstance);
           } catch (err) {
             eventTypeInstance.handleErrorDuringClustering(err);

package/src/shared/redis.js

@@ -2,7 +2,7 @@
 
 const redis = require("redis");
 
-const { getInstance: getEnvInstance } = require("./env");
+const { getEnvInstance } = require("./env");
 const EventQueueError = require("../EventQueueError");
 
 const COMPONENT_NAME = "eventQueue/shared/redis";