@baukit/sync-client 0.17.0 → 0.18.0
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/README.md +7 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/transport.d.ts +14 -0
- package/dist/transport.d.ts.map +1 -1
- package/dist/transport.js +39 -3
- package/dist/transport.js.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +1 -0
- package/src/transport.test.ts +129 -3
- package/src/transport.ts +54 -3
package/README.md
CHANGED
|
@@ -185,6 +185,13 @@ It classifies failures as follows:
|
|
|
185
185
|
values use `now + retryAfterFallbackMs`. The default fallback is 60 seconds. Tests and products
|
|
186
186
|
with another policy can inject `now` and `retryAfterFallbackMs` in the fetch-backed constructor.
|
|
187
187
|
|
|
188
|
+
Every request has a deadline, `requestTimeoutMs`, 30 seconds by default (`DEFAULT_REQUEST_TIMEOUT_MS`).
|
|
189
|
+
It covers the fetch and the body read. When it passes, the transport aborts the request's signal
|
|
190
|
+
and rejects with a retryable `SyncNetworkError`, so the scheduler's next run opens a new
|
|
191
|
+
connection instead of waiting on a pooled one whose packets get dropped. Both constructors take
|
|
192
|
+
the setting. A prebuilt request function receives the deadline signal and should pass it on to
|
|
193
|
+
its `fetch`. A caller's own `signal` still aborts the request.
|
|
194
|
+
|
|
188
195
|
Auth headers resolve per attempt, so a token refreshed between retries is picked up. The
|
|
189
196
|
partition header is sent only when the caller passes a `partitionId`, and both its name and the
|
|
190
197
|
mismatch code are configurable. The transport never names an endpoint: callers pass the path and
|
package/dist/index.d.ts
CHANGED
|
@@ -8,6 +8,6 @@ export { SyncScheduler } from './scheduler.js';
|
|
|
8
8
|
export type { SyncSchedulerEnvironment, SyncSchedulerOptions, SyncSchedulerRecoverySignal, SyncSchedulerRetry, SyncSchedulerRetryOptions, SyncSchedulerTimer, } from './scheduler.js';
|
|
9
9
|
export { deriveInitialSyncState, deriveLocalStoreReadiness, SyncStatusStore } from './store.js';
|
|
10
10
|
export type { InitialPullStatus, InitialSyncState, LocalStoreReadiness, LocalStoreReadinessInput, SyncAttentionItem, SyncFailureUpdate, SyncStatus, SyncStatusHydration, SyncStatusSink, SyncStatusSnapshot, SyncStatusStoreOptions, } from './store.js';
|
|
11
|
-
export { commitCursorAfterLocalTransaction, DEFAULT_RETRY_AFTER_FALLBACK_MS, parseRetryAfter, SyncTransport, validatePullPage, } from './transport.js';
|
|
11
|
+
export { commitCursorAfterLocalTransaction, DEFAULT_REQUEST_TIMEOUT_MS, DEFAULT_RETRY_AFTER_FALLBACK_MS, parseRetryAfter, SyncTransport, validatePullPage, } from './transport.js';
|
|
12
12
|
export type { CursorCommitOptions, ParseRetryAfterOptions, PullPagePosition, SyncCursorComparator, SyncFetch, SyncFetchResponse, SyncResponseHeaders, SyncPrebuiltRequest, SyncPrebuiltRequestTransportOptions, SyncRequestOptions, SyncRequestInit, SyncFetchTransportOptions, SyncTransportOptions, } from './transport.js';
|
|
13
13
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,0BAA0B,EAC1B,6BAA6B,EAC7B,kBAAkB,EAClB,eAAe,EACf,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EACL,8BAA8B,EAC9B,4BAA4B,EAC5B,4BAA4B,EAC5B,kBAAkB,EAClB,uBAAuB,EACvB,4BAA4B,EAC5B,eAAe,EACf,iBAAiB,GAClB,MAAM,UAAU,CAAC;AAClB,YAAY,EACV,gBAAgB,EAChB,UAAU,EACV,2BAA2B,EAC3B,uBAAuB,GACxB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AACpG,YAAY,EACV,aAAa,EACb,0BAA0B,EAC1B,cAAc,EACd,oBAAoB,GACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,YAAY,EACV,wBAAwB,EACxB,oBAAoB,EACpB,2BAA2B,EAC3B,kBAAkB,EAClB,yBAAyB,EACzB,kBAAkB,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAChG,YAAY,EACV,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,wBAAwB,EACxB,iBAAiB,EACjB,iBAAiB,EACjB,UAAU,EACV,mBAAmB,EACnB,cAAc,EACd,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,iCAAiC,EACjC,+BAA+B,EAC/B,eAAe,EACf,aAAa,EACb,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AACxB,YAAY,EACV,mBAAmB,EACnB,sBAAsB,EACtB,gBAAgB,EAChB,oBAAoB,EACpB,SAAS,EACT,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,mCAAmC,EACnC,kBAAkB,EAClB,eAAe,EACf,yBAAyB,EACzB,oBAAoB,GACrB,MAAM,gBAAgB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,0BAA0B,EAC1B,6BAA6B,EAC7B,kBAAkB,EAClB,eAAe,EACf,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EACL,8BAA8B,EAC9B,4BAA4B,EAC5B,4BAA4B,EAC5B,kBAAkB,EAClB,uBAAuB,EACvB,4BAA4B,EAC5B,eAAe,EACf,iBAAiB,GAClB,MAAM,UAAU,CAAC;AAClB,YAAY,EACV,gBAAgB,EAChB,UAAU,EACV,2BAA2B,EAC3B,uBAAuB,GACxB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AACpG,YAAY,EACV,aAAa,EACb,0BAA0B,EAC1B,cAAc,EACd,oBAAoB,GACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,YAAY,EACV,wBAAwB,EACxB,oBAAoB,EACpB,2BAA2B,EAC3B,kBAAkB,EAClB,yBAAyB,EACzB,kBAAkB,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAChG,YAAY,EACV,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,wBAAwB,EACxB,iBAAiB,EACjB,iBAAiB,EACjB,UAAU,EACV,mBAAmB,EACnB,cAAc,EACd,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,iCAAiC,EACjC,0BAA0B,EAC1B,+BAA+B,EAC/B,eAAe,EACf,aAAa,EACb,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AACxB,YAAY,EACV,mBAAmB,EACnB,sBAAsB,EACtB,gBAAgB,EAChB,oBAAoB,EACpB,SAAS,EACT,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,mCAAmC,EACnC,kBAAkB,EAClB,eAAe,EACf,yBAAyB,EACzB,oBAAoB,GACrB,MAAM,gBAAgB,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -3,5 +3,5 @@ export { compareHybridLogicalTimestamps, decodeHybridLogicalTimestamp, encodeHyb
|
|
|
3
3
|
export { dependencyRankByOrder, rankPushBatch, validatePushOutcomeCoverage } from './push-batch.js';
|
|
4
4
|
export { SyncScheduler } from './scheduler.js';
|
|
5
5
|
export { deriveInitialSyncState, deriveLocalStoreReadiness, SyncStatusStore } from './store.js';
|
|
6
|
-
export { commitCursorAfterLocalTransaction, DEFAULT_RETRY_AFTER_FALLBACK_MS, parseRetryAfter, SyncTransport, validatePullPage, } from './transport.js';
|
|
6
|
+
export { commitCursorAfterLocalTransaction, DEFAULT_REQUEST_TIMEOUT_MS, DEFAULT_RETRY_AFTER_FALLBACK_MS, parseRetryAfter, SyncTransport, validatePullPage, } from './transport.js';
|
|
7
7
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,0BAA0B,EAC1B,6BAA6B,EAC7B,kBAAkB,EAClB,eAAe,EACf,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,8BAA8B,EAC9B,4BAA4B,EAC5B,4BAA4B,EAC5B,kBAAkB,EAClB,uBAAuB,EACvB,4BAA4B,EAC5B,eAAe,EACf,iBAAiB,GAClB,MAAM,UAAU,CAAC;AAOlB,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AAOpG,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAS/C,OAAO,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAchG,OAAO,EACL,iCAAiC,EACjC,+BAA+B,EAC/B,eAAe,EACf,aAAa,EACb,gBAAgB,GACjB,MAAM,gBAAgB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,0BAA0B,EAC1B,6BAA6B,EAC7B,kBAAkB,EAClB,eAAe,EACf,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,8BAA8B,EAC9B,4BAA4B,EAC5B,4BAA4B,EAC5B,kBAAkB,EAClB,uBAAuB,EACvB,4BAA4B,EAC5B,eAAe,EACf,iBAAiB,GAClB,MAAM,UAAU,CAAC;AAOlB,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AAOpG,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAS/C,OAAO,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAchG,OAAO,EACL,iCAAiC,EACjC,0BAA0B,EAC1B,+BAA+B,EAC/B,eAAe,EACf,aAAa,EACb,gBAAgB,GACjB,MAAM,gBAAgB,CAAC"}
|
package/dist/transport.d.ts
CHANGED
|
@@ -38,6 +38,11 @@ export interface SyncFetchTransportOptions {
|
|
|
38
38
|
retryAfterFallbackMs?: number;
|
|
39
39
|
/** Clock used to resolve `Retry-After`. Defaults to `Date.now`. */
|
|
40
40
|
now?: () => number;
|
|
41
|
+
/**
|
|
42
|
+
* Milliseconds one request may take, body read included, before it is aborted
|
|
43
|
+
* with a {@link SyncNetworkError}. Defaults to 30 seconds.
|
|
44
|
+
*/
|
|
45
|
+
requestTimeoutMs?: number;
|
|
41
46
|
}
|
|
42
47
|
export interface SyncPrebuiltRequestTransportOptions {
|
|
43
48
|
/**
|
|
@@ -47,6 +52,11 @@ export interface SyncPrebuiltRequestTransportOptions {
|
|
|
47
52
|
request: SyncPrebuiltRequest;
|
|
48
53
|
/** Defaults to `X-Partition-Id`. */
|
|
49
54
|
partitionHeader?: string;
|
|
55
|
+
/**
|
|
56
|
+
* Milliseconds one request may take before its signal aborts and it rejects
|
|
57
|
+
* with a {@link SyncNetworkError}. Defaults to 30 seconds.
|
|
58
|
+
*/
|
|
59
|
+
requestTimeoutMs?: number;
|
|
50
60
|
}
|
|
51
61
|
export type SyncTransportOptions = SyncFetchTransportOptions | SyncPrebuiltRequestTransportOptions;
|
|
52
62
|
export interface SyncRequestOptions {
|
|
@@ -58,6 +68,7 @@ export interface SyncRequestOptions {
|
|
|
58
68
|
signal?: AbortSignal;
|
|
59
69
|
}
|
|
60
70
|
export declare const DEFAULT_RETRY_AFTER_FALLBACK_MS = 60000;
|
|
71
|
+
export declare const DEFAULT_REQUEST_TIMEOUT_MS = 30000;
|
|
61
72
|
export interface ParseRetryAfterOptions {
|
|
62
73
|
/** Unix time in milliseconds. Defaults to `Date.now()`. */
|
|
63
74
|
now?: number;
|
|
@@ -93,6 +104,7 @@ export declare class SyncTransport {
|
|
|
93
104
|
private readonly partitionMismatchCode;
|
|
94
105
|
private readonly retryAfterFallbackMs;
|
|
95
106
|
private readonly now;
|
|
107
|
+
private readonly requestTimeoutMs;
|
|
96
108
|
constructor(options: SyncTransportOptions);
|
|
97
109
|
/**
|
|
98
110
|
* Sends one sync request and decodes its JSON response.
|
|
@@ -102,6 +114,8 @@ export declare class SyncTransport {
|
|
|
102
114
|
* decoding and failure policy to that request function.
|
|
103
115
|
*/
|
|
104
116
|
request<T>(path: string, options?: SyncRequestOptions): Promise<T>;
|
|
117
|
+
private fetchJson;
|
|
118
|
+
private withDeadline;
|
|
105
119
|
private send;
|
|
106
120
|
private init;
|
|
107
121
|
private readBody;
|
package/dist/transport.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"transport.d.ts","sourceRoot":"","sources":["../src/transport.ts"],"names":[],"mappings":"AAWA,sDAAsD;AACtD,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,MAAM,SAAS,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,eAAe,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAE9F,uDAAuD;AACvD,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,eAAe,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;AAE3F,MAAM,WAAW,mBAAmB;IAClC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,yDAAyD;AACzD,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IACvC,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,yBAAyB;IACxC,mEAAmE;IACnE,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,SAAS,CAAC;IACjB,qEAAqE;IACrE,WAAW,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5E;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,2FAA2F;IAC3F,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,mEAAmE;IACnE,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"transport.d.ts","sourceRoot":"","sources":["../src/transport.ts"],"names":[],"mappings":"AAWA,sDAAsD;AACtD,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,MAAM,SAAS,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,eAAe,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAE9F,uDAAuD;AACvD,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,eAAe,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;AAE3F,MAAM,WAAW,mBAAmB;IAClC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,yDAAyD;AACzD,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IACvC,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,yBAAyB;IACxC,mEAAmE;IACnE,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,SAAS,CAAC;IACjB,qEAAqE;IACrE,WAAW,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5E;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,2FAA2F;IAC3F,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,mEAAmE;IACnE,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;IACnB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,mCAAmC;IAClD;;;OAGG;IACH,OAAO,EAAE,mBAAmB,CAAC;IAC7B,oCAAoC;IACpC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,MAAM,oBAAoB,GAAG,yBAAyB,GAAG,mCAAmC,CAAC;AAEnG,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,+EAA+E;IAC/E,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAKD,eAAO,MAAM,+BAA+B,QAAS,CAAC;AACtD,eAAO,MAAM,0BAA0B,QAAS,CAAC;AAWjD,MAAM,WAAW,sBAAsB;IACrC,2DAA2D;IAC3D,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,kFAAkF;IAClF,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,wEAAwE;AACxE,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAChC,OAAO,GAAE,sBAA2B,GACnC,MAAM,CAmBR;AAcD,MAAM,MAAM,oBAAoB,CAAC,OAAO,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,KAAK,MAAM,CAAC;AAEtF,MAAM,WAAW,gBAAgB,CAAC,OAAO;IACvC,UAAU,EAAE,OAAO,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,iFAAiF;AACjF,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,KAAK,SAAS,gBAAgB,CAAC,OAAO,CAAC,EAC/E,aAAa,EAAE,OAAO,EACtB,IAAI,EAAE,KAAK,EACX,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC,GACrC,KAAK,CAYP;AAED,MAAM,WAAW,mBAAmB,CAAC,OAAO,EAAE,OAAO;IACnD,UAAU,EAAE,OAAO,CAAC;IACpB,WAAW,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IACpC,YAAY,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CACzD;AAED,uEAAuE;AACvE,wBAAsB,iCAAiC,CAAC,OAAO,EAAE,OAAO,EAAE,EACxE,UAAU,EACV,WAAW,EACX,YAAY,GACb,EAAE,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAe1D;AAWD;;;;;GAKG;AACH,qBAAa,aAAa;IAQZ,OAAO,CAAC,QAAQ,CAAC,OAAO;IAPpC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAgB;IACxC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAgB;IACtD,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAe;IACnC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;gBAEb,OAAO,EAAE,oBAAoB;IAqB1D;;;;;;OAMG;IACG,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAAC,CAAC,CAAC;YAU9D,SAAS;YAST,YAAY;YA4BZ,IAAI;IAalB,OAAO,CAAC,IAAI;YAwBE,QAAQ;IAQtB,OAAO,CAAC,MAAM;IAWd,OAAO,CAAC,GAAG;IAIX,OAAO,CAAC,IAAI;IAKZ,OAAO,CAAC,gBAAgB;CAyBzB"}
|
package/dist/transport.js
CHANGED
|
@@ -3,6 +3,7 @@ const DEFAULT_PARTITION_HEADER = 'X-Partition-Id';
|
|
|
3
3
|
const DEFAULT_PARTITION_MISMATCH_CODE = 'partition_identity_mismatch';
|
|
4
4
|
const RETRYABLE_STATUSES = new Set([408, 429]);
|
|
5
5
|
export const DEFAULT_RETRY_AFTER_FALLBACK_MS = 60_000;
|
|
6
|
+
export const DEFAULT_REQUEST_TIMEOUT_MS = 30_000;
|
|
6
7
|
function isRetryableStatus(status) {
|
|
7
8
|
return RETRYABLE_STATUSES.has(status) || status >= 500;
|
|
8
9
|
}
|
|
@@ -94,6 +95,7 @@ export class SyncTransport {
|
|
|
94
95
|
partitionMismatchCode;
|
|
95
96
|
retryAfterFallbackMs;
|
|
96
97
|
now;
|
|
98
|
+
requestTimeoutMs;
|
|
97
99
|
constructor(options) {
|
|
98
100
|
this.options = options;
|
|
99
101
|
this.baseUrl = 'fetch' in options ? options.baseUrl.replace(/\/+$/, '') : null;
|
|
@@ -110,6 +112,10 @@ export class SyncTransport {
|
|
|
110
112
|
if (!Number.isFinite(this.retryAfterFallbackMs) || this.retryAfterFallbackMs < 0) {
|
|
111
113
|
throw new RangeError('retryAfterFallbackMs must be finite and non-negative');
|
|
112
114
|
}
|
|
115
|
+
this.requestTimeoutMs = options.requestTimeoutMs ?? DEFAULT_REQUEST_TIMEOUT_MS;
|
|
116
|
+
if (!Number.isFinite(this.requestTimeoutMs) || this.requestTimeoutMs <= 0) {
|
|
117
|
+
throw new RangeError('requestTimeoutMs must be finite and positive');
|
|
118
|
+
}
|
|
113
119
|
}
|
|
114
120
|
/**
|
|
115
121
|
* Sends one sync request and decodes its JSON response.
|
|
@@ -119,9 +125,15 @@ export class SyncTransport {
|
|
|
119
125
|
* decoding and failure policy to that request function.
|
|
120
126
|
*/
|
|
121
127
|
async request(path, options = {}) {
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
128
|
+
return this.withDeadline(options.signal, (signal) => {
|
|
129
|
+
const bounded = { ...options, signal };
|
|
130
|
+
if ('request' in this.options) {
|
|
131
|
+
return this.options.request(this.path(path, options.query), this.init(bounded, {}));
|
|
132
|
+
}
|
|
133
|
+
return this.fetchJson(path, bounded);
|
|
134
|
+
});
|
|
135
|
+
}
|
|
136
|
+
async fetchJson(path, options) {
|
|
125
137
|
const response = await this.send(path, options);
|
|
126
138
|
const body = await this.readBody(response);
|
|
127
139
|
if (!response.ok) {
|
|
@@ -129,6 +141,30 @@ export class SyncTransport {
|
|
|
129
141
|
}
|
|
130
142
|
return this.decode(body);
|
|
131
143
|
}
|
|
144
|
+
async withDeadline(callerSignal, run) {
|
|
145
|
+
const controller = new AbortController();
|
|
146
|
+
const forwardAbort = () => {
|
|
147
|
+
controller.abort(callerSignal?.reason);
|
|
148
|
+
};
|
|
149
|
+
if (callerSignal?.aborted)
|
|
150
|
+
forwardAbort();
|
|
151
|
+
callerSignal?.addEventListener('abort', forwardAbort, { once: true });
|
|
152
|
+
let timer;
|
|
153
|
+
const deadline = new Promise((_, reject) => {
|
|
154
|
+
timer = setTimeout(() => {
|
|
155
|
+
const error = new SyncNetworkError(`sync request timed out after ${String(this.requestTimeoutMs)} ms`);
|
|
156
|
+
controller.abort(error);
|
|
157
|
+
reject(error);
|
|
158
|
+
}, this.requestTimeoutMs);
|
|
159
|
+
});
|
|
160
|
+
try {
|
|
161
|
+
return await Promise.race([run(controller.signal), deadline]);
|
|
162
|
+
}
|
|
163
|
+
finally {
|
|
164
|
+
clearTimeout(timer);
|
|
165
|
+
callerSignal?.removeEventListener('abort', forwardAbort);
|
|
166
|
+
}
|
|
167
|
+
}
|
|
132
168
|
async send(path, options) {
|
|
133
169
|
if (!('fetch' in this.options)) {
|
|
134
170
|
throw new Error('unreachable request-backed transport');
|
package/dist/transport.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"transport.js","sourceRoot":"","sources":["../src/transport.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,0BAA0B,EAC1B,6BAA6B,EAC7B,kBAAkB,EAClB,eAAe,GAEhB,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"transport.js","sourceRoot":"","sources":["../src/transport.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,0BAA0B,EAC1B,6BAA6B,EAC7B,kBAAkB,EAClB,eAAe,GAEhB,MAAM,YAAY,CAAC;AAgFpB,MAAM,wBAAwB,GAAG,gBAAgB,CAAC;AAClD,MAAM,+BAA+B,GAAG,6BAA6B,CAAC;AACtE,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAC/C,MAAM,CAAC,MAAM,+BAA+B,GAAG,MAAM,CAAC;AACtD,MAAM,CAAC,MAAM,0BAA0B,GAAG,MAAM,CAAC;AAOjD,SAAS,iBAAiB,CAAC,MAAc;IACvC,OAAO,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,MAAM,IAAI,GAAG,CAAC;AACzD,CAAC;AASD,wEAAwE;AACxE,MAAM,UAAU,eAAe,CAC7B,KAAgC,EAChC,UAAkC,EAAE;IAEpC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;IACtC,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,+BAA+B,CAAC;IACzE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,MAAM,IAAI,UAAU,CAAC,oBAAoB,CAAC,CAAC;IACtE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;QACnD,MAAM,IAAI,UAAU,CAAC,sDAAsD,CAAC,CAAC;IAC/E,CAAC;IAED,MAAM,UAAU,GAAG,GAAG,GAAG,UAAU,CAAC;IACpC,MAAM,OAAO,GAAG,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IACpC,IAAI,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC;IAC3B,IAAI,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAC1B,SAAS,GAAG,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC;IAC5C,CAAC;SAAM,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9B,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,cAAc,CACnB,oBAAoB,CAAC,SAAS,CAAC,IAAI,SAAS,IAAI,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAC7E,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,YAAoB;IAChD,OAAO,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;AAC1F,CAAC;AAED,SAAS,cAAc,CAAC,YAAoB;IAC1C,IAAI,CAAC;QACH,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,CAAC;IAC9C,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,UAAU,CAAC,+DAA+D,CAAC,CAAC;IACxF,CAAC;AACH,CAAC;AASD,iFAAiF;AACjF,MAAM,UAAU,gBAAgB,CAC9B,aAAsB,EACtB,IAAW,EACX,OAAsC;IAEtC,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;IACtD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,6BAA6B,CAAC,4CAA4C,CAAC,CAAC;IACxF,CAAC;IACD,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACd,MAAM,IAAI,6BAA6B,CAAC,kCAAkC,CAAC,CAAC;IAC9E,CAAC;IACD,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,6BAA6B,CAAC,2CAA2C,CAAC,CAAC;IACvF,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAQD,uEAAuE;AACvE,MAAM,CAAC,KAAK,UAAU,iCAAiC,CAAmB,EACxE,UAAU,EACV,WAAW,EACX,YAAY,GAC0B;IACtC,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,MAAM,WAAW,EAAE,CAAC;IAC/B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,mBAAmB;YAAE,MAAM,KAAK,CAAC;QACtD,MAAM,IAAI,mBAAmB,CAAC,oCAAoC,EAAE,KAAK,CAAC,CAAC;IAC7E,CAAC;IACD,IAAI,CAAC;QACH,MAAM,YAAY,CAAC,UAAU,CAAC,CAAC;IACjC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,mBAAmB;YAAE,MAAM,KAAK,CAAC;QACtD,MAAM,IAAI,mBAAmB,CAAC,yCAAyC,EAAE,KAAK,CAAC,CAAC;IAClF,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,cAAc,CAAC,IAAY;IAClC,IAAI,CAAC;QACH,MAAM,OAAO,GAA2B,IAAI,CAAC,KAAK,CAAC,IAAI,CAA2B,CAAC;QACnF,OAAO,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IACxE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,OAAO,aAAa;IAQK;IAPZ,OAAO,CAAgB;IACvB,eAAe,CAAS;IACxB,qBAAqB,CAAgB;IACrC,oBAAoB,CAAS;IAC7B,GAAG,CAAe;IAClB,gBAAgB,CAAS;IAE1C,YAA6B,OAA6B;QAA7B,YAAO,GAAP,OAAO,CAAsB;QACxD,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC/E,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,wBAAwB,CAAC;QAC3E,IAAI,CAAC,qBAAqB;YACxB,OAAO,IAAI,OAAO;gBAChB,CAAC,CAAC,CAAC,OAAO,CAAC,qBAAqB,IAAI,+BAA+B,CAAC;gBACpE,CAAC,CAAC,IAAI,CAAC;QACX,IAAI,CAAC,oBAAoB;YACvB,OAAO,IAAI,OAAO;gBAChB,CAAC,CAAC,CAAC,OAAO,CAAC,oBAAoB,IAAI,+BAA+B,CAAC;gBACnE,CAAC,CAAC,+BAA+B,CAAC;QACtC,IAAI,CAAC,GAAG,GAAG,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QACrE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,IAAI,CAAC,oBAAoB,GAAG,CAAC,EAAE,CAAC;YACjF,MAAM,IAAI,UAAU,CAAC,sDAAsD,CAAC,CAAC;QAC/E,CAAC;QACD,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,IAAI,0BAA0B,CAAC;QAC/E,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,IAAI,CAAC,gBAAgB,IAAI,CAAC,EAAE,CAAC;YAC1E,MAAM,IAAI,UAAU,CAAC,8CAA8C,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CAAI,IAAY,EAAE,UAA8B,EAAE;QAC7D,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE;YAClD,MAAM,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAC;YACvC,IAAI,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;YACzF,CAAC;YACD,OAAO,IAAI,CAAC,SAAS,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,SAAS,CAAI,IAAY,EAAE,OAA2B;QAClE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAChD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC3C,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;QAC3F,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAM,CAAC;IAChC,CAAC;IAEO,KAAK,CAAC,YAAY,CACxB,YAAqC,EACrC,GAAwC;QAExC,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,YAAY,GAAG,GAAS,EAAE;YAC9B,UAAU,CAAC,KAAK,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QACzC,CAAC,CAAC;QACF,IAAI,YAAY,EAAE,OAAO;YAAE,YAAY,EAAE,CAAC;QAC1C,YAAY,EAAE,gBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACtE,IAAI,KAAgD,CAAC;QACrD,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;YAChD,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;gBACtB,MAAM,KAAK,GAAG,IAAI,gBAAgB,CAChC,gCAAgC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,CACnE,CAAC;gBACF,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACxB,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC;YACH,OAAO,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;QAChE,CAAC;gBAAS,CAAC;YACT,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,YAAY,EAAE,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,IAAI,CAAC,IAAY,EAAE,OAA2B;QAC1D,IAAI,CAAC,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QACD,MAAM,OAAO,GAA2B,EAAE,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;QAClF,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACzC,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;QACvE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,gBAAgB,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAEO,IAAI,CACV,OAA2B,EAC3B,cAAsC;QAEtC,MAAM,OAAO,GAAG,EAAE,GAAG,cAAc,EAAE,CAAC;QACtC,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAC/C,CAAC;QACD,IAAI,OAAO,CAAC,WAAW,IAAI,IAAI,EAAE,CAAC;YAChC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC;QACtD,CAAC;QACD,MAAM,IAAI,GAAoB,EAAE,OAAO,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC/B,CAAC;QACD,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC3C,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC/B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,QAA2B;QAChD,IAAI,CAAC;YACH,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC/B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,gBAAgB,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,IAAY;QACzB,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,6BAA6B,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAAC;QAC1F,CAAC;IACH,CAAC;IAEO,GAAG,CAAC,IAAY,EAAE,KAAyC;QACjE,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;IAC1D,CAAC;IAEO,IAAI,CAAC,IAAY,EAAE,KAAyC;QAClE,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACxE,OAAO,GAAG,IAAI,GAAG,MAAM,EAAE,CAAC;IAC5B,CAAC;IAEO,gBAAgB,CACtB,MAAc,EACd,IAAY,EACZ,UAAqC;QAErC,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,OAAO,GACX,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;YAC/D,CAAC,CAAC,OAAO,CAAC,OAAO;YACjB,CAAC,CAAC,mCAAmC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1D,IAAI,IAAI,CAAC,qBAAqB,KAAK,IAAI,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,qBAAqB,EAAE,CAAC;YACvF,OAAO,IAAI,0BAA0B,CAAC,OAAO,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,IAAI,aAAa,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC;QACD,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,MAAM,OAAO,GAAG,eAAe,CAAC,UAAU,EAAE;gBAC1C,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE;gBACf,UAAU,EAAE,IAAI,CAAC,oBAAoB;aACtC,CAAC,CAAC;YACH,OAAO,IAAI,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,IAAI,IAAI,CAAC,CAAC;QACtE,CAAC;QACD,OAAO,IAAI,eAAe,CAAC,OAAO,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;IACjE,CAAC;CACF;AAED,SAAS,YAAY,CAAC,KAAc;IAClC,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC"}
|
package/package.json
CHANGED
package/src/index.ts
CHANGED
package/src/transport.test.ts
CHANGED
|
@@ -13,6 +13,7 @@ import {
|
|
|
13
13
|
} from './error.js';
|
|
14
14
|
import {
|
|
15
15
|
commitCursorAfterLocalTransaction,
|
|
16
|
+
DEFAULT_REQUEST_TIMEOUT_MS,
|
|
16
17
|
parseRetryAfter,
|
|
17
18
|
SyncTransport,
|
|
18
19
|
validatePullPage,
|
|
@@ -20,6 +21,7 @@ import {
|
|
|
20
21
|
type SyncFetch,
|
|
21
22
|
type SyncFetchResponse,
|
|
22
23
|
type SyncPrebuiltRequest,
|
|
24
|
+
type SyncRequestInit,
|
|
23
25
|
} from './transport.js';
|
|
24
26
|
|
|
25
27
|
function response(status: number, body: string, retryAfter?: string): SyncFetchResponse {
|
|
@@ -53,7 +55,11 @@ describe('SyncTransport', () => {
|
|
|
53
55
|
});
|
|
54
56
|
|
|
55
57
|
expect(result).toEqual({ accepted: 1 });
|
|
56
|
-
expect(fetch).
|
|
58
|
+
expect(fetch).toHaveBeenCalledTimes(1);
|
|
59
|
+
const [url, init] = fetch.mock.calls[0] ?? [];
|
|
60
|
+
const { signal, ...sent } = init ?? {};
|
|
61
|
+
expect(url).toBe('https://api.example.test/sync/push');
|
|
62
|
+
expect(sent).toEqual({
|
|
57
63
|
method: 'POST',
|
|
58
64
|
headers: {
|
|
59
65
|
Authorization: 'Bearer token',
|
|
@@ -62,6 +68,7 @@ describe('SyncTransport', () => {
|
|
|
62
68
|
},
|
|
63
69
|
body: '{"changes":[]}',
|
|
64
70
|
});
|
|
71
|
+
expect(signal).toBeInstanceOf(AbortSignal);
|
|
65
72
|
});
|
|
66
73
|
|
|
67
74
|
it('awaits an async auth header provider', async () => {
|
|
@@ -78,7 +85,9 @@ describe('SyncTransport', () => {
|
|
|
78
85
|
});
|
|
79
86
|
|
|
80
87
|
it('delegates a relative request to a prebuilt product API client', async () => {
|
|
81
|
-
const request = vi.fn((
|
|
88
|
+
const request = vi.fn((_input: string, _init?: SyncRequestInit) =>
|
|
89
|
+
Promise.resolve({ accepted: 1 }),
|
|
90
|
+
);
|
|
82
91
|
const client = new SyncTransport({ request: request as SyncPrebuiltRequest });
|
|
83
92
|
|
|
84
93
|
const result = await client.request<{ accepted: number }>('/sync/push', {
|
|
@@ -89,7 +98,11 @@ describe('SyncTransport', () => {
|
|
|
89
98
|
});
|
|
90
99
|
|
|
91
100
|
expect(result).toEqual({ accepted: 1 });
|
|
92
|
-
expect(request).
|
|
101
|
+
expect(request).toHaveBeenCalledTimes(1);
|
|
102
|
+
const [input, init] = request.mock.calls[0] ?? [];
|
|
103
|
+
const { signal, ...sent } = init ?? {};
|
|
104
|
+
expect(input).toBe('/sync/push?limit=50');
|
|
105
|
+
expect(sent).toEqual({
|
|
93
106
|
method: 'POST',
|
|
94
107
|
headers: {
|
|
95
108
|
'Content-Type': 'application/json',
|
|
@@ -97,6 +110,7 @@ describe('SyncTransport', () => {
|
|
|
97
110
|
},
|
|
98
111
|
body: '{"changes":[]}',
|
|
99
112
|
});
|
|
113
|
+
expect(signal).toBeInstanceOf(AbortSignal);
|
|
100
114
|
});
|
|
101
115
|
|
|
102
116
|
it('leaves a prebuilt request function in charge of its errors', async () => {
|
|
@@ -107,6 +121,118 @@ describe('SyncTransport', () => {
|
|
|
107
121
|
await expect(client.request('/sync/pull')).rejects.toBe(failure);
|
|
108
122
|
});
|
|
109
123
|
|
|
124
|
+
describe('request deadline', () => {
|
|
125
|
+
function hangingFetch(): { fetch: SyncFetch; signals: AbortSignal[] } {
|
|
126
|
+
const signals: AbortSignal[] = [];
|
|
127
|
+
const fetch: SyncFetch = (_input, init) => {
|
|
128
|
+
if (init?.signal) signals.push(init.signal);
|
|
129
|
+
return new Promise(() => undefined);
|
|
130
|
+
};
|
|
131
|
+
return { fetch, signals };
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
it('aborts a request that outlives the default deadline', async () => {
|
|
135
|
+
vi.useFakeTimers();
|
|
136
|
+
try {
|
|
137
|
+
const { fetch, signals } = hangingFetch();
|
|
138
|
+
const pending = transport(fetch).request('/sync/pull');
|
|
139
|
+
const outcome = expect(pending).rejects.toThrow(
|
|
140
|
+
new SyncNetworkError('sync request timed out after 30000 ms'),
|
|
141
|
+
);
|
|
142
|
+
await vi.advanceTimersByTimeAsync(DEFAULT_REQUEST_TIMEOUT_MS - 1);
|
|
143
|
+
expect(signals[0]?.aborted).toBe(false);
|
|
144
|
+
await vi.advanceTimersByTimeAsync(1);
|
|
145
|
+
await outcome;
|
|
146
|
+
await expect(pending).rejects.toBeInstanceOf(SyncNetworkError);
|
|
147
|
+
expect(signals[0]?.aborted).toBe(true);
|
|
148
|
+
expect(signals[0]?.reason).toBeInstanceOf(SyncNetworkError);
|
|
149
|
+
} finally {
|
|
150
|
+
vi.useRealTimers();
|
|
151
|
+
}
|
|
152
|
+
});
|
|
153
|
+
|
|
154
|
+
it('bounds a body read that stalls after the headers arrive', async () => {
|
|
155
|
+
vi.useFakeTimers();
|
|
156
|
+
try {
|
|
157
|
+
const stalled: SyncFetchResponse = {
|
|
158
|
+
ok: true,
|
|
159
|
+
status: 200,
|
|
160
|
+
text: () => new Promise(() => undefined),
|
|
161
|
+
};
|
|
162
|
+
const client = new SyncTransport({
|
|
163
|
+
baseUrl: 'https://api.example.test',
|
|
164
|
+
fetch: () => Promise.resolve(stalled),
|
|
165
|
+
authHeaders: () => ({}),
|
|
166
|
+
requestTimeoutMs: 5_000,
|
|
167
|
+
});
|
|
168
|
+
const pending = client.request('/sync/pull');
|
|
169
|
+
const outcome = expect(pending).rejects.toThrow('sync request timed out after 5000 ms');
|
|
170
|
+
await vi.advanceTimersByTimeAsync(5_000);
|
|
171
|
+
await outcome;
|
|
172
|
+
} finally {
|
|
173
|
+
vi.useRealTimers();
|
|
174
|
+
}
|
|
175
|
+
});
|
|
176
|
+
|
|
177
|
+
it('gives a prebuilt request the deadline signal', async () => {
|
|
178
|
+
vi.useFakeTimers();
|
|
179
|
+
try {
|
|
180
|
+
let signal: AbortSignal | undefined;
|
|
181
|
+
const request = ((_input: string, init?: { signal?: AbortSignal }) => {
|
|
182
|
+
signal = init?.signal;
|
|
183
|
+
return new Promise(() => undefined);
|
|
184
|
+
}) as SyncPrebuiltRequest;
|
|
185
|
+
const pending = new SyncTransport({ request, requestTimeoutMs: 1_000 }).request(
|
|
186
|
+
'/sync/pull',
|
|
187
|
+
);
|
|
188
|
+
const outcome = expect(pending).rejects.toBeInstanceOf(SyncNetworkError);
|
|
189
|
+
await vi.advanceTimersByTimeAsync(1_000);
|
|
190
|
+
await outcome;
|
|
191
|
+
expect(signal?.aborted).toBe(true);
|
|
192
|
+
} finally {
|
|
193
|
+
vi.useRealTimers();
|
|
194
|
+
}
|
|
195
|
+
});
|
|
196
|
+
|
|
197
|
+
it('clears the timer once a request settles', async () => {
|
|
198
|
+
vi.useFakeTimers();
|
|
199
|
+
try {
|
|
200
|
+
const fetch = vi.fn<SyncFetch>(() => Promise.resolve(response(200, '{}')));
|
|
201
|
+
await transport(fetch).request('/sync/pull');
|
|
202
|
+
expect(vi.getTimerCount()).toBe(0);
|
|
203
|
+
} finally {
|
|
204
|
+
vi.useRealTimers();
|
|
205
|
+
}
|
|
206
|
+
});
|
|
207
|
+
|
|
208
|
+
it('forwards a caller abort to the request signal', async () => {
|
|
209
|
+
const { fetch, signals } = hangingFetch();
|
|
210
|
+
const caller = new AbortController();
|
|
211
|
+
void transport(fetch)
|
|
212
|
+
.request('/sync/pull', { signal: caller.signal })
|
|
213
|
+
.catch(() => undefined);
|
|
214
|
+
await Promise.resolve();
|
|
215
|
+
await Promise.resolve();
|
|
216
|
+
caller.abort('stopped');
|
|
217
|
+
expect(signals[0]?.aborted).toBe(true);
|
|
218
|
+
expect(signals[0]?.reason).toBe('stopped');
|
|
219
|
+
});
|
|
220
|
+
|
|
221
|
+
it('rejects a deadline that is not finite and positive', () => {
|
|
222
|
+
for (const requestTimeoutMs of [0, -1, Number.NaN, Number.POSITIVE_INFINITY]) {
|
|
223
|
+
expect(
|
|
224
|
+
() =>
|
|
225
|
+
new SyncTransport({
|
|
226
|
+
baseUrl: 'https://api.example.test',
|
|
227
|
+
fetch: () => Promise.resolve(response(200, '{}')),
|
|
228
|
+
authHeaders: () => ({}),
|
|
229
|
+
requestTimeoutMs,
|
|
230
|
+
}),
|
|
231
|
+
).toThrow(new RangeError('requestTimeoutMs must be finite and positive'));
|
|
232
|
+
}
|
|
233
|
+
});
|
|
234
|
+
});
|
|
235
|
+
|
|
110
236
|
it('appends query parameters and honours a custom partition header', async () => {
|
|
111
237
|
const fetch = vi.fn<SyncFetch>(() => Promise.resolve(response(200, '{}')));
|
|
112
238
|
|
package/src/transport.ts
CHANGED
|
@@ -54,6 +54,11 @@ export interface SyncFetchTransportOptions {
|
|
|
54
54
|
retryAfterFallbackMs?: number;
|
|
55
55
|
/** Clock used to resolve `Retry-After`. Defaults to `Date.now`. */
|
|
56
56
|
now?: () => number;
|
|
57
|
+
/**
|
|
58
|
+
* Milliseconds one request may take, body read included, before it is aborted
|
|
59
|
+
* with a {@link SyncNetworkError}. Defaults to 30 seconds.
|
|
60
|
+
*/
|
|
61
|
+
requestTimeoutMs?: number;
|
|
57
62
|
}
|
|
58
63
|
|
|
59
64
|
export interface SyncPrebuiltRequestTransportOptions {
|
|
@@ -64,6 +69,11 @@ export interface SyncPrebuiltRequestTransportOptions {
|
|
|
64
69
|
request: SyncPrebuiltRequest;
|
|
65
70
|
/** Defaults to `X-Partition-Id`. */
|
|
66
71
|
partitionHeader?: string;
|
|
72
|
+
/**
|
|
73
|
+
* Milliseconds one request may take before its signal aborts and it rejects
|
|
74
|
+
* with a {@link SyncNetworkError}. Defaults to 30 seconds.
|
|
75
|
+
*/
|
|
76
|
+
requestTimeoutMs?: number;
|
|
67
77
|
}
|
|
68
78
|
|
|
69
79
|
export type SyncTransportOptions = SyncFetchTransportOptions | SyncPrebuiltRequestTransportOptions;
|
|
@@ -81,6 +91,7 @@ const DEFAULT_PARTITION_HEADER = 'X-Partition-Id';
|
|
|
81
91
|
const DEFAULT_PARTITION_MISMATCH_CODE = 'partition_identity_mismatch';
|
|
82
92
|
const RETRYABLE_STATUSES = new Set([408, 429]);
|
|
83
93
|
export const DEFAULT_RETRY_AFTER_FALLBACK_MS = 60_000;
|
|
94
|
+
export const DEFAULT_REQUEST_TIMEOUT_MS = 30_000;
|
|
84
95
|
|
|
85
96
|
interface ServerErrorBody {
|
|
86
97
|
code?: unknown;
|
|
@@ -210,6 +221,7 @@ export class SyncTransport {
|
|
|
210
221
|
private readonly partitionMismatchCode: string | null;
|
|
211
222
|
private readonly retryAfterFallbackMs: number;
|
|
212
223
|
private readonly now: () => number;
|
|
224
|
+
private readonly requestTimeoutMs: number;
|
|
213
225
|
|
|
214
226
|
constructor(private readonly options: SyncTransportOptions) {
|
|
215
227
|
this.baseUrl = 'fetch' in options ? options.baseUrl.replace(/\/+$/, '') : null;
|
|
@@ -226,6 +238,10 @@ export class SyncTransport {
|
|
|
226
238
|
if (!Number.isFinite(this.retryAfterFallbackMs) || this.retryAfterFallbackMs < 0) {
|
|
227
239
|
throw new RangeError('retryAfterFallbackMs must be finite and non-negative');
|
|
228
240
|
}
|
|
241
|
+
this.requestTimeoutMs = options.requestTimeoutMs ?? DEFAULT_REQUEST_TIMEOUT_MS;
|
|
242
|
+
if (!Number.isFinite(this.requestTimeoutMs) || this.requestTimeoutMs <= 0) {
|
|
243
|
+
throw new RangeError('requestTimeoutMs must be finite and positive');
|
|
244
|
+
}
|
|
229
245
|
}
|
|
230
246
|
|
|
231
247
|
/**
|
|
@@ -236,9 +252,16 @@ export class SyncTransport {
|
|
|
236
252
|
* decoding and failure policy to that request function.
|
|
237
253
|
*/
|
|
238
254
|
async request<T>(path: string, options: SyncRequestOptions = {}): Promise<T> {
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
255
|
+
return this.withDeadline(options.signal, (signal) => {
|
|
256
|
+
const bounded = { ...options, signal };
|
|
257
|
+
if ('request' in this.options) {
|
|
258
|
+
return this.options.request<T>(this.path(path, options.query), this.init(bounded, {}));
|
|
259
|
+
}
|
|
260
|
+
return this.fetchJson<T>(path, bounded);
|
|
261
|
+
});
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
private async fetchJson<T>(path: string, options: SyncRequestOptions): Promise<T> {
|
|
242
265
|
const response = await this.send(path, options);
|
|
243
266
|
const body = await this.readBody(response);
|
|
244
267
|
if (!response.ok) {
|
|
@@ -247,6 +270,34 @@ export class SyncTransport {
|
|
|
247
270
|
return this.decode(body) as T;
|
|
248
271
|
}
|
|
249
272
|
|
|
273
|
+
private async withDeadline<T>(
|
|
274
|
+
callerSignal: AbortSignal | undefined,
|
|
275
|
+
run: (signal: AbortSignal) => Promise<T>,
|
|
276
|
+
): Promise<T> {
|
|
277
|
+
const controller = new AbortController();
|
|
278
|
+
const forwardAbort = (): void => {
|
|
279
|
+
controller.abort(callerSignal?.reason);
|
|
280
|
+
};
|
|
281
|
+
if (callerSignal?.aborted) forwardAbort();
|
|
282
|
+
callerSignal?.addEventListener('abort', forwardAbort, { once: true });
|
|
283
|
+
let timer: ReturnType<typeof setTimeout> | undefined;
|
|
284
|
+
const deadline = new Promise<never>((_, reject) => {
|
|
285
|
+
timer = setTimeout(() => {
|
|
286
|
+
const error = new SyncNetworkError(
|
|
287
|
+
`sync request timed out after ${String(this.requestTimeoutMs)} ms`,
|
|
288
|
+
);
|
|
289
|
+
controller.abort(error);
|
|
290
|
+
reject(error);
|
|
291
|
+
}, this.requestTimeoutMs);
|
|
292
|
+
});
|
|
293
|
+
try {
|
|
294
|
+
return await Promise.race([run(controller.signal), deadline]);
|
|
295
|
+
} finally {
|
|
296
|
+
clearTimeout(timer);
|
|
297
|
+
callerSignal?.removeEventListener('abort', forwardAbort);
|
|
298
|
+
}
|
|
299
|
+
}
|
|
300
|
+
|
|
250
301
|
private async send(path: string, options: SyncRequestOptions): Promise<SyncFetchResponse> {
|
|
251
302
|
if (!('fetch' in this.options)) {
|
|
252
303
|
throw new Error('unreachable request-backed transport');
|