@chainlink/external-adapter-framework 0.4.0 → 0.5.1

package/util/logger.d.ts

@@ -0,0 +1,49 @@
+/// <reference types="node" />
+import pino from 'pino';
+import { AdapterRequest } from './request';
+import { FastifyReply, HookHandlerDoneFunction } from 'fastify';
+import { AsyncLocalStorage } from 'node:async_hooks';
+import { CensorKeyValue } from './censor/censor-list';
+export declare const asyncLocalStorage: AsyncLocalStorage<unknown>;
+export declare type Store = {
+    correlationId: string;
+};
+export declare const COLORS: string[];
+export declare const colorFactory: (colors: string[]) => () => string;
+/**
+ * Instead of using a global logger instance, we want to force using a child logger
+ * with a specific layer set in it, so that we can filter logs by where they're output from.
+ *
+ * Details on what each log level represents:
+ * "trace": Forensic debugging of issues on a local machine.
+ * "debug": Detailed logging level to get more context from users on their environments.
+ * "info": High-level informational messages, to describe at a glance the high level state of the system.
+ * "warn": A mild error occurred that might require non-urgent action.
+ * "error": An unexpected error occurred during the regular operation of a well-maintained EA.
+ * "fatal": The EA encountered an unrecoverable problem and had to exit.
+ *
+ * Full reference this is based on can be found at
+ * https://github.com/smartcontractkit/documentation/blob/main/docs/Node%20Operators/configuration-variables.md#log_level
+ *
+ * @param layer - the layer name to include in the logs (e.g. "SomeMiddleware", "RedisCache", etc.)
+ * @returns a layer specific logger
+ */
+export declare const makeLogger: (layer: string) => pino.Logger<{
+    level: string;
+    hooks: {
+        logMethod(this: pino.Logger<pino.LoggerOptions>, inputArgs: [msg: string, ...args: any[]], method: pino.LogFn): void;
+    };
+    mixin(): {};
+    transport: {
+        target: string;
+        options: {
+            levelFirst: boolean;
+            levelLabel: string;
+            ignore: string;
+            messageFormat: string;
+            translateTime: string;
+        };
+    } | undefined;
+} & pino.ChildLoggerOptions>;
+export declare const loggingContextMiddleware: (req: AdapterRequest, res: FastifyReply, done: HookHandlerDoneFunction) => void;
+export declare function censor(obj: any, censorList: CensorKeyValue[]): any;

package/util/logger.js

@@ -0,0 +1,123 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.censor = exports.loggingContextMiddleware = exports.makeLogger = exports.colorFactory = exports.COLORS = exports.asyncLocalStorage = void 0;
+const pino_1 = __importDefault(require("pino"));
+const config_1 = require("../config");
+const crypto_1 = require("crypto");
+const node_async_hooks_1 = require("node:async_hooks");
+const censor_list_1 = __importDefault(require("./censor/censor-list"));
+exports.asyncLocalStorage = new node_async_hooks_1.AsyncLocalStorage();
+const debugTransport = {
+    target: 'pino-pretty',
+    options: {
+        levelFirst: true,
+        levelLabel: 'level',
+        ignore: 'layer,pid,hostname,correlationId,color',
+        messageFormat: `\x1b[0m[{correlationId}] {color}[{layer}]\x1b[0m {msg}`,
+        translateTime: 'yyyy-mm-dd HH:MM:ss.l',
+    },
+};
+// Base logger, shouldn't be used because we want layers to be specified
+const baseLogger = (0, pino_1.default)({
+    level: process.env['LOG_LEVEL']?.toLowerCase() || config_1.BaseSettings.LOG_LEVEL.default,
+    hooks: {
+        logMethod(inputArgs, method) {
+            // Censor each argument of logger
+            const censorList = censor_list_1.default.getAll();
+            return method.apply(this, inputArgs.map((arg) => censor(arg, censorList)));
+        },
+    },
+    mixin() {
+        if (process.env['CORRELATION_ID_ENABLED'] !== 'false') {
+            const store = exports.asyncLocalStorage.getStore();
+            if (store) {
+                return store;
+            }
+        }
+        return {};
+    },
+    transport: process.env['DEBUG'] === 'true' || process.env['NODE_ENV'] === 'development'
+        ? debugTransport
+        : undefined,
+});
+exports.COLORS = [
+    '\u001b[31;1m',
+    '\u001b[32m',
+    '\u001b[33m',
+    '\u001b[34m',
+    '\u001b[35m',
+    '\u001b[36m',
+    '\u001b[38;2;121;85;72m',
+    '\u001b[92m',
+    '\u001b[93m',
+    '\u001b[94m',
+    '\u001b[95m',
+    '\u001b[96m',
+    '\u001b[38;5;202m',
+    '\u001b[38;5;31m',
+    '\u001b[38;5;130m',
+    '\u001b[38;2;255;122;92m',
+    '\u001b[38;2;46;125;50m',
+    '\u001b[38;2;129;168;37m',
+    '\u001b[38;2;175;180;43m',
+    '\u001b[91m',
+    '\u001b[38;2;63;81;181m',
+];
+const colorFactory = (colors) => {
+    let index = -1;
+    return () => {
+        index++;
+        if (index > colors.length - 1) {
+            index = 0;
+        }
+        return colors[index];
+    };
+};
+exports.colorFactory = colorFactory;
+const getNextColor = (0, exports.colorFactory)(exports.COLORS);
+/**
+ * Instead of using a global logger instance, we want to force using a child logger
+ * with a specific layer set in it, so that we can filter logs by where they're output from.
+ *
+ * Details on what each log level represents:
+ * "trace": Forensic debugging of issues on a local machine.
+ * "debug": Detailed logging level to get more context from users on their environments.
+ * "info": High-level informational messages, to describe at a glance the high level state of the system.
+ * "warn": A mild error occurred that might require non-urgent action.
+ * "error": An unexpected error occurred during the regular operation of a well-maintained EA.
+ * "fatal": The EA encountered an unrecoverable problem and had to exit.
+ *
+ * Full reference this is based on can be found at
+ * https://github.com/smartcontractkit/documentation/blob/main/docs/Node%20Operators/configuration-variables.md#log_level
+ *
+ * @param layer - the layer name to include in the logs (e.g. "SomeMiddleware", "RedisCache", etc.)
+ * @returns a layer specific logger
+ */
+const makeLogger = (layer) => baseLogger.child({
+    layer,
+    color: process.env['DEBUG'] === 'true' || process.env['NODE_ENV'] === 'development'
+        ? getNextColor()
+        : undefined,
+});
+exports.makeLogger = makeLogger;
+const loggingContextMiddleware = (req, res, done) => {
+    const correlationId = req.headers['x-correlation-id'] || (0, crypto_1.randomUUID)();
+    exports.asyncLocalStorage.run({ correlationId: correlationId }, () => {
+        done();
+    });
+};
+exports.loggingContextMiddleware = loggingContextMiddleware;
+// Obj is typed as "any" because it could be a variety of structures in the logger
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function censor(obj, censorList) {
+    let stringified = JSON.stringify(obj);
+    censorList.forEach((entry) => {
+        stringified = stringified.replace(entry.value, `[${entry.key} REDACTED]`);
+    });
+    return JSON.parse(stringified);
+}
+exports.censor = censor;
+//# sourceMappingURL=logger.js.map

package/util/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../src/util/logger.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAuB;AACvB,sCAAwC;AAGxC,mCAAmC;AACnC,uDAAoD;AACpD,uEAAiE;AAEpD,QAAA,iBAAiB,GAAG,IAAI,oCAAiB,EAAE,CAAA;AAMxD,MAAM,cAAc,GAAG;IACrB,MAAM,EAAE,aAAa;IACrB,OAAO,EAAE;QACP,UAAU,EAAE,IAAI;QAChB,UAAU,EAAE,OAAO;QACnB,MAAM,EAAE,wCAAwC;QAChD,aAAa,EAAE,wDAAwD;QACvE,aAAa,EAAE,uBAAuB;KACvC;CACF,CAAA;AAED,wEAAwE;AACxE,MAAM,UAAU,GAAG,IAAA,cAAI,EAAC;IACtB,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,IAAI,qBAAY,CAAC,SAAS,CAAC,OAAO;IAChF,KAAK,EAAE;QACL,SAAS,CAAC,SAAS,EAAE,MAAM;YACzB,iCAAiC;YACjC,MAAM,UAAU,GAAG,qBAAU,CAAC,MAAM,EAAE,CAAA;YACtC,OAAO,MAAM,CAAC,KAAK,CACjB,IAAI,EACJ,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,CAA2B,CAC1E,CAAA;QACH,CAAC;KACF;IACD,KAAK;QACH,IAAI,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,KAAK,OAAO,EAAE;YACrD,MAAM,KAAK,GAAG,yBAAiB,CAAC,QAAQ,EAAW,CAAA;YACnD,IAAI,KAAK,EAAE;gBACT,OAAO,KAAK,CAAA;aACb;SACF;QACD,OAAO,EAAE,CAAA;IACX,CAAC;IACD,SAAS,EACP,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,aAAa;QAC1E,CAAC,CAAC,cAAc;QAChB,CAAC,CAAC,SAAS;CAChB,CAAC,CAAA;AAEW,QAAA,MAAM,GAAG;IACpB,cAAc;IACd,YAAY;IACZ,YAAY;IACZ,YAAY;IACZ,YAAY;IACZ,YAAY;IACZ,wBAAwB;IACxB,YAAY;IACZ,YAAY;IACZ,YAAY;IACZ,YAAY;IACZ,YAAY;IACZ,kBAAkB;IAClB,iBAAiB;IACjB,kBAAkB;IAClB,yBAAyB;IACzB,wBAAwB;IACxB,yBAAyB;IACzB,yBAAyB;IACzB,YAAY;IACZ,wBAAwB;CACzB,CAAA;AAEM,MAAM,YAAY,GAAG,CAAC,MAAgB,EAAE,EAAE;IAC/C,IAAI,KAAK,GAAG,CAAC,CAAC,CAAA;IACd,OAAO,GAAG,EAAE;QACV,KAAK,EAAE,CAAA;QACP,IAAI,KAAK,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YAC7B,KAAK,GAAG,CAAC,CAAA;SACV;QACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;IACtB,CAAC,CAAA;AACH,CAAC,CAAA;AATY,QAAA,YAAY,gBASxB;AAED,MAAM,YAAY,GAAG,IAAA,oBAAY,EAAC,cAAM,CAAC,CAAA;AAEzC;;;;;;;;;;;;;;;;;GAiBG;AACI,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE,CAC1C,UAAU,CAAC,KAAK,CAAC;IACf,KAAK;IACL,KAAK,EACH,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,aAAa;QAC1E,CAAC,CAAC,YAAY,EAAE;QAChB,CAAC,CAAC,SAAS;CAChB,CAAC,CAAA;AAPS,QAAA,UAAU,cAOnB;AAEG,MAAM,wBAAwB,GAAG,CACtC,GAAmB,EACnB,GAAiB,EACjB,IAA6B,EAC7B,EAAE;IACF,MAAM,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,IAAA,mBAAU,GAAE,CAAA;IACrE,yBAAiB,CAAC,GAAG,CAAC,EAAE,aAAa,EAAE,aAAa,EAAE,EAAE,GAAG,EAAE;QAC3D,IAAI,EAAE,CAAA;IACR,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AATY,QAAA,wBAAwB,4BASpC;AAED,kFAAkF;AAClF,8DAA8D;AAC9D,SAAgB,MAAM,CAAC,GAAQ,EAAE,UAA4B;IAC3D,IAAI,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;IACrC,UAAU,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC3B,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,KAAK,CAAC,GAAG,YAAY,CAAC,CAAA;IAC3E,CAAC,CAAC,CAAA;IACF,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;AAChC,CAAC;AAND,wBAMC"}

package/util/request.d.ts

@@ -0,0 +1,138 @@
+import { FastifyReply, FastifyRequest, HookHandlerDoneFunction } from 'fastify';
+import { Adapter } from '../adapter';
+import { AdapterError } from '../validation/error';
+declare module 'fastify' {
+    interface FastifyRequest {
+        requestContext: AdapterRequestContext;
+    }
+}
+export declare type Merge<T1, T2> = {
+    [K in keyof T1 | keyof T2]: K extends keyof T2 ? T2[K] : K extends keyof T1 ? T1[K] : never;
+};
+/**
+ * Structure for the body of all requests that will be sent to the adapter
+ */
+export interface AdapterRequestBody<T = AdapterRequestData> {
+    /** Adapter endpoint (not to be confused with REST API endpoint) */
+    endpoint?: string;
+    /** Main data that will be validated and used on each adapter request */
+    data: T;
+}
+/**
+ * Object that will be added to the request on a successful validation.
+ * Contains all the necessary information the adapter will need across the request execution.
+ */
+export declare type AdapterRequestContext<T = AdapterRequestData> = {
+    /** Name of the endpoint this payload should be directed to */
+    endpointName: string;
+    /** Precalculated cache key used to get and set corresponding values from the cache and subscription sets */
+    cacheKey: string;
+    /** Normalized and validated data coming from the request body */
+    data: T;
+    /** Metadata relevant to this particular request */
+    meta?: AdapterRequestMeta;
+};
+/**
+ * Helper type to denote an empty body
+ */
+declare type EmptyBody = Record<string, never>;
+/**
+ * Helper type to provide fastify for all adapter handlers
+ */
+export declare type AdapterRouteGeneric = {
+    /** Set to an empty record so the user does not access the raw request data and uses the Validated data from the context instead */
+    Body: EmptyBody;
+};
+/**
+ * Structure for all requests incoming to this adapter
+ */
+export declare type AdapterRequest<T extends RequestGenerics = RequestGenerics> = FastifyRequest<AdapterRouteGeneric> & {
+    /** Set to an empty record so the user does not access the raw request data and uses the Validated data from the context instead */
+    body: EmptyBody;
+    /** Container for all validated information that will be used by the framework across this request's lifecycle */
+    requestContext: AdapterRequestContext<T['Params']>;
+};
+/**
+ * Metadata for a particular request
+ */
+export interface AdapterRequestMeta {
+    /** Relevant metrics gathered for this request */
+    metrics?: AdapterMetricsMeta;
+    /** An error that ocurred somewhere along this requests' lifecycle */
+    error?: AdapterError | Error;
+}
+/**
+ * Meta info that pertains to exposing metrics
+ */
+export interface AdapterMetricsMeta {
+    /** String to uniquely identify a specific price feed */
+    feedId?: string;
+    /** Boolean to note if this request's response was found in the cache directly */
+    cacheHit?: boolean;
+}
+/**
+ * Basic shape for the data within the request body
+ */
+export declare type AdapterRequestData = Record<string, unknown> & {
+    endpoint?: string;
+};
+/**
+ * Helper type to hold the value from responses from a provider, and the adapter params they correspond to.
+ */
+export interface ProviderResult<T extends {
+    Request: RequestGenerics;
+    Response: ResponseGenerics;
+}> {
+    /** The set of parameters that uniquely relate to the response */
+    params: T['Request']['Params'];
+    /** Value that will be included in the result property of the response */
+    value: T['Response']['Result'];
+}
+export declare type EmptyObject = Object;
+/**
+ * Helper struct type that provides detail about the incoming Adapter Request
+ */
+export declare type RequestGenerics = {
+    /**
+     * Type for the parameters sent to the EA in the data property of the body.
+     */
+    Params: EmptyObject;
+};
+/**
+ * Helper struct type that provides detail about the outgoing Adapter Response
+ */
+export declare type ResponseGenerics = {
+    /**
+     * Type for the data property of the response.
+     */
+    Data: unknown;
+    /**
+     * Type for the result property of the response.
+     * This is mostly used for OCR, and corresponds to one "word" when talking about it from an on-chain perspective.
+     */
+    Result: string | number | null;
+};
+/**
+ * Shape of the response body from the adapter
+ */
+export declare type AdapterResponse<T extends ResponseGenerics = ResponseGenerics> = {
+    /** HTTP status code */
+    statusCode: number;
+    /** Response data, holds "result" for Flux Monitor */
+    data: T['Data'];
+    /** Result value used for OCR */
+    result: T['Result'];
+    /** Number detailing the maximum age of the result in the cache, will be replaced by telemetry eventually */
+    maxAge?: number;
+    /** Metadata relevant to this request */
+    meta?: AdapterRequestMeta;
+};
+export declare type SingleNumberResultResponse = {
+    Result: number;
+    Data: {
+        result: number;
+    };
+};
+export declare type Middleware = ((req: AdapterRequest, reply: FastifyReply, done: HookHandlerDoneFunction) => FastifyReply | void) | ((req: AdapterRequest, reply: FastifyReply) => Promise<FastifyReply | void>);
+export declare type AdapterMiddlewareBuilder = (adapter: Adapter) => Middleware;
+export {};

package/util/request.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=request.js.map

package/util/request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../src/util/request.ts"],"names":[],"mappings":""}

package/util/subscription-set/expiring-sorted-set.d.ts

@@ -0,0 +1,21 @@
+import { SubscriptionSet } from './subscription-set';
+/**
+ * An object describing an entry in the expiring sorted set.
+ * @typeParam T - the type of the entry's value
+ */
+interface ExpiringSortedSetEntry<T> {
+    value: T;
+    expirationTimestamp: number;
+}
+/**
+ * This class implements a set of unique items, each of which has an expiration timestamp.
+ * On reads, items that have expired will be deleted from the set and not returned.
+ *
+ * @typeParam T - the type of the set entries' values
+ */
+export declare class ExpiringSortedSet<T> implements SubscriptionSet<T> {
+    map: Map<string, ExpiringSortedSetEntry<T>>;
+    add(key: string, value: T, ttl: number): void;
+    getAll(): T[];
+}
+export {};

package/util/subscription-set/expiring-sorted-set.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExpiringSortedSet = void 0;
+/**
+ * This class implements a set of unique items, each of which has an expiration timestamp.
+ * On reads, items that have expired will be deleted from the set and not returned.
+ *
+ * @typeParam T - the type of the set entries' values
+ */
+class ExpiringSortedSet {
+    constructor() {
+        this.map = new Map();
+    }
+    add(key, value, ttl) {
+        this.map.set(key, {
+            value,
+            expirationTimestamp: Date.now() + ttl,
+        });
+    }
+    getAll() {
+        const results = [];
+        const now = Date.now();
+        // Since we're iterating, might as well prune here
+        for (const [key, entry] of this.map.entries()) {
+            if (entry.expirationTimestamp < now) {
+                this.map.delete(key); // In theory, this shouldn't happen frequently for feeds
+            }
+            else {
+                results.push(entry.value);
+            }
+        }
+        return results;
+    }
+}
+exports.ExpiringSortedSet = ExpiringSortedSet;
+//# sourceMappingURL=expiring-sorted-set.js.map

package/util/subscription-set/expiring-sorted-set.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"expiring-sorted-set.js","sourceRoot":"","sources":["../../../../src/util/subscription-set/expiring-sorted-set.ts"],"names":[],"mappings":";;;AAWA;;;;;GAKG;AACH,MAAa,iBAAiB;IAA9B;QACE,QAAG,GAAG,IAAI,GAAG,EAAqC,CAAA;IAwBpD,CAAC;IAtBC,GAAG,CAAC,GAAW,EAAE,KAAQ,EAAE,GAAW;QACpC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE;YAChB,KAAK;YACL,mBAAmB,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG;SACtC,CAAC,CAAA;IACJ,CAAC;IAED,MAAM;QACJ,MAAM,OAAO,GAAQ,EAAE,CAAA;QACvB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAEtB,kDAAkD;QAClD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE;YAC7C,IAAI,KAAK,CAAC,mBAAmB,GAAG,GAAG,EAAE;gBACnC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA,CAAC,wDAAwD;aAC9E;iBAAM;gBACL,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;aAC1B;SACF;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;CACF;AAzBD,8CAyBC"}

package/util/subscription-set/redis-sorted-set.d.ts

@@ -0,0 +1,9 @@
+import Redis from 'ioredis';
+import { SubscriptionSet } from './subscription-set';
+export declare class RedisSubscriptionSet<T> implements SubscriptionSet<T> {
+    private redisClient;
+    private subscriptionSetKey;
+    constructor(redisClient: Redis, subscriptionSetKey: string);
+    add(key: string, value: T, ttl: number): Promise<undefined>;
+    getAll(): Promise<T[]>;
+}

package/util/subscription-set/redis-sorted-set.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisSubscriptionSet = void 0;
+// Delimiter used to store both key and value in redis sorted set string field together
+const DELIMITER = '>';
+class RedisSubscriptionSet {
+    constructor(redisClient, subscriptionSetKey) {
+        this.redisClient = redisClient;
+        this.subscriptionSetKey = subscriptionSetKey;
+    }
+    async add(key, value, ttl) {
+        const storedValue = `${key}${DELIMITER}${JSON.stringify(value)}`;
+        await this.redisClient.zadd(this.subscriptionSetKey, Date.now() + ttl, storedValue);
+        return;
+    }
+    async getAll() {
+        // Remove expired keys from sorted set
+        await this.redisClient.zremrangebyscore(this.subscriptionSetKey, '-inf', Date.now());
+        const parsedRequests = [];
+        const validEntries = await this.redisClient.zrange(this.subscriptionSetKey, 0, -1);
+        validEntries.forEach((entry) => {
+            // Separate request and cache key prior to populating results array
+            parsedRequests.push(JSON.parse(entry.split(DELIMITER)[1]));
+        });
+        return parsedRequests;
+    }
+}
+exports.RedisSubscriptionSet = RedisSubscriptionSet;
+//# sourceMappingURL=redis-sorted-set.js.map

package/util/subscription-set/redis-sorted-set.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis-sorted-set.js","sourceRoot":"","sources":["../../../../src/util/subscription-set/redis-sorted-set.ts"],"names":[],"mappings":";;;AAGA,uFAAuF;AACvF,MAAM,SAAS,GAAG,GAAG,CAAA;AAErB,MAAa,oBAAoB;IAK/B,YAAY,WAAkB,EAAE,kBAA0B;QACxD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAA;IAC9C,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAQ,EAAE,GAAW;QAC1C,MAAM,WAAW,GAAG,GAAG,GAAG,GAAG,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAA;QAChE,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,EAAE,WAAW,CAAC,CAAA;QACnF,OAAM;IACR,CAAC;IAED,KAAK,CAAC,MAAM;QACV,sCAAsC;QACtC,MAAM,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,IAAI,CAAC,kBAAkB,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAA;QACpF,MAAM,cAAc,GAAQ,EAAE,CAAA;QAC9B,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAClF,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC7B,mEAAmE;YACnE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAM,CAAC,CAAA;QACjE,CAAC,CAAC,CAAA;QACF,OAAO,cAAc,CAAA;IACvB,CAAC;CACF;AA3BD,oDA2BC"}

package/util/subscription-set/subscription-set.d.ts

@@ -0,0 +1,19 @@
+import Redis from 'ioredis';
+import { PromiseOrValue } from '..';
+import { AdapterConfig } from '../../config';
+/**
+ * Set to hold items to subscribe to from a provider (regardless of protocol)
+ */
+export interface SubscriptionSet<T> {
+    /** Add a new subscription to the set */
+    add(key: string, value: T, ttl: number): PromiseOrValue<void>;
+    /** Get all subscriptions from the set as a list */
+    getAll(): PromiseOrValue<T[]>;
+}
+export declare class SubscriptionSetFactory {
+    private cacheType;
+    private redisClient?;
+    private adapterName?;
+    constructor(config: AdapterConfig, adapterName: string, redisClient?: Redis);
+    buildSet<T>(endpointName: string): SubscriptionSet<T>;
+}

package/util/subscription-set/subscription-set.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionSetFactory = void 0;
+const expiring_sorted_set_1 = require("./expiring-sorted-set");
+const redis_sorted_set_1 = require("./redis-sorted-set");
+class SubscriptionSetFactory {
+    constructor(config, adapterName, redisClient) {
+        this.cacheType = config.CACHE_TYPE;
+        this.redisClient = redisClient;
+        this.adapterName = adapterName;
+    }
+    buildSet(endpointName) {
+        switch (this.cacheType) {
+            case 'local':
+                return new expiring_sorted_set_1.ExpiringSortedSet();
+            case 'redis': {
+                if (!this.redisClient) {
+                    throw new Error('Redis client undefined. Cannot create Redis subscription set');
+                }
+                // Identifier key used for the subscription set in redis
+                const subscriptionSetKey = `${this.adapterName}-${endpointName}-subscriptionSet`;
+                return new redis_sorted_set_1.RedisSubscriptionSet(this.redisClient, subscriptionSetKey);
+            }
+        }
+    }
+}
+exports.SubscriptionSetFactory = SubscriptionSetFactory;
+//# sourceMappingURL=subscription-set.js.map

package/util/subscription-set/subscription-set.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription-set.js","sourceRoot":"","sources":["../../../../src/util/subscription-set/subscription-set.ts"],"names":[],"mappings":";;;AAGA,+DAAyD;AACzD,yDAAyD;AAazD,MAAa,sBAAsB;IAKjC,YAAY,MAAqB,EAAE,WAAmB,EAAE,WAAmB;QACzE,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,UAAU,CAAA;QAClC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;IAED,QAAQ,CAAI,YAAoB;QAC9B,QAAQ,IAAI,CAAC,SAAS,EAAE;YACtB,KAAK,OAAO;gBACV,OAAO,IAAI,uCAAiB,EAAK,CAAA;YACnC,KAAK,OAAO,CAAC,CAAC;gBACZ,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;oBACrB,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAA;iBAChF;gBACD,wDAAwD;gBACxD,MAAM,kBAAkB,GAAG,GAAG,IAAI,CAAC,WAAW,IAAI,YAAY,kBAAkB,CAAA;gBAChF,OAAO,IAAI,uCAAoB,CAAI,IAAI,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAA;aACzE;SACF;IACH,CAAC;CACF;AAzBD,wDAyBC"}

package/util/test-payload-loader.d.ts

@@ -0,0 +1,26 @@
+import { AdapterRequestData } from './request';
+/**
+ * The test payload read in from filesystem
+ */
+export interface Payload {
+    requests: Array<AdapterRequestData>;
+}
+/**
+ * Test payload with discriminated union so we can tell when we should just do
+ * a simple liveness check rather than a sample request
+ */
+declare type TestPayload = (Payload & {
+    isDefault: false;
+}) | {
+    isDefault: true;
+};
+/**
+ * Load in a JSON file containing a test payload for the current adapter,
+ * used in healthchecks to make sample requests
+ *
+ * @param fileName - name of file that contains the test payload data for the smoke endpoint
+ * @returns the parsed payload with individual requests
+ */
+export declare function loadTestPayload(fileName?: string): TestPayload;
+export declare function resolvePayload(fileName?: string): Payload | null;
+export {};

package/util/test-payload-loader.js

@@ -0,0 +1,85 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolvePayload = exports.loadTestPayload = void 0;
+const ajv_1 = __importDefault(require("ajv"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const logger_1 = require("./logger");
+const logger = (0, logger_1.makeLogger)('TestPayloadLoader');
+/**
+ * Load in a JSON file containing a test payload for the current adapter,
+ * used in healthchecks to make sample requests
+ *
+ * @param fileName - name of file that contains the test payload data for the smoke endpoint
+ * @returns the parsed payload with individual requests
+ */
+function loadTestPayload(fileName) {
+    const ajv = new ajv_1.default();
+    const schema = {
+        type: 'object',
+        required: ['requests'],
+        properties: {
+            requests: {
+                type: 'array',
+                items: {
+                    type: 'object',
+                    required: [],
+                },
+            },
+        },
+    };
+    const validate = ajv.compile(schema);
+    try {
+        const payload = resolvePayload(fileName);
+        if (!validate(payload) || !payload?.requests) {
+            throw Error(JSON.stringify(validate?.errors || 'Could not validate schema for test payload'));
+        }
+        return { ...payload, isDefault: false };
+    }
+    catch (e) {
+        logger.warn(`Could not load payload: ${e.message}`);
+        logger.warn('Falling back to default empty payload');
+        return { isDefault: true };
+    }
+}
+exports.loadTestPayload = loadTestPayload;
+function resolvePayload(fileName) {
+    try {
+        let payload = null;
+        // Find test payload by specified name, fallback to default names if not found
+        if (fileName && fs_1.default.existsSync(path_1.default.join(process.cwd(), fileName))) {
+            payload = require(path_1.default.join(process.cwd(), fileName));
+        }
+        else if (fileName && fs_1.default.existsSync(`./${fileName}`)) {
+            payload = require(`./${fileName}`);
+        }
+        // Search for test payload js first if no filename specified or found
+        else if (fs_1.default.existsSync(path_1.default.resolve('.', 'test-payload.js'))) {
+            payload = require(path_1.default.join(process.cwd(), 'test-payload.js'));
+        }
+        else if (fs_1.default.existsSync(`./test-payload.js`)) {
+            payload = require(`./test-payload.js`);
+        }
+        // Search for test payload json second if no filename specified or found
+        else if (fs_1.default.existsSync(path_1.default.join(process.cwd(), 'test-payload.json'))) {
+            payload = require(path_1.default.join(process.cwd(), 'test-payload.json'));
+        }
+        else if (fs_1.default.existsSync(`./test-payload.json`)) {
+            payload = require(`./test-payload.json`);
+        }
+        if (typeof payload === 'string') {
+            return JSON.parse(payload);
+        }
+        else {
+            return payload;
+        }
+    }
+    catch {
+        return null;
+    }
+}
+exports.resolvePayload = resolvePayload;
+//# sourceMappingURL=test-payload-loader.js.map

package/util/test-payload-loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-payload-loader.js","sourceRoot":"","sources":["../../../src/util/test-payload-loader.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAqB;AACrB,4CAAmB;AACnB,gDAAuB;AACvB,qCAAqC;AAGrC,MAAM,MAAM,GAAG,IAAA,mBAAU,EAAC,mBAAmB,CAAC,CAAA;AAe9C;;;;;;GAMG;AACH,SAAgB,eAAe,CAAC,QAAiB;IAC/C,MAAM,GAAG,GAAG,IAAI,aAAG,EAAE,CAAA;IACrB,MAAM,MAAM,GAAG;QACb,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,CAAC,UAAU,CAAC;QACtB,UAAU,EAAE;YACV,QAAQ,EAAE;gBACR,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,EAAE;iBACb;aACF;SACF;KACF,CAAA;IACD,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IACpC,IAAI;QACF,MAAM,OAAO,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAA;QACxC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE;YAC5C,MAAM,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,MAAM,IAAI,4CAA4C,CAAC,CAAC,CAAA;SAC9F;QACD,OAAO,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAA;KACxC;IAAC,OAAO,CAAU,EAAE;QACnB,MAAM,CAAC,IAAI,CAAC,2BAA4B,CAAW,CAAC,OAAO,EAAE,CAAC,CAAA;QAC9D,MAAM,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAA;QACpD,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,CAAA;KAC3B;AACH,CAAC;AA3BD,0CA2BC;AAED,SAAgB,cAAc,CAAC,QAAiB;IAC9C,IAAI;QACF,IAAI,OAAO,GAAG,IAAI,CAAA;QAClB,8EAA8E;QAC9E,IAAI,QAAQ,IAAI,YAAE,CAAC,UAAU,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC,EAAE;YACjE,OAAO,GAAG,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAA;SACtD;aAAM,IAAI,QAAQ,IAAI,YAAE,CAAC,UAAU,CAAC,KAAK,QAAQ,EAAE,CAAC,EAAE;YACrD,OAAO,GAAG,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC,CAAA;SACnC;QACD,qEAAqE;aAChE,IAAI,YAAE,CAAC,UAAU,CAAC,cAAI,CAAC,OAAO,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC,EAAE;YAC5D,OAAO,GAAG,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,iBAAiB,CAAC,CAAC,CAAA;SAC/D;aAAM,IAAI,YAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE;YAC7C,OAAO,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAA;SACvC;QACD,wEAAwE;aACnE,IAAI,YAAE,CAAC,UAAU,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,mBAAmB,CAAC,CAAC,EAAE;YACrE,OAAO,GAAG,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,mBAAmB,CAAC,CAAC,CAAA;SACjE;aAAM,IAAI,YAAE,CAAC,UAAU,CAAC,qBAAqB,CAAC,EAAE;YAC/C,OAAO,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;SACzC;QACD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;SAC3B;aAAM;YACL,OAAO,OAAO,CAAA;SACf;KACF;IAAC,MAAM;QACN,OAAO,IAAI,CAAA;KACZ;AACH,CAAC;AA7BD,wCA6BC"}

package/validation/error.d.ts

@@ -0,0 +1,48 @@
+import { HttpRequestType } from '../metrics/constants';
+declare type ErrorBasic = {
+    name: string;
+    message: string;
+};
+declare type ErrorFull = ErrorBasic & {
+    stack: string;
+    cause: string;
+};
+export declare type AdapterErrorResponse = {
+    status: string;
+    statusCode: number;
+    providerStatusCode?: number;
+    error: ErrorBasic | ErrorFull;
+};
+export declare class AdapterError extends Error {
+    status: string;
+    statusCode: number;
+    cause: unknown;
+    url?: string;
+    errorResponse: unknown;
+    feedID?: string;
+    providerStatusCode?: number;
+    metricsLabel?: HttpRequestType;
+    name: string;
+    message: string;
+    constructor({ status, statusCode, name, message, cause, url, errorResponse, feedID, providerStatusCode, metricsLabel, }: Partial<AdapterError>);
+    toJSONResponse(): AdapterErrorResponse;
+}
+export declare class AdapterInputError extends AdapterError {
+    constructor(input: Partial<AdapterError>);
+}
+export declare class AdapterRateLimitError extends AdapterError {
+    constructor(input: Partial<AdapterError>);
+}
+export declare class AdapterTimeoutError extends AdapterError {
+    constructor(input: Partial<AdapterError>);
+}
+export declare class AdapterDataProviderError extends AdapterError {
+    constructor(input: Partial<AdapterError>);
+}
+export declare class AdapterConnectionError extends AdapterError {
+    constructor(input: Partial<AdapterError>);
+}
+export declare class AdapterCustomError extends AdapterError {
+    constructor(input: Partial<AdapterError>);
+}
+export {};