@superblocksteam/shared 0.9130.0 → 0.9132.0

package/dist/socket/tracedSocket.d.ts

@@ -0,0 +1,43 @@
+import { Tracer } from '@opentelemetry/api';
+import WebSocket from 'isomorphic-ws';
+import { ISocket, SocketError, SocketMessage } from './socket';
+import { GenericMiddleware, ISocketClient, MethodHandler, MethodHandlers, RequestContextBase, SocketTimeouts } from './types';
+export declare class TracedSocket<ImplementedMethods, CallableMethods, RequestContext extends RequestContextBase> extends ISocket<ImplementedMethods, CallableMethods, RequestContext> {
+    /**
+     * The TracedSocket class extends the ISocket class to add tracing capabilities for each connection. It manages
+     * spans for handler calls to provide detailed tracing information.
+     *
+     * Unlike Express, the ISocket handler call chain is fully recursive. This recursion makes it challenging to determine
+     * when to create and end spans for specific handlers, as handlers may call other handlers before returning a result.
+     *
+     * An example span for recursive call
+     * Main span ----------------------------------------------------------------------------------
+     * Handler1     ----------------------------------------------------------------------------
+     * Handler2           ----------------------------------------------------------------------
+     *
+     * To manage this, we keep a reference to the most recently created span and complete that span when we go one step deeper into the recursion.
+     * This approach works for now since we don't support much parallelism, but it will need to be updated when we start handling requests concurrently.
+     *
+     * An example span for recursive call after the above fixes
+     * Main span ----------------------------------------------------------------------------------
+     * Handler1     -----------------------------
+     * Handler2                                  ------------------------------------------------
+     *
+     */
+    private activeSpanByRequestId;
+    private middlewareSpanByReqId;
+    private lastActiveSpan;
+    private tracer;
+    constructor(ws: WebSocket, requestHandlers: MethodHandlers<ImplementedMethods, CallableMethods, RequestContext>, globalMiddlewares: GenericMiddleware<CallableMethods, RequestContext>[], tracer: Tracer, timeouts?: SocketTimeouts, logger?: {
+        error: (message?: string) => void;
+    });
+    protected callHandler<Params, Result, CallableMethods, RequestContext extends RequestContextBase>(handler: MethodHandler<Params, Result, CallableMethods, RequestContext>, params: Params, ctx: RequestContext, client: ISocketClient<CallableMethods>, next: () => Promise<Result>): Promise<Result>;
+    protected handleMessage(message: SocketMessage): Promise<void>;
+    request<Params, Result>(method: string, params: Params, authorization?: string): Promise<Result>;
+    protected decorateToSend(message: SocketMessage): SocketMessage;
+    protected respond<Result>(requestId: number, result: Result): void;
+    protected respondError(requestId: number, error: SocketError, exception?: Error): void;
+    private addEvent;
+    close(): void;
+}
+//# sourceMappingURL=tracedSocket.d.ts.map

package/dist/socket/tracedSocket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracedSocket.d.ts","sourceRoot":"","sources":["../../src/socket/tracedSocket.ts"],"names":[],"mappings":"AAAA,OAAO,EASL,MAAM,EAEP,MAAM,oBAAoB,CAAC;AAE5B,OAAO,SAAS,MAAM,eAAe,CAAC;AAUtC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAmC9H,qBAAa,YAAY,CAAC,kBAAkB,EAAE,eAAe,EAAE,cAAc,SAAS,kBAAkB,CAAE,SAAQ,OAAO,CACvH,kBAAkB,EAClB,eAAe,EACf,cAAc,CACf;IACC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,OAAO,CAAC,qBAAqB,CAA2B;IACxD,OAAO,CAAC,qBAAqB,CAA2B;IACxD,OAAO,CAAC,cAAc,CAAmB;IACzC,OAAO,CAAC,MAAM,CAAS;gBAGrB,EAAE,EAAE,SAAS,EACb,eAAe,EAAE,cAAc,CAAC,kBAAkB,EAAE,eAAe,EAAE,cAAc,CAAC,EACpF,iBAAiB,EAAE,iBAAiB,CAAC,eAAe,EAAE,cAAc,CAAC,EAAE,EACvE,MAAM,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,cAAc,EACzB,MAAM,CAAC,EAAE;QAAE,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;KAAE;cAMhC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,cAAc,SAAS,kBAAkB,EACpG,OAAO,EAAE,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,cAAc,CAAC,EACvE,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,cAAc,EACnB,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,EACtC,IAAI,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,GAC1B,OAAO,CAAC,MAAM,CAAC;cAkCF,aAAa,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAqC7D,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAKvG,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,aAAa,GAAG,aAAa;IAK/D,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAKlE,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,CAAC,EAAE,KAAK,GAAG,IAAI;IAStF,OAAO,CAAC,QAAQ;IAQT,KAAK,IAAI,IAAI;CAQrB"}

package/dist/socket/tracedSocket.js

@@ -0,0 +1,163 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TracedSocket = void 0;
+const api_1 = require("@opentelemetry/api");
+const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
+const observability_1 = require("../observability");
+const socket_1 = require("./socket");
+function isPromise(obj) {
+    return obj !== null && typeof obj === 'object' && typeof obj.then === 'function';
+}
+// Taken from https://github.com/gadget-inc/opentelemetry-instrumentations/blob/main/packages/opentelemetry-instrumentation-ws/src/index.ts#L21
+const endSpan = (traced, span) => {
+    try {
+        const result = traced();
+        if (isPromise(result)) {
+            return Promise.resolve(result)
+                .catch((err) => {
+                setHttpStatusFromError(span, typeof err === 'string' ? new Error(err) : err);
+                throw err;
+            })
+                .finally(() => span.end());
+        }
+        else {
+            span.end();
+            return result;
+        }
+    }
+    catch (error) {
+        setHttpStatusFromError(span, error);
+        span.end();
+        throw error;
+    }
+};
+function setHttpStatusFromError(span, error) {
+    // Simplified error handling without server-side dependencies
+    span.setAttribute(observability_1.OBS_TAG_HTTP_STATUS_CODE, 500);
+    span.recordException(error);
+    span.setStatus({ code: api_1.SpanStatusCode.ERROR, message: error.message });
+}
+class TracedSocket extends socket_1.ISocket {
+    constructor(ws, requestHandlers, globalMiddlewares, tracer, timeouts, logger) {
+        super(ws, requestHandlers, globalMiddlewares, timeouts, logger);
+        /**
+         * The TracedSocket class extends the ISocket class to add tracing capabilities for each connection. It manages
+         * spans for handler calls to provide detailed tracing information.
+         *
+         * Unlike Express, the ISocket handler call chain is fully recursive. This recursion makes it challenging to determine
+         * when to create and end spans for specific handlers, as handlers may call other handlers before returning a result.
+         *
+         * An example span for recursive call
+         * Main span ----------------------------------------------------------------------------------
+         * Handler1     ----------------------------------------------------------------------------
+         * Handler2           ----------------------------------------------------------------------
+         *
+         * To manage this, we keep a reference to the most recently created span and complete that span when we go one step deeper into the recursion.
+         * This approach works for now since we don't support much parallelism, but it will need to be updated when we start handling requests concurrently.
+         *
+         * An example span for recursive call after the above fixes
+         * Main span ----------------------------------------------------------------------------------
+         * Handler1     -----------------------------
+         * Handler2                                  ------------------------------------------------
+         *
+         */
+        this.activeSpanByRequestId = new Map();
+        this.middlewareSpanByReqId = new Map();
+        this.tracer = tracer;
+    }
+    async callHandler(handler, params, ctx, client, next) {
+        let currentContext = api_1.context.active();
+        const middleWareSpan = this.middlewareSpanByReqId.get(ctx.requestId);
+        const activeSpan = this.activeSpanByRequestId.get(ctx.requestId);
+        // We need to end the middleware span since callHandler is called recursively
+        // Otherwise spans will be nested which is not representing actual time taken to execute a middleware
+        // Since we are ending the span here, it won't capture error state of nested handlers
+        if (middleWareSpan) {
+            middleWareSpan.end();
+            if (activeSpan) {
+                currentContext = api_1.trace.setSpan(api_1.context.active(), activeSpan);
+            }
+        }
+        let result;
+        await api_1.context.with(currentContext, async () => {
+            await this.tracer.startActiveSpan(`WS HANDLER ${handler.name === '' ? ctx.method : handler.name}`, {
+                attributes: {
+                    [semantic_conventions_1.SEMATTRS_MESSAGING_SYSTEM]: 'ws',
+                    [semantic_conventions_1.SEMATTRS_MESSAGING_DESTINATION_KIND]: 'websocket'
+                },
+                kind: api_1.SpanKind.SERVER
+            }, async (span) => {
+                this.middlewareSpanByReqId.set(ctx.requestId, span);
+                result = await endSpan(() => super.callHandler(handler, params, ctx, client, next), span);
+                this.middlewareSpanByReqId.delete(ctx.requestId);
+            });
+        });
+        return result;
+    }
+    async handleMessage(message) {
+        if (message.request) {
+            const spanName = message.request.method;
+            const requestId = message.request.id;
+            const payload = message.request.payload;
+            await api_1.context.with(api_1.propagation.extract(api_1.ROOT_CONTEXT, message.request), async () => await this.tracer.startActiveSpan(`WS SERVER ${spanName}`, {
+                attributes: {
+                    [semantic_conventions_1.SEMATTRS_MESSAGING_SYSTEM]: 'ws',
+                    [semantic_conventions_1.SEMATTRS_MESSAGING_DESTINATION_KIND]: 'websocket',
+                    [observability_1.OBS_TAG_HTTP_ROUTE]: spanName,
+                    [observability_1.OBS_TAG_APPLICATION_ID]: payload?.['applicationId'],
+                    [observability_1.OBS_TAG_API_ID]: payload?.['apiId'],
+                    [observability_1.OBS_TAG_BRANCH]: payload?.['branch'] ?? payload?.['branchName'],
+                    [observability_1.OBS_TAG_COMMIT_ID]: payload?.['commitId']
+                },
+                kind: api_1.SpanKind.SERVER
+            }, async (span) => {
+                this.lastActiveSpan = span;
+                this.activeSpanByRequestId.set(requestId, span);
+                const result = await endSpan(() => super.handleMessage(message), span);
+                this.activeSpanByRequestId.delete(requestId);
+                return result;
+            }));
+        }
+        else if (message.response) {
+            this.addEvent('ws.received-response', { ['ws.response.id']: message.response.id });
+            return await super.handleMessage(message);
+        }
+    }
+    request(method, params, authorization) {
+        this.addEvent('ws.send-request', { ['ws.request.method']: method, ['ws.request.id']: this.nxtRequestId });
+        return super.request(method, params, authorization);
+    }
+    decorateToSend(message) {
+        api_1.propagation.inject(api_1.context.active(), message.request);
+        return message;
+    }
+    respond(requestId, result) {
+        this.addEvent('ws.send-response', { ['ws.response.id']: requestId });
+        return super.respond(requestId, result);
+    }
+    respondError(requestId, error, exception) {
+        this.addEvent('ws.send-error', { ['ws.response.id']: requestId });
+        if (this.lastActiveSpan) {
+            setHttpStatusFromError(this.lastActiveSpan, exception ?? new Error(error.message));
+            this.lastActiveSpan.setAttribute(observability_1.OBS_SOCKET_STATUS_CODE, error.code);
+        }
+        return super.respondError(requestId, error, exception);
+    }
+    addEvent(eventName, attributes) {
+        // Since we do not have parent requestId in all the methods, we are assuming latest created span is the only active span
+        // This assumption can be broken if we start sending multiple request through the same connection.
+        if (this.lastActiveSpan) {
+            this.lastActiveSpan.addEvent(eventName, attributes, new Date());
+        }
+    }
+    close() {
+        for (const span of this.activeSpanByRequestId.values()) {
+            span.end();
+        }
+        this.activeSpanByRequestId = new Map();
+        this.lastActiveSpan = undefined;
+        super.close();
+    }
+}
+exports.TracedSocket = TracedSocket;
+//# sourceMappingURL=tracedSocket.js.map

package/dist/socket/tracedSocket.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracedSocket.js","sourceRoot":"","sources":["../../src/socket/tracedSocket.ts"],"names":[],"mappings":";;;AAAA,4CAW4B;AAC5B,8EAAqH;AAErH,oDAQ0B;AAC1B,qCAA+D;AAG/D,SAAS,SAAS,CAAC,GAAY;IAC7B,OAAO,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAQ,GAAwB,CAAC,IAAI,KAAK,UAAU,CAAC;AACzG,CAAC;AAED,+IAA+I;AAC/I,MAAM,OAAO,GAAG,CAAC,MAAwC,EAAE,IAAU,EAAE,EAAE;IACvE,IAAI;QACF,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC;QACxB,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE;YACrB,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;iBAC3B,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACb,sBAAsB,CAAC,IAAI,EAAE,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;gBAC7E,MAAM,GAAG,CAAC;YACZ,CAAC,CAAC;iBACD,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;SAC9B;aAAM;YACL,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,OAAO,MAAM,CAAC;SACf;KACF;IAAC,OAAO,KAAK,EAAE;QACd,sBAAsB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,GAAG,EAAE,CAAC;QACX,MAAM,KAAK,CAAC;KACb;AACH,CAAC,CAAC;AAEF,SAAS,sBAAsB,CAAC,IAAU,EAAE,KAAY;IACtD,6DAA6D;IAC7D,IAAI,CAAC,YAAY,CAAC,wCAAwB,EAAE,GAAG,CAAC,CAAC;IACjD,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IAC5B,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,oBAAc,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;AACzE,CAAC;AAED,MAAa,YAA6F,SAAQ,gBAIjH;IA2BC,YACE,EAAa,EACb,eAAoF,EACpF,iBAAuE,EACvE,MAAc,EACd,QAAyB,EACzB,MAA8C;QAE9C,KAAK,CAAC,EAAE,EAAE,eAAe,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAlClE;;;;;;;;;;;;;;;;;;;;WAoBG;QACK,0BAAqB,GAAG,IAAI,GAAG,EAAgB,CAAC;QAChD,0BAAqB,GAAG,IAAI,GAAG,EAAgB,CAAC;QAatD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAES,KAAK,CAAC,WAAW,CACzB,OAAuE,EACvE,MAAc,EACd,GAAmB,EACnB,MAAsC,EACtC,IAA2B;QAE3B,IAAI,cAAc,GAAG,aAAO,CAAC,MAAM,EAAE,CAAC;QACtC,MAAM,cAAc,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACrE,MAAM,UAAU,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACjE,6EAA6E;QAC7E,qGAAqG;QACrG,qFAAqF;QACrF,IAAI,cAAc,EAAE;YAClB,cAAc,CAAC,GAAG,EAAE,CAAC;YACrB,IAAI,UAAU,EAAE;gBACd,cAAc,GAAG,WAAK,CAAC,OAAO,CAAC,aAAO,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC;aAC9D;SACF;QACD,IAAI,MAAM,CAAC;QACX,MAAM,aAAO,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE;YAC5C,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAC/B,cAAc,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAC/D;gBACE,UAAU,EAAE;oBACV,CAAC,gDAAyB,CAAC,EAAE,IAAI;oBACjC,CAAC,0DAAmC,CAAC,EAAE,WAAW;iBACnD;gBACD,IAAI,EAAE,cAAQ,CAAC,MAAM;aACtB,EACD,KAAK,EAAE,IAAU,EAAE,EAAE;gBACnB,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;gBACpD,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;gBAC1F,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACnD,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,OAAO,MAAgB,CAAC;IAC1B,CAAC;IAES,KAAK,CAAC,aAAa,CAAC,OAAsB;QAClD,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;YACxC,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;YACxC,MAAM,aAAO,CAAC,IAAI,CAChB,iBAAW,CAAC,OAAO,CAAC,kBAAY,EAAE,OAAO,CAAC,OAAO,CAAC,EAClD,KAAK,IAAI,EAAE,CACT,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAC/B,aAAa,QAAQ,EAAE,EACvB;gBACE,UAAU,EAAE;oBACV,CAAC,gDAAyB,CAAC,EAAE,IAAI;oBACjC,CAAC,0DAAmC,CAAC,EAAE,WAAW;oBAClD,CAAC,kCAAkB,CAAC,EAAE,QAAQ;oBAC9B,CAAC,sCAAsB,CAAC,EAAE,OAAO,EAAE,CAAC,eAAe,CAAC;oBACpD,CAAC,8BAAc,CAAC,EAAE,OAAO,EAAE,CAAC,OAAO,CAAC;oBACpC,CAAC,8BAAc,CAAC,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,IAAI,OAAO,EAAE,CAAC,YAAY,CAAC;oBAChE,CAAC,iCAAiB,CAAC,EAAE,OAAO,EAAE,CAAC,UAAU,CAAC;iBAC3C;gBACD,IAAI,EAAE,cAAQ,CAAC,MAAM;aACtB,EACD,KAAK,EAAE,IAAU,EAAE,EAAE;gBACnB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;gBAC3B,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;gBAChD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC;gBACvE,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC7C,OAAO,MAAM,CAAC;YAChB,CAAC,CACF,CACJ,CAAC;SACH;aAAM,IAAI,OAAO,CAAC,QAAQ,EAAE;YAC3B,IAAI,CAAC,QAAQ,CAAC,sBAAsB,EAAE,EAAE,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;YACnF,OAAO,MAAM,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;SAC3C;IACH,CAAC;IAEM,OAAO,CAAiB,MAAc,EAAE,MAAc,EAAE,aAAsB;QACnF,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,EAAE,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QAC1G,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IACtD,CAAC;IAES,cAAc,CAAC,OAAsB;QAC7C,iBAAW,CAAC,MAAM,CAAC,aAAO,CAAC,MAAM,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACtD,OAAO,OAAO,CAAC;IACjB,CAAC;IAES,OAAO,CAAS,SAAiB,EAAE,MAAc;QACzD,IAAI,CAAC,QAAQ,CAAC,kBAAkB,EAAE,EAAE,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACrE,OAAO,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAC1C,CAAC;IAES,YAAY,CAAC,SAAiB,EAAE,KAAkB,EAAE,SAAiB;QAC7E,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,EAAE,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QAClE,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,sBAAsB,CAAC,IAAI,CAAC,cAAc,EAAE,SAAS,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;YACnF,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,sCAAsB,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;SACtE;QACD,OAAO,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;IACzD,CAAC;IAEO,QAAQ,CAAC,SAAiB,EAAE,UAAkC;QACpE,wHAAwH;QACxH,kGAAkG;QAClG,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;SACjE;IACH,CAAC;IAEM,KAAK;QACV,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,EAAE;YACtD,IAAI,CAAC,GAAG,EAAE,CAAC;SACZ;QACD,IAAI,CAAC,qBAAqB,GAAG,IAAI,GAAG,EAAE,CAAC;QACvC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,KAAK,CAAC,KAAK,EAAE,CAAC;IAChB,CAAC;CACF;AAhKD,oCAgKC"}

package/dist-esm/socket/tracedSocket.d.ts

@@ -0,0 +1,43 @@
+import { Tracer } from '@opentelemetry/api';
+import WebSocket from 'isomorphic-ws';
+import { ISocket, SocketError, SocketMessage } from './socket';
+import { GenericMiddleware, ISocketClient, MethodHandler, MethodHandlers, RequestContextBase, SocketTimeouts } from './types';
+export declare class TracedSocket<ImplementedMethods, CallableMethods, RequestContext extends RequestContextBase> extends ISocket<ImplementedMethods, CallableMethods, RequestContext> {
+    /**
+     * The TracedSocket class extends the ISocket class to add tracing capabilities for each connection. It manages
+     * spans for handler calls to provide detailed tracing information.
+     *
+     * Unlike Express, the ISocket handler call chain is fully recursive. This recursion makes it challenging to determine
+     * when to create and end spans for specific handlers, as handlers may call other handlers before returning a result.
+     *
+     * An example span for recursive call
+     * Main span ----------------------------------------------------------------------------------
+     * Handler1     ----------------------------------------------------------------------------
+     * Handler2           ----------------------------------------------------------------------
+     *
+     * To manage this, we keep a reference to the most recently created span and complete that span when we go one step deeper into the recursion.
+     * This approach works for now since we don't support much parallelism, but it will need to be updated when we start handling requests concurrently.
+     *
+     * An example span for recursive call after the above fixes
+     * Main span ----------------------------------------------------------------------------------
+     * Handler1     -----------------------------
+     * Handler2                                  ------------------------------------------------
+     *
+     */
+    private activeSpanByRequestId;
+    private middlewareSpanByReqId;
+    private lastActiveSpan;
+    private tracer;
+    constructor(ws: WebSocket, requestHandlers: MethodHandlers<ImplementedMethods, CallableMethods, RequestContext>, globalMiddlewares: GenericMiddleware<CallableMethods, RequestContext>[], tracer: Tracer, timeouts?: SocketTimeouts, logger?: {
+        error: (message?: string) => void;
+    });
+    protected callHandler<Params, Result, CallableMethods, RequestContext extends RequestContextBase>(handler: MethodHandler<Params, Result, CallableMethods, RequestContext>, params: Params, ctx: RequestContext, client: ISocketClient<CallableMethods>, next: () => Promise<Result>): Promise<Result>;
+    protected handleMessage(message: SocketMessage): Promise<void>;
+    request<Params, Result>(method: string, params: Params, authorization?: string): Promise<Result>;
+    protected decorateToSend(message: SocketMessage): SocketMessage;
+    protected respond<Result>(requestId: number, result: Result): void;
+    protected respondError(requestId: number, error: SocketError, exception?: Error): void;
+    private addEvent;
+    close(): void;
+}
+//# sourceMappingURL=tracedSocket.d.ts.map

package/dist-esm/socket/tracedSocket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracedSocket.d.ts","sourceRoot":"","sources":["../../src/socket/tracedSocket.ts"],"names":[],"mappings":"AAAA,OAAO,EASL,MAAM,EAEP,MAAM,oBAAoB,CAAC;AAE5B,OAAO,SAAS,MAAM,eAAe,CAAC;AAUtC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAmC9H,qBAAa,YAAY,CAAC,kBAAkB,EAAE,eAAe,EAAE,cAAc,SAAS,kBAAkB,CAAE,SAAQ,OAAO,CACvH,kBAAkB,EAClB,eAAe,EACf,cAAc,CACf;IACC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,OAAO,CAAC,qBAAqB,CAA2B;IACxD,OAAO,CAAC,qBAAqB,CAA2B;IACxD,OAAO,CAAC,cAAc,CAAmB;IACzC,OAAO,CAAC,MAAM,CAAS;gBAGrB,EAAE,EAAE,SAAS,EACb,eAAe,EAAE,cAAc,CAAC,kBAAkB,EAAE,eAAe,EAAE,cAAc,CAAC,EACpF,iBAAiB,EAAE,iBAAiB,CAAC,eAAe,EAAE,cAAc,CAAC,EAAE,EACvE,MAAM,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,cAAc,EACzB,MAAM,CAAC,EAAE;QAAE,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;KAAE;cAMhC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,cAAc,SAAS,kBAAkB,EACpG,OAAO,EAAE,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,cAAc,CAAC,EACvE,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,cAAc,EACnB,MAAM,EAAE,aAAa,CAAC,eAAe,CAAC,EACtC,IAAI,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,GAC1B,OAAO,CAAC,MAAM,CAAC;cAkCF,aAAa,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAqC7D,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAKvG,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,aAAa,GAAG,aAAa;IAK/D,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAKlE,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,CAAC,EAAE,KAAK,GAAG,IAAI;IAStF,OAAO,CAAC,QAAQ;IAQT,KAAK,IAAI,IAAI;CAQrB"}

package/dist-esm/socket/tracedSocket.js

@@ -0,0 +1,159 @@
+import { ROOT_CONTEXT, SpanKind, SpanStatusCode, context as otelCtx, propagation, trace } from '@opentelemetry/api';
+import { SEMATTRS_MESSAGING_DESTINATION_KIND, SEMATTRS_MESSAGING_SYSTEM } from '@opentelemetry/semantic-conventions';
+import { OBS_SOCKET_STATUS_CODE, OBS_TAG_API_ID, OBS_TAG_APPLICATION_ID, OBS_TAG_BRANCH, OBS_TAG_COMMIT_ID, OBS_TAG_HTTP_ROUTE, OBS_TAG_HTTP_STATUS_CODE } from '../observability';
+import { ISocket } from './socket';
+function isPromise(obj) {
+    return obj !== null && typeof obj === 'object' && typeof obj.then === 'function';
+}
+// Taken from https://github.com/gadget-inc/opentelemetry-instrumentations/blob/main/packages/opentelemetry-instrumentation-ws/src/index.ts#L21
+const endSpan = (traced, span) => {
+    try {
+        const result = traced();
+        if (isPromise(result)) {
+            return Promise.resolve(result)
+                .catch((err) => {
+                setHttpStatusFromError(span, typeof err === 'string' ? new Error(err) : err);
+                throw err;
+            })
+                .finally(() => span.end());
+        }
+        else {
+            span.end();
+            return result;
+        }
+    }
+    catch (error) {
+        setHttpStatusFromError(span, error);
+        span.end();
+        throw error;
+    }
+};
+function setHttpStatusFromError(span, error) {
+    // Simplified error handling without server-side dependencies
+    span.setAttribute(OBS_TAG_HTTP_STATUS_CODE, 500);
+    span.recordException(error);
+    span.setStatus({ code: SpanStatusCode.ERROR, message: error.message });
+}
+export class TracedSocket extends ISocket {
+    constructor(ws, requestHandlers, globalMiddlewares, tracer, timeouts, logger) {
+        super(ws, requestHandlers, globalMiddlewares, timeouts, logger);
+        /**
+         * The TracedSocket class extends the ISocket class to add tracing capabilities for each connection. It manages
+         * spans for handler calls to provide detailed tracing information.
+         *
+         * Unlike Express, the ISocket handler call chain is fully recursive. This recursion makes it challenging to determine
+         * when to create and end spans for specific handlers, as handlers may call other handlers before returning a result.
+         *
+         * An example span for recursive call
+         * Main span ----------------------------------------------------------------------------------
+         * Handler1     ----------------------------------------------------------------------------
+         * Handler2           ----------------------------------------------------------------------
+         *
+         * To manage this, we keep a reference to the most recently created span and complete that span when we go one step deeper into the recursion.
+         * This approach works for now since we don't support much parallelism, but it will need to be updated when we start handling requests concurrently.
+         *
+         * An example span for recursive call after the above fixes
+         * Main span ----------------------------------------------------------------------------------
+         * Handler1     -----------------------------
+         * Handler2                                  ------------------------------------------------
+         *
+         */
+        this.activeSpanByRequestId = new Map();
+        this.middlewareSpanByReqId = new Map();
+        this.tracer = tracer;
+    }
+    async callHandler(handler, params, ctx, client, next) {
+        let currentContext = otelCtx.active();
+        const middleWareSpan = this.middlewareSpanByReqId.get(ctx.requestId);
+        const activeSpan = this.activeSpanByRequestId.get(ctx.requestId);
+        // We need to end the middleware span since callHandler is called recursively
+        // Otherwise spans will be nested which is not representing actual time taken to execute a middleware
+        // Since we are ending the span here, it won't capture error state of nested handlers
+        if (middleWareSpan) {
+            middleWareSpan.end();
+            if (activeSpan) {
+                currentContext = trace.setSpan(otelCtx.active(), activeSpan);
+            }
+        }
+        let result;
+        await otelCtx.with(currentContext, async () => {
+            await this.tracer.startActiveSpan(`WS HANDLER ${handler.name === '' ? ctx.method : handler.name}`, {
+                attributes: {
+                    [SEMATTRS_MESSAGING_SYSTEM]: 'ws',
+                    [SEMATTRS_MESSAGING_DESTINATION_KIND]: 'websocket'
+                },
+                kind: SpanKind.SERVER
+            }, async (span) => {
+                this.middlewareSpanByReqId.set(ctx.requestId, span);
+                result = await endSpan(() => super.callHandler(handler, params, ctx, client, next), span);
+                this.middlewareSpanByReqId.delete(ctx.requestId);
+            });
+        });
+        return result;
+    }
+    async handleMessage(message) {
+        if (message.request) {
+            const spanName = message.request.method;
+            const requestId = message.request.id;
+            const payload = message.request.payload;
+            await otelCtx.with(propagation.extract(ROOT_CONTEXT, message.request), async () => await this.tracer.startActiveSpan(`WS SERVER ${spanName}`, {
+                attributes: {
+                    [SEMATTRS_MESSAGING_SYSTEM]: 'ws',
+                    [SEMATTRS_MESSAGING_DESTINATION_KIND]: 'websocket',
+                    [OBS_TAG_HTTP_ROUTE]: spanName,
+                    [OBS_TAG_APPLICATION_ID]: payload?.['applicationId'],
+                    [OBS_TAG_API_ID]: payload?.['apiId'],
+                    [OBS_TAG_BRANCH]: payload?.['branch'] ?? payload?.['branchName'],
+                    [OBS_TAG_COMMIT_ID]: payload?.['commitId']
+                },
+                kind: SpanKind.SERVER
+            }, async (span) => {
+                this.lastActiveSpan = span;
+                this.activeSpanByRequestId.set(requestId, span);
+                const result = await endSpan(() => super.handleMessage(message), span);
+                this.activeSpanByRequestId.delete(requestId);
+                return result;
+            }));
+        }
+        else if (message.response) {
+            this.addEvent('ws.received-response', { ['ws.response.id']: message.response.id });
+            return await super.handleMessage(message);
+        }
+    }
+    request(method, params, authorization) {
+        this.addEvent('ws.send-request', { ['ws.request.method']: method, ['ws.request.id']: this.nxtRequestId });
+        return super.request(method, params, authorization);
+    }
+    decorateToSend(message) {
+        propagation.inject(otelCtx.active(), message.request);
+        return message;
+    }
+    respond(requestId, result) {
+        this.addEvent('ws.send-response', { ['ws.response.id']: requestId });
+        return super.respond(requestId, result);
+    }
+    respondError(requestId, error, exception) {
+        this.addEvent('ws.send-error', { ['ws.response.id']: requestId });
+        if (this.lastActiveSpan) {
+            setHttpStatusFromError(this.lastActiveSpan, exception ?? new Error(error.message));
+            this.lastActiveSpan.setAttribute(OBS_SOCKET_STATUS_CODE, error.code);
+        }
+        return super.respondError(requestId, error, exception);
+    }
+    addEvent(eventName, attributes) {
+        // Since we do not have parent requestId in all the methods, we are assuming latest created span is the only active span
+        // This assumption can be broken if we start sending multiple request through the same connection.
+        if (this.lastActiveSpan) {
+            this.lastActiveSpan.addEvent(eventName, attributes, new Date());
+        }
+    }
+    close() {
+        for (const span of this.activeSpanByRequestId.values()) {
+            span.end();
+        }
+        this.activeSpanByRequestId = new Map();
+        this.lastActiveSpan = undefined;
+        super.close();
+    }
+}
+//# sourceMappingURL=tracedSocket.js.map

package/dist-esm/socket/tracedSocket.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracedSocket.js","sourceRoot":"","sources":["../../src/socket/tracedSocket.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EAEZ,QAAQ,EACR,cAAc,EAEd,OAAO,IAAI,OAAO,EAClB,WAAW,EAEX,KAAK,EACN,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,mCAAmC,EAAE,yBAAyB,EAAE,MAAM,qCAAqC,CAAC;AAErH,OAAO,EACL,sBAAsB,EACtB,cAAc,EACd,sBAAsB,EACtB,cAAc,EACd,iBAAiB,EACjB,kBAAkB,EAClB,wBAAwB,EACzB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,OAAO,EAA8B,MAAM,UAAU,CAAC;AAG/D,SAAS,SAAS,CAAC,GAAY;IAC7B,OAAO,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAQ,GAAwB,CAAC,IAAI,KAAK,UAAU,CAAC;AACzG,CAAC;AAED,+IAA+I;AAC/I,MAAM,OAAO,GAAG,CAAC,MAAwC,EAAE,IAAU,EAAE,EAAE;IACvE,IAAI;QACF,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC;QACxB,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE;YACrB,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;iBAC3B,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACb,sBAAsB,CAAC,IAAI,EAAE,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;gBAC7E,MAAM,GAAG,CAAC;YACZ,CAAC,CAAC;iBACD,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;SAC9B;aAAM;YACL,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,OAAO,MAAM,CAAC;SACf;KACF;IAAC,OAAO,KAAK,EAAE;QACd,sBAAsB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,GAAG,EAAE,CAAC;QACX,MAAM,KAAK,CAAC;KACb;AACH,CAAC,CAAC;AAEF,SAAS,sBAAsB,CAAC,IAAU,EAAE,KAAY;IACtD,6DAA6D;IAC7D,IAAI,CAAC,YAAY,CAAC,wBAAwB,EAAE,GAAG,CAAC,CAAC;IACjD,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IAC5B,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;AACzE,CAAC;AAED,MAAM,OAAO,YAA6F,SAAQ,OAIjH;IA2BC,YACE,EAAa,EACb,eAAoF,EACpF,iBAAuE,EACvE,MAAc,EACd,QAAyB,EACzB,MAA8C;QAE9C,KAAK,CAAC,EAAE,EAAE,eAAe,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAlClE;;;;;;;;;;;;;;;;;;;;WAoBG;QACK,0BAAqB,GAAG,IAAI,GAAG,EAAgB,CAAC;QAChD,0BAAqB,GAAG,IAAI,GAAG,EAAgB,CAAC;QAatD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAES,KAAK,CAAC,WAAW,CACzB,OAAuE,EACvE,MAAc,EACd,GAAmB,EACnB,MAAsC,EACtC,IAA2B;QAE3B,IAAI,cAAc,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QACtC,MAAM,cAAc,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACrE,MAAM,UAAU,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACjE,6EAA6E;QAC7E,qGAAqG;QACrG,qFAAqF;QACrF,IAAI,cAAc,EAAE;YAClB,cAAc,CAAC,GAAG,EAAE,CAAC;YACrB,IAAI,UAAU,EAAE;gBACd,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC;aAC9D;SACF;QACD,IAAI,MAAM,CAAC;QACX,MAAM,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE;YAC5C,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAC/B,cAAc,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAC/D;gBACE,UAAU,EAAE;oBACV,CAAC,yBAAyB,CAAC,EAAE,IAAI;oBACjC,CAAC,mCAAmC,CAAC,EAAE,WAAW;iBACnD;gBACD,IAAI,EAAE,QAAQ,CAAC,MAAM;aACtB,EACD,KAAK,EAAE,IAAU,EAAE,EAAE;gBACnB,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;gBACpD,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;gBAC1F,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACnD,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,OAAO,MAAgB,CAAC;IAC1B,CAAC;IAES,KAAK,CAAC,aAAa,CAAC,OAAsB;QAClD,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;YACxC,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;YACxC,MAAM,OAAO,CAAC,IAAI,CAChB,WAAW,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,EAClD,KAAK,IAAI,EAAE,CACT,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAC/B,aAAa,QAAQ,EAAE,EACvB;gBACE,UAAU,EAAE;oBACV,CAAC,yBAAyB,CAAC,EAAE,IAAI;oBACjC,CAAC,mCAAmC,CAAC,EAAE,WAAW;oBAClD,CAAC,kBAAkB,CAAC,EAAE,QAAQ;oBAC9B,CAAC,sBAAsB,CAAC,EAAE,OAAO,EAAE,CAAC,eAAe,CAAC;oBACpD,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,CAAC,OAAO,CAAC;oBACpC,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,IAAI,OAAO,EAAE,CAAC,YAAY,CAAC;oBAChE,CAAC,iBAAiB,CAAC,EAAE,OAAO,EAAE,CAAC,UAAU,CAAC;iBAC3C;gBACD,IAAI,EAAE,QAAQ,CAAC,MAAM;aACtB,EACD,KAAK,EAAE,IAAU,EAAE,EAAE;gBACnB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;gBAC3B,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;gBAChD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC;gBACvE,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC7C,OAAO,MAAM,CAAC;YAChB,CAAC,CACF,CACJ,CAAC;SACH;aAAM,IAAI,OAAO,CAAC,QAAQ,EAAE;YAC3B,IAAI,CAAC,QAAQ,CAAC,sBAAsB,EAAE,EAAE,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;YACnF,OAAO,MAAM,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;SAC3C;IACH,CAAC;IAEM,OAAO,CAAiB,MAAc,EAAE,MAAc,EAAE,aAAsB;QACnF,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,EAAE,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC,eAAe,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QAC1G,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IACtD,CAAC;IAES,cAAc,CAAC,OAAsB;QAC7C,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QACtD,OAAO,OAAO,CAAC;IACjB,CAAC;IAES,OAAO,CAAS,SAAiB,EAAE,MAAc;QACzD,IAAI,CAAC,QAAQ,CAAC,kBAAkB,EAAE,EAAE,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACrE,OAAO,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAC1C,CAAC;IAES,YAAY,CAAC,SAAiB,EAAE,KAAkB,EAAE,SAAiB;QAC7E,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,EAAE,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QAClE,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,sBAAsB,CAAC,IAAI,CAAC,cAAc,EAAE,SAAS,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;YACnF,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,sBAAsB,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;SACtE;QACD,OAAO,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;IACzD,CAAC;IAEO,QAAQ,CAAC,SAAiB,EAAE,UAAkC;QACpE,wHAAwH;QACxH,kGAAkG;QAClG,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;SACjE;IACH,CAAC;IAEM,KAAK;QACV,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,EAAE,EAAE;YACtD,IAAI,CAAC,GAAG,EAAE,CAAC;SACZ;QACD,IAAI,CAAC,qBAAqB,GAAG,IAAI,GAAG,EAAE,CAAC;QACvC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,KAAK,CAAC,KAAK,EAAE,CAAC;IAChB,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superblocksteam/shared",
-  "version": "0.9130.0",
+  "version": "0.9132.0",
   "description": "Superblocks Shared Resources",
   "repository": "https://github.com/superblocksteam/shared.git",
   "license": "Superblocks Community Software License",

package/src/socket/tracedSocket.ts

@@ -0,0 +1,220 @@
+import {
+  Attributes,
+  ROOT_CONTEXT,
+  Span,
+  SpanKind,
+  SpanStatusCode,
+  TimeInput,
+  context as otelCtx,
+  propagation,
+  Tracer,
+  trace
+} from '@opentelemetry/api';
+import { SEMATTRS_MESSAGING_DESTINATION_KIND, SEMATTRS_MESSAGING_SYSTEM } from '@opentelemetry/semantic-conventions';
+import WebSocket from 'isomorphic-ws';
+import {
+  OBS_SOCKET_STATUS_CODE,
+  OBS_TAG_API_ID,
+  OBS_TAG_APPLICATION_ID,
+  OBS_TAG_BRANCH,
+  OBS_TAG_COMMIT_ID,
+  OBS_TAG_HTTP_ROUTE,
+  OBS_TAG_HTTP_STATUS_CODE
+} from '../observability';
+import { ISocket, SocketError, SocketMessage } from './socket';
+import { GenericMiddleware, ISocketClient, MethodHandler, MethodHandlers, RequestContextBase, SocketTimeouts } from './types';
+
+function isPromise(obj: unknown): obj is Promise<unknown> {
+  return obj !== null && typeof obj === 'object' && typeof (obj as Promise<unknown>).then === 'function';
+}
+
+// Taken from https://github.com/gadget-inc/opentelemetry-instrumentations/blob/main/packages/opentelemetry-instrumentation-ws/src/index.ts#L21
+const endSpan = (traced: () => unknown | Promise<unknown>, span: Span) => {
+  try {
+    const result = traced();
+    if (isPromise(result)) {
+      return Promise.resolve(result)
+        .catch((err) => {
+          setHttpStatusFromError(span, typeof err === 'string' ? new Error(err) : err);
+          throw err;
+        })
+        .finally(() => span.end());
+    } else {
+      span.end();
+      return result;
+    }
+  } catch (error) {
+    setHttpStatusFromError(span, error);
+    span.end();
+    throw error;
+  }
+};
+
+function setHttpStatusFromError(span: Span, error: Error): void {
+  // Simplified error handling without server-side dependencies
+  span.setAttribute(OBS_TAG_HTTP_STATUS_CODE, 500);
+  span.recordException(error);
+  span.setStatus({ code: SpanStatusCode.ERROR, message: error.message });
+}
+
+export class TracedSocket<ImplementedMethods, CallableMethods, RequestContext extends RequestContextBase> extends ISocket<
+  ImplementedMethods,
+  CallableMethods,
+  RequestContext
+> {
+  /**
+   * The TracedSocket class extends the ISocket class to add tracing capabilities for each connection. It manages
+   * spans for handler calls to provide detailed tracing information.
+   *
+   * Unlike Express, the ISocket handler call chain is fully recursive. This recursion makes it challenging to determine
+   * when to create and end spans for specific handlers, as handlers may call other handlers before returning a result.
+   *
+   * An example span for recursive call
+   * Main span ----------------------------------------------------------------------------------
+   * Handler1     ----------------------------------------------------------------------------
+   * Handler2           ----------------------------------------------------------------------
+   *
+   * To manage this, we keep a reference to the most recently created span and complete that span when we go one step deeper into the recursion.
+   * This approach works for now since we don't support much parallelism, but it will need to be updated when we start handling requests concurrently.
+   *
+   * An example span for recursive call after the above fixes
+   * Main span ----------------------------------------------------------------------------------
+   * Handler1     -----------------------------
+   * Handler2                                  ------------------------------------------------
+   *
+   */
+  private activeSpanByRequestId = new Map<number, Span>();
+  private middlewareSpanByReqId = new Map<number, Span>();
+  private lastActiveSpan: Span | undefined;
+  private tracer: Tracer;
+
+  constructor(
+    ws: WebSocket,
+    requestHandlers: MethodHandlers<ImplementedMethods, CallableMethods, RequestContext>,
+    globalMiddlewares: GenericMiddleware<CallableMethods, RequestContext>[],
+    tracer: Tracer,
+    timeouts?: SocketTimeouts,
+    logger?: { error: (message?: string) => void }
+  ) {
+    super(ws, requestHandlers, globalMiddlewares, timeouts, logger);
+    this.tracer = tracer;
+  }
+
+  protected async callHandler<Params, Result, CallableMethods, RequestContext extends RequestContextBase>(
+    handler: MethodHandler<Params, Result, CallableMethods, RequestContext>,
+    params: Params,
+    ctx: RequestContext,
+    client: ISocketClient<CallableMethods>,
+    next: () => Promise<Result>
+  ): Promise<Result> {
+    let currentContext = otelCtx.active();
+    const middleWareSpan = this.middlewareSpanByReqId.get(ctx.requestId);
+    const activeSpan = this.activeSpanByRequestId.get(ctx.requestId);
+    // We need to end the middleware span since callHandler is called recursively
+    // Otherwise spans will be nested which is not representing actual time taken to execute a middleware
+    // Since we are ending the span here, it won't capture error state of nested handlers
+    if (middleWareSpan) {
+      middleWareSpan.end();
+      if (activeSpan) {
+        currentContext = trace.setSpan(otelCtx.active(), activeSpan);
+      }
+    }
+    let result;
+    await otelCtx.with(currentContext, async () => {
+      await this.tracer.startActiveSpan(
+        `WS HANDLER ${handler.name === '' ? ctx.method : handler.name}`,
+        {
+          attributes: {
+            [SEMATTRS_MESSAGING_SYSTEM]: 'ws',
+            [SEMATTRS_MESSAGING_DESTINATION_KIND]: 'websocket'
+          },
+          kind: SpanKind.SERVER
+        },
+        async (span: Span) => {
+          this.middlewareSpanByReqId.set(ctx.requestId, span);
+          result = await endSpan(() => super.callHandler(handler, params, ctx, client, next), span);
+          this.middlewareSpanByReqId.delete(ctx.requestId);
+        }
+      );
+    });
+    return result as Result;
+  }
+
+  protected async handleMessage(message: SocketMessage): Promise<void> {
+    if (message.request) {
+      const spanName = message.request.method;
+      const requestId = message.request.id;
+      const payload = message.request.payload;
+      await otelCtx.with(
+        propagation.extract(ROOT_CONTEXT, message.request),
+        async () =>
+          await this.tracer.startActiveSpan(
+            `WS SERVER ${spanName}`,
+            {
+              attributes: {
+                [SEMATTRS_MESSAGING_SYSTEM]: 'ws',
+                [SEMATTRS_MESSAGING_DESTINATION_KIND]: 'websocket',
+                [OBS_TAG_HTTP_ROUTE]: spanName,
+                [OBS_TAG_APPLICATION_ID]: payload?.['applicationId'],
+                [OBS_TAG_API_ID]: payload?.['apiId'],
+                [OBS_TAG_BRANCH]: payload?.['branch'] ?? payload?.['branchName'],
+                [OBS_TAG_COMMIT_ID]: payload?.['commitId']
+              },
+              kind: SpanKind.SERVER
+            },
+            async (span: Span) => {
+              this.lastActiveSpan = span;
+              this.activeSpanByRequestId.set(requestId, span);
+              const result = await endSpan(() => super.handleMessage(message), span);
+              this.activeSpanByRequestId.delete(requestId);
+              return result;
+            }
+          )
+      );
+    } else if (message.response) {
+      this.addEvent('ws.received-response', { ['ws.response.id']: message.response.id });
+      return await super.handleMessage(message);
+    }
+  }
+
+  public request<Params, Result>(method: string, params: Params, authorization?: string): Promise<Result> {
+    this.addEvent('ws.send-request', { ['ws.request.method']: method, ['ws.request.id']: this.nxtRequestId });
+    return super.request(method, params, authorization);
+  }
+
+  protected decorateToSend(message: SocketMessage): SocketMessage {
+    propagation.inject(otelCtx.active(), message.request);
+    return message;
+  }
+
+  protected respond<Result>(requestId: number, result: Result): void {
+    this.addEvent('ws.send-response', { ['ws.response.id']: requestId });
+    return super.respond(requestId, result);
+  }
+
+  protected respondError(requestId: number, error: SocketError, exception?: Error): void {
+    this.addEvent('ws.send-error', { ['ws.response.id']: requestId });
+    if (this.lastActiveSpan) {
+      setHttpStatusFromError(this.lastActiveSpan, exception ?? new Error(error.message));
+      this.lastActiveSpan.setAttribute(OBS_SOCKET_STATUS_CODE, error.code);
+    }
+    return super.respondError(requestId, error, exception);
+  }
+
+  private addEvent(eventName: string, attributes: Attributes | TimeInput): void {
+    // Since we do not have parent requestId in all the methods, we are assuming latest created span is the only active span
+    // This assumption can be broken if we start sending multiple request through the same connection.
+    if (this.lastActiveSpan) {
+      this.lastActiveSpan.addEvent(eventName, attributes, new Date());
+    }
+  }
+
+  public close(): void {
+    for (const span of this.activeSpanByRequestId.values()) {
+      span.end();
+    }
+    this.activeSpanByRequestId = new Map();
+    this.lastActiveSpan = undefined;
+    super.close();
+  }
+}