@chainlink/external-adapter-framework 0.3.7 → 0.4.0

package/README.md

@@ -0,0 +1,102 @@
+# EA Framework v3
+
+External adapters and its core framework serve as middleware to facilitate connections between Chainlink Nodes and Data Providers (DP). Their main purpose is threefold:
+
+- Abstract provider specific details, specifically:
+  - Transport (REST, WebSockets, RPC, SSE, etc.)
+  - Authentication (login flows, keys)
+  - Accept normalized request payloads and translate into the provider's interface (this also includes things like symbols/tickers)
+  - Parse provider responses into the desired data points (e.g. price from crypto endpoint)
+- Make the overall system more efficient by using as few resources (e.g. API credits, networking traffic, CPU usage) as possible to fetch data, achieved by features like:
+  - Caching: since DPs update data at various times and a request to their API incurs a certain latency, EAs keep a cache of values to
+    - Provide responses to the Chainlink Nodes as quickly as possible
+    - Communicate with DPs only when necessary
+  - Cache Warming: in order to make as many of the requests to EAs be fulfilled from the cache, EAs fetch values from DPs asynchronously to keep the local ones fresh.
+  - Batching: the CL Node requests feeds individually, but it's common for DPs to provide batch endpoints to get many data points at once. With Batching, EAs keep track of incoming requests and consolidate them into one batched request.
+  - Rate limiting: the EA framework additionally checks request rates (frequency) to make sure they fall within acceptable limits (like quotas for the DP's API, or adjusting based on the NOP's API tier).
+- Perform off chain computations (think aggregations, indexing, or any sort of data processing)
+
+By providing a framework that gives users easy access to those features, we reduce the complexity required for Nodes to communicate with DPs since by using EAs there is only one standardized way to do so, while at the same time optimizing said communication so it's as resource efficient as possible. It also makes internal and external development easier and faster, by serving as a strict guideline to implement and add new providers.
+
+## Qs
+
+- Store entire response in cache?
+- Check for valid result in adapter response?
+
+## Env vars
+
+These are all existing env vars, marked DONE if they have been ported to this version, or N/A if the new version disregards them altogether.
+
+| Name                                       | State | Comments                                                     |
+| :----------------------------------------- | :---: | :----------------------------------------------------------- |
+| ADAPTER_URL                                |   -   |                                                              |
+| API_ENDPOINT                               |   √   |                                                              |
+| API_KEY                                    |   √   |                                                              |
+| API_TIMEOUT                                |   √   | Sets timeout for axios request                               |
+| API_VERBOSE                                |   √   | Does not return verbose on cache hit                         |
+| BASE_URL                                   |   √   |                                                              |
+| CACHE_ENABLED                              |  N/A  | Cache is integral to this fw, not including this for now     |
+| CACHE_KEY_IGNORED_PROPS                    |  N/A  | Not applicable after feed ID generation logic change         |
+| CACHE_KEY_GROUP                            |  N/A  | Grouping cache data is not needed in v3                      |
+| CACHE_MAX_AGE                              |   √   |                                                              |
+| CACHE_MAX_ITEMS                            |   -   | Should add when replacing obj in local impl with LRU package |
+| CACHE_MIN_AGE                              |   -   | Used for rate limiting                                       |
+| CACHE_REDIS_CONNECTION_TIMEOUT             |   -   | TODO: Redis                                                  |
+| CACHE_REDIS_HOST                           |   √   |                                                              |
+| CACHE_REDIS_MAX_QUEUED_ITEMS               |   -   | TODO: Redis                                                  |
+| CACHE_REDIS_MAX_RECONNECT_COOLDOWN         |   -   | TODO: Redis                                                  |
+| CACHE_REDIS_PASSWORD                       |   √   |                                                              |
+| CACHE_REDIS_PATH                           |   √   |                                                              |
+| CACHE_REDIS_PORT                           |   √   |                                                              |
+| CACHE_REDIS_TIMEOUT                        |   √   |                                                              |
+| CACHE_REDIS_URL                            |   -   | TODO: Redis                                                  |
+| CACHE_TYPE                                 |   √   |                                                              |
+| CACHE_UPDATE_AGE_ON_GET                    |  N/A  | No longer used in EA currently, apparently                   |
+| DATA_PROVIDER_URL                          |   -   | Legacy var same as ADAPTER_URL                               |
+| DEBUG                                      |   √   |                                                              |
+| DEFAULT_WS_HEARTBEAT_INTERVAL              |  N/A  |                                                              |
+| EA_HOST                                    |   √   |                                                              |
+| EA_PORT                                    |   √   |                                                              |
+| ERROR_CAPACITY                             |   -   | Error backoff is not currently in v3                         |
+| EXPERIMENTAL_METRICS_ENABLED               |   √   | Maintaining for backwards compatibility. Defaults to true    |
+| LOG_LEVEL                                  |       |                                                              |
+| METRICS_ENABLED                            |   √   | Defaults to true                                             |
+| METRICS_NAME                               |   √   |                                                              |
+| METRICS_PORT                               |   √   |                                                              |
+| METRICS_USE_BASE_URL                       |   √   |                                                              |
+| NODE_ENV                                   |       |                                                              |
+| npm_package_version                        |       |                                                              |
+| RATE_LIMIT_API_TIER                        |   √   |                                                              |
+| RATE_LIMIT_CAPACITY                        |   √   | Used for per minute rate limit if exists                     |
+| RATE_LIMIT_CAPACITY_MINUTE                 |   √   | Used for per minute rate limit if exists                     |
+| RATE_LIMIT_CAPACITY_SECOND                 |   √   | Used for per second rate limit if exists                     |
+| RATE_LIMIT_ENABLED                         |  N/A  | Rate limit always enabled in v3                              |
+| RECORD                                     |  N/A  | Not needed in v3 config for integration testing              |
+| REQUEST_COALESCING_ENABLED                 |   √   | Overrides transport config option if set                     |
+| REQUEST_COALESCING_ENTROPY_MAX             |       |                                                              |
+| REQUEST_COALESCING_INTERVAL                |       |                                                              |
+| REQUEST_COALESCING_INTERVAL_COEFFICIENT    |       |                                                              |
+| REQUEST_COALESCING_INTERVAL_MAX            |       |                                                              |
+| REQUEST_COALESCING_MAX_RETRIES             |       |                                                              |
+| RETRY                                      |   -   | Retry mechanism not yet part of v3                           |
+| SERVER_RATE_LIMIT_MAX                      |       |                                                              |
+| SERVER_SLOW_DOWN_AFTER_FACTOR              |       |                                                              |
+| SERVER_SLOW_DOWN_DELAY_MS                  |       |                                                              |
+| TIMEOUT                                    |   X   | API_TIMEOUT is used for same purpose                         |
+| WARMUP_ENABLED                             |       |                                                              |
+| WARMUP_INTERVAL                            |       |                                                              |
+| WARMUP_SUBSCRIPTION_TTL                    |       |                                                              |
+| WARMUP_UNHEALTHY_THRESHOLD                 |       |                                                              |
+| WS_API_ENDPOINT                            |       |                                                              |
+| WS_API_KEY                                 |       |                                                              |
+| WS_CONNECTION_KEY                          |  N/A  | Connection key is no longer used for WS in v3                |
+| WS_CONNECTION_LIMIT                        |       |                                                              |
+| WS_CONNECTION_RETRY_DELAY                  |       |                                                              |
+| WS_CONNECTION_RETRY_LIMIT                  |       |                                                              |
+| WS_CONNECTION_TTL                          |       |                                                              |
+| WS_ENABLED                                 |  N/A  | Shouldn't be part of this fw                                 |
+| WS_SUBSCRIPTION_LIMIT                      |       |                                                              |
+| WS_SUBSCRIPTION_PRIORITY_LIST              |       |                                                              |
+| WS_SUBSCRIPTION_TTL                        |       |                                                              |
+| WS_SUBSCRIPTION_UNRESPONSIVE_TTL           |       |                                                              |
+| WS_TIME_UNTIL_HANDLE_NEXT_MESSAGE_OVERRIDE |       |                                                              |

package/package.json

@@ -1,58 +1,47 @@
 {
   "name": "@chainlink/external-adapter-framework",
-  "version": "0.3.7",
+  "version": "0.4.0",
   "main": "dist/index.js",
   "license": "MIT",
   "dependencies": {
-    "ajv": "8.11.0",
-    "axios": "0.27.2",
-    "eventsource": "2.0.2",
-    "fastify": "4.7.0",
-    "ioredis": "5.2.3",
-    "pino": "8.6.1",
-    "prom-client": "13.2.0",
-    "ws": "8.9.0"
+    "axios": "^0.27.2",
+    "fastify": "^3.29.0",
+    "ioredis": "^5.0.4",
+    "pino": "^7.9.2",
+    "supertest": "^6.2.4",
+    "ts-jest": "^28.0.7",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.6.3",
+    "ws": "^8.5.0"
   },
   "scripts": {
+    "start": "ts-node src/test.ts",
+    "generate-docs": "typedoc src/**/*.ts",
+    "test": "LOG_LEVEL=error EA_PORT=0 c8 ava",
     "build": "tsc",
+    "lint": "eslint ./src && prettier --check ./src/**/*.ts",
+    "lint-fix": "eslint --fix ./src && prettier --write ./src/**/*.ts",
     "dev": "NODE_ENV=develop tsnd --respawn --transpile-only --project tsconfig.json './src/test.ts'",
-    "generate-docs": "typedoc src/**/*.ts",
-    "lint-fix": "eslint --max-warnings=0 --fix ./src && prettier --write ./src/**/*.ts ./*.{json,js,yaml}",
-    "lint": "eslint --max-warnings=0 ./src && prettier --check ./src/**/*.ts ./*.{json,js,yaml}",
-    "release": "./release.sh",
-    "start": "ts-node -e 'import(`./src/examples/${process.argv[1]}/src/index`).then(ea => ea.server())'",
-    "test-debug": "EA_HOST=localhost SKIP_METRICS_CLEAR=true LOG_LEVEL=trace DEBUG=true EA_PORT=0 c8 ava --verbose",
-    "test": "EA_HOST=localhost SKIP_METRICS_CLEAR=true LOG_LEVEL=error EA_PORT=0 c8 ava",
-    "verify": "yarn lint && yarn build && yarn build -p ./test/tsconfig.json && yarn test",
-    "code-coverage": "c8 check-coverage --statements 95 --lines 95 --functions 95 --branches 90"
+    "verify": "yarn lint && yarn build && yarn build -p ./test/tsconfig.json && yarn test"
   },
   "devDependencies": {
-    "@sinonjs/fake-timers": "9.1.2",
-    "@types/eventsource": "1.1.9",
-    "@types/jest": "29.1.1",
-    "@types/node": "18.8.2",
-    "@types/sinonjs__fake-timers": "8.1.2",
-    "@types/supertest": "2.0.12",
-    "@types/ws": "8.5.3",
-    "@typescript-eslint/eslint-plugin": "5.39.0",
-    "@typescript-eslint/parser": "5.39.0",
-    "ava": "4.3.3",
-    "c8": "7.12.0",
-    "eslint": "8.24.0",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-tsdoc": "0.2.17",
-    "jest": "29.1.2",
-    "mock-socket": "9.1.5",
-    "mocksse": "1.0.4",
-    "nock": "13.2.9",
-    "pino-pretty": "9.1.0",
-    "prettier": "2.7.1",
-    "supertest": "6.3.0",
-    "ts-node": "10.9.1",
-    "ts-jest": "29.0.3",
-    "ts-node-dev": "2.0.0",
-    "typedoc": "0.23.15",
-    "typescript": "4.8.4"
+    "@sinonjs/fake-timers": "^9.1.2",
+    "@types/jest": "^28.1.7",
+    "@types/node": "^18.6.5",
+    "@types/sinonjs__fake-timers": "^8.1.2",
+    "@types/ws": "^8.5.3",
+    "@typescript-eslint/eslint-plugin": "^5.17.0",
+    "@typescript-eslint/parser": "^5.17.0",
+    "ava": "^4.2.0",
+    "c8": "^7.11.2",
+    "eslint": "^8.14.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-tsdoc": "^0.2.16",
+    "mock-socket": "^9.1.3",
+    "nock": "^13.2.4",
+    "pino-pretty": "^7.6.0",
+    "prettier": "^2.6.1",
+    "typedoc": "^0.22.15"
   },
   "prettier": {
     "semi": false,
@@ -62,6 +51,10 @@
     "trailingComma": "all",
     "arrowParens": "always"
   },
+  "optionalDependencies": {
+    "bufferutil": "^4.0.6",
+    "utf-8-validate": "^5.0.9"
+  },
   "ava": {
     "files": [
       "test/**/*.test.ts"
@@ -72,10 +65,9 @@
     "require": [
       "ts-node/register"
     ],
-    "workerThreads": false,
-    "environmentVariables": {
-      "METRICS_ENABLED": "false"
-    },
-    "timeout": "20s"
-  }
+    "workerThreads": false
+  },
+  "files": [
+    "dist"
+  ]
 }

package/adapter/basic.d.ts

@@ -1,86 +0,0 @@
-import { SettingsMap, BaseAdapterConfig, AdapterConfig } from '../config';
-import { AdapterRequest, AdapterResponse } from '../util';
-import { AdapterEndpoint } from './endpoint';
-import { AdapterDependencies, AdapterParams, AdapterRateLimitingConfig, CustomAdapterSettings, RequestTransform } from './types';
-/**
- * Main class to represent an External Adapter
- */
-export declare class Adapter<CustomSettings extends CustomAdapterSettings = SettingsMap> implements Omit<AdapterParams<CustomSettings>, 'bootstrap'> {
-    name: string;
-    defaultEndpoint?: string | undefined;
-    endpoints: AdapterEndpoint<unknown, unknown, CustomSettings>[];
-    envDefaultOverrides?: Partial<BaseAdapterConfig> | undefined;
-    customSettings?: SettingsMap | undefined;
-    rateLimiting?: AdapterRateLimitingConfig | undefined;
-    overrides?: Record<string, string> | undefined;
-    requestTransforms?: RequestTransform[];
-    initialized: boolean;
-    /** Object containing alias translations for all endpoints */
-    endpointsMap: Record<string, AdapterEndpoint<unknown, unknown, CustomSettings>>;
-    /** Initialized dependencies that the adapter will use */
-    dependencies: AdapterDependencies;
-    /** Configuration params for various adapter properties */
-    config: AdapterConfig<CustomSettings>;
-    /** Bootstrap function that will run when initializing the adapter */
-    private readonly bootstrap?;
-    constructor(params: AdapterParams<CustomSettings>);
-    /**
-     * Initializes all of the [[Transport]]s in the adapter, passing along any [[AdapterDependencies]] and [[AdapterConfig]].
-     * Additionally, it builds a map out of all the endpoint names and aliases (checking for duplicates).
-     */
-    initialize(dependencies?: Partial<AdapterDependencies>): Promise<void>;
-    /**
-     * Takes an adapter and normalizes all endpoint names and aliases, as well as the default endpoint.
-     * i.e. makes them lowercase for now
-     */
-    private normalizeEndpointNames;
-    /**
-     * This function will take an adapter structure and go through each endpoint, calculating
-     * each one's allocation of the total rate limits that are set for the adapter as a whole.
-     *
-     */
-    private calculateRateLimitAllocations;
-    /**
-     * Creates a list of key/value pairs that need to be censored in the logs
-     * using the sensitive flag in the adapter config
-     */
-    private buildCensorList;
-    /**
-     * This function will process dependencies for an adapter, such as caches or rate limiters,
-     * in order to inject them into transports and other relevant places later in the lifecycle.
-     *
-     * @param inputDependencies - a partial obj of initialized dependencies to override the created ones
-     * @returns a set of AdapterDependencies all initialized
-     */
-    initializeDependencies(inputDependencies?: Partial<AdapterDependencies>): AdapterDependencies;
-    /**
-     * Attempts to find a value from the Cache and return that if found.
-     *
-     * @param req - the incoming request to this adapter
-     * @returns the cached value if exists
-     */
-    findResponseInCache(req: AdapterRequest): Promise<AdapterResponse | undefined>;
-    /**
-     * Default request transform that takes requests and manipulates
-     *
-     * @param adapter - the current adapter
-     * @param req - the current adapter request
-     * @returns the modified (or new) request
-     */
-    symbolOverrider(req: AdapterRequest): AdapterRequest<import("../util").AdapterRequestData>;
-    /**
-     * Takes the incoming request and applies all request transforms in the adapter
-     *
-     * @param req - the current adapter request
-     * @returns the request after passing through all request transforms
-     */
-    runRequestTransforms(req: AdapterRequest): void;
-    /**
-     * Function to serve as middleware to pass along the AdapterRequest to the appropriate Transport (acc. to the endpoint in the req.)
-     *
-     * @param req - the incoming request to this adapter
-     * @param replySent - a promise that resolves when the reply has already been sent
-     * @returns a simple Promise when it's done
-     */
-    handleRequest(req: AdapterRequest, replySent: Promise<unknown>): Promise<AdapterResponse>;
-}

package/adapter/basic.js

@@ -1,323 +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;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Adapter = void 0;
-const ioredis_1 = __importDefault(require("ioredis"));
-const cache_1 = require("../cache");
-const cacheMetrics = __importStar(require("../cache/metrics"));
-const config_1 = require("../config");
-const transportMetrics = __importStar(require("../transports/metrics"));
-const rate_limiting_1 = require("../rate-limiting");
-const util_1 = require("../util");
-const censor_list_1 = __importDefault(require("../util/censor/censor-list"));
-const error_1 = require("../validation/error");
-const logger = (0, util_1.makeLogger)('Adapter');
-/**
- * Main class to represent an External Adapter
- */
-class Adapter {
-    constructor(params) {
-        // After initialization
-        this.initialized = false;
-        /** Object containing alias translations for all endpoints */
-        this.endpointsMap = {};
-        // Copy over params
-        this.name = params.name;
-        this.defaultEndpoint = params.defaultEndpoint?.toLowerCase();
-        this.endpoints = params.endpoints;
-        this.envDefaultOverrides = params.envDefaultOverrides;
-        this.customSettings = params.customSettings;
-        this.rateLimiting = params.rateLimiting;
-        this.overrides = params.overrides;
-        this.requestTransforms = [this.symbolOverrider.bind(this), ...(params.requestTransforms || [])];
-        this.bootstrap = params.bootstrap;
-        this.config = (0, config_1.buildAdapterConfig)({
-            overrides: this.envDefaultOverrides,
-            customSettings: this.customSettings,
-        });
-        this.normalizeEndpointNames();
-        this.calculateRateLimitAllocations();
-    }
-    /**
-     * Initializes all of the [[Transport]]s in the adapter, passing along any [[AdapterDependencies]] and [[AdapterConfig]].
-     * Additionally, it builds a map out of all the endpoint names and aliases (checking for duplicates).
-     */
-    async initialize(dependencies) {
-        if (this.initialized) {
-            throw new Error('This adapter has already been initialized!');
-        }
-        if (this.bootstrap) {
-            await this.bootstrap(this);
-        }
-        this.dependencies = this.initializeDependencies(dependencies);
-        for (const endpoint of this.endpoints) {
-            // Add aliases to map to use in validation
-            const aliases = [endpoint.name, ...(endpoint.aliases || [])];
-            for (const alias of aliases) {
-                if (this.endpointsMap[alias]) {
-                    throw new Error(`Duplicate endpoint / alias: "${alias}"`);
-                }
-                this.endpointsMap[alias] = endpoint;
-            }
-            logger.debug(`Initializing transport for endpoint "${endpoint.name}"...`);
-            await endpoint.transport.initialize(this.dependencies, this.config, endpoint.name);
-        }
-        // Build list of key/values that need to be redacted in logs
-        // Populates the static array in CensorList to use in censor-transport
-        this.buildCensorList();
-        logger.debug('Adapter initialization complete.');
-        this.initialized = true;
-    }
-    /**
-     * Takes an adapter and normalizes all endpoint names and aliases, as well as the default endpoint.
-     * i.e. makes them lowercase for now
-     */
-    normalizeEndpointNames() {
-        for (const endpoint of this.endpoints) {
-            endpoint.name = endpoint.name.toLowerCase();
-            endpoint.aliases = endpoint.aliases?.map((a) => a.toLowerCase());
-        }
-    }
-    /**
-     * This function will take an adapter structure and go through each endpoint, calculating
-     * each one's allocation of the total rate limits that are set for the adapter as a whole.
-     *
-     */
-    calculateRateLimitAllocations() {
-        const numberOfEndpoints = this.endpoints.length;
-        const endpointsWithExplicitAllocations = this.endpoints.filter((e) => e.rateLimiting);
-        const totalExplicitAllocation = endpointsWithExplicitAllocations
-            .map((e) => e.rateLimiting?.allocationPercentage || 0)
-            .reduce((sum, next) => sum + next, 0);
-        if (totalExplicitAllocation > 100) {
-            throw new Error('The total allocation set for all endpoints summed cannot exceed 100%');
-        }
-        if (totalExplicitAllocation === 100 &&
-            numberOfEndpoints - endpointsWithExplicitAllocations.length > 0) {
-            throw new Error('The explicit allocation is at 100% but there are endpoints with implicit allocation');
-        }
-        const implicitAllocation = 100 - totalExplicitAllocation;
-        logger.debug('Adapter rate limit allocations:');
-        for (const endpoint of this.endpoints) {
-            if (!endpoint.rateLimiting) {
-                endpoint.rateLimiting = {
-                    allocationPercentage: implicitAllocation / (numberOfEndpoints - endpointsWithExplicitAllocations.length),
-                };
-            }
-            logger.debug(`Endpoint [${endpoint.name}] - ${endpoint.rateLimiting?.allocationPercentage}%`);
-        }
-    }
-    /**
-     * Creates a list of key/value pairs that need to be censored in the logs
-     * using the sensitive flag in the adapter config
-     */
-    buildCensorList() {
-        const censorList = Object.entries(config_1.BaseSettings)
-            .concat(Object.entries(this.customSettings || {}))
-            .filter(([name, setting]) => setting &&
-            setting.type === 'string' &&
-            setting.sensitive &&
-            this.config[name])
-            .map(([name]) => ({
-            key: name,
-            // Escaping potential special characters in values before creating regex
-            value: new RegExp(
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            this.config[name].replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&'), 'gi'),
-        }));
-        censor_list_1.default.set(censorList);
-    }
-    /**
-     * This function will process dependencies for an adapter, such as caches or rate limiters,
-     * in order to inject them into transports and other relevant places later in the lifecycle.
-     *
-     * @param inputDependencies - a partial obj of initialized dependencies to override the created ones
-     * @returns a set of AdapterDependencies all initialized
-     */
-    initializeDependencies(inputDependencies) {
-        const dependencies = inputDependencies || {};
-        if (!dependencies.redisClient) {
-            if (this.config.CACHE_TYPE === 'redis') {
-                dependencies.redisClient = new ioredis_1.default({
-                    enableAutoPipelining: true,
-                    host: this.config.CACHE_REDIS_HOST,
-                    port: this.config.CACHE_REDIS_PORT,
-                    password: this.config.CACHE_REDIS_PASSWORD,
-                    path: this.config.CACHE_REDIS_PATH,
-                    timeout: this.config.CACHE_REDIS_TIMEOUT,
-                });
-                dependencies.redisClient.on('connect', () => {
-                    cacheMetrics.redisConnectionsOpen.inc();
-                });
-            }
-        }
-        if (!dependencies.cache) {
-            dependencies.cache = cache_1.CacheFactory.buildCache(this.config.CACHE_TYPE, dependencies.redisClient);
-        }
-        const rateLimitingTier = (0, rate_limiting_1.getRateLimitingTier)(this.config, this.rateLimiting?.tiers);
-        if (!dependencies.requestRateLimiter) {
-            dependencies.requestRateLimiter = new rate_limiting_1.SimpleCountingRateLimiter().initialize(this.endpoints, rateLimitingTier);
-        }
-        if (!dependencies.backgroundExecuteRateLimiter) {
-            dependencies.backgroundExecuteRateLimiter = new rate_limiting_1.FixedFrequencyRateLimiter().initialize(this.endpoints, rateLimitingTier);
-        }
-        if (!dependencies.subscriptionSetFactory) {
-            dependencies.subscriptionSetFactory = new util_1.SubscriptionSetFactory(this.config, this.name, dependencies.redisClient);
-        }
-        return dependencies;
-    }
-    /**
-     * Attempts to find a value from the Cache and return that if found.
-     *
-     * @param req - the incoming request to this adapter
-     * @returns the cached value if exists
-     */
-    async findResponseInCache(req) {
-        const response = await this.dependencies.cache.get(req.requestContext.cacheKey);
-        if (response) {
-            if (this.config.METRICS_ENABLED && this.config.EXPERIMENTAL_METRICS_ENABLED) {
-                const label = cacheMetrics.cacheMetricsLabel(req.requestContext.cacheKey, req.requestContext.meta?.metrics?.feedId || 'N/A', this.config.CACHE_TYPE);
-                // Record cache staleness and cache get count and value
-                const staleness = (0, cache_1.calculateStaleness)(response.maxAge, this.config.CACHE_MAX_AGE);
-                cacheMetrics.cacheGet(label, response.result, staleness);
-                req.requestContext.meta = {
-                    ...req.requestContext.meta,
-                    metrics: { ...req.requestContext.meta?.metrics, cacheHit: true },
-                };
-            }
-            return response;
-        }
-    }
-    /**
-     * Default request transform that takes requests and manipulates
-     *
-     * @param adapter - the current adapter
-     * @param req - the current adapter request
-     * @returns the modified (or new) request
-     */
-    symbolOverrider(req) {
-        const rawRequestBody = req.body;
-        const requestOverrides = rawRequestBody.data?.overrides?.[this.name.toLowerCase()];
-        const base = req.requestContext.data['base'];
-        // Perform overrides specified in the request payload
-        if (requestOverrides?.[base]) {
-            req.requestContext.data['base'] = requestOverrides[base];
-        }
-        // Perform hardcoded adapter overrides
-        if (this.overrides?.[base]) {
-            req.requestContext.data['base'] = this.overrides[base];
-        }
-        return req;
-    }
-    /**
-     * Takes the incoming request and applies all request transforms in the adapter
-     *
-     * @param req - the current adapter request
-     * @returns the request after passing through all request transforms
-     */
-    runRequestTransforms(req) {
-        if (!this.requestTransforms) {
-            return;
-        }
-        for (const transform of this.requestTransforms) {
-            transform(req);
-        }
-    }
-    /**
-     * Function to serve as middleware to pass along the AdapterRequest to the appropriate Transport (acc. to the endpoint in the req.)
-     *
-     * @param req - the incoming request to this adapter
-     * @param replySent - a promise that resolves when the reply has already been sent
-     * @returns a simple Promise when it's done
-     */
-    async handleRequest(req, replySent) {
-        // Get transport, must be here because it's already checked in the validator
-        const transport = this.endpointsMap[req.requestContext.endpointName].transport;
-        // First try to find the response in our cache, keep it ready
-        const cachedResponse = await this.findResponseInCache(req);
-        // Next we fire off the transport's registration of the request if defined, regardless of if we already have a cached response.
-        // This is necessary to ensure things like subscription sets are updated each time we get a request
-        let requestRegistrationPromise;
-        if (transport.registerRequest) {
-            const handler = async () => {
-                // If we already have a cached response, wait for it to be sent back before continuing with registration
-                // This way we respond to incoming requests from the cache as fast as possible
-                if (cachedResponse) {
-                    await replySent;
-                }
-                // Disable the non-null assertion error, since we're checking this exists in the if above
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                return transport.registerRequest(req, this.config);
-            };
-            // Execute the registration handler without blocking
-            logger.debug(`Firing request registration handler${cachedResponse ? ' (cached response already sent)' : ''}`);
-            requestRegistrationPromise = handler();
-        }
-        // Now that we have dealt with request registration, we can return the cached response if present
-        if (cachedResponse) {
-            logger.debug('Found response from cache, sending that');
-            return cachedResponse;
-        }
-        // If there was no cached response, execute the foregroundExecute if defined
-        const immediateResponse = transport.foregroundExecute && (await transport.foregroundExecute(req, this.config));
-        if (immediateResponse) {
-            logger.debug('Got immediate response from transport, sending as response');
-            return immediateResponse;
-        }
-        // Finally, either because there was no synchronous execute or because it returned an empty response,
-        // we wait for the cache to be filled (either from background work started in the sync execute, or the backgroundExecute).
-        // We can wait for the request registration to have finished here, since we're going to be sleeping for the cache anyways,
-        // and it's useful in case the registration throws a promise so that it doesn't go unhandled.
-        await requestRegistrationPromise;
-        // Observe the idle time taken for polling response
-        const metricsTimer = transportMetrics.transportPollingDurationSeconds
-            .labels({ endpoint: req.requestContext.endpointName })
-            .startTimer();
-        logger.debug('Transport is set up, polling cache for response...');
-        const response = await (0, cache_1.pollResponseFromCache)(this.dependencies.cache, req.requestContext.cacheKey, {
-            maxRetries: this.config.CACHE_POLLING_MAX_RETRIES,
-            sleep: this.config.CACHE_POLLING_SLEEP_MS,
-        });
-        metricsTimer({ succeeded: String(!!response) });
-        if (response) {
-            logger.debug('Got a response from polling the cache, sending that back');
-            return response;
-        }
-        // Record polling mechanism failure to return response
-        transportMetrics.transportPollingFailureCount
-            .labels({ endpoint: req.requestContext.endpointName })
-            .inc();
-        logger.debug('Ran out of polling attempts, returning timeout');
-        throw new error_1.AdapterTimeoutError({
-            message: 'Timed out waiting for provider result.',
-            statusCode: 504,
-        });
-    }
-}
-exports.Adapter = Adapter;
-//# sourceMappingURL=basic.js.map