@palmetto/pubsub 1.0.0 → 1.0.2

package/dist/bullmq/publisher.d.ts

@@ -9,5 +9,6 @@ export declare class BullMqPublisher implements PublisherProvider {
     readonly transport: string;
     private getQueue;
     publish(config: BullMqQueueConfiguration, message: string): Promise<void>;
+    init(config: BullMqQueueConfiguration): Promise<void>;
     close(): Promise<void>;
 }

package/dist/bullmq/publisher.js

@@ -50,6 +50,11 @@ class BullMqPublisher {
             });
         });
     }
+    init(config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.getQueue(config);
+        });
+    }
     close() {
         return __awaiter(this, void 0, void 0, function* () {
             for (const queue of this.queues.values()) {

package/dist/bullmq/pubsub.d.ts

@@ -9,4 +9,5 @@ export declare class BullMqPubSubProvider implements PubSubProvider {
     publish(config: BullMqQueueConfiguration, message: string): Promise<void>;
     startSubscribe(config: BullMqQueueConfiguration, onMessage: (s: string, context: MessageContext) => Promise<MessageResult> | MessageResult): Promise<StopSubscribe>;
     close(): Promise<void>;
+    init(config: BullMqQueueConfiguration): Promise<void>;
 }

package/dist/bullmq/pubsub.js

@@ -31,5 +31,10 @@ class BullMqPubSubProvider {
             yield this.publisher.close();
         });
     }
+    init(config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.publisher.init(config);
+        });
+    }
 }
 exports.BullMqPubSubProvider = BullMqPubSubProvider;

package/dist/interfaces.d.ts

@@ -22,6 +22,7 @@ export type BaseMessage = z4.infer<typeof IdMetaSchema>;
  */
 export interface PublisherProvider {
     transport: string;
+    init(config: PubSubConfiguration): Promise<void> | void;
     publish(config: PubSubConfiguration, message: string): Promise<void> | void;
     close(): Promise<void> | void;
 }

package/dist/publisher.d.ts

@@ -6,6 +6,9 @@ export declare class Publisher {
     constructor(logger: Logger, providers?: PublisherProvider[]);
     addProvider(provider: PublisherProvider): void;
     removeProvider(providerOrTransport: PublisherProvider | string): boolean;
+    init(config: PubSubConfiguration): Promise<void>;
     publish(config: PubSubConfiguration, message: BaseMessage): Promise<void>;
     close(): Promise<void>;
+    private getProvider;
+    private assertSchema;
 }

package/dist/publisher.js

@@ -40,39 +40,36 @@ class Publisher {
         (_b = (_a = this.logger).debug) === null || _b === void 0 ? void 0 : _b.call(_a, `Publisher removing provider for ${transport}`);
         return this.publisherProviders.delete(transport);
     }
+    init(config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.getProvider(config).init(config);
+            yield this.assertSchema(config);
+        });
+    }
     publish(config, message) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
-            const { transport, schema } = config;
-            const provider = this.publisherProviders.get(transport);
-            if (!provider) {
-                throw new errors_1.MissingPubSubProviderError(`No provider configured for ${transport}`);
-            }
+            const provider = this.getProvider(config);
             if (!message.id) {
                 message.id = (0, uuid_1.v4)();
             }
-            let hash = this.hashes.get(schema);
-            if (!hash) {
-                const jsonSchema = JSON.stringify(v4_1.z.toJSONSchema(schema), null, 3);
-                hash = yield (0, crypto_hash_1.sha256)(jsonSchema);
-                this.hashes.set(schema, hash);
-            }
+            const { schema, schemaId } = yield this.assertSchema(config);
             if (!message.meta) {
                 message.meta = {
                     createdAt: new Date().toISOString(),
                     publishedBy: "",
-                    schemaId: hash,
+                    schemaId: schemaId,
                 };
             }
             else {
-                message.meta.schemaId = hash;
+                message.meta.schemaId = schemaId;
             }
             const json = JSON.stringify(message);
             const check = schema.safeParse(JSON.parse(json));
             if (!check.success) {
                 throw new errors_1.SchemaValidationError(`Schema did not accept the published message: ${check.error.message}`);
             }
-            (_b = (_a = this.logger).debug) === null || _b === void 0 ? void 0 : _b.call(_a, `Publisher publishing message for ${transport}`);
+            (_b = (_a = this.logger).debug) === null || _b === void 0 ? void 0 : _b.call(_a, `Publisher publishing message for ${provider.transport}`);
             yield provider.publish(config, json);
         });
     }
@@ -83,5 +80,28 @@ class Publisher {
             }
         });
     }
+    getProvider(config) {
+        const { transport } = config;
+        const provider = this.publisherProviders.get(transport);
+        if (!provider) {
+            throw new errors_1.MissingPubSubProviderError(`No provider configured for ${transport}`);
+        }
+        return provider;
+    }
+    assertSchema(config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { schema } = config;
+            let hash = this.hashes.get(schema);
+            if (!hash) {
+                const jsonSchema = JSON.stringify(v4_1.z.toJSONSchema(schema), null, 3);
+                hash = yield (0, crypto_hash_1.sha256)(jsonSchema);
+                this.hashes.set(schema, hash);
+            }
+            return {
+                schema,
+                schemaId: hash,
+            };
+        });
+    }
 }
 exports.Publisher = Publisher;

package/dist/rabbitmq/connection.d.ts

@@ -18,6 +18,7 @@ export declare class RabbitMqConnection {
     static create(config: RabbitMqConnectionConfig, logger: Logger): Promise<RabbitMqConnection>;
     private constructor();
     close(): Promise<void>;
+    isConnected(): boolean;
     /**
      * Creates the exchanges necessary for the given config
      * @param channel

package/dist/rabbitmq/connection.js

@@ -46,6 +46,9 @@ class RabbitMqConnection {
             yield this.connection.close();
         });
     }
+    isConnected() {
+        return this.connection.isConnected();
+    }
     /**
      * Creates the exchanges necessary for the given config
      * @param channel

package/dist/rabbitmq/publisher.d.ts

@@ -1,4 +1,3 @@
-import type { ChannelWrapper } from "amqp-connection-manager";
 import { Logger, PublisherProvider } from "../interfaces";
 import { RabbitMqConnection } from "./connection";
 import { RabbitQueueExchangeConfiguration } from "./config";
@@ -10,13 +9,14 @@ export declare class RabbitMqPublisher implements PublisherProvider {
     private connected;
     constructor(connection: RabbitMqConnection, logger: Logger);
     readonly transport: string;
+    init(config: RabbitQueueExchangeConfiguration): Promise<void>;
     /**
      * Initializes the rabbit connection and asserts the exchange for the configuration.
      *
      * @param config
      * @returns a Promise containing the ChannelWrapper to publish messages with
      */
-    init(config: RabbitQueueExchangeConfiguration): Promise<ChannelWrapper>;
+    private getChannel;
     /**
      * Publishes a message to Rabbit based on the configuration
      *

package/dist/rabbitmq/publisher.js

@@ -22,13 +22,18 @@ class RabbitMqPublisher {
         this.connected = false;
         this.transport = connection_1.RABBITMQ_TRANSPORT;
     }
+    init(config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.getChannel(config);
+        });
+    }
     /**
      * Initializes the rabbit connection and asserts the exchange for the configuration.
      *
      * @param config
      * @returns a Promise containing the ChannelWrapper to publish messages with
      */
-    init(config) {
+    getChannel(config) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             const delayMs = this.connection.config.startupRetryDelayMs || 500;
@@ -76,7 +81,7 @@ class RabbitMqPublisher {
     publish(config, message) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
-            const channel = yield this.init(config);
+            const channel = yield this.getChannel(config);
             (_b = (_a = this.logger).debug) === null || _b === void 0 ? void 0 : _b.call(_a, `Publishing message to ${(0, config_1.getExchangeName)(config)} - ${message} [starting]`);
             const exchangeName = (0, config_1.getExchangeName)(config);
             const ok = yield channel.publish(exchangeName, (0, config_1.getRoutingKey)(config), Buffer.from(message, "utf8"), {

package/dist/rabbitmq/pubsub.d.ts

@@ -12,4 +12,5 @@ export declare class RabbitMqPubSubProvider implements PubSubProvider {
     publish(config: RabbitQueueExchangeConfiguration, message: string): Promise<void>;
     startSubscribe(config: RabbitQueueExchangeConfiguration, onMessage: (s: string, context: MessageContext) => Promise<MessageResult> | MessageResult): StopSubscribe;
     close(): Promise<void>;
+    init(config: RabbitQueueExchangeConfiguration): Promise<void>;
 }

package/dist/rabbitmq/pubsub.js

@@ -33,5 +33,10 @@ class RabbitMqPubSubProvider {
             yield Promise.all([this.subscriber.close(), this.publisher.close()]);
         });
     }
+    init(config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.publisher.init(config);
+        });
+    }
 }
 exports.RabbitMqPubSubProvider = RabbitMqPubSubProvider;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@palmetto/pubsub",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "main": "./dist/main.js",
   "scripts": {
     "lint": "yarn run -T eslint --fix ./src",
@@ -15,10 +15,9 @@
     "hook:format": "prettier --write --loglevel warn",
     "hook:tc": "yarn tc",
     "prepublishOnly": "yarn build",
-    "test": "vitest run",
-    "test:watch": "vitest watch",
-    "redis-up": "docker compose -f redis-compose.yml up -d",
-    "rabbitmq-up": "docker compose -f rabbitmq-compose.yml up -d"
+    "test-runner": "../../scripts/test-runner.sh",
+    "test": "yarn run test-runner vitest run",
+    "test:watch": "yarn run test-runner vitest watch"
   },
   "devDependencies": {
     "@types/amqplib": "^0",

package/src/rabbitmq/README.md

@@ -52,7 +52,15 @@ yarn add @palmetto/pubsub amqp-connection-manager amqplib zod
    };
    ```
 
-6. Publish a message
+6. Initialize the publisher
+
+   For performance reasons, it's a good idea to initialize the publisher on your API startup. This can reduce the latency for the first message published.
+
+   ```ts
+   await publisher.init(config);
+   ```
+
+7. Publish a message
 
    ```ts
    const message: MyModel = {... };
@@ -60,7 +68,7 @@ yarn add @palmetto/pubsub amqp-connection-manager amqplib zod
    await publisher.publish(config, message);
    ```
 
-7. Subscribe to a queue
+8. Subscribe to a queue
 
    ```ts
    subscriber.addSubscriber(queue, (message: MyModel, context: RabbitMqMessageContext) => {
@@ -69,7 +77,7 @@ yarn add @palmetto/pubsub amqp-connection-manager amqplib zod
    });
    ```
 
-8. Subscribe to the dead-letter queue if you want to re-process completely failed messages. Set the `queueType` to `"dead-letter"`
+9. Subscribe to the dead-letter queue if you want to re-process completely failed messages. Set the `queueType` to `"dead-letter"`
 
    ```ts
    const dlQueue = {