@chainlink/external-adapter-framework 0.0.14 → 0.0.16

package/package/cache/local.js

@@ -1,83 +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.LocalCache = void 0;
-const util_1 = require("../util");
-const cacheMetrics = __importStar(require("./metrics"));
-const logger = (0, util_1.makeLogger)('LocalCache');
-/**
- * Local implementation of a Cache. It uses a simple js Object, storing entries with both
- * a value and an expiration timestamp. Expired entries are deleted on reads (i.e. no background gc/upkeep).
- *
- * @typeParam T - the type for the entries' values
- */
-class LocalCache {
-    constructor() {
-        this.store = {};
-    }
-    async get(key) {
-        logger.trace(`Getting key ${key}`);
-        const entry = this.store[key];
-        if (!entry) {
-            logger.debug(`No entry in local cache for key "${key}", returning undefined`);
-            return undefined;
-        }
-        const expired = entry.expirationTimestamp <= Date.now();
-        if (expired) {
-            logger.debug('Entry in local cache expired, deleting and returning undefined');
-            this.delete(key);
-            return undefined;
-        }
-        else {
-            logger.debug('Found valid entry in local cache, returning value');
-            return entry.value;
-        }
-    }
-    async delete(key) {
-        logger.trace(`Deleting key ${key}`);
-        delete this.store[key]; // Deletes are slower than ignoring or setting null, fyi
-    }
-    async set(key, value, ttl) {
-        logger.trace(`Setting key ${key} with ttl ${ttl}`);
-        this.store[key] = {
-            value,
-            expirationTimestamp: Date.now() + ttl,
-        };
-        // Only record metrics if feed Id is present, otherwise assuming value is not adapter response to record
-        const feedId = value.meta?.metrics?.feedId;
-        if (feedId) {
-            // Record cache set count, max age, and staleness (set to 0 for cache set)
-            const label = cacheMetrics.cacheMetricsLabel(key, feedId, cacheMetrics.CacheTypes.Local);
-            cacheMetrics.cacheSet(label, ttl);
-        }
-    }
-    async setMany(entries, ttl) {
-        logger.trace(`Setting a bunch of keys with ttl ${ttl}`);
-        for (const { key, value } of entries) {
-            this.set(key, value, ttl);
-        }
-    }
-}
-exports.LocalCache = LocalCache;

package/package/cache/metrics.d.ts

@@ -1,27 +0,0 @@
-import * as client from 'prom-client';
-interface CacheMetricsLabels {
-    participant_id: string;
-    feed_id: string;
-    cache_type: string;
-}
-export declare const cacheGet: (label: CacheMetricsLabels, value: unknown, staleness: number) => void;
-export declare const cacheSet: (label: CacheMetricsLabels, maxAge: number) => void;
-export declare const cacheMetricsLabel: (cacheKey: string, feedId: string, cacheType: string) => {
-    participant_id: string;
-    feed_id: string;
-    cache_type: string;
-};
-export declare enum CacheTypes {
-    Redis = "redis",
-    Local = "local"
-}
-export declare enum CMD_SENT_STATUS {
-    TIMEOUT = "TIMEOUT",
-    FAIL = "FAIL",
-    SUCCESS = "SUCCESS"
-}
-export declare const redisConnectionsOpen: client.Counter<string>;
-export declare const redisRetriesCount: client.Counter<string>;
-export declare const redisCommandsSentCount: client.Counter<"status" | "function_name">;
-export declare const cacheWarmerCount: client.Gauge<"isBatched">;
-export {};

package/package/cache/metrics.js

@@ -1,120 +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.cacheWarmerCount = exports.redisCommandsSentCount = exports.redisRetriesCount = exports.redisConnectionsOpen = exports.CMD_SENT_STATUS = exports.CacheTypes = exports.cacheMetricsLabel = exports.cacheSet = exports.cacheGet = void 0;
-const client = __importStar(require("prom-client"));
-const cacheGet = (label, value, staleness) => {
-    if (typeof value === 'number' || typeof value === 'string') {
-        const parsedValue = Number(value);
-        if (!Number.isNaN(parsedValue) && Number.isFinite(parsedValue)) {
-            cacheDataGetValues.labels(label).set(parsedValue);
-        }
-    }
-    cacheDataGetCount.labels(label).inc();
-    cacheDataStalenessSeconds.labels(label).set(staleness);
-};
-exports.cacheGet = cacheGet;
-const cacheSet = (label, maxAge) => {
-    cacheDataSetCount.labels(label).inc();
-    cacheDataMaxAge.labels(label).set(maxAge);
-    cacheDataStalenessSeconds.labels(label).set(0);
-};
-exports.cacheSet = cacheSet;
-const cacheMetricsLabel = (cacheKey, feedId, cacheType) => ({
-    participant_id: cacheKey,
-    feed_id: feedId,
-    cache_type: cacheType,
-});
-exports.cacheMetricsLabel = cacheMetricsLabel;
-var CacheTypes;
-(function (CacheTypes) {
-    CacheTypes["Redis"] = "redis";
-    CacheTypes["Local"] = "local";
-})(CacheTypes = exports.CacheTypes || (exports.CacheTypes = {}));
-var CMD_SENT_STATUS;
-(function (CMD_SENT_STATUS) {
-    CMD_SENT_STATUS["TIMEOUT"] = "TIMEOUT";
-    CMD_SENT_STATUS["FAIL"] = "FAIL";
-    CMD_SENT_STATUS["SUCCESS"] = "SUCCESS";
-})(CMD_SENT_STATUS = exports.CMD_SENT_STATUS || (exports.CMD_SENT_STATUS = {}));
-const baseLabels = [
-    'feed_id',
-    'participant_id',
-    'cache_type',
-    'is_from_ws',
-    'experimental',
-];
-// Skipping this metrics for v3
-// const cache_execution_duration_seconds = new client.Histogram({
-//   name: 'cache_execution_duration_seconds',
-//   help: 'A histogram bucket of the distribution of cache execution durations',
-//   labelNames: [...baseLabels, 'cache_hit'] as const,
-//   buckets: [0.01, 0.1, 1, 10],
-// })
-const cacheDataGetCount = new client.Counter({
-    name: 'cache_data_get_count',
-    help: 'A counter that increments every time a value is fetched from the cache',
-    labelNames: baseLabels,
-});
-const cacheDataGetValues = new client.Gauge({
-    name: 'cache_data_get_values',
-    help: 'A gauge keeping track of values being fetched from cache',
-    labelNames: baseLabels,
-});
-const cacheDataMaxAge = new client.Gauge({
-    name: 'cache_data_max_age',
-    help: 'A gauge tracking the max age of stored values in the cache',
-    labelNames: baseLabels,
-});
-const cacheDataSetCount = new client.Counter({
-    name: 'cache_data_set_count',
-    help: 'A counter that increments every time a value is set to the cache',
-    labelNames: [...baseLabels, 'status_code'],
-});
-const cacheDataStalenessSeconds = new client.Gauge({
-    name: 'cache_data_staleness_seconds',
-    help: 'Observes the staleness of the data returned',
-    labelNames: baseLabels,
-});
-// Redis Metrics
-exports.redisConnectionsOpen = new client.Counter({
-    name: 'redis_connections_open',
-    help: 'The number of redis connections that are open',
-});
-exports.redisRetriesCount = new client.Counter({
-    name: 'redis_retries_count',
-    help: 'The number of retries that have been made to establish a redis connection',
-});
-exports.redisCommandsSentCount = new client.Counter({
-    name: 'redis_commands_sent_count',
-    help: 'The number of redis commands sent',
-    labelNames: ['status', 'function_name'],
-});
-// Cache Warmer Metrics
-exports.cacheWarmerCount = new client.Gauge({
-    name: 'cache_warmer_get_count',
-    help: 'The number of cache warmers running',
-    labelNames: ['isBatched'],
-});

package/package/cache/redis.d.ts

@@ -1,16 +0,0 @@
-import Redis from 'ioredis';
-import { Cache, CacheEntry } from './index';
-/**
- * Redis implementation of a Cache. It uses a simple js Object, storing entries with both
- * a value and an expiration timestamp. Expired entries are deleted on reads (i.e. no background gc/upkeep).
- *
- * @typeParam T - the type for the entries' values
- */
-export declare class RedisCache<T = unknown> implements Cache<T> {
-    private client;
-    constructor(client: Redis);
-    get(key: string): Promise<T | undefined>;
-    delete(key: string): Promise<void>;
-    set(key: string, value: T, ttl: number): Promise<void>;
-    setMany(entries: CacheEntry<T>[], ttl: number): Promise<void>;
-}

package/package/cache/redis.js

@@ -1,100 +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.RedisCache = void 0;
-const util_1 = require("../util");
-const cacheMetrics = __importStar(require("./metrics"));
-const logger = (0, util_1.makeLogger)('RedisCache');
-/**
- * Redis implementation of a Cache. It uses a simple js Object, storing entries with both
- * a value and an expiration timestamp. Expired entries are deleted on reads (i.e. no background gc/upkeep).
- *
- * @typeParam T - the type for the entries' values
- */
-// TODO: Add error handling for redis command failures
-class RedisCache {
-    constructor(client) {
-        this.client = client;
-    }
-    async get(key) {
-        logger.trace(`Getting key ${key}`);
-        const value = await this.client.get(key);
-        // Record get command sent to Redis
-        cacheMetrics.redisCommandsSentCount
-            .labels({ status: cacheMetrics.CMD_SENT_STATUS.SUCCESS, function_name: 'get' })
-            .inc();
-        if (!value) {
-            logger.debug(`No entry in redis cache for key "${key}", returning undefined`);
-            return undefined;
-        }
-        return JSON.parse(value); // TODO: Check for invalid parsing
-    }
-    async delete(key) {
-        logger.trace(`Deleting key ${key}`);
-        await this.client.del(key);
-        // Record delete command sent to Redis
-        cacheMetrics.redisCommandsSentCount
-            .labels({ status: cacheMetrics.CMD_SENT_STATUS.SUCCESS, function_name: 'delete' })
-            .inc();
-    }
-    async set(key, value, ttl) {
-        logger.trace(`Setting key ${key}`);
-        // TODO: Check for invalid stringify
-        await this.client.set(key, JSON.stringify(value), 'PX', ttl);
-        // Only record metrics if feed Id is present, otherwise assuming value is not adapter response to record
-        const feedId = value.meta?.metrics?.feedId;
-        if (feedId) {
-            // Record cache set count, max age, and staleness (set to 0 for cache set)
-            const label = cacheMetrics.cacheMetricsLabel(key, feedId, cacheMetrics.CacheTypes.Redis);
-            cacheMetrics.cacheSet(label, ttl);
-        }
-        // Record set command sent to Redis
-        cacheMetrics.redisCommandsSentCount
-            .labels({ status: cacheMetrics.CMD_SENT_STATUS.SUCCESS, function_name: 'set' })
-            .inc();
-    }
-    async setMany(entries, ttl) {
-        logger.trace(`Setting a bunch of keys`);
-        // Unfortunately, there's no ttl for mset
-        let chain = this.client.multi();
-        for (const entry of entries) {
-            chain = chain.set(entry.key, JSON.stringify(entry.value), 'PX', ttl);
-            // TODO: Move to after error handling once implemented to avoid recording cache sets that failed
-            // Only record metrics if feed Id is present, otherwise assuming value is not adapter response to record
-            const feedId = entry.value.meta?.metrics?.feedId;
-            if (feedId) {
-                // Record cache set count, max age, and staleness (set to 0 for cache set)
-                const label = cacheMetrics.cacheMetricsLabel(entry.key, feedId, cacheMetrics.CacheTypes.Redis);
-                cacheMetrics.cacheSet(label, ttl);
-            }
-        }
-        await chain.exec();
-        // Record setMany command sent to Redis
-        cacheMetrics.redisCommandsSentCount
-            .labels({ status: cacheMetrics.CMD_SENT_STATUS.SUCCESS, function_name: 'exec' })
-            .inc();
-    }
-}
-exports.RedisCache = RedisCache;

package/package/config/index.d.ts

@@ -1,195 +0,0 @@
-export declare const BaseSettings: {
-    readonly API_KEY: {
-        readonly description: "Default setting for an EA key";
-        readonly type: "string";
-    };
-    readonly BASE_URL: {
-        readonly description: "Starting path for the EA handler endpoint";
-        readonly type: "string";
-        readonly default: "/";
-    };
-    readonly CACHE_MAX_AGE: {
-        readonly description: "Maximum amount of time (in ms) that a response will stay cached";
-        readonly type: "number";
-        readonly default: 90000;
-    };
-    readonly CACHE_REDIS_HOST: {
-        readonly description: "Hostname for the Redis instance to be used";
-        readonly type: "string";
-        readonly default: "127.0.0.1";
-    };
-    readonly CACHE_REDIS_PORT: {
-        readonly description: "Port for the Redis instance to be used";
-        readonly type: "number";
-        readonly default: 6379;
-    };
-    readonly CACHE_TYPE: {
-        readonly description: "The type of cache to use throughout the EA";
-        readonly type: "enum";
-        readonly default: "local";
-        readonly options: readonly ["local", "redis"];
-    };
-    readonly CORRELATION_ID_ENABLED: {
-        readonly description: "Flag to enable correlation IDs for sent requests in logging";
-        readonly type: "boolean";
-        readonly default: true;
-    };
-    readonly EA_PORT: {
-        readonly description: "Port through which the EA will listen for REST requests (if mode is set to \"reader\" or \"reader-writer\")";
-        readonly type: "number";
-        readonly default: 8080;
-    };
-    readonly EXPERIMENTAL_METRICS_ENABLED: {
-        readonly description: "Flag to specify whether or not to collect metrics. Used as fallback for METRICS_ENABLED";
-        readonly type: "boolean";
-        readonly default: true;
-    };
-    readonly LOG_LEVEL: {
-        readonly description: "Minimum level required for logs to be output";
-        readonly type: "string";
-        readonly default: "info";
-    };
-    readonly METRICS_ENABLED: {
-        readonly description: "Flag to specify whether or not to startup the metrics server";
-        readonly type: "boolean";
-        readonly default: true;
-    };
-    readonly METRICS_NAME: {
-        readonly description: "Metrics name";
-        readonly type: "string";
-    };
-    readonly METRICS_PORT: {
-        readonly description: "Port metrics will be exposed to";
-        readonly type: "number";
-        readonly default: 9080;
-    };
-    readonly METRICS_USE_BASE_URL: {
-        readonly description: "Flag to specify whether or not to prepend the BASE_URL to the metrics endpoint";
-        readonly type: "boolean";
-    };
-    readonly RATE_LIMIT_API_TIER: {
-        readonly description: "Rate limiting tier to use from the available options for the adapter. If not present, the adapter will run using the first tier on the list.";
-        readonly type: "string";
-    };
-    readonly WARMUP_SUBSCRIPTION_TTL: {
-        readonly type: "number";
-        readonly description: "";
-        readonly default: 10000;
-    };
-    readonly CACHE_POLLING_MAX_RETRIES: {
-        readonly description: "Max amount of times to attempt to find EA response in the cache after the Transport has been set up";
-        readonly type: "number";
-        readonly default: 10;
-    };
-    readonly CACHE_POLLING_SLEEP_MS: {
-        readonly description: "The number of ms to sleep between each retry to fetch the EA response in the cache";
-        readonly type: "number";
-        readonly default: 200;
-    };
-    readonly DEFAULT_CACHE_KEY: {
-        readonly description: "Default key to be used when one cannot be determined from request parameters";
-        readonly type: "string";
-        readonly default: "DEFAULT_CACHE_KEY";
-    };
-    readonly EA_HOST: {
-        readonly description: "Host this EA will listen for REST requests on (if mode is set to \"reader\" or \"reader-writer\")";
-        readonly type: "string";
-        readonly default: "::";
-    };
-    readonly EA_MODE: {
-        readonly description: "Port this EA will listen for REST requests on (if mode is set to \"reader\" or \"reader-writer\")";
-        readonly type: "enum";
-        readonly default: "reader-writer";
-        readonly options: readonly ["reader", "writer", "reader-writer"];
-    };
-    readonly REST_TRANSPORT_MAX_RATE_LIMIT_RETRIES: {
-        readonly description: "Maximum amount of times the Rest Transport will attempt to set up a request when blocked by the rate limiter";
-        readonly type: "number";
-        readonly default: 3;
-    };
-    readonly REST_TRANSPORT_MS_BETWEEN_RATE_LIMIT_RETRIES: {
-        readonly description: "Time that the Rest Transport will wait between retries when blocked by the rate limiter";
-        readonly type: "number";
-        readonly default: 400;
-    };
-};
-export declare const buildAdapterConfig: <CustomSettings extends CustomSettingsType<CustomSettings> = EmptySettings>({ overrides, customSettings, }: {
-    overrides?: Partial<BaseAdapterConfig> | undefined;
-    customSettings?: SettingsMap | undefined;
-}) => AdapterConfig<CustomSettings>;
-declare type SettingValueType = string | number | boolean;
-declare type SettingType<C extends Setting> = C['type'] extends 'string' ? string : C['type'] extends 'number' ? number : C['type'] extends 'boolean' ? boolean : C['type'] extends 'enum' ? C['options'] extends readonly string[] ? C['options'][number] : never : never;
-declare type BaseSettingsType = typeof BaseSettings;
-export declare type Setting = {
-    type: 'string';
-    description: string;
-    options?: never;
-    default?: string;
-    validate?: (value?: string) => ValidationErrorMessage;
-    required?: false;
-} | {
-    type: 'string';
-    description: string;
-    options?: never;
-    default?: string;
-    validate?: (value: string) => ValidationErrorMessage;
-    required: true;
-} | {
-    type: 'number';
-    description: string;
-    options?: never;
-    default?: number;
-    validate?: (value?: number) => ValidationErrorMessage;
-    required?: false;
-} | {
-    type: 'number';
-    description: string;
-    options?: never;
-    default?: number;
-    validate?: (value: number) => ValidationErrorMessage;
-    required: true;
-} | {
-    type: 'boolean';
-    description: string;
-    options?: never;
-    default?: boolean;
-    validate?: (value?: boolean) => ValidationErrorMessage;
-    required?: false;
-} | {
-    type: 'boolean';
-    description: string;
-    options?: never;
-    default?: boolean;
-    validate?: (value: boolean) => ValidationErrorMessage;
-    required: true;
-} | {
-    type: 'enum';
-    description: string;
-    default?: string;
-    options: readonly string[];
-    validate?: (value?: string) => ValidationErrorMessage;
-    required?: false;
-} | {
-    type: 'enum';
-    description: string;
-    default?: string;
-    options: readonly string[];
-    validate?: (value: string) => ValidationErrorMessage;
-    required: true;
-};
-export declare type AdapterConfigFromSettings<T extends SettingsMap> = {
-    -readonly [K in keyof T as T[K] extends {
-        default: SettingValueType;
-    } ? K : T[K]['required'] extends true ? K : never]: SettingType<T[K]>;
-} & {
-    -readonly [K in keyof T as T[K] extends {
-        default: SettingValueType;
-    } ? never : T[K]['required'] extends true ? never : K]?: SettingType<T[K]> | undefined;
-};
-export declare type BaseAdapterConfig = AdapterConfigFromSettings<BaseSettingsType>;
-export declare type AdapterConfig<T extends CustomSettingsType<T> = SettingsMap> = AdapterConfigFromSettings<T> & BaseAdapterConfig;
-export declare type CustomSettingsType<T = SettingsMap> = Record<keyof T, Setting>;
-export declare type EmptySettings = Record<string, never>;
-export declare type SettingsMap = Record<string, Setting>;
-export declare type ValidationErrorMessage = string | undefined;
-export {};