@cap-js-community/event-queue 0.1.49

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,160 @@
+# @cap-js-community/event-queue
+
+[![npm version](https://img.shields.io/npm/v/@cap-js-community/event-queue)](https://www.npmjs.com/package/@cap-js-community/event-queue)
+[![monthly downloads](https://img.shields.io/npm/dm/@cap-js-community/event-queue)](https://www.npmjs.com/package/@cap-js-community/event-queue)
+[![REUSE status](https://api.reuse.software/badge/github.com/cap-js-community/event-queue)](https://api.reuse.software/info/github.com/cap-js-community/event-queue)
+[![CI Main](https://github.com/cap-js-community/event-queue/actions/workflows/ci-main.yml/badge.svg)](https://github.com/cap-js-community/event-queue/commits/main)
+
+The Event-Queue is a framework built on top of CAP Node.js, specifically designed to enable efficient and streamlined
+asynchronous event processing in a multi-tenancy environment. With a strong emphasis on load balancing, this package
+ensures optimal distribution of workload across all available application instances. By offering managed tenant-specific
+transactions, similar to CAP handlers, the Event-Queue framework simplifies event and asynchronous processing, thereby
+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("@sap/cds-event-queue");
+
+cds.on("bootstrap", () => {
+  eventQueue.initialize({
+    configFilePath: "./srv/eventConfig.yml",
+  });
+});
+
+module.exports = cds.server;
+```
+
+### As cds-plugin
+
+Extend the cds section of your package.json. Reference to the cds-plugin section in the capire documentation about the
+cds-plugin concept.
+https://cap.cloud.sap/docs/releases/march23#new-cds-plugin-technique
+
+```json
+{
+  "cds": {
+    "eventQueue": {
+      "plugin": true,
+      "configFilePath": "./srv/eventQueueConfig.yml"
+    }
+  }
+}
+```
+
+## Features
+
+- load balancing of event processing throughout 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)
+
+## 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": "@sap/cds-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
+
+| 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. |
+
+## Support, Feedback, Contributing
+
+This project is open to feature requests/suggestions, bug reports etc.
+via [GitHub issues](https://github.com/cap-js-community/<your-project>/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](CONTRIBUTING.md).
+
+## 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](CODE_OF_CONDUCT.md) at all
+times.
+
+## Licensing
+
+Copyright 2023 SAP SE or an SAP affiliate company and `@cap-js-community/event-queue contributors`. Please see
+our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and
+their licensing/copyright information is
+available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js-community/<your-project>).

package/cds-plugin.js

@@ -0,0 +1,11 @@
+"use strict";
+
+const cds = require("@sap/cds");
+
+const eventQueue = require("./src");
+
+if (cds.env.eventQueue && cds.env.eventQueue.plugin) {
+  cds.on("bootstrap", async () => {
+    await eventQueue.initialize();
+  });
+}

package/db/Event.cds

@@ -0,0 +1,24 @@
+namespace sap.eventqueue;
+
+using cuid from '@sap/cds/common';
+
+@sap.value.list: 'fixed-values'
+type Status: Integer enum {
+    Open = 0;
+    InProgress = 1;
+    Done = 2;
+    Error = 3;
+    Exceeded = 4;
+}
+
+entity Event: cuid {
+    type: String not null;
+    subType: String not null;
+    referenceEntity: String;
+    referenceEntityKey: UUID;
+    status: Status default 0 not null;
+    payload: LargeString;
+    attempts: Integer default 0 not null;
+    lastAttemptTimestamp: Timestamp;
+    createdAt: Timestamp @cds.on.insert : $now;
+}

package/db/Lock.cds

@@ -0,0 +1,10 @@
+namespace sap.eventqueue;
+
+using cuid from '@sap/cds/common';
+using managed from '@sap/cds/common';
+
+@assert.unique.semanticKey: [code]
+entity Lock: managed {
+    code: String not null;
+    value: String;
+}

package/db/index.cds

@@ -0,0 +1,2 @@
+using from './Event';
+using from './Lock';

package/index.cds

@@ -0,0 +1 @@
+using from './db';

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@cap-js-community/event-queue",
+  "version": "0.1.49",
+  "description": "event queue for cds",
+  "main": "src/index.js",
+  "files": [
+    "src",
+    "db",
+    "cds-plugin.js",
+    "index.cds"
+  ],
+  "scripts": {
+    "test:unit": "jest --testPathIgnorePatterns=\"/test-integration/\"",
+    "test:integration": "jest --testPathIgnorePatterns=\"/test/\" --runInBand --forceExit",
+    "test:all": "npm run test:unit && npm run test:integration",
+    "test:ci": "npm run test:prepare && npm run test:all",
+    "test:all:coverage": "jest --runInBand --forceExit --collect-coverage",
+    "test:prepare": "npm run build:ci --prefix=./test-integration/_env",
+    "lint": "npm run eslint && npm run prettier",
+    "lint:ci": "npm run eslint:ci && npm run prettier:ci",
+    "eslint": "eslint --fix .",
+    "eslint:ci": "eslint .",
+    "prettier": "prettier --write --loglevel error .",
+    "prettier:ci": "prettier --check .",
+    "prepareRelease": "npm prune --production",
+    "docs": "cd docs && bundle exec jekyll serve",
+    "docs:install": "cd docs && npx shx rm -rf vendor Gemfile.lock && bundle install",
+    "upgrade-lock": "npx shx rm -rf package-lock.json node_modules && npm i --package-lock"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "dependencies": {
+    "uuid": "9.0.0",
+    "redis": "4.6.7",
+    "verror": "1.10.1",
+    "yaml": "2.3.1"
+  },
+  "devDependencies": {
+    "@sap/eslint-plugin-cds": "2.6.3",
+    "@sap/cds-dk": "7.0.0",
+    "hdb": "0.19.5",
+    "eslint-plugin-node": "11.1.0",
+    "sqlite3": "5.1.6",
+    "express": "4.18.2",
+    "@sap/cds": "7.0.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"
+  },
+  "author": "Maximilian Gruenfelder <maximilian.gruenfelder@sap.com>",
+  "license": "Apache-2.0"
+}

package/src/EventQueueError.js

@@ -0,0 +1,141 @@
+"use strict";
+
+const VError = require("verror");
+
+const ERROR_CODES = {
+  WRONG_TX_USAGE: "WRONG_TX_USAGE",
+  UNKNOWN_EVENT_TYPE: "UNKNOWN_EVENT_TYPE",
+  NOT_INITIALIZED: "NOT_INITIALIZED",
+  REDIS_CREATE_CLIENT: "REDIS_CREATE_CLIENT",
+  REDIS_LOCAL_NO_RECONNECT: "REDIS_LOCAL_NO_RECONNECT",
+  MISSING_TABLE_DEFINITION: "MISSING_TABLE_DEFINITION",
+  MISSING_ELEMENT_IN_TABLE: "MISSING_ELEMENT_IN_TABLE",
+  TYPE_MISMATCH_TABLE: "TYPE_MISMATCH_TABLE",
+};
+
+const ERROR_CODES_META = {
+  [ERROR_CODES.WRONG_TX_USAGE]: {
+    message:
+      "Usage of this.tx|this.context is not allowed if parallel event processing is enabled",
+  },
+  [ERROR_CODES.UNKNOWN_EVENT_TYPE]: {
+    message:
+      "The event type and subType configuration is not configured! Maintain the combination in the config file.",
+  },
+  [ERROR_CODES.NOT_INITIALIZED]: {
+    message:
+      "The event-queue is not initialized yet. The initialization needs to be completed before the package is used.",
+  },
+  [ERROR_CODES.REDIS_CREATE_CLIENT]: {
+    message: "error during create client with redis-cache service",
+  },
+  [ERROR_CODES.REDIS_LOCAL_NO_RECONNECT]: {
+    message: "disabled reconnect, because we are not running on cloud foundry",
+  },
+  [ERROR_CODES.MISSING_TABLE_DEFINITION]: {
+    message:
+      "Could not find table in csn. Make sure the provided table name is correct and the table is known by CDS.",
+  },
+  [ERROR_CODES.MISSING_ELEMENT_IN_TABLE]: {
+    message:
+      "The provided table doesn't match the required structure. At least the following element is missing.",
+  },
+  [ERROR_CODES.TYPE_MISMATCH_TABLE]: {
+    message:
+      "At least one field in the provided table doesn't have the expected data type.",
+  },
+};
+
+class EventQueueError extends VError {
+  constructor(...args) {
+    super(...args);
+  }
+
+  static wrongTxUsage(type, subType) {
+    const { message } = ERROR_CODES_META[ERROR_CODES.WRONG_TX_USAGE];
+    return new EventQueueError(
+      {
+        name: ERROR_CODES.WRONG_TX_USAGE,
+        info: { type, subType },
+      },
+      message
+    );
+  }
+
+  static unknownEventType(type, subType) {
+    const { message } = ERROR_CODES_META[ERROR_CODES.UNKNOWN_EVENT_TYPE];
+    return new EventQueueError(
+      {
+        name: ERROR_CODES.UNKNOWN_EVENT_TYPE,
+        info: { type, subType },
+      },
+      message
+    );
+  }
+
+  static notInitialized() {
+    const { message } = ERROR_CODES_META[ERROR_CODES.NOT_INITIALIZED];
+    return new EventQueueError(
+      {
+        name: ERROR_CODES.NOT_INITIALIZED,
+      },
+      message
+    );
+  }
+
+  static redisConnectionFailure(err) {
+    const { message } = ERROR_CODES_META[ERROR_CODES.REDIS_CREATE_CLIENT];
+    return new EventQueueError(
+      {
+        name: ERROR_CODES.REDIS_CREATE_CLIENT,
+        cause: err,
+      },
+      message
+    );
+  }
+
+  static redisNoReconnect() {
+    const { message } = ERROR_CODES_META[ERROR_CODES.REDIS_LOCAL_NO_RECONNECT];
+    return new EventQueueError(
+      {
+        name: ERROR_CODES.REDIS_LOCAL_NO_RECONNECT,
+      },
+      message
+    );
+  }
+
+  static missingTableInCsn(tableName) {
+    const { message } = ERROR_CODES_META[ERROR_CODES.MISSING_TABLE_DEFINITION];
+    return new EventQueueError(
+      {
+        name: ERROR_CODES.MISSING_TABLE_DEFINITION,
+        info: { tableName },
+      },
+      message
+    );
+  }
+
+  static missingElementInTable(tableName, elementName) {
+    const { message } = ERROR_CODES_META[ERROR_CODES.MISSING_ELEMENT_IN_TABLE];
+    return new EventQueueError(
+      {
+        name: ERROR_CODES.MISSING_ELEMENT_IN_TABLE,
+        info: { tableName, elementName },
+      },
+      message
+    );
+  }
+
+  static typeMismatchInTable(tableName, elementName) {
+    const { message } = ERROR_CODES_META[ERROR_CODES.TYPE_MISMATCH_TABLE];
+    return new EventQueueError(
+      {
+        name: ERROR_CODES.TYPE_MISMATCH_TABLE,
+        info: { tableName, elementName },
+      },
+      message
+    );
+  }
+}
+
+module.exports = EventQueueError;