@chainlink/external-adapter-framework 0.0.21 → 0.0.22

package/cache/factory.js

@@ -1,27 +1,4 @@
 "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 };
 };
@@ -30,7 +7,6 @@ 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 {
@@ -48,9 +24,6 @@ class CacheFactory {
                 path: config.CACHE_REDIS_PATH,
                 timeout: config.CACHE_REDIS_TIMEOUT,
             });
-            redis.on('connect', () => {
-                cacheMetrics.redisConnectionsOpen.inc();
-            });
             return new redis_1.RedisCache(redis);
         }
     }

package/cache/index.js

@@ -10,25 +10,12 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     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 __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.buildCacheMiddleware = exports.pollResponseFromCache = exports.calculateKey = exports.calculateFeedId = exports.calculateCacheKey = void 0;
 const util_1 = require("../util");
-const cacheMetrics = __importStar(require("./metrics"));
 __exportStar(require("./local"), exports);
 __exportStar(require("./redis"), exports);
 __exportStar(require("./factory"), exports);
@@ -157,10 +144,8 @@ const buildCacheMiddleware = (adapter) => async (req, res) => {
     if (response) {
         logger.debug('Found response from cache, sending that');
         if (adapter.config.METRICS_ENABLED && adapter.config.EXPERIMENTAL_METRICS_ENABLED) {
-            const label = cacheMetrics.cacheMetricsLabel(req.requestContext.cacheKey, req.requestContext.meta?.metrics?.feedId || 'N/A', adapter.config.CACHE_TYPE);
             // Record cache staleness and cache get count and value
-            const staleness = calculateStaleness(response.maxAge, adapter.config.CACHE_MAX_AGE);
-            cacheMetrics.cacheGet(label, response.result, staleness);
+            calculateStaleness(response.maxAge, adapter.config.CACHE_MAX_AGE);
             req.requestContext.meta = {
                 ...req.requestContext.meta,
                 metrics: { ...req.requestContext.meta?.metrics, cacheHit: true },

package/cache/local.js

@@ -1,31 +1,7 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LocalCache = void 0;
 const util_1 = require("../util");
-const cacheMetrics = __importStar(require("./metrics"));
 const logger = (0, util_1.makeLogger)('LocalCache');
 /**
  * Local implementation of a Cache. It uses a simple js Object, storing entries with both
@@ -69,8 +45,6 @@ class LocalCache {
         const feedId = value.meta?.metrics?.feedId;
         if (feedId) {
             // Record cache set count, max age, and staleness (set to 0 for cache set)
-            const label = cacheMetrics.cacheMetricsLabel(key, feedId, cacheMetrics.CacheTypes.Local);
-            cacheMetrics.cacheSet(label, ttl);
         }
     }
     async setMany(entries, ttl) {

package/cache/redis.js

@@ -1,31 +1,7 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RedisCache = void 0;
 const util_1 = require("../util");
-const cacheMetrics = __importStar(require("./metrics"));
 const logger = (0, util_1.makeLogger)('RedisCache');
 /**
  * Redis implementation of a Cache. It uses a simple js Object, storing entries with both
@@ -40,10 +16,6 @@ class RedisCache {
     async get(key) {
         logger.trace(`Getting key ${key}`);
         const value = await this.client.get(key);
-        // Record get command sent to Redis
-        cacheMetrics.redisCommandsSentCount
-            .labels({ status: cacheMetrics.CMD_SENT_STATUS.SUCCESS, function_name: 'get' })
-            .inc();
         if (!value) {
             logger.debug(`No entry in redis cache for key "${key}", returning undefined`);
             return undefined;
@@ -53,10 +25,6 @@ class RedisCache {
     async delete(key) {
         logger.trace(`Deleting key ${key}`);
         await this.client.del(key);
-        // Record delete command sent to Redis
-        cacheMetrics.redisCommandsSentCount
-            .labels({ status: cacheMetrics.CMD_SENT_STATUS.SUCCESS, function_name: 'delete' })
-            .inc();
     }
     async set(key, value, ttl) {
         logger.trace(`Setting key ${key}`);
@@ -65,13 +33,7 @@ class RedisCache {
         const feedId = value.meta?.metrics?.feedId;
         if (feedId) {
             // Record cache set count, max age, and staleness (set to 0 for cache set)
-            const label = cacheMetrics.cacheMetricsLabel(key, feedId, cacheMetrics.CacheTypes.Redis);
-            cacheMetrics.cacheSet(label, ttl);
         }
-        // Record set command sent to Redis
-        cacheMetrics.redisCommandsSentCount
-            .labels({ status: cacheMetrics.CMD_SENT_STATUS.SUCCESS, function_name: 'set' })
-            .inc();
     }
     async setMany(entries, ttl) {
         logger.trace(`Setting a bunch of keys`);
@@ -86,15 +48,8 @@ class RedisCache {
             // Only record metrics if feed Id is present, otherwise assuming value is not adapter response to record
             const feedId = entry.value.meta?.metrics?.feedId;
             if (feedId) {
-                // Record cache set count, max age, and staleness (set to 0 for cache set)
-                const label = cacheMetrics.cacheMetricsLabel(entry.key, feedId, cacheMetrics.CacheTypes.Redis);
-                cacheMetrics.cacheSet(label, ttl);
             }
         }
-        // Record setMany command sent to Redis
-        cacheMetrics.redisCommandsSentCount
-            .labels({ status: cacheMetrics.CMD_SENT_STATUS.SUCCESS, function_name: 'exec' })
-            .inc();
     }
 }
 exports.RedisCache = RedisCache;

package/metrics/index.d.ts

@@ -11,5 +11,5 @@ export declare const setupMetrics: (name: string, config: AdapterConfig) => void
  * @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 httpRequestsTotal: client.Counter<"type" | "method" | "status_code" | "retry" | "is_cache_warming" | "feed_id" | "provider_status_code">;
 export declare const httpRequestDurationSeconds: client.Histogram<string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chainlink/external-adapter-framework",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "main": "dist/index.js",
   "license": "MIT",
   "dependencies": {
@@ -44,7 +44,7 @@
     "nock": "^13.2.4",
     "pino-pretty": "^7.6.0",
     "prettier": "^2.6.1",
-    "ts-node-dev": "2.0.0",
+    "ts-node-dev": "^2.0.0",
     "typedoc": "^0.22.15"
   },
   "prettier": {

package/test.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const _1 = require(".");
-const bank_frick_1 = require("./examples/bank-frick");
+const src_1 = require("./examples/coingecko/src");
 // Start sample adapter
-(0, _1.expose)(bank_frick_1.adapter);
+(0, _1.expose)(src_1.adapter);

package/transports/batch-warming.js

@@ -1,35 +1,9 @@
 "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.BatchWarmingTransport = void 0;
 const util_1 = require("../util");
 const _1 = require("./");
 const util_2 = require("./util");
-const rateLimitMetrics = __importStar(require("../rate-limiting/metrics"));
-const cacheMetrics = __importStar(require("../cache/metrics"));
-const WARMUP_BATCH_REQUEST_ID = '9002';
 const logger = (0, util_1.makeLogger)('BatchWarmingTransport');
 /**
  * Transport implementation that takes incoming batches requests and keeps a warm cache of values.
@@ -69,14 +43,12 @@ class BatchWarmingTransport {
             logger.debug('No entries in batch warming set, skipping');
             if (this.WARMER_ACTIVE) {
                 // Decrement count when warmer changed from having entries to having none
-                cacheMetrics.cacheWarmerCount.labels({ isBatched: 'true' }).dec();
                 this.WARMER_ACTIVE = false;
             }
             return this.rateLimiter.msUntilNextExecution(context.adapterEndpoint.name);
         }
         else if (this.WARMER_ACTIVE === false) {
             // Increment count when warmer changed from having no entries to having some
-            cacheMetrics.cacheWarmerCount.labels({ isBatched: 'true' }).inc();
             this.WARMER_ACTIVE = true;
         }
         const request = this.config.prepareRequest(entries, context);
@@ -87,14 +59,6 @@ class BatchWarmingTransport {
         const adapterResponses = (0, _1.buildCacheEntriesFromResults)(results, context);
         logger.debug('Setting adapter responses in cache');
         await this.cache.setMany(adapterResponses, context.adapterConfig.CACHE_MAX_AGE);
-        // Record cost of data provider call
-        const cost = rateLimitMetrics.retrieveCost(providerResponse.data);
-        rateLimitMetrics.rateLimitCreditsSpentTotal
-            .labels({
-            feed_id: 'N/A',
-            participant_id: WARMUP_BATCH_REQUEST_ID,
-        })
-            .inc(cost);
         return this.rateLimiter.msUntilNextExecution(context.adapterEndpoint.name);
     }
 }

package/transports/rest.js

@@ -1,33 +1,9 @@
 "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.RestTransport = void 0;
 const util_1 = require("../util");
 const error_1 = require("../validation/error");
 const util_2 = require("./util");
-const rateLimitMetrics = __importStar(require("../rate-limiting/metrics"));
 const IN_FLIGHT_PREFIX = 'InFlight';
 const logger = (0, util_1.makeLogger)('RestTransport');
 /**
@@ -114,14 +90,6 @@ class RestTransport {
         }
         logger.debug('Setting provider response in cache');
         await this.cache.set(req.requestContext.cacheKey, parsedResponse, config.CACHE_MAX_AGE);
-        // Record cost of data provider call
-        const cost = rateLimitMetrics.retrieveCost(providerResponse.data);
-        rateLimitMetrics.rateLimitCreditsSpentTotal
-            .labels({
-            feed_id: req.requestContext.meta?.metrics?.feedId || 'N/A',
-            participant_id: req.requestContext.cacheKey,
-        })
-            .inc(cost);
         // Update cacheHit flag in request meta for metrics use
         req.requestContext.meta = {
             ...req.requestContext.meta,

package/transports/util.js

@@ -1,27 +1,4 @@
 "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 };
 };
@@ -29,7 +6,6 @@ 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
  *
@@ -37,7 +13,6 @@ const transportMetrics = __importStar(require("./metrics"));
  * @returns axios response for the request
  */
 async function axiosRequest(request, config) {
-    const responseTimer = transportMetrics.dataProviderRequestDurationSeconds.startTimer();
     let providerResponse;
     try {
         request.timeout = config.API_TIMEOUT;
@@ -62,9 +37,6 @@ async function axiosRequest(request, config) {
             providerStatusCode = 0; // 0 -> connection error
         }
         // Record count of failed data provider request
-        transportMetrics.dataProviderRequests
-            .labels(transportMetrics.dataProviderMetricsLabel(providerStatusCode, request.method))
-            .inc();
         adapterError.statusCode = 200;
         adapterError.providerStatusCode = providerStatusCode;
         adapterError.message = error?.message;
@@ -75,12 +47,7 @@ async function axiosRequest(request, config) {
     }
     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/transports/websocket.js

@@ -1,27 +1,4 @@
 "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 };
 };
@@ -30,7 +7,6 @@ exports.WebSocketTransport = exports.WebSocketClassProvider = void 0;
 const ws_1 = __importDefault(require("ws"));
 const util_1 = require("../util");
 const _1 = require("./");
-const transportMetrics = __importStar(require("./metrics"));
 const logger = (0, util_1.makeLogger)('WebSocketTransport');
 class WebSocketClassProvider {
     static set(ctor) {
@@ -87,7 +63,6 @@ class WebSocketTransport {
                 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.inc();
                 resolve(true);
             });
             this.wsConnection.addEventListener('message', async (event) => {
@@ -103,15 +78,11 @@ class WebSocketTransport {
             });
             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.dec();
             });
         });
     }
@@ -155,8 +126,6 @@ class WebSocketTransport {
             logger.trace(`Sending message: ${JSON.stringify(message)}`);
             this.wsConnection.send(message);
         }
-        // Record WS message and subscription metrics
-        transportMetrics.recordWsMessageMetrics(context, subscribeParams, unsubscribeParams);
         logger.debug('Setting local state to cache value');
         this.localSubscriptions = desiredSubs;
         logger.debug('Background execute complete');