@chainlink/external-adapter-framework 1.3.1 → 1.3.2

package/generator-adapter/generators/app/templates/src/transport/custombg.ts.ejs

@@ -2,11 +2,14 @@ import { TransportDependencies } from '@chainlink/external-adapter-framework/tra
 import { ResponseCache } from '@chainlink/external-adapter-framework/cache/response'
 import { Requester } from '@chainlink/external-adapter-framework/util/requester'
 import {
-  AdapterResponse, sleep
+  AdapterResponse, sleep, makeLogger
 } from '@chainlink/external-adapter-framework/util'
 import { SubscriptionTransport } from '@chainlink/external-adapter-framework/transports/abstract/subscription'
 import { EndpointContext } from '@chainlink/external-adapter-framework/adapter'
 import { BaseEndpointTypes, inputParameters } from '../endpoint/<%= inputEndpointName %>'
+import { AdapterError } from '@chainlink/external-adapter-framework/validation/error'
+
+const logger = makeLogger('CustomTransport')
 
 type RequestParams = typeof inputParameters.validated
 
@@ -63,8 +66,9 @@ export class CustomTransport extends SubscriptionTransport<CustomTransportTypes>
       response = await this._handleRequest(param)
     } catch (e) {
       const errorMessage = e instanceof Error ? e.message : 'Unknown error occurred'
+      logger.error(e, errorMessage)
       response = {
-        statusCode: 502,
+        statusCode: (e as AdapterError)?.statusCode || 502,
         errorMessage,
         timestamps: {
           providerDataRequestedUnixMs: 0,

package/generator-adapter/generators/app/templates/src/transport/customfg.ts.ejs

@@ -51,7 +51,7 @@ export class CustomTransport implements Transport<CustomTransportTypes> {
   // request, process it,save it in the cache and return to user.
 <% } -%>
   async foregroundExecute(
-    req: AdapterRequest<typeof inputParameters.validated>
+    _: AdapterRequest<typeof inputParameters.validated>
   ): Promise<AdapterResponse<CustomTransportTypes['Response']>> {
 
     // Custom transport logic
@@ -68,16 +68,6 @@ export class CustomTransport implements Transport<CustomTransportTypes> {
         providerIndicatedTimeUnixMs: undefined,
       },
     }
-<% if (includeComments) { -%>
-    // Once the response object is ready, write it to the cache. Use the transport name, request payload and constructed response. Once cache is
-    // saved, return the response to the user.
-<% } -%>
-    await this.responseCache.write(this.name, [
-      {
-        params: req.requestContext.data,
-        response,
-      },
-    ])
 
     return response
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chainlink/external-adapter-framework",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "main": "dist/index.js",
   "license": "MIT",
   "dependencies": {

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

@@ -16,6 +16,7 @@ export declare class SubscriptionSetFactory {
     private redisClient?;
     private adapterName?;
     private capacity;
+    private cachePrefix;
     constructor(adapterSettings: AdapterSettings, adapterName: string, redisClient?: Redis);
     buildSet<T>(endpointName: string, transportName: string): SubscriptionSet<T>;
 }

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

@@ -9,6 +9,7 @@ class SubscriptionSetFactory {
         this.redisClient = redisClient;
         this.adapterName = adapterName;
         this.capacity = adapterSettings.SUBSCRIPTION_SET_MAX_ITEMS;
+        this.cachePrefix = adapterSettings.CACHE_PREFIX;
     }
     buildSet(endpointName, transportName) {
         switch (this.cacheType) {
@@ -19,7 +20,8 @@ class SubscriptionSetFactory {
                     throw new Error('Redis client undefined. Cannot create Redis subscription set');
                 }
                 // Identifier key used for the subscription set in redis
-                const subscriptionSetKey = `${this.adapterName}-${endpointName}-${transportName}-subscriptionSet`;
+                const cachePrefix = this.cachePrefix ? `${this.cachePrefix}-` : '';
+                const subscriptionSetKey = `${cachePrefix}${this.adapterName}-${endpointName}-${transportName}-subscriptionSet`;
                 return new redis_sorted_set_1.RedisSubscriptionSet(this.redisClient, subscriptionSetKey);
             }
         }

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

@@ -1 +1 @@
-{"version":3,"file":"subscription-set.js","sourceRoot":"","sources":["../../../../src/util/subscription-set/subscription-set.ts"],"names":[],"mappings":";;;AAGA,+DAAyD;AACzD,yDAAyD;AAezD,MAAa,sBAAsB;IAMjC,YAAY,eAAgC,EAAE,WAAmB,EAAE,WAAmB;QACpF,IAAI,CAAC,SAAS,GAAG,eAAe,CAAC,UAAU,CAAA;QAC3C,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,QAAQ,GAAG,eAAe,CAAC,0BAA0B,CAAA;IAC5D,CAAC;IAED,QAAQ,CAAI,YAAoB,EAAE,aAAqB;QACrD,QAAQ,IAAI,CAAC,SAAS,EAAE;YACtB,KAAK,OAAO;gBACV,OAAO,IAAI,uCAAiB,CAAI,IAAI,CAAC,QAAQ,CAAC,CAAA;YAChD,KAAK,OAAO,CAAC,CAAC;gBACZ,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;oBACrB,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAA;iBAChF;gBACD,wDAAwD;gBACxD,MAAM,kBAAkB,GAAG,GAAG,IAAI,CAAC,WAAW,IAAI,YAAY,IAAI,aAAa,kBAAkB,CAAA;gBACjG,OAAO,IAAI,uCAAoB,CAAI,IAAI,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAA;aACzE;SACF;IACH,CAAC;CACF;AA3BD,wDA2BC"}
+{"version":3,"file":"subscription-set.js","sourceRoot":"","sources":["../../../../src/util/subscription-set/subscription-set.ts"],"names":[],"mappings":";;;AAGA,+DAAyD;AACzD,yDAAyD;AAezD,MAAa,sBAAsB;IAOjC,YAAY,eAAgC,EAAE,WAAmB,EAAE,WAAmB;QACpF,IAAI,CAAC,SAAS,GAAG,eAAe,CAAC,UAAU,CAAA;QAC3C,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,QAAQ,GAAG,eAAe,CAAC,0BAA0B,CAAA;QAC1D,IAAI,CAAC,WAAW,GAAG,eAAe,CAAC,YAAY,CAAA;IACjD,CAAC;IAED,QAAQ,CAAI,YAAoB,EAAE,aAAqB;QACrD,QAAQ,IAAI,CAAC,SAAS,EAAE;YACtB,KAAK,OAAO;gBACV,OAAO,IAAI,uCAAiB,CAAI,IAAI,CAAC,QAAQ,CAAC,CAAA;YAChD,KAAK,OAAO,CAAC,CAAC;gBACZ,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;oBACrB,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAA;iBAChF;gBACD,wDAAwD;gBACxD,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;gBAClE,MAAM,kBAAkB,GAAG,GAAG,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,YAAY,IAAI,aAAa,kBAAkB,CAAA;gBAC/G,OAAO,IAAI,uCAAoB,CAAI,IAAI,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAA;aACzE;SACF;IACH,CAAC;CACF;AA9BD,wDA8BC"}