@chainlink/external-adapter-framework 0.0.6 → 0.0.7

package/dist/src/transports/batch-warming.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BatchWarmingTransport = void 0;
+const util_1 = require("../util");
+const _1 = require("./");
+const util_2 = require("./util");
+const logger = (0, util_1.makeLogger)('BatchWarmingTransport');
+/**
+ * Transport implementation that takes incoming batches requests and keeps a warm cache of values.
+ * Within the setup function, adapter params are added to an set that also keeps track and expires values.
+ * In the background execute, the list of non-expired items in the set is fetched.
+ * Then, the list is passed through the `prepareRequest` function, that returns an AxiosRequestConfig.
+ * The Data Provider response is, they are passed through the `parseResponse` function to create a [[CacheEntry]] list.
+ * Finally, the items in that [[CacheEntry]] list are set in the Cache so the Adapter can fetch values from there.
+ *
+ * @typeParam AdapterParams - interface for the adapter request body
+ * @typeParam ProviderRequestBody - interface for the body of the request to the Data Provider
+ * @typeParam ProviderResponseBody - interface for the body of the Data Provider's response
+ */
+class BatchWarmingTransport {
+    constructor(config) {
+        this.config = config;
+        this.expiringSortedSet = new util_1.ExpiringSortedSet(); // TODO: Move to dependencies, inject
+    }
+    async initialize(dependencies) {
+        this.cache = dependencies.cache;
+        this.rateLimiter = dependencies.backgroundExecuteRateLimiter;
+    }
+    async hasBeenSetUp(req) {
+        return !!this.expiringSortedSet.get(req.requestContext.cacheKey);
+    }
+    async setup(req, config) {
+        logger.debug(`Adding entry to batch warming set: [${req.requestContext.cacheKey}] = ${req.requestContext.data}`);
+        this.expiringSortedSet.add(req.requestContext.cacheKey, req.requestContext.data, config.WARMUP_SUBSCRIPTION_TTL);
+    }
+    async backgroundExecute(context) {
+        logger.debug('Starting background execute');
+        const entries = this.expiringSortedSet.getAll();
+        if (!entries.length) {
+            logger.debug('No entries in batch warming set, skipping');
+            return this.rateLimiter.msUntilNextExecution(context.adapterEndpoint.name);
+        }
+        const request = this.config.prepareRequest(entries, context);
+        logger.trace('Sending request to data provider...');
+        const providerResponse = await (0, util_2.axiosRequest)(request);
+        logger.debug(`Got response from provider, parsing (raw body: ${providerResponse.data})`);
+        const results = this.config.parseResponse(providerResponse, context);
+        const adapterResponses = (0, _1.buildCacheEntriesFromResults)(results, context);
+        logger.debug('Setting adapter responses in cache');
+        await this.cache.setMany(adapterResponses, context.adapterConfig.CACHE_MAX_AGE);
+        // TODO: Record rate limit credit with cost, default 1
+        return this.rateLimiter.msUntilNextExecution(context.adapterEndpoint.name);
+    }
+}
+exports.BatchWarmingTransport = BatchWarmingTransport;

package/dist/src/transports/index.js

@@ -0,0 +1,85 @@
+"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.buildTransportHandler = exports.buildCacheEntriesFromResults = void 0;
+const cache_1 = require("../cache");
+const util_1 = require("../util");
+__exportStar(require("./batch-warming"), exports);
+__exportStar(require("./rest"), exports);
+__exportStar(require("./websocket"), exports);
+const logger = (0, util_1.makeLogger)('Transport');
+/**
+ * Helper method to build cache entries to set after getting a bunch of responses from a DP.
+ *
+ * @param results - a list of results coming from a DataProvider
+ * @param context - context for the Adapter
+ * @returns a list of CacheEntries of AdapterResponses
+ */
+const buildCacheEntriesFromResults = (results, context) => results.map((r) => {
+    const cacheEntry = {
+        key: (0, cache_1.calculateCacheKey)(context, r.params),
+        value: {
+            result: r.value,
+            statusCode: 200,
+            data: null, // TODO: Maybe add data as well?
+        },
+    };
+    if (context.adapterConfig.METRICS_ENABLED &&
+        context.adapterConfig.EXPERIMENTAL_METRICS_ENABLED) {
+        const metrics = {
+            maxAge: Date.now() + context.adapterConfig.CACHE_MAX_AGE,
+            metricsMeta: {
+                feedId: (0, cache_1.calculateFeedId)(context.adapterEndpoint, r.params),
+            },
+        };
+        cacheEntry.value = { ...cacheEntry.value, ...metrics };
+    }
+    return cacheEntry;
+});
+exports.buildCacheEntriesFromResults = buildCacheEntriesFromResults;
+/**
+ * Takes an Adapter, its configuration, and its dependencies, and it creates an express middleware
+ * that will pass along the AdapterRequest to the appropriate Transport (acc. to the endpoint in the req.)
+ *
+ * @param adapter - main adapter object, already initialized
+ * @returns the transport handler middleware function
+ */
+const buildTransportHandler = (adapter) => async (req, reply) => {
+    // Get transport, must be here because it's already checked in the validator
+    const transport = adapter.endpointsMap[req.requestContext.endpointName].transport;
+    // Set up transport if it hasn't been done already
+    if (!(await transport.hasBeenSetUp(req))) {
+        logger.debug('Transport not set up yet, doing so...');
+        const immediateResponse = await transport.setup(req, adapter.config);
+        if (immediateResponse) {
+            logger.debug('Got immediate response from transport, sending as response');
+            return reply.send(immediateResponse);
+        }
+    }
+    logger.debug('Transport is set up, polling cache for response...');
+    const response = await (0, cache_1.pollResponseFromCache)(adapter.dependencies.cache, req.requestContext.cacheKey, {
+        maxRetries: adapter.config.CACHE_POLLING_MAX_RETRIES,
+        sleep: adapter.config.CACHE_POLLING_SLEEP_MS,
+    });
+    if (response) {
+        logger.debug('Got a response from the cache, sending that back');
+        return reply.send(response);
+    }
+    logger.debug('Ran out of polling attempts, returning timeout');
+    reply.statusCode = 504;
+    return reply.send();
+};
+exports.buildTransportHandler = buildTransportHandler;

package/dist/src/transports/metrics.js

@@ -0,0 +1,119 @@
+"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.wsMessageTotal = exports.wsSubscriptionErrors = exports.wsSubscriptionTotal = exports.wsSubscriptionActive = exports.wsConnectionRetries = exports.wsConnectionErrors = exports.wsConnectionActive = exports.messageLabels = exports.subscriptionErrorLabels = exports.subscriptionLabels = exports.connectionErrorLabels = exports.connectionLabels = exports.dataProviderRequestDurationSeconds = exports.dataProviderRequests = exports.dataProviderMetricsLabel = void 0;
+const client = __importStar(require("prom-client"));
+const constants_1 = require("../metrics/constants");
+// Data Provider Metrics
+const dataProviderMetricsLabel = (providerStatusCode, method = 'get') => ({
+    provider_status_code: providerStatusCode,
+    method: method.toUpperCase(),
+});
+exports.dataProviderMetricsLabel = dataProviderMetricsLabel;
+exports.dataProviderRequests = new client.Counter({
+    name: 'data_provider_requests',
+    help: 'The number of http requests that are made to a data provider',
+    labelNames: ['method', 'provider_status_code'],
+});
+exports.dataProviderRequestDurationSeconds = new client.Histogram({
+    name: 'data_provider_request_duration_seconds',
+    help: 'A histogram bucket of the distribution of data provider request durations',
+    buckets: constants_1.requestDurationBuckets,
+});
+// Websocket Metrics
+const connectionLabels = (key) => ({
+// Key,
+});
+exports.connectionLabels = connectionLabels;
+const connectionErrorLabels = (message) => ({
+    // Key,
+    message,
+});
+exports.connectionErrorLabels = connectionErrorLabels;
+const subscriptionLabels = (
+// Connection_key: string,
+feed_id, cache_key) => ({
+    // Connection_key,
+    feed_id,
+    subscription_key: cache_key,
+});
+exports.subscriptionLabels = subscriptionLabels;
+const subscriptionErrorLabels = (
+// Connection_key: string,
+input, message, type) => ({
+    // Connection_key,
+    feed_id: input ? input.metricsMeta?.feedId : 'N/A',
+    message,
+    subscription_key: input.cacheKey ? input.cacheKey : 'N/A',
+    type,
+});
+exports.subscriptionErrorLabels = subscriptionErrorLabels;
+const messageLabels = (feed_id, cache_key) => ({
+    feed_id,
+    subscription_key: cache_key,
+});
+exports.messageLabels = messageLabels;
+exports.wsConnectionActive = new client.Gauge({
+    name: 'ws_connection_active',
+    help: 'The number of active connections',
+    labelNames: ['url'],
+});
+exports.wsConnectionErrors = new client.Counter({
+    name: 'ws_connection_errors',
+    help: 'The number of connection errors',
+    labelNames: ['url', 'message'],
+});
+// Doesn't seem to be any retry connection functionality yet
+exports.wsConnectionRetries = new client.Counter({
+    name: 'ws_connection_retries',
+    help: 'The number of connection retries',
+    labelNames: ['url'],
+});
+exports.wsSubscriptionActive = new client.Gauge({
+    name: 'ws_subscription_active',
+    help: 'The number of currently active subscriptions',
+    labelNames: ['connection_url', 'feed_id', 'subscription_key'],
+});
+exports.wsSubscriptionTotal = new client.Counter({
+    name: 'ws_subscription_total',
+    help: 'The number of subscriptions opened in total',
+    labelNames: ['connection_url', 'feed_id', 'subscription_key'],
+});
+exports.wsSubscriptionErrors = new client.Counter({
+    name: 'ws_subscription_errors',
+    help: 'The number of subscriptions errors',
+    labelNames: ['connection_url', 'feed_id', 'subscription_key', 'message', 'type'],
+});
+exports.wsMessageTotal = new client.Counter({
+    name: 'ws_message_total',
+    help: 'The number of messages received in total',
+    labelNames: ['feed_id', 'subscription_key'],
+});
+// Cache Warmer Metrics
+exports.cacheWarmerCount = new client.Gauge({
+    name: 'cache_warmer_get_count',
+    help: 'The number of cache warmers running',
+    labelNames: ['isBatched'],
+});

package/dist/src/transports/rest.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestTransport = void 0;
+const util_1 = require("../util");
+const error_1 = require("../validation/error");
+const util_2 = require("./util");
+const IN_FLIGHT_PREFIX = 'InFlight';
+const logger = (0, util_1.makeLogger)('RestTransport');
+/**
+ * Transport implementation that takes incoming requests, transforms them into a DataProvider request,
+ * and executes that request returning the response immediately from the `setup` function.
+ * Optionally, setting the `coalescing` option to `true` will make it so once a request is in flight,
+ * new adapter requests for the same feed will not trigger a new one, but return an empty promise from
+ * the setup instead so the normal cache polling mechanism is used.
+ *
+ * @typeParam AdapterParams - interface for the adapter request body
+ * @typeParam ProviderRequestBody - interface for the body of the request to the Data Provider
+ * @typeParam ProviderResponseBody - interface for the body of the Data Provider's response
+ */
+class RestTransport {
+    constructor(config) {
+        this.config = config;
+    }
+    async initialize(dependencies) {
+        this.inFlightPrefix = `${IN_FLIGHT_PREFIX}-`;
+        this.cache = dependencies.cache;
+        this.rateLimiter = dependencies.requestRateLimiter;
+    }
+    async hasBeenSetUp(req) {
+        if (!this.config.options.coalescing) {
+            return false;
+        }
+        // Check if request is in flight
+        const inFlight = await this.cache.get(this.inFlightPrefix + req.requestContext.cacheKey);
+        if (inFlight) {
+            logger.debug('Request is in flight, transport has been set up');
+            return true;
+        }
+        else {
+            logger.debug('Request not in flight, transport not set up');
+            return false;
+        }
+    }
+    async waitUntilUnderRateLimit(options, retry = 0) {
+        if (this.rateLimiter.isUnderLimits()) {
+            logger.trace('Incoming request would not be under limits, moving on');
+            return;
+        }
+        if (retry >= options.maxRetries) {
+            throw new error_1.AdapterError({
+                statusCode: 504,
+                message: `REST Transport timed out while waiting for rate limit availability (max retries: ${options.maxRetries})`,
+            });
+        }
+        logger.debug(`Request would be over rate limits, sleeping for ${options.msBetweenRetries}`);
+        await (0, util_1.sleep)(options.msBetweenRetries);
+        await this.waitUntilUnderRateLimit(options, retry + 1);
+    }
+    async setup(req, config) {
+        if (this.config.options.coalescing) {
+            logger.debug('Setting up rest transport, setting request in flight in cache');
+            // TODO: Should this use a separate cache?
+            // TODO: Set viable ttl to approximate timeout from API
+            // TODO: Make this ttl configurable
+            await this.cache.set(this.inFlightPrefix + req.requestContext.cacheKey, true, 2000); // Can't use Infinity for things like Redis
+        }
+        const request = await this.config.prepareRequest(req, config);
+        logger.trace('Check if we are under rate limits to perform request');
+        await this.waitUntilUnderRateLimit({
+            maxRetries: config.REST_TRANSPORT_MAX_RATE_LIMIT_RETRIES,
+            msBetweenRetries: config.REST_TRANSPORT_MS_BETWEEN_RATE_LIMIT_RETRIES,
+        });
+        logger.trace('Sending request to data provider...');
+        const providerResponse = await (0, util_2.axiosRequest)(request);
+        logger.debug(`Got response from provider, parsing (raw body: ${providerResponse.data})`); // TODO: Sensitive data?
+        const parsedResponse = await this.config.parseResponse(req, providerResponse, config);
+        if (config.METRICS_ENABLED && config.EXPERIMENTAL_METRICS_ENABLED) {
+            // TODO: Potentially create function to add all telemetry data
+            parsedResponse.maxAge = Date.now() + config.CACHE_MAX_AGE;
+            parsedResponse.metricsMeta = { feedId: req.requestContext.metricsMeta?.feedId || 'N/A' };
+        }
+        logger.debug('Setting provider response in cache');
+        await this.cache.set(req.requestContext.cacheKey, parsedResponse, config.CACHE_MAX_AGE);
+        // TODO: Record rate limit credit with cost, default 1
+        // TODO: move this to a try/catch/finally
+        if (this.config.options.coalescing) {
+            logger.debug('Set provider response in cache, removing in flight from cache');
+            await this.cache.delete(this.inFlightPrefix);
+        }
+        return parsedResponse;
+    }
+}
+exports.RestTransport = RestTransport;

package/dist/src/transports/util.js

@@ -0,0 +1,85 @@
+"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.axiosRequest = void 0;
+const axios_1 = __importDefault(require("axios"));
+const error_1 = require("../validation/error");
+const transportMetrics = __importStar(require("./metrics"));
+/**
+ * Performs axios request along with metrics recording and error handling
+ *
+ * @param request - axios request config
+ * @returns axios response for the request
+ */
+async function axiosRequest(request) {
+    const responseTimer = transportMetrics.dataProviderRequestDurationSeconds.startTimer();
+    let providerResponse;
+    try {
+        providerResponse = await axios_1.default.request(request);
+    }
+    catch (e) {
+        const error = e;
+        // Request error
+        let providerStatusCode;
+        let name;
+        let statusCode;
+        if (error.code === 'ECONNABORTED') {
+            providerStatusCode = error?.response?.status ?? 504;
+            name = 'Data Provider Request Timeout error';
+            statusCode = 504;
+        }
+        else {
+            providerStatusCode = error?.response?.status ?? 0; // 0 -> connection error
+            statusCode = 200;
+        }
+        // Record count of failed data provider request
+        transportMetrics.dataProviderRequests
+            .labels(transportMetrics.dataProviderMetricsLabel(providerStatusCode, request.method))
+            .inc();
+        // TODO: Use specific AdapterErrors once ported over (AdapterTimeoutError, AdapterConnectionError, AdapterDataProviderError)
+        throw new error_1.AdapterError({
+            statusCode,
+            name,
+            providerStatusCode,
+            message: error?.message,
+            cause: error,
+            errorResponse: error?.response?.data,
+            url: request.url,
+        });
+    }
+    finally {
+        // Record time taken for data provider request for success or failure
+        responseTimer();
+    }
+    // Record count of successful data provider requests
+    transportMetrics.dataProviderRequests
+        .labels(transportMetrics.dataProviderMetricsLabel(providerResponse.status, request.method))
+        .inc();
+    return providerResponse;
+}
+exports.axiosRequest = axiosRequest;

package/dist/src/transports/websocket.js

@@ -0,0 +1,175 @@
+"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.WebSocketTransport = exports.WebSocketClassProvider = exports.DEFAULT_WS_TTL = void 0;
+const ws_1 = __importDefault(require("ws"));
+const util_1 = require("../util");
+const _1 = require("./");
+const transportMetrics = __importStar(require("./metrics"));
+// TODO: Config
+exports.DEFAULT_WS_TTL = 10000;
+const logger = (0, util_1.makeLogger)('WebSocketTransport');
+class WebSocketClassProvider {
+    static set(ctor) {
+        this.ctor = ctor;
+    }
+    static get() {
+        return this.ctor;
+    }
+}
+exports.WebSocketClassProvider = WebSocketClassProvider;
+WebSocketClassProvider.ctor = ws_1.default;
+/**
+ * Transport implementation that takes incoming requests, adds them to an [[ExpiringSortedSet]] and,
+ * through a WebSocket connection, subscribes to the relevant feeds to populate the cache.
+ *
+ * @typeParam AdapterParams - interface for the adapter request body
+ * @typeParam ProviderDataMessage - interface for a WS message containing processable data (i.e. not part of open/close/login/etc)
+ */
+class WebSocketTransport {
+    constructor(config) {
+        this.config = config;
+        // The double sets serve to create a simple polling mechanism instead of needing a subscription
+        // This one would be either local, redis, etc
+        this.expiringSortedSet = new util_1.ExpiringSortedSet(); // TODO: Move to dependencies, inject
+        // This one would not; this is always local state
+        this.localSubscriptions = [];
+    }
+    async initialize(dependencies) {
+        this.cache = dependencies.cache;
+        this.rateLimiter = dependencies.backgroundExecuteRateLimiter;
+    }
+    async hasBeenSetUp(req) {
+        return !!this.expiringSortedSet.get(req.requestContext.cacheKey);
+    }
+    async setup(req) {
+        logger.debug(`Adding entry to subscription set: [${req.requestContext.cacheKey}] = ${req.requestContext.data}`);
+        this.expiringSortedSet.add(req.requestContext.cacheKey, req.requestContext.data, exports.DEFAULT_WS_TTL);
+    }
+    // TODO: Maybe we don't do this, and leave the preparation on the adapter's side?
+    // TODO: Maybe we store adapter params pre-prepared? That would be more efficient
+    // Assuming always JSON payloads for now, makes it all cleaner
+    serializeMessage(payload) {
+        return typeof payload === 'string' ? payload : JSON.stringify(payload);
+    }
+    deserializeMessage(data) {
+        return JSON.parse(data.toString());
+    }
+    establishWsConnection(context) {
+        return new Promise((resolve) => {
+            const ctor = WebSocketClassProvider.get();
+            this.wsConnection = new ctor(this.config.url);
+            this.wsConnection.addEventListener('open', async (event) => {
+                logger.debug(`Opened websocket connection.`);
+                await this.config.handlers.open(this.wsConnection, context);
+                logger.debug('Successfully executed connection opened handler');
+                // Record active ws connections by incrementing count on open
+                // Using URL in label since connection_key is removed from v3
+                transportMetrics.wsConnectionActive.labels({ url: this.config.url }).inc();
+                resolve(true);
+            });
+            this.wsConnection.addEventListener('message', async (event) => {
+                // TODO: Assuming JSON always, maybe use BSON also?
+                const parsed = this.deserializeMessage(event.data);
+                logger.trace(`Got ws message: ${parsed}`);
+                const results = this.config.handlers.message(parsed, context);
+                if (Array.isArray(results)) {
+                    const responses = (0, _1.buildCacheEntriesFromResults)(results, context);
+                    logger.trace(`Writing ${responses.length} responses to cache`);
+                    await this.cache.setMany(responses, context.adapterConfig.CACHE_MAX_AGE);
+                }
+            });
+            this.wsConnection.addEventListener('error', async (event) => {
+                // Record connection error count
+                transportMetrics.wsConnectionErrors
+                    .labels(transportMetrics.connectionErrorLabels(event.message))
+                    .inc();
+            });
+            this.wsConnection.addEventListener('close', (event) => {
+                logger.debug(`Closed websocket connection. Code: ${event.code} ; reason: ${event.reason?.toString()}`);
+                // Record active ws connections by decrementing count on close
+                // Using URL in label since connection_key is removed from v3
+                transportMetrics.wsConnectionActive.labels({ url: this.config.url }).dec();
+            });
+        });
+    }
+    // Unlike cache warming, this execute will manage subscriptions
+    async backgroundExecute(context) {
+        logger.debug('Starting background execute, getting subscriptions from sorted set');
+        const desiredSubs = this.expiringSortedSet.getAll();
+        logger.debug('Generating delta (subscribes & unsubscribes)');
+        // TODO: More efficient algorithm, this is really easy to read, but high(er) time complexity
+        const subscribes = desiredSubs
+            .filter((s) => !this.localSubscriptions.includes(s))
+            .map(this.config.builders.subscribeMessage)
+            .map(this.serializeMessage);
+        const unsubscribes = this.localSubscriptions
+            .filter((s) => !desiredSubs.includes(s))
+            .map(this.config.builders.unsubscribeMessage)
+            .map(this.serializeMessage);
+        logger.debug(`${subscribes.length} new subscriptions; ${unsubscribes.length} to unsubscribe`);
+        if (subscribes.length) {
+            logger.trace(`Will subscribe to: ${subscribes}`);
+        }
+        if (unsubscribes.length) {
+            logger.trace(`Will unsubscribe to: ${unsubscribes}`);
+        }
+        // New subs && no connection -> connect -> add subs
+        // No new subs && no connection -> skip
+        // New subs && connection -> add subs
+        // No new subs && connection -> unsubs only
+        if (!subscribes.length && !this.wsConnection) {
+            logger.debug('No entries in subscription set and no established connection, skipping');
+            return this.rateLimiter.msUntilNextExecution(context.adapterEndpoint.name);
+        }
+        if (!this.wsConnection && subscribes.length) {
+            logger.debug('No established connection and new subscriptions available, connecting to WS');
+            await this.establishWsConnection(context);
+        }
+        // TODO: Close connection at some point?
+        // TODO: Finish ws metrics
+        logger.debug('Sending subs/unsubs if there are any');
+        const messages = unsubscribes.concat(subscribes);
+        for (const message of messages) {
+            logger.trace(`Sending message: ${JSON.stringify(message)}`);
+            this.wsConnection.send(message);
+            // Record total number of ws messages sent
+            // ws_message_total.labels(messageLabels(this.config.key)).inc()
+        }
+        // Record number of total subscriptions made
+        // ws_subscription_total.labels(subscriptionLabels(this.config.key)).inc(subscribes.length())
+        // Record number of active ws subscriptions
+        // const activeSubCount = desiredSubs ? desiredSubs.length : 0
+        // ws_subscription_active.labels(subscriptionLabels(this.config.key)).set(activeSubCount)
+        logger.debug('Setting local state to cache value');
+        this.localSubscriptions = desiredSubs;
+        logger.debug('Background execute complete');
+        return this.rateLimiter.msUntilNextExecution(context.adapterEndpoint.name);
+    }
+}
+exports.WebSocketTransport = WebSocketTransport;

package/dist/src/util/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;