@chainlink/external-adapter-framework 0.0.12 → 0.0.15

package/dist/src/index.js

@@ -1,128 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.expose = void 0;
-const fastify_1 = __importDefault(require("fastify"));
-const path_1 = require("path");
-const background_executor_1 = require("./background-executor");
-const cache_1 = require("./cache");
-const metrics_1 = require("./metrics");
-const transports_1 = require("./transports");
-const util_1 = require("./util");
-const test_payload_loader_1 = require("./util/test-payload-loader");
-const validation_1 = require("./validation");
-const logger = (0, util_1.makeLogger)('Main');
-const VERSION = process.env['npm_package_version'];
-/**
- * Main function for the framework.
- * Initializes config and dependencies, uses those to initialize Transports, and starts listening for requests.
- *
- * @param adapter - an object describing an External Adapter
- * @param dependencies - an optional object with adapter dependencies to inject
- * @returns a Promise that resolves to the http.Server listening for connections
- */
-const expose = async (adapter, dependencies) => {
-    // Initialize adapter (create dependencies, inject them, build endpoint map, etc.)
-    await adapter.initialize(dependencies);
-    let server = undefined;
-    if (adapter.config.METRICS_ENABLED && adapter.config.EXPERIMENTAL_METRICS_ENABLED) {
-        (0, metrics_1.setupMetricsServer)(adapter.name, adapter.config);
-    }
-    if (adapter.config.EA_MODE === 'reader' || adapter.config.EA_MODE === 'reader-writer') {
-        // Main REST API server to handle incoming requests
-        const app = await buildRestApi(adapter);
-        // Start listening for incoming requests
-        try {
-            await app.listen(adapter.config.EA_PORT, adapter.config.EA_HOST);
-        }
-        catch (err) {
-            logger.fatal(`There was an error when starting the EA server: ${err}`);
-            process.exit();
-        }
-        logger.info(`Listening on port ${app.server.address().port}`);
-        server = app.server;
-    }
-    else {
-        logger.info('REST API is disabled; this instance will not process incoming requests.');
-    }
-    if (adapter.config.EA_MODE === 'writer' || adapter.config.EA_MODE === 'reader-writer') {
-        // Start background loop that will take care of calling any async Transports
-        logger.info('Starting background execution loop');
-        (0, background_executor_1.callBackgroundExecutes)(adapter, server);
-    }
-    else {
-        logger.info('Background executor is disabled; this instance will not perform async background executes.');
-    }
-    return server;
-};
-exports.expose = expose;
-async function buildRestApi(adapter) {
-    const { config } = adapter;
-    const app = (0, fastify_1.default)();
-    // Add healthcheck endpoint before middlewares to bypass them
-    app.get((0, path_1.join)(config.BASE_URL, 'health'), (req, res) => {
-        res.status(200).send({ message: 'OK', version: VERSION });
-    });
-    // Use global error handling
-    app.setErrorHandler(validation_1.errorCatchingMiddleware);
-    const transportHandler = await (0, transports_1.buildTransportHandler)(adapter);
-    app.register(async (router) => {
-        // Set up "middlewares" (hooks in fastify)
-        router.addHook('preHandler', (0, validation_1.validatorMiddleware)(adapter));
-        router.addHook('preHandler', (0, cache_1.buildCacheMiddleware)(adapter));
-        if (config['CORRELATION_ID_ENABLED']) {
-            router.addHook('onRequest', util_1.loggingContextMiddleware);
-        }
-        router.route({
-            url: config.BASE_URL,
-            method: 'POST',
-            handler: transportHandler,
-        });
-        if (config.METRICS_ENABLED && config.EXPERIMENTAL_METRICS_ENABLED) {
-            router.addHook('onResponse', metrics_1.buildMetricsMiddleware);
-        }
-    });
-    // Add smoke endpoint after middleware which are needed for tests
-    buildSmokeEndpoint(app, config);
-    return app;
-}
-/**
- * Adds the /smoke endpoint to the API for smoke testing the adapter
- *
- * @param app - the Fastify instance
- * @param config - the initialized adapter config
- */
-function buildSmokeEndpoint(app, config) {
-    const testPayload = (0, test_payload_loader_1.loadTestPayload)(config.SMOKE_TEST_PAYLOAD_FILE_NAME);
-    app.get((0, path_1.join)(config.BASE_URL, 'smoke'), async (_, res) => {
-        if (testPayload.isDefault) {
-            return res.status(200).send('OK');
-        }
-        const errors = [];
-        for (const index in testPayload.requests) {
-            try {
-                const request = { id: index, data: testPayload.requests[index] };
-                // Use Fastify's app inject to pass smoke requests internally
-                const response = await app.inject({
-                    method: 'POST',
-                    url: '/',
-                    payload: request,
-                });
-                const parsedResponse = JSON.parse(response.body);
-                // Throw error if not 2xx status code
-                if (parsedResponse.statusCode < 200 || parsedResponse.statusCode > 299) {
-                    throw Error('Smoke test request failed');
-                }
-            }
-            catch (e) {
-                errors.push(e);
-            }
-        }
-        if (errors.length > 0) {
-            return res.status(500).send(errors);
-        }
-        return res.status(200).send('OK');
-    });
-}

package/dist/src/metrics/constants.d.ts

@@ -1,16 +0,0 @@
-export declare enum HttpRequestType {
-    CACHE_HIT = "cacheHit",
-    DATA_PROVIDER_HIT = "dataProviderHit",
-    ADAPTER_ERROR = "adapterError",
-    INPUT_ERROR = "inputError",
-    RATE_LIMIT_ERROR = "rateLimitError",
-    DP_ERROR = "dataProviderError",
-    TIMEOUT_ERROR = "timeoutError",
-    CONNECTION_ERROR = "connectionError",
-    CUSTOM_ERROR = "customError"
-}
-/**
- * Maxiumum number of characters that a feedId can contain.
- */
-export declare const MAX_FEED_ID_LENGTH = 300;
-export declare const requestDurationBuckets: number[];

package/dist/src/metrics/constants.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.requestDurationBuckets = exports.MAX_FEED_ID_LENGTH = exports.HttpRequestType = void 0;
-var HttpRequestType;
-(function (HttpRequestType) {
-    HttpRequestType["CACHE_HIT"] = "cacheHit";
-    HttpRequestType["DATA_PROVIDER_HIT"] = "dataProviderHit";
-    HttpRequestType["ADAPTER_ERROR"] = "adapterError";
-    HttpRequestType["INPUT_ERROR"] = "inputError";
-    HttpRequestType["RATE_LIMIT_ERROR"] = "rateLimitError";
-    // BURST_LIMIT_ERROR = 'burstLimitError',
-    // BACKOFF_ERROR = 'backoffError',
-    HttpRequestType["DP_ERROR"] = "dataProviderError";
-    HttpRequestType["TIMEOUT_ERROR"] = "timeoutError";
-    HttpRequestType["CONNECTION_ERROR"] = "connectionError";
-    // RES_EMPTY_ERROR = 'responseEmptyError',
-    // RES_INVALID_ERROR = 'responseInvalidError',
-    HttpRequestType["CUSTOM_ERROR"] = "customError";
-})(HttpRequestType = exports.HttpRequestType || (exports.HttpRequestType = {}));
-/**
- * Maxiumum number of characters that a feedId can contain.
- */
-exports.MAX_FEED_ID_LENGTH = 300;
-// We should tune these as we collect data, this is the default bucket distribution that prom comes with
-exports.requestDurationBuckets = [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10];

package/dist/src/metrics/index.d.ts

@@ -1,15 +0,0 @@
-import * as client from 'prom-client';
-import { AdapterRequest } from '../util';
-import { AdapterConfig } from '../config';
-import { FastifyReply, HookHandlerDoneFunction } from 'fastify';
-export declare function setupMetricsServer(name: string, config: AdapterConfig): void;
-export declare const setupMetrics: (name: string, config: AdapterConfig) => void;
-/**
- * Builds metrics middleware that records end to end EA response times
- * and count of requests
- *
- * @returns the cache middleware function
- */
-export declare const buildMetricsMiddleware: (req: AdapterRequest, res: FastifyReply, done: HookHandlerDoneFunction) => void;
-export declare const httpRequestsTotal: client.Counter<"type" | "method" | "feed_id" | "status_code" | "provider_status_code" | "retry" | "is_cache_warming">;
-export declare const httpRequestDurationSeconds: client.Histogram<string>;

package/dist/src/metrics/index.js

@@ -1,122 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.httpRequestDurationSeconds = exports.httpRequestsTotal = exports.buildMetricsMiddleware = exports.setupMetrics = exports.setupMetricsServer = void 0;
-const client = __importStar(require("prom-client"));
-const constants_1 = require("./constants");
-const util_1 = require("../util");
-const fastify_1 = __importDefault(require("fastify"));
-const path_1 = require("path");
-const error_1 = require("../validation/error");
-const logger = (0, util_1.makeLogger)('Metrics');
-function setupMetricsServer(name, config) {
-    const metricsApp = (0, fastify_1.default)({
-        logger: false,
-    });
-    const metricsPort = config.METRICS_PORT;
-    const endpoint = config.METRICS_USE_BASE_URL ? (0, path_1.join)(config.BASE_URL, 'metrics') : '/metrics';
-    const eaHost = config.EA_HOST;
-    (0, exports.setupMetrics)(name, config);
-    metricsApp.get(endpoint, async (_, res) => {
-        res.type('txt');
-        res.send(await client.register.metrics());
-    });
-    metricsApp.listen(metricsPort, eaHost, () => logger.info(`Monitoring listening on port ${metricsPort}!`));
-}
-exports.setupMetricsServer = setupMetricsServer;
-const setupMetrics = (name, config) => {
-    client.collectDefaultMetrics();
-    client.register.setDefaultLabels({
-        app_name: config.METRICS_NAME || name || 'N/A',
-        app_version: config['npm_package_version'],
-    });
-};
-exports.setupMetrics = setupMetrics;
-/**
- * Builds metrics middleware that records end to end EA response times
- * and count of requests
- *
- * @returns the cache middleware function
- */
-const buildMetricsMiddleware = (req, res, done) => {
-    const feedId = req.requestContext.meta?.metrics?.feedId || 'N/A';
-    const labels = buildHttpRequestMetricsLabel(feedId, req.requestContext.meta?.error, req.requestContext.meta?.metrics?.cacheHit);
-    // Record number of requests sent to EA
-    exports.httpRequestsTotal.labels(labels).inc();
-    // Record response time of request through entire EA
-    exports.httpRequestDurationSeconds.observe(res.getResponseTime());
-    logger.debug(`Response time for ${feedId}: ${res.getResponseTime()}ms`);
-    done();
-};
-exports.buildMetricsMiddleware = buildMetricsMiddleware;
-const buildHttpRequestMetricsLabel = (feedId, error, cacheHit) => {
-    const labels = {};
-    labels.method = 'POST';
-    labels.feed_id = feedId;
-    if (error instanceof error_1.AdapterError) {
-        // If error present and an instace of AdapterError, build label from error info
-        labels.type = error?.metricsLabel || constants_1.HttpRequestType.ADAPTER_ERROR;
-        labels.status_code = error?.statusCode;
-        labels.provider_status_code = error?.providerStatusCode;
-    }
-    else if (error instanceof Error) {
-        // If error present and not instance of generic Error, unexpected failure occurred
-        labels.type = constants_1.HttpRequestType.ADAPTER_ERROR;
-        labels.status_code = 500;
-    }
-    else {
-        // If no error present, request went as expected
-        labels.status_code = 200;
-        if (cacheHit) {
-            labels.type = constants_1.HttpRequestType.CACHE_HIT;
-        }
-        else {
-            labels.type = constants_1.HttpRequestType.DATA_PROVIDER_HIT;
-            labels.provider_status_code = 200;
-        }
-    }
-    return labels;
-};
-exports.httpRequestsTotal = new client.Counter({
-    name: 'http_requests_total',
-    help: 'The number of http requests this external adapter has serviced for its entire uptime',
-    labelNames: [
-        'method',
-        'status_code',
-        'retry',
-        'type',
-        'is_cache_warming',
-        'feed_id',
-        'provider_status_code',
-    ],
-});
-exports.httpRequestDurationSeconds = new client.Histogram({
-    name: 'http_request_duration_seconds',
-    help: 'A histogram bucket of the distribution of http request durations',
-    buckets: constants_1.requestDurationBuckets,
-});

package/dist/src/metrics/util.d.ts

@@ -1,7 +0,0 @@
-import { AdapterMetricsMeta, AdapterRequestData } from '../util';
-import { AdapterEndpoint } from '../adapter';
-import { AdapterConfig, SettingsMap } from '../config';
-export declare const getMetricsMeta: <Params, Result, CustomSettings extends SettingsMap>({ adapterEndpoint, adapterConfig, }: {
-    adapterEndpoint: AdapterEndpoint<Params, Result, CustomSettings>;
-    adapterConfig: AdapterConfig<CustomSettings>;
-}, data: AdapterRequestData) => AdapterMetricsMeta;

package/dist/src/metrics/util.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMetricsMeta = void 0;
-const cache_1 = require("../cache");
-const getMetricsMeta = ({ adapterEndpoint, adapterConfig, }, data) => {
-    const feedId = (0, cache_1.calculateFeedId)({ adapterEndpoint, adapterConfig }, data);
-    return { feedId };
-};
-exports.getMetricsMeta = getMetricsMeta;

package/dist/src/package/adapter.d.ts

@@ -1,88 +0,0 @@
-import { AdapterConfig, BaseAdapterConfig, SettingsMap } from './config';
-import { AdapterRateLimitTier } from './rate-limiting';
-import { AdapterDependencies, Transport } from './transports';
-import { InputParameters } from './validation/input-params';
-/**
- * Structure to describe rate limits specs for the Adapter
- */
-interface AdapterRateLimitingConfig {
-    /** Adapter rate limits, gotten from the specific tier requested */
-    tiers: Record<string, AdapterRateLimitTier>;
-}
-/**
- * Main structure of an External Adapter
- */
-export interface Adapter {
-    /** Name of the adapter */
-    name: string;
-    /** If present, the string that will be used for requests with no specified endpoint */
-    defaultEndpoint?: string;
-    /** List of [[AdapterEndpoint]]s in the adapter */
-    endpoints: AdapterEndpoint[];
-    /** Map of overrides to the default config values for an Adapter */
-    envDefaultOverrides?: Partial<BaseAdapterConfig>;
-    /** List of custom env vars for this particular adapter (e.g. RPC_URL) */
-    customSettings?: SettingsMap;
-    /** Configuration relevant to outbound (EA --\> DP) communication rate limiting */
-    rateLimiting?: AdapterRateLimitingConfig;
-    /** Overrides for converting the 'base' parameter that are hardcoded into the adapter. */
-    overrides?: Record<string, string>;
-}
-/**
- * Structure to describe rate limits specs for a specific adapter endpoint
- */
-export interface EndpointRateLimitingConfig {
-    /**
-     * How much of the total limit for the adapter will be assigned to this specific endpoint.
-     * Should be a non-zero positive number up to 100.
-     * Endpoints in the same adapter without a specific allocation will divide the remaining limits equally.
-     */
-    allocationPercentage: number;
-}
-/**
- * Structure to describe a specific endpoint in an [[Adapter]]
- */
-export interface AdapterEndpoint {
-    /** Name that will be used to match input params to this endpoint (case insensitive) */
-    name: string;
-    /** List of alternative endpoint names that will resolve to this same transport (case insensitive) */
-    aliases?: string[];
-    /** Transport that will be used to handle data processing and communication for this endpoint */
-    transport: Transport<any, any, any>;
-    /** Specification of what the body of a request hitting this endpoint should look like (used for validation) */
-    inputParameters: InputParameters;
-    /** Specific details related to the rate limiting for this endpoint in particular */
-    rateLimiting?: EndpointRateLimitingConfig;
-}
-/**
- * Structure to describe an adapter that has been initialized
- */
-export interface InitializedAdapter extends Adapter {
-    /** Object containing alias translations for all endpoints */
-    endpointsMap: Record<string, AdapterEndpoint>;
-    /** Initialized dependencies that the adapter will use */
-    dependencies: AdapterDependencies;
-    /** Configuration params for various adapter properties */
-    config: AdapterConfig;
-}
-/**
- * This function will process dependencies for an adapter, such as caches or rate limiters,
- * in order to inject them into transports and other relevant places later in the lifecycle.
- *
- * @param config - the configuration for this adapter
- * @param inputDependencies - a partial obj of initialized dependencies to override the created ones
- * @param rateLimitingConfig - details from the adapter regarding rate limiting
- * @returns a set of AdapterDependencies all initialized
- */
-export declare const initializeDependencies: (adapter: Adapter, config: AdapterConfig, inputDependencies?: Partial<AdapterDependencies>) => AdapterDependencies;
-/**
- * Initializes all of the [[Transport]]s in the adapter, passing along any [[AdapterDependencies]] and [[AdapterConfig]].
- * Additionally, it builds a map out of all the endpoint names and aliases (checking for duplicates).
- *
- * @param adapter - an instance of an Adapter
- * @param dependencies - dependencies that the adapter will need at initialization
- * @param config - configuration variables already processed and validated
- * @returns - the adapter with all transports initialized and aliases map built
- */
-export declare const initializeAdapter: (adapter: Adapter, config: AdapterConfig, dependencies?: Partial<AdapterDependencies>) => Promise<InitializedAdapter>;
-export {};

package/dist/src/package/adapter.js

@@ -1,112 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.initializeAdapter = exports.initializeDependencies = void 0;
-const factory_1 = require("./cache/factory");
-const rate_limiting_1 = require("./rate-limiting");
-const util_1 = require("./util");
-const logger = (0, util_1.makeLogger)('Adapter');
-/**
- * This function will take an adapter structure and go through each endpoint, calculating
- * each one's allocation of the total rate limits that are set for the adapter as a whole.
- *
- * @param adapter - the adapter to initialize rate limiting for
- */
-const calculateRateLimitAllocations = (adapter) => {
-    const numberOfEndpoints = adapter.endpoints.length;
-    const endpointsWithExplicitAllocations = adapter.endpoints.filter((e) => e.rateLimiting);
-    const totalExplicitAllocation = endpointsWithExplicitAllocations
-        .map((e) => e.rateLimiting?.allocationPercentage || 0)
-        .reduce((sum, next) => sum + next, 0);
-    if (totalExplicitAllocation > 100) {
-        throw new Error('The total allocation set for all endpoints summed cannot exceed 100%');
-    }
-    if (totalExplicitAllocation === 100 &&
-        numberOfEndpoints - endpointsWithExplicitAllocations.length > 0) {
-        throw new Error('The explicit allocation is at 100% but there are endpoints with implicit allocation');
-    }
-    const implicitAllocation = 100 - totalExplicitAllocation;
-    logger.debug('Adapter rate limit allocations:');
-    for (const endpoint of adapter.endpoints) {
-        if (!endpoint.rateLimiting) {
-            endpoint.rateLimiting = {
-                allocationPercentage: implicitAllocation / (numberOfEndpoints - endpointsWithExplicitAllocations.length),
-            };
-        }
-        logger.debug(`Endpoint [${endpoint.name}] - ${endpoint.rateLimiting?.allocationPercentage}%`);
-    }
-};
-/**
- * This function will process dependencies for an adapter, such as caches or rate limiters,
- * in order to inject them into transports and other relevant places later in the lifecycle.
- *
- * @param config - the configuration for this adapter
- * @param inputDependencies - a partial obj of initialized dependencies to override the created ones
- * @param rateLimitingConfig - details from the adapter regarding rate limiting
- * @returns a set of AdapterDependencies all initialized
- */
-const initializeDependencies = (adapter, config, inputDependencies) => {
-    const dependencies = inputDependencies || {};
-    if (!dependencies.cache) {
-        dependencies.cache = factory_1.CacheFactory.buildCache(config);
-    }
-    // In the future we might want something more complex, but for now it's better to simplify
-    // and just use the same rate limiting for everything. Once we have a more complex use case we
-    // can think of ways to make this more configurable.
-    const rateLimitingTier = (0, rate_limiting_1.getRateLimitingTier)(adapter.rateLimiting?.tiers, config.RATE_LIMIT_API_TIER);
-    if (!dependencies.requestRateLimiter) {
-        dependencies.requestRateLimiter = new rate_limiting_1.SimpleCountingRateLimiter().initialize(adapter.endpoints, rateLimitingTier);
-    }
-    if (!dependencies.backgroundExecuteRateLimiter) {
-        dependencies.backgroundExecuteRateLimiter = new rate_limiting_1.FixedFrequencyRateLimiter().initialize(adapter.endpoints, rateLimitingTier);
-    }
-    return dependencies;
-};
-exports.initializeDependencies = initializeDependencies;
-/**
- * Takes an adapter and normalizes all endpoint names and aliases, as well as the default endpoint.
- * i.e. makes them lowercase for now
- * @param adapter - an instance of an Adapter
- */
-const normalizeEndpointNames = (adapter) => {
-    // Make endpoints case insensitive, including default
-    adapter.defaultEndpoint = adapter.defaultEndpoint?.toLowerCase();
-    for (const endpoint of adapter.endpoints) {
-        endpoint.name = endpoint.name.toLowerCase();
-        endpoint.aliases = endpoint.aliases?.map((a) => a.toLowerCase());
-    }
-};
-/**
- * Initializes all of the [[Transport]]s in the adapter, passing along any [[AdapterDependencies]] and [[AdapterConfig]].
- * Additionally, it builds a map out of all the endpoint names and aliases (checking for duplicates).
- *
- * @param adapter - an instance of an Adapter
- * @param dependencies - dependencies that the adapter will need at initialization
- * @param config - configuration variables already processed and validated
- * @returns - the adapter with all transports initialized and aliases map built
- */
-const initializeAdapter = async (adapter, config, dependencies) => {
-    normalizeEndpointNames(adapter);
-    calculateRateLimitAllocations(adapter);
-    const initializedDependencies = (0, exports.initializeDependencies)(adapter, config, dependencies);
-    const endpointsMap = {};
-    for (const endpoint of adapter.endpoints) {
-        // Add aliases to map to use in validation
-        const aliases = [endpoint.name, ...(endpoint.aliases || [])];
-        for (const alias of aliases) {
-            if (endpointsMap[alias]) {
-                throw new Error(`Duplicate endpoint / alias: "${alias}"`);
-            }
-            endpointsMap[alias] = endpoint;
-        }
-        logger.debug(`Initializing transport for endpoint "${endpoint.name}"...`);
-        await endpoint.transport.initialize(initializedDependencies);
-    }
-    logger.debug('Adapter initialization complete.');
-    return {
-        ...adapter,
-        endpointsMap,
-        dependencies: initializedDependencies,
-        config,
-    };
-};
-exports.initializeAdapter = initializeAdapter;

package/dist/src/package/background-executor.d.ts

@@ -1,11 +0,0 @@
-/// <reference types="node" />
-import { Server } from 'http';
-import { InitializedAdapter } from './adapter';
-/**
- * Very simple background loop that will call the [[Transport.backgroundExecute]] functions in all Transports.
- * It gets the time in ms to wait as the return value from those functions, and sleeps until next execution.
- *
- * @param adapter - an initialized External Adapter
- * @param server - the http server to attach an on close listener to
- */
-export declare function callBackgroundExecutes(adapter: InitializedAdapter, server?: Server): Promise<void>;

package/dist/src/package/background-executor.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.callBackgroundExecutes = void 0;
-const util_1 = require("./util");
-const logger = (0, util_1.makeLogger)('BackgroundExecutor');
-/**
- * Very simple background loop that will call the [[Transport.backgroundExecute]] functions in all Transports.
- * It gets the time in ms to wait as the return value from those functions, and sleeps until next execution.
- *
- * @param adapter - an initialized External Adapter
- * @param server - the http server to attach an on close listener to
- */
-async function callBackgroundExecutes(adapter, server) {
-    // Set up variable to check later on to see if we need to stop this background "thread"
-    // If no server is provided, the listener won't be set and serverClosed will always be false
-    let serverClosed = false;
-    server?.on('close', () => {
-        serverClosed = true;
-    });
-    for (const endpoint of adapter.endpoints) {
-        const backgroundExecute = endpoint.transport.backgroundExecute?.bind(endpoint.transport);
-        if (!backgroundExecute) {
-            logger.debug(`Endpoint "${endpoint.name}" has no background execute, skipping...`);
-            continue;
-        }
-        const context = {
-            adapterEndpoint: endpoint,
-            adapterConfig: adapter.config,
-        };
-        const handler = async () => {
-            if (serverClosed) {
-                logger.info('Server closed, stopping recursive backgroundExecute handler chain');
-                return;
-            }
-            logger.debug(`Calling background execute for endpoint "${endpoint.name}"`);
-            const timeToWait = await backgroundExecute(context);
-            logger.debug(`Finished background execute for endpoint "${endpoint.name}", sleeping for ${timeToWait}ms`);
-            await (0, util_1.sleep)(timeToWait);
-            handler();
-        };
-        // Start recursive async calls
-        handler();
-    }
-}
-exports.callBackgroundExecutes = callBackgroundExecutes;

package/dist/src/package/cache/factory.d.ts

@@ -1,6 +0,0 @@
-import { AdapterConfig } from '../config';
-import { LocalCache } from './local';
-import { RedisCache } from './redis';
-export declare class CacheFactory {
-    static buildCache(config: AdapterConfig): LocalCache<unknown> | RedisCache<unknown> | undefined;
-}

package/dist/src/package/cache/factory.js

@@ -1,57 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CacheFactory = void 0;
-const ioredis_1 = __importDefault(require("ioredis"));
-const util_1 = require("../util");
-const local_1 = require("./local");
-const cacheMetrics = __importStar(require("./metrics"));
-const redis_1 = require("./redis");
-const logger = (0, util_1.makeLogger)('CacheFactory');
-class CacheFactory {
-    static buildCache(config) {
-        logger.info(`Using "${config.CACHE_TYPE}" cache.`);
-        if (config.CACHE_TYPE === 'local') {
-            return new local_1.LocalCache();
-        }
-        else if (config.CACHE_TYPE === 'redis') {
-            const redis = new ioredis_1.default({
-                enableAutoPipelining: true,
-                host: config.CACHE_REDIS_HOST,
-                port: config.CACHE_REDIS_PORT,
-            });
-            redis.on('connect', () => {
-                cacheMetrics.redisConnectionsOpen.inc();
-            });
-            // TODO: Maybe track active redis connections instead of just total count of connections created
-            // Use a Gauge and track with a combo of connect/end events listeners
-            return new redis_1.RedisCache(redis);
-        }
-    }
-}
-exports.CacheFactory = CacheFactory;