@chainlink/external-adapter-framework 0.12.1 → 0.13.0

package/rate-limiting/metrics.js.map

@@ -1 +1 @@
-{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../../src/rate-limiting/metrics.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAqC;AAErC,8CAA8C;AAC9C,kCAAkC;AAC3B,MAAM,YAAY,GAAG,CAAuB,IAA0B,EAAU,EAAE;IACvF,MAAM,IAAI,GAAI,IAAgC,CAAC,MAAM,CAAC,CAAA;IACtD,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QACxD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAA;KACpB;SAAM;QACL,OAAO,CAAC,CAAA;KACT;AACH,CAAC,CAAA;AAPY,QAAA,YAAY,gBAOxB;AAEY,QAAA,0BAA0B,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IAC3D,IAAI,EAAE,gCAAgC;IACtC,IAAI,EAAE,8DAA8D;IACpE,UAAU,EAAE,CAAC,gBAAgB,EAAE,SAAS,CAAU;CACnD,CAAC,CAAA"}
+{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../../src/rate-limiting/metrics.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAqC;AAErC,8CAA8C;AAC9C,kCAAkC;AAC3B,MAAM,YAAY,GAAG,CAAuB,IAA0B,EAAU,EAAE;IACvF,MAAM,IAAI,GAAI,IAAgC,EAAE,CAAC,MAAM,CAAC,CAAA;IACxD,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QACxD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAA;KACpB;SAAM;QACL,OAAO,CAAC,CAAA;KACT;AACH,CAAC,CAAA;AAPY,QAAA,YAAY,gBAOxB;AAEY,QAAA,0BAA0B,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IAC3D,IAAI,EAAE,gCAAgC;IACtC,IAAI,EAAE,8DAA8D;IACpE,UAAU,EAAE,CAAC,gBAAgB,EAAE,SAAS,CAAU;CACnD,CAAC,CAAA"}

package/transports/abstract/streaming.d.ts

@@ -0,0 +1,34 @@
+import { TransportGenerics } from '..';
+import { EndpointContext } from '../../adapter';
+import { SubscriptionTransport } from './subscription';
+/**
+ * Object to carry details about the current subscriptions for a StreamingTransport.
+ */
+export declare type SubscriptionDeltas<T> = {
+    /** All the subscriptions that are valid at this point in time */
+    desired: T[];
+    /** The subscriptions that have not been processed yet (also included in the desired property) */
+    new: T[];
+    /** Subscriptions that have expired from the subscription set */
+    stale: T[];
+};
+/**
+ * Abstract Transport that will take incoming requests and add them to a subscription set as part
+ * of the registration. It also defines an abstract stream handler method, that will be called by the
+ * background execute and provided with calculated subscription deltas.
+ *
+ * @typeParam T - all types related to the [[Transport]]
+ */
+export declare abstract class StreamingTransport<T extends TransportGenerics> extends SubscriptionTransport<T> {
+    localSubscriptions: T['Request']['Params'][];
+    providerDataStreamEstablished: number;
+    backgroundHandler(context: EndpointContext<T>, desiredSubs: T['Request']['Params'][]): Promise<void>;
+    /**
+     * Abstract method that will be provided with context and subscription details, and should take care of
+     * handling the connection and messages sent to whatever streaming source is used.
+     *
+     * @param context - the context related to this background execution
+     * @param subscriptions - object containing details for the desired, new, and stale subscriptions
+     */
+    abstract streamHandler(context: EndpointContext<T>, subscriptions: SubscriptionDeltas<T['Request']['Params']>): Promise<void>;
+}

package/transports/abstract/streaming.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamingTransport = void 0;
+const util_1 = require("../../util");
+const subscription_1 = require("./subscription");
+const logger = (0, util_1.makeLogger)('StreamingTransport');
+/**
+ * Abstract Transport that will take incoming requests and add them to a subscription set as part
+ * of the registration. It also defines an abstract stream handler method, that will be called by the
+ * background execute and provided with calculated subscription deltas.
+ *
+ * @typeParam T - all types related to the [[Transport]]
+ */
+class StreamingTransport extends subscription_1.SubscriptionTransport {
+    constructor() {
+        super(...arguments);
+        // 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 only tracks when the connection was established, not when the subscription was requested
+        this.providerDataStreamEstablished = 0;
+    }
+    async backgroundHandler(context, desiredSubs) {
+        logger.debug('Generating delta (subscribes & unsubscribes)');
+        const subscriptions = {
+            desired: desiredSubs,
+            new: desiredSubs.filter((s) => !this.localSubscriptions.map((ls) => JSON.stringify(ls)).includes(JSON.stringify(s))),
+            stale: this.localSubscriptions.filter((s) => !desiredSubs.map((ds) => JSON.stringify(ds)).includes(JSON.stringify(s))),
+        };
+        logger.debug(`${subscriptions.new.length} new subscriptions; ${subscriptions.stale.length} to unsubscribe`);
+        if (subscriptions.new.length) {
+            logger.trace(`Will subscribe to: ${JSON.stringify(subscriptions.new)}`);
+        }
+        if (subscriptions.stale.length) {
+            logger.trace(`Will unsubscribe to: ${JSON.stringify(subscriptions.stale)}`);
+        }
+        await this.streamHandler(context, subscriptions);
+        logger.debug('Setting local state to subscription set value');
+        this.localSubscriptions = desiredSubs;
+        return;
+    }
+}
+exports.StreamingTransport = StreamingTransport;
+//# sourceMappingURL=streaming.js.map

package/transports/abstract/streaming.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streaming.js","sourceRoot":"","sources":["../../../../src/transports/abstract/streaming.ts"],"names":[],"mappings":";;;AAEA,qCAAuC;AACvC,iDAAsD;AAEtD,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,oBAAoB,CAAC,CAAA;AAgB/C;;;;;;GAMG;AACH,MAAsB,kBAEpB,SAAQ,oCAAwB;IAFlC;;QAGE,+FAA+F;QAC/F,iDAAiD;QACjD,uBAAkB,GAA6B,EAAE,CAAA;QAEjD,gGAAgG;QAChG,kCAA6B,GAAG,CAAC,CAAA;IA8CnC,CAAC;IA5CU,KAAK,CAAC,iBAAiB,CAC9B,OAA2B,EAC3B,WAAqC;QAErC,MAAM,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAA;QAC5D,MAAM,aAAa,GAAG;YACpB,OAAO,EAAE,WAAW;YACpB,GAAG,EAAE,WAAW,CAAC,MAAM,CACrB,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;YACD,KAAK,EAAE,IAAI,CAAC,kBAAkB,CAAC,MAAM,CACnC,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;SACF,CAAA;QAED,MAAM,CAAC,KAAK,CACV,GAAG,aAAa,CAAC,GAAG,CAAC,MAAM,uBAAuB,aAAa,CAAC,KAAK,CAAC,MAAM,iBAAiB,CAC9F,CAAA;QACD,IAAI,aAAa,CAAC,GAAG,CAAC,MAAM,EAAE;YAC5B,MAAM,CAAC,KAAK,CAAC,sBAAsB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;SACxE;QACD,IAAI,aAAa,CAAC,KAAK,CAAC,MAAM,EAAE;YAC9B,MAAM,CAAC,KAAK,CAAC,wBAAwB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;SAC5E;QAED,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;QAEhD,MAAM,CAAC,KAAK,CAAC,+CAA+C,CAAC,CAAA;QAC7D,IAAI,CAAC,kBAAkB,GAAG,WAAW,CAAA;QAErC,OAAM;IACR,CAAC;CAaF;AAtDD,gDAsDC"}

package/transports/abstract/subscription.d.ts

@@ -0,0 +1,38 @@
+import { EndpointContext } from '../../adapter';
+import { ResponseCache } from '../../cache/response';
+import { AdapterConfig } from '../../config';
+import { BackgroundExecuteRateLimiter } from '../../rate-limiting';
+import { SubscriptionSet } from '../../util';
+import { AdapterRequest } from '../../util/request';
+import { Transport, TransportDependencies, TransportGenerics } from '..';
+/**
+ * Abstract Transport that will take incoming requests and add them to a subscription set as part
+ * of the registration. Then it will provide those entries to the (abstract) backgroundHandler method.
+ *
+ * @typeParam T - all types related to the [[Transport]]
+ */
+export declare abstract class SubscriptionTransport<T extends TransportGenerics> implements Transport<T> {
+    responseCache: ResponseCache<{
+        Request: T['Request'];
+        Response: T['Response'];
+    }>;
+    rateLimiter: BackgroundExecuteRateLimiter;
+    subscriptionSet: SubscriptionSet<T['Request']['Params']>;
+    subscriptionTtl: number;
+    initialize(dependencies: TransportDependencies<T>, config: AdapterConfig<T['CustomSettings']>, endpointName: string): Promise<void>;
+    registerRequest(req: AdapterRequest<T['Request']>, _: AdapterConfig<T['CustomSettings']>): Promise<void>;
+    backgroundExecute(context: EndpointContext<T>): Promise<number>;
+    /**
+     * Handler specific to the subscription transport, that is provided all entries in the subscription set.
+     *
+     * @param context - background context for the execution of this handler
+     * @param entries - all the entries in the subscription set
+     */
+    abstract backgroundHandler(context: EndpointContext<T>, entries: T['Request']['Params'][]): Promise<void>;
+    /**
+     * Helper method to be defined in subclasses, for each of them to carry their own TTL definition in the EA config.
+     *
+     * @param config - the config for this adapter
+     */
+    abstract getSubscriptionTtlFromConfig(config: AdapterConfig<T['CustomSettings']>): number;
+}

package/transports/abstract/subscription.js

@@ -0,0 +1,63 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionTransport = void 0;
+const util_1 = require("../../util");
+const transportMetrics = __importStar(require("../metrics"));
+const logger = (0, util_1.makeLogger)('SubscriptionTransport');
+/**
+ * Abstract Transport that will take incoming requests and add them to a subscription set as part
+ * of the registration. Then it will provide those entries to the (abstract) backgroundHandler method.
+ *
+ * @typeParam T - all types related to the [[Transport]]
+ */
+class SubscriptionTransport {
+    async initialize(dependencies, config, endpointName) {
+        this.responseCache = dependencies.responseCache;
+        this.rateLimiter = dependencies.backgroundExecuteRateLimiter;
+        this.subscriptionSet = dependencies.subscriptionSetFactory.buildSet(endpointName);
+        this.subscriptionTtl = this.getSubscriptionTtlFromConfig(config); // Will be implemented by subclasses
+    }
+    async registerRequest(req, _) {
+        logger.debug(`Adding entry to subscription set (ttl ${this.subscriptionTtl}): [${req.requestContext.cacheKey}] = ${req.requestContext.data}`);
+        // This might need coalescing to avoid too frequent ttl updates
+        await this.subscriptionSet.add(req.requestContext.cacheKey, req.requestContext.data, this.subscriptionTtl);
+    }
+    async backgroundExecute(context) {
+        logger.debug('Starting background execute');
+        const entries = await this.subscriptionSet.getAll();
+        // Keep track of active subscriptions for background execute
+        // Note: for those coming from reasonable OOP languages, don't fret; this is JS:
+        // this.constructor.name will resolve to the instance name, not the class one (i.e., will use the implementing class' name)
+        transportMetrics.bgExecuteSubscriptionSetCount
+            .labels({ endpoint: context.endpointName, transport_type: this.constructor.name })
+            .set(entries.length);
+        const interval = this.rateLimiter.msUntilNextExecution(context.endpointName);
+        await this.backgroundHandler(context, entries);
+        return interval;
+    }
+}
+exports.SubscriptionTransport = SubscriptionTransport;
+//# sourceMappingURL=subscription.js.map

package/transports/abstract/subscription.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription.js","sourceRoot":"","sources":["../../../../src/transports/abstract/subscription.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,qCAAwD;AAGxD,6DAA8C;AAE9C,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,uBAAuB,CAAC,CAAA;AAElD;;;;;GAKG;AACH,MAAsB,qBAAqB;IASzC,KAAK,CAAC,UAAU,CACd,YAAsC,EACtC,MAA0C,EAC1C,YAAoB;QAEpB,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC,aAAa,CAAA;QAC/C,IAAI,CAAC,WAAW,GAAG,YAAY,CAAC,4BAA4B,CAAA;QAC5D,IAAI,CAAC,eAAe,GAAG,YAAY,CAAC,sBAAsB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;QACjF,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,4BAA4B,CAAC,MAAM,CAAC,CAAA,CAAC,oCAAoC;IACvG,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,GAAiC,EACjC,CAAqC;QAErC,MAAM,CAAC,KAAK,CACV,yCAAyC,IAAI,CAAC,eAAe,OAAO,GAAG,CAAC,cAAc,CAAC,QAAQ,OAAO,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAChI,CAAA;QAED,+DAA+D;QAC/D,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAC5B,GAAG,CAAC,cAAc,CAAC,QAAQ,EAC3B,GAAG,CAAC,cAAc,CAAC,IAAI,EACvB,IAAI,CAAC,eAAe,CACrB,CAAA;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,OAA2B;QACjD,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAA;QAC3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAA;QAEnD,4DAA4D;QAC5D,gFAAgF;QAChF,2HAA2H;QAC3H,gBAAgB,CAAC,6BAA6B;aAC3C,MAAM,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,YAAY,EAAE,cAAc,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;aACjF,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;QAEtB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;QAE5E,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAE9C,OAAO,QAAQ,CAAA;IACjB,CAAC;CAmBF;AAvED,sDAuEC"}

package/transports/batch-warming.d.ts

@@ -1,11 +1,9 @@
 import { AxiosRequestConfig, AxiosResponse } from 'axios';
-import { Cache } from '../cache';
+import { EndpointContext } from '../adapter';
 import { AdapterConfig } from '../config';
-import { BackgroundExecuteRateLimiter } from '../rate-limiting';
-import { SubscriptionSet } from '../util';
-import { AdapterRequest, AdapterResponse, ProviderResult } from '../util/request';
-import { Transport, TransportGenerics } from './';
-import { EndpointContext, AdapterDependencies } from '../adapter';
+import { AdapterRequest, ProviderResult } from '../util/request';
+import { TransportGenerics } from './';
+import { SubscriptionTransport } from './abstract/subscription';
 /**
  * Helper struct type that will be used to pass types to the generic parameters of a Transport.
  * Extends the common TransportGenerics, adding Provider specific types for this Batch endpoint.
@@ -42,16 +40,13 @@ export interface BatchWarmingTransportConfig<T extends BatchWarmingTransportGene
  *
  * @typeParam T - all types related to the [[Transport]]
  */
-export declare class BatchWarmingTransport<T extends BatchWarmingTransportGenerics> implements Transport<T> {
+export declare class BatchWarmingTransport<T extends BatchWarmingTransportGenerics> extends SubscriptionTransport<T> {
     private config;
-    cache: Cache<AdapterResponse<T['Response']>>;
-    rateLimiter: BackgroundExecuteRateLimiter;
-    subscriptionSet: SubscriptionSet<T['Request']['Params']>;
     WARMER_ACTIVE: boolean;
     constructor(config: BatchWarmingTransportConfig<T>);
-    initialize(dependencies: AdapterDependencies, _: AdapterConfig<T['CustomSettings']>, endpointName: string): Promise<void>;
+    getSubscriptionTtlFromConfig(config: AdapterConfig<T['CustomSettings']>): number;
     registerRequest(req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>): Promise<void>;
-    backgroundExecute(context: EndpointContext<T>): Promise<number>;
+    backgroundHandler(context: EndpointContext<T>, entries: T['Request']['Params'][]): Promise<void>;
     private makeRequest;
 }
 export {};

package/transports/batch-warming.js

@@ -24,13 +24,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BatchWarmingTransport = void 0;
-const util_1 = require("../util");
-const _1 = require("./");
-const util_2 = require("./util");
-const rateLimitMetrics = __importStar(require("../rate-limiting/metrics"));
 const cacheMetrics = __importStar(require("../cache/metrics"));
-const transportMetrics = __importStar(require("./metrics"));
+const rateLimitMetrics = __importStar(require("../rate-limiting/metrics"));
+const util_1 = require("../util");
 const error_1 = require("../validation/error");
+const subscription_1 = require("./abstract/subscription");
+const util_2 = require("./util");
 const WARMUP_BATCH_REQUEST_ID = '9002';
 const logger = (0, util_1.makeLogger)('BatchWarmingTransport');
 /**
@@ -43,21 +42,18 @@ const logger = (0, util_1.makeLogger)('BatchWarmingTransport');
  *
  * @typeParam T - all types related to the [[Transport]]
  */
-class BatchWarmingTransport {
+class BatchWarmingTransport extends subscription_1.SubscriptionTransport {
     constructor(config) {
+        super();
         this.config = config;
         // Flag used to track whether the warmer has moved from having no entries to having some and vice versa
         // Used for recording the cache warmer active metrics accurately
         this.WARMER_ACTIVE = false;
     }
-    async initialize(dependencies, _, endpointName) {
-        this.cache = dependencies.cache;
-        this.rateLimiter = dependencies.backgroundExecuteRateLimiter;
-        this.subscriptionSet = dependencies.subscriptionSetFactory.buildSet(endpointName);
+    getSubscriptionTtlFromConfig(config) {
+        return config.WARMUP_SUBSCRIPTION_TTL;
     }
-    // This might need coalescing to avoid too frequent ttl updates
     async registerRequest(req, config) {
-        logger.debug(`Adding entry to subscription set (ttl ${config.WARMUP_SUBSCRIPTION_TTL}): [${req.requestContext.cacheKey}] = ${req.requestContext.data}`);
         if (config.BATCH_TRANSPORT_SETUP_VALIDATION) {
             const response = await this.makeRequest([req.requestContext.data], config);
             if (!response.results.length) {
@@ -69,16 +65,9 @@ class BatchWarmingTransport {
                 });
             }
         }
-        await this.subscriptionSet.add(req.requestContext.cacheKey, req.requestContext.data, config.WARMUP_SUBSCRIPTION_TTL);
+        return super.registerRequest(req, config);
     }
-    async backgroundExecute(context) {
-        logger.debug('Starting background execute');
-        const entries = await this.subscriptionSet.getAll();
-        // Keep track of active subscriptions for background execute
-        transportMetrics.bgExecuteSubscriptionSetCount
-            .labels({ endpoint: context.endpointName, transport_type: 'batch' })
-            .set(entries.length);
-        const interval = this.rateLimiter.msUntilNextExecution(context.endpointName);
+    async backgroundHandler(context, entries) {
         if (!entries.length) {
             logger.debug('No entries in batch warming set, skipping');
             if (this.WARMER_ACTIVE) {
@@ -86,7 +75,7 @@ class BatchWarmingTransport {
                 cacheMetrics.cacheWarmerCount.labels({ isBatched: 'true' }).dec();
                 this.WARMER_ACTIVE = false;
             }
-            return interval;
+            return;
         }
         else if (this.WARMER_ACTIVE === false) {
             // Increment count when warmer changed from having no entries to having some
@@ -95,11 +84,10 @@ class BatchWarmingTransport {
         }
         const response = await this.makeRequest(entries, context.adapterConfig);
         if (!response.results?.length) {
-            return interval;
+            return;
         }
-        const cacheEntries = (0, _1.buildCacheEntriesFromResults)(response.results, context);
         logger.debug('Setting adapter responses in cache');
-        await this.cache.setMany(cacheEntries, context.adapterConfig.CACHE_MAX_AGE);
+        await this.responseCache.write(response.results);
         // Record cost of data provider call
         const cost = rateLimitMetrics.retrieveCost(response.providerResponse.data);
         rateLimitMetrics.rateLimitCreditsSpentTotal
@@ -108,26 +96,52 @@ class BatchWarmingTransport {
             participant_id: WARMUP_BATCH_REQUEST_ID,
         })
             .inc(cost);
-        return interval;
+        return;
     }
     async makeRequest(entries, config) {
         logger.trace(`Have ${entries.length} entries in batch, preparing request...`);
         const request = this.config.prepareRequest(entries, config);
         logger.trace(`Sending request to data provider: ${JSON.stringify(request)}`);
+        const providerDataRequested = Date.now();
         let providerResponse;
         try {
             providerResponse = await (0, util_2.axiosRequest)(request, config);
         }
         catch (e) {
+            const err = e.cause;
+            const providerDataReceived = Date.now();
             logger.warn(`There was an error while performing the batch request: ${e}`);
             return {
-                results: [],
+                results: entries.map((entry) => ({
+                    params: entry,
+                    response: {
+                        errorMessage: `Provider request failed with status ${err?.status}: "${err?.response?.data}"`,
+                        statusCode: 502,
+                        timestamps: {
+                            providerDataRequested,
+                            providerDataReceived,
+                            providerIndicatedTime: undefined,
+                        },
+                    },
+                })),
                 providerResponse: e,
             };
         }
+        const providerDataReceived = Date.now();
+        // Parse responses and apply timestamps
+        const results = this.config.parseResponse(entries, providerResponse, config).map((r) => {
+            const result = r;
+            const partialResponse = r.response;
+            result.response.timestamps = {
+                providerDataRequested,
+                providerDataReceived,
+                providerIndicatedTime: partialResponse.timestamps?.providerIndicatedTime,
+            };
+            return result;
+        });
         logger.debug(`Got response from provider, parsing (raw body: ${providerResponse.data})`);
         return {
-            results: this.config.parseResponse(entries, providerResponse, config),
+            results,
             providerResponse,
         };
     }

package/transports/batch-warming.js.map

@@ -1 +1 @@
-{"version":3,"file":"batch-warming.js","sourceRoot":"","sources":["../../../src/transports/batch-warming.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,kCAAqD;AAErD,yBAA+E;AAC/E,iCAAqC;AACrC,2EAA4D;AAC5D,+DAAgD;AAEhD,4DAA6C;AAC7C,+CAAkD;AAElD,MAAM,uBAAuB,GAAG,MAAM,CAAA;AAEtC,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,uBAAuB,CAAC,CAAA;AAsClD;;;;;;;;;GASG;AACH,MAAa,qBAAqB;IAWhC,YAAoB,MAAsC;QAAtC,WAAM,GAAN,MAAM,CAAgC;QAJ1D,uGAAuG;QACvG,gEAAgE;QAChE,kBAAa,GAAG,KAAK,CAAA;IAEwC,CAAC;IAE9D,KAAK,CAAC,UAAU,CACd,YAAiC,EACjC,CAAqC,EACrC,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,+DAA+D;IAC/D,KAAK,CAAC,eAAe,CACnB,GAAiC,EACjC,MAA0C;QAE1C,MAAM,CAAC,KAAK,CACV,yCAAyC,MAAM,CAAC,uBAAuB,OAAO,GAAG,CAAC,cAAc,CAAC,QAAQ,OAAO,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAC1I,CAAA;QAED,IAAI,MAAM,CAAC,gCAAgC,EAAE;YAC3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAA;YAE1E,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE;gBAC5B,MAAM,IAAI,oBAAY,CAAC;oBACrB,UAAU,EAAE,GAAG;oBACf,kBAAkB,EAAE,QAAQ,CAAC,gBAAgB,CAAC,MAAM;oBACpD,OAAO,EACJ,QAAQ,CAAC,gBAAqC,CAAC,OAAO;wBACvD,sGAAsG;iBACzG,CAAC,CAAA;aACH;SACF;QAED,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAC5B,GAAG,CAAC,cAAc,CAAC,QAAQ,EAC3B,GAAG,CAAC,cAAc,CAAC,IAAI,EACvB,MAAM,CAAC,uBAAuB,CAC/B,CAAA;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,OAA2B;QACjD,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAA;QAC3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAA;QAEnD,4DAA4D;QAC5D,gBAAgB,CAAC,6BAA6B;aAC3C,MAAM,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,YAAY,EAAE,cAAc,EAAE,OAAO,EAAE,CAAC;aACnE,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;QAEtB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;QAE5E,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YACnB,MAAM,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAA;YACzD,IAAI,IAAI,CAAC,aAAa,EAAE;gBACtB,yEAAyE;gBACzE,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,CAAA;gBACjE,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;aAC3B;YACD,OAAO,QAAQ,CAAA;SAChB;aAAM,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,EAAE;YACvC,4EAA4E;YAC5E,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,CAAA;YACjE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAA;SAC1B;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,CAAA;QAEvE,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE;YAC7B,OAAO,QAAQ,CAAA;SAChB;QAED,MAAM,YAAY,GAAG,IAAA,+BAA4B,EAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAE5E,MAAM,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAA;QAClD,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,CAAA;QAE3E,oCAAoC;QACpC,MAAM,IAAI,GAAG,gBAAgB,CAAC,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;QAC1E,gBAAgB,CAAC,0BAA0B;aACxC,MAAM,CAAC;YACN,OAAO,EAAE,KAAK;YACd,cAAc,EAAE,uBAAuB;SACxC,CAAC;aACD,GAAG,CAAC,IAAI,CAAC,CAAA;QAEZ,OAAO,QAAQ,CAAA;IACjB,CAAC;IAEO,KAAK,CAAC,WAAW,CACvB,OAAiC,EACjC,MAA0C;QAK1C,MAAM,CAAC,KAAK,CAAC,QAAQ,OAAO,CAAC,MAAM,yCAAyC,CAAC,CAAA;QAC7E,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QAE3D,MAAM,CAAC,KAAK,CAAC,qCAAqC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAC5E,IAAI,gBAAgB,CAAA;QACpB,IAAI;YACF,gBAAgB,GAAG,MAAM,IAAA,mBAAY,EAInC,OAAO,EAAE,MAAM,CAAC,CAAA;SACnB;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,CAAC,IAAI,CAAC,0DAA0D,CAAC,EAAE,CAAC,CAAA;YAC1E,OAAO;gBACL,OAAO,EAAE,EAAE;gBACX,gBAAgB,EAAE,CAAkB;aACrC,CAAA;SACF;QAED,MAAM,CAAC,KAAK,CAAC,kDAAkD,gBAAgB,CAAC,IAAI,GAAG,CAAC,CAAA;QACxF,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,CAAC;YACrE,gBAAgB;SACjB,CAAA;IACH,CAAC;CACF;AArID,sDAqIC"}
+{"version":3,"file":"batch-warming.js","sourceRoot":"","sources":["../../../src/transports/batch-warming.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,+DAAgD;AAEhD,2EAA4D;AAC5D,kCAAoC;AAOpC,+CAA4E;AAE5E,0DAA+D;AAC/D,iCAAqC;AAErC,MAAM,uBAAuB,GAAG,MAAM,CAAA;AAEtC,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,uBAAuB,CAAC,CAAA;AAsClD;;;;;;;;;GASG;AACH,MAAa,qBAEX,SAAQ,oCAAwB;IAKhC,YAAoB,MAAsC;QACxD,KAAK,EAAE,CAAA;QADW,WAAM,GAAN,MAAM,CAAgC;QAJ1D,uGAAuG;QACvG,gEAAgE;QAChE,kBAAa,GAAG,KAAK,CAAA;IAIrB,CAAC;IAED,4BAA4B,CAAC,MAA0C;QACrE,OAAO,MAAM,CAAC,uBAAuB,CAAA;IACvC,CAAC;IAEQ,KAAK,CAAC,eAAe,CAC5B,GAAiC,EACjC,MAA0C;QAE1C,IAAI,MAAM,CAAC,gCAAgC,EAAE;YAC3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAA;YAE1E,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE;gBAC5B,MAAM,IAAI,oBAAY,CAAC;oBACrB,UAAU,EAAE,GAAG;oBACf,kBAAkB,EAAE,QAAQ,CAAC,gBAAgB,CAAC,MAAM;oBACpD,OAAO,EACJ,QAAQ,CAAC,gBAAqC,CAAC,OAAO;wBACvD,sGAAsG;iBACzG,CAAC,CAAA;aACH;SACF;QAED,OAAO,KAAK,CAAC,eAAe,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;IAC3C,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,OAA2B,EAC3B,OAAiC;QAEjC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YACnB,MAAM,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAA;YACzD,IAAI,IAAI,CAAC,aAAa,EAAE;gBACtB,yEAAyE;gBACzE,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,CAAA;gBACjE,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;aAC3B;YACD,OAAM;SACP;aAAM,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,EAAE;YACvC,4EAA4E;YAC5E,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,CAAA;YACjE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAA;SAC1B;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,CAAA;QAEvE,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE;YAC7B,OAAM;SACP;QAED,MAAM,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAA;QAClD,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;QAEhD,oCAAoC;QACpC,MAAM,IAAI,GAAG,gBAAgB,CAAC,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;QAC1E,gBAAgB,CAAC,0BAA0B;aACxC,MAAM,CAAC;YACN,OAAO,EAAE,KAAK;YACd,cAAc,EAAE,uBAAuB;SACxC,CAAC;aACD,GAAG,CAAC,IAAI,CAAC,CAAA;QAEZ,OAAM;IACR,CAAC;IAEO,KAAK,CAAC,WAAW,CACvB,OAAiC,EACjC,MAA0C;QAK1C,MAAM,CAAC,KAAK,CAAC,QAAQ,OAAO,CAAC,MAAM,yCAAyC,CAAC,CAAA;QAC7E,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QAE3D,MAAM,CAAC,KAAK,CAAC,qCAAqC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAC5E,MAAM,qBAAqB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACxC,IAAI,gBAAgB,CAAA;QACpB,IAAI;YACF,gBAAgB,GAAG,MAAM,IAAA,mBAAY,EAInC,OAAO,EAAE,MAAM,CAAC,CAAA;SACnB;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,GAAG,GAAI,CAA8B,CAAC,KAA+B,CAAA;YAC3E,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;YACvC,MAAM,CAAC,IAAI,CAAC,0DAA0D,CAAC,EAAE,CAAC,CAAA;YAC1E,OAAO;gBACL,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;oBAC/B,MAAM,EAAE,KAAK;oBACb,QAAQ,EAAE;wBACR,YAAY,EAAE,uCAAuC,GAAG,EAAE,MAAM,MAAM,GAAG,EAAE,QAAQ,EAAE,IAAI,GAAG;wBAC5F,UAAU,EAAE,GAAG;wBACf,UAAU,EAAE;4BACV,qBAAqB;4BACrB,oBAAoB;4BACpB,qBAAqB,EAAE,SAAS;yBACjC;qBACF;iBACF,CAAC,CAAC;gBACH,gBAAgB,EAAE,CAAkB;aACrC,CAAA;SACF;QACD,MAAM,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAEvC,uCAAuC;QACvC,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACrF,MAAM,MAAM,GAAG,CAAiC,CAAA;YAChD,MAAM,eAAe,GAAG,CAAC,CAAC,QAAoD,CAAA;YAC9E,MAAM,CAAC,QAAQ,CAAC,UAAU,GAAG;gBAC3B,qBAAqB;gBACrB,oBAAoB;gBACpB,qBAAqB,EAAE,eAAe,CAAC,UAAU,EAAE,qBAAqB;aACzE,CAAA;YACD,OAAO,MAAM,CAAA;QACf,CAAC,CAAC,CAAA;QAEF,MAAM,CAAC,KAAK,CAAC,kDAAkD,gBAAgB,CAAC,IAAI,GAAG,CAAC,CAAA;QACxF,OAAO;YACL,OAAO;YACP,gBAAgB;SACjB,CAAA;IACH,CAAC;CACF;AAtID,sDAsIC"}

package/transports/index.d.ts

@@ -1,7 +1,7 @@
-import { EndpointContext, AdapterDependencies } from '../adapter';
-import { Cache, CacheEntry } from '../cache';
+import { AdapterDependencies, EndpointContext } from '../adapter';
+import { ResponseCache } from '../cache/response';
 import { AdapterConfig, SettingsMap } from '../config';
-import { AdapterRequest, AdapterResponse, ProviderResult, RequestGenerics, ResponseGenerics } from '../util/request';
+import { AdapterRequest, AdapterResponse, RequestGenerics, ResponseGenerics } from '../util/request';
 export * from './batch-warming';
 export * from './rest';
 export * from './sse';
@@ -28,6 +28,18 @@ export declare type TransportGenerics = {
      */
     CustomSettings: SettingsMap;
 };
+/**
+ * Extended dependencies with necessary tools for a transport
+ */
+export declare type TransportDependencies<T extends TransportGenerics> = AdapterDependencies & {
+    /**
+     * Cache that will be used to write responses that the Transport will return
+     */
+    responseCache: ResponseCache<{
+        Request: T['Request'];
+        Response: T['Response'];
+    }>;
+};
 /**
  * Generic interface for a Transport.
  * A Transport defines the way in which an AdapterEndpoint will process incoming requests to
@@ -39,7 +51,10 @@ export declare type TransportGenerics = {
  * @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[TransportGenerics]])
  */
 export interface Transport<T extends TransportGenerics> {
-    cache?: Cache<AdapterResponse<T['Response']>>;
+    responseCache: ResponseCache<{
+        Request: T['Request'];
+        Response: T['Response'];
+    }>;
     /**
      * Initializes the transport in the Adapter context.
      *
@@ -47,7 +62,7 @@ export interface Transport<T extends TransportGenerics> {
      * @param config - Adapter config containing env vars
      * @returns an empty Promise
      */
-    initialize: (dependencies: AdapterDependencies, config: AdapterConfig<T['CustomSettings']>, endpointName: string) => Promise<void>;
+    initialize: (dependencies: TransportDependencies<T>, config: AdapterConfig<T['CustomSettings']>, endpointName: string) => Promise<void>;
     /**
      * Registers a request within the context of the transport.
      * This means things like adding the request to a subscription set.
@@ -98,11 +113,3 @@ export interface MetaTransport<T extends TransportGenerics> extends Transport<T>
         [key: string]: Transport<T>;
     };
 }
-/**
- * Helper method to build cache entries to set after getting a bunch of responses from a DP.
- *
- * @param results - a list of results coming from a DataProvider
- * @param context - context for the Adapter
- * @returns a list of CacheEntries of AdapterResponses
- */
-export declare const buildCacheEntriesFromResults: <T extends TransportGenerics>(results: ProviderResult<T>[], context: EndpointContext<T>) => CacheEntry<AdapterResponse<T["Response"]>>[];

package/transports/index.js

@@ -14,43 +14,8 @@ 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 });
-exports.buildCacheEntriesFromResults = void 0;
-const cache_1 = require("../cache");
 __exportStar(require("./batch-warming"), exports);
 __exportStar(require("./rest"), exports);
 __exportStar(require("./sse"), exports);
 __exportStar(require("./websocket"), exports);
-/**
- * Helper method to build cache entries to set after getting a bunch of responses from a DP.
- *
- * @param results - a list of results coming from a DataProvider
- * @param context - context for the Adapter
- * @returns a list of CacheEntries of AdapterResponses
- */
-const buildCacheEntriesFromResults = (results, context) => results.map((r) => {
-    const cacheEntry = {
-        key: (0, cache_1.calculateCacheKey)(context, r.params),
-        value: {
-            result: r.value,
-            statusCode: 200,
-            data: {
-                result: r.value,
-            },
-        },
-    };
-    if (context.adapterConfig.METRICS_ENABLED &&
-        context.adapterConfig.EXPERIMENTAL_METRICS_ENABLED) {
-        const metrics = {
-            maxAge: Date.now() + context.adapterConfig.CACHE_MAX_AGE,
-            meta: {
-                metrics: {
-                    feedId: (0, cache_1.calculateFeedId)(context, r.params),
-                },
-            },
-        };
-        cacheEntry.value = { ...cacheEntry.value, ...metrics };
-    }
-    return cacheEntry;
-});
-exports.buildCacheEntriesFromResults = buildCacheEntriesFromResults;
 //# sourceMappingURL=index.js.map

package/transports/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/transports/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AACA,oCAAgF;AAUhF,kDAA+B;AAC/B,yCAAsB;AACtB,wCAAqB;AACrB,8CAA2B;AAgH3B;;;;;;GAMG;AACI,MAAM,4BAA4B,GAAG,CAC1C,OAA4B,EAC5B,OAA2B,EACmB,EAAE,CAChD,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;IAChB,MAAM,UAAU,GAAG;QACjB,GAAG,EAAE,IAAA,yBAAiB,EAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;QACzC,KAAK,EAAE;YACL,MAAM,EAAE,CAAC,CAAC,KAAK;YACf,UAAU,EAAE,GAAG;YACf,IAAI,EAAE;gBACJ,MAAM,EAAE,CAAC,CAAC,KAAK;aAChB;SACF;KACF,CAAA;IAED,IACE,OAAO,CAAC,aAAa,CAAC,eAAe;QACrC,OAAO,CAAC,aAAa,CAAC,4BAA4B,EAClD;QACA,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC,aAAa;YACxD,IAAI,EAAE;gBACJ,OAAO,EAAE;oBACP,MAAM,EAAE,IAAA,uBAAe,EAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;iBAC3C;aACF;SACF,CAAA;QACD,UAAU,CAAC,KAAK,GAAG,EAAE,GAAG,UAAU,CAAC,KAAK,EAAE,GAAG,OAAO,EAAE,CAAA;KACvD;IACD,OAAO,UAAU,CAAA;AACnB,CAAC,CAAC,CAAA;AA/BS,QAAA,4BAA4B,gCA+BrC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/transports/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAKA,kDAA+B;AAC/B,yCAAsB;AACtB,wCAAqB;AACrB,8CAA2B"}

package/transports/metrics.d.ts

@@ -1,6 +1,8 @@
 import * as client from 'prom-client';
 import { TransportGenerics } from '.';
 import { EndpointContext } from '../adapter';
+import { AdapterConfig } from '../config';
+import { InputParameters } from '../validation';
 export declare const dataProviderMetricsLabel: (providerStatusCode?: number, method?: string) => {
     provider_status_code: number | undefined;
     method: string;
@@ -10,16 +12,21 @@ export declare const dataProviderRequestDurationSeconds: client.Histogram<string
 export declare const connectionErrorLabels: (message: string) => {
     message: string;
 };
-export declare const messageSubsLabels: (feed_id: string, cache_key: string) => {
+export declare type MessageDirection = 'sent' | 'received';
+export declare const messageSubsLabels: <T extends TransportGenerics>(context: {
+    inputParameters: InputParameters;
+    endpointName: string;
+    adapterConfig: AdapterConfig<T["CustomSettings"]>;
+}, params: T["Request"]["Params"]) => {
     feed_id: string;
     subscription_key: string;
 };
 export declare const recordWsMessageMetrics: <T extends TransportGenerics>(context: EndpointContext<T>, subscribes: T["Request"]["Params"][], unsubscribes: T["Request"]["Params"][]) => void;
 export declare const wsConnectionActive: client.Gauge<"url">;
 export declare const wsConnectionErrors: client.Counter<"message" | "url">;
-export declare const wsSubscriptionActive: client.Gauge<"feed_id" | "connection_url" | "subscription_key">;
-export declare const wsSubscriptionTotal: client.Counter<"feed_id" | "connection_url" | "subscription_key">;
-export declare const wsMessageTotal: client.Counter<"feed_id" | "subscription_key">;
+export declare const wsSubscriptionActive: client.Gauge<"feed_id" | "subscription_key" | "connection_url">;
+export declare const wsSubscriptionTotal: client.Counter<"feed_id" | "subscription_key" | "connection_url">;
+export declare const wsMessageTotal: client.Counter<"direction" | "feed_id" | "subscription_key">;
 export declare const bgExecuteSubscriptionSetCount: client.Gauge<"endpoint" | "transport_type">;
 export declare const transportPollingFailureCount: client.Counter<"endpoint">;
 export declare const transportPollingDurationSeconds: client.Gauge<"succeeded" | "endpoint">;

package/transports/metrics.js

@@ -49,32 +49,42 @@ const connectionErrorLabels = (message) => ({
     message,
 });
 exports.connectionErrorLabels = connectionErrorLabels;
-const messageSubsLabels = (feed_id, cache_key) => ({
-    feed_id,
-    subscription_key: cache_key,
-});
+const messageSubsLabels = (context, params) => {
+    const feedId = (0, cache_1.calculateFeedId)(context, params);
+    const cacheKey = (0, cache_1.calculateCacheKey)(context, params);
+    return {
+        feed_id: feedId,
+        subscription_key: cacheKey,
+    };
+};
 exports.messageSubsLabels = messageSubsLabels;
 // Record WS message and subscription metrics
 // Recalculate cacheKey and feedId for metrics
 // since avoiding storing extra info in expiring sorted set
 const recordWsMessageMetrics = (context, subscribes, unsubscribes) => {
-    subscribes.forEach((param) => {
-        const feedId = (0, cache_1.calculateFeedId)(context, param);
-        const cacheKey = (0, cache_1.calculateCacheKey)(context, param);
+    const recordMetrics = (params, type) => {
+        const baseLabels = (0, exports.messageSubsLabels)(context, params);
         // Record total number of ws messages sent
-        exports.wsMessageTotal.labels((0, exports.messageSubsLabels)(feedId, cacheKey)).inc();
+        exports.wsMessageTotal
+            .labels({
+            ...baseLabels,
+            direction: 'sent',
+        })
+            .inc();
         // Record total number of subscriptions made
-        exports.wsSubscriptionTotal.labels((0, exports.messageSubsLabels)(feedId, cacheKey)).inc();
-        // Record number of active ws subscriptions
-        exports.wsSubscriptionActive.labels((0, exports.messageSubsLabels)(feedId, cacheKey)).inc();
+        if (type === 'sub') {
+            exports.wsSubscriptionTotal.labels(baseLabels).inc();
+            exports.wsSubscriptionActive.labels(baseLabels).inc();
+        }
+        else {
+            exports.wsSubscriptionActive.labels(baseLabels).dec();
+        }
+    };
+    subscribes.forEach((params) => {
+        recordMetrics(params, 'sub');
     });
-    unsubscribes.forEach((param) => {
-        const feedId = (0, cache_1.calculateFeedId)(context, param);
-        const cacheKey = (0, cache_1.calculateCacheKey)(context, param);
-        // Record total number of ws messages sent
-        exports.wsMessageTotal.labels((0, exports.messageSubsLabels)(feedId, cacheKey)).inc();
-        // Record number of active ws subscriptions
-        exports.wsSubscriptionActive.labels((0, exports.messageSubsLabels)(feedId, cacheKey)).dec();
+    unsubscribes.forEach((params) => {
+        recordMetrics(params, 'unsub');
     });
 };
 exports.recordWsMessageMetrics = recordWsMessageMetrics;
@@ -100,8 +110,8 @@ exports.wsSubscriptionTotal = new client.Counter({
 });
 exports.wsMessageTotal = new client.Counter({
     name: 'ws_message_total',
-    help: 'The number of messages received in total',
-    labelNames: ['feed_id', 'subscription_key'],
+    help: 'The number of messages sent in total',
+    labelNames: ['feed_id', 'subscription_key', 'direction'],
 });
 // V3 specific metrics
 exports.bgExecuteSubscriptionSetCount = new client.Gauge({