@chainlink/external-adapter-framework 0.5.4 → 0.5.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/adapter/basic.d.ts +16 -6
- package/adapter/basic.js +34 -7
- package/adapter/basic.js.map +1 -1
- package/adapter/endpoint.d.ts +6 -6
- package/adapter/endpoint.js +1 -0
- package/adapter/endpoint.js.map +1 -1
- package/adapter/price.d.ts +10 -8
- package/adapter/price.js +8 -5
- package/adapter/price.js.map +1 -1
- package/adapter/types.d.ts +20 -13
- package/background-executor.js +19 -4
- package/background-executor.js.map +1 -1
- package/cache/index.d.ts +6 -6
- package/cache/redis.d.ts +0 -3
- package/cache/redis.js +19 -12
- package/cache/redis.js.map +1 -1
- package/config/index.d.ts +14 -1
- package/config/index.js +37 -20
- package/config/index.js.map +1 -1
- package/examples/bank-frick/accounts.d.ts +17 -24
- package/examples/bank-frick/accounts.js +22 -9
- package/examples/bank-frick/accounts.js.map +1 -1
- package/examples/bank-frick/index.d.ts +1 -15
- package/examples/bank-frick/index.js +1 -1
- package/examples/coingecko/src/crypto-utils.d.ts +15 -1
- package/examples/coingecko/src/crypto-utils.js.map +1 -1
- package/examples/coingecko/src/endpoint/coins.d.ts +20 -3
- package/examples/coingecko/src/endpoint/coins.js +2 -2
- package/examples/coingecko/src/endpoint/coins.js.map +1 -1
- package/examples/coingecko/src/endpoint/crypto-marketcap.d.ts +2 -2
- package/examples/coingecko/src/endpoint/crypto-marketcap.js.map +1 -1
- package/examples/coingecko/src/endpoint/crypto-volume.d.ts +2 -2
- package/examples/coingecko/src/endpoint/crypto-volume.js.map +1 -1
- package/examples/coingecko/src/endpoint/crypto.d.ts +2 -1
- package/examples/coingecko/src/endpoint/crypto.js.map +1 -1
- package/examples/coingecko/src/endpoint/dominance.d.ts +2 -2
- package/examples/coingecko/src/endpoint/dominance.js.map +1 -1
- package/examples/coingecko/src/endpoint/global-marketcap.d.ts +2 -2
- package/examples/coingecko/src/endpoint/global-marketcap.js.map +1 -1
- package/examples/coingecko/src/global-utils.d.ts +18 -3
- package/examples/coingecko/src/global-utils.js.map +1 -1
- package/examples/coingecko/src/index.js +1 -1
- package/examples/cryptocompare/src/endpoints/crypto.d.ts +14 -2
- package/examples/cryptocompare/src/endpoints/crypto.js.map +1 -1
- package/examples/cryptocompare/src/index.js +1 -1
- package/examples/genesis/index.js +1 -1
- package/examples/genesis/sseStream.d.ts +13 -2
- package/examples/genesis/sseStream.js.map +1 -1
- package/metrics/util.d.ts +5 -5
- package/metrics/util.js.map +1 -1
- package/package.json +1 -1
- package/rate-limiting/background/fixed-frequency.d.ts +2 -3
- package/rate-limiting/background/fixed-frequency.js.map +1 -1
- package/rate-limiting/index.d.ts +4 -4
- package/rate-limiting/index.js +1 -1
- package/rate-limiting/index.js.map +1 -1
- package/rate-limiting/request/simple-counting.d.ts +2 -3
- package/rate-limiting/request/simple-counting.js.map +1 -1
- package/transports/batch-warming.d.ts +31 -13
- package/transports/batch-warming.js +4 -4
- package/transports/batch-warming.js.map +1 -1
- package/transports/index.d.ts +50 -13
- package/transports/index.js.map +1 -1
- package/transports/metrics.d.ts +2 -2
- package/transports/metrics.js +2 -2
- package/transports/metrics.js.map +1 -1
- package/transports/rest.d.ts +30 -13
- package/transports/rest.js +1 -3
- package/transports/rest.js.map +1 -1
- package/transports/routing.d.ts +11 -12
- package/transports/routing.js +16 -4
- package/transports/routing.js.map +1 -1
- package/transports/sse.d.ts +39 -18
- package/transports/sse.js +8 -2
- package/transports/sse.js.map +1 -1
- package/transports/websocket.d.ts +39 -23
- package/transports/websocket.js +8 -7
- package/transports/websocket.js.map +1 -1
- package/util/data-validation.d.ts +15 -0
- package/util/data-validation.js +61 -0
- package/util/data-validation.js.map +1 -0
- package/util/index.d.ts +1 -0
- package/util/index.js +5 -1
- package/util/index.js.map +1 -1
- package/util/logger.js +2 -6
- package/util/logger.js.map +1 -1
- package/util/request.d.ts +46 -10
- package/validation/error.js +1 -1
- package/validation/error.js.map +1 -1
- package/validation/index.js +16 -15
- package/validation/index.js.map +1 -1
|
@@ -5,7 +5,7 @@ const __1 = require("../../..");
|
|
|
5
5
|
const adapter_1 = require("../../../../src/adapter");
|
|
6
6
|
const endpoints_1 = require("./endpoints");
|
|
7
7
|
exports.adapter = new adapter_1.PriceAdapter({
|
|
8
|
-
name: '
|
|
8
|
+
name: 'CRYPTOCOMPARE',
|
|
9
9
|
defaultEndpoint: 'crypto',
|
|
10
10
|
endpoints: [endpoints_1.cryptoEndpoint],
|
|
11
11
|
});
|
|
@@ -5,7 +5,7 @@ const adapter_1 = require("../../adapter");
|
|
|
5
5
|
const sseStream_1 = require("./sseStream");
|
|
6
6
|
const config_1 = require("./config");
|
|
7
7
|
exports.adapter = new adapter_1.Adapter({
|
|
8
|
-
name: '
|
|
8
|
+
name: 'GENESIS',
|
|
9
9
|
defaultEndpoint: sseStream_1.sseEndpoint.name,
|
|
10
10
|
endpoints: [sseStream_1.sseEndpoint],
|
|
11
11
|
customSettings: config_1.customSettings,
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { AdapterEndpoint } from '../../adapter';
|
|
2
2
|
import { SSETransport } from '../../transports';
|
|
3
|
+
import { SingleNumberResultResponse } from '../../util';
|
|
3
4
|
import { InputParameters } from '../../validation';
|
|
4
5
|
import { SettingsMap } from '../../config';
|
|
5
6
|
interface AdapterRequestParams {
|
|
@@ -10,7 +11,17 @@ export declare const inputParameters: InputParameters;
|
|
|
10
11
|
declare type Price = number;
|
|
11
12
|
declare type Quantity = number;
|
|
12
13
|
export declare type Entry = ['BUY' | 'SELL' | '', Price, Quantity];
|
|
13
|
-
|
|
14
|
+
declare type StreamEndpointTypes = {
|
|
15
|
+
Request: {
|
|
16
|
+
Params: AdapterRequestParams;
|
|
17
|
+
};
|
|
18
|
+
Response: SingleNumberResultResponse;
|
|
19
|
+
CustomSettings: SettingsMap;
|
|
20
|
+
Provider: {
|
|
21
|
+
RequestBody: never;
|
|
22
|
+
};
|
|
23
|
+
};
|
|
24
|
+
export declare const sseTransport: SSETransport<StreamEndpointTypes>;
|
|
14
25
|
export declare const calculateQWAPprice: (entries: Entry[]) => number | undefined;
|
|
15
|
-
export declare const sseEndpoint: AdapterEndpoint<
|
|
26
|
+
export declare const sseEndpoint: AdapterEndpoint<StreamEndpointTypes>;
|
|
16
27
|
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sseStream.js","sourceRoot":"","sources":["../../../../src/examples/genesis/sseStream.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA2B;AAC3B,2CAA+
|
|
1
|
+
{"version":3,"file":"sseStream.js","sourceRoot":"","sources":["../../../../src/examples/genesis/sseStream.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA2B;AAC3B,2CAA+C;AAC/C,iDAA6E;AAC7E,qCAAmF;AAKnF,MAAM,gBAAgB,GAAG,gCAAgC,CAAA;AAO5C,QAAA,eAAe,GAAoB;IAC9C,IAAI,EAAE;QACJ,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;QACzB,WAAW,EAAE,qCAAqC;QAClD,QAAQ,EAAE,IAAI;KACf;IACD,KAAK,EAAE;QACL,OAAO,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC;QACzB,WAAW,EAAE,0CAA0C;QACvD,QAAQ,EAAE,IAAI;KACf;CACF,CAAA;AAiBD,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,qBAAqB,CAAC,CAAA;AAanC,QAAA,YAAY,GAAG,IAAI,yBAAY,CAAsB;IAChE,0BAA0B,EAAE,CAAC,MAAM,EAAE,OAAO,EAAa,EAAE;QACzD,MAAM,OAAO,GAAG,MAAM,CAAA;QACtB,MAAM,GAAG,GAAG,iBAAiB,CAAC,OAAO,CAAC,aAAa,EAAE,WAAW,EAAE,OAAO,CAAC,CAAA;QAC1E,MAAM,CAAC,KAAK,CAAC,sBAAsB,EAAE,GAAG,CAAC,CAAA;QACzC,OAAO,EAAE,GAAG,EAAE,CAAA;IAChB,CAAC;IACD,uBAAuB,EAAE,CAAC,OAAO,EAA4B,EAAE;QAC7D,MAAM,OAAO,GAAG,MAAM,CAAA;QACtB,MAAM,GAAG,GAAG,iBAAiB,CAAC,OAAO,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QACrE,MAAM,kBAAkB,GAA6B;YACnD,MAAM,EAAE,MAAM;YACd,GAAG;SACJ,CAAA;QACD,MAAM,CAAC,KAAK,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAA;QACrC,OAAO,kBAAkB,CAAA;IAC3B,CAAC;IACD,0BAA0B,EAAE,CAAC,MAAM,EAAE,OAAO,EAA4B,EAAE;QACxE,MAAM,gBAAgB,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAuB,EAAE,EAAE;YAC9D,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,CAAA;QAC3D,CAAC,CAAC,CAAA;QACF,MAAM,UAAU,GAAG;YACjB,MAAM,EAAE,WAAW;YACnB,OAAO,EAAE,gBAAgB;SAC1B,CAAA;QACD,MAAM,GAAG,GAAG,iBAAiB,CAC3B,OAAO,CAAC,aAAa,EACrB,mBAAmB,EACnB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAC3B,CAAA;QACD,MAAM,CAAC,KAAK,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAA;QACpC,MAAM,WAAW,GAA6B;YAC5C,MAAM,EAAE,MAAM;YACd,GAAG;SACJ,CAAA;QACD,OAAO,WAAW,CAAA;IACpB,CAAC;IACD,4BAA4B,EAAE,CAAC,MAAM,EAAE,OAAO,EAA4B,EAAE;QAC1E,MAAM,gBAAgB,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAuB,EAAE,EAAE;YAC9D,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,CAAA;QAC3D,CAAC,CAAC,CAAA;QACF,MAAM,UAAU,GAAG;YACjB,MAAM,EAAE,aAAa;YACrB,OAAO,EAAE,gBAAgB;SAC1B,CAAA;QACD,MAAM,GAAG,GAAG,iBAAiB,CAC3B,OAAO,CAAC,aAAa,EACrB,mBAAmB,EACnB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAC3B,CAAA;QACD,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAA;QACtC,MAAM,WAAW,GAA6B;YAC5C,MAAM,EAAE,MAAM;YACd,GAAG;SACJ,CAAA;QACD,OAAO,WAAW,CAAA;IACpB,CAAC;IACD,cAAc,EAAE;QACd;YACE,IAAI,EAAE,UAAU;YAChB,aAAa,EAAE,CAAC,GAAiB,EAAyC,EAAE;gBAC1E,IAAI,YAAY,GAAG,EAAkB,CAAA;gBACrC,IAAI;oBACF,+DAA+D;oBAC/D,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;iBACpC;gBAAC,OAAO,KAAK,EAAE;oBACd,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,uCAAuC,CAAC,CAAA;iBAC7D;gBACD,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;gBACxD,MAAM,KAAK,GAAG,IAAA,0BAAkB,EAAC,OAAO,CAAC,CAAA;gBACzC,IAAI,KAAK,EAAE;oBACT,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;oBACpD,OAAO;wBACL;4BACE,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;4BACvB,KAAK;yBACN;qBACF,CAAA;iBACF;gBACD,OAAO,EAAE,CAAA;YACX,CAAC;SACF;KACF;CACF,CAAC,CAAA;AAEK,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAAsB,EAAE;IACzE,MAAM,mBAAmB,GAAgD,EAAE,CAAA;IAC3E,2BAA2B;IAC3B,IAAI,aAAa,GAAG,CAAC,CAAA;IACrB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QACpB,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE;YACd,OAAM;SACP;QACD,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,EAAE;YACzC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;SACnD;aAAM;YACL,MAAM,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;YACtE,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YACpE,aAAa,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;SACtB;IACH,CAAC,CAAC,CAAA;IACF,IAAI,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QACjD,OAAM;KACP;IACD,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;QAClF,GAAG;QACH,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;KACd,CAAC,CAAC,CAAC,CAAC,CAAA;IACL,iEAAiE;IACjE,OAAO,qBAAqB,GAAG,aAAa,CAAA;AAC9C,CAAC,CAAA;AAzBY,QAAA,kBAAkB,sBAyB9B;AAED,MAAM,iBAAiB,GAAG,CACxB,MAAgE,EAChE,QAAgB,EAChB,OAAe,EACP,EAAE;IACV,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAA;IAC7B,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,CAAC,KAAK,CACV,IAAI,KAAK,CAAC,iBAAiB,CAAC,EAC5B,mEAAmE,CACpE,CAAA;KACF;IACD,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAA;IACnC,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;IACjE,MAAM,IAAI,GAAG,gBAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,CAAA;IACtE,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,CAAC,CAAA;IAC/D,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;IACzC,MAAM,OAAO,GAAG,MAAM,CAAC,YAAY,IAAI,gBAAgB,CAAA;IACvD,MAAM,MAAM,GAAG,GAAG,QAAQ,WAAW,MAAM,YAAY,OAAO,UAAU,KAAK,cAAc,GAAG,EAAE,CAAA;IAChG,OAAO,IAAI,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAA;AAC5C,CAAC,CAAA;AAEY,QAAA,WAAW,GAAG,IAAI,yBAAe,CAAC;IAC7C,IAAI,EAAE,WAAW;IACjB,SAAS,EAAE,oBAAY;IACvB,eAAe,EAAf,uBAAe;CAChB,CAAC,CAAA"}
|
package/metrics/util.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { AdapterMetricsMeta, AdapterRequestData } from '../util';
|
|
2
1
|
import { AdapterEndpoint } from '../adapter';
|
|
3
|
-
import { AdapterConfig
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
2
|
+
import { AdapterConfig } from '../config';
|
|
3
|
+
import { AdapterMetricsMeta, AdapterRequestData } from '../util';
|
|
4
|
+
export declare const getMetricsMeta: <T extends import("../transports").TransportGenerics>({ adapterEndpoint, adapterConfig, }: {
|
|
5
|
+
adapterEndpoint: AdapterEndpoint<T>;
|
|
6
|
+
adapterConfig: AdapterConfig<T["CustomSettings"]>;
|
|
7
7
|
}, data: AdapterRequestData) => AdapterMetricsMeta;
|
package/metrics/util.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"util.js","sourceRoot":"","sources":["../../../src/metrics/util.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"util.js","sourceRoot":"","sources":["../../../src/metrics/util.ts"],"names":[],"mappings":";;;AACA,oCAA0C;AAInC,MAAM,cAAc,GAAG,CAC5B,EACE,eAAe,EACf,aAAa,GAId,EACD,IAAwB,EACJ,EAAE;IACtB,MAAM,MAAM,GAAG,IAAA,uBAAe,EAAC,EAAE,eAAe,EAAE,aAAa,EAAE,EAAE,IAAI,CAAC,CAAA;IACxE,OAAO,EAAE,MAAM,EAAE,CAAA;AACnB,CAAC,CAAA;AAZY,QAAA,cAAc,kBAY1B"}
|
package/package.json
CHANGED
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
import { AdapterRateLimitTier, BackgroundExecuteRateLimiter } from '..';
|
|
2
|
-
import { AdapterEndpoint } from '../../adapter';
|
|
3
|
-
import { SettingsMap } from '../../config';
|
|
2
|
+
import { AdapterEndpoint, EndpointGenerics } from '../../adapter';
|
|
4
3
|
export declare const DEFAULT_SHARED_MS_BETWEEN_REQUESTS = 5000;
|
|
5
4
|
export declare class FixedFrequencyRateLimiter implements BackgroundExecuteRateLimiter {
|
|
6
5
|
msBetweenRequestsMap: {
|
|
7
6
|
[endpointName: string]: number;
|
|
8
7
|
};
|
|
9
|
-
initialize<
|
|
8
|
+
initialize<T extends EndpointGenerics>(endpoints: AdapterEndpoint<T>[], limits?: AdapterRateLimitTier): this;
|
|
10
9
|
msUntilNextExecution(endpointName: string): number;
|
|
11
10
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fixed-frequency.js","sourceRoot":"","sources":["../../../../src/rate-limiting/background/fixed-frequency.ts"],"names":[],"mappings":";;;AAAA,0BAA8F;
|
|
1
|
+
{"version":3,"file":"fixed-frequency.js","sourceRoot":"","sources":["../../../../src/rate-limiting/background/fixed-frequency.ts"],"names":[],"mappings":";;;AAAA,0BAA8F;AAE9F,qCAAuC;AAEvC,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,2BAA2B,CAAC,CAAA;AACzC,QAAA,kCAAkC,GAAG,IAAI,CAAA;AAEtD,MAAa,yBAAyB;IAAtC;QACE,yBAAoB,GAEhB,EAAE,CAAA;IAqCR,CAAC;IAnCC,UAAU,CACR,SAA+B,EAC/B,MAA6B;QAE7B,kDAAkD;QAClD,IAAI,uBAAuB,GAAG,IAAI,GAAG,IAAA,yBAAqB,EAAC,MAAM,CAAC,CAAA;QAElE,0DAA0D;QAC1D,IAAI,CAAC,MAAM,EAAE,WAAW,IAAI,CAAC,MAAM,EAAE,WAAW,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE;YACxE,+BAA+B;YAC/B,uBAAuB,GAAG,0CAAkC,CAAA;SAC7D;QAED,MAAM,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAA;QACzD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;YAChC,IAAI,QAAQ,CAAC,YAAY,EAAE,oBAAoB,IAAI,IAAI,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,uCAAuC,QAAQ,CAAC,IAAI,WAAW,CAAC,CAAA;aACjF;YAED,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACtC,CAAC,uBAAuB,GAAG,QAAQ,CAAC,YAAY,EAAE,oBAAoB,CAAC,GAAG,GAAG,CAAA;YAE/E,MAAM,CAAC,KAAK,CACV,aAAa,QAAQ,CAAC,IAAI,MACxB,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,IAC7C,oBAAoB,CACrB,CAAA;SACF;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED,oBAAoB,CAAC,YAAoB;QACvC,OAAO,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAA;IAChD,CAAC;CACF;AAxCD,8DAwCC"}
|
package/rate-limiting/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { AdapterEndpoint } from '../adapter';
|
|
2
|
-
import { AdapterConfig
|
|
3
|
-
export * from './request/simple-counting';
|
|
1
|
+
import { AdapterEndpoint, EndpointGenerics } from '../adapter';
|
|
2
|
+
import { AdapterConfig } from '../config';
|
|
4
3
|
export * from './background/fixed-frequency';
|
|
4
|
+
export * from './request/simple-counting';
|
|
5
5
|
export interface AdapterRateLimitTier {
|
|
6
6
|
rateLimit1s?: number;
|
|
7
7
|
rateLimit1m?: number;
|
|
@@ -18,7 +18,7 @@ export interface RateLimiter {
|
|
|
18
18
|
* @param limits - settings for how much throughput to allow for the Adapter
|
|
19
19
|
* @param endpoints - list of adapter endpoints
|
|
20
20
|
*/
|
|
21
|
-
initialize<
|
|
21
|
+
initialize<T extends EndpointGenerics>(endpoints: AdapterEndpoint<T>[], limits: AdapterRateLimitTier): this;
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
24
|
* RequestRateLimiters perform checks agains imminent outbound requests for any transport.
|
package/rate-limiting/index.js
CHANGED
|
@@ -15,8 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
exports.buildRateLimitTiersFromConfig = exports.getRateLimitingTier = exports.consolidateTierLimits = void 0;
|
|
18
|
-
__exportStar(require("./request/simple-counting"), exports);
|
|
19
18
|
__exportStar(require("./background/fixed-frequency"), exports);
|
|
19
|
+
__exportStar(require("./request/simple-counting"), exports);
|
|
20
20
|
/**
|
|
21
21
|
* This method will convert all possible settings for a rate limit tier and
|
|
22
22
|
* convert them all to requests per second, returning the lowest one
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/rate-limiting/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAGA,4DAAyC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/rate-limiting/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAGA,+DAA4C;AAC5C,4DAAyC;AA4CzC;;;;;;GAMG;AACI,MAAM,qBAAqB,GAAG,CAAC,MAA6B,EAAE,EAAE;IACrE,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,WAAW,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAA;IAClE,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,WAAW,IAAI,QAAQ,CAAC,GAAG,EAAE,CAAA;IAC7D,MAAM,cAAc,GAAG,MAAM,EAAE,WAAW,IAAI,QAAQ,CAAA;IACtD,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,cAAc,EAAE,cAAc,CAAC,CAAA;AAC/D,CAAC,CAAA;AALY,QAAA,qBAAqB,yBAKjC;AAED;;;;;;GAMG;AACI,MAAM,mBAAmB,GAAG,CACjC,MAAqB,EACrB,KAA4C,EACV,EAAE;IACpC,IACE,MAAM,CAAC,mBAAmB;QAC1B,MAAM,CAAC,0BAA0B;QACjC,MAAM,CAAC,0BAA0B,EACjC;QACA,OAAO,IAAA,qCAA6B,EAAC,MAAM,CAAC,CAAA;KAC7C;IACD,IAAI,CAAC,KAAK,EAAE;QACV,OAAM;KACP;IAED,2DAA2D;IAC3D,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QACrC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;KACnE;IAED,8DAA8D;IAC9D,MAAM,YAAY,GAAG,MAAM,CAAC,mBAAmB,CAAA;IAC/C,IAAI,YAAY,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE;QACxC,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;aACxC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC;aACpB,IAAI,CAAC,IAAI,CAAC,CAAA;QAEb,MAAM,IAAI,KAAK,CACb,iCAAiC,YAAY,iCAAiC,gBAAgB,GAAG,CAClG,CAAA;KACF;IAED,IAAI,CAAC,YAAY,EAAE;QACjB,8CAA8C;QAC9C,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAC3C,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,IAAA,6BAAqB,EAAC,EAAE,CAAC,GAAG,IAAA,6BAAqB,EAAC,EAAE,CAAC,CAClE,CAAA;QAED,OAAO,WAAW,CAAC,CAAC,CAAC,CAAA;KACtB;IAED,OAAO,KAAK,CAAC,YAAY,CAAC,CAAA;AAC5B,CAAC,CAAA;AA1CY,QAAA,mBAAmB,uBA0C/B;AAED,0EAA0E;AACnE,MAAM,6BAA6B,GAAG,CAC3C,MAAqB,EACa,EAAE;IACpC,MAAM,WAAW,GAAG,MAAM,CAAC,0BAA0B,CAAA;IACrD,IAAI,WAAW,CAAA;IACf,IAAI,MAAM,CAAC,0BAA0B,EAAE;QACrC,WAAW,GAAG,MAAM,CAAC,0BAA0B,CAAA;KAChD;SAAM,IAAI,MAAM,CAAC,mBAAmB,EAAE;QACrC,WAAW,GAAG,MAAM,CAAC,mBAAmB,CAAA;KACzC;IACD,OAAO;QACL,WAAW;QACX,WAAW;KACZ,CAAA;AACH,CAAC,CAAA;AAdY,QAAA,6BAA6B,iCAczC"}
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { AdapterRateLimitTier, RateLimiter } from '..';
|
|
2
|
-
import { AdapterEndpoint } from '../../adapter';
|
|
3
|
-
import { SettingsMap } from '../../config';
|
|
2
|
+
import { AdapterEndpoint, EndpointGenerics } from '../../adapter';
|
|
4
3
|
/**
|
|
5
4
|
* This rate limiter is the simplest stateful option.
|
|
6
5
|
* On startup, it'll compare the different thresholds for each tier, calculate them all
|
|
@@ -16,6 +15,6 @@ export declare class SimpleCountingRateLimiter implements RateLimiter {
|
|
|
16
15
|
requestsThisMinute: number;
|
|
17
16
|
perSecondLimit: number;
|
|
18
17
|
perMinuteLimit: number;
|
|
19
|
-
initialize<
|
|
18
|
+
initialize<T extends EndpointGenerics>(endpoints: AdapterEndpoint<T>[], limits?: AdapterRateLimitTier): this;
|
|
20
19
|
isUnderLimits(): boolean;
|
|
21
20
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"simple-counting.js","sourceRoot":"","sources":["../../../../src/rate-limiting/request/simple-counting.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"simple-counting.js","sourceRoot":"","sources":["../../../../src/rate-limiting/request/simple-counting.ts"],"names":[],"mappings":";;;AAEA,qCAAuC;AAEvC,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,2BAA2B,CAAC,CAAA;AAEtD;;;;;;;GAOG;AACH,MAAa,yBAAyB;IAAtC;QACE,yBAAoB,GAAG,CAAC,CAAA;QACxB,uBAAkB,GAAG,CAAC,CAAA;QACtB,yBAAoB,GAAG,CAAC,CAAA;QACxB,uBAAkB,GAAG,CAAC,CAAA;IA4DxB,CAAC;IAxDC,UAAU,CACR,SAA+B,EAC/B,MAA6B;QAE7B,kDAAkD;QAClD,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,WAAW,IAAI,QAAQ,CAAC,GAAG,EAAE,CAAA;QAC3D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,IAAI,QAAQ,EAAE,YAAY,CAAC,CAAA;QAC7E,IAAI,CAAC,cAAc,GAAG,MAAM,EAAE,WAAW,IAAI,QAAQ,CAAA;QACrD,MAAM,CAAC,KAAK,CACV,6CAA6C,IAAI,CAAC,cAAc,mBAAmB,IAAI,CAAC,cAAc,EAAE,CACzG,CAAA;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED,aAAa;QACX,qEAAqE;QACrE,IAAI,IAAI,CAAC,cAAc,KAAK,QAAQ,IAAI,IAAI,CAAC,cAAc,KAAK,QAAQ,EAAE;YACxE,OAAO,IAAI,CAAA;SACZ;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACtB,MAAM,qBAAqB,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,CAAA;QACpD,MAAM,qBAAqB,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAA;QAE3D,sFAAsF;QACtF,mFAAmF;QACnF,IAAI,qBAAqB,KAAK,IAAI,CAAC,oBAAoB,EAAE;YACvD,MAAM,CAAC,KAAK,CACV,8DAA8D,IAAI,CAAC,kBAAkB,GAAG,CACzF,CAAA;YACD,IAAI,CAAC,oBAAoB,GAAG,qBAAqB,CAAA;YACjD,IAAI,CAAC,kBAAkB,GAAG,CAAC,CAAA;SAC5B;QAED,IAAI,qBAAqB,KAAK,IAAI,CAAC,oBAAoB,EAAE;YACvD,MAAM,CAAC,KAAK,CACV,4DAA4D,IAAI,CAAC,kBAAkB,GAAG,CACvF,CAAA;YACD,IAAI,CAAC,oBAAoB,GAAG,qBAAqB,CAAA;YACjD,IAAI,CAAC,kBAAkB,GAAG,CAAC,CAAA;SAC5B;QAED,IACE,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,cAAc;YAC7C,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,cAAc,EAC7C;YACA,MAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAA;YACjD,IAAI,CAAC,kBAAkB,EAAE,CAAA;YACzB,IAAI,CAAC,kBAAkB,EAAE,CAAA;YACzB,OAAO,IAAI,CAAA;SACZ;aAAM;YACL,MAAM,CAAC,KAAK,CAAC,8CAA8C,CAAC,CAAA;YAC5D,OAAO,KAAK,CAAA;SACb;IACH,CAAC;CACF;AAhED,8DAgEC"}
|
|
@@ -1,11 +1,30 @@
|
|
|
1
1
|
import { AxiosRequestConfig, AxiosResponse } from 'axios';
|
|
2
2
|
import { Cache } from '../cache';
|
|
3
|
-
import { AdapterConfig
|
|
3
|
+
import { AdapterConfig } from '../config';
|
|
4
4
|
import { BackgroundExecuteRateLimiter } from '../rate-limiting';
|
|
5
5
|
import { SubscriptionSet } from '../util';
|
|
6
6
|
import { AdapterRequest, AdapterResponse, ProviderResult } from '../util/request';
|
|
7
|
-
import { Transport,
|
|
7
|
+
import { Transport, TransportGenerics } from './';
|
|
8
8
|
import { AdapterContext, AdapterDependencies } from '../adapter';
|
|
9
|
+
/**
|
|
10
|
+
* Helper struct type that will be used to pass types to the generic parameters of a Transport.
|
|
11
|
+
* Extends the common TransportGenerics, adding Provider specific types for this Batch endpoint.
|
|
12
|
+
*/
|
|
13
|
+
declare type BatchWarmingTransportGenerics = TransportGenerics & {
|
|
14
|
+
/**
|
|
15
|
+
* Type details for any provider specific interfaces.
|
|
16
|
+
*/
|
|
17
|
+
Provider: {
|
|
18
|
+
/**
|
|
19
|
+
* Structure of the body of the request that will be sent to the data provider.
|
|
20
|
+
*/
|
|
21
|
+
RequestBody: unknown;
|
|
22
|
+
/**
|
|
23
|
+
* Structure for the body of the response coming from the data provider.
|
|
24
|
+
*/
|
|
25
|
+
ResponseBody: unknown;
|
|
26
|
+
};
|
|
27
|
+
};
|
|
9
28
|
/**
|
|
10
29
|
* Transport implementation that takes incoming batches requests and keeps a warm cache of values.
|
|
11
30
|
* Within the setup function, adapter params are added to an set that also keeps track and expires values.
|
|
@@ -14,22 +33,21 @@ import { AdapterContext, AdapterDependencies } from '../adapter';
|
|
|
14
33
|
* The Data Provider response is, they are passed through the `parseResponse` function to create a [[CacheEntry]] list.
|
|
15
34
|
* Finally, the items in that [[CacheEntry]] list are set in the Cache so the Adapter can fetch values from there.
|
|
16
35
|
*
|
|
17
|
-
* @typeParam
|
|
18
|
-
* @typeParam ProviderRequestBody - interface for the body of the request to the Data Provider
|
|
19
|
-
* @typeParam ProviderResponseBody - interface for the body of the Data Provider's response
|
|
36
|
+
* @typeParam T - all types related to the [[Transport]]
|
|
20
37
|
*/
|
|
21
|
-
export declare class BatchWarmingTransport<
|
|
38
|
+
export declare class BatchWarmingTransport<T extends BatchWarmingTransportGenerics> implements Transport<T> {
|
|
22
39
|
private config;
|
|
23
|
-
cache: Cache<AdapterResponse<
|
|
40
|
+
cache: Cache<AdapterResponse<T['Response']>>;
|
|
24
41
|
rateLimiter: BackgroundExecuteRateLimiter;
|
|
25
|
-
subscriptionSet: SubscriptionSet<
|
|
42
|
+
subscriptionSet: SubscriptionSet<T['Request']['Params']>;
|
|
26
43
|
WARMER_ACTIVE: boolean;
|
|
27
44
|
constructor(config: {
|
|
28
|
-
prepareRequest: (params:
|
|
29
|
-
parseResponse: (params:
|
|
45
|
+
prepareRequest: (params: T['Request']['Params'][], config: AdapterConfig<T['CustomSettings']>) => AxiosRequestConfig<T['Provider']['RequestBody']>;
|
|
46
|
+
parseResponse: (params: T['Request']['Params'][], res: AxiosResponse<T['Provider']['ResponseBody']>, config: AdapterConfig<T['CustomSettings']>) => ProviderResult<T>[];
|
|
30
47
|
});
|
|
31
|
-
initialize(dependencies: AdapterDependencies, _: AdapterConfig<CustomSettings>, endpointName: string): Promise<void>;
|
|
32
|
-
registerRequest(req: AdapterRequest<
|
|
33
|
-
backgroundExecute(context: AdapterContext<
|
|
48
|
+
initialize(dependencies: AdapterDependencies, _: AdapterConfig<T['CustomSettings']>, endpointName: string): Promise<void>;
|
|
49
|
+
registerRequest(req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>): Promise<void>;
|
|
50
|
+
backgroundExecute(context: AdapterContext<T>): Promise<number>;
|
|
34
51
|
private makeRequest;
|
|
35
52
|
}
|
|
53
|
+
export {};
|
|
@@ -41,9 +41,7 @@ const logger = (0, util_1.makeLogger)('BatchWarmingTransport');
|
|
|
41
41
|
* The Data Provider response is, they are passed through the `parseResponse` function to create a [[CacheEntry]] list.
|
|
42
42
|
* Finally, the items in that [[CacheEntry]] list are set in the Cache so the Adapter can fetch values from there.
|
|
43
43
|
*
|
|
44
|
-
* @typeParam
|
|
45
|
-
* @typeParam ProviderRequestBody - interface for the body of the request to the Data Provider
|
|
46
|
-
* @typeParam ProviderResponseBody - interface for the body of the Data Provider's response
|
|
44
|
+
* @typeParam T - all types related to the [[Transport]]
|
|
47
45
|
*/
|
|
48
46
|
class BatchWarmingTransport {
|
|
49
47
|
constructor(config) {
|
|
@@ -113,13 +111,15 @@ class BatchWarmingTransport {
|
|
|
113
111
|
return interval;
|
|
114
112
|
}
|
|
115
113
|
async makeRequest(entries, config) {
|
|
114
|
+
logger.trace(`Have ${entries.length} entries in batch, preparing request...`);
|
|
116
115
|
const request = this.config.prepareRequest(entries, config);
|
|
117
|
-
logger.trace(
|
|
116
|
+
logger.trace(`Sending request to data provider: ${JSON.stringify(request)}`);
|
|
118
117
|
let providerResponse;
|
|
119
118
|
try {
|
|
120
119
|
providerResponse = await (0, util_2.axiosRequest)(request, config);
|
|
121
120
|
}
|
|
122
121
|
catch (e) {
|
|
122
|
+
logger.warn(`There was an error while performing the batch request: ${e}`);
|
|
123
123
|
return {
|
|
124
124
|
results: [],
|
|
125
125
|
providerResponse: e,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"batch-warming.js","sourceRoot":"","sources":["../../../src/transports/batch-warming.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,kCAAqD;AAErD,
|
|
1
|
+
{"version":3,"file":"batch-warming.js","sourceRoot":"","sources":["../../../src/transports/batch-warming.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,kCAAqD;AAErD,yBAA+E;AAC/E,iCAAqC;AACrC,2EAA4D;AAC5D,+DAAgD;AAEhD,4DAA6C;AAC7C,+CAAkD;AAElD,MAAM,uBAAuB,GAAG,MAAM,CAAA;AAEtC,MAAM,MAAM,GAAG,IAAA,iBAAU,EAAC,uBAAuB,CAAC,CAAA;AAuBlD;;;;;;;;;GASG;AACH,MAAa,qBAAqB;IAWhC,YACU,MAUP;QAVO,WAAM,GAAN,MAAM,CAUb;QAfH,uGAAuG;QACvG,gEAAgE;QAChE,kBAAa,GAAG,KAAK,CAAA;IAclB,CAAC;IAEJ,KAAK,CAAC,UAAU,CACd,YAAiC,EACjC,CAAqC,EACrC,YAAoB;QAEpB,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,KAA8C,CAAA;QACxE,IAAI,CAAC,WAAW,GAAG,YAAY,CAAC,4BAA4B,CAAA;QAC5D,IAAI,CAAC,eAAe,GAAG,YAAY,CAAC,sBAAsB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;IACnF,CAAC;IAED,+DAA+D;IAC/D,KAAK,CAAC,eAAe,CACnB,GAAiC,EACjC,MAA0C;QAE1C,MAAM,CAAC,KAAK,CACV,yCAAyC,MAAM,CAAC,uBAAuB,OAAO,GAAG,CAAC,cAAc,CAAC,QAAQ,OAAO,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAC1I,CAAA;QAED,IAAI,MAAM,CAAC,gCAAgC,EAAE;YAC3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAA;YAE1E,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE;gBAC5B,MAAM,IAAI,oBAAY,CAAC;oBACrB,UAAU,EAAE,GAAG;oBACf,kBAAkB,EAAE,QAAQ,CAAC,gBAAgB,CAAC,MAAM;oBACpD,OAAO,EACJ,QAAQ,CAAC,gBAAqC,CAAC,OAAO;wBACvD,sGAAsG;iBACzG,CAAC,CAAA;aACH;SACF;QAED,MAAM,IAAI,CAAC,eAAe,CAAC,GAAG,CAC5B,GAAG,CAAC,cAAc,CAAC,QAAQ,EAC3B,GAAG,CAAC,cAAc,CAAC,IAAI,EACvB,MAAM,CAAC,uBAAuB,CAC/B,CAAA;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,OAA0B;QAChD,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAA;QAC3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAA;QAEnD,4DAA4D;QAC5D,gBAAgB,CAAC,6BAA6B;aAC3C,MAAM,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,CAAC;aAC3E,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;QAEtB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;QAEpF,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YACnB,MAAM,CAAC,KAAK,CAAC,2CAA2C,CAAC,CAAA;YACzD,IAAI,IAAI,CAAC,aAAa,EAAE;gBACtB,yEAAyE;gBACzE,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,CAAA;gBACjE,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;aAC3B;YACD,OAAO,QAAQ,CAAA;SAChB;aAAM,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,EAAE;YACvC,4EAA4E;YAC5E,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,CAAA;YACjE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAA;SAC1B;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,CAAA;QAEvE,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE;YAC7B,OAAO,QAAQ,CAAA;SAChB;QAED,MAAM,YAAY,GAAG,IAAA,+BAA4B,EAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAE5E,MAAM,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAA;QAClD,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,CAAA;QAE3E,oCAAoC;QACpC,MAAM,IAAI,GAAG,gBAAgB,CAAC,YAAY,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;QAC1E,gBAAgB,CAAC,0BAA0B;aACxC,MAAM,CAAC;YACN,OAAO,EAAE,KAAK;YACd,cAAc,EAAE,uBAAuB;SACxC,CAAC;aACD,GAAG,CAAC,IAAI,CAAC,CAAA;QAEZ,OAAO,QAAQ,CAAA;IACjB,CAAC;IAEO,KAAK,CAAC,WAAW,CACvB,OAAiC,EACjC,MAA0C;QAK1C,MAAM,CAAC,KAAK,CAAC,QAAQ,OAAO,CAAC,MAAM,yCAAyC,CAAC,CAAA;QAC7E,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QAE3D,MAAM,CAAC,KAAK,CAAC,qCAAqC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAC5E,IAAI,gBAAgB,CAAA;QACpB,IAAI;YACF,gBAAgB,GAAG,MAAM,IAAA,mBAAY,EAInC,OAAO,EAAE,MAAM,CAAC,CAAA;SACnB;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,CAAC,IAAI,CAAC,0DAA0D,CAAC,EAAE,CAAC,CAAA;YAC1E,OAAO;gBACL,OAAO,EAAE,EAAE;gBACX,gBAAgB,EAAE,CAAkB;aACrC,CAAA;SACF;QAED,MAAM,CAAC,KAAK,CAAC,kDAAkD,gBAAgB,CAAC,IAAI,GAAG,CAAC,CAAA;QACxF,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,CAAC;YACrE,gBAAgB;SACjB,CAAA;IACH,CAAC;CACF;AAjJD,sDAiJC"}
|
package/transports/index.d.ts
CHANGED
|
@@ -1,11 +1,33 @@
|
|
|
1
1
|
import { AdapterContext, AdapterDependencies } from '../adapter';
|
|
2
2
|
import { Cache, CacheEntry } from '../cache';
|
|
3
3
|
import { AdapterConfig, SettingsMap } from '../config';
|
|
4
|
-
import { AdapterRequest, AdapterResponse, ProviderResult } from '../util/request';
|
|
4
|
+
import { AdapterRequest, AdapterResponse, ProviderResult, RequestGenerics, ResponseGenerics } from '../util/request';
|
|
5
5
|
export * from './batch-warming';
|
|
6
6
|
export * from './rest';
|
|
7
7
|
export * from './sse';
|
|
8
8
|
export * from './websocket';
|
|
9
|
+
/**
|
|
10
|
+
* Helper struct type that will be used to pass types to the generic parameters of a Transport.
|
|
11
|
+
* Within the transport, given a generic param T extends TransportGenerics, these will be used like so:
|
|
12
|
+
*
|
|
13
|
+
* const request: AdapterRequest\<T['Request']\> = ...
|
|
14
|
+
*
|
|
15
|
+
* (ignore the slash characters, they're just for proper doc syntax \<)
|
|
16
|
+
*/
|
|
17
|
+
export declare type TransportGenerics = {
|
|
18
|
+
/**
|
|
19
|
+
* Type details about incoming Adapter requests to this Transport
|
|
20
|
+
*/
|
|
21
|
+
Request: RequestGenerics;
|
|
22
|
+
/**
|
|
23
|
+
* Type details about outbound responses from this Transport
|
|
24
|
+
*/
|
|
25
|
+
Response: ResponseGenerics;
|
|
26
|
+
/**
|
|
27
|
+
* Type for any custom settings used for this Transport
|
|
28
|
+
*/
|
|
29
|
+
CustomSettings: SettingsMap;
|
|
30
|
+
};
|
|
9
31
|
/**
|
|
10
32
|
* Generic interface for a Transport.
|
|
11
33
|
* A Transport defines the way in which an AdapterEndpoint will process incoming requests to
|
|
@@ -14,11 +36,10 @@ export * from './websocket';
|
|
|
14
36
|
* This separation gives us the ability of splitting these concerns, and optionally parallelizing
|
|
15
37
|
* the reading and writing of data to a centralized Cache.
|
|
16
38
|
*
|
|
17
|
-
* @typeParam
|
|
18
|
-
* @typeParam Result - the structure of the AdapterResponse's body
|
|
39
|
+
* @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[TransportGenerics]])
|
|
19
40
|
*/
|
|
20
|
-
export interface Transport<
|
|
21
|
-
cache
|
|
41
|
+
export interface Transport<T extends TransportGenerics> {
|
|
42
|
+
cache?: Cache<AdapterResponse<T['Response']>>;
|
|
22
43
|
/**
|
|
23
44
|
* Initializes the transport in the Adapter context.
|
|
24
45
|
*
|
|
@@ -26,7 +47,7 @@ export interface Transport<Params, Result, CustomSettings extends SettingsMap> {
|
|
|
26
47
|
* @param config - Adapter config containing env vars
|
|
27
48
|
* @returns an empty Promise
|
|
28
49
|
*/
|
|
29
|
-
initialize: (dependencies: AdapterDependencies, config: AdapterConfig<CustomSettings>, endpointName: string) => Promise<void>;
|
|
50
|
+
initialize: (dependencies: AdapterDependencies, config: AdapterConfig<T['CustomSettings']>, endpointName: string) => Promise<void>;
|
|
30
51
|
/**
|
|
31
52
|
* Registers a request within the context of the transport.
|
|
32
53
|
* This means things like adding the request to a subscription set.
|
|
@@ -35,7 +56,7 @@ export interface Transport<Params, Result, CustomSettings extends SettingsMap> {
|
|
|
35
56
|
* @param config - common configuration for the Adapter as a whole
|
|
36
57
|
* @returns an empty Promise
|
|
37
58
|
*/
|
|
38
|
-
registerRequest?: (req: AdapterRequest<
|
|
59
|
+
registerRequest?: (req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>) => Promise<void>;
|
|
39
60
|
/**
|
|
40
61
|
* Performs a synchronous fetch/processing of information within the lifecycle of an incoming request.
|
|
41
62
|
* This is mostly intended to be used as a backwards compatibility mechanism, or for very specific cases where
|
|
@@ -48,7 +69,10 @@ export interface Transport<Params, Result, CustomSettings extends SettingsMap> {
|
|
|
48
69
|
* @returns a Promise that _optionally_ returns an AdapterResponse, if the Transport has the capability of
|
|
49
70
|
* immediately fetching data and returning it without the background process.
|
|
50
71
|
*/
|
|
51
|
-
foregroundExecute?: (req: AdapterRequest<
|
|
72
|
+
foregroundExecute?: (req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>) => Promise<AdapterResponse<{
|
|
73
|
+
Data: T['Response']['Data'];
|
|
74
|
+
Result: T['Response']['Result'];
|
|
75
|
+
}> | void>;
|
|
52
76
|
/**
|
|
53
77
|
* Main function that will be called by the main background loop of the writer EA.
|
|
54
78
|
* All logic fetching from providers should live here.
|
|
@@ -56,11 +80,24 @@ export interface Transport<Params, Result, CustomSettings extends SettingsMap> {
|
|
|
56
80
|
* @param context - background context for the execution (e.g. endpoint name)
|
|
57
81
|
* @returns an empty Promise
|
|
58
82
|
*/
|
|
59
|
-
backgroundExecute?: (context: AdapterContext<
|
|
83
|
+
backgroundExecute?: (context: AdapterContext<T>) => Promise<number>;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Generic interface for a Transport that contains or manages other transports.
|
|
87
|
+
* Some transports, such as the RoutingTransport, do not directly fetch data from a Data Provider, but
|
|
88
|
+
* instead coordinate the execution of other transports for fetching and transforming data.
|
|
89
|
+
* These transports have alternative initialization procedures, which typically involve
|
|
90
|
+
* initializing each downstream transport.
|
|
91
|
+
*
|
|
92
|
+
* @typeParam Params - the structure of the AdapterRequest's body
|
|
93
|
+
* @typeParam Result - the structure of the AdapterResponse's body
|
|
94
|
+
* @typeParam CustomSettings - custom settings for the Adapter, or the default SettingsMap
|
|
95
|
+
*/
|
|
96
|
+
export interface MetaTransport<T extends TransportGenerics> extends Transport<T> {
|
|
97
|
+
transports: {
|
|
98
|
+
[key: string]: Transport<T>;
|
|
99
|
+
};
|
|
60
100
|
}
|
|
61
|
-
export declare type BackgroundStoredResultType = {
|
|
62
|
-
result: unknown;
|
|
63
|
-
};
|
|
64
101
|
/**
|
|
65
102
|
* Helper method to build cache entries to set after getting a bunch of responses from a DP.
|
|
66
103
|
*
|
|
@@ -68,4 +105,4 @@ export declare type BackgroundStoredResultType = {
|
|
|
68
105
|
* @param context - context for the Adapter
|
|
69
106
|
* @returns a list of CacheEntries of AdapterResponses
|
|
70
107
|
*/
|
|
71
|
-
export declare const buildCacheEntriesFromResults: <
|
|
108
|
+
export declare const buildCacheEntriesFromResults: <T extends TransportGenerics>(results: ProviderResult<T>[], context: AdapterContext<T>) => CacheEntry<AdapterResponse<T["Response"]>>[];
|
package/transports/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/transports/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AACA,oCAAgF;
|
|
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/metrics.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as client from 'prom-client';
|
|
2
|
+
import { TransportGenerics } from '.';
|
|
2
3
|
import { AdapterContext } from '../adapter';
|
|
3
|
-
import { SettingsMap } from '../config';
|
|
4
4
|
export declare const dataProviderMetricsLabel: (providerStatusCode?: number, method?: string) => {
|
|
5
5
|
provider_status_code: number | undefined;
|
|
6
6
|
method: string;
|
|
@@ -14,7 +14,7 @@ export declare const messageSubsLabels: (feed_id: string, cache_key: string) =>
|
|
|
14
14
|
feed_id: string;
|
|
15
15
|
subscription_key: string;
|
|
16
16
|
};
|
|
17
|
-
export declare const recordWsMessageMetrics: <
|
|
17
|
+
export declare const recordWsMessageMetrics: <T extends TransportGenerics>(context: AdapterContext<T>, subscribes: T["Request"]["Params"][], unsubscribes: T["Request"]["Params"][]) => void;
|
|
18
18
|
export declare const wsConnectionActive: client.Gauge<"url">;
|
|
19
19
|
export declare const wsConnectionErrors: client.Counter<"message" | "url">;
|
|
20
20
|
export declare const wsSubscriptionActive: client.Gauge<"feed_id" | "connection_url" | "subscription_key">;
|
package/transports/metrics.js
CHANGED
|
@@ -57,7 +57,7 @@ exports.messageSubsLabels = messageSubsLabels;
|
|
|
57
57
|
// Record WS message and subscription metrics
|
|
58
58
|
// Recalculate cacheKey and feedId for metrics
|
|
59
59
|
// since avoiding storing extra info in expiring sorted set
|
|
60
|
-
const recordWsMessageMetrics = (context, subscribes,
|
|
60
|
+
const recordWsMessageMetrics = (context, subscribes, unsubscribes) => {
|
|
61
61
|
subscribes.forEach((param) => {
|
|
62
62
|
const feedId = (0, cache_1.calculateFeedId)(context, param);
|
|
63
63
|
const cacheKey = (0, cache_1.calculateCacheKey)(context, param);
|
|
@@ -68,7 +68,7 @@ const recordWsMessageMetrics = (context, subscribes, unsubscrices) => {
|
|
|
68
68
|
// Record number of active ws subscriptions
|
|
69
69
|
exports.wsSubscriptionActive.labels((0, exports.messageSubsLabels)(feedId, cacheKey)).inc();
|
|
70
70
|
});
|
|
71
|
-
|
|
71
|
+
unsubscribes.forEach((param) => {
|
|
72
72
|
const feedId = (0, cache_1.calculateFeedId)(context, param);
|
|
73
73
|
const cacheKey = (0, cache_1.calculateCacheKey)(context, param);
|
|
74
74
|
// Record total number of ws messages sent
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../../src/transports/metrics.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAqC;
|
|
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
CHANGED
|
@@ -1,11 +1,30 @@
|
|
|
1
1
|
import { AdapterRequest, AdapterResponse } from '../util/request';
|
|
2
|
-
import { Transport } from './';
|
|
2
|
+
import { Transport, TransportGenerics } from './';
|
|
3
3
|
import { Cache } from '../cache';
|
|
4
4
|
import { AxiosRequestConfig, AxiosResponse } from 'axios';
|
|
5
|
-
import { AdapterConfig
|
|
5
|
+
import { AdapterConfig } from '../config';
|
|
6
6
|
import { RequestRateLimiter } from '../rate-limiting';
|
|
7
7
|
import { AdapterDependencies } from '../adapter';
|
|
8
8
|
export { AxiosRequestConfig as HttpRequestConfig, AxiosResponse as HttpResponse };
|
|
9
|
+
/**
|
|
10
|
+
* Helper struct type that will be used to pass types to the generic parameters of a Transport.
|
|
11
|
+
* Extends the common TransportGenerics, adding Provider specific types for this Batch endpoint.
|
|
12
|
+
*/
|
|
13
|
+
declare type RestTransportGenerics = TransportGenerics & {
|
|
14
|
+
/**
|
|
15
|
+
* Type details for any provider specific interfaces.
|
|
16
|
+
*/
|
|
17
|
+
Provider: {
|
|
18
|
+
/**
|
|
19
|
+
* Structure of the body of the request that will be sent to the data provider.
|
|
20
|
+
*/
|
|
21
|
+
RequestBody: unknown;
|
|
22
|
+
/**
|
|
23
|
+
* Structure for the body of the response coming from the data provider.
|
|
24
|
+
*/
|
|
25
|
+
ResponseBody: unknown;
|
|
26
|
+
};
|
|
27
|
+
};
|
|
9
28
|
/**
|
|
10
29
|
* Transport implementation that takes incoming requests, transforms them into a DataProvider request,
|
|
11
30
|
* and executes that request returning the response immediately from the `setup` function.
|
|
@@ -13,14 +32,12 @@ export { AxiosRequestConfig as HttpRequestConfig, AxiosResponse as HttpResponse
|
|
|
13
32
|
* new adapter requests for the same feed will not trigger a new one, but return an empty promise from
|
|
14
33
|
* the setup instead so the normal cache polling mechanism is used.
|
|
15
34
|
*
|
|
16
|
-
* @typeParam
|
|
17
|
-
* @typeParam ProviderRequestBody - interface for the body of the request to the Data Provider
|
|
18
|
-
* @typeParam ProviderResponseBody - interface for the body of the Data Provider's response
|
|
35
|
+
* @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[RestTransportGenerics]])
|
|
19
36
|
*/
|
|
20
|
-
export declare class RestTransport<
|
|
37
|
+
export declare class RestTransport<T extends RestTransportGenerics> implements Transport<T> {
|
|
21
38
|
protected config: {
|
|
22
|
-
prepareRequest: (req: AdapterRequest<
|
|
23
|
-
parseResponse: (req: AdapterRequest<
|
|
39
|
+
prepareRequest: (req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>) => AxiosRequestConfig<T['Provider']['RequestBody']> | Promise<AxiosRequestConfig<T['Provider']['RequestBody']>>;
|
|
40
|
+
parseResponse: (req: AdapterRequest<T['Request']>, res: AxiosResponse<T['Provider']['ResponseBody']>, config: AdapterConfig<T['CustomSettings']>) => AdapterResponse<T['Response']> | Promise<AdapterResponse<T['Response']>>;
|
|
24
41
|
options: {
|
|
25
42
|
requestCoalescing: {
|
|
26
43
|
enabled: boolean;
|
|
@@ -29,12 +46,12 @@ export declare class RestTransport<AdapterParams, ProviderRequestBody, ProviderR
|
|
|
29
46
|
};
|
|
30
47
|
};
|
|
31
48
|
inFlightPrefix: string;
|
|
32
|
-
cache: Cache<AdapterResponse<
|
|
49
|
+
cache: Cache<AdapterResponse<T['Response']>>;
|
|
33
50
|
inFlightCache: Cache<boolean>;
|
|
34
51
|
rateLimiter: RequestRateLimiter;
|
|
35
52
|
constructor(config: {
|
|
36
|
-
prepareRequest: (req: AdapterRequest<
|
|
37
|
-
parseResponse: (req: AdapterRequest<
|
|
53
|
+
prepareRequest: (req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>) => AxiosRequestConfig<T['Provider']['RequestBody']> | Promise<AxiosRequestConfig<T['Provider']['RequestBody']>>;
|
|
54
|
+
parseResponse: (req: AdapterRequest<T['Request']>, res: AxiosResponse<T['Provider']['ResponseBody']>, config: AdapterConfig<T['CustomSettings']>) => AdapterResponse<T['Response']> | Promise<AdapterResponse<T['Response']>>;
|
|
38
55
|
options: {
|
|
39
56
|
requestCoalescing: {
|
|
40
57
|
enabled: boolean;
|
|
@@ -42,10 +59,10 @@ export declare class RestTransport<AdapterParams, ProviderRequestBody, ProviderR
|
|
|
42
59
|
};
|
|
43
60
|
};
|
|
44
61
|
});
|
|
45
|
-
initialize(dependencies: AdapterDependencies, config: AdapterConfig<CustomSettings>): Promise<void>;
|
|
62
|
+
initialize(dependencies: AdapterDependencies, config: AdapterConfig<T['CustomSettings']>): Promise<void>;
|
|
46
63
|
protected waitUntilUnderRateLimit(options: {
|
|
47
64
|
maxRetries: number;
|
|
48
65
|
msBetweenRetries: number;
|
|
49
66
|
}, retry?: number): Promise<void>;
|
|
50
|
-
foregroundExecute(req: AdapterRequest<
|
|
67
|
+
foregroundExecute(req: AdapterRequest<T['Request']>, config: AdapterConfig<T['CustomSettings']>): Promise<AdapterResponse<T['Response']> | undefined>;
|
|
51
68
|
}
|
package/transports/rest.js
CHANGED
|
@@ -37,9 +37,7 @@ const logger = (0, util_1.makeLogger)('RestTransport');
|
|
|
37
37
|
* new adapter requests for the same feed will not trigger a new one, but return an empty promise from
|
|
38
38
|
* the setup instead so the normal cache polling mechanism is used.
|
|
39
39
|
*
|
|
40
|
-
* @typeParam
|
|
41
|
-
* @typeParam ProviderRequestBody - interface for the body of the request to the Data Provider
|
|
42
|
-
* @typeParam ProviderResponseBody - interface for the body of the Data Provider's response
|
|
40
|
+
* @typeParam T - Helper struct type that will be used to pass types to the generic parameters (check [[RestTransportGenerics]])
|
|
43
41
|
*/
|
|
44
42
|
class RestTransport {
|
|
45
43
|
constructor(config) {
|