@palmetto/pubsub 2.2.0 → 2.2.1

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

@@ -1,9 +1,60 @@
 interface Span {
+    /**
+     * Sets the end timestamp and finalizes Span state.
+     *
+     * With the exception of calls to Span.context() (which are always allowed),
+     * finish() must be the last call made to any span instance, and to do
+     * otherwise leads to undefined behavior.
+     */
     finish(): void;
+    /**
+     * 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 {
+    /**
+     * a parent SpanContext (or Span, for convenience) that the newly-started
+     * span will be the child of (per REFERENCE_CHILD_OF). If specified,
+     * `references` must be unspecified.
+     */
+    childOf: Span | null;
+    /**
+     * 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 Tracer {
-    startSpan(name: string): Span;
+    /**
+     * Starts and returns a new Span representing a logical unit of work.
+     * @param {string} name The name of the operation.
+     * @param {SpanOptions} [options] Options for the newly created span.
+     * @returns {Span} A new Span object.
+     */
+    startSpan(name: string, options: SpanOptions): Span;
+    /**
+     * Returns a reference to the current scope.
+     */
+    scope(): Scope;
 }
 export declare function getTracer(): Tracer;
 export declare function registerDdTrace(tracer: Tracer): void;

package/dist/dd-trace.wrapper.js

@@ -10,12 +10,21 @@ class NoOpSpan {
         return this;
     }
 }
+class NoOpScope {
+    active() {
+        return null;
+    }
+}
 class NoOpTracer {
     constructor() {
-        this.span = new NoOpSpan();
+        this.noOpSpan = new NoOpSpan();
+        this.noOpScope = new NoOpScope();
+    }
+    startSpan(_name, _options) {
+        return this.noOpSpan;
     }
-    startSpan(_name) {
-        return this.span;
+    scope() {
+        return this.noOpScope;
     }
 }
 let tracerInstance = new NoOpTracer();

package/dist/publisher.js

@@ -54,10 +54,14 @@ class Publisher {
     }
     publish(config, message) {
         return __awaiter(this, void 0, void 0, function* () {
-            const span = (0, dd_trace_wrapper_js_1.getTracer)()
-                .startSpan("Publisher.publish")
-                .setTag("pubsub.transport", config.transport)
-                .setTag("pubsub.name", config.name);
+            const tracer = (0, dd_trace_wrapper_js_1.getTracer)();
+            const span = tracer.startSpan("pubsub.publish", {
+                childOf: tracer.scope().active(),
+                tags: {
+                    "pubsub.transport": config.transport,
+                    "pubsub.name": config.name,
+                },
+            });
             try {
                 const provider = this.getProvider(config);
                 const { schema, schemaId } = this.assertSchema(config);

package/dist/subscriber.js

@@ -57,10 +57,14 @@ class Subscriber {
                 throw new errors_js_1.MissingPubSubProviderError(`No provider configured for ${config.transport}`);
             }
             const transform = (jsonStr, context) => __awaiter(this, void 0, void 0, function* () {
-                const span = (0, dd_trace_wrapper_js_1.getTracer)()
-                    .startSpan("Subscriber.handleMessage")
-                    .setTag("pubsub.transport", config.transport)
-                    .setTag("pubsub.name", config.name);
+                const tracer = (0, dd_trace_wrapper_js_1.getTracer)();
+                const span = tracer.startSpan("pubsub.handleMessage", {
+                    childOf: tracer.scope().active(),
+                    tags: {
+                        "pubsub.transport": config.transport,
+                        "pubsub.name": config.name,
+                    },
+                });
                 const start = (0, message_logger_js_1.startTiming)();
                 const jsonObject = JSON.parse(jsonStr);
                 const r = schema.safeDecode(jsonObject);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@palmetto/pubsub",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "main": "./dist/main.js",
   "scripts": {
     "lint": "yarn run -T eslint --fix ./src",