@chainlink/external-adapter-framework 0.0.15 → 0.0.16

package/rate-limiting/index.js

@@ -0,0 +1,84 @@
+"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.getRateLimitingTier = exports.consolidateTierLimits = void 0;
+__exportStar(require("./request/simple-counting"), exports);
+__exportStar(require("./background/fixed-frequency"), exports);
+/**
+ * This method will convert all possible settings for a rate limit tier and
+ * convert them all to requests per second, returning the lowest one
+ *
+ * @param limits - the rate limit tier set for the adapter
+ * @returns the most restrictive of the set options, in requests per second
+ */
+const consolidateTierLimits = (limits) => {
+    const perHourLimit = (limits?.rateLimit1h || Infinity) / (60 * 60);
+    const perMinuteLimit = (limits?.rateLimit1m || Infinity) / 60;
+    const perSecondLimit = limits?.rateLimit1s || Infinity;
+    return Math.min(perHourLimit, perMinuteLimit, perSecondLimit);
+};
+exports.consolidateTierLimits = consolidateTierLimits;
+/**
+ * Validates rate limiting tiers specified for the adapter, and returns the one to use.
+ *
+ * @param config - the adapter config containing the env vars
+ * @param tiers - the adapter config listing the different available API tiers
+ * @returns the specified API tier, or a default one if none are specified
+ */
+const getRateLimitingTier = (config, tiers) => {
+    if (config.RATE_LIMIT_CAPACITY ||
+        config.RATE_LIMIT_CAPACITY_MINUTE ||
+        config.RATE_LIMIT_CAPACITY_SECOND) {
+        return buildRateLimitTiersFromConfig(config);
+    }
+    if (!tiers) {
+        return;
+    }
+    // Check that if the tiers object is defined, it has values
+    if (Object.values(tiers).length === 0) {
+        throw new Error(`The tiers object is defined, but has no entries`);
+    }
+    // Check that the tier set in the AdapterConfig is a valid one
+    const selectedTier = config.RATE_LIMIT_API_TIER;
+    if (selectedTier && !tiers[selectedTier]) {
+        const validTiersString = Object.keys(tiers)
+            .map((t) => `"${t}"`)
+            .join(', ');
+        throw new Error(`The selected rate limit tier "${selectedTier}" is not valid (can be one of ${validTiersString})`);
+    }
+    if (!selectedTier) {
+        // Sort the tiers by most to least restrictive
+        const sortedTiers = Object.values(tiers).sort((t1, t2) => (0, exports.consolidateTierLimits)(t1) - (0, exports.consolidateTierLimits)(t2));
+        return sortedTiers[0];
+    }
+    return tiers[selectedTier];
+};
+exports.getRateLimitingTier = getRateLimitingTier;
+// Creates adapter rate limit tier using the configs specified in env vars
+const buildRateLimitTiersFromConfig = (config) => {
+    const rateLimit1s = config.RATE_LIMIT_CAPACITY_SECOND;
+    let rateLimit1m;
+    if (config.RATE_LIMIT_CAPACITY_MINUTE) {
+        rateLimit1m = config.RATE_LIMIT_CAPACITY_MINUTE;
+    }
+    else if (config.RATE_LIMIT_CAPACITY) {
+        rateLimit1m = config.RATE_LIMIT_CAPACITY;
+    }
+    return {
+        rateLimit1s,
+        rateLimit1m,
+    };
+};

package/rate-limiting/metrics.js

@@ -0,0 +1,44 @@
+"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.rateLimitCreditsSpentTotal = exports.retrieveCost = void 0;
+const client = __importStar(require("prom-client"));
+// Retrieve cost field from response if exists
+// If not return default cost of 1
+const retrieveCost = (data) => {
+    const cost = data['cost'];
+    if (typeof cost === 'number' || typeof cost === 'string') {
+        return Number(cost);
+    }
+    else {
+        return 1;
+    }
+};
+exports.retrieveCost = retrieveCost;
+exports.rateLimitCreditsSpentTotal = new client.Counter({
+    name: 'rate_limit_credits_spent_total',
+    help: 'The number of data provider credits the adapter is consuming',
+    labelNames: ['participant_id', 'feed_id'],
+});

package/rate-limiting/request/simple-counting.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimpleCountingRateLimiter = void 0;
+const util_1 = require("../../util");
+const logger = (0, util_1.makeLogger)('SimpleCountingRateLimiter');
+/**
+ * This rate limiter is the simplest stateful option.
+ * On startup, it'll compare the different thresholds for each tier, calculate them all
+ * in the finest window we'll use (seconds), and use the most restrictive one.
+ * This is so if the EA were to restart, we don't need to worry about persisting state
+ * for things like daily quotas. The downside is that this does not work well for bursty
+ * loads or spikes, in cases where e.g. the per second limit is high but daily quotas low.
+ */
+class SimpleCountingRateLimiter {
+    constructor() {
+        this.latestSecondInterval = 0;
+        this.requestsThisSecond = 0;
+        this.latestMinuteInterval = 0;
+        this.requestsThisMinute = 0;
+    }
+    initialize(endpoints, limits) {
+        // Translate the hourly limit into reqs per minute
+        const perHourLimit = (limits?.rateLimit1h || Infinity) / 60;
+        this.perMinuteLimit = Math.min(limits?.rateLimit1m || Infinity, perHourLimit);
+        this.perSecondLimit = limits?.rateLimit1s || Infinity;
+        logger.debug(`Using rate limiting settings: perMinute = ${this.perMinuteLimit} | perSecond: = ${this.perSecondLimit}`);
+        return this;
+    }
+    isUnderLimits() {
+        // If the limit is set to infinity, there was no tier limit specified
+        if (this.perSecondLimit === Infinity && this.perMinuteLimit === Infinity) {
+            return true;
+        }
+        const now = Date.now();
+        const nearestSecondInterval = Math.floor(now / 1000);
+        const nearestMinuteInterval = Math.floor(now / (1000 * 60));
+        // This should always run to completion, even if it doesn't look atomic; therefore the
+        // Ops should be "thread safe". Thank JS and its infinite single threaded dumbness.
+        if (nearestSecondInterval !== this.latestSecondInterval) {
+            logger.trace(`Clearing latest second interval, # of requests logged was: ${this.requestsThisSecond} `);
+            this.latestSecondInterval = nearestSecondInterval;
+            this.requestsThisSecond = 0;
+        }
+        if (nearestMinuteInterval !== this.latestMinuteInterval) {
+            logger.trace(`Clearing latest second minute, # of requests logged was: ${this.requestsThisMinute} `);
+            this.latestMinuteInterval = nearestMinuteInterval;
+            this.requestsThisMinute = 0;
+        }
+        if (this.requestsThisSecond < this.perSecondLimit &&
+            this.requestsThisMinute < this.perMinuteLimit) {
+            logger.trace('Request under limits, counting +1');
+            this.requestsThisSecond++;
+            this.requestsThisMinute++;
+            return true;
+        }
+        else {
+            logger.trace('Requests seen this interval are above limits');
+            return false;
+        }
+    }
+}
+exports.SimpleCountingRateLimiter = SimpleCountingRateLimiter;

package/test.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const _1 = require(".");
+const bank_frick_1 = require("./examples/bank-frick");
+// Start sample adapter
+(0, _1.expose)(bank_frick_1.adapter);

package/transports/batch-warming.js

@@ -0,0 +1,101 @@
+"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 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 AdapterParams - interface for the adapter request body
+ * @typeParam ProviderRequestBody - interface for the body of the request to the Data Provider
+ * @typeParam ProviderResponseBody - interface for the body of the Data Provider's response
+ */
+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) {
+        this.cache = dependencies.cache;
+        this.rateLimiter = dependencies.backgroundExecuteRateLimiter;
+        this.subscriptionSet = dependencies.subscriptionSetFactory.buildSet();
+    }
+    async hasBeenSetUp(req) {
+        return !!(await this.subscriptionSet.get(req.requestContext.cacheKey));
+    }
+    async setup(req, config) {
+        logger.debug(`Adding entry to batch warming set: [${req.requestContext.cacheKey}] = ${req.requestContext.data}`);
+        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();
+        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 this.rateLimiter.msUntilNextExecution(context.adapterEndpoint.name);
+        }
+        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 request = this.config.prepareRequest(entries, context);
+        logger.trace('Sending request to data provider...');
+        const providerResponse = await (0, util_2.axiosRequest)(request, context.adapterConfig);
+        logger.debug(`Got response from provider, parsing (raw body: ${providerResponse.data})`);
+        const results = this.config.parseResponse(providerResponse, context);
+        const adapterResponses = (0, _1.buildCacheEntriesFromResults)(results, context);
+        logger.debug('Setting adapter responses in cache');
+        await this.cache.setMany(adapterResponses, context.adapterConfig.CACHE_MAX_AGE);
+        // Record cost of data provider call
+        const cost = rateLimitMetrics.retrieveCost(providerResponse.data);
+        rateLimitMetrics.rateLimitCreditsSpentTotal
+            .labels({
+            feed_id: 'N/A',
+            participant_id: WARMUP_BATCH_REQUEST_ID,
+        })
+            .inc(cost);
+        return this.rateLimiter.msUntilNextExecution(context.adapterEndpoint.name);
+    }
+}
+exports.BatchWarmingTransport = BatchWarmingTransport;

package/transports/index.js

@@ -0,0 +1,87 @@
+"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.buildTransportHandler = exports.buildCacheEntriesFromResults = void 0;
+const cache_1 = require("../cache");
+const util_1 = require("../util");
+__exportStar(require("./batch-warming"), exports);
+__exportStar(require("./rest"), exports);
+__exportStar(require("./websocket"), exports);
+const logger = (0, util_1.makeLogger)('Transport');
+/**
+ * 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: null, // TODO: Maybe add data as well?
+        },
+    };
+    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;
+/**
+ * Takes an Adapter, its configuration, and its dependencies, and it creates an express middleware
+ * that will pass along the AdapterRequest to the appropriate Transport (acc. to the endpoint in the req.)
+ *
+ * @param adapter - main adapter object, already initialized
+ * @returns the transport handler middleware function
+ */
+const buildTransportHandler = (adapter) => async (req, reply) => {
+    // Get transport, must be here because it's already checked in the validator
+    const transport = adapter.endpointsMap[req.requestContext.endpointName].transport;
+    // Set up transport if it hasn't been done already
+    if (!(await transport.hasBeenSetUp(req))) {
+        logger.debug('Transport not set up yet, doing so...');
+        const immediateResponse = await transport.setup(req, adapter.config);
+        if (immediateResponse) {
+            logger.debug('Got immediate response from transport, sending as response');
+            return reply.send(immediateResponse);
+        }
+    }
+    logger.debug('Transport is set up, polling cache for response...');
+    const response = await (0, cache_1.pollResponseFromCache)(adapter.dependencies.cache, req.requestContext.cacheKey, {
+        maxRetries: adapter.config.CACHE_POLLING_MAX_RETRIES,
+        sleep: adapter.config.CACHE_POLLING_SLEEP_MS,
+    });
+    if (response) {
+        logger.debug('Got a response from the cache, sending that back');
+        return reply.send(response);
+    }
+    logger.debug('Ran out of polling attempts, returning timeout');
+    reply.statusCode = 504;
+    return reply.send();
+};
+exports.buildTransportHandler = buildTransportHandler;

package/transports/metrics.js

@@ -0,0 +1,105 @@
+"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.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, unsubscrices) => {
+    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();
+    });
+    unsubscrices.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'],
+});

package/transports/rest.js

@@ -0,0 +1,138 @@
+"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.RestTransport = void 0;
+const util_1 = require("../util");
+const error_1 = require("../validation/error");
+const util_2 = require("./util");
+const rateLimitMetrics = __importStar(require("../rate-limiting/metrics"));
+const IN_FLIGHT_PREFIX = 'InFlight';
+const logger = (0, util_1.makeLogger)('RestTransport');
+/**
+ * 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 AdapterParams - interface for the adapter request body
+ * @typeParam ProviderRequestBody - interface for the body of the request to the Data Provider
+ * @typeParam ProviderResponseBody - interface for the body of the Data Provider's response
+ */
+class RestTransport {
+    constructor(config) {
+        this.config = config;
+    }
+    async initialize(dependencies, config) {
+        this.inFlightPrefix = `${IN_FLIGHT_PREFIX}-`;
+        this.cache = dependencies.cache;
+        this.rateLimiter = dependencies.requestRateLimiter;
+        // Allow enabling/disabling request coalescing through env var
+        if (config.REQUEST_COALESCING_ENABLED !== undefined) {
+            this.config.options.coalescing = config.REQUEST_COALESCING_ENABLED;
+        }
+    }
+    async hasBeenSetUp(req) {
+        if (!this.config.options.coalescing) {
+            return false;
+        }
+        // Check if request is in flight
+        const inFlight = await this.cache.get(this.inFlightPrefix + req.requestContext.cacheKey);
+        if (inFlight) {
+            logger.debug('Request is in flight, transport has been set up');
+            return true;
+        }
+        else {
+            logger.debug('Request not in flight, transport not set up');
+            return false;
+        }
+    }
+    async waitUntilUnderRateLimit(options, retry = 0) {
+        if (this.rateLimiter.isUnderLimits()) {
+            logger.trace('Incoming request would not be under limits, moving on');
+            return;
+        }
+        if (retry >= options.maxRetries) {
+            throw new error_1.AdapterError({
+                statusCode: 504,
+                message: `REST Transport timed out while waiting for rate limit availability (max retries: ${options.maxRetries})`,
+            });
+        }
+        logger.debug(`Request would be over rate limits, sleeping for ${options.msBetweenRetries}`);
+        await (0, util_1.sleep)(options.msBetweenRetries);
+        await this.waitUntilUnderRateLimit(options, retry + 1);
+    }
+    async setup(req, config) {
+        if (this.config.options.coalescing) {
+            logger.debug('Setting up rest transport, setting request in flight in cache');
+            // TODO: Should this use a separate cache?
+            // TODO: Set viable ttl to approximate timeout from API
+            // TODO: Make this ttl configurable
+            await this.cache.set(this.inFlightPrefix + req.requestContext.cacheKey, true, 2000); // Can't use Infinity for things like Redis
+        }
+        const request = await this.config.prepareRequest(req, config);
+        logger.trace('Check if we are under rate limits to perform request');
+        await this.waitUntilUnderRateLimit({
+            maxRetries: config.REST_TRANSPORT_MAX_RATE_LIMIT_RETRIES,
+            msBetweenRetries: config.REST_TRANSPORT_MS_BETWEEN_RATE_LIMIT_RETRIES,
+        });
+        logger.trace('Sending request to data provider...');
+        const providerResponse = await (0, util_2.axiosRequest)(request, config);
+        logger.debug(`Got response from provider, parsing (raw body: ${providerResponse.data})`); // TODO: Sensitive data?
+        const parsedResponse = await this.config.parseResponse(req, providerResponse, config);
+        if (config.API_VERBOSE) {
+            parsedResponse.data = providerResponse.data;
+        }
+        if (config.METRICS_ENABLED && config.EXPERIMENTAL_METRICS_ENABLED) {
+            // TODO: Potentially create function to add all telemetry data
+            parsedResponse.maxAge = Date.now() + config.CACHE_MAX_AGE;
+            parsedResponse.meta = {
+                metrics: { feedId: req.requestContext.meta?.metrics?.feedId || 'N/A' },
+            };
+        }
+        logger.debug('Setting provider response in cache');
+        await this.cache.set(req.requestContext.cacheKey, parsedResponse, config.CACHE_MAX_AGE);
+        // Record cost of data provider call
+        const cost = rateLimitMetrics.retrieveCost(providerResponse.data);
+        rateLimitMetrics.rateLimitCreditsSpentTotal
+            .labels({
+            feed_id: req.requestContext.meta?.metrics?.feedId || 'N/A',
+            participant_id: req.requestContext.cacheKey,
+        })
+            .inc(cost);
+        // Update cacheHit flag in request meta for metrics use
+        req.requestContext.meta = {
+            ...req.requestContext.meta,
+            metrics: { ...req.requestContext.meta?.metrics, cacheHit: false },
+        };
+        // TODO: move this to a try/catch/finally
+        if (this.config.options.coalescing) {
+            logger.debug('Set provider response in cache, removing in flight from cache');
+            await this.cache.delete(this.inFlightPrefix);
+        }
+        return parsedResponse;
+    }
+}
+exports.RestTransport = RestTransport;