node-server-engine 1.10.11 → 1.10.13

package/README.md

@@ -852,7 +852,9 @@ It can be configured through environment variables
 
 ### Pub/Sub
 
-The engine exposes a `PubSub` entity that can be used to communicate with Google Cloud Pub/Sub.
+The engine exposes a `PubSub` entity that can be used to communicate with Google Cloud Pub/Sub with production-ready configuration including flow control, retry policies, and batch processing.
+
+Based on [@google-cloud/pubsub](https://github.com/googleapis/nodejs-pubsub) v4.11.0.
 
 ```javascript
 import { PubSub } from 'node-server-engine';
@@ -861,32 +863,55 @@ import { PubSub } from 'node-server-engine';
  * Declare that the service will be publishing to a topic
  * This must be done before init() is called
  * Any attempt to publish a message without declaring a topic first will fail
- * @property {string|Array.<string>} topic - The topic(s) to which we will be publishing
+ * @param {string|Array<string>} topic - The topic(s) to which we will be publishing
+ * @param {Object} [options] - Publisher configuration options
  */
-PubSub.addPublisher(topic);
+PubSub.addPublisher(topic, {
+  enableMessageOrdering: false, // Enable ordering (requires orderingKey when publishing)
+  batching: {
+    maxMessages: 100,        // Max messages per batch
+    maxBytes: 1024 * 1024,   // Max bytes per batch (1MB)
+    maxMilliseconds: 100     // Max delay before sending batch
+  },
+  retry: {
+    initialDelayMillis: 100,  // Initial retry delay
+    maxDelayMillis: 60000,    // Max retry delay (60s)
+    delayMultiplier: 1.3      // Exponential backoff multiplier
+  }
+});
 
 /**
- * Binds a message handle to a subscription
+ * Binds a message handler to a subscription
  * If called multiple times, handlers will be chained
  * This must be done before init() is called
  * The subscription will not be consumed until init() is called
- * @property {string} subscription - The subscription to consume
- * @property {function|Array.<function>} handler - The message handling function(s)
- * @property {boolean} [first] - Puts the handler(s) at the beginning of the handling chain (default: false)
+ * @param {string} subscription - The subscription to consume
+ * @param {function|Array<function>} handler - The message handling function(s)
+ * @param {Object} [options] - Subscriber configuration options
  */
-PubSub.addSubscriber(subscription, handler, first);
+PubSub.addSubscriber(subscription, handler, {
+  first: false,              // Put handler at beginning of chain
+  isDebezium: false,         // Handle Debezium CDC events
+  ackDeadline: 60,           // Acknowledgement deadline (10-600 seconds)
+  flowControl: {
+    maxMessages: 1000,         // Max concurrent messages
+    maxBytes: 100 * 1024 * 1024, // Max concurrent bytes (100MB)
+    allowExcessMessages: true  // Allow excess messages if under maxBytes
+  }
+});
 
 /**
  * Establish connection with all the declared publishers/subscribers
+ * Validates topic/subscription existence and permissions
  */
 await PubSub.init();
 
 /**
  * Send a message through a previously declared publisher
- * @property {string} topic - The name of the topic to which the message should be pushed
- * @property {Object} message - The actual message (will be JSON stringified)
- * @property {Object} [attributes] - Message attributes
- * @property {string} [orderingKey] - Ordering key
+ * @param {string} topic - The name of the topic to which the message should be pushed
+ * @param {Object} message - The actual message (will be JSON stringified)
+ * @param {Object} [attributes] - Message attributes for filtering
+ * @param {string} [orderingKey] - Enforce ordering for messages with same key
  */
 await PubSub.publish(topic, message, attributes, orderingKey);
 
@@ -896,28 +921,102 @@ await PubSub.publish(topic, message, attributes, orderingKey);
 await PubSub.shutdown();
 ```
 
+#### Message Handling
+
+Messages are acknowledged after successful processing. If any handler throws an error, the message is nacked and will be redelivered according to the subscription's retry policy.
+
+```javascript
+// Handler signature
+async function messageHandler(payload, attributes, publishedAt) {
+  // payload: The JSON message content
+  // attributes: Message attributes (key-value pairs)
+  // publishedAt: Date when message was published
+  
+  // Process the message
+  await processData(payload);
+  
+  // Message will be ack'd automatically after successful processing
+  // If an error is thrown, message will be nack'd for redelivery
+}
+```
+
+#### Best Practices
+
+1. **Flow Control**: Configure `flowControl` based on your service's memory and processing capacity
+2. **Batch Settings**: Tune batching for optimal throughput vs. latency tradeoff
+3. **Retry Policy**: Use exponential backoff to handle transient failures gracefully
+4. **Dead Letter Topics**: Configure dead letter topics on your subscriptions in GCP Console for failed messages
+5. **Exactly-Once Delivery**: Enable exactly-once delivery in GCP Console when creating/updating your subscription (requires ackWithResponse() in handlers)
+6. **Message Ordering**: Only enable when strict ordering is required (reduces throughput)
+7. **ACK Deadline**: Set based on your handler's processing time (default: 60s)
+
+#### Environment Variables
+
+Pub/Sub authentication uses [Google Cloud Application Default Credentials](https://cloud.google.com/docs/authentication/application-default-credentials). Set `GOOGLE_APPLICATION_CREDENTIALS` to your service account key path, or use Workload Identity in GKE.
+
 ---
 
 ### PushNotification
 
-Communication interface with the push service.
+Communication interface with the push notification service using Pub/Sub.
 
 ```javascript
 import { PushNotification } from 'node-server-engine';
 
-// The entity needs to initialize it's pub/sub connections
-// Handlers must be declared before this function is called
+// Initialize with optimized settings for push notifications
+// Must be called before sending notifications
 await PushNotification.init();
 
 /**
  * Send a push notification through the push service
- * @param {String} userId - ID of the user that should receive the notification
+ * @param {string} userId - ID of the user that should receive the notification
  * @param {Object} notification - Notification that should be sent
- * @return {void}
+ * @throws {EngineError} If userId is missing or publish fails
  */
-await PushNotification.sendPush(userId, notification);
+await PushNotification.sendPush(userId, {
+  title: 'Hello!',
+  body: 'You have a new message',
+  payload: { type: 'message', messageId: '123' },
+  priority: true,
+  ttl: 3600 // Time to live in seconds
+});
+```
+
+#### Notification Options
+
+```typescript
+{
+  title?: string;              // Notification title
+  body?: string;               // Notification body text
+  payload?: unknown;           // Custom data payload
+  voip?: boolean;             // VOIP notification (iOS)
+  background?: boolean;       // Background/data-only notification
+  token?: string;             // Specific device token (optional)
+  mutable?: boolean;          // Content can be mutated by client (iOS)
+  contentAvailable?: boolean; // Requires client-side processing (iOS)
+  ttl?: number;               // Time to live in seconds
+  priority?: boolean;         // High priority notification
+  collapseId?: string;        // Group notifications with same ID
+}
 ```
 
+#### Environment Variables
+
+| Variable | Description | Required |
+| -------- | ----------- | -------- |
+| `PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC` | Pub/Sub topic name for push notifications | ✓ |
+
+#### Configuration
+
+The PushNotification entity is pre-configured with optimal settings:
+- **Batching**: Up to 100 messages, 1MB max, 50ms delay for fast delivery
+- **Retry**: Exponential backoff with 100ms initial delay, up to 60s max delay
+- **No Ordering**: Push notifications don't require strict ordering for better throughput
+
+#### Integration
+
+Your `omg-notification-service` (or similar) should subscribe to the configured topic to process and deliver push notifications to devices via FCM, APNs, or other push providers.
+
 ---
 
 ### Localizator

package/dist/const/metrics.js

@@ -7,6 +7,13 @@ exports.serviceRegistry = exports.instanceRegistry = void 0;
 var _promClient = require("prom-client");
 // Registry for metrics that apply to this specific instance of the service
 const instanceRegistry = exports.instanceRegistry = new _promClient.Registry();
+
 // Registry for metrics that apply to the service as a whole
 const serviceRegistry = exports.serviceRegistry = new _promClient.Registry();
+
+// Collect default Node.js process metrics (includes process_start_time_seconds)
+(0, _promClient.collectDefaultMetrics)({
+  register: instanceRegistry,
+  prefix: ''
+});
 //# sourceMappingURL=metrics.js.map

package/dist/const/metrics.js.map

@@ -1 +1 @@
-{"version":3,"file":"metrics.js","names":["_promClient","require","instanceRegistry","exports","Registry","serviceRegistry"],"sources":["../../src/const/metrics.ts"],"sourcesContent":["import { Registry } from 'prom-client';\n\n// Registry for metrics that apply to this specific instance of the service\nexport const instanceRegistry = new Registry();\n// Registry for metrics that apply to the service as a whole\nexport const serviceRegistry = new Registry();\n"],"mappings":";;;;;;AAAA,IAAAA,WAAA,GAAAC,OAAA;AAEA;AACO,MAAMC,gBAAgB,GAAAC,OAAA,CAAAD,gBAAA,GAAG,IAAIE,oBAAQ,CAAC,CAAC;AAC9C;AACO,MAAMC,eAAe,GAAAF,OAAA,CAAAE,eAAA,GAAG,IAAID,oBAAQ,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"metrics.js","names":["_promClient","require","instanceRegistry","exports","Registry","serviceRegistry","collectDefaultMetrics","register","prefix"],"sources":["../../src/const/metrics.ts"],"sourcesContent":["import { Registry, collectDefaultMetrics } from 'prom-client';\n\n// Registry for metrics that apply to this specific instance of the service\nexport const instanceRegistry = new Registry();\n\n// Registry for metrics that apply to the service as a whole\nexport const serviceRegistry = new Registry();\n\n// Collect default Node.js process metrics (includes process_start_time_seconds)\ncollectDefaultMetrics({\n  register: instanceRegistry,\n  prefix: '',\n});\n"],"mappings":";;;;;;AAAA,IAAAA,WAAA,GAAAC,OAAA;AAEA;AACO,MAAMC,gBAAgB,GAAAC,OAAA,CAAAD,gBAAA,GAAG,IAAIE,oBAAQ,CAAC,CAAC;;AAE9C;AACO,MAAMC,eAAe,GAAAF,OAAA,CAAAE,eAAA,GAAG,IAAID,oBAAQ,CAAC,CAAC;;AAE7C;AACA,IAAAE,iCAAqB,EAAC;EACpBC,QAAQ,EAAEL,gBAAgB;EAC1BM,MAAM,EAAE;AACV,CAAC,CAAC","ignoreList":[]}

package/dist/entities/PubSub/PubSub.d.ts

@@ -1,5 +1,5 @@
 import { Attributes } from '@google-cloud/pubsub';
-import { PubSubAddSubscriberOptions, PubSubMessageHandler } from './PubSub.types';
+import { PubSubAddSubscriberOptions, PubSubMessageHandler, PubSubPublisherOptions } from './PubSub.types';
 /**
  * This is a singleton service who's role is to manage pub/sub connections
  * It is the preferred way to interact with Pub/Sub as it manages the underlying subscription and handler objects
@@ -16,8 +16,10 @@ export declare const PubSub: {
     shutdown(): Promise<void>;
     /**
      * Creates a publisher if it does not exist yet
+     * @param topic - Topic name or array of topic names
+     * @param options - Publisher configuration options
      */
-    addPublisher(topic: string | Array<string>): void;
+    addPublisher(topic: string | Array<string>, options?: PubSubPublisherOptions): void;
     /**
      * Add message handlers to a subscription
      * @param subscription - Name of the Pub/Sub subscription

package/dist/entities/PubSub/PubSub.js

@@ -93,18 +93,43 @@ const PubSub = exports.PubSub = {
   },
   /**
    * Creates a publisher if it does not exist yet
+   * @param topic - Topic name or array of topic names
+   * @param options - Publisher configuration options
    */
-  addPublisher(topic) {
+  addPublisher(topic, options) {
     const topicArray = topic instanceof Array ? topic : [topic];
     (0, _utils.reportDebug)({
       namespace,
-      message: `Registering publisher for topics '${topicArray.join("', '")}'`
+      message: `Registering publisher for topics '${topicArray.join("', '")}'`,
+      data: options
     });
     // Register a new topic if it does not exist yet
     for (const topic of topicArray) {
       if (!Object.keys(topics).includes(topic)) {
         topics[topic] = pubSubClient.topic(topic, {
-          enableOpenTelemetryTracing: true
+          enableOpenTelemetryTracing: true,
+          messageOrdering: options?.enableMessageOrdering ?? false,
+          batching: options?.batching ? {
+            maxMessages: options.batching.maxMessages ?? 100,
+            maxBytes: options.batching.maxBytes ?? 1024 * 1024,
+            // 1MB
+            maxMilliseconds: options.batching.maxMilliseconds ?? 100
+          } : undefined,
+          gaxOpts: options?.retry ? {
+            retry: {
+              retryCodes: [10, 14],
+              // ABORTED, UNAVAILABLE
+              backoffSettings: {
+                initialRetryDelayMillis: options.retry.initialDelayMillis ?? 100,
+                maxRetryDelayMillis: options.retry.maxDelayMillis ?? 60000,
+                retryDelayMultiplier: options.retry.delayMultiplier ?? 1.3,
+                initialRpcTimeoutMillis: 60000,
+                maxRpcTimeoutMillis: 600000,
+                rpcTimeoutMultiplier: 1.0,
+                totalTimeoutMillis: 600000
+              }
+            }
+          } : undefined
         });
       }
     }
@@ -119,19 +144,33 @@ const PubSub = exports.PubSub = {
     const handlers = handler instanceof Array ? handler : [handler];
     const isDebezium = options?.isDebezium ?? false;
     const first = options?.first ?? false;
+    const flowControl = options?.flowControl;
+    const ackDeadline = options?.ackDeadline;
     (0, _utils.reportDebug)({
       namespace,
       message: `Registering subscriber for subscription '${subscription}'`,
       data: {
         first,
         handlersCount: handlers.length,
-        isDebezium
+        isDebezium,
+        flowControl
       }
     });
     if (!Object.keys(subscriptions).includes(subscription)) {
       subscriptions[subscription] = {
         subscription: pubSubClient.subscription(subscription, {
-          enableOpenTelemetryTracing: true
+          enableOpenTelemetryTracing: true,
+          flowControl: flowControl ? {
+            maxMessages: flowControl.maxMessages ?? 1000,
+            maxBytes: flowControl.maxBytes ?? 100 * 1024 * 1024,
+            // 100MB
+            allowExcessMessages: flowControl.allowExcessMessages ?? true
+          } : {
+            maxMessages: 1000,
+            maxBytes: 100 * 1024 * 1024,
+            allowExcessMessages: true
+          },
+          ackDeadline: ackDeadline ?? 60
         }),
         handlers: []
       };

package/dist/entities/PubSub/PubSub.js.map

@@ -1 +1 @@
-{"version":3,"file":"PubSub.js","names":["_pubsub","require","_handleMessage","_EngineError","_LifecycleController","_utils","namespace","subscriptions","topics","pubSubClient","PubsubClient","PubSub","exports","init","reportDebug","message","Promise","all","Object","values","map","topic","exists","EngineError","name","permissions","iam","testPermissions","hasPermissions","every","success","subscription","handlers","isDebezium","on","handleMessage","catch","error","reportError","LifecycleController","register","shutdown","flush","close","keys","forEach","addPublisher","topicArray","Array","join","includes","enableOpenTelemetryTracing","addSubscriber","handler","options","first","data","handlersCount","length","push","unshift","publish","attributes","orderingKey","publishMessage","json"],"sources":["../../../src/entities/PubSub/PubSub.ts"],"sourcesContent":["import {\n  Attributes,\n  PubSub as PubsubClient,\n  Message\n} from '@google-cloud/pubsub';\nimport { handleMessage } from './handleMessage';\nimport {\n  PubSubTopicsMap,\n  PubSubSubscriptionsMap,\n  PubSubAddSubscriberOptions,\n  PubSubMessageHandler\n} from './PubSub.types';\nimport { EngineError } from 'entities/EngineError';\nimport { LifecycleController } from 'entities/LifecycleController';\nimport { reportDebug, reportError } from 'utils';\n\nconst namespace = 'engine:PubSub';\n\n/**\n * Associative containing all the subscriptions sorted by topic registered for publishing\n */\nconst subscriptions: PubSubSubscriptionsMap = {};\n\n/**\n * Associative containing all the topics registered for publishing\n */\nconst topics: PubSubTopicsMap = {};\n\nconst pubSubClient = new PubsubClient();\n\n/**\n * This is a singleton service who's role is to manage pub/sub connections\n * It is the preferred way to interact with Pub/Sub as it manages the underlying subscription and handler objects\n * It avoids potential subscription splitting on an instance\n */\nexport const PubSub = {\n  /**\n   * Initialize the registered publishers and subscribers\n   */\n  async init(): Promise<void> {\n    reportDebug({ namespace, message: `Initializing Pub/Sub` });\n    // Check that all topics/permissions exist, and that we have permission on them\n    await Promise.all([\n      // Test that all topics actually exist and that we have permissions\n      ...Object.values(topics).map(async (topic) => {\n        const [exists] = await topic.exists();\n        if (!exists)\n          throw new EngineError(`Topic ${topic.name} does not exist`);\n        // Test permission ton publish to topic\n        const [permissions] = await topic.iam.testPermissions([\n          'pubsub.topics.publish'\n        ]);\n        const hasPermissions = Object.values(permissions).every(\n          (success) => success\n        );\n        if (!hasPermissions)\n          throw new EngineError(\n            `Instance does not have appropriate permissions to publish to topic ${topic.name}`\n          );\n      }),\n      // Test that all subscriptions actually exist and that we have permissions\n      ...Object.values(subscriptions).map(async ({ subscription }) => {\n        const [exists] = await subscription.exists();\n        if (!exists)\n          throw new EngineError(\n            `Subscription ${subscription.name} does not exist`\n          );\n        // Test permission ton consume subscription\n        const [permissions] = await subscription.iam.testPermissions([\n          'pubsub.subscriptions.consume'\n        ]);\n        const hasPermissions = Object.values(permissions).every(\n          (success) => success\n        );\n        if (!hasPermissions)\n          throw new EngineError(\n            `Instance does not have appropriate permissions to subscribe to subscription ${subscription.name}`\n          );\n      })\n    ]);\n\n    // Register handlers on the subscriptions to activate them\n    for (const { subscription, handlers, isDebezium } of Object.values(\n      subscriptions\n    )) {\n      subscription.on('message', (message) => {\n        handleMessage(\n          message as Message,\n          subscription,\n          handlers,\n          isDebezium\n        ).catch((error) => {\n          reportError(error);\n        });\n      });\n    }\n\n    LifecycleController.register(PubSub);\n  },\n\n  /**\n   * Shutdown the registered publishers and subscribers\n   */\n  async shutdown(): Promise<void> {\n    reportDebug({ namespace, message: `Shutting down Pub/Sub` });\n    // Flush all pending messages and shut down connections\n    await Promise.all([\n      ...Object.values(topics).map(async (topic) => topic.flush()),\n      ...Object.values(subscriptions).map(async ({ subscription }) =>\n        subscription.close()\n      )\n    ]);\n    // Delete the stored topics/subscriptions\n    Object.keys(topics).forEach((topic) => delete topics[topic]);\n    Object.keys(subscriptions).forEach(\n      (subscription) => delete subscriptions[subscription]\n    );\n    // Close the client\n    await pubSubClient.close();\n  },\n\n  /**\n   * Creates a publisher if it does not exist yet\n   */\n  addPublisher(topic: string | Array<string>): void {\n    const topicArray = topic instanceof Array ? topic : [topic];\n    reportDebug({\n      namespace,\n      message: `Registering publisher for topics '${topicArray.join(\"', '\")}'`\n    });\n    // Register a new topic if it does not exist yet\n    for (const topic of topicArray) {\n      if (!Object.keys(topics).includes(topic)) {\n        topics[topic] = pubSubClient.topic(topic, {\n          enableOpenTelemetryTracing: true\n        });\n      }\n    }\n  },\n\n  /**\n   * Add message handlers to a subscription\n   * @param subscription - Name of the Pub/Sub subscription\n   * @param handler - Function or list of functions to set as message handlers\n   * @param options - Indicates that the additional options need to handle on Subscriber\n   */\n  addSubscriber<T>(\n    subscription: string,\n    handler: PubSubMessageHandler<T> | Array<PubSubMessageHandler<T>>,\n    options: PubSubAddSubscriberOptions = {}\n  ): void {\n    const handlers = handler instanceof Array ? handler : [handler];\n    const isDebezium = options?.isDebezium ?? false;\n    const first = options?.first ?? false;\n\n    reportDebug({\n      namespace,\n      message: `Registering subscriber for subscription '${subscription}'`,\n      data: { first, handlersCount: handlers.length, isDebezium }\n    });\n    if (!Object.keys(subscriptions).includes(subscription)) {\n      subscriptions[subscription] = {\n        subscription: pubSubClient.subscription(subscription, {\n          enableOpenTelemetryTracing: true\n        }),\n        handlers: []\n      };\n    }\n\n    if (isDebezium) subscriptions[subscription].isDebezium = true;\n\n    if (first) subscriptions[subscription].handlers.push(...handlers);\n    else subscriptions[subscription].handlers.unshift(...handlers);\n  },\n\n  /**\n   * Send a message to a Pub/Sub topic\n   * @param topic - Name of the topic\n   * @param message - Content of the message, must be an object that can be JSON stringified\n   * @param attributes - Attributes for this message, can be used to filter messages on the subscription\n   * @param orderingKey - Enforce order guarantee of messages sent with the same key\n   */\n  async publish(\n    topic: string,\n    message: unknown,\n    attributes?: Attributes,\n    orderingKey?: string\n  ): Promise<void> {\n    if (!topics[topic])\n      throw new EngineError(`No publisher was registered for topic '${topic}'`);\n    reportDebug({\n      namespace,\n      message: `Sending message to topic '${topic}'`,\n      data: { message, attributes, orderingKey }\n    });\n    await topics[topic].publishMessage({\n      json: message,\n      attributes,\n      orderingKey\n    });\n  }\n};\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAKA,IAAAC,cAAA,GAAAD,OAAA;AAOA,IAAAE,YAAA,GAAAF,OAAA;AACA,IAAAG,oBAAA,GAAAH,OAAA;AACA,IAAAI,MAAA,GAAAJ,OAAA;AAEA,MAAMK,SAAS,GAAG,eAAe;;AAEjC;AACA;AACA;AACA,MAAMC,aAAqC,GAAG,CAAC,CAAC;;AAEhD;AACA;AACA;AACA,MAAMC,MAAuB,GAAG,CAAC,CAAC;AAElC,MAAMC,YAAY,GAAG,IAAIC,cAAY,CAAC,CAAC;;AAEvC;AACA;AACA;AACA;AACA;AACO,MAAMC,MAAM,GAAAC,OAAA,CAAAD,MAAA,GAAG;EACpB;AACF;AACA;EACE,MAAME,IAAIA,CAAA,EAAkB;IAC1B,IAAAC,kBAAW,EAAC;MAAER,SAAS;MAAES,OAAO,EAAE;IAAuB,CAAC,CAAC;IAC3D;IACA,MAAMC,OAAO,CAACC,GAAG,CAAC;IAChB;IACA,GAAGC,MAAM,CAACC,MAAM,CAACX,MAAM,CAAC,CAACY,GAAG,CAAC,MAAOC,KAAK,IAAK;MAC5C,MAAM,CAACC,MAAM,CAAC,GAAG,MAAMD,KAAK,CAACC,MAAM,CAAC,CAAC;MACrC,IAAI,CAACA,MAAM,EACT,MAAM,IAAIC,wBAAW,CAAC,SAASF,KAAK,CAACG,IAAI,iBAAiB,CAAC;MAC7D;MACA,MAAM,CAACC,WAAW,CAAC,GAAG,MAAMJ,KAAK,CAACK,GAAG,CAACC,eAAe,CAAC,CACpD,uBAAuB,CACxB,CAAC;MACF,MAAMC,cAAc,GAAGV,MAAM,CAACC,MAAM,CAACM,WAAW,CAAC,CAACI,KAAK,CACpDC,OAAO,IAAKA,OACf,CAAC;MACD,IAAI,CAACF,cAAc,EACjB,MAAM,IAAIL,wBAAW,CACnB,sEAAsEF,KAAK,CAACG,IAAI,EAClF,CAAC;IACL,CAAC,CAAC;IACF;IACA,GAAGN,MAAM,CAACC,MAAM,CAACZ,aAAa,CAAC,CAACa,GAAG,CAAC,OAAO;MAAEW;IAAa,CAAC,KAAK;MAC9D,MAAM,CAACT,MAAM,CAAC,GAAG,MAAMS,YAAY,CAACT,MAAM,CAAC,CAAC;MAC5C,IAAI,CAACA,MAAM,EACT,MAAM,IAAIC,wBAAW,CACnB,gBAAgBQ,YAAY,CAACP,IAAI,iBACnC,CAAC;MACH;MACA,MAAM,CAACC,WAAW,CAAC,GAAG,MAAMM,YAAY,CAACL,GAAG,CAACC,eAAe,CAAC,CAC3D,8BAA8B,CAC/B,CAAC;MACF,MAAMC,cAAc,GAAGV,MAAM,CAACC,MAAM,CAACM,WAAW,CAAC,CAACI,KAAK,CACpDC,OAAO,IAAKA,OACf,CAAC;MACD,IAAI,CAACF,cAAc,EACjB,MAAM,IAAIL,wBAAW,CACnB,+EAA+EQ,YAAY,CAACP,IAAI,EAClG,CAAC;IACL,CAAC,CAAC,CACH,CAAC;;IAEF;IACA,KAAK,MAAM;MAAEO,YAAY;MAAEC,QAAQ;MAAEC;IAAW,CAAC,IAAIf,MAAM,CAACC,MAAM,CAChEZ,aACF,CAAC,EAAE;MACDwB,YAAY,CAACG,EAAE,CAAC,SAAS,EAAGnB,OAAO,IAAK;QACtC,IAAAoB,4BAAa,EACXpB,OAAO,EACPgB,YAAY,EACZC,QAAQ,EACRC,UACF,CAAC,CAACG,KAAK,CAAEC,KAAK,IAAK;UACjB,IAAAC,kBAAW,EAACD,KAAK,CAAC;QACpB,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ;IAEAE,wCAAmB,CAACC,QAAQ,CAAC7B,MAAM,CAAC;EACtC,CAAC;EAED;AACF;AACA;EACE,MAAM8B,QAAQA,CAAA,EAAkB;IAC9B,IAAA3B,kBAAW,EAAC;MAAER,SAAS;MAAES,OAAO,EAAE;IAAwB,CAAC,CAAC;IAC5D;IACA,MAAMC,OAAO,CAACC,GAAG,CAAC,CAChB,GAAGC,MAAM,CAACC,MAAM,CAACX,MAAM,CAAC,CAACY,GAAG,CAAC,MAAOC,KAAK,IAAKA,KAAK,CAACqB,KAAK,CAAC,CAAC,CAAC,EAC5D,GAAGxB,MAAM,CAACC,MAAM,CAACZ,aAAa,CAAC,CAACa,GAAG,CAAC,OAAO;MAAEW;IAAa,CAAC,KACzDA,YAAY,CAACY,KAAK,CAAC,CACrB,CAAC,CACF,CAAC;IACF;IACAzB,MAAM,CAAC0B,IAAI,CAACpC,MAAM,CAAC,CAACqC,OAAO,CAAExB,KAAK,IAAK,OAAOb,MAAM,CAACa,KAAK,CAAC,CAAC;IAC5DH,MAAM,CAAC0B,IAAI,CAACrC,aAAa,CAAC,CAACsC,OAAO,CAC/Bd,YAAY,IAAK,OAAOxB,aAAa,CAACwB,YAAY,CACrD,CAAC;IACD;IACA,MAAMtB,YAAY,CAACkC,KAAK,CAAC,CAAC;EAC5B,CAAC;EAED;AACF;AACA;EACEG,YAAYA,CAACzB,KAA6B,EAAQ;IAChD,MAAM0B,UAAU,GAAG1B,KAAK,YAAY2B,KAAK,GAAG3B,KAAK,GAAG,CAACA,KAAK,CAAC;IAC3D,IAAAP,kBAAW,EAAC;MACVR,SAAS;MACTS,OAAO,EAAE,qCAAqCgC,UAAU,CAACE,IAAI,CAAC,MAAM,CAAC;IACvE,CAAC,CAAC;IACF;IACA,KAAK,MAAM5B,KAAK,IAAI0B,UAAU,EAAE;MAC9B,IAAI,CAAC7B,MAAM,CAAC0B,IAAI,CAACpC,MAAM,CAAC,CAAC0C,QAAQ,CAAC7B,KAAK,CAAC,EAAE;QACxCb,MAAM,CAACa,KAAK,CAAC,GAAGZ,YAAY,CAACY,KAAK,CAACA,KAAK,EAAE;UACxC8B,0BAA0B,EAAE;QAC9B,CAAC,CAAC;MACJ;IACF;EACF,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;EACEC,aAAaA,CACXrB,YAAoB,EACpBsB,OAAiE,EACjEC,OAAmC,GAAG,CAAC,CAAC,EAClC;IACN,MAAMtB,QAAQ,GAAGqB,OAAO,YAAYL,KAAK,GAAGK,OAAO,GAAG,CAACA,OAAO,CAAC;IAC/D,MAAMpB,UAAU,GAAGqB,OAAO,EAAErB,UAAU,IAAI,KAAK;IAC/C,MAAMsB,KAAK,GAAGD,OAAO,EAAEC,KAAK,IAAI,KAAK;IAErC,IAAAzC,kBAAW,EAAC;MACVR,SAAS;MACTS,OAAO,EAAE,4CAA4CgB,YAAY,GAAG;MACpEyB,IAAI,EAAE;QAAED,KAAK;QAAEE,aAAa,EAAEzB,QAAQ,CAAC0B,MAAM;QAAEzB;MAAW;IAC5D,CAAC,CAAC;IACF,IAAI,CAACf,MAAM,CAAC0B,IAAI,CAACrC,aAAa,CAAC,CAAC2C,QAAQ,CAACnB,YAAY,CAAC,EAAE;MACtDxB,aAAa,CAACwB,YAAY,CAAC,GAAG;QAC5BA,YAAY,EAAEtB,YAAY,CAACsB,YAAY,CAACA,YAAY,EAAE;UACpDoB,0BAA0B,EAAE;QAC9B,CAAC,CAAC;QACFnB,QAAQ,EAAE;MACZ,CAAC;IACH;IAEA,IAAIC,UAAU,EAAE1B,aAAa,CAACwB,YAAY,CAAC,CAACE,UAAU,GAAG,IAAI;IAE7D,IAAIsB,KAAK,EAAEhD,aAAa,CAACwB,YAAY,CAAC,CAACC,QAAQ,CAAC2B,IAAI,CAAC,GAAG3B,QAAQ,CAAC,CAAC,KAC7DzB,aAAa,CAACwB,YAAY,CAAC,CAACC,QAAQ,CAAC4B,OAAO,CAAC,GAAG5B,QAAQ,CAAC;EAChE,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;AACA;EACE,MAAM6B,OAAOA,CACXxC,KAAa,EACbN,OAAgB,EAChB+C,UAAuB,EACvBC,WAAoB,EACL;IACf,IAAI,CAACvD,MAAM,CAACa,KAAK,CAAC,EAChB,MAAM,IAAIE,wBAAW,CAAC,0CAA0CF,KAAK,GAAG,CAAC;IAC3E,IAAAP,kBAAW,EAAC;MACVR,SAAS;MACTS,OAAO,EAAE,6BAA6BM,KAAK,GAAG;MAC9CmC,IAAI,EAAE;QAAEzC,OAAO;QAAE+C,UAAU;QAAEC;MAAY;IAC3C,CAAC,CAAC;IACF,MAAMvD,MAAM,CAACa,KAAK,CAAC,CAAC2C,cAAc,CAAC;MACjCC,IAAI,EAAElD,OAAO;MACb+C,UAAU;MACVC;IACF,CAAC,CAAC;EACJ;AACF,CAAC","ignoreList":[]}
+{"version":3,"file":"PubSub.js","names":["_pubsub","require","_handleMessage","_EngineError","_LifecycleController","_utils","namespace","subscriptions","topics","pubSubClient","PubsubClient","PubSub","exports","init","reportDebug","message","Promise","all","Object","values","map","topic","exists","EngineError","name","permissions","iam","testPermissions","hasPermissions","every","success","subscription","handlers","isDebezium","on","handleMessage","catch","error","reportError","LifecycleController","register","shutdown","flush","close","keys","forEach","addPublisher","options","topicArray","Array","join","data","includes","enableOpenTelemetryTracing","messageOrdering","enableMessageOrdering","batching","maxMessages","maxBytes","maxMilliseconds","undefined","gaxOpts","retry","retryCodes","backoffSettings","initialRetryDelayMillis","initialDelayMillis","maxRetryDelayMillis","maxDelayMillis","retryDelayMultiplier","delayMultiplier","initialRpcTimeoutMillis","maxRpcTimeoutMillis","rpcTimeoutMultiplier","totalTimeoutMillis","addSubscriber","handler","first","flowControl","ackDeadline","handlersCount","length","allowExcessMessages","push","unshift","publish","attributes","orderingKey","publishMessage","json"],"sources":["../../../src/entities/PubSub/PubSub.ts"],"sourcesContent":["import {\n  Attributes,\n  PubSub as PubsubClient,\n  Message\n} from '@google-cloud/pubsub';\nimport { handleMessage } from './handleMessage';\nimport {\n  PubSubTopicsMap,\n  PubSubSubscriptionsMap,\n  PubSubAddSubscriberOptions,\n  PubSubMessageHandler,\n  PubSubPublisherOptions\n} from './PubSub.types';\nimport { EngineError } from 'entities/EngineError';\nimport { LifecycleController } from 'entities/LifecycleController';\nimport { reportDebug, reportError } from 'utils';\n\nconst namespace = 'engine:PubSub';\n\n/**\n * Associative containing all the subscriptions sorted by topic registered for publishing\n */\nconst subscriptions: PubSubSubscriptionsMap = {};\n\n/**\n * Associative containing all the topics registered for publishing\n */\nconst topics: PubSubTopicsMap = {};\n\nconst pubSubClient = new PubsubClient();\n\n/**\n * This is a singleton service who's role is to manage pub/sub connections\n * It is the preferred way to interact with Pub/Sub as it manages the underlying subscription and handler objects\n * It avoids potential subscription splitting on an instance\n */\nexport const PubSub = {\n  /**\n   * Initialize the registered publishers and subscribers\n   */\n  async init(): Promise<void> {\n    reportDebug({ namespace, message: `Initializing Pub/Sub` });\n    // Check that all topics/permissions exist, and that we have permission on them\n    await Promise.all([\n      // Test that all topics actually exist and that we have permissions\n      ...Object.values(topics).map(async (topic) => {\n        const [exists] = await topic.exists();\n        if (!exists)\n          throw new EngineError(`Topic ${topic.name} does not exist`);\n        // Test permission ton publish to topic\n        const [permissions] = await topic.iam.testPermissions([\n          'pubsub.topics.publish'\n        ]);\n        const hasPermissions = Object.values(permissions).every(\n          (success) => success\n        );\n        if (!hasPermissions)\n          throw new EngineError(\n            `Instance does not have appropriate permissions to publish to topic ${topic.name}`\n          );\n      }),\n      // Test that all subscriptions actually exist and that we have permissions\n      ...Object.values(subscriptions).map(async ({ subscription }) => {\n        const [exists] = await subscription.exists();\n        if (!exists)\n          throw new EngineError(\n            `Subscription ${subscription.name} does not exist`\n          );\n        // Test permission ton consume subscription\n        const [permissions] = await subscription.iam.testPermissions([\n          'pubsub.subscriptions.consume'\n        ]);\n        const hasPermissions = Object.values(permissions).every(\n          (success) => success\n        );\n        if (!hasPermissions)\n          throw new EngineError(\n            `Instance does not have appropriate permissions to subscribe to subscription ${subscription.name}`\n          );\n      })\n    ]);\n\n    // Register handlers on the subscriptions to activate them\n    for (const { subscription, handlers, isDebezium } of Object.values(\n      subscriptions\n    )) {\n      subscription.on('message', (message) => {\n        handleMessage(\n          message as Message,\n          subscription,\n          handlers,\n          isDebezium\n        ).catch((error) => {\n          reportError(error);\n        });\n      });\n    }\n\n    LifecycleController.register(PubSub);\n  },\n\n  /**\n   * Shutdown the registered publishers and subscribers\n   */\n  async shutdown(): Promise<void> {\n    reportDebug({ namespace, message: `Shutting down Pub/Sub` });\n    // Flush all pending messages and shut down connections\n    await Promise.all([\n      ...Object.values(topics).map(async (topic) => topic.flush()),\n      ...Object.values(subscriptions).map(async ({ subscription }) =>\n        subscription.close()\n      )\n    ]);\n    // Delete the stored topics/subscriptions\n    Object.keys(topics).forEach((topic) => delete topics[topic]);\n    Object.keys(subscriptions).forEach(\n      (subscription) => delete subscriptions[subscription]\n    );\n    // Close the client\n    await pubSubClient.close();\n  },\n\n  /**\n   * Creates a publisher if it does not exist yet\n   * @param topic - Topic name or array of topic names\n   * @param options - Publisher configuration options\n   */\n  addPublisher(\n    topic: string | Array<string>,\n    options?: PubSubPublisherOptions\n  ): void {\n    const topicArray = topic instanceof Array ? topic : [topic];\n    reportDebug({\n      namespace,\n      message: `Registering publisher for topics '${topicArray.join(\"', '\")}'`,\n      data: options\n    });\n    // Register a new topic if it does not exist yet\n    for (const topic of topicArray) {\n      if (!Object.keys(topics).includes(topic)) {\n        topics[topic] = pubSubClient.topic(topic, {\n          enableOpenTelemetryTracing: true,\n          messageOrdering: options?.enableMessageOrdering ?? false,\n          batching: options?.batching\n            ? {\n                maxMessages: options.batching.maxMessages ?? 100,\n                maxBytes: options.batching.maxBytes ?? 1024 * 1024, // 1MB\n                maxMilliseconds: options.batching.maxMilliseconds ?? 100\n              }\n            : undefined,\n          gaxOpts: options?.retry\n            ? {\n                retry: {\n                  retryCodes: [10, 14], // ABORTED, UNAVAILABLE\n                  backoffSettings: {\n                    initialRetryDelayMillis:\n                      options.retry.initialDelayMillis ?? 100,\n                    maxRetryDelayMillis: options.retry.maxDelayMillis ?? 60000,\n                    retryDelayMultiplier: options.retry.delayMultiplier ?? 1.3,\n                    initialRpcTimeoutMillis: 60000,\n                    maxRpcTimeoutMillis: 600000,\n                    rpcTimeoutMultiplier: 1.0,\n                    totalTimeoutMillis: 600000\n                  }\n                }\n              }\n            : undefined\n        });\n      }\n    }\n  },\n\n  /**\n   * Add message handlers to a subscription\n   * @param subscription - Name of the Pub/Sub subscription\n   * @param handler - Function or list of functions to set as message handlers\n   * @param options - Indicates that the additional options need to handle on Subscriber\n   */\n  addSubscriber<T>(\n    subscription: string,\n    handler: PubSubMessageHandler<T> | Array<PubSubMessageHandler<T>>,\n    options: PubSubAddSubscriberOptions = {}\n  ): void {\n    const handlers = handler instanceof Array ? handler : [handler];\n    const isDebezium = options?.isDebezium ?? false;\n    const first = options?.first ?? false;\n    const flowControl = options?.flowControl;\n    const ackDeadline = options?.ackDeadline;\n\n    reportDebug({\n      namespace,\n      message: `Registering subscriber for subscription '${subscription}'`,\n      data: {\n        first,\n        handlersCount: handlers.length,\n        isDebezium,\n        flowControl\n      }\n    });\n    if (!Object.keys(subscriptions).includes(subscription)) {\n      subscriptions[subscription] = {\n        subscription: pubSubClient.subscription(subscription, {\n          enableOpenTelemetryTracing: true,\n          flowControl: flowControl\n            ? {\n                maxMessages: flowControl.maxMessages ?? 1000,\n                maxBytes: flowControl.maxBytes ?? 100 * 1024 * 1024, // 100MB\n                allowExcessMessages: flowControl.allowExcessMessages ?? true\n              }\n            : {\n                maxMessages: 1000,\n                maxBytes: 100 * 1024 * 1024,\n                allowExcessMessages: true\n              },\n          ackDeadline: ackDeadline ?? 60\n        }),\n        handlers: []\n      };\n    }\n\n    if (isDebezium) subscriptions[subscription].isDebezium = true;\n\n    if (first) subscriptions[subscription].handlers.push(...handlers);\n    else subscriptions[subscription].handlers.unshift(...handlers);\n  },\n\n  /**\n   * Send a message to a Pub/Sub topic\n   * @param topic - Name of the topic\n   * @param message - Content of the message, must be an object that can be JSON stringified\n   * @param attributes - Attributes for this message, can be used to filter messages on the subscription\n   * @param orderingKey - Enforce order guarantee of messages sent with the same key\n   */\n  async publish(\n    topic: string,\n    message: unknown,\n    attributes?: Attributes,\n    orderingKey?: string\n  ): Promise<void> {\n    if (!topics[topic])\n      throw new EngineError(`No publisher was registered for topic '${topic}'`);\n    reportDebug({\n      namespace,\n      message: `Sending message to topic '${topic}'`,\n      data: { message, attributes, orderingKey }\n    });\n    await topics[topic].publishMessage({\n      json: message,\n      attributes,\n      orderingKey\n    });\n  }\n};\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAKA,IAAAC,cAAA,GAAAD,OAAA;AAQA,IAAAE,YAAA,GAAAF,OAAA;AACA,IAAAG,oBAAA,GAAAH,OAAA;AACA,IAAAI,MAAA,GAAAJ,OAAA;AAEA,MAAMK,SAAS,GAAG,eAAe;;AAEjC;AACA;AACA;AACA,MAAMC,aAAqC,GAAG,CAAC,CAAC;;AAEhD;AACA;AACA;AACA,MAAMC,MAAuB,GAAG,CAAC,CAAC;AAElC,MAAMC,YAAY,GAAG,IAAIC,cAAY,CAAC,CAAC;;AAEvC;AACA;AACA;AACA;AACA;AACO,MAAMC,MAAM,GAAAC,OAAA,CAAAD,MAAA,GAAG;EACpB;AACF;AACA;EACE,MAAME,IAAIA,CAAA,EAAkB;IAC1B,IAAAC,kBAAW,EAAC;MAAER,SAAS;MAAES,OAAO,EAAE;IAAuB,CAAC,CAAC;IAC3D;IACA,MAAMC,OAAO,CAACC,GAAG,CAAC;IAChB;IACA,GAAGC,MAAM,CAACC,MAAM,CAACX,MAAM,CAAC,CAACY,GAAG,CAAC,MAAOC,KAAK,IAAK;MAC5C,MAAM,CAACC,MAAM,CAAC,GAAG,MAAMD,KAAK,CAACC,MAAM,CAAC,CAAC;MACrC,IAAI,CAACA,MAAM,EACT,MAAM,IAAIC,wBAAW,CAAC,SAASF,KAAK,CAACG,IAAI,iBAAiB,CAAC;MAC7D;MACA,MAAM,CAACC,WAAW,CAAC,GAAG,MAAMJ,KAAK,CAACK,GAAG,CAACC,eAAe,CAAC,CACpD,uBAAuB,CACxB,CAAC;MACF,MAAMC,cAAc,GAAGV,MAAM,CAACC,MAAM,CAACM,WAAW,CAAC,CAACI,KAAK,CACpDC,OAAO,IAAKA,OACf,CAAC;MACD,IAAI,CAACF,cAAc,EACjB,MAAM,IAAIL,wBAAW,CACnB,sEAAsEF,KAAK,CAACG,IAAI,EAClF,CAAC;IACL,CAAC,CAAC;IACF;IACA,GAAGN,MAAM,CAACC,MAAM,CAACZ,aAAa,CAAC,CAACa,GAAG,CAAC,OAAO;MAAEW;IAAa,CAAC,KAAK;MAC9D,MAAM,CAACT,MAAM,CAAC,GAAG,MAAMS,YAAY,CAACT,MAAM,CAAC,CAAC;MAC5C,IAAI,CAACA,MAAM,EACT,MAAM,IAAIC,wBAAW,CACnB,gBAAgBQ,YAAY,CAACP,IAAI,iBACnC,CAAC;MACH;MACA,MAAM,CAACC,WAAW,CAAC,GAAG,MAAMM,YAAY,CAACL,GAAG,CAACC,eAAe,CAAC,CAC3D,8BAA8B,CAC/B,CAAC;MACF,MAAMC,cAAc,GAAGV,MAAM,CAACC,MAAM,CAACM,WAAW,CAAC,CAACI,KAAK,CACpDC,OAAO,IAAKA,OACf,CAAC;MACD,IAAI,CAACF,cAAc,EACjB,MAAM,IAAIL,wBAAW,CACnB,+EAA+EQ,YAAY,CAACP,IAAI,EAClG,CAAC;IACL,CAAC,CAAC,CACH,CAAC;;IAEF;IACA,KAAK,MAAM;MAAEO,YAAY;MAAEC,QAAQ;MAAEC;IAAW,CAAC,IAAIf,MAAM,CAACC,MAAM,CAChEZ,aACF,CAAC,EAAE;MACDwB,YAAY,CAACG,EAAE,CAAC,SAAS,EAAGnB,OAAO,IAAK;QACtC,IAAAoB,4BAAa,EACXpB,OAAO,EACPgB,YAAY,EACZC,QAAQ,EACRC,UACF,CAAC,CAACG,KAAK,CAAEC,KAAK,IAAK;UACjB,IAAAC,kBAAW,EAACD,KAAK,CAAC;QACpB,CAAC,CAAC;MACJ,CAAC,CAAC;IACJ;IAEAE,wCAAmB,CAACC,QAAQ,CAAC7B,MAAM,CAAC;EACtC,CAAC;EAED;AACF;AACA;EACE,MAAM8B,QAAQA,CAAA,EAAkB;IAC9B,IAAA3B,kBAAW,EAAC;MAAER,SAAS;MAAES,OAAO,EAAE;IAAwB,CAAC,CAAC;IAC5D;IACA,MAAMC,OAAO,CAACC,GAAG,CAAC,CAChB,GAAGC,MAAM,CAACC,MAAM,CAACX,MAAM,CAAC,CAACY,GAAG,CAAC,MAAOC,KAAK,IAAKA,KAAK,CAACqB,KAAK,CAAC,CAAC,CAAC,EAC5D,GAAGxB,MAAM,CAACC,MAAM,CAACZ,aAAa,CAAC,CAACa,GAAG,CAAC,OAAO;MAAEW;IAAa,CAAC,KACzDA,YAAY,CAACY,KAAK,CAAC,CACrB,CAAC,CACF,CAAC;IACF;IACAzB,MAAM,CAAC0B,IAAI,CAACpC,MAAM,CAAC,CAACqC,OAAO,CAAExB,KAAK,IAAK,OAAOb,MAAM,CAACa,KAAK,CAAC,CAAC;IAC5DH,MAAM,CAAC0B,IAAI,CAACrC,aAAa,CAAC,CAACsC,OAAO,CAC/Bd,YAAY,IAAK,OAAOxB,aAAa,CAACwB,YAAY,CACrD,CAAC;IACD;IACA,MAAMtB,YAAY,CAACkC,KAAK,CAAC,CAAC;EAC5B,CAAC;EAED;AACF;AACA;AACA;AACA;EACEG,YAAYA,CACVzB,KAA6B,EAC7B0B,OAAgC,EAC1B;IACN,MAAMC,UAAU,GAAG3B,KAAK,YAAY4B,KAAK,GAAG5B,KAAK,GAAG,CAACA,KAAK,CAAC;IAC3D,IAAAP,kBAAW,EAAC;MACVR,SAAS;MACTS,OAAO,EAAE,qCAAqCiC,UAAU,CAACE,IAAI,CAAC,MAAM,CAAC,GAAG;MACxEC,IAAI,EAAEJ;IACR,CAAC,CAAC;IACF;IACA,KAAK,MAAM1B,KAAK,IAAI2B,UAAU,EAAE;MAC9B,IAAI,CAAC9B,MAAM,CAAC0B,IAAI,CAACpC,MAAM,CAAC,CAAC4C,QAAQ,CAAC/B,KAAK,CAAC,EAAE;QACxCb,MAAM,CAACa,KAAK,CAAC,GAAGZ,YAAY,CAACY,KAAK,CAACA,KAAK,EAAE;UACxCgC,0BAA0B,EAAE,IAAI;UAChCC,eAAe,EAAEP,OAAO,EAAEQ,qBAAqB,IAAI,KAAK;UACxDC,QAAQ,EAAET,OAAO,EAAES,QAAQ,GACvB;YACEC,WAAW,EAAEV,OAAO,CAACS,QAAQ,CAACC,WAAW,IAAI,GAAG;YAChDC,QAAQ,EAAEX,OAAO,CAACS,QAAQ,CAACE,QAAQ,IAAI,IAAI,GAAG,IAAI;YAAE;YACpDC,eAAe,EAAEZ,OAAO,CAACS,QAAQ,CAACG,eAAe,IAAI;UACvD,CAAC,GACDC,SAAS;UACbC,OAAO,EAAEd,OAAO,EAAEe,KAAK,GACnB;YACEA,KAAK,EAAE;cACLC,UAAU,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;cAAE;cACtBC,eAAe,EAAE;gBACfC,uBAAuB,EACrBlB,OAAO,CAACe,KAAK,CAACI,kBAAkB,IAAI,GAAG;gBACzCC,mBAAmB,EAAEpB,OAAO,CAACe,KAAK,CAACM,cAAc,IAAI,KAAK;gBAC1DC,oBAAoB,EAAEtB,OAAO,CAACe,KAAK,CAACQ,eAAe,IAAI,GAAG;gBAC1DC,uBAAuB,EAAE,KAAK;gBAC9BC,mBAAmB,EAAE,MAAM;gBAC3BC,oBAAoB,EAAE,GAAG;gBACzBC,kBAAkB,EAAE;cACtB;YACF;UACF,CAAC,GACDd;QACN,CAAC,CAAC;MACJ;IACF;EACF,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;EACEe,aAAaA,CACX5C,YAAoB,EACpB6C,OAAiE,EACjE7B,OAAmC,GAAG,CAAC,CAAC,EAClC;IACN,MAAMf,QAAQ,GAAG4C,OAAO,YAAY3B,KAAK,GAAG2B,OAAO,GAAG,CAACA,OAAO,CAAC;IAC/D,MAAM3C,UAAU,GAAGc,OAAO,EAAEd,UAAU,IAAI,KAAK;IAC/C,MAAM4C,KAAK,GAAG9B,OAAO,EAAE8B,KAAK,IAAI,KAAK;IACrC,MAAMC,WAAW,GAAG/B,OAAO,EAAE+B,WAAW;IACxC,MAAMC,WAAW,GAAGhC,OAAO,EAAEgC,WAAW;IAExC,IAAAjE,kBAAW,EAAC;MACVR,SAAS;MACTS,OAAO,EAAE,4CAA4CgB,YAAY,GAAG;MACpEoB,IAAI,EAAE;QACJ0B,KAAK;QACLG,aAAa,EAAEhD,QAAQ,CAACiD,MAAM;QAC9BhD,UAAU;QACV6C;MACF;IACF,CAAC,CAAC;IACF,IAAI,CAAC5D,MAAM,CAAC0B,IAAI,CAACrC,aAAa,CAAC,CAAC6C,QAAQ,CAACrB,YAAY,CAAC,EAAE;MACtDxB,aAAa,CAACwB,YAAY,CAAC,GAAG;QAC5BA,YAAY,EAAEtB,YAAY,CAACsB,YAAY,CAACA,YAAY,EAAE;UACpDsB,0BAA0B,EAAE,IAAI;UAChCyB,WAAW,EAAEA,WAAW,GACpB;YACErB,WAAW,EAAEqB,WAAW,CAACrB,WAAW,IAAI,IAAI;YAC5CC,QAAQ,EAAEoB,WAAW,CAACpB,QAAQ,IAAI,GAAG,GAAG,IAAI,GAAG,IAAI;YAAE;YACrDwB,mBAAmB,EAAEJ,WAAW,CAACI,mBAAmB,IAAI;UAC1D,CAAC,GACD;YACEzB,WAAW,EAAE,IAAI;YACjBC,QAAQ,EAAE,GAAG,GAAG,IAAI,GAAG,IAAI;YAC3BwB,mBAAmB,EAAE;UACvB,CAAC;UACLH,WAAW,EAAEA,WAAW,IAAI;QAC9B,CAAC,CAAC;QACF/C,QAAQ,EAAE;MACZ,CAAC;IACH;IAEA,IAAIC,UAAU,EAAE1B,aAAa,CAACwB,YAAY,CAAC,CAACE,UAAU,GAAG,IAAI;IAE7D,IAAI4C,KAAK,EAAEtE,aAAa,CAACwB,YAAY,CAAC,CAACC,QAAQ,CAACmD,IAAI,CAAC,GAAGnD,QAAQ,CAAC,CAAC,KAC7DzB,aAAa,CAACwB,YAAY,CAAC,CAACC,QAAQ,CAACoD,OAAO,CAAC,GAAGpD,QAAQ,CAAC;EAChE,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;AACA;EACE,MAAMqD,OAAOA,CACXhE,KAAa,EACbN,OAAgB,EAChBuE,UAAuB,EACvBC,WAAoB,EACL;IACf,IAAI,CAAC/E,MAAM,CAACa,KAAK,CAAC,EAChB,MAAM,IAAIE,wBAAW,CAAC,0CAA0CF,KAAK,GAAG,CAAC;IAC3E,IAAAP,kBAAW,EAAC;MACVR,SAAS;MACTS,OAAO,EAAE,6BAA6BM,KAAK,GAAG;MAC9C8B,IAAI,EAAE;QAAEpC,OAAO;QAAEuE,UAAU;QAAEC;MAAY;IAC3C,CAAC,CAAC;IACF,MAAM/E,MAAM,CAACa,KAAK,CAAC,CAACmE,cAAc,CAAC;MACjCC,IAAI,EAAE1E,OAAO;MACbuE,UAAU;MACVC;IACF,CAAC,CAAC;EACJ;AACF,CAAC","ignoreList":[]}

package/dist/entities/PubSub/PubSub.types.d.ts

@@ -21,6 +21,40 @@ export interface PubSubAddSubscriberOptions {
     first?: boolean;
     /** Indicates that the topic is a Debezium CDC topic, additional processing is done on the message */
     isDebezium?: boolean;
+    /** Flow control settings for the subscriber */
+    flowControl?: {
+        /** Maximum number of messages to process concurrently */
+        maxMessages?: number;
+        /** Maximum bytes to process concurrently */
+        maxBytes?: number;
+        /** Allow more messages than maxMessages if total bytes is under maxBytes */
+        allowExcessMessages?: boolean;
+    };
+    /** Acknowledgement deadline in seconds (10-600) */
+    ackDeadline?: number;
+}
+/** Options for configuring a publisher */
+export interface PubSubPublisherOptions {
+    /** Enable message ordering (requires orderingKey when publishing) */
+    enableMessageOrdering?: boolean;
+    /** Batching settings */
+    batching?: {
+        /** Maximum messages to batch */
+        maxMessages?: number;
+        /** Maximum bytes to batch */
+        maxBytes?: number;
+        /** Maximum delay in milliseconds */
+        maxMilliseconds?: number;
+    };
+    /** Retry settings */
+    retry?: {
+        /** Initial retry delay in milliseconds */
+        initialDelayMillis?: number;
+        /** Maximum retry delay in milliseconds */
+        maxDelayMillis?: number;
+        /** Retry delay multiplier */
+        delayMultiplier?: number;
+    };
 }
 export type PubSubMessageHandler<T> = (message: T, attributes: Attributes, publishedAt: Date) => void | Promise<void>;
 /** Debezium create event payload */

package/dist/entities/PubSub/PubSub.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"PubSub.types.js","names":[],"sources":["../../../src/entities/PubSub/PubSub.types.ts"],"sourcesContent":["import { Topic, Subscription, Attributes } from '@google-cloud/pubsub';\nimport { DebeziumEvent } from 'const/DebeziumEvent';\n\n/** List of all active topics */\nexport interface PubSubTopicsMap {\n  [topic: string]: Topic;\n}\n\n/** List of subscriptions handled for each topic */\nexport interface PubSubSubscriptionsMap {\n  [topic: string]: {\n    /** The Pub/Sub subscription object */\n    subscription: Subscription;\n    /** The message handling functions */\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    handlers: Array<PubSubMessageHandler<any>>;\n    /** Indicates that the subscription from Debezium events */\n    isDebezium?: boolean;\n  };\n}\n\n/** Options to setup a subscription  */\nexport interface PubSubAddSubscriberOptions {\n  /** Should the handlers declared here be added to the top of the queue, and called first when an new message arrives */\n  first?: boolean;\n  /** Indicates that the topic is a Debezium CDC topic, additional processing is done on the message */\n  isDebezium?: boolean;\n}\n\nexport type PubSubMessageHandler<T> = (\n  message: T,\n  attributes: Attributes,\n  publishedAt: Date\n) => void | Promise<void>;\n\n/** Debezium create event payload */\ninterface PubSubDebeziumCreatePayload<T> {\n  /** The instance properties before the operation */\n  before: null;\n  /** The instance properties after the operation */\n  after: T;\n  /** The operation that was executed */\n  op: DebeziumEvent.Create;\n  /** List of fields that have changed */\n  diff: Array<string>;\n}\n\n/** Debezium update event payload */\ninterface PubSubDebeziumUpdatePayload<T> {\n  /** The instance properties before the operation */\n  before: T;\n  /** The instance properties after the operation */\n  after: T;\n  /** The operation that was executed */\n  op: DebeziumEvent.Update;\n  /** List of fields that have changed */\n  diff: Array<string>;\n}\n\n/** Debezium delete event payload */\ninterface PubSubDebeziumDeletePayload<T> {\n  /** The instance properties before the operation */\n  before: T;\n  /** The instance properties after the operation */\n  after: null;\n  /** The operation that was executed */\n  op: DebeziumEvent.Delete;\n  /** List of fields that have changed */\n  diff: Array<string>;\n}\n\n/** Payload of Debezium messages */\nexport type PubSubDebeziumPayload<T> =\n  | PubSubDebeziumCreatePayload<T>\n  | PubSubDebeziumUpdatePayload<T>\n  | PubSubDebeziumDeletePayload<T>;\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"PubSub.types.js","names":[],"sources":["../../../src/entities/PubSub/PubSub.types.ts"],"sourcesContent":["import { Topic, Subscription, Attributes } from '@google-cloud/pubsub';\nimport { DebeziumEvent } from 'const/DebeziumEvent';\n\n/** List of all active topics */\nexport interface PubSubTopicsMap {\n  [topic: string]: Topic;\n}\n\n/** List of subscriptions handled for each topic */\nexport interface PubSubSubscriptionsMap {\n  [topic: string]: {\n    /** The Pub/Sub subscription object */\n    subscription: Subscription;\n    /** The message handling functions */\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    handlers: Array<PubSubMessageHandler<any>>;\n    /** Indicates that the subscription from Debezium events */\n    isDebezium?: boolean;\n  };\n}\n\n/** Options to setup a subscription  */\nexport interface PubSubAddSubscriberOptions {\n  /** Should the handlers declared here be added to the top of the queue, and called first when an new message arrives */\n  first?: boolean;\n  /** Indicates that the topic is a Debezium CDC topic, additional processing is done on the message */\n  isDebezium?: boolean;\n  /** Flow control settings for the subscriber */\n  flowControl?: {\n    /** Maximum number of messages to process concurrently */\n    maxMessages?: number;\n    /** Maximum bytes to process concurrently */\n    maxBytes?: number;\n    /** Allow more messages than maxMessages if total bytes is under maxBytes */\n    allowExcessMessages?: boolean;\n  };\n  /** Acknowledgement deadline in seconds (10-600) */\n  ackDeadline?: number;\n}\n\n/** Options for configuring a publisher */\nexport interface PubSubPublisherOptions {\n  /** Enable message ordering (requires orderingKey when publishing) */\n  enableMessageOrdering?: boolean;\n  /** Batching settings */\n  batching?: {\n    /** Maximum messages to batch */\n    maxMessages?: number;\n    /** Maximum bytes to batch */\n    maxBytes?: number;\n    /** Maximum delay in milliseconds */\n    maxMilliseconds?: number;\n  };\n  /** Retry settings */\n  retry?: {\n    /** Initial retry delay in milliseconds */\n    initialDelayMillis?: number;\n    /** Maximum retry delay in milliseconds */\n    maxDelayMillis?: number;\n    /** Retry delay multiplier */\n    delayMultiplier?: number;\n  };\n}\n\nexport type PubSubMessageHandler<T> = (\n  message: T,\n  attributes: Attributes,\n  publishedAt: Date\n) => void | Promise<void>;\n\n/** Debezium create event payload */\ninterface PubSubDebeziumCreatePayload<T> {\n  /** The instance properties before the operation */\n  before: null;\n  /** The instance properties after the operation */\n  after: T;\n  /** The operation that was executed */\n  op: DebeziumEvent.Create;\n  /** List of fields that have changed */\n  diff: Array<string>;\n}\n\n/** Debezium update event payload */\ninterface PubSubDebeziumUpdatePayload<T> {\n  /** The instance properties before the operation */\n  before: T;\n  /** The instance properties after the operation */\n  after: T;\n  /** The operation that was executed */\n  op: DebeziumEvent.Update;\n  /** List of fields that have changed */\n  diff: Array<string>;\n}\n\n/** Debezium delete event payload */\ninterface PubSubDebeziumDeletePayload<T> {\n  /** The instance properties before the operation */\n  before: T;\n  /** The instance properties after the operation */\n  after: null;\n  /** The operation that was executed */\n  op: DebeziumEvent.Delete;\n  /** List of fields that have changed */\n  diff: Array<string>;\n}\n\n/** Payload of Debezium messages */\nexport type PubSubDebeziumPayload<T> =\n  | PubSubDebeziumCreatePayload<T>\n  | PubSubDebeziumUpdatePayload<T>\n  | PubSubDebeziumDeletePayload<T>;\n"],"mappings":"","ignoreList":[]}

package/dist/entities/PubSub/handleMessage/handleMessage.js

@@ -21,7 +21,6 @@ async function handleMessage(message, subscription, handlers, isDebezium = false
     namespace,
     message: `Received message from Pub/Sub [${subscription.name}]`
   });
-  message.ack();
   let payload;
   try {
     payload = JSON.parse(message.data.toString());
@@ -42,22 +41,41 @@ async function handleMessage(message, subscription, handlers, isDebezium = false
         }
       });
     }
-  } catch {
-    throw new _EngineError.EngineError({
+  } catch (error) {
+    (0, _utils.reportError)(new _EngineError.EngineError({
       severity: _const.LogSeverity.WARNING,
       message: `Pub/Sub message is not valid JSON ${subscription.name}`,
       data: {
         subscription,
         message: message.data.toString()
       }
-    });
+    }));
+    // Acknowledge invalid messages to prevent redelivery
+    message.ack();
+    return;
   }
+
+  // Process all handlers
+  let hasError = false;
   for (const handler of handlers) {
     try {
       await handler(payload, message.attributes, message.publishTime);
     } catch (error) {
+      hasError = true;
       (0, _utils.reportError)(error);
     }
   }
+
+  // Acknowledge message only after successful processing
+  // If there was an error, nack the message so it can be redelivered
+  if (hasError) {
+    (0, _utils.reportDebug)({
+      namespace,
+      message: `Nacking message due to handler errors [${subscription.name}]`
+    });
+    message.nack();
+  } else {
+    message.ack();
+  }
 }
 //# sourceMappingURL=handleMessage.js.map

package/dist/entities/PubSub/handleMessage/handleMessage.js.map

@@ -1 +1 @@
-{"version":3,"file":"handleMessage.js","names":["_const","require","_EngineError","_utils","namespace","handleMessage","message","subscription","handlers","isDebezium","reportDebug","name","ack","payload","JSON","parse","data","toString","before","after","diff","Object","keys","filter","key","EngineError","severity","LogSeverity","WARNING","handler","attributes","publishTime","error","reportError"],"sources":["../../../../src/entities/PubSub/handleMessage/handleMessage.ts"],"sourcesContent":["import { Subscription, Message } from '@google-cloud/pubsub';\nimport { PubSubMessageHandler, PubSubDebeziumPayload } from '../PubSub.types';\nimport { LogSeverity } from 'const';\nimport { EngineError } from 'entities/EngineError';\nimport { reportDebug, reportError } from 'utils';\n\nconst namespace = 'engine:PubSub:handleMessage';\n\n/**\n * handle the pubSubClients on message event\n * @param message - Message to parse and handle\n * @param subscription - The related Pub/Sub subscription object\n * @param handlers - Message handlers\n * @param isDebezium - Indicates that the subscription from Debezium events\n */\nexport async function handleMessage(\n  message: Message,\n  subscription: Subscription,\n  handlers: Array<PubSubMessageHandler<unknown>>,\n  isDebezium = false\n): Promise<void> {\n  reportDebug({\n    namespace,\n    message: `Received message from Pub/Sub [${subscription.name}]`\n  });\n\n  message.ack();\n\n  let payload;\n  try {\n    payload = JSON.parse(message.data.toString()) as unknown;\n\n    // When handling Debezium message, we calculate automatically the keys that have changed between the previous and current state\n    if (isDebezium) {\n      payload = payload as PubSubDebeziumPayload<Record<string, unknown>>;\n      const { before, after } = payload;\n      if (before && after)\n        payload.diff = Object.keys(after).filter(\n          (key) => after[key] !== before[key]\n        );\n      else if (before) payload.diff = Object.keys(before);\n      else if (after) payload.diff = Object.keys(after);\n      else\n        throw new EngineError({\n          severity: LogSeverity.WARNING,\n          message: `Debezium Pub/Sub message did not include before nor after value [${subscription.name}]`,\n          data: { subscription, message: message.data.toString() }\n        });\n    }\n  } catch {\n    throw new EngineError({\n      severity: LogSeverity.WARNING,\n      message: `Pub/Sub message is not valid JSON ${subscription.name}`,\n      data: { subscription, message: message.data.toString() }\n    });\n  }\n\n  for (const handler of handlers) {\n    try {\n      await handler(payload, message.attributes, message.publishTime);\n    } catch (error) {\n      reportError(error);\n    }\n  }\n}\n"],"mappings":";;;;;;AAEA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,YAAA,GAAAD,OAAA;AACA,IAAAE,MAAA,GAAAF,OAAA;AAEA,MAAMG,SAAS,GAAG,6BAA6B;;AAE/C;AACA;AACA;AACA;AACA;AACA;AACA;AACO,eAAeC,aAAaA,CACjCC,OAAgB,EAChBC,YAA0B,EAC1BC,QAA8C,EAC9CC,UAAU,GAAG,KAAK,EACH;EACf,IAAAC,kBAAW,EAAC;IACVN,SAAS;IACTE,OAAO,EAAE,kCAAkCC,YAAY,CAACI,IAAI;EAC9D,CAAC,CAAC;EAEFL,OAAO,CAACM,GAAG,CAAC,CAAC;EAEb,IAAIC,OAAO;EACX,IAAI;IACFA,OAAO,GAAGC,IAAI,CAACC,KAAK,CAACT,OAAO,CAACU,IAAI,CAACC,QAAQ,CAAC,CAAC,CAAY;;IAExD;IACA,IAAIR,UAAU,EAAE;MACdI,OAAO,GAAGA,OAAyD;MACnE,MAAM;QAAEK,MAAM;QAAEC;MAAM,CAAC,GAAGN,OAAO;MACjC,IAAIK,MAAM,IAAIC,KAAK,EACjBN,OAAO,CAACO,IAAI,GAAGC,MAAM,CAACC,IAAI,CAACH,KAAK,CAAC,CAACI,MAAM,CACrCC,GAAG,IAAKL,KAAK,CAACK,GAAG,CAAC,KAAKN,MAAM,CAACM,GAAG,CACpC,CAAC,CAAC,KACC,IAAIN,MAAM,EAAEL,OAAO,CAACO,IAAI,GAAGC,MAAM,CAACC,IAAI,CAACJ,MAAM,CAAC,CAAC,KAC/C,IAAIC,KAAK,EAAEN,OAAO,CAACO,IAAI,GAAGC,MAAM,CAACC,IAAI,CAACH,KAAK,CAAC,CAAC,KAEhD,MAAM,IAAIM,wBAAW,CAAC;QACpBC,QAAQ,EAAEC,kBAAW,CAACC,OAAO;QAC7BtB,OAAO,EAAE,oEAAoEC,YAAY,CAACI,IAAI,GAAG;QACjGK,IAAI,EAAE;UAAET,YAAY;UAAED,OAAO,EAAEA,OAAO,CAACU,IAAI,CAACC,QAAQ,CAAC;QAAE;MACzD,CAAC,CAAC;IACN;EACF,CAAC,CAAC,MAAM;IACN,MAAM,IAAIQ,wBAAW,CAAC;MACpBC,QAAQ,EAAEC,kBAAW,CAACC,OAAO;MAC7BtB,OAAO,EAAE,qCAAqCC,YAAY,CAACI,IAAI,EAAE;MACjEK,IAAI,EAAE;QAAET,YAAY;QAAED,OAAO,EAAEA,OAAO,CAACU,IAAI,CAACC,QAAQ,CAAC;MAAE;IACzD,CAAC,CAAC;EACJ;EAEA,KAAK,MAAMY,OAAO,IAAIrB,QAAQ,EAAE;IAC9B,IAAI;MACF,MAAMqB,OAAO,CAAChB,OAAO,EAAEP,OAAO,CAACwB,UAAU,EAAExB,OAAO,CAACyB,WAAW,CAAC;IACjE,CAAC,CAAC,OAAOC,KAAK,EAAE;MACd,IAAAC,kBAAW,EAACD,KAAK,CAAC;IACpB;EACF;AACF","ignoreList":[]}
+{"version":3,"file":"handleMessage.js","names":["_const","require","_EngineError","_utils","namespace","handleMessage","message","subscription","handlers","isDebezium","reportDebug","name","payload","JSON","parse","data","toString","before","after","diff","Object","keys","filter","key","EngineError","severity","LogSeverity","WARNING","error","reportError","ack","hasError","handler","attributes","publishTime","nack"],"sources":["../../../../src/entities/PubSub/handleMessage/handleMessage.ts"],"sourcesContent":["import { Subscription, Message } from '@google-cloud/pubsub';\nimport { PubSubMessageHandler, PubSubDebeziumPayload } from '../PubSub.types';\nimport { LogSeverity } from 'const';\nimport { EngineError } from 'entities/EngineError';\nimport { reportDebug, reportError } from 'utils';\n\nconst namespace = 'engine:PubSub:handleMessage';\n\n/**\n * handle the pubSubClients on message event\n * @param message - Message to parse and handle\n * @param subscription - The related Pub/Sub subscription object\n * @param handlers - Message handlers\n * @param isDebezium - Indicates that the subscription from Debezium events\n */\nexport async function handleMessage(\n  message: Message,\n  subscription: Subscription,\n  handlers: Array<PubSubMessageHandler<unknown>>,\n  isDebezium = false\n): Promise<void> {\n  reportDebug({\n    namespace,\n    message: `Received message from Pub/Sub [${subscription.name}]`\n  });\n\n  let payload;\n  try {\n    payload = JSON.parse(message.data.toString()) as unknown;\n\n    // When handling Debezium message, we calculate automatically the keys that have changed between the previous and current state\n    if (isDebezium) {\n      payload = payload as PubSubDebeziumPayload<Record<string, unknown>>;\n      const { before, after } = payload;\n      if (before && after)\n        payload.diff = Object.keys(after).filter(\n          (key) => after[key] !== before[key]\n        );\n      else if (before) payload.diff = Object.keys(before);\n      else if (after) payload.diff = Object.keys(after);\n      else\n        throw new EngineError({\n          severity: LogSeverity.WARNING,\n          message: `Debezium Pub/Sub message did not include before nor after value [${subscription.name}]`,\n          data: { subscription, message: message.data.toString() }\n        });\n    }\n  } catch (error) {\n    reportError(\n      new EngineError({\n        severity: LogSeverity.WARNING,\n        message: `Pub/Sub message is not valid JSON ${subscription.name}`,\n        data: { subscription, message: message.data.toString() }\n      })\n    );\n    // Acknowledge invalid messages to prevent redelivery\n    message.ack();\n    return;\n  }\n\n  // Process all handlers\n  let hasError = false;\n  for (const handler of handlers) {\n    try {\n      await handler(payload, message.attributes, message.publishTime);\n    } catch (error) {\n      hasError = true;\n      reportError(error);\n    }\n  }\n\n  // Acknowledge message only after successful processing\n  // If there was an error, nack the message so it can be redelivered\n  if (hasError) {\n    reportDebug({\n      namespace,\n      message: `Nacking message due to handler errors [${subscription.name}]`\n    });\n    message.nack();\n  } else {\n    message.ack();\n  }\n}\n"],"mappings":";;;;;;AAEA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,YAAA,GAAAD,OAAA;AACA,IAAAE,MAAA,GAAAF,OAAA;AAEA,MAAMG,SAAS,GAAG,6BAA6B;;AAE/C;AACA;AACA;AACA;AACA;AACA;AACA;AACO,eAAeC,aAAaA,CACjCC,OAAgB,EAChBC,YAA0B,EAC1BC,QAA8C,EAC9CC,UAAU,GAAG,KAAK,EACH;EACf,IAAAC,kBAAW,EAAC;IACVN,SAAS;IACTE,OAAO,EAAE,kCAAkCC,YAAY,CAACI,IAAI;EAC9D,CAAC,CAAC;EAEF,IAAIC,OAAO;EACX,IAAI;IACFA,OAAO,GAAGC,IAAI,CAACC,KAAK,CAACR,OAAO,CAACS,IAAI,CAACC,QAAQ,CAAC,CAAC,CAAY;;IAExD;IACA,IAAIP,UAAU,EAAE;MACdG,OAAO,GAAGA,OAAyD;MACnE,MAAM;QAAEK,MAAM;QAAEC;MAAM,CAAC,GAAGN,OAAO;MACjC,IAAIK,MAAM,IAAIC,KAAK,EACjBN,OAAO,CAACO,IAAI,GAAGC,MAAM,CAACC,IAAI,CAACH,KAAK,CAAC,CAACI,MAAM,CACrCC,GAAG,IAAKL,KAAK,CAACK,GAAG,CAAC,KAAKN,MAAM,CAACM,GAAG,CACpC,CAAC,CAAC,KACC,IAAIN,MAAM,EAAEL,OAAO,CAACO,IAAI,GAAGC,MAAM,CAACC,IAAI,CAACJ,MAAM,CAAC,CAAC,KAC/C,IAAIC,KAAK,EAAEN,OAAO,CAACO,IAAI,GAAGC,MAAM,CAACC,IAAI,CAACH,KAAK,CAAC,CAAC,KAEhD,MAAM,IAAIM,wBAAW,CAAC;QACpBC,QAAQ,EAAEC,kBAAW,CAACC,OAAO;QAC7BrB,OAAO,EAAE,oEAAoEC,YAAY,CAACI,IAAI,GAAG;QACjGI,IAAI,EAAE;UAAER,YAAY;UAAED,OAAO,EAAEA,OAAO,CAACS,IAAI,CAACC,QAAQ,CAAC;QAAE;MACzD,CAAC,CAAC;IACN;EACF,CAAC,CAAC,OAAOY,KAAK,EAAE;IACd,IAAAC,kBAAW,EACT,IAAIL,wBAAW,CAAC;MACdC,QAAQ,EAAEC,kBAAW,CAACC,OAAO;MAC7BrB,OAAO,EAAE,qCAAqCC,YAAY,CAACI,IAAI,EAAE;MACjEI,IAAI,EAAE;QAAER,YAAY;QAAED,OAAO,EAAEA,OAAO,CAACS,IAAI,CAACC,QAAQ,CAAC;MAAE;IACzD,CAAC,CACH,CAAC;IACD;IACAV,OAAO,CAACwB,GAAG,CAAC,CAAC;IACb;EACF;;EAEA;EACA,IAAIC,QAAQ,GAAG,KAAK;EACpB,KAAK,MAAMC,OAAO,IAAIxB,QAAQ,EAAE;IAC9B,IAAI;MACF,MAAMwB,OAAO,CAACpB,OAAO,EAAEN,OAAO,CAAC2B,UAAU,EAAE3B,OAAO,CAAC4B,WAAW,CAAC;IACjE,CAAC,CAAC,OAAON,KAAK,EAAE;MACdG,QAAQ,GAAG,IAAI;MACf,IAAAF,kBAAW,EAACD,KAAK,CAAC;IACpB;EACF;;EAEA;EACA;EACA,IAAIG,QAAQ,EAAE;IACZ,IAAArB,kBAAW,EAAC;MACVN,SAAS;MACTE,OAAO,EAAE,0CAA0CC,YAAY,CAACI,IAAI;IACtE,CAAC,CAAC;IACFL,OAAO,CAAC6B,IAAI,CAAC,CAAC;EAChB,CAAC,MAAM;IACL7B,OAAO,CAACwB,GAAG,CAAC,CAAC;EACf;AACF","ignoreList":[]}

package/dist/entities/PushNotification/PushNotification.d.ts

@@ -1,11 +1,15 @@
 import { PushNotificationNotification } from './PushNotification.types';
 export declare const PushNotification: {
-    /** Initialize the push notification entity */
-    init(): void;
+    /**
+     * Initialize the push notification entity
+     * Registers the publisher with optimal settings for push notifications
+     */
+    init(): Promise<void>;
     /**
      * Send a push notification through the push service
      * @param userId - ID of the user that should receive the notification
      * @param notification - Notification that should be sent
+     * @throws {EngineError} If the topic is not initialized or publish fails
      */
     sendPush(userId: string, notification: PushNotificationNotification): Promise<void>;
 };

package/dist/entities/PushNotification/PushNotification.js

@@ -9,8 +9,11 @@ var _PubSub = require("../PubSub");
 var _utils = require("../../utils");
 const namespace = 'engine:PushNotification';
 const PushNotification = exports.PushNotification = {
-  /** Initialize the push notification entity */
-  init() {
+  /**
+   * Initialize the push notification entity
+   * Registers the publisher with optimal settings for push notifications
+   */
+  async init() {
     (0, _utils.reportDebug)({
       namespace,
       message: 'Initializing PushNotification'
@@ -18,27 +21,60 @@ const PushNotification = exports.PushNotification = {
     if (!process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC) throw new _.EngineError({
       message: 'Environment variable PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC is not defined'
     });
-    // Register publisher
-    _PubSub.PubSub.addPublisher(process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC);
+
+    // Register publisher with optimized settings for push notifications
+    _PubSub.PubSub.addPublisher(process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC, {
+      enableMessageOrdering: false,
+      // Push notifications don't need strict ordering
+      batching: {
+        maxMessages: 100,
+        maxBytes: 1024 * 1024,
+        // 1MB
+        maxMilliseconds: 50 // Fast delivery for notifications
+      },
+      retry: {
+        initialDelayMillis: 100,
+        maxDelayMillis: 60000,
+        delayMultiplier: 1.3
+      }
+    });
   },
   /**
    * Send a push notification through the push service
    * @param userId - ID of the user that should receive the notification
    * @param notification - Notification that should be sent
+   * @throws {EngineError} If the topic is not initialized or publish fails
    */
   async sendPush(userId, notification) {
+    if (!userId) {
+      throw new _.EngineError({
+        message: 'userId is required to send push notification'
+      });
+    }
     (0, _utils.reportDebug)({
       namespace,
-      message: `Received data to send notification to user with Id '${userId}'`,
+      message: `Sending push notification to user '${userId}'`,
       data: {
         userId,
         notification
       }
     });
-    await _PubSub.PubSub.publish(process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC, {
-      ...notification,
-      userId
-    });
+    try {
+      await _PubSub.PubSub.publish(process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC, {
+        ...notification,
+        userId
+      });
+    } catch (error) {
+      (0, _utils.reportError)(new _.EngineError({
+        message: `Failed to send push notification to user '${userId}'`,
+        data: {
+          userId,
+          notification,
+          error
+        }
+      }));
+      throw error;
+    }
   }
 };
 //# sourceMappingURL=PushNotification.js.map

package/dist/entities/PushNotification/PushNotification.js.map

@@ -1 +1 @@
-{"version":3,"file":"PushNotification.js","names":["_","require","_PubSub","_utils","namespace","PushNotification","exports","init","reportDebug","message","process","env","PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC","EngineError","PubSub","addPublisher","sendPush","userId","notification","data","publish"],"sources":["../../../src/entities/PushNotification/PushNotification.ts"],"sourcesContent":["import { PushNotificationNotification } from './PushNotification.types';\nimport { EngineError } from 'entities';\nimport { PubSub } from 'entities/PubSub';\nimport { reportDebug } from 'utils';\n\nconst namespace = 'engine:PushNotification';\n\nexport const PushNotification = {\n  /** Initialize the push notification entity */\n  init(): void {\n    reportDebug({ namespace, message: 'Initializing PushNotification' });\n    if (!process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC)\n      throw new EngineError({\n        message:\n          'Environment variable PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC is not defined'\n      });\n    // Register publisher\n    PubSub.addPublisher(process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC);\n  },\n\n  /**\n   * Send a push notification through the push service\n   * @param userId - ID of the user that should receive the notification\n   * @param notification - Notification that should be sent\n   */\n  async sendPush(\n    userId: string,\n    notification: PushNotificationNotification\n  ): Promise<void> {\n    reportDebug({\n      namespace,\n      message: `Received data to send notification to user with Id '${userId}'`,\n      data: { userId, notification }\n    });\n\n    await PubSub.publish(\n      process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC as string,\n      {\n        ...notification,\n        userId\n      }\n    );\n  }\n};\n"],"mappings":";;;;;;AACA,IAAAA,CAAA,GAAAC,OAAA;AACA,IAAAC,OAAA,GAAAD,OAAA;AACA,IAAAE,MAAA,GAAAF,OAAA;AAEA,MAAMG,SAAS,GAAG,yBAAyB;AAEpC,MAAMC,gBAAgB,GAAAC,OAAA,CAAAD,gBAAA,GAAG;EAC9B;EACAE,IAAIA,CAAA,EAAS;IACX,IAAAC,kBAAW,EAAC;MAAEJ,SAAS;MAAEK,OAAO,EAAE;IAAgC,CAAC,CAAC;IACpE,IAAI,CAACC,OAAO,CAACC,GAAG,CAACC,oCAAoC,EACnD,MAAM,IAAIC,aAAW,CAAC;MACpBJ,OAAO,EACL;IACJ,CAAC,CAAC;IACJ;IACAK,cAAM,CAACC,YAAY,CAACL,OAAO,CAACC,GAAG,CAACC,oCAAoC,CAAC;EACvE,CAAC;EAED;AACF;AACA;AACA;AACA;EACE,MAAMI,QAAQA,CACZC,MAAc,EACdC,YAA0C,EAC3B;IACf,IAAAV,kBAAW,EAAC;MACVJ,SAAS;MACTK,OAAO,EAAE,uDAAuDQ,MAAM,GAAG;MACzEE,IAAI,EAAE;QAAEF,MAAM;QAAEC;MAAa;IAC/B,CAAC,CAAC;IAEF,MAAMJ,cAAM,CAACM,OAAO,CAClBV,OAAO,CAACC,GAAG,CAACC,oCAAoC,EAChD;MACE,GAAGM,YAAY;MACfD;IACF,CACF,CAAC;EACH;AACF,CAAC","ignoreList":[]}
+{"version":3,"file":"PushNotification.js","names":["_","require","_PubSub","_utils","namespace","PushNotification","exports","init","reportDebug","message","process","env","PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC","EngineError","PubSub","addPublisher","enableMessageOrdering","batching","maxMessages","maxBytes","maxMilliseconds","retry","initialDelayMillis","maxDelayMillis","delayMultiplier","sendPush","userId","notification","data","publish","error","reportError"],"sources":["../../../src/entities/PushNotification/PushNotification.ts"],"sourcesContent":["import { PushNotificationNotification } from './PushNotification.types';\nimport { EngineError } from 'entities';\nimport { PubSub } from 'entities/PubSub';\nimport { reportDebug, reportError } from 'utils';\n\nconst namespace = 'engine:PushNotification';\n\nexport const PushNotification = {\n  /**\n   * Initialize the push notification entity\n   * Registers the publisher with optimal settings for push notifications\n   */\n  async init(): Promise<void> {\n    reportDebug({ namespace, message: 'Initializing PushNotification' });\n    if (!process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC)\n      throw new EngineError({\n        message:\n          'Environment variable PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC is not defined'\n      });\n    \n    // Register publisher with optimized settings for push notifications\n    PubSub.addPublisher(process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC, {\n      enableMessageOrdering: false, // Push notifications don't need strict ordering\n      batching: {\n        maxMessages: 100,\n        maxBytes: 1024 * 1024, // 1MB\n        maxMilliseconds: 50 // Fast delivery for notifications\n      },\n      retry: {\n        initialDelayMillis: 100,\n        maxDelayMillis: 60000,\n        delayMultiplier: 1.3\n      }\n    });\n  },\n\n  /**\n   * Send a push notification through the push service\n   * @param userId - ID of the user that should receive the notification\n   * @param notification - Notification that should be sent\n   * @throws {EngineError} If the topic is not initialized or publish fails\n   */\n  async sendPush(\n    userId: string,\n    notification: PushNotificationNotification\n  ): Promise<void> {\n    if (!userId) {\n      throw new EngineError({\n        message: 'userId is required to send push notification'\n      });\n    }\n\n    reportDebug({\n      namespace,\n      message: `Sending push notification to user '${userId}'`,\n      data: { userId, notification }\n    });\n\n    try {\n      await PubSub.publish(\n        process.env.PUBSUB_PUSH_NOTIFICATION_QUEUE_TOPIC as string,\n        {\n          ...notification,\n          userId\n        }\n      );\n    } catch (error) {\n      reportError(\n        new EngineError({\n          message: `Failed to send push notification to user '${userId}'`,\n          data: { userId, notification, error }\n        })\n      );\n      throw error;\n    }\n  }\n};\n"],"mappings":";;;;;;AACA,IAAAA,CAAA,GAAAC,OAAA;AACA,IAAAC,OAAA,GAAAD,OAAA;AACA,IAAAE,MAAA,GAAAF,OAAA;AAEA,MAAMG,SAAS,GAAG,yBAAyB;AAEpC,MAAMC,gBAAgB,GAAAC,OAAA,CAAAD,gBAAA,GAAG;EAC9B;AACF;AACA;AACA;EACE,MAAME,IAAIA,CAAA,EAAkB;IAC1B,IAAAC,kBAAW,EAAC;MAAEJ,SAAS;MAAEK,OAAO,EAAE;IAAgC,CAAC,CAAC;IACpE,IAAI,CAACC,OAAO,CAACC,GAAG,CAACC,oCAAoC,EACnD,MAAM,IAAIC,aAAW,CAAC;MACpBJ,OAAO,EACL;IACJ,CAAC,CAAC;;IAEJ;IACAK,cAAM,CAACC,YAAY,CAACL,OAAO,CAACC,GAAG,CAACC,oCAAoC,EAAE;MACpEI,qBAAqB,EAAE,KAAK;MAAE;MAC9BC,QAAQ,EAAE;QACRC,WAAW,EAAE,GAAG;QAChBC,QAAQ,EAAE,IAAI,GAAG,IAAI;QAAE;QACvBC,eAAe,EAAE,EAAE,CAAC;MACtB,CAAC;MACDC,KAAK,EAAE;QACLC,kBAAkB,EAAE,GAAG;QACvBC,cAAc,EAAE,KAAK;QACrBC,eAAe,EAAE;MACnB;IACF,CAAC,CAAC;EACJ,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;EACE,MAAMC,QAAQA,CACZC,MAAc,EACdC,YAA0C,EAC3B;IACf,IAAI,CAACD,MAAM,EAAE;MACX,MAAM,IAAIb,aAAW,CAAC;QACpBJ,OAAO,EAAE;MACX,CAAC,CAAC;IACJ;IAEA,IAAAD,kBAAW,EAAC;MACVJ,SAAS;MACTK,OAAO,EAAE,sCAAsCiB,MAAM,GAAG;MACxDE,IAAI,EAAE;QAAEF,MAAM;QAAEC;MAAa;IAC/B,CAAC,CAAC;IAEF,IAAI;MACF,MAAMb,cAAM,CAACe,OAAO,CAClBnB,OAAO,CAACC,GAAG,CAACC,oCAAoC,EAChD;QACE,GAAGe,YAAY;QACfD;MACF,CACF,CAAC;IACH,CAAC,CAAC,OAAOI,KAAK,EAAE;MACd,IAAAC,kBAAW,EACT,IAAIlB,aAAW,CAAC;QACdJ,OAAO,EAAE,6CAA6CiB,MAAM,GAAG;QAC/DE,IAAI,EAAE;UAAEF,MAAM;UAAEC,YAAY;UAAEG;QAAM;MACtC,CAAC,CACH,CAAC;MACD,MAAMA,KAAK;IACb;EACF;AACF,CAAC","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-server-engine",
-  "version": "1.10.11",
+  "version": "1.10.13",
   "description": "Framework used to develop backend services. This package ships with a lot of features to standardize the creation of services, letting you focus on the business logic.",
   "main": "dist/index.js",
   "scripts": {