@chainlink/external-adapter-framework 0.3.7 → 0.4.0

package/cache/index.js

@@ -1,133 +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.pollResponseFromCache = exports.calculateStaleness = exports.calculateKey = exports.calculateFeedId = exports.calculateCacheKey = void 0;
-const util_1 = require("../util");
-__exportStar(require("./factory"), exports);
-__exportStar(require("./local"), exports);
-__exportStar(require("./redis"), exports);
-const logger = (0, util_1.makeLogger)('Cache');
-// Uses calculateKey to generate a unique key from the endpoint name, data, and input parameters
-const calculateCacheKey = ({ adapterEndpoint, adapterConfig, }, data) => {
-    const paramNames = Object.keys(adapterEndpoint.inputParameters);
-    if (paramNames.length === 0) {
-        logger.trace(`Using default cache key ${adapterConfig.DEFAULT_CACHE_KEY}`);
-        return adapterConfig.DEFAULT_CACHE_KEY;
-    }
-    const cacheKey = `${adapterEndpoint.name}-${(0, exports.calculateKey)(data, paramNames, adapterConfig)}`;
-    logger.trace(`Generated cache key for request: "${cacheKey}"`);
-    return cacheKey;
-};
-exports.calculateCacheKey = calculateCacheKey;
-const calculateFeedId = ({ adapterEndpoint, adapterConfig, }, data) => {
-    const paramNames = Object.keys(adapterEndpoint.inputParameters);
-    if (paramNames.length === 0) {
-        logger.trace(`Cannot generate Feed ID without input parameters`);
-        return 'N/A';
-    }
-    return (0, exports.calculateKey)(data, paramNames, adapterConfig);
-};
-exports.calculateFeedId = calculateFeedId;
-/**
- * Calculates a unique key from the provided data.
- *
- * @param data - the request data/body, i.e. the adapter input params
- * @param paramNames - the keys from adapter endpoint input parameters
- * @returns the calculated unique key
- *
- * @example
- * ```
- * calculateKey({ base: 'ETH', quote: 'BTC' }, ['base','quote'])
- * // equals `|base:eth|quote:btc`
- * ```
- */
-const calculateKey = (data, paramNames, adapterConfig) => {
-    if (data && typeof data !== 'object') {
-        throw new Error('Data to calculate cache key should be an object');
-    }
-    const params = data;
-    let cacheKey = '';
-    for (const paramName of paramNames) {
-        const param = params[paramName];
-        if (param === undefined) {
-            continue;
-        }
-        cacheKey += `|${paramName}:`;
-        switch (typeof param) {
-            case 'string':
-                cacheKey += param.toLowerCase();
-                break;
-            case 'number':
-            case 'boolean':
-                cacheKey += param.toString();
-                break;
-            case 'object':
-                // Force cache keys to only use performant properties of the input params.
-                // If the object were to be used, we'd have to sort its properties.
-                logger.debug(`Property "${paramName}" in request parameters is of type object, and won't be used in the cacheKey`);
-        }
-    }
-    if (cacheKey.length > adapterConfig.MAX_COMMON_KEY_SIZE) {
-        logger.warn(`Generated cache key for adapter request is bigger than the MAX_COMMON_KEY_SIZE and will be truncated`);
-        cacheKey = cacheKey.slice(0, adapterConfig.MAX_COMMON_KEY_SIZE);
-    }
-    return cacheKey;
-};
-exports.calculateKey = calculateKey;
-// Calculate the amount of time a non-expired entry has been in the cache
-const calculateStaleness = (expirationTimestamp, ttl) => {
-    if (expirationTimestamp) {
-        const createTimestamp = expirationTimestamp - ttl;
-        return (Date.now() - createTimestamp) / 1000;
-    }
-    else {
-        // If expirationTimestamp is not available, staleness cannot be calculated
-        // Defaults to ttl for metrics purposes
-        return ttl;
-    }
-};
-exports.calculateStaleness = calculateStaleness;
-/**
- * Polls the provided Cache for an AdapterResponse set in the provided key. If the maximum
- * amount of retries is exceeded, it returns undefined instead.
- *
- * @param cache - a Cache instance
- * @param key - the key generated from an AdapterRequest that corresponds to the desired AdapterResponse
- * @param retry - current retry, only for internal use
- * @returns the AdapterResponse if found, else undefined
- */
-const pollResponseFromCache = async (cache, key, options, retry = 0) => {
-    if (retry > options.maxRetries) {
-        // Ideally this shouldn't happen often (p99 of reqs should be found in the cache)
-        logger.info('Exceeded max cache polling retries');
-        return undefined;
-    }
-    logger.trace('Getting response from cache...');
-    const response = await cache.get(key);
-    if (response) {
-        logger.trace('Got response from cache');
-        return response;
-    }
-    if (options.maxRetries === 0) {
-        logger.debug(`Response not found, retries disabled`);
-        return undefined;
-    }
-    logger.debug(`Response not found, sleeping ${options.sleep} milliseconds...`);
-    await (0, util_1.sleep)(options.sleep);
-    return (0, exports.pollResponseFromCache)(cache, key, options, retry + 1);
-};
-exports.pollResponseFromCache = pollResponseFromCache;
-//# sourceMappingURL=index.js.map

package/cache/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cache/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAEA,kCAA4D;AAE5D,4CAAyB;AACzB,0CAAuB;AACvB,0CAAuB;AAEvB,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,OAAO,CAAC,CAAA;AAoDlC,gGAAgG;AACzF,MAAM,iBAAiB,GAAG,CAC/B,EACE,eAAe,EACf,aAAa,GAId,EACD,IAAa,EACL,EAAE;IACV,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,CAAA;IAC/D,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;QAC3B,MAAM,CAAC,KAAK,CAAC,2BAA2B,aAAa,CAAC,iBAAiB,EAAE,CAAC,CAAA;QAC1E,OAAO,aAAa,CAAC,iBAAiB,CAAA;KACvC;IACD,MAAM,QAAQ,GAAG,GAAG,eAAe,CAAC,IAAI,IAAI,IAAA,oBAAY,EAAC,IAAI,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,CAAA;IAC3F,MAAM,CAAC,KAAK,CAAC,qCAAqC,QAAQ,GAAG,CAAC,CAAA;IAC9D,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAlBY,QAAA,iBAAiB,qBAkB7B;AAEM,MAAM,eAAe,GAAG,CAC7B,EACE,eAAe,EACf,aAAa,GAId,EACD,IAAa,EACL,EAAE;IACV,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,eAAe,CAAC,CAAA;IAC/D,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;QAC3B,MAAM,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAA;QAChE,OAAO,KAAK,CAAA;KACb;IACD,OAAO,IAAA,oBAAY,EAAC,IAAI,EAAE,UAAU,EAAE,aAAa,CAAC,CAAA;AACtD,CAAC,CAAA;AAhBY,QAAA,eAAe,mBAgB3B;AAED;;;;;;;;;;;;GAYG;AACI,MAAM,YAAY,GAAG,CAC1B,IAAa,EACb,UAAoB,EACpB,aAA4C,EACpC,EAAE;IACV,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QACpC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;KACnE;IAED,MAAM,MAAM,GAAG,IAA+B,CAAA;IAE9C,IAAI,QAAQ,GAAG,EAAE,CAAA;IACjB,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;QAClC,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAA;QAC/B,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,SAAQ;SACT;QAED,QAAQ,IAAI,IAAI,SAAS,GAAG,CAAA;QAC5B,QAAQ,OAAO,KAAK,EAAE;YACpB,KAAK,QAAQ;gBACX,QAAQ,IAAI,KAAK,CAAC,WAAW,EAAE,CAAA;gBAC/B,MAAK;YACP,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS;gBACZ,QAAQ,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAA;gBAC5B,MAAK;YACP,KAAK,QAAQ;gBACX,0EAA0E;gBAC1E,mEAAmE;gBACnE,MAAM,CAAC,KAAK,CACV,aAAa,SAAS,8EAA8E,CACrG,CAAA;SACJ;KACF;IAED,IAAI,QAAQ,CAAC,MAAM,GAAG,aAAa,CAAC,mBAAmB,EAAE;QACvD,MAAM,CAAC,IAAI,CACT,sGAAsG,CACvG,CAAA;QACD,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAA;KAChE;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AA5CY,QAAA,YAAY,gBA4CxB;AAED,yEAAyE;AAClE,MAAM,kBAAkB,GAAG,CAChC,mBAAuC,EACvC,GAAW,EACH,EAAE;IACV,IAAI,mBAAmB,EAAE;QACvB,MAAM,eAAe,GAAG,mBAAmB,GAAG,GAAG,CAAA;QACjD,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,eAAe,CAAC,GAAG,IAAI,CAAA;KAC7C;SAAM;QACL,0EAA0E;QAC1E,uCAAuC;QACvC,OAAO,GAAG,CAAA;KACX;AACH,CAAC,CAAA;AAZY,QAAA,kBAAkB,sBAY9B;AAED;;;;;;;;GAQG;AACI,MAAM,qBAAqB,GAAG,KAAK,EACxC,KAA6B,EAC7B,GAAW,EACX,OAGC,EACD,KAAK,GAAG,CAAC,EAC6B,EAAE;IACxC,IAAI,KAAK,GAAG,OAAO,CAAC,UAAU,EAAE;QAC9B,iFAAiF;QACjF,MAAM,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAA;QACjD,OAAO,SAAS,CAAA;KACjB;IAED,MAAM,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAA;IAC9C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IACrC,IAAI,QAAQ,EAAE;QACZ,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAA;QACvC,OAAO,QAAQ,CAAA;KAChB;IAED,IAAI,OAAO,CAAC,UAAU,KAAK,CAAC,EAAE;QAC5B,MAAM,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAA;QACpD,OAAO,SAAS,CAAA;KACjB;IAED,MAAM,CAAC,KAAK,CAAC,gCAAgC,OAAO,CAAC,KAAK,kBAAkB,CAAC,CAAA;IAC7E,MAAM,IAAA,YAAK,EAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAE1B,OAAO,IAAA,6BAAqB,EAAC,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;AAC9D,CAAC,CAAA;AA/BY,QAAA,qBAAqB,yBA+BjC"}

package/cache/local.d.ts

@@ -1,23 +0,0 @@
-import { Cache, CacheEntry } from './index';
-/**
- * Type for a value stored in a LocalCache entry.
- *
- * @typeParam T - the type for the entry's value
- */
-export interface LocalCacheEntry<T> {
-    expirationTimestamp: number;
-    value: T;
-}
-/**
- * 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
- */
-export declare class LocalCache<T = unknown> implements Cache<T> {
-    store: Record<string, LocalCacheEntry<T>>;
-    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/cache/local.js

@@ -1,84 +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;
-//# sourceMappingURL=local.js.map

package/cache/local.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"local.js","sourceRoot":"","sources":["../../../src/cache/local.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kCAAqD;AAErD,wDAAyC;AAEzC,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,YAAY,CAAC,CAAA;AAYvC;;;;;GAKG;AACH,MAAa,UAAU;IAAvB;QACE,UAAK,GAAuC,EAAE,CAAA;IAiDhD,CAAC;IA/CC,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,MAAM,CAAC,KAAK,CAAC,eAAe,GAAG,EAAE,CAAC,CAAA;QAClC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAE7B,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,CAAC,KAAK,CAAC,oCAAoC,GAAG,wBAAwB,CAAC,CAAA;YAC7E,OAAO,SAAS,CAAA;SACjB;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,mBAAmB,IAAI,IAAI,CAAC,GAAG,EAAE,CAAA;QACvD,IAAI,OAAO,EAAE;YACX,MAAM,CAAC,KAAK,CAAC,gEAAgE,CAAC,CAAA;YAC9E,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAChB,OAAO,SAAS,CAAA;SACjB;aAAM;YACL,MAAM,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAA;YACjE,OAAO,KAAK,CAAC,KAAK,CAAA;SACnB;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,MAAM,CAAC,KAAK,CAAC,gBAAgB,GAAG,EAAE,CAAC,CAAA;QACnC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA,CAAC,wDAAwD;IACjF,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAQ,EAAE,GAAW;QAC1C,MAAM,CAAC,KAAK,CAAC,eAAe,GAAG,aAAa,GAAG,EAAE,CAAC,CAAA;QAClD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG;YAChB,KAAK;YACL,mBAAmB,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG;SACtC,CAAA;QAED,wGAAwG;QACxG,MAAM,MAAM,GAAI,KAAoC,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAA;QAC1E,IAAI,MAAM,EAAE;YACV,0EAA0E;YAC1E,MAAM,KAAK,GAAG,YAAY,CAAC,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;YACxF,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;SAClC;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,OAAwB,EAAE,GAAW;QACjD,MAAM,CAAC,KAAK,CAAC,oCAAoC,GAAG,EAAE,CAAC,CAAA;QACvD,KAAK,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,OAAO,EAAE;YACpC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAA;SAC1B;IACH,CAAC;CACF;AAlDD,gCAkDC"}

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/cache/metrics.js

@@ -1,121 +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'],
-});
-//# sourceMappingURL=metrics.js.map

package/cache/metrics.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../../src/cache/metrics.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAqC;AAS9B,MAAM,QAAQ,GAAG,CAAC,KAAyB,EAAE,KAAc,EAAE,SAAiB,EAAE,EAAE;IACvF,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC1D,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;QACjC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;YAC9D,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;SAClD;KACF;IACD,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,CAAA;IACrC,yBAAyB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;AACxD,CAAC,CAAA;AATY,QAAA,QAAQ,YASpB;AAEM,MAAM,QAAQ,GAAG,CAAC,KAAyB,EAAE,MAAc,EAAE,EAAE;IACpE,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,CAAA;IACrC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACzC,yBAAyB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;AAChD,CAAC,CAAA;AAJY,QAAA,QAAQ,YAIpB;AAEM,MAAM,iBAAiB,GAAG,CAAC,QAAgB,EAAE,MAAc,EAAE,SAAiB,EAAE,EAAE,CAAC,CAAC;IACzF,cAAc,EAAE,QAAQ;IACxB,OAAO,EAAE,MAAM;IACf,UAAU,EAAE,SAAS;CACtB,CAAC,CAAA;AAJW,QAAA,iBAAiB,qBAI5B;AAEF,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,6BAAe,CAAA;IACf,6BAAe,CAAA;AACjB,CAAC,EAHW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAGrB;AAED,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,sCAAmB,CAAA;IACnB,gCAAa,CAAA;IACb,sCAAmB,CAAA;AACrB,CAAC,EAJW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAI1B;AAED,MAAM,UAAU,GAAG;IACjB,SAAS;IACT,gBAAgB;IAChB,YAAY;IACZ,YAAY;IACZ,cAAc;CACN,CAAA;AAEV,+BAA+B;AAC/B,kEAAkE;AAClE,8CAA8C;AAC9C,iFAAiF;AACjF,uDAAuD;AACvD,iCAAiC;AACjC,KAAK;AAEL,MAAM,iBAAiB,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IAC3C,IAAI,EAAE,sBAAsB;IAC5B,IAAI,EAAE,wEAAwE;IAC9E,UAAU,EAAE,UAAU;CACvB,CAAC,CAAA;AAEF,MAAM,kBAAkB,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC;IAC1C,IAAI,EAAE,uBAAuB;IAC7B,IAAI,EAAE,0DAA0D;IAChE,UAAU,EAAE,UAAU;CACvB,CAAC,CAAA;AAEF,MAAM,eAAe,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC;IACvC,IAAI,EAAE,oBAAoB;IAC1B,IAAI,EAAE,4DAA4D;IAClE,UAAU,EAAE,UAAU;CACvB,CAAC,CAAA;AAEF,MAAM,iBAAiB,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IAC3C,IAAI,EAAE,sBAAsB;IAC5B,IAAI,EAAE,kEAAkE;IACxE,UAAU,EAAE,CAAC,GAAG,UAAU,EAAE,aAAa,CAAC;CAC3C,CAAC,CAAA;AAEF,MAAM,yBAAyB,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC;IACjD,IAAI,EAAE,8BAA8B;IACpC,IAAI,EAAE,6CAA6C;IACnD,UAAU,EAAE,UAAU;CACvB,CAAC,CAAA;AAEF,gBAAgB;AACH,QAAA,oBAAoB,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IACrD,IAAI,EAAE,wBAAwB;IAC9B,IAAI,EAAE,+CAA+C;CACtD,CAAC,CAAA;AAEW,QAAA,iBAAiB,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IAClD,IAAI,EAAE,qBAAqB;IAC3B,IAAI,EAAE,2EAA2E;CAClF,CAAC,CAAA;AAEW,QAAA,sBAAsB,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IACvD,IAAI,EAAE,2BAA2B;IACjC,IAAI,EAAE,mCAAmC;IACzC,UAAU,EAAE,CAAC,QAAQ,EAAE,eAAe,CAAC;CACxC,CAAC,CAAA;AAEF,uBAAuB;AACV,QAAA,gBAAgB,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC;IAC/C,IAAI,EAAE,wBAAwB;IAC9B,IAAI,EAAE,qCAAqC;IAC3C,UAAU,EAAE,CAAC,WAAW,CAAU;CACnC,CAAC,CAAA"}

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/cache/redis.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.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
- */
-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);
-    }
-    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}`);
-        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);
-        }
-        await chain.exec();
-        // Loop again, but this time to record these in metrics
-        for (const entry of entries) {
-            // 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);
-            }
-        }
-        // Record setMany command sent to Redis
-        cacheMetrics.redisCommandsSentCount
-            .labels({ status: cacheMetrics.CMD_SENT_STATUS.SUCCESS, function_name: 'exec' })
-            .inc();
-    }
-}
-exports.RedisCache = RedisCache;
-//# sourceMappingURL=redis.js.map

package/cache/redis.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"redis.js","sourceRoot":"","sources":["../../../src/cache/redis.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,kCAAqD;AAErD,wDAAyC;AAEzC,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,YAAY,CAAC,CAAA;AAEvC;;;;;GAKG;AACH,MAAa,UAAU;IACrB,YAAoB,MAAa;QAAb,WAAM,GAAN,MAAM,CAAO;IAAG,CAAC;IAErC,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,MAAM,CAAC,KAAK,CAAC,eAAe,GAAG,EAAE,CAAC,CAAA;QAClC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAExC,mCAAmC;QACnC,YAAY,CAAC,sBAAsB;aAChC,MAAM,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;aAC9E,GAAG,EAAE,CAAA;QAER,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,CAAC,KAAK,CAAC,oCAAoC,GAAG,wBAAwB,CAAC,CAAA;YAC7E,OAAO,SAAS,CAAA;SACjB;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAM,CAAA;IAC/B,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,MAAM,CAAC,KAAK,CAAC,gBAAgB,GAAG,EAAE,CAAC,CAAA;QACnC,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAE1B,sCAAsC;QACtC,YAAY,CAAC,sBAAsB;aAChC,MAAM,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;aACjF,GAAG,EAAE,CAAA;IACV,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAQ,EAAE,GAAW;QAC1C,MAAM,CAAC,KAAK,CAAC,eAAe,GAAG,EAAE,CAAC,CAAA;QAClC,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;QAE5D,wGAAwG;QACxG,MAAM,MAAM,GAAI,KAAoC,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAA;QAC1E,IAAI,MAAM,EAAE;YACV,0EAA0E;YAC1E,MAAM,KAAK,GAAG,YAAY,CAAC,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;YACxF,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;SAClC;QAED,mCAAmC;QACnC,YAAY,CAAC,sBAAsB;aAChC,MAAM,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;aAC9E,GAAG,EAAE,CAAA;IACV,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,OAAwB,EAAE,GAAW;QACjD,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAA;QACvC,yCAAyC;QACzC,IAAI,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;QAE/B,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;YAC3B,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;SACrE;QAED,MAAM,KAAK,CAAC,IAAI,EAAE,CAAA;QAElB,uDAAuD;QACvD,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;YAC3B,wGAAwG;YACxG,MAAM,MAAM,GAAI,KAAK,CAAC,KAAoC,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAA;YAChF,IAAI,MAAM,EAAE;gBACV,0EAA0E;gBAC1E,MAAM,KAAK,GAAG,YAAY,CAAC,iBAAiB,CAC1C,KAAK,CAAC,GAAG,EACT,MAAM,EACN,YAAY,CAAC,UAAU,CAAC,KAAK,CAC9B,CAAA;gBACD,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;aAClC;SACF;QAED,uCAAuC;QACvC,YAAY,CAAC,sBAAsB;aAChC,MAAM,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC;aAC/E,GAAG,EAAE,CAAA;IACV,CAAC;CACF;AA/ED,gCA+EC"}