@haathie/pgmb 0.2.11 → 0.2.12

package/README.md

@@ -422,7 +422,10 @@ const pgmb = new PgmbClient({
 		headers: {
 			// add a custom user-agent header
 			'user-agent': 'my-service-client/1.0.0'
-		}
+		},
+		// if payload is larger than 1KB, will be sent as a gzipped body
+		// with content-encoding: gzip header
+		minCompressSizeBytes: 1024,
 	},
 	// this function is called to obtain webhook URLs
 	// for a given set of PGMB subscription IDs. These

package/lib/types.d.ts

@@ -34,6 +34,19 @@ export type PgmbWebhookOpts<T extends IEventData> = {
     splitBy?: ISplitFn<T>;
     jsonifier?: JSONifier;
     serialiseEvent?(ev: IReadEvent, logger: Logger): SerialisedEvent;
+    /**
+     * Minimum size in bytes for the payload to be compressed.
+     * @default 1024
+     */
+    minCompressSizeBytes?: number;
+    /**
+     * Compress the webhook payload before sending.
+     * By default, uses gzip compression via the `zlib` library.
+     */
+    compress?(data: Uint8Array | string): Promise<{
+        data: Uint8Array | string;
+        contentEncoding: string;
+    }>;
 };
 export interface IEventData {
     topic: string;

package/lib/webhook-handler.d.ts

@@ -3,4 +3,4 @@ import type { IEventData, IEventHandler, PgmbWebhookOpts } from './types.ts';
  * Create a handler that sends events to a webhook URL via HTTP POST.
  * @param url Where to send the webhook requests
  */
-export declare function createWebhookHandler<T extends IEventData>({ timeoutMs, headers, retryOpts, jsonifier, serialiseEvent }: Partial<PgmbWebhookOpts<T>>): IEventHandler;
+export declare function createWebhookHandler<T extends IEventData>({ timeoutMs, headers, retryOpts, jsonifier, serialiseEvent, minCompressSizeBytes, compress }: Partial<PgmbWebhookOpts<T>>): IEventHandler;

package/lib/webhook-handler.js

@@ -1,6 +1,10 @@
 import assert from 'node:assert';
 import { createHash } from 'node:crypto';
+import { promisify } from 'node:util';
+import { gzip } from 'node:zlib';
 import { createRetryHandler } from "./retry-handler.js";
+import { getEnvNumber } from "./utils.js";
+const gzipPromise = promisify(gzip);
 /**
  * Create a handler that sends events to a webhook URL via HTTP POST.
  * @param url Where to send the webhook requests
@@ -8,7 +12,7 @@ import { createRetryHandler } from "./retry-handler.js";
 export function createWebhookHandler({ timeoutMs = 5_000, headers, retryOpts = {
     // retry after 5 minutes, then after 30 minutes
     retriesS: [5 * 60, 30 * 60]
-}, jsonifier = JSON, serialiseEvent = createSimpleSerialiser(jsonifier) }) {
+}, jsonifier = JSON, serialiseEvent = createSimpleSerialiser(jsonifier), minCompressSizeBytes = getEnvNumber('PGMB_WEBHOOK_MIN_COMPRESS_SIZE_BYTES', 1024), compress = gzipCompress }) {
     const handler = async (ev, { logger, extra }) => {
         assert(typeof extra === 'object'
             && extra !== null
@@ -19,14 +23,18 @@ export function createWebhookHandler({ timeoutMs = 5_000, headers, retryOpts = {
         const idempotencyKey = getIdempotencyKeyHeader(ev);
         logger = logger.child({ idempotencyKey });
         const { body, contentType } = serialiseEvent(ev, logger);
+        const { data: compBody, contentEncoding } = body.length >= minCompressSizeBytes
+            ? await compress(body)
+            : { data: body };
         const { status, statusText, body: res } = await fetch(url, {
             method: 'POST',
             headers: {
                 'content-type': contentType,
                 'idempotency-key': idempotencyKey,
+                ...(contentEncoding ? { 'content-encoding': contentEncoding } : {}),
                 ...headers
             },
-            body,
+            body: compBody,
             redirect: 'manual',
             signal: AbortSignal.timeout(timeoutMs)
         });
@@ -63,3 +71,9 @@ function createSimpleSerialiser(jsonifier) {
         contentType: 'application/json'
     });
 }
+async function gzipCompress(data) {
+    return {
+        data: await gzipPromise(data),
+        contentEncoding: 'gzip'
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haathie/pgmb",
-  "version": "0.2.11",
+  "version": "0.2.12",
   "description": "PG message broker, with a type-safe typescript client with built-in webhook & SSE support.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org",