@chainlink/external-adapter-framework 0.0.10 → 0.0.14

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

@@ -0,0 +1,47 @@
+"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,
+        });
+    }
+    get(key) {
+        const entry = this.map.get(key);
+        if (!entry) {
+            return;
+        }
+        else if (entry.expirationTimestamp < Date.now()) {
+            return entry.value;
+        }
+        else {
+            this.map.delete(key);
+        }
+    }
+    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;

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

@@ -0,0 +1,18 @@
+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 a specific subscription from the set */
+    get(key: string): PromiseOrValue<T | undefined>;
+    /** Get all subscriptions from the set as a list */
+    getAll(): PromiseOrValue<T[]>;
+}
+export declare class SubscriptionSetFactory {
+    private cacheType;
+    constructor(config: AdapterConfig);
+    buildSet<T>(): SubscriptionSet<T>;
+}

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

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionSetFactory = void 0;
+const expiring_sorted_set_1 = require("./expiring-sorted-set");
+class SubscriptionSetFactory {
+    constructor(config) {
+        this.cacheType = config.CACHE_TYPE;
+    }
+    buildSet() {
+        switch (this.cacheType) {
+            case 'local':
+                return new expiring_sorted_set_1.ExpiringSortedSet();
+            case 'redis':
+                // TODO: Implement redis set
+                return new expiring_sorted_set_1.ExpiringSortedSet();
+        }
+    }
+}
+exports.SubscriptionSetFactory = SubscriptionSetFactory;

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

@@ -0,0 +1,25 @@
+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 {};

package/util/test-payload-loader.js

@@ -0,0 +1,83 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+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;
+    }
+}

package/validation/error.d.ts

@@ -1,4 +1,4 @@
-import { HttpRequestType } from "../metrics/constants";
+import { HttpRequestType } from '../metrics/constants';
 declare type ErrorBasic = {
     name: string;
     message: string;
@@ -26,7 +26,7 @@ export declare class AdapterError extends Error {
     metricsLabel?: HttpRequestType;
     name: string;
     message: string;
-    constructor({ jobRunID, status, statusCode, name, message, cause, url, errorResponse, feedID, providerStatusCode, metricsLabel }: Partial<AdapterError>);
+    constructor({ jobRunID, status, statusCode, name, message, cause, url, errorResponse, feedID, providerStatusCode, metricsLabel, }: Partial<AdapterError>);
     toJSONResponse(): AdapterErrorResponse;
 }
 export declare class AdapterInputError extends AdapterError {

package/validation/error.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AdapterCustomError = exports.AdapterConnectionError = exports.AdapterDataProviderError = exports.AdapterTimeoutError = exports.AdapterRateLimitError = exports.AdapterInputError = exports.AdapterError = void 0;
 const constants_1 = require("../metrics/constants");
 class AdapterError extends Error {
-    constructor({ jobRunID = '1', status = 'errored', statusCode = 500, name = 'AdapterError', message = 'An error occurred.', cause, url, errorResponse, feedID, providerStatusCode, metricsLabel = constants_1.HttpRequestType.ADAPTER_ERROR }) {
+    constructor({ jobRunID = '1', status = 'errored', statusCode = 500, name = 'AdapterError', message = 'An error occurred.', cause, url, errorResponse, feedID, providerStatusCode, metricsLabel = constants_1.HttpRequestType.ADAPTER_ERROR, }) {
         super(message);
         this.jobRunID = jobRunID;
         this.status = status;

package/validation/index.js

@@ -22,7 +22,9 @@ const validatorMiddleware = (adapter) => (req, reply, done) => {
         });
     }
     // Make endpoints case insensitive
-    const endpointParam = req.body.endpoint?.toLowerCase() || adapter.defaultEndpoint;
+    const endpointParam = req.body.endpoint?.toLowerCase() ||
+        req.body.data?.endpoint?.toLowerCase() ||
+        adapter.defaultEndpoint;
     if (!endpointParam) {
         throw new error_1.AdapterInputError({
             message: `Request body does not specify an endpoint, and there is no default endpoint configured for this adapter.`,
@@ -32,7 +34,7 @@ const validatorMiddleware = (adapter) => (req, reply, done) => {
     const endpoint = adapter.endpointsMap[endpointParam];
     if (!endpoint) {
         throw new error_1.AdapterInputError({
-            message: `Adapter does not have a "${req.body.endpoint}" endpoint.`,
+            message: `Adapter does not have a "${endpointParam}" endpoint.`,
             statusCode: 404,
         });
     }
@@ -48,7 +50,10 @@ const validatorMiddleware = (adapter) => (req, reply, done) => {
     if (adapter.config.METRICS_ENABLED && adapter.config.EXPERIMENTAL_METRICS_ENABLED) {
         // Add metrics meta which includes feedId to the request
         // Perform prior to overrides to maintain consistent Feed IDs across adapters
-        const metrics = (0, util_1.getMetricsMeta)(endpoint, validator.validated.data);
+        const metrics = (0, util_1.getMetricsMeta)({
+            adapterEndpoint: endpoint,
+            adapterConfig: adapter.config,
+        }, validator.validated.data);
         req.requestContext = { ...req.requestContext, meta: { metrics } };
     }
     // TODO: Support `includes` and `tokenOverrides` overrides as needed