@chainlink/external-adapter-framework 0.12.1 → 0.13.0

package/transports/websocket.js

@@ -30,8 +30,8 @@ exports.WebSocketTransport = exports.WebSocketClassProvider = exports.WebSocket
 const ws_1 = __importDefault(require("ws"));
 exports.WebSocket = ws_1.default;
 const util_1 = require("../util");
-const _1 = require("./");
 const transportMetrics = __importStar(require("./metrics"));
+const streaming_1 = require("./abstract/streaming");
 const logger = (0, util_1.makeLogger)('WebSocketTransport');
 class WebSocketClassProvider {
     static set(ctor) {
@@ -49,22 +49,15 @@ WebSocketClassProvider.ctor = ws_1.default;
  *
  * @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[WebsocketTransportGenerics]])
  */
-class WebSocketTransport {
+class WebSocketTransport extends streaming_1.StreamingTransport {
     constructor(config) {
+        super();
         this.config = config;
-        // The double sets serve to create a simple polling mechanism instead of needing a subscription
-        // This one would not; this is always local state
-        this.localSubscriptions = [];
         this.currentUrl = '';
+        this.lastMessageReceivedAt = 0;
     }
-    async initialize(dependencies, config, endpointName) {
-        this.cache = dependencies.cache;
-        this.rateLimiter = dependencies.backgroundExecuteRateLimiter;
-        this.subscriptionSet = dependencies.subscriptionSetFactory.buildSet(endpointName);
-    }
-    async registerRequest(req, config) {
-        logger.debug(`Adding entry to subscription set (ttl: ${config.WS_SUBSCRIPTION_TTL}): [${req.requestContext.cacheKey}] = ${req.requestContext.data}`);
-        await this.subscriptionSet.add(req.requestContext.cacheKey, req.requestContext.data, config.WS_SUBSCRIPTION_TTL);
+    getSubscriptionTtlFromConfig(config) {
+        return config.WS_SUBSCRIPTION_TTL;
     }
     connectionClosed() {
         return !this.wsConnection || this.wsConnection.readyState === ws_1.default.CLOSED;
@@ -75,11 +68,10 @@ class WebSocketTransport {
     deserializeMessage(data) {
         return JSON.parse(data.toString());
     }
-    establishWsConnection(context, url, options) {
-        return new Promise((resolve) => {
-            const ctor = WebSocketClassProvider.get();
-            this.wsConnection = new ctor(url, undefined, options);
-            this.wsConnection.addEventListener('open', async (event) => {
+    buildConnectionHandlers(context, connectionReadyResolve) {
+        return {
+            // Called when the WS connection is opened
+            open: async (event) => {
                 logger.debug(`Opened websocket connection. (event type ${event.type})`);
                 if (this.config.handlers.open) {
                     await this.config.handlers.open(this.wsConnection, context);
@@ -87,31 +79,64 @@ class WebSocketTransport {
                 }
                 // Record active ws connections by incrementing count on open
                 transportMetrics.wsConnectionActive.inc();
-                resolve(true);
-            });
-            this.wsConnection.addEventListener('message', async (event) => {
+                connectionReadyResolve(true);
+            },
+            // Called when any message is received by the open connection
+            message: async (event) => {
                 const parsed = this.deserializeMessage(event.data);
                 logger.trace(`Got ws message: ${event.data}`);
-                const results = this.config.handlers.message(parsed, context);
+                const providerDataReceived = Date.now();
+                const results = this.config.handlers.message(parsed, context)?.map((r) => {
+                    const result = r;
+                    const partialResponse = r.response;
+                    result.response.timestamps = {
+                        providerDataStreamEstablished: this.providerDataStreamEstablished,
+                        providerDataReceived,
+                        providerIndicatedTime: partialResponse.timestamps?.providerIndicatedTime,
+                    };
+                    return result;
+                });
                 if (Array.isArray(results)) {
-                    const responses = (0, _1.buildCacheEntriesFromResults)(results, context);
-                    logger.trace(`Writing ${responses.length} responses to cache`);
-                    await this.cache.setMany(responses, context.adapterConfig.CACHE_MAX_AGE);
+                    // Updating the last message received time here, to only care about messages we use
+                    this.lastMessageReceivedAt = Date.now();
+                    logger.trace(`Writing ${results.length} responses to cache`);
+                    await this.responseCache.write(results);
                 }
-            });
-            this.wsConnection.addEventListener('error', async (event) => {
+                // Do this after writing so we get the values to the cache ASAP
+                // We're not calculating feedId or subscription because this is only a single message,
+                // and it could in theory contain more than one value to set to the cache
+                transportMetrics.wsMessageTotal
+                    .labels({
+                    direction: 'received',
+                })
+                    .inc();
+            },
+            // Called when an error is thrown by the connection
+            error: async (event) => {
                 logger.debug(`Error occurred in web socket connection. Error: ${event.error} ; Message: ${event.message}`);
                 // Record connection error count
                 transportMetrics.wsConnectionErrors
                     .labels(transportMetrics.connectionErrorLabels(event.message))
                     .inc();
-            });
-            this.wsConnection.addEventListener('close', (event) => {
+            },
+            // Called when the WS connection closes for any reason
+            close: (event) => {
                 logger.debug(`Closed websocket connection. Code: ${event.code} ; reason: ${event.reason?.toString()}`);
                 // Record active ws connections by decrementing count on close
                 // Using URL in label since connection_key is removed from v3
                 transportMetrics.wsConnectionActive.dec();
-            });
+            },
+        };
+    }
+    establishWsConnection(context, url, options) {
+        return new Promise((resolve) => {
+            const ctor = WebSocketClassProvider.get();
+            const handlers = this.buildConnectionHandlers(context, resolve);
+            this.wsConnection = new ctor(url, undefined, options);
+            this.wsConnection.addEventListener('open', handlers.open);
+            this.wsConnection.addEventListener('message', handlers.message);
+            this.wsConnection.addEventListener('error', handlers.error);
+            this.wsConnection.addEventListener('close', handlers.close);
         });
     }
     async sendMessages(context, subscribes, unsubscribes) {
@@ -122,59 +147,50 @@ class WebSocketTransport {
             this.wsConnection.send(message);
         }
     }
-    // Unlike cache warming, this execute will manage subscriptions
-    async backgroundExecute(context) {
-        logger.debug('Starting background execute, getting subscriptions from sorted set');
-        const desiredSubs = await this.subscriptionSet.getAll();
-        // Keep track of active subscriptions for background execute
-        transportMetrics.bgExecuteSubscriptionSetCount
-            .labels({ endpoint: context.endpointName, transport_type: 'websocket' })
-            .set(desiredSubs.length);
-        logger.debug('Generating delta (subscribes & unsubscribes)');
-        const subscribes = desiredSubs.filter((s) => !this.localSubscriptions.map((ls) => JSON.stringify(ls)).includes(JSON.stringify(s)));
-        const unsubscribes = this.localSubscriptions.filter((s) => !desiredSubs.map((ds) => JSON.stringify(ds)).includes(JSON.stringify(s)));
-        logger.debug(`${subscribes.length} new subscriptions; ${unsubscribes.length} to unsubscribe`);
-        if (subscribes.length) {
-            logger.trace(`Will subscribe to: ${JSON.stringify(subscribes)}`);
-        }
-        if (unsubscribes.length) {
-            logger.trace(`Will unsubscribe to: ${JSON.stringify(unsubscribes)}`);
-        }
+    async streamHandler(context, subscriptions) {
         // New subs && no connection -> connect -> add subs
         // No new subs && no connection -> skip
         // New subs && connection -> add subs
         // No new subs && connection -> unsubs only
-        if (!subscribes.length && !this.wsConnection) {
+        if (!subscriptions.new.length && !this.wsConnection) {
             logger.debug('No entries in subscription set and no established connection, skipping');
-            return this.rateLimiter.msUntilNextExecution(context.endpointName);
+            return;
         }
-        const urlFromConfig = await this.config.url(context, desiredSubs);
+        const urlFromConfig = await this.config.url(context, subscriptions.desired);
         const urlChanged = this.currentUrl !== urlFromConfig;
+        const timeSinceLastMessage = Date.now() - this.lastMessageReceivedAt;
+        const connectionUnresponsive = timeSinceLastMessage > context.adapterConfig.WS_SUBSCRIPTION_UNRESPONSIVE_TTL;
         let connectionClosed = this.connectionClosed();
         // Check if we should close the current connection
-        if (!connectionClosed && urlChanged) {
-            logger.info(`Websocket url has changed from ${this.currentUrl} to ${urlFromConfig}, closing connection...`);
+        if (!connectionClosed && (urlChanged || connectionUnresponsive)) {
+            const reason = urlChanged
+                ? `Websocket url has changed from ${this.currentUrl} to ${urlFromConfig}, closing connection...`
+                : `Last message was received ${timeSinceLastMessage} ago, exceeding the threshold of ${context.adapterConfig.WS_SUBSCRIPTION_UNRESPONSIVE_TTL}ms, closing connection...`;
+            logger.info(reason);
             this.wsConnection.close();
             connectionClosed = true;
+            // If the connection was closed, the new subscriptions should be the desired ones
+            subscriptions.new = subscriptions.desired;
+            if (subscriptions.new.length) {
+                logger.trace(`Connection will be reopened and will subscribe to new and resubscribe to existing: ${JSON.stringify(subscriptions.new)}`);
+            }
         }
         // Check if we need to open a new connection
-        if (connectionClosed && desiredSubs.length) {
+        if (connectionClosed && subscriptions.desired.length) {
             logger.debug('No established connection and new subscriptions available, connecting to WS');
             const options = this.config.options && (await this.config.options(context));
             this.currentUrl = urlFromConfig;
             await this.establishWsConnection(context, urlFromConfig, options);
+            this.providerDataStreamEstablished = Date.now();
         }
         if (this.config.builders) {
             logger.debug('Sending subs/unsubs if there are any');
             const { subscribeMessage, unsubscribeMessage } = this.config.builders;
-            await this.sendMessages(context, subscribeMessage ? subscribes.map(subscribeMessage) : subscribes, unsubscribeMessage ? unsubscribes.map(unsubscribeMessage) : unsubscribes);
+            await this.sendMessages(context, subscribeMessage ? subscriptions.new.map(subscribeMessage) : subscriptions.new, unsubscribeMessage ? subscriptions.stale.map(unsubscribeMessage) : subscriptions.stale);
         }
         // Record WS message and subscription metrics
-        transportMetrics.recordWsMessageMetrics(context, subscribes, unsubscribes);
-        logger.debug('Setting local state to cache value');
-        this.localSubscriptions = desiredSubs;
-        logger.debug('Background execute complete');
-        return this.rateLimiter.msUntilNextExecution(context.endpointName);
+        transportMetrics.recordWsMessageMetrics(context, subscriptions.new, subscriptions.stale);
+        return;
     }
 }
 exports.WebSocketTransport = WebSocketTransport;

package/transports/websocket.js.map

@@ -1 +1 @@
-{"version":3,"file":"websocket.js","sourceRoot":"","sources":["../../../src/transports/websocket.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAAsD;AAW7C,oBAXF,YAAS,CAWE;AANlB,kCAAqD;AAErD,yBAA+E;AAC/E,4DAA6C;AAK7C,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,oBAAoB,CAAC,CAAA;AAQ/C,MAAa,sBAAsB;IAGjC,MAAM,CAAC,GAAG,CAAC,IAAoB;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IAED,MAAM,CAAC,GAAG;QACR,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;;AATH,wDAUC;AATQ,2BAAI,GAAmB,YAAS,CAAA;AAoFzC;;;;;GAKG;AACH,MAAa,kBAAkB;IAW7B,YAAoB,MAAmC;QAAnC,WAAM,GAAN,MAAM,CAA6B;QANvD,+FAA+F;QAC/F,iDAAiD;QACjD,uBAAkB,GAA6B,EAAE,CAAA;QAGjD,eAAU,GAAG,EAAE,CAAA;IAC2C,CAAC;IAE3D,KAAK,CAAC,UAAU,CACd,YAAiC,EACjC,MAA0C,EAC1C,YAAoB;QAEpB,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAA8C,CAAA;QACxE,IAAI,CAAC,WAAW,GAAG,YAAY,CAAC,4BAA4B,CAAA;QAC5D,IAAI,CAAC,eAAe,GAAG,YAAY,CAAC,sBAAsB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;IACnF,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,GAAiC,EACjC,MAA0C;QAE1C,MAAM,CAAC,KAAK,CACV,0CAA0C,MAAM,CAAC,mBAAmB,OAAO,GAAG,CAAC,cAAc,CAAC,QAAQ,OAAO,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CACvI,CAAA;QACD,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAC5B,GAAG,CAAC,cAAc,CAAC,QAAQ,EAC3B,GAAG,CAAC,cAAc,CAAC,IAAI,EACvB,MAAM,CAAC,mBAAmB,CAC3B,CAAA;IACH,CAAC;IAED,gBAAgB;QACd,OAAO,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,CAAC,UAAU,KAAK,YAAS,CAAC,MAAM,CAAA;IAChF,CAAC;IAED,gBAAgB,CAAC,OAAgB;QAC/B,OAAO,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;IACxE,CAAC;IACD,kBAAkB,CAAC,IAAoB;QACrC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAA+B,CAAA;IAClE,CAAC;IAED,qBAAqB,CACnB,OAA2B,EAC3B,GAAW,EACX,OAA6C;QAE7C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,MAAM,IAAI,GAAG,sBAAsB,CAAC,GAAG,EAAE,CAAA;YACzC,IAAI,CAAC,YAAY,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAA;YACrD,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,MAAM,EAAE,KAAK,EAAE,KAAsB,EAAE,EAAE;gBAC1E,MAAM,CAAC,KAAK,CAAC,4CAA4C,KAAK,CAAC,IAAI,GAAG,CAAC,CAAA;gBACvE,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;oBAC7B,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;oBAC3D,MAAM,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAA;iBAChE;gBACD,6DAA6D;gBAC7D,gBAAgB,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAA;gBACzC,OAAO,CAAC,IAAI,CAAC,CAAA;YACf,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,SAAS,EAAE,KAAK,EAAE,KAA6B,EAAE,EAAE;gBACpF,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;gBAClD,MAAM,CAAC,KAAK,CAAC,mBAAmB,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;gBAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;gBAC7D,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;oBAC1B,MAAM,SAAS,GAAG,IAAA,+BAA4B,EAAC,OAAO,EAAE,OAAO,CAAC,CAAA;oBAChE,MAAM,CAAC,KAAK,CAAC,WAAW,SAAS,CAAC,MAAM,qBAAqB,CAAC,CAAA;oBAC9D,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,CAAA;iBACzE;YACH,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,KAA2B,EAAE,EAAE;gBAChF,MAAM,CAAC,KAAK,CACV,mDAAmD,KAAK,CAAC,KAAK,eAAe,KAAK,CAAC,OAAO,EAAE,CAC7F,CAAA;gBACD,gCAAgC;gBAChC,gBAAgB,CAAC,kBAAkB;qBAChC,MAAM,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;qBAC7D,GAAG,EAAE,CAAA;YACV,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAA2B,EAAE,EAAE;gBAC1E,MAAM,CAAC,KAAK,CACV,sCAAsC,KAAK,CAAC,IAAI,cAAc,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CACzF,CAAA;gBACD,8DAA8D;gBAC9D,6DAA6D;gBAC7D,gBAAgB,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAA;YAC3C,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,OAA2B,EAAE,UAAqB,EAAE,YAAuB;QAC5F,MAAM,oBAAoB,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAClE,MAAM,sBAAsB,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAEtE,MAAM,QAAQ,GAAG,oBAAoB,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAA;QACpE,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC9B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;SAChC;IACH,CAAC;IAED,+DAA+D;IAC/D,KAAK,CAAC,iBAAiB,CAAC,OAA2B;QACjD,MAAM,CAAC,KAAK,CAAC,oEAAoE,CAAC,CAAA;QAClF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAA;QAEvD,4DAA4D;QAC5D,gBAAgB,CAAC,6BAA6B;aAC3C,MAAM,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,YAAY,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC;aACvE,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QAE1B,MAAM,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAA;QAC5D,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,CACnC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAC5F,CAAA;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CACjD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAChF,CAAA;QAED,MAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,MAAM,uBAAuB,YAAY,CAAC,MAAM,iBAAiB,CAAC,CAAA;QAC7F,IAAI,UAAU,CAAC,MAAM,EAAE;YACrB,MAAM,CAAC,KAAK,CAAC,sBAAsB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;SACjE;QACD,IAAI,YAAY,CAAC,MAAM,EAAE;YACvB,MAAM,CAAC,KAAK,CAAC,wBAAwB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;SACrE;QAED,mDAAmD;QACnD,uCAAuC;QACvC,qCAAqC;QACrC,2CAA2C;QAC3C,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YAC5C,MAAM,CAAC,KAAK,CAAC,wEAAwE,CAAC,CAAA;YACtF,OAAO,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;SACnE;QAED,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;QACjE,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,KAAK,aAAa,CAAA;QACpD,IAAI,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAA;QAE9C,kDAAkD;QAClD,IAAI,CAAC,gBAAgB,IAAI,UAAU,EAAE;YACnC,MAAM,CAAC,IAAI,CACT,kCAAkC,IAAI,CAAC,UAAU,OAAO,aAAa,yBAAyB,CAC/F,CAAA;YACD,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAA;YACzB,gBAAgB,GAAG,IAAI,CAAA;SACxB;QAED,4CAA4C;QAC5C,IAAI,gBAAgB,IAAI,WAAW,CAAC,MAAM,EAAE;YAC1C,MAAM,CAAC,KAAK,CAAC,6EAA6E,CAAC,CAAA;YAC3F,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;YAC3E,IAAI,CAAC,UAAU,GAAG,aAAa,CAAA;YAC/B,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,aAAa,EAAE,OAAO,CAAC,CAAA;SAClE;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;YACxB,MAAM,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAA;YACpD,MAAM,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAA;YACrE,MAAM,IAAI,CAAC,YAAY,CACrB,OAAO,EACP,gBAAgB,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,UAAU,EAChE,kBAAkB,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,YAAY,CACzE,CAAA;SACF;QAED,6CAA6C;QAC7C,gBAAgB,CAAC,sBAAsB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC,CAAA;QAE1E,MAAM,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAA;QAClD,IAAI,CAAC,kBAAkB,GAAG,WAAW,CAAA;QAErC,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAA;QAC3C,OAAO,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;IACpE,CAAC;CACF;AAtLD,gDAsLC"}
+{"version":3,"file":"websocket.js","sourceRoot":"","sources":["../../../src/transports/websocket.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4CAAsD;AAc7C,oBAdF,YAAS,CAcE;AAXlB,kCAAoC;AAOpC,4DAA6C;AAC7C,oDAA6E;AAK7E,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,oBAAoB,CAAC,CAAA;AAQ/C,MAAa,sBAAsB;IAGjC,MAAM,CAAC,GAAG,CAAC,IAAoB;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IAED,MAAM,CAAC,GAAG;QACR,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;;AATH,wDAUC;AATQ,2BAAI,GAAmB,YAAS,CAAA;AAoFzC;;;;;GAKG;AACH,MAAa,kBAEX,SAAQ,8BAAqB;IAK7B,YAAoB,MAAmC;QACrD,KAAK,EAAE,CAAA;QADW,WAAM,GAAN,MAAM,CAA6B;QAHvD,eAAU,GAAG,EAAE,CAAA;QACf,0BAAqB,GAAG,CAAC,CAAA;IAIzB,CAAC;IAED,4BAA4B,CAAC,MAA0C;QACrE,OAAO,MAAM,CAAC,mBAAmB,CAAA;IACnC,CAAC;IAED,gBAAgB;QACd,OAAO,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,CAAC,UAAU,KAAK,YAAS,CAAC,MAAM,CAAA;IAChF,CAAC;IAED,gBAAgB,CAAC,OAAgB;QAC/B,OAAO,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;IACxE,CAAC;IACD,kBAAkB,CAAC,IAAoB;QACrC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAA+B,CAAA;IAClE,CAAC;IAED,uBAAuB,CACrB,OAA2B,EAC3B,sBAAgD;QAEhD,OAAO;YACL,0CAA0C;YAC1C,IAAI,EAAE,KAAK,EAAE,KAAsB,EAAE,EAAE;gBACrC,MAAM,CAAC,KAAK,CAAC,4CAA4C,KAAK,CAAC,IAAI,GAAG,CAAC,CAAA;gBACvE,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;oBAC7B,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;oBAC3D,MAAM,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAA;iBAChE;gBACD,6DAA6D;gBAC7D,gBAAgB,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAA;gBACzC,sBAAsB,CAAC,IAAI,CAAC,CAAA;YAC9B,CAAC;YAED,6DAA6D;YAC7D,OAAO,EAAE,KAAK,EAAE,KAA6B,EAAE,EAAE;gBAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;gBAClD,MAAM,CAAC,KAAK,CAAC,mBAAmB,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;gBAC7C,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;gBACvC,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;oBACvE,MAAM,MAAM,GAAG,CAAiC,CAAA;oBAChD,MAAM,eAAe,GAAG,CAAC,CAAC,QAAoD,CAAA;oBAC9E,MAAM,CAAC,QAAQ,CAAC,UAAU,GAAG;wBAC3B,6BAA6B,EAAE,IAAI,CAAC,6BAA6B;wBACjE,oBAAoB;wBACpB,qBAAqB,EAAE,eAAe,CAAC,UAAU,EAAE,qBAAqB;qBACzE,CAAA;oBACD,OAAO,MAAM,CAAA;gBACf,CAAC,CAAC,CAAA;gBACF,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;oBAC1B,mFAAmF;oBACnF,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;oBAEvC,MAAM,CAAC,KAAK,CAAC,WAAW,OAAO,CAAC,MAAM,qBAAqB,CAAC,CAAA;oBAC5D,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;iBACxC;gBAED,+DAA+D;gBAC/D,sFAAsF;gBACtF,yEAAyE;gBACzE,gBAAgB,CAAC,cAAc;qBAC5B,MAAM,CAAC;oBACN,SAAS,EAAE,UAAU;iBACtB,CAAC;qBACD,GAAG,EAAE,CAAA;YACV,CAAC;YAED,mDAAmD;YACnD,KAAK,EAAE,KAAK,EAAE,KAA2B,EAAE,EAAE;gBAC3C,MAAM,CAAC,KAAK,CACV,mDAAmD,KAAK,CAAC,KAAK,eAAe,KAAK,CAAC,OAAO,EAAE,CAC7F,CAAA;gBACD,gCAAgC;gBAChC,gBAAgB,CAAC,kBAAkB;qBAChC,MAAM,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;qBAC7D,GAAG,EAAE,CAAA;YACV,CAAC;YAED,sDAAsD;YACtD,KAAK,EAAE,CAAC,KAA2B,EAAE,EAAE;gBACrC,MAAM,CAAC,KAAK,CACV,sCAAsC,KAAK,CAAC,IAAI,cAAc,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CACzF,CAAA;gBACD,8DAA8D;gBAC9D,6DAA6D;gBAC7D,gBAAgB,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAA;YAC3C,CAAC;SACF,CAAA;IACH,CAAC;IAED,qBAAqB,CACnB,OAA2B,EAC3B,GAAW,EACX,OAA6C;QAE7C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,MAAM,IAAI,GAAG,sBAAsB,CAAC,GAAG,EAAE,CAAA;YACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAE/D,IAAI,CAAC,YAAY,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAA;YACrD,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAA;YACzD,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;YAC/D,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAA;YAC3D,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAA;QAC7D,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,OAA2B,EAAE,UAAqB,EAAE,YAAuB;QAC5F,MAAM,oBAAoB,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAClE,MAAM,sBAAsB,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAEtE,MAAM,QAAQ,GAAG,oBAAoB,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAA;QACpE,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC9B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;SAChC;IACH,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,OAA2B,EAC3B,aAAyD;QAEzD,mDAAmD;QACnD,uCAAuC;QACvC,qCAAqC;QACrC,2CAA2C;QAC3C,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACnD,MAAM,CAAC,KAAK,CAAC,wEAAwE,CAAC,CAAA;YACtF,OAAM;SACP;QAED,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;QAC3E,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,KAAK,aAAa,CAAA;QACpD,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,qBAAqB,CAAA;QACpE,MAAM,sBAAsB,GAC1B,oBAAoB,GAAG,OAAO,CAAC,aAAa,CAAC,gCAAgC,CAAA;QAC/E,IAAI,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAA;QAE9C,kDAAkD;QAClD,IAAI,CAAC,gBAAgB,IAAI,CAAC,UAAU,IAAI,sBAAsB,CAAC,EAAE;YAC/D,MAAM,MAAM,GAAG,UAAU;gBACvB,CAAC,CAAC,kCAAkC,IAAI,CAAC,UAAU,OAAO,aAAa,yBAAyB;gBAChG,CAAC,CAAC,6BAA6B,oBAAoB,oCAAoC,OAAO,CAAC,aAAa,CAAC,gCAAgC,2BAA2B,CAAA;YAC1K,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YACnB,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAA;YACzB,gBAAgB,GAAG,IAAI,CAAA;YAEvB,iFAAiF;YACjF,aAAa,CAAC,GAAG,GAAG,aAAa,CAAC,OAAO,CAAA;YACzC,IAAI,aAAa,CAAC,GAAG,CAAC,MAAM,EAAE;gBAC5B,MAAM,CAAC,KAAK,CACV,sFAAsF,IAAI,CAAC,SAAS,CAClG,aAAa,CAAC,GAAG,CAClB,EAAE,CACJ,CAAA;aACF;SACF;QAED,4CAA4C;QAC5C,IAAI,gBAAgB,IAAI,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE;YACpD,MAAM,CAAC,KAAK,CAAC,6EAA6E,CAAC,CAAA;YAC3F,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;YAC3E,IAAI,CAAC,UAAU,GAAG,aAAa,CAAA;YAC/B,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,aAAa,EAAE,OAAO,CAAC,CAAA;YACjE,IAAI,CAAC,6BAA6B,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;SAChD;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;YACxB,MAAM,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAA;YACpD,MAAM,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAA;YACrE,MAAM,IAAI,CAAC,YAAY,CACrB,OAAO,EACP,gBAAgB,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,EAC9E,kBAAkB,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CACvF,CAAA;SACF;QAED,6CAA6C;QAC7C,gBAAgB,CAAC,sBAAsB,CAAC,OAAO,EAAE,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC,KAAK,CAAC,CAAA;QAExF,OAAM;IACR,CAAC;CACF;AA9LD,gDA8LC"}

package/util/request.d.ts

@@ -76,18 +76,27 @@ export interface AdapterMetricsMeta {
 export declare type AdapterRequestData = Record<string, unknown> & {
     endpoint?: string;
 };
+export declare type ProviderResultGenerics = {
+    Request: RequestGenerics;
+    Response: ResponseGenerics;
+};
 /**
  * Helper type to hold the value from responses from a provider, and the adapter params they correspond to.
  */
-export interface ProviderResult<T extends {
-    Request: RequestGenerics;
-    Response: ResponseGenerics;
-}> {
+export declare type ProviderResult<T extends ProviderResultGenerics> = {
     /** The set of parameters that uniquely relate to the response */
     params: T['Request']['Params'];
     /** Value that will be included in the result property of the response */
-    value: T['Response']['Result'];
-}
+    response: PartialAdapterResponse<T['Response']>;
+};
+export declare type TimestampedProviderResult<T extends ProviderResultGenerics> = Pick<ProviderResult<T>, 'params'> & {
+    /** Value that will be included in the result property of the response, with timestamps applied */
+    response: TimestampedAdapterResponse<T['Response']>;
+};
+/**
+ * Here we do actually want an object, since unknown could be a primitive.
+ * The rule itself does say "marginally better"
+ */
 export declare type EmptyObject = Object;
 /**
  * Helper struct type that provides detail about the incoming Adapter Request
@@ -113,20 +122,90 @@ export declare type ResponseGenerics = {
     Result: string | number | null;
 };
 /**
- * Shape of the response body from the adapter
+ * Details for timestamps to be included in the response
+ */
+declare type ResponseTimestamps = {
+    /** Time at which data was received from the provider */
+    providerDataReceived: number;
+    /** Time indicated by the provider representing the time at which this value was calculated/set/valid */
+    providerIndicatedTime: number | undefined;
+} & ({
+    /**
+     * For sync protocols (request -\> response).
+     * Time at which data was requested from the provider.
+     */
+    providerDataRequested: number;
+    providerDataStreamEstablished?: never;
+} | {
+    /**
+     * For async protocols (subscription -\> n events received).
+     * Time at which a data stream was established for the provider.
+     */
+    providerDataStreamEstablished: number;
+    providerDataRequested?: never;
+});
+/**
+ * Object with timestamps that will be present in both successful and provider error responses
+ */
+declare type TimestampedResponseObject = {
+    /** Timestamps relevant for data provider timings */
+    timestamps: ResponseTimestamps;
+};
+/**
+ * Response from the EA to send when manually storing an error in the cache
  */
-export declare type AdapterResponse<T extends ResponseGenerics = ResponseGenerics> = {
-    /** HTTP status code */
+declare type ProviderErrorResponse = {
+    /** Status code for the errored response */
     statusCode: number;
+    /** Error message that will be sent back from the adapter */
+    errorMessage: string;
+} & {
+    data?: never;
+    result?: never;
+    meta?: never;
+};
+/**
+ * Provider error response with timestamps added
+ */
+export declare type TimestampedProviderErrorResponse = ProviderErrorResponse & TimestampedResponseObject;
+/**
+ * The most basic data that needs to be manually set for an adapter response.
+ */
+export declare type PartialSuccessfulResponse<T extends ResponseGenerics> = {
     /** Response data, holds "result" for Flux Monitor */
     data: T['Data'];
     /** Result value used for OCR */
     result: T['Result'];
-    /** Number detailing the maximum age of the result in the cache, will be replaced by telemetry eventually */
-    maxAge?: number;
+    /** Optionally, specify manually some of the timestamps here */
+    timestamps?: Pick<ResponseTimestamps, 'providerIndicatedTime'>;
+} & {
+    errorMessage?: never;
+};
+/**
+ * Partial EA response, with timestamps added
+ */
+declare type TimestampedSuccessfulResponse<T extends ResponseGenerics> = PartialSuccessfulResponse<T> & TimestampedResponseObject;
+/**
+ * Full EA successful response, with metadata and defaults added
+ */
+declare type SuccessfulResponse<T extends ResponseGenerics> = TimestampedSuccessfulResponse<T> & {
     /** Metadata relevant to this request */
     meta?: AdapterRequestMeta;
+    /** HTTP status code, by default will be set to 200 */
+    statusCode: number;
 };
+/**
+ * Response body from the EA, before timestamps, defaults and metadata are filled in
+ */
+export declare type PartialAdapterResponse<T extends ResponseGenerics = ResponseGenerics> = PartialSuccessfulResponse<T> | ProviderErrorResponse;
+/**
+ * Response body from the EA with timestamps, before defaults and metadata are filled in
+ */
+export declare type TimestampedAdapterResponse<T extends ResponseGenerics = ResponseGenerics> = TimestampedSuccessfulResponse<T> | TimestampedProviderErrorResponse;
+/**
+ * Shape of the response body from the adapter
+ */
+export declare type AdapterResponse<T extends ResponseGenerics = ResponseGenerics> = SuccessfulResponse<T> | TimestampedProviderErrorResponse;
 export declare type SingleNumberResultResponse = {
     Result: number;
     Data: {