@chainlink/external-adapter-framework 0.5.0 → 0.5.1

package/transports/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/transports/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AACA,oCAAgF;AAUhF,kDAA+B;AAC/B,yCAAsB;AACtB,wCAAqB;AACrB,8CAA2B;AAgH3B;;;;;;GAMG;AACI,MAAM,4BAA4B,GAAG,CAC1C,OAA4B,EAC5B,OAA0B,EACoB,EAAE,CAChD,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;IAChB,MAAM,UAAU,GAAG;QACjB,GAAG,EAAE,IAAA,yBAAiB,EAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;QACzC,KAAK,EAAE;YACL,MAAM,EAAE,CAAC,CAAC,KAAK;YACf,UAAU,EAAE,GAAG;YACf,IAAI,EAAE;gBACJ,MAAM,EAAE,CAAC,CAAC,KAAK;aAChB;SACF;KACF,CAAA;IAED,IACE,OAAO,CAAC,aAAa,CAAC,eAAe;QACrC,OAAO,CAAC,aAAa,CAAC,4BAA4B,EAClD;QACA,MAAM,OAAO,GAAG;YACd,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC,aAAa;YACxD,IAAI,EAAE;gBACJ,OAAO,EAAE;oBACP,MAAM,EAAE,IAAA,uBAAe,EAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;iBAC3C;aACF;SACF,CAAA;QACD,UAAU,CAAC,KAAK,GAAG,EAAE,GAAG,UAAU,CAAC,KAAK,EAAE,GAAG,OAAO,EAAE,CAAA;KACvD;IACD,OAAO,UAAU,CAAA;AACnB,CAAC,CAAC,CAAA;AA/BS,QAAA,4BAA4B,gCA+BrC"}

package/transports/inference-test.js

@@ -0,0 +1,202 @@
+"use strict";
+// Type BaseType = {
+//   asd: number
+// }
+// class WithNormalGeneric<T extends BaseType> {
+//   fn: (param: T) => void
+//   constructor(config: { fn: (param: T) => void }) {
+//     this.fn = config.fn
+//   }
+// }
+// type ComplexGeneric = {
+//   Subtype: unknown
+// }
+// class WithComplexGeneric<T extends ComplexGeneric> {
+//   fn: (param: T['Subtype']) => void
+//   constructor(config: { fn: (param: T['Subtype']) => void }) {
+//     this.fn = config.fn
+//   }
+// }
+// // Union-aware keyof operator
+// //    keyof ({ a: number} | { b: number}) => never
+// //    KeysOf<{a: number} | {b: number}>   => "a" | "b"
+// // this exists to allow users to override faulty type-provider logic.
+// // type KeysOf<T> = T extends any ? keyof T : never
+// // class WithComplexGeneric2<T extends Partial<ComplexGeneric>, TT = {
+// //   [K in KeysOf<T | >]
+// // }>
+// class WithComplexGeneric3<
+//   SubtypeParam extends BaseType,
+//   T extends ComplexGeneric = {
+//     Subtype: SubtypeParam
+//   },
+// > {
+//   fn: (param: T['Subtype']) => void
+//   constructor(config: { fn: (param: T['Subtype']) => void }) {
+//     this.fn = config.fn
+//   }
+// }
+// // Test inference
+// const instance1 = new WithNormalGeneric({
+//   fn: (_: BaseType) => {
+//     return
+//   },
+// })
+// // Test 2
+// const instance2 = new WithComplexGeneric({
+//   fn: (_: BaseType) => {
+//     return
+//   },
+// })
+// // Test 3
+// class WithComplexGeneric3<
+//   SubtypeParam extends BaseType,
+//   T extends ComplexGeneric = {
+//     Subtype: SubtypeParam
+//   },
+// > {
+//   fn: (param: T['Subtype']) => void
+//   constructor(config: { fn: (param: T['Subtype']) => void }) {
+//     this.fn = config.fn
+//   }
+// }
+// const instance2 = new WithComplexGeneric3({
+//   fn: (_: { asd: number; qwe: number }) => {
+//     return
+//   },
+// })
+// // Test 4
+// class WithComplexGeneric4<T extends ComplexGeneric = ComplexGeneric> {
+//   fn: (param: T['Subtype']) => void
+//   constructor(config: { fn: (param: T['Subtype']) => void }) {
+//     this.fn = config.fn
+//   }
+// }
+// const instance2 = new WithComplexGeneric4({
+//   fn: (_: { asd: number; qwe: number }) => {
+//     return
+//   },
+// })
+// // Test 5
+// type ExtensibleType<T> = {
+//   [K in keyof T | string]: K extends keyof T ? T[K] : unknown
+// }
+// type ExtensibleComplexGeneric = {
+//   SubType: ExtensibleType<BaseType>
+// }
+// class WithComplexGeneric5<T extends ExtensibleComplexGeneric> {
+//   fn: (param: T['SubType']) => void
+//   constructor(config: { fn: (param: T['SubType']) => void }) {
+//     this.fn = config.fn
+//   }
+// }
+// const instance2 = new WithComplexGeneric5({
+//   fn: (_: { asd: number; qwe: number }) => {
+//     return
+//   },
+// })
+// // Test 6
+// class WithComplexGeneric6<T extends ComplexGeneric> {
+//   fn: (param: T['Subtype']) => void
+//   constructor(config: { fn: (param: T['Subtype']) => void }) {
+//     this.fn = config.fn
+//   }
+// }
+// const instance6 = new WithComplexGeneric6<{
+//   Subtype: BaseType
+// }>({
+//   fn: (_: BaseType) => {
+//     return
+//   },
+// })
+// const instance6_1 = new WithComplexGeneric6({
+//   fn: (_: BaseType) => {
+//     return
+//   },
+// })
+// // Test 7
+// // type SubtypeForGeneric<T> = T extends ComplexGeneric<>
+// type ComplexGeneric2 = {
+//   Subtype: any
+// }
+// class WithComplexGeneric7<T extends ComplexGeneric2> {
+//   fn: (param: T['Subtype']) => void
+//   constructor(config: { fn: (param: T['Subtype']) => void, fn2: (param: T['Subtype']) => void }) {
+//     this.fn = config.fn
+//   }
+// }
+// const instance7 = new WithComplexGeneric7({
+//   fn: (_: BaseType) => {
+//     return
+//   },
+//   fn2: (_: { asd: number }) => {
+//     return
+//   },
+// })
+// //
+// //
+// // //
+// //
+// // //
+// //
+// // //
+// //
+// // //
+// //
+// // //
+// //
+// // //
+// //
+// // //
+// //
+// // //
+// //
+// // //
+// //
+// // //
+// //
+// // //
+// //
+// //
+// type Head<T> = T extends [infer I, ...infer _Rest] ? I : never
+// type Tail<T> = T extends [infer _I, ...infer Rest] ? Rest : never
+// type Zip_DeepMergeTwoTypes<T, U> = T extends []
+//   ? U
+//   : U extends []
+//   ? T
+//   : [DeepMergeTwoTypes<Head<T>, Head<U>>, ...Zip_DeepMergeTwoTypes<Tail<T>, Tail<U>>]
+// /**
+//  * Take two objects T and U and create the new one with uniq keys for T a U objectI
+//  * helper generic for `DeepMergeTwoTypes`
+//  */
+// type GetObjDifferentKeys<
+//   T,
+//   U,
+//   T0 = Omit<T, keyof U> & Omit<U, keyof T>,
+//   T1 = { [K in keyof T0]: T0[K] },
+// > = T1
+// /**
+//  * Take two objects T and U and create the new one with the same objects keys
+//  * helper generic for `DeepMergeTwoTypes`
+//  */
+// type GetObjSameKeys<T, U> = Omit<T | U, keyof GetObjDifferentKeys<T, U>>
+// type MergeTwoObjects<
+//   T,
+//   U,
+//   // Non shared keys are optional
+//   T0 = Partial<GetObjDifferentKeys<T, U>> & {
+//     // Shared keys are recursively resolved by `DeepMergeTwoTypes<...>`
+//     [K in keyof GetObjSameKeys<T, U>]: DeepMergeTwoTypes<T[K], U[K]>
+//   },
+//   T1 = { [K in keyof T0]: T0[K] },
+// > = T1
+// // It merge 2 static types and try to avoid of unnecessary options (`'`)
+// export type DeepMergeTwoTypes<T, U> =
+//   // ----- 2 added lines ------
+//   [T, U] extends [any[], any[]]
+//     ? Zip_DeepMergeTwoTypes<T, U>
+//     : // Check if generic types are objects
+//     [T, U] extends [{ [key: string]: unknown }, { [key: string]: unknown }]
+//     ? MergeTwoObjects<T, U>
+//     : T | U
+//# sourceMappingURL=inference-test.js.map

package/transports/inference-test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inference-test.js","sourceRoot":"","sources":["../../../src/transports/inference-test.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,gBAAgB;AAChB,IAAI;AAEJ,gDAAgD;AAChD,2BAA2B;AAE3B,sDAAsD;AACtD,0BAA0B;AAC1B,MAAM;AACN,IAAI;AAEJ,0BAA0B;AAC1B,qBAAqB;AACrB,IAAI;AAEJ,uDAAuD;AACvD,sCAAsC;AAEtC,iEAAiE;AACjE,0BAA0B;AAC1B,MAAM;AACN,IAAI;AAEJ,gCAAgC;AAChC,qDAAqD;AACrD,yDAAyD;AACzD,wEAAwE;AACxE,sDAAsD;AAEtD,yEAAyE;AACzE,2BAA2B;AAC3B,QAAQ;AAER,6BAA6B;AAC7B,mCAAmC;AACnC,iCAAiC;AACjC,4BAA4B;AAC5B,OAAO;AACP,MAAM;AACN,sCAAsC;AAEtC,iEAAiE;AACjE,0BAA0B;AAC1B,MAAM;AACN,IAAI;AAEJ,oBAAoB;AACpB,4CAA4C;AAC5C,2BAA2B;AAC3B,aAAa;AACb,OAAO;AACP,KAAK;AAEL,YAAY;AAEZ,6CAA6C;AAC7C,2BAA2B;AAC3B,aAAa;AACb,OAAO;AACP,KAAK;AAEL,YAAY;AAEZ,6BAA6B;AAC7B,mCAAmC;AACnC,iCAAiC;AACjC,4BAA4B;AAC5B,OAAO;AACP,MAAM;AACN,sCAAsC;AAEtC,iEAAiE;AACjE,0BAA0B;AAC1B,MAAM;AACN,IAAI;AAEJ,8CAA8C;AAC9C,+CAA+C;AAC/C,aAAa;AACb,OAAO;AACP,KAAK;AAEL,YAAY;AAEZ,yEAAyE;AACzE,sCAAsC;AAEtC,iEAAiE;AACjE,0BAA0B;AAC1B,MAAM;AACN,IAAI;AAEJ,8CAA8C;AAC9C,+CAA+C;AAC/C,aAAa;AACb,OAAO;AACP,KAAK;AAEL,YAAY;AAEZ,6BAA6B;AAC7B,gEAAgE;AAChE,IAAI;AAEJ,oCAAoC;AACpC,sCAAsC;AACtC,IAAI;AAEJ,kEAAkE;AAClE,sCAAsC;AAEtC,iEAAiE;AACjE,0BAA0B;AAC1B,MAAM;AACN,IAAI;AAEJ,8CAA8C;AAC9C,+CAA+C;AAC/C,aAAa;AACb,OAAO;AACP,KAAK;AAEL,YAAY;AAEZ,wDAAwD;AACxD,sCAAsC;AAEtC,iEAAiE;AACjE,0BAA0B;AAC1B,MAAM;AACN,IAAI;AAEJ,8CAA8C;AAC9C,sBAAsB;AACtB,OAAO;AACP,2BAA2B;AAC3B,aAAa;AACb,OAAO;AACP,KAAK;AAEL,gDAAgD;AAChD,2BAA2B;AAC3B,aAAa;AACb,OAAO;AACP,KAAK;AAEL,YAAY;AAEZ,4DAA4D;AAE5D,2BAA2B;AAC3B,iBAAiB;AACjB,IAAI;AAEJ,yDAAyD;AACzD,sCAAsC;AAEtC,qGAAqG;AACrG,0BAA0B;AAC1B,MAAM;AACN,IAAI;AAEJ,8CAA8C;AAC9C,2BAA2B;AAC3B,aAAa;AACb,OAAO;AACP,mCAAmC;AACnC,aAAa;AACb,OAAO;AACP,KAAK;AAEL,KAAK;AACL,KAAK;AACL,QAAQ;AACR,KAAK;AACL,QAAQ;AACR,KAAK;AACL,QAAQ;AACR,KAAK;AACL,QAAQ;AACR,KAAK;AACL,QAAQ;AACR,KAAK;AACL,QAAQ;AACR,KAAK;AACL,QAAQ;AACR,KAAK;AACL,QAAQ;AACR,KAAK;AACL,QAAQ;AACR,KAAK;AACL,QAAQ;AACR,KAAK;AACL,QAAQ;AACR,KAAK;AACL,KAAK;AAEL,iEAAiE;AACjE,oEAAoE;AAEpE,kDAAkD;AAClD,QAAQ;AACR,mBAAmB;AACnB,QAAQ;AACR,wFAAwF;AAExF,MAAM;AACN,sFAAsF;AACtF,4CAA4C;AAC5C,MAAM;AACN,4BAA4B;AAC5B,OAAO;AACP,OAAO;AACP,8CAA8C;AAC9C,qCAAqC;AACrC,SAAS;AACT,MAAM;AACN,gFAAgF;AAChF,4CAA4C;AAC5C,MAAM;AACN,2EAA2E;AAE3E,wBAAwB;AACxB,OAAO;AACP,OAAO;AACP,oCAAoC;AACpC,gDAAgD;AAChD,0EAA0E;AAC1E,uEAAuE;AACvE,OAAO;AACP,qCAAqC;AACrC,SAAS;AAET,2EAA2E;AAC3E,wCAAwC;AACxC,kCAAkC;AAClC,kCAAkC;AAClC,oCAAoC;AACpC,8CAA8C;AAC9C,8EAA8E;AAC9E,8BAA8B;AAC9B,cAAc"}

package/transports/metrics.d.ts

@@ -0,0 +1,25 @@
+import * as client from 'prom-client';
+import { TransportGenerics } from '.';
+import { AdapterContext } from '../adapter';
+export declare const dataProviderMetricsLabel: (providerStatusCode?: number, method?: string) => {
+    provider_status_code: number | undefined;
+    method: string;
+};
+export declare const dataProviderRequests: client.Counter<"method" | "provider_status_code">;
+export declare const dataProviderRequestDurationSeconds: client.Histogram<string>;
+export declare const connectionErrorLabels: (message: string) => {
+    message: string;
+};
+export declare const messageSubsLabels: (feed_id: string, cache_key: string) => {
+    feed_id: string;
+    subscription_key: string;
+};
+export declare const recordWsMessageMetrics: <T extends TransportGenerics>(context: AdapterContext<T>, subscribes: T["Request"]["Params"][], unsubscribes: T["Request"]["Params"][]) => void;
+export declare const wsConnectionActive: client.Gauge<"url">;
+export declare const wsConnectionErrors: client.Counter<"message" | "url">;
+export declare const wsSubscriptionActive: client.Gauge<"feed_id" | "connection_url" | "subscription_key">;
+export declare const wsSubscriptionTotal: client.Counter<"feed_id" | "connection_url" | "subscription_key">;
+export declare const wsMessageTotal: client.Counter<"feed_id" | "subscription_key">;
+export declare const bgExecuteSubscriptionSetCount: client.Gauge<"endpoint" | "transport_type">;
+export declare const transportPollingFailureCount: client.Counter<"endpoint">;
+export declare const transportPollingDurationSeconds: client.Gauge<"succeeded" | "endpoint">;

package/transports/metrics.js

@@ -0,0 +1,122 @@
+"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.transportPollingDurationSeconds = exports.transportPollingFailureCount = exports.bgExecuteSubscriptionSetCount = exports.wsMessageTotal = exports.wsSubscriptionTotal = exports.wsSubscriptionActive = exports.wsConnectionErrors = exports.wsConnectionActive = exports.recordWsMessageMetrics = exports.messageSubsLabels = exports.connectionErrorLabels = exports.dataProviderRequestDurationSeconds = exports.dataProviderRequests = exports.dataProviderMetricsLabel = void 0;
+const client = __importStar(require("prom-client"));
+const cache_1 = require("../cache");
+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 connectionErrorLabels = (message) => ({
+    // Key,
+    message,
+});
+exports.connectionErrorLabels = connectionErrorLabels;
+const messageSubsLabels = (feed_id, cache_key) => ({
+    feed_id,
+    subscription_key: cache_key,
+});
+exports.messageSubsLabels = messageSubsLabels;
+// Record WS message and subscription metrics
+// Recalculate cacheKey and feedId for metrics
+// since avoiding storing extra info in expiring sorted set
+const recordWsMessageMetrics = (context, subscribes, unsubscribes) => {
+    subscribes.forEach((param) => {
+        const feedId = (0, cache_1.calculateFeedId)(context, param);
+        const cacheKey = (0, cache_1.calculateCacheKey)(context, param);
+        // Record total number of ws messages sent
+        exports.wsMessageTotal.labels((0, exports.messageSubsLabels)(feedId, cacheKey)).inc();
+        // Record total number of subscriptions made
+        exports.wsSubscriptionTotal.labels((0, exports.messageSubsLabels)(feedId, cacheKey)).inc();
+        // Record number of active ws subscriptions
+        exports.wsSubscriptionActive.labels((0, exports.messageSubsLabels)(feedId, cacheKey)).inc();
+    });
+    unsubscribes.forEach((param) => {
+        const feedId = (0, cache_1.calculateFeedId)(context, param);
+        const cacheKey = (0, cache_1.calculateCacheKey)(context, param);
+        // Record total number of ws messages sent
+        exports.wsMessageTotal.labels((0, exports.messageSubsLabels)(feedId, cacheKey)).inc();
+        // Record number of active ws subscriptions
+        exports.wsSubscriptionActive.labels((0, exports.messageSubsLabels)(feedId, cacheKey)).dec();
+    });
+};
+exports.recordWsMessageMetrics = recordWsMessageMetrics;
+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'],
+});
+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.wsMessageTotal = new client.Counter({
+    name: 'ws_message_total',
+    help: 'The number of messages received in total',
+    labelNames: ['feed_id', 'subscription_key'],
+});
+// V3 specific metrics
+exports.bgExecuteSubscriptionSetCount = new client.Gauge({
+    name: 'bg_execute_subscription_set_count',
+    help: 'The number of active subscriptions in background execute',
+    labelNames: ['endpoint', 'transport_type'],
+});
+exports.transportPollingFailureCount = new client.Counter({
+    name: 'transport_polling_failure_count',
+    help: 'The number of times the polling mechanism ran out of attempts and failed to return a response',
+    labelNames: ['endpoint'],
+});
+exports.transportPollingDurationSeconds = new client.Gauge({
+    name: 'transport_polling_duration_seconds',
+    help: 'A histogram bucket of the distribution of transport polling idle time durations',
+    labelNames: ['endpoint', 'succeeded'],
+});
+//# sourceMappingURL=metrics.js.map

package/transports/metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../../src/transports/metrics.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAqC;AAGrC,oCAA6D;AAC7D,oDAA6D;AAE7D,wBAAwB;AACjB,MAAM,wBAAwB,GAAG,CAAC,kBAA2B,EAAE,MAAM,GAAG,KAAK,EAAE,EAAE,CAAC,CAAC;IACxF,oBAAoB,EAAE,kBAAkB;IACxC,MAAM,EAAE,MAAM,CAAC,WAAW,EAAE;CAC7B,CAAC,CAAA;AAHW,QAAA,wBAAwB,4BAGnC;AAEW,QAAA,oBAAoB,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IACrD,IAAI,EAAE,wBAAwB;IAC9B,IAAI,EAAE,8DAA8D;IACpE,UAAU,EAAE,CAAC,QAAQ,EAAE,sBAAsB,CAAU;CACxD,CAAC,CAAA;AAEW,QAAA,kCAAkC,GAAG,IAAI,MAAM,CAAC,SAAS,CAAC;IACrE,IAAI,EAAE,wCAAwC;IAC9C,IAAI,EAAE,2EAA2E;IACjF,OAAO,EAAE,kCAAsB;CAChC,CAAC,CAAA;AAEF,oBAAoB;AACb,MAAM,qBAAqB,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,CAAC;IACzD,OAAO;IACP,OAAO;CACR,CAAC,CAAA;AAHW,QAAA,qBAAqB,yBAGhC;AAEK,MAAM,iBAAiB,GAAG,CAAC,OAAe,EAAE,SAAiB,EAAE,EAAE,CAAC,CAAC;IACxE,OAAO;IACP,gBAAgB,EAAE,SAAS;CAC5B,CAAC,CAAA;AAHW,QAAA,iBAAiB,qBAG5B;AAEF,6CAA6C;AAC7C,8CAA8C;AAC9C,2DAA2D;AACpD,MAAM,sBAAsB,GAAG,CACpC,OAA0B,EAC1B,UAAoC,EACpC,YAAsC,EAChC,EAAE;IACR,UAAU,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC3B,MAAM,MAAM,GAAG,IAAA,uBAAe,EAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAC9C,MAAM,QAAQ,GAAG,IAAA,yBAAiB,EAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAClD,0CAA0C;QAC1C,sBAAc,CAAC,MAAM,CAAC,IAAA,yBAAiB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;QAEhE,4CAA4C;QAC5C,2BAAmB,CAAC,MAAM,CAAC,IAAA,yBAAiB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;QAErE,2CAA2C;QAC3C,4BAAoB,CAAC,MAAM,CAAC,IAAA,yBAAiB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;IACxE,CAAC,CAAC,CAAA;IACF,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC7B,MAAM,MAAM,GAAG,IAAA,uBAAe,EAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAC9C,MAAM,QAAQ,GAAG,IAAA,yBAAiB,EAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAElD,0CAA0C;QAC1C,sBAAc,CAAC,MAAM,CAAC,IAAA,yBAAiB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;QAEhE,2CAA2C;QAC3C,4BAAoB,CAAC,MAAM,CAAC,IAAA,yBAAiB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;IACxE,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AA3BY,QAAA,sBAAsB,0BA2BlC;AAEY,QAAA,kBAAkB,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC;IACjD,IAAI,EAAE,sBAAsB;IAC5B,IAAI,EAAE,kCAAkC;IACxC,UAAU,EAAE,CAAC,KAAK,CAAU;CAC7B,CAAC,CAAA;AAEW,QAAA,kBAAkB,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IACnD,IAAI,EAAE,sBAAsB;IAC5B,IAAI,EAAE,iCAAiC;IACvC,UAAU,EAAE,CAAC,KAAK,EAAE,SAAS,CAAU;CACxC,CAAC,CAAA;AAEW,QAAA,oBAAoB,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC;IACnD,IAAI,EAAE,wBAAwB;IAC9B,IAAI,EAAE,8CAA8C;IACpD,UAAU,EAAE,CAAC,gBAAgB,EAAE,SAAS,EAAE,kBAAkB,CAAU;CACvE,CAAC,CAAA;AAEW,QAAA,mBAAmB,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IACpD,IAAI,EAAE,uBAAuB;IAC7B,IAAI,EAAE,6CAA6C;IACnD,UAAU,EAAE,CAAC,gBAAgB,EAAE,SAAS,EAAE,kBAAkB,CAAU;CACvE,CAAC,CAAA;AAEW,QAAA,cAAc,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IAC/C,IAAI,EAAE,kBAAkB;IACxB,IAAI,EAAE,0CAA0C;IAChD,UAAU,EAAE,CAAC,SAAS,EAAE,kBAAkB,CAAU;CACrD,CAAC,CAAA;AAEF,sBAAsB;AACT,QAAA,6BAA6B,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC;IAC5D,IAAI,EAAE,mCAAmC;IACzC,IAAI,EAAE,0DAA0D;IAChE,UAAU,EAAE,CAAC,UAAU,EAAE,gBAAgB,CAAU;CACpD,CAAC,CAAA;AAEW,QAAA,4BAA4B,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC;IAC7D,IAAI,EAAE,iCAAiC;IACvC,IAAI,EAAE,+FAA+F;IACrG,UAAU,EAAE,CAAC,UAAU,CAAU;CAClC,CAAC,CAAA;AAEW,QAAA,+BAA+B,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC;IAC9D,IAAI,EAAE,oCAAoC;IAC1C,IAAI,EAAE,iFAAiF;IACvF,UAAU,EAAE,CAAC,UAAU,EAAE,WAAW,CAAU;CAC/C,CAAC,CAAA"}

package/transports/rest.d.ts

@@ -0,0 +1,68 @@
+import { AdapterRequest, AdapterResponse } from '../util/request';
+import { Transport, TransportGenerics } from './';
+import { Cache } from '../cache';
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { AdapterConfig } from '../config';
+import { RequestRateLimiter } from '../rate-limiting';
+import { AdapterDependencies } from '../adapter';
+export { AxiosRequestConfig as HttpRequestConfig, AxiosResponse as HttpResponse };
+/**
+ * Helper struct type that will be used to pass types to the generic parameters of a Transport.
+ * Extends the common TransportGenerics, adding Provider specific types for this Batch endpoint.
+ */
+declare type RestTransportGenerics = TransportGenerics & {
+    /**
+     * Type details for any provider specific interfaces.
+     */
+    Provider: {
+        /**
+         * Structure of the body of the request that will be sent to the data provider.
+         */
+        RequestBody: unknown;
+        /**
+         * Structure for the body of the response coming from the data provider.
+         */
+        ResponseBody: unknown;
+    };
+};
+/**
+ * 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 T - Helper struct type that will be used to pass types to the generic parameters (check [[RestTransportGenerics]])
+ */
+export declare class RestTransport<T extends RestTransportGenerics> implements Transport<T> {
+    protected config: {
+        prepareRequest: (req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>) => AxiosRequestConfig<T['Provider']['RequestBody']> | Promise<AxiosRequestConfig<T['Provider']['RequestBody']>>;
+        parseResponse: (req: AdapterRequest<T['Request']>, res: AxiosResponse<T['Provider']['ResponseBody']>, config: AdapterConfig<T['CustomSettings']>) => AdapterResponse<T['Response']> | Promise<AdapterResponse<T['Response']>>;
+        options: {
+            requestCoalescing: {
+                enabled: boolean;
+                entropyMax?: number;
+            };
+        };
+    };
+    inFlightPrefix: string;
+    cache: Cache<AdapterResponse<T['Response']>>;
+    inFlightCache: Cache<boolean>;
+    rateLimiter: RequestRateLimiter;
+    constructor(config: {
+        prepareRequest: (req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>) => AxiosRequestConfig<T['Provider']['RequestBody']> | Promise<AxiosRequestConfig<T['Provider']['RequestBody']>>;
+        parseResponse: (req: AdapterRequest<T['Request']>, res: AxiosResponse<T['Provider']['ResponseBody']>, config: AdapterConfig<T['CustomSettings']>) => AdapterResponse<T['Response']> | Promise<AdapterResponse<T['Response']>>;
+        options: {
+            requestCoalescing: {
+                enabled: boolean;
+                entropyMax?: number;
+            };
+        };
+    });
+    initialize(dependencies: AdapterDependencies, config: AdapterConfig<T['CustomSettings']>): Promise<void>;
+    protected waitUntilUnderRateLimit(options: {
+        maxRetries: number;
+        msBetweenRetries: number;
+    }, retry?: number): Promise<void>;
+    foregroundExecute(req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>): Promise<AdapterResponse<T['Response']> | undefined>;
+}

package/transports/rest.js

@@ -0,0 +1,131 @@
+"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');
+/**
+ * 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 T - Helper struct type that will be used to pass types to the generic parameters (check [[RestTransportGenerics]])
+ */
+class RestTransport {
+    constructor(config) {
+        this.config = config;
+    }
+    async initialize(dependencies, config) {
+        this.inFlightPrefix = `${IN_FLIGHT_PREFIX}-`;
+        this.cache = dependencies.cache;
+        this.inFlightCache = dependencies.cache;
+        this.rateLimiter = dependencies.requestRateLimiter;
+        // Allow enabling/disabling request coalescing through env var
+        this.config.options.requestCoalescing.enabled = config.REQUEST_COALESCING_ENABLED;
+        this.config.options.requestCoalescing.entropyMax = config.REQUEST_COALESCING_ENTROPY_MAX;
+    }
+    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 foregroundExecute(req, config) {
+        // Add some entropy here because of possible scenario where the key won't be set before multiple
+        // other instances in a burst request try to access the coalescing key.
+        const randomMs = Math.random() * (this.config.options.requestCoalescing.entropyMax || 0);
+        await (0, util_1.sleep)(randomMs);
+        // Check if request is in flight if coalescing is enabled
+        const inFlight = this.config.options.requestCoalescing.enabled &&
+            (await this.cache.get(this.inFlightPrefix + req.requestContext.cacheKey));
+        if (inFlight) {
+            logger.debug('Request is in flight, transport has been set up');
+            return;
+        }
+        else if (this.config.options.requestCoalescing.enabled) {
+            // If it wasn't in flight and coalescing is disabled, register it as in flight
+            const ttl = config.REST_TRANSPORT_MAX_RATE_LIMIT_RETRIES *
+                config.REST_TRANSPORT_MS_BETWEEN_RATE_LIMIT_RETRIES;
+            logger.debug('Setting up rest transport, setting request in flight in cache');
+            await this.inFlightCache.set(this.inFlightPrefix + req.requestContext.cacheKey, true, ttl + 100); // 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, config);
+        logger.debug(`Got response from provider, parsing (raw body: ${providerResponse.data})`);
+        const parsedResponse = await this.config.parseResponse(req, providerResponse, config);
+        if (config.API_VERBOSE) {
+            parsedResponse.data = providerResponse.data;
+        }
+        if (config.METRICS_ENABLED && config.EXPERIMENTAL_METRICS_ENABLED) {
+            parsedResponse.maxAge = Date.now() + config.CACHE_MAX_AGE;
+            parsedResponse.meta = {
+                metrics: { feedId: req.requestContext.meta?.metrics?.feedId || 'N/A' },
+            };
+        }
+        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,
+            metrics: { ...req.requestContext.meta?.metrics, cacheHit: false },
+        };
+        if (this.config.options.requestCoalescing.enabled) {
+            logger.debug('Set provider response in cache, removing in flight from cache');
+            await this.cache.delete(this.inFlightPrefix);
+        }
+        return parsedResponse;
+    }
+}
+exports.RestTransport = RestTransport;
+//# sourceMappingURL=rest.js.map

package/transports/rest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest.js","sourceRoot":"","sources":["../../../src/transports/rest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,kCAA2C;AAG3C,+CAAkD;AAClD,iCAAqC;AACrC,2EAA4D;AAK5D,MAAM,gBAAgB,GAAG,UAAU,CAAA;AAEnC,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,eAAe,CAAC,CAAA;AAuB1C;;;;;;;;GAQG;AACH,MAAa,aAAa;IAMxB,YACY,MAkBT;QAlBS,WAAM,GAAN,MAAM,CAkBf;IACA,CAAC;IAEJ,KAAK,CAAC,UAAU,CACd,YAAiC,EACjC,MAA0C;QAE1C,IAAI,CAAC,cAAc,GAAG,GAAG,gBAAgB,GAAG,CAAA;QAC5C,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAA8C,CAAA;QACxE,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC,KAAuB,CAAA;QACzD,IAAI,CAAC,WAAW,GAAG,YAAY,CAAC,kBAAkB,CAAA;QAElD,8DAA8D;QAC9D,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO,GAAG,MAAM,CAAC,0BAA0B,CAAA;QACjF,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,UAAU,GAAG,MAAM,CAAC,8BAA8B,CAAA;IAC1F,CAAC;IAES,KAAK,CAAC,uBAAuB,CACrC,OAGC,EACD,KAAK,GAAG,CAAC;QAET,IAAI,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,EAAE;YACpC,MAAM,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAA;YACrE,OAAM;SACP;QAED,IAAI,KAAK,IAAI,OAAO,CAAC,UAAU,EAAE;YAC/B,MAAM,IAAI,oBAAY,CAAC;gBACrB,UAAU,EAAE,GAAG;gBACf,OAAO,EAAE,oFAAoF,OAAO,CAAC,UAAU,GAAG;aACnH,CAAC,CAAA;SACH;QAED,MAAM,CAAC,KAAK,CAAC,mDAAmD,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;QAC3F,MAAM,IAAA,YAAK,EAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA;QACrC,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;IACxD,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,GAAiC,EACjC,MAA0C;QAE1C,gGAAgG;QAChG,uEAAuE;QACvE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,UAAU,IAAI,CAAC,CAAC,CAAA;QACxF,MAAM,IAAA,YAAK,EAAC,QAAQ,CAAC,CAAA;QAErB,yDAAyD;QACzD,MAAM,QAAQ,GACZ,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO;YAC7C,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC3E,IAAI,QAAQ,EAAE;YACZ,MAAM,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAA;YAC/D,OAAM;SACP;aAAM,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO,EAAE;YACxD,8EAA8E;YAC9E,MAAM,GAAG,GACP,MAAM,CAAC,qCAAqC;gBAC5C,MAAM,CAAC,4CAA4C,CAAA;YACrD,MAAM,CAAC,KAAK,CAAC,+DAA+D,CAAC,CAAA;YAC7E,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,CAC1B,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,cAAc,CAAC,QAAQ,EACjD,IAAI,EACJ,GAAG,GAAG,GAAG,CACV,CAAA,CAAC,2CAA2C;SAC9C;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;QAE7D,MAAM,CAAC,KAAK,CAAC,sDAAsD,CAAC,CAAA;QACpE,MAAM,IAAI,CAAC,uBAAuB,CAAC;YACjC,UAAU,EAAE,MAAM,CAAC,qCAAqC;YACxD,gBAAgB,EAAE,MAAM,CAAC,4CAA4C;SACtE,CAAC,CAAA;QAEF,MAAM,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAA;QACnD,MAAM,gBAAgB,GAAG,MAAM,IAAA,mBAAY,EAIzC,OAAO,EAAE,MAAM,CAAC,CAAA;QAElB,MAAM,CAAC,KAAK,CAAC,kDAAkD,gBAAgB,CAAC,IAAI,GAAG,CAAC,CAAA;QACxF,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,gBAAgB,EAAE,MAAM,CAAC,CAAA;QAErF,IAAI,MAAM,CAAC,WAAW,EAAE;YACtB,cAAc,CAAC,IAAI,GAAG,gBAAgB,CAAC,IAAI,CAAA;SAC5C;QAED,IAAI,MAAM,CAAC,eAAe,IAAI,MAAM,CAAC,4BAA4B,EAAE;YACjE,cAAc,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,aAAa,CAAA;YACzD,cAAc,CAAC,IAAI,GAAG;gBACpB,OAAO,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK,EAAE;aACvE,CAAA;SACF;QAED,MAAM,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAA;QAClD,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,QAAQ,EAAE,cAAc,EAAE,MAAM,CAAC,aAAa,CAAC,CAAA;QAEvF,oCAAoC;QACpC,MAAM,IAAI,GAAG,gBAAgB,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;QACjE,gBAAgB,CAAC,0BAA0B;aACxC,MAAM,CAAC;YACN,OAAO,EAAE,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK;YAC1D,cAAc,EAAE,GAAG,CAAC,cAAc,CAAC,QAAQ;SAC5C,CAAC;aACD,GAAG,CAAC,IAAI,CAAC,CAAA;QAEZ,uDAAuD;QACvD,GAAG,CAAC,cAAc,CAAC,IAAI,GAAG;YACxB,GAAG,GAAG,CAAC,cAAc,CAAC,IAAI;YAC1B,OAAO,EAAE,EAAE,GAAG,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE;SAClE,CAAA;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO,EAAE;YACjD,MAAM,CAAC,KAAK,CAAC,+DAA+D,CAAC,CAAA;YAC7E,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;SAC7C;QAED,OAAO,cAAc,CAAA;IACvB,CAAC;CACF;AArJD,sCAqJC"}

package/transports/routing.d.ts

@@ -0,0 +1,21 @@
+import { AdapterDependencies } from '../adapter';
+import { AdapterConfig } from '../config';
+import { AdapterRequest, AdapterResponse } from '../util/request';
+import { MetaTransport, Transport, TransportGenerics } from './';
+/**
+ * Transport implementation that takes 2 or more transports and a function that determines with transport to use.
+ *
+ * @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[TransportGenerics]])
+ */
+export declare class RoutingTransport<T extends TransportGenerics> implements MetaTransport<T> {
+    transports: {
+        [key: string]: Transport<T>;
+    };
+    private route;
+    constructor(transports: {
+        [key: string]: Transport<T>;
+    }, route: (req: AdapterRequest<T['Request']>, adapterConfig?: AdapterConfig<T['CustomSettings']>) => string);
+    initialize(dependencies: AdapterDependencies, adapterConfig: AdapterConfig<T['CustomSettings']>, endpointName: string): Promise<void>;
+    private resolveTransport;
+    foregroundExecute(req: AdapterRequest<T['Request']>, adapterConfig: AdapterConfig<T['CustomSettings']>): Promise<AdapterResponse<any> | void>;
+}

package/transports/routing.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RoutingTransport = void 0;
+const util_1 = require("../util");
+const error_1 = require("../validation/error");
+const logger = (0, util_1.makeLogger)('RoutingTransport');
+/**
+ * Transport implementation that takes 2 or more transports and a function that determines with transport to use.
+ *
+ * @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[TransportGenerics]])
+ */
+class RoutingTransport {
+    constructor(
+    //  This is public for tests, which sometimes need the underlying transport for things like ticking the clock
+    transports, 
+    // Route should return to a string key that corresponds to a transport in the transports object
+    route) {
+        this.transports = transports;
+        this.route = route;
+    }
+    async initialize(dependencies, adapterConfig, endpointName) {
+        logger.debug(`Initializing ${Object.keys(this.transports).length} transports`);
+        Object.entries(this.transports).forEach(([k, v]) => {
+            logger.debug(`Initializing transport ${k} (${v.constructor.name})`);
+            v.initialize(dependencies, adapterConfig, endpointName);
+        });
+    }
+    resolveTransport(req, adapterConfig) {
+        logger.debug(`routing request using`, req.params);
+        const key = this.route(req, adapterConfig || undefined);
+        if (!this.transports[key]) {
+            throw new error_1.AdapterError({ statusCode: 400, message: `No transport found for ${key}` });
+        }
+        const transport = this.transports[key];
+        logger.debug(`Found ${transport.constructor.name} corresponding to ${key}`);
+        return transport;
+    }
+    // Allow AdapterResponse<any> below since we don't know what the adapter will return
+    /* eslint-disable  @typescript-eslint/no-explicit-any */
+    async foregroundExecute(req, adapterConfig) {
+        const transport = this.resolveTransport(req, adapterConfig);
+        if (transport.foregroundExecute) {
+            logger.debug(`Running foregroundExecute on retrieved transport`);
+            return transport.foregroundExecute(req, adapterConfig);
+        }
+        logger.debug(`Retrieved transport doesn't implement foregroundExecute`);
+    }
+}
+exports.RoutingTransport = RoutingTransport;
+//# sourceMappingURL=routing.js.map