@palmetto/pubsub 2.2.5 → 2.2.7

package/README.md

@@ -114,6 +114,10 @@ yarn add @palmetto/pubsub zod
 
 1. Register with dd-trace for improved trace logs
 
+   Datadog trace logs will include publisher and subscriber actions using the queue/job/exchange name.
+
+   ![alt text](dd-trace-sample.png)
+
    ```ts
    import tracer from "dd-trace";
    import { registerDdTrace } from "@palmetto/pubsub";

package/dist/bullmq/publisher.js

@@ -38,18 +38,23 @@ class BullMqPublisher {
     }
     publish(config, messages) {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
             const queue = yield this.getQueue(config);
-            yield Promise.all(messages.map((message) => __awaiter(this, void 0, void 0, function* () {
-                var _a, _b;
-                (_b = (_a = this.logger).debug) === null || _b === void 0 ? void 0 : _b.call(_a, `Publishing message to ${queue.name} - ${message}`);
-                yield queue.add(config.job || connection_js_1.BULLMQ_DEFAULTJOB, message, {
+            (_b = (_a = this.logger).debug) === null || _b === void 0 ? void 0 : _b.call(_a, `Publishing ${messages.length} messages to ${queue.name}`);
+            const job = {
+                name: config.job || connection_js_1.BULLMQ_DEFAULTJOB,
+                opts: {
                     attempts: config.retries,
                     backoff: {
                         type: "fixed",
                         delay: config.retryDelay || 30000,
                     },
-                });
-            })));
+                },
+            };
+            const jobs = messages.map((data) => {
+                return Object.assign(Object.assign({}, job), { data });
+            });
+            yield queue.addBulk(jobs);
         });
     }
     init(config) {

package/dist/bullmq/subscriber.js

@@ -14,7 +14,7 @@ const interfaces_js_1 = require("../interfaces.js");
 const connection_js_1 = require("./connection.js");
 const lazy_load_js_1 = require("../lazy-load.js");
 const create_log_error_payload_js_1 = require("../create-log-error-payload.js");
-const dd_trace_wrapper_js_1 = require("../dd-trace.wrapper.js");
+const dd_trace_api_1 = require("dd-trace-api");
 class SubscribedMessage {
     constructor(owner, worker, logger) {
         this.owner = owner;
@@ -65,7 +65,7 @@ class BullMqSubscriber {
                 context: "BullMqSubscriber",
             });
             const worker = new BullMqPackage.Worker(config.name, (job) => __awaiter(this, void 0, void 0, function* () {
-                return yield (0, dd_trace_wrapper_js_1.getTracer)().trace("pubsub.bullmq.handle", {
+                return yield dd_trace_api_1.tracer.trace("pubsub.bullmq.handle", {
                     resource: `handle ${config.name}`,
                 }, () => __awaiter(this, void 0, void 0, function* () {
                     const context = {

package/dist/main.d.ts

@@ -1,4 +1,3 @@
-export * from "./dd-trace.wrapper.js";
 export * from "./errors.js";
 export * from "./interfaces.js";
 export * from "./publisher.js";

package/dist/main.js

@@ -14,7 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./dd-trace.wrapper.js"), exports);
 __exportStar(require("./errors.js"), exports);
 __exportStar(require("./interfaces.js"), exports);
 __exportStar(require("./publisher.js"), exports);

package/dist/publisher.js

@@ -15,7 +15,7 @@ const uuid_1 = require("uuid");
 const crypto_1 = require("crypto");
 const errors_js_1 = require("./errors.js");
 const message_logger_js_1 = require("./message-logger.js");
-const dd_trace_wrapper_js_1 = require("./dd-trace.wrapper.js");
+const dd_trace_api_1 = require("dd-trace-api");
 class Publisher {
     constructor(logger, providers) {
         var _a, _b;
@@ -54,7 +54,10 @@ class Publisher {
     }
     publish(config, message) {
         const messages = Array.isArray(message) ? message : [message];
-        return (0, dd_trace_wrapper_js_1.getTracer)().trace("pubsub.publish", {
+        if (messages.length === 0) {
+            return Promise.resolve();
+        }
+        return dd_trace_api_1.tracer.trace("pubsub.publish", {
             resource: `publish ${config.transport} ${config.name}`,
         }, (span) => {
             return this.publishImpl(config, messages, span);
@@ -64,7 +67,7 @@ class Publisher {
         return __awaiter(this, void 0, void 0, function* () {
             const provider = this.getProvider(config);
             const { schema, schemaId } = this.assertSchema(config);
-            const jsons = messages.map((msg) => {
+            const mappedMessages = messages.map((msg) => {
                 if (!msg.id) {
                     msg.id = (0, uuid_1.v4)();
                 }
@@ -82,30 +85,38 @@ class Publisher {
                 if (!check.success) {
                     (0, message_logger_js_1.logMessage)({
                         note: "Publish message failed schema validation",
-                        message: messages,
+                        message: msg,
                         level: "error",
                         logger: this.logger,
                         extra: Object.assign({ transport: provider.transport, name: config.name }, provider.enrichPublishedMesssageLog(config)),
                     });
-                    throw new errors_js_1.SchemaValidationError(`Schema did not accept the published message: ${check.error.message}`);
+                    return { json: JSON.stringify(msg), error: check.error };
                 }
                 const json = JSON.stringify(check.data);
                 return { json, data: check.data };
             });
+            const errors = mappedMessages.filter((mm) => mm.error);
+            if (errors.length > 0) {
+                const errorMessage = errors.map((mm) => { var _a; return (_a = mm.error) === null || _a === void 0 ? void 0 : _a.message; }).join(", ");
+                throw new errors_js_1.SchemaValidationError(`Schema did not accept ${errors.length} of ${messages.length} message(s): ${errorMessage}`);
+            }
+            const jsons = mappedMessages.filter((j) => j.data).map((j) => j.json);
             const start = (0, message_logger_js_1.startTiming)();
-            yield provider.publish(config, jsons.map((j) => j.json));
+            yield provider.publish(config, jsons);
             const duration = (0, message_logger_js_1.getDuration)(start);
-            jsons.forEach((msg) => {
+            mappedMessages.forEach((msg) => {
                 (0, message_logger_js_1.logMessage)({
                     note: "Published message",
                     message: msg.data,
                     level: config.messageLogLevel,
                     logger: this.logger,
-                    extra: Object.assign({ transport: provider.transport, name: config.name, durationMs: duration }, provider.enrichPublishedMesssageLog(config)),
+                    extra: Object.assign({ transport: provider.transport, name: config.name, durationMs: duration, batchSize: messages.length }, provider.enrichPublishedMesssageLog(config)),
                 });
             });
-            span.setTag("pubsub.duration_ms", duration);
-            span.setTag("pubsub.message_count", messages.length);
+            if (span) {
+                span.setTag("pubsub.duration_ms", duration);
+                span.setTag("pubsub.message_count", messages.length);
+            }
         });
     }
     close() {

package/dist/rabbitmq/subscriber.js

@@ -15,7 +15,7 @@ const errors_js_1 = require("../errors.js");
 const config_js_1 = require("./config.js");
 const connection_js_1 = require("./connection.js");
 const create_log_error_payload_js_1 = require("../create-log-error-payload.js");
-const dd_trace_wrapper_js_1 = require("../dd-trace.wrapper.js");
+const dd_trace_api_1 = require("dd-trace-api");
 class SubscribedMessage {
     constructor(owner, logger, config, onMessage, stop) {
         this.owner = owner;
@@ -123,7 +123,7 @@ class RabbitMqSubscriber {
                 ? setupResult.dlQueueName
                 : setupResult.queueName;
             const onRabbitMessage = (msg) => __awaiter(this, void 0, void 0, function* () {
-                yield (0, dd_trace_wrapper_js_1.getTracer)().trace("pubsub.rabbit.consume", {
+                yield dd_trace_api_1.tracer.trace("pubsub.rabbit.consume", {
                     resource: `consume ${config.transport} ${queueName}`,
                 }, (span) => __awaiter(this, void 0, void 0, function* () {
                     try {
@@ -135,7 +135,7 @@ class RabbitMqSubscriber {
                             message: "Unexpected error handling RabbitMq message",
                             error: (0, create_log_error_payload_js_1.createLogErrorPayload)(err),
                         });
-                        span.setTag("error", err);
+                        span === null || span === void 0 ? void 0 : span.setTag("error", err);
                         try {
                             channel.nack(msg, undefined, true);
                         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@palmetto/pubsub",
-  "version": "2.2.5",
+  "version": "2.2.7",
   "main": "./dist/main.js",
   "scripts": {
     "lint": "yarn run -T eslint --fix ./src",
@@ -25,6 +25,7 @@
     "amqp-connection-manager": "^4.1.14",
     "amqplib": "^0.10.8",
     "bullmq": "^5.58.0",
+    "opentracing": "^0.14.7",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4",
@@ -41,6 +42,7 @@
     "access": "public"
   },
   "dependencies": {
+    "dd-trace-api": "^1.0.0",
     "uuid": "^11.1.0"
   },
   "peerDependencies": {

package/dist/dd-trace.wrapper.d.ts

@@ -1,75 +0,0 @@
-export interface Span {
-    /**
-     * Adds a single tag to the span.  See `addTags()` for details.
-     *
-     * @param {string} key
-     * @param {any} value
-     */
-    setTag(key: string, value: unknown): this;
-}
-interface SpanOptions {
-    /**
-     * set of key-value pairs which will be set as tags on the newly created
-     * Span. Ownership of the object is passed to the created span for
-     * efficiency reasons (the caller should not modify this object after
-     * calling startSpan).
-     */
-    tags?: {
-        [key: string]: unknown;
-    };
-}
-/**
- * The Datadog Scope Manager. This is used for context propagation.
- */
-interface Scope {
-    /**
-     * Get the current active span or null if there is none.
-     *
-     * @returns {Span} The active span.
-     */
-    active(): Span | null;
-}
-interface TraceOptions {
-    /**
-     * The resource you are tracing. The resource name must not be longer than
-     * 5000 characters.
-     */
-    resource?: string;
-    /**
-     * The type of request.
-     */
-    type?: string;
-}
-interface Tracer {
-    /**
-     * Instruments a function by automatically creating a span activated on its
-     * scope.
-     *
-     * The span will automatically be finished when one of these conditions is
-     * met:
-     *
-     * * The function returns a promise, in which case the span will finish when
-     * the promise is resolved or rejected.
-     * * The function takes a callback as its second parameter, in which case the
-     * span will finish when that callback is called.
-     * * The function doesn't accept a callback and doesn't return a promise, in
-     * which case the span will finish at the end of the function execution.
-     */
-    trace<T>(name: string, options: TraceOptions & SpanOptions, fn: (span: Span) => Promise<T>): Promise<T>;
-    /**
-     * Returns a reference to the current scope.
-     */
-    scope(): Scope;
-}
-export declare function getTracer(): Tracer;
-/**
- * Registers the dd-trace tracer instance to be used by the pubsub package.
- *
- * Usage:
- *   import trace from 'dd-trace';
- *   registerDdTrace(trace.init());
- *
- * @param tracer the tracer instance
- */
-export declare function registerDdTrace(tracer: unknown): void;
-export {};

package/dist/dd-trace.wrapper.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTracer = getTracer;
-exports.registerDdTrace = registerDdTrace;
-class NoOpSpan {
-    finish() {
-        // no-op
-    }
-    setTag(_key, _value) {
-        return this;
-    }
-}
-class NoOpScope {
-    active() {
-        return null;
-    }
-}
-class NoOpTracer {
-    constructor() {
-        this.noOpSpan = new NoOpSpan();
-        this.noOpScope = new NoOpScope();
-    }
-    trace(_name, _options, fn) {
-        return fn(this.noOpSpan);
-    }
-    scope() {
-        return this.noOpScope;
-    }
-}
-let tracerInstance = new NoOpTracer();
-function getTracer() {
-    return tracerInstance;
-}
-/**
- * Registers the dd-trace tracer instance to be used by the pubsub package.
- *
- * Usage:
- *   import trace from 'dd-trace';
- *   registerDdTrace(trace.init());
- *
- * @param tracer the tracer instance
- */
-function registerDdTrace(tracer) {
-    tracerInstance = tracer;
-}