@chainlink/external-adapter-framework 0.0.12 → 0.0.15

package/dist/src/package/rate-limiting/background/fixed-frequency.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FixedFrequencyRateLimiter = exports.DEFAULT_SHARED_MS_BETWEEN_REQUESTS = void 0;
-const __1 = require("..");
-const util_1 = require("../../util");
-const logger = (0, util_1.makeLogger)('FixedFrequencyRateLimiter');
-exports.DEFAULT_SHARED_MS_BETWEEN_REQUESTS = 5000;
-class FixedFrequencyRateLimiter {
-    constructor() {
-        this.msBetweenRequestsMap = {};
-    }
-    initialize(endpoints, limits) {
-        // Translate the hourly limit into reqs per minute
-        let sharedMsBetweenRequests = 1000 / (0, __1.consolidateTierLimits)(limits);
-        // If there is no limit set, we use some reasonable number
-        if (!limits?.rateLimit1h && !limits?.rateLimit1m && !limits?.rateLimit1s) {
-            // 5s period for all seems good
-            sharedMsBetweenRequests = exports.DEFAULT_SHARED_MS_BETWEEN_REQUESTS;
-        }
-        logger.debug('Using fixed frequency batch rate limiting');
-        for (const endpoint of endpoints) {
-            // TODO: See if we can remove this runtime check
-            if (endpoint.rateLimiting?.allocationPercentage == null) {
-                throw new Error(`Allocation percentage for endpoint "${endpoint.name}" is null`);
-            }
-            // TODO: Implement different strategy where this is not fixed, but rather divided based on whether all warmers are active
-            this.msBetweenRequestsMap[endpoint.name] =
-                (sharedMsBetweenRequests / endpoint.rateLimiting?.allocationPercentage) * 100;
-            logger.debug(`Endpoint [${endpoint.name}]: ${this.msBetweenRequestsMap[endpoint.name] / 1000}s between requests`);
-        }
-        return this;
-    }
-    msUntilNextExecution(endpointName) {
-        return this.msBetweenRequestsMap[endpointName];
-    }
-}
-exports.FixedFrequencyRateLimiter = FixedFrequencyRateLimiter;

package/dist/src/package/rate-limiting/index.d.ts

@@ -1,54 +0,0 @@
-import { AdapterEndpoint } from '../adapter';
-export * from './request/simple-counting';
-export * from './background/fixed-frequency';
-export interface AdapterRateLimitTier {
-    rateLimit1s?: number;
-    rateLimit1m?: number;
-    rateLimit1h?: number;
-    note?: string;
-}
-/**
- * Common interface for all RateLimiter classes to implement
- */
-export interface RateLimiter {
-    /**
-     * Method to ensure all RateLimiters can be initialized in the same manner.
-     *
-     * @param limits - settings for how much throughput to allow for the Adapter
-     * @param endpoints - list of adapter endpoints
-     */
-    initialize(endpoints: AdapterEndpoint[], limits: AdapterRateLimitTier): this;
-}
-/**
- * RequestRateLimiters perform checks agains imminent outbound requests for any transport.
- */
-export interface RequestRateLimiter extends RateLimiter {
-    /**
-     * This method will check using whatever strategy is implemented to determine if
-     * this request can be processed. If so, it returns true; if not, returns false.
-     */
-    isUnderLimits(): boolean;
-}
-/**
- * BackgroundExecuteFrequencyRateLimiters will implement custom logic to calculate
- * the period of time to wait between background executions for a transport.
- */
-export interface BackgroundExecuteRateLimiter extends RateLimiter {
-    msUntilNextExecution(endpointName: string): number;
-}
-/**
- * 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
- */
-export declare const consolidateTierLimits: (limits?: AdapterRateLimitTier) => number;
-/**
- * Validates rate limiting tiers specified for the adapter, and returns the one to use.
- *
- * @param tiers - the adapter config listing the different available API tiers
- * @param selectedTier - chosen API tier from settings, if present
- * @returns the specified API tier, or a default one if none are specified
- */
-export declare const getRateLimitingTier: (tiers?: Record<string, AdapterRateLimitTier>, selectedTier?: string) => AdapterRateLimitTier | undefined;

package/dist/src/package/rate-limiting/index.js

@@ -1,63 +0,0 @@
-"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 tiers - the adapter config listing the different available API tiers
- * @param selectedTier - chosen API tier from settings, if present
- * @returns the specified API tier, or a default one if none are specified
- */
-const getRateLimitingTier = (tiers, selectedTier) => {
-    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
-    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;

package/dist/src/package/rate-limiting/metrics.d.ts

@@ -1,3 +0,0 @@
-import * as client from 'prom-client';
-export declare const retrieveCost: <ProviderResponseBody>(data: ProviderResponseBody) => number;
-export declare const rateLimitCreditsSpentTotal: client.Counter<"feed_id" | "participant_id">;

package/dist/src/package/rate-limiting/metrics.js

@@ -1,44 +0,0 @@
-"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/dist/src/package/rate-limiting/request/simple-counting.d.ts

@@ -1,20 +0,0 @@
-import { AdapterRateLimitTier, RateLimiter } from '..';
-import { AdapterEndpoint } from '../../adapter';
-/**
- * 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.
- */
-export declare class SimpleCountingRateLimiter implements RateLimiter {
-    latestSecondInterval: number;
-    requestsThisSecond: number;
-    latestMinuteInterval: number;
-    requestsThisMinute: number;
-    perSecondLimit: number;
-    perMinuteLimit: number;
-    initialize(endpoints: AdapterEndpoint[], limits?: AdapterRateLimitTier): this;
-    isUnderLimits(): boolean;
-}

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

@@ -1,62 +0,0 @@
-"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/dist/src/package/test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/package/test.js

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

package/dist/src/package/transports/batch-warming.d.ts

@@ -1,34 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
-import { Cache } from '../cache';
-import { AdapterConfig, SettingsMap } from '../config';
-import { BackgroundExecuteRateLimiter } from '../rate-limiting';
-import { ExpiringSortedSet } from '../util';
-import { AdapterRequest, ProviderResult } from '../util/request';
-import { AdapterContext, AdapterDependencies, Transport } from './';
-/**
- * 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
- */
-export declare class BatchWarmingTransport<AdapterParams, ProviderRequestBody, ProviderResponseBody, CustomSettings extends SettingsMap> implements Transport<AdapterParams, ProviderResponseBody, CustomSettings> {
-    private config;
-    cache: Cache;
-    rateLimiter: BackgroundExecuteRateLimiter;
-    expiringSortedSet: ExpiringSortedSet<AdapterParams>;
-    WARMER_ACTIVE: boolean;
-    constructor(config: {
-        prepareRequest: (params: AdapterParams[], context: AdapterContext<CustomSettings>) => AxiosRequestConfig<ProviderRequestBody>;
-        parseResponse: (res: AxiosResponse<ProviderResponseBody>, context: AdapterContext<CustomSettings>) => ProviderResult<AdapterParams>[];
-    });
-    initialize(dependencies: AdapterDependencies): Promise<void>;
-    hasBeenSetUp(req: AdapterRequest<AdapterParams>): Promise<boolean>;
-    setup(req: AdapterRequest<AdapterParams>, config: AdapterConfig<CustomSettings>): Promise<void>;
-    backgroundExecute(context: AdapterContext<CustomSettings>): Promise<number>;
-}

package/dist/src/package/transports/batch-warming.js

@@ -1,101 +0,0 @@
-"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;
-        this.expiringSortedSet = new util_1.ExpiringSortedSet(); // TODO: Move to dependencies, inject
-        // 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;
-    }
-    async hasBeenSetUp(req) {
-        return !!this.expiringSortedSet.get(req.requestContext.cacheKey);
-    }
-    async setup(req, config) {
-        logger.debug(`Adding entry to batch warming set: [${req.requestContext.cacheKey}] = ${req.requestContext.data}`);
-        this.expiringSortedSet.add(req.requestContext.cacheKey, req.requestContext.data, config.WARMUP_SUBSCRIPTION_TTL);
-    }
-    async backgroundExecute(context) {
-        logger.debug('Starting background execute');
-        const entries = this.expiringSortedSet.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);
-        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/dist/src/package/transports/index.d.ts

@@ -1,87 +0,0 @@
-import { FastifyReply } from 'fastify';
-import { AdapterEndpoint, InitializedAdapter } from '../adapter';
-import { Cache, CacheEntry } from '../cache';
-import { AdapterConfig, CustomSettingsType, SettingsMap } from '../config';
-import { BackgroundExecuteRateLimiter, RequestRateLimiter } from '../rate-limiting';
-import { AdapterRequest, AdapterResponse, ProviderResult } from '../util/request';
-export * from './batch-warming';
-export * from './rest';
-export * from './websocket';
-/**
- * Dependencies that will be injected into the Adapter on startup
- */
-export interface AdapterDependencies {
-    cache: Cache;
-    requestRateLimiter: RequestRateLimiter;
-    backgroundExecuteRateLimiter: BackgroundExecuteRateLimiter;
-}
-/**
- * Context that will be used on background executions of a Transport.
- * For example, the endpointName used to log statements or generate Cache keys.
- */
-export interface AdapterContext<CustomSettings extends CustomSettingsType<CustomSettings> = SettingsMap> {
-    adapterEndpoint: AdapterEndpoint;
-    adapterConfig: AdapterConfig<CustomSettings>;
-}
-/**
- * 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 Params - the structure of the AdapterRequest's body
- * @typeParam Result - the structure of the AdapterResponse's body
- */
-export interface Transport<Params, Result, CustomSettings extends SettingsMap> {
-    /**
-     * Initializes the transport in the Adapter context.
-     *
-     * @param dependencies - Adapter dependencies (e.g. cache instance)
-     * @returns an empty Promise
-     */
-    initialize: (dependencies: AdapterDependencies) => Promise<void>;
-    /**
-     * Checks if the Transport has already set up the incoming request.
-     * This will likely use the cacheKey generated in the provided request.
-     *
-     * @param req - the incoming AdapterRequest
-     * @returns a Promise that returns true if setup is in place
-     */
-    hasBeenSetUp: (req: AdapterRequest<Params>) => Promise<boolean>;
-    /**
-     * Sets up the incoming request within the Transport.
-     * In other words, it means that the Adapter has recognized this request, and will begin
-     * fetching the necessary data from a Data Provider.
-     *
-     * @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.
-     */
-    setup: (req: AdapterRequest<Params>, config: AdapterConfig<CustomSettings>) => Promise<AdapterResponse<Result> | void>;
-    /**
-     * If the Transport relies on an async mechanism, implementing this function will make it
-     * so the background task executor calls it on Adapter startup.
-     *
-     * @param context - background context for the execution (e.g. endpoint name)
-     */
-    backgroundExecute?: (context: AdapterContext<CustomSettings>) => Promise<number>;
-}
-/**
- * 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: <Params, Context extends AdapterContext<any>>(results: ProviderResult<Params>[], context: Context) => CacheEntry<AdapterResponse<null>>[];
-/**
- * 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
- */
-export declare const buildTransportHandler: (adapter: InitializedAdapter) => (req: AdapterRequest, reply: FastifyReply) => Promise<never>;

package/dist/src/package/transports/index.js

@@ -1,87 +0,0 @@
-"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.adapterEndpoint, 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/dist/src/package/transports/metrics.d.ts

@@ -1,21 +0,0 @@
-import * as client from 'prom-client';
-import { AdapterContext } from '.';
-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: <AdapterParams>(context: AdapterContext, subscribes: AdapterParams[], unsubscrices: AdapterParams[]) => 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">;