@chainlink/external-adapter-framework 0.5.0 → 0.5.2

package/transports/batch-warming.d.ts

@@ -0,0 +1,53 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { Cache } from '../cache';
+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 { AdapterContext, AdapterDependencies } from '../adapter';
+/**
+ * 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.
+ */
+declare type BatchWarmingTransportGenerics = TransportGenerics & {
+    /**
+     * Type details for any provider specific interfaces.
+     */
+    Provider: {
+        /**
+         * Structure of the body of the request that will be sent to the data provider.
+         */
+        RequestBody: unknown;
+        /**
+         * Structure for the body of the response coming from the data provider.
+         */
+        ResponseBody: unknown;
+    };
+};
+/**
+ * Transport implementation that takes incoming batches requests and keeps a warm cache of values.
+ * Within the setup function, adapter params are added to an set that also keeps track and expires values.
+ * In the background execute, the list of non-expired items in the set is fetched.
+ * Then, the list is passed through the `prepareRequest` function, that returns an AxiosRequestConfig.
+ * The Data Provider response is, they are passed through the `parseResponse` function to create a [[CacheEntry]] list.
+ * Finally, the items in that [[CacheEntry]] list are set in the Cache so the Adapter can fetch values from there.
+ *
+ * @typeParam T - all types related to the [[Transport]]
+ */
+export declare class BatchWarmingTransport<T extends BatchWarmingTransportGenerics> implements Transport<T> {
+    private config;
+    cache: Cache<AdapterResponse<T['Response']>>;
+    rateLimiter: BackgroundExecuteRateLimiter;
+    subscriptionSet: SubscriptionSet<T['Request']['Params']>;
+    WARMER_ACTIVE: boolean;
+    constructor(config: {
+        prepareRequest: (params: T['Request']['Params'][], config: AdapterConfig<T['CustomSettings']>) => AxiosRequestConfig<T['Provider']['RequestBody']>;
+        parseResponse: (params: T['Request']['Params'][], res: AxiosResponse<T['Provider']['ResponseBody']>, config: AdapterConfig<T['CustomSettings']>) => ProviderResult<T>[];
+    });
+    initialize(dependencies: AdapterDependencies, _: AdapterConfig<T['CustomSettings']>, endpointName: string): Promise<void>;
+    registerRequest(req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>): Promise<void>;
+    backgroundExecute(context: AdapterContext<T>): Promise<number>;
+    private makeRequest;
+}
+export {};

package/transports/batch-warming.js

@@ -0,0 +1,136 @@
+"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.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 error_1 = require("../validation/error");
+const WARMUP_BATCH_REQUEST_ID = '9002';
+const logger = (0, util_1.makeLogger)('BatchWarmingTransport');
+/**
+ * Transport implementation that takes incoming batches requests and keeps a warm cache of values.
+ * Within the setup function, adapter params are added to an set that also keeps track and expires values.
+ * In the background execute, the list of non-expired items in the set is fetched.
+ * Then, the list is passed through the `prepareRequest` function, that returns an AxiosRequestConfig.
+ * The Data Provider response is, they are passed through the `parseResponse` function to create a [[CacheEntry]] list.
+ * Finally, the items in that [[CacheEntry]] list are set in the Cache so the Adapter can fetch values from there.
+ *
+ * @typeParam T - all types related to the [[Transport]]
+ */
+class BatchWarmingTransport {
+    constructor(config) {
+        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);
+    }
+    // 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) {
+                throw new error_1.AdapterError({
+                    statusCode: 200,
+                    providerStatusCode: response.providerResponse.status,
+                    message: response.providerResponse.message ||
+                        'There was an error while validating the incoming request before adding to the batch subscription set',
+                });
+            }
+        }
+        await this.subscriptionSet.add(req.requestContext.cacheKey, req.requestContext.data, config.WARMUP_SUBSCRIPTION_TTL);
+    }
+    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.adapterEndpoint.name, transport_type: 'batch' })
+            .set(entries.length);
+        const interval = this.rateLimiter.msUntilNextExecution(context.adapterEndpoint.name);
+        if (!entries.length) {
+            logger.debug('No entries in batch warming set, skipping');
+            if (this.WARMER_ACTIVE) {
+                // Decrement count when warmer changed from having entries to having none
+                cacheMetrics.cacheWarmerCount.labels({ isBatched: 'true' }).dec();
+                this.WARMER_ACTIVE = false;
+            }
+            return interval;
+        }
+        else if (this.WARMER_ACTIVE === false) {
+            // Increment count when warmer changed from having no entries to having some
+            cacheMetrics.cacheWarmerCount.labels({ isBatched: 'true' }).inc();
+            this.WARMER_ACTIVE = true;
+        }
+        const response = await this.makeRequest(entries, context.adapterConfig);
+        if (!response.results?.length) {
+            return interval;
+        }
+        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);
+        // Record cost of data provider call
+        const cost = rateLimitMetrics.retrieveCost(response.providerResponse.data);
+        rateLimitMetrics.rateLimitCreditsSpentTotal
+            .labels({
+            feed_id: 'N/A',
+            participant_id: WARMUP_BATCH_REQUEST_ID,
+        })
+            .inc(cost);
+        return interval;
+    }
+    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)}`);
+        let providerResponse;
+        try {
+            providerResponse = await (0, util_2.axiosRequest)(request, config);
+        }
+        catch (e) {
+            logger.warn(`There was an error while performing the batch request: ${e}`);
+            return {
+                results: [],
+                providerResponse: e,
+            };
+        }
+        logger.debug(`Got response from provider, parsing (raw body: ${providerResponse.data})`);
+        return {
+            results: this.config.parseResponse(entries, providerResponse, config),
+            providerResponse,
+        };
+    }
+}
+exports.BatchWarmingTransport = BatchWarmingTransport;
+//# sourceMappingURL=batch-warming.js.map

package/transports/batch-warming.js.map

@@ -0,0 +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;AAuBlD;;;;;;;;;GASG;AACH,MAAa,qBAAqB;IAWhC,YACU,MAUP;QAVO,WAAM,GAAN,MAAM,CAUb;QAfH,uGAAuG;QACvG,gEAAgE;QAChE,kBAAa,GAAG,KAAK,CAAA;IAclB,CAAC;IAEJ,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,OAA0B;QAChD,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,eAAe,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,CAAC;aAC3E,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;QAEtB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;QAEpF,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;AAjJD,sDAiJC"}

package/transports/index.d.ts

@@ -0,0 +1,108 @@
+import { AdapterContext, AdapterDependencies } from '../adapter';
+import { Cache, CacheEntry } from '../cache';
+import { AdapterConfig, SettingsMap } from '../config';
+import { AdapterRequest, AdapterResponse, ProviderResult, RequestGenerics, ResponseGenerics } from '../util/request';
+export * from './batch-warming';
+export * from './rest';
+export * from './sse';
+export * from './websocket';
+/**
+ * Helper struct type that will be used to pass types to the generic parameters of a Transport.
+ * Within the transport, given a generic param T extends TransportGenerics, these will be used like so:
+ *
+ * const request: AdapterRequest\<T['Request']\> = ...
+ *
+ * (ignore the slash characters, they're just for proper doc syntax \<)
+ */
+export declare type TransportGenerics = {
+    /**
+     * Type details about incoming Adapter requests to this Transport
+     */
+    Request: RequestGenerics;
+    /**
+     * Type details about outbound responses from this Transport
+     */
+    Response: ResponseGenerics;
+    /**
+     * Type for any custom settings used for this Transport
+     */
+    CustomSettings: SettingsMap;
+};
+/**
+ * Generic interface for a Transport.
+ * A Transport defines the way in which an AdapterEndpoint will process incoming requests to
+ * fetch data from a Data Provider. The setup phase will take care of the former, while the
+ * backgroundExecute will be in charge of the latter.
+ * This separation gives us the ability of splitting these concerns, and optionally parallelizing
+ * the reading and writing of data to a centralized Cache.
+ *
+ * @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']>>;
+    /**
+     * Initializes the transport in the Adapter context.
+     *
+     * @param dependencies - Adapter dependencies (e.g. cache instance)
+     * @param config - Adapter config containing env vars
+     * @returns an empty Promise
+     */
+    initialize: (dependencies: AdapterDependencies, 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.
+     *
+     * @param req - the incoming AdapterRequest
+     * @param config - common configuration for the Adapter as a whole
+     * @returns an empty Promise
+     */
+    registerRequest?: (req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>) => Promise<void>;
+    /**
+     * Performs a synchronous fetch/processing of information within the lifecycle of an incoming request.
+     * This is mostly intended to be used as a backwards compatibility mechanism, or for very specific cases where
+     * processing is expected to be very simple. Things like rate limiting for example won't be able to be applied
+     * to this method with more than one EA instance. It's heavily encouraged to instead rework adapter logic
+     * to perform as much of the work as possible (or all of it) in the backgroundExecute method.
+     *
+     * @param req - the incoming AdapterRequest
+     * @param config - common configuration for the Adapter as a whole
+     * @returns a Promise that _optionally_ returns an AdapterResponse, if the Transport has the capability of
+     *   immediately fetching data and returning it without the background process.
+     */
+    foregroundExecute?: (req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>) => Promise<AdapterResponse<{
+        Data: T['Response']['Data'];
+        Result: T['Response']['Result'];
+    }> | void>;
+    /**
+     * Main function that will be called by the main background loop of the writer EA.
+     * All logic fetching from providers should live here.
+     *
+     * @param context - background context for the execution (e.g. endpoint name)
+     * @returns an empty Promise
+     */
+    backgroundExecute?: (context: AdapterContext<T>) => Promise<number>;
+}
+/**
+ * Generic interface for a Transport that contains or manages other transports.
+ * Some transports, such as the RoutingTransport, do not directly fetch data from a Data Provider, but
+ * instead coordinate the execution of other transports for fetching and transforming data.
+ * These transports have alternative initialization procedures, which typically involve
+ * initializing each downstream transport.
+ *
+ * @typeParam Params - the structure of the AdapterRequest's body
+ * @typeParam Result - the structure of the AdapterResponse's body
+ * @typeParam CustomSettings - custom settings for the Adapter, or the default SettingsMap
+ */
+export interface MetaTransport<T extends TransportGenerics> extends Transport<T> {
+    transports: {
+        [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: AdapterContext<T>) => CacheEntry<AdapterResponse<T["Response"]>>[];

package/transports/index.js

@@ -0,0 +1,56 @@
+"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 __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

@@ -0,0 +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,OAA0B,EACoB,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"}

package/transports/metrics.d.ts

@@ -0,0 +1,25 @@
+import * as client from 'prom-client';
+import { TransportGenerics } from '.';
+import { AdapterContext } from '../adapter';
+export declare const dataProviderMetricsLabel: (providerStatusCode?: number, method?: string) => {
+    provider_status_code: number | undefined;
+    method: string;
+};
+export declare const dataProviderRequests: client.Counter<"method" | "provider_status_code">;
+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) => {
+    feed_id: string;
+    subscription_key: string;
+};
+export declare const recordWsMessageMetrics: <T extends TransportGenerics>(context: AdapterContext<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 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

@@ -0,0 +1,122 @@
+"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.transportPollingDurationSeconds = exports.transportPollingFailureCount = exports.bgExecuteSubscriptionSetCount = exports.wsMessageTotal = exports.wsSubscriptionTotal = exports.wsSubscriptionActive = exports.wsConnectionErrors = exports.wsConnectionActive = exports.recordWsMessageMetrics = exports.messageSubsLabels = exports.connectionErrorLabels = exports.dataProviderRequestDurationSeconds = exports.dataProviderRequests = exports.dataProviderMetricsLabel = void 0;
+const client = __importStar(require("prom-client"));
+const cache_1 = require("../cache");
+const constants_1 = require("../metrics/constants");
+// Data Provider Metrics
+const dataProviderMetricsLabel = (providerStatusCode, method = 'get') => ({
+    provider_status_code: providerStatusCode,
+    method: method.toUpperCase(),
+});
+exports.dataProviderMetricsLabel = dataProviderMetricsLabel;
+exports.dataProviderRequests = new client.Counter({
+    name: 'data_provider_requests',
+    help: 'The number of http requests that are made to a data provider',
+    labelNames: ['method', 'provider_status_code'],
+});
+exports.dataProviderRequestDurationSeconds = new client.Histogram({
+    name: 'data_provider_request_duration_seconds',
+    help: 'A histogram bucket of the distribution of data provider request durations',
+    buckets: constants_1.requestDurationBuckets,
+});
+// Websocket Metrics
+const connectionErrorLabels = (message) => ({
+    // Key,
+    message,
+});
+exports.connectionErrorLabels = connectionErrorLabels;
+const messageSubsLabels = (feed_id, cache_key) => ({
+    feed_id,
+    subscription_key: cache_key,
+});
+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);
+        // Record total number of ws messages sent
+        exports.wsMessageTotal.labels((0, exports.messageSubsLabels)(feedId, cacheKey)).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();
+    });
+    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();
+    });
+};
+exports.recordWsMessageMetrics = recordWsMessageMetrics;
+exports.wsConnectionActive = new client.Gauge({
+    name: 'ws_connection_active',
+    help: 'The number of active connections',
+    labelNames: ['url'],
+});
+exports.wsConnectionErrors = new client.Counter({
+    name: 'ws_connection_errors',
+    help: 'The number of connection errors',
+    labelNames: ['url', 'message'],
+});
+exports.wsSubscriptionActive = new client.Gauge({
+    name: 'ws_subscription_active',
+    help: 'The number of currently active subscriptions',
+    labelNames: ['connection_url', 'feed_id', 'subscription_key'],
+});
+exports.wsSubscriptionTotal = new client.Counter({
+    name: 'ws_subscription_total',
+    help: 'The number of subscriptions opened in total',
+    labelNames: ['connection_url', 'feed_id', 'subscription_key'],
+});
+exports.wsMessageTotal = new client.Counter({
+    name: 'ws_message_total',
+    help: 'The number of messages received in total',
+    labelNames: ['feed_id', 'subscription_key'],
+});
+// V3 specific metrics
+exports.bgExecuteSubscriptionSetCount = new client.Gauge({
+    name: 'bg_execute_subscription_set_count',
+    help: 'The number of active subscriptions in background execute',
+    labelNames: ['endpoint', 'transport_type'],
+});
+exports.transportPollingFailureCount = new client.Counter({
+    name: 'transport_polling_failure_count',
+    help: 'The number of times the polling mechanism ran out of attempts and failed to return a response',
+    labelNames: ['endpoint'],
+});
+exports.transportPollingDurationSeconds = new client.Gauge({
+    name: 'transport_polling_duration_seconds',
+    help: 'A histogram bucket of the distribution of transport polling idle time durations',
+    labelNames: ['endpoint', 'succeeded'],
+});
+//# sourceMappingURL=metrics.js.map

package/transports/metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../../src/transports/metrics.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAqC;AAGrC,oCAA6D;AAC7D,oDAA6D;AAE7D,wBAAwB;AACjB,MAAM,wBAAwB,GAAG,CAAC,kBAA2B,EAAE,MAAM,GAAG,KAAK,EAAE,EAAE,CAAC,CAAC;IACxF,oBAAoB,EAAE,kBAAkB;IACxC,MAAM,EAAE,MAAM,CAAC,WAAW,EAAE;CAC7B,CAAC,CAAA;AAHW,QAAA,wBAAwB,4BAGnC;AAEW,QAAA,oBAAoB,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IACrD,IAAI,EAAE,wBAAwB;IAC9B,IAAI,EAAE,8DAA8D;IACpE,UAAU,EAAE,CAAC,QAAQ,EAAE,sBAAsB,CAAU;CACxD,CAAC,CAAA;AAEW,QAAA,kCAAkC,GAAG,IAAI,MAAM,CAAC,SAAS,CAAC;IACrE,IAAI,EAAE,wCAAwC;IAC9C,IAAI,EAAE,2EAA2E;IACjF,OAAO,EAAE,kCAAsB;CAChC,CAAC,CAAA;AAEF,oBAAoB;AACb,MAAM,qBAAqB,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,CAAC;IACzD,OAAO;IACP,OAAO;CACR,CAAC,CAAA;AAHW,QAAA,qBAAqB,yBAGhC;AAEK,MAAM,iBAAiB,GAAG,CAAC,OAAe,EAAE,SAAiB,EAAE,EAAE,CAAC,CAAC;IACxE,OAAO;IACP,gBAAgB,EAAE,SAAS;CAC5B,CAAC,CAAA;AAHW,QAAA,iBAAiB,qBAG5B;AAEF,6CAA6C;AAC7C,8CAA8C;AAC9C,2DAA2D;AACpD,MAAM,sBAAsB,GAAG,CACpC,OAA0B,EAC1B,UAAoC,EACpC,YAAsC,EAChC,EAAE;IACR,UAAU,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC3B,MAAM,MAAM,GAAG,IAAA,uBAAe,EAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAC9C,MAAM,QAAQ,GAAG,IAAA,yBAAiB,EAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAClD,0CAA0C;QAC1C,sBAAc,CAAC,MAAM,CAAC,IAAA,yBAAiB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;QAEhE,4CAA4C;QAC5C,2BAAmB,CAAC,MAAM,CAAC,IAAA,yBAAiB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;QAErE,2CAA2C;QAC3C,4BAAoB,CAAC,MAAM,CAAC,IAAA,yBAAiB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;IACxE,CAAC,CAAC,CAAA;IACF,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC7B,MAAM,MAAM,GAAG,IAAA,uBAAe,EAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAC9C,MAAM,QAAQ,GAAG,IAAA,yBAAiB,EAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAElD,0CAA0C;QAC1C,sBAAc,CAAC,MAAM,CAAC,IAAA,yBAAiB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;QAEhE,2CAA2C;QAC3C,4BAAoB,CAAC,MAAM,CAAC,IAAA,yBAAiB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;IACxE,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AA3BY,QAAA,sBAAsB,0BA2BlC;AAEY,QAAA,kBAAkB,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC;IACjD,IAAI,EAAE,sBAAsB;IAC5B,IAAI,EAAE,kCAAkC;IACxC,UAAU,EAAE,CAAC,KAAK,CAAU;CAC7B,CAAC,CAAA;AAEW,QAAA,kBAAkB,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IACnD,IAAI,EAAE,sBAAsB;IAC5B,IAAI,EAAE,iCAAiC;IACvC,UAAU,EAAE,CAAC,KAAK,EAAE,SAAS,CAAU;CACxC,CAAC,CAAA;AAEW,QAAA,oBAAoB,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC;IACnD,IAAI,EAAE,wBAAwB;IAC9B,IAAI,EAAE,8CAA8C;IACpD,UAAU,EAAE,CAAC,gBAAgB,EAAE,SAAS,EAAE,kBAAkB,CAAU;CACvE,CAAC,CAAA;AAEW,QAAA,mBAAmB,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IACpD,IAAI,EAAE,uBAAuB;IAC7B,IAAI,EAAE,6CAA6C;IACnD,UAAU,EAAE,CAAC,gBAAgB,EAAE,SAAS,EAAE,kBAAkB,CAAU;CACvE,CAAC,CAAA;AAEW,QAAA,cAAc,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IAC/C,IAAI,EAAE,kBAAkB;IACxB,IAAI,EAAE,0CAA0C;IAChD,UAAU,EAAE,CAAC,SAAS,EAAE,kBAAkB,CAAU;CACrD,CAAC,CAAA;AAEF,sBAAsB;AACT,QAAA,6BAA6B,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC;IAC5D,IAAI,EAAE,mCAAmC;IACzC,IAAI,EAAE,0DAA0D;IAChE,UAAU,EAAE,CAAC,UAAU,EAAE,gBAAgB,CAAU;CACpD,CAAC,CAAA;AAEW,QAAA,4BAA4B,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IAC7D,IAAI,EAAE,iCAAiC;IACvC,IAAI,EAAE,+FAA+F;IACrG,UAAU,EAAE,CAAC,UAAU,CAAU;CAClC,CAAC,CAAA;AAEW,QAAA,+BAA+B,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC;IAC9D,IAAI,EAAE,oCAAoC;IAC1C,IAAI,EAAE,iFAAiF;IACvF,UAAU,EAAE,CAAC,UAAU,EAAE,WAAW,CAAU;CAC/C,CAAC,CAAA"}

package/transports/rest.d.ts

@@ -0,0 +1,68 @@
+import { AdapterRequest, AdapterResponse } from '../util/request';
+import { Transport, TransportGenerics } from './';
+import { Cache } from '../cache';
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { AdapterConfig } from '../config';
+import { RequestRateLimiter } from '../rate-limiting';
+import { AdapterDependencies } from '../adapter';
+export { AxiosRequestConfig as HttpRequestConfig, AxiosResponse as HttpResponse };
+/**
+ * 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.
+ */
+declare type RestTransportGenerics = TransportGenerics & {
+    /**
+     * Type details for any provider specific interfaces.
+     */
+    Provider: {
+        /**
+         * Structure of the body of the request that will be sent to the data provider.
+         */
+        RequestBody: unknown;
+        /**
+         * Structure for the body of the response coming from the data provider.
+         */
+        ResponseBody: unknown;
+    };
+};
+/**
+ * Transport implementation that takes incoming requests, transforms them into a DataProvider request,
+ * and executes that request returning the response immediately from the `setup` function.
+ * Optionally, setting the `coalescing` option to `true` will make it so once a request is in flight,
+ * new adapter requests for the same feed will not trigger a new one, but return an empty promise from
+ * the setup instead so the normal cache polling mechanism is used.
+ *
+ * @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[RestTransportGenerics]])
+ */
+export declare class RestTransport<T extends RestTransportGenerics> implements Transport<T> {
+    protected config: {
+        prepareRequest: (req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>) => AxiosRequestConfig<T['Provider']['RequestBody']> | Promise<AxiosRequestConfig<T['Provider']['RequestBody']>>;
+        parseResponse: (req: AdapterRequest<T['Request']>, res: AxiosResponse<T['Provider']['ResponseBody']>, config: AdapterConfig<T['CustomSettings']>) => AdapterResponse<T['Response']> | Promise<AdapterResponse<T['Response']>>;
+        options: {
+            requestCoalescing: {
+                enabled: boolean;
+                entropyMax?: number;
+            };
+        };
+    };
+    inFlightPrefix: string;
+    cache: Cache<AdapterResponse<T['Response']>>;
+    inFlightCache: Cache<boolean>;
+    rateLimiter: RequestRateLimiter;
+    constructor(config: {
+        prepareRequest: (req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>) => AxiosRequestConfig<T['Provider']['RequestBody']> | Promise<AxiosRequestConfig<T['Provider']['RequestBody']>>;
+        parseResponse: (req: AdapterRequest<T['Request']>, res: AxiosResponse<T['Provider']['ResponseBody']>, config: AdapterConfig<T['CustomSettings']>) => AdapterResponse<T['Response']> | Promise<AdapterResponse<T['Response']>>;
+        options: {
+            requestCoalescing: {
+                enabled: boolean;
+                entropyMax?: number;
+            };
+        };
+    });
+    initialize(dependencies: AdapterDependencies, config: AdapterConfig<T['CustomSettings']>): Promise<void>;
+    protected waitUntilUnderRateLimit(options: {
+        maxRetries: number;
+        msBetweenRetries: number;
+    }, retry?: number): Promise<void>;
+    foregroundExecute(req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>): Promise<AdapterResponse<T['Response']> | undefined>;
+}