@ethlete/query 2.1.0 → 2.2.0

package/fesm2020/ethlete-query.mjs

@@ -71,7 +71,7 @@ const queryStateDoesNotContainKeyError = (data) => new QueryError('005', 'The qu
 const queryStateCannotTransformError = (data) => new QueryError('006', 'The query state cannot be transformed because it is not loading', data);
 const invalidBodyError = (data) => new QueryError('007', 'The body is not valid or upsupported', data);
 
-const isRequestError = (error) => error instanceof Object && 'code' in error && 'message' in error;
+const isRequestError = (error) => error instanceof Object && 'status' in error && 'statusText' in error && 'url' in error;
 const buildRoute = (options) => {
     if (options.base.endsWith('/')) {
         throw invalidBaseRouteError(options.base);
@@ -163,6 +163,9 @@ const extractExpiresInSeconds = (headers) => {
         const ageSeconds = parseInt(age);
         expiresIn = maxAge - ageSeconds;
     }
+    else if (maxAge) {
+        expiresIn = maxAge / 2; // We assume the response is half way to its expiration
+    }
     else if (expires) {
         // Used by some apis to tell the response will never expire
         // In this case we let the response expire after 1 hour
@@ -268,6 +271,37 @@ const getResponseUrl = (xhr) => {
     }
     return null;
 };
+const shouldRetryRequest = (config) => {
+    const defaultRetryDelay = 1000 + 1000 * config.currentRetryCount;
+    if (config.currentRetryCount > 3) {
+        return { retry: false };
+    }
+    if (!isRequestError(config.error)) {
+        return { retry: false };
+    }
+    const { status } = config.error;
+    // Retry on 5xx errors
+    if (status >= 500) {
+        return { retry: true, delay: defaultRetryDelay };
+    }
+    // Retry on 408 or 425 errors
+    if (status === 408 /* HttpStatusCode.RequestTimeout */ || status === 425 /* HttpStatusCode.TooEarly */) {
+        return { retry: true, delay: defaultRetryDelay };
+    }
+    // Retry on 429 errors
+    if (status === 429 /* HttpStatusCode.TooManyRequests */) {
+        const retryAfter = config.headers['retry-after'] ||
+            config.headers['Retry-After'] ||
+            config.headers['x-retry-after'] ||
+            config.headers['X-Retry-After'];
+        if (retryAfter) {
+            const delay = parseInt(retryAfter) * 1000;
+            return { retry: true, delay: Number.isNaN(delay) ? defaultRetryDelay : delay };
+        }
+        return { retry: true, delay: defaultRetryDelay };
+    }
+    return { retry: false };
+};
 
 const XSSI_PREFIX = /^\)\]\}',?\n/;
 const request = (config) => {
@@ -275,25 +309,32 @@ const request = (config) => {
     const responseType = config.responseType || 'json';
     const body = config.body || null;
     const url = config.urlWithParams.split('?')[0];
+    const retryFn = config.retryFn || shouldRetryRequest;
+    let currentRetryCount = 0;
+    let retryTimeout = null;
     return new Observable((observer) => {
         const xhr = new XMLHttpRequest();
-        xhr.open(config.method, config.urlWithParams);
-        if (config.withCredentials) {
-            xhr.withCredentials = true;
-        }
-        forEachHeader(headers, (name, value) => xhr.setRequestHeader(name, value));
-        if (!hasHeader(headers, 'Accept')) {
-            xhr.setRequestHeader('Accept', 'application/json, text/plain, */*');
-        }
-        if (!hasHeader(headers, 'Content-Type')) {
-            const detectedType = detectContentTypeHeader(body);
-            if (detectedType) {
-                xhr.setRequestHeader('Content-Type', detectedType);
-            }
-        }
-        xhr.responseType = responseType !== 'json' ? responseType : 'text';
         const reqBody = serializeBody(body);
         let headerResponse = null;
+        const setupXhr = () => {
+            headerResponse = null;
+            xhr.open(config.method, config.urlWithParams);
+            if (config.withCredentials) {
+                xhr.withCredentials = true;
+            }
+            forEachHeader(headers, (name, value) => xhr.setRequestHeader(name, value));
+            if (!hasHeader(headers, 'Accept')) {
+                xhr.setRequestHeader('Accept', 'application/json, text/plain, */*');
+            }
+            if (!hasHeader(headers, 'Content-Type')) {
+                const detectedType = detectContentTypeHeader(body);
+                if (detectedType) {
+                    xhr.setRequestHeader('Content-Type', detectedType);
+                }
+            }
+            xhr.responseType = responseType !== 'json' ? responseType : 'text';
+        };
+        setupXhr();
         const partialFromXhr = () => {
             if (headerResponse !== null) {
                 return headerResponse;
@@ -304,6 +345,24 @@ const request = (config) => {
             headerResponse = { headers, status: xhr.status, statusText, url: _url };
             return headerResponse;
         };
+        const handleRetry = (error) => {
+            const newRetryCount = currentRetryCount + 1;
+            const { headers } = partialFromXhr();
+            const { retry, delay } = retryFn({ currentRetryCount: newRetryCount, headers, error });
+            if (!retry) {
+                observer.next({ type: 'failure', headers, error });
+                observer.complete();
+                return;
+            }
+            const _delay = delay ?? 1000;
+            observer.next({ type: 'delay-retry', headers, retryNumber: newRetryCount, retryDelay: _delay });
+            retryTimeout = window.setTimeout(() => {
+                setupXhr();
+                xhr.send(reqBody);
+                currentRetryCount = newRetryCount;
+                observer.next({ type: 'start', headers, isRetry: true, retryNumber: currentRetryCount, retryDelay: _delay });
+            }, _delay);
+        };
         const onLoad = () => {
             const { headers, statusText, url } = partialFromXhr();
             let { status } = partialFromXhr();
@@ -344,32 +403,22 @@ const request = (config) => {
                 observer.complete();
             }
             else {
-                observer.next({
-                    type: 'failure',
-                    headers,
-                    error: {
-                        url,
-                        detail: body,
-                        status,
-                        statusText,
-                    },
+                handleRetry({
+                    url,
+                    detail: body,
+                    status,
+                    statusText,
                 });
-                observer.complete();
             }
         };
         const onError = (error) => {
-            const { url, headers } = partialFromXhr();
-            observer.next({
-                type: 'failure',
-                headers,
-                error: {
-                    url,
-                    detail: error,
-                    status: xhr.status || 0,
-                    statusText: xhr.statusText || 'Unknown Error',
-                },
+            const { url } = partialFromXhr();
+            handleRetry({
+                url,
+                detail: error,
+                status: xhr.status || 0,
+                statusText: xhr.statusText || 'Unknown Error',
             });
-            observer.complete();
         };
         const onDownProgress = (event) => {
             const { headers } = partialFromXhr();
@@ -423,6 +472,9 @@ const request = (config) => {
             xhr.removeEventListener('abort', onError);
             xhr.removeEventListener('load', onLoad);
             xhr.removeEventListener('timeout', onError);
+            if (retryTimeout) {
+                window.clearTimeout(retryTimeout);
+            }
             if (config.reportProgress) {
                 xhr.removeEventListener('progress', onDownProgress);
                 if (reqBody !== null && xhr.upload) {
@@ -625,23 +677,31 @@ class Query {
                 authHeader = this._client.authProvider.header;
             }
         }
+        const mergedHeaders = mergeHeaders(getDefaultHeaders(this._client.config.request?.headers, this._queryConfig.method), authHeader, this._args?.headers) || undefined;
         request({
             urlWithParams: this._routeWithParams,
             method: transformMethod(this._queryConfig.method),
             body,
-            headers: mergeHeaders(getDefaultHeaders(this._client.config.request?.headers, this._queryConfig.method), authHeader, this._args?.headers) || undefined,
-            cacheAdapter: this._client.config.request?.cacheAdapter,
+            headers: mergedHeaders,
             reportProgress: this._queryConfig.reportProgress,
             responseType: this._queryConfig.responseType,
             withCredentials: this._queryConfig.withCredentials,
+            cacheAdapter: this._client.config.request?.cacheAdapter,
+            retryFn: this._client.config.request?.retryFn,
         })
             .pipe(takeUntil(this._onAbort$))
             .subscribe({
             next: (state) => {
-                if (state.type === 'start') {
+                if (state.type === 'start' || state.type === 'delay-retry') {
+                    const newMeta = {
+                        ...meta,
+                        isWaitingForRetry: state.type === 'delay-retry',
+                        retryDelay: state.retryDelay,
+                        retryNumber: state.retryNumber,
+                    };
                     this._state$.next({
                         type: "LOADING" /* QueryStateType.Loading */,
-                        meta,
+                        meta: newMeta,
                     });
                 }
                 else if (state.type === 'download-progress') {
@@ -1866,5 +1926,5 @@ const def = () => null;
  * Generated bundle index. Do not edit.
  */
 
-export { BasicAuthProvider, BearerAuthProvider, CustomHeaderAuthProvider, INFINITY_QUERY_TOKEN, InfinityQuery, InfinityQueryDirective, InfinityQueryTriggerDirective, Query, QueryClient, QueryDirective, QueryError, QueryField, QueryForm, QueryStore, buildErrorMessage, buildGqlCacheKey, buildQueryArrayString, buildQueryString, buildRoute, buildTimestampFromSeconds, createInfinityQueryConfig, createQueryCollection, decryptBearer, deepFreeze, def, detectContentTypeHeader, extractExpiresInSeconds, extractQuery, filterFailure, filterInvalidParams, filterNull, filterQueryStates, filterSuccess, forEachHeader, getDefaultHeaders, getResponseUrl, gql, hasHeader, invalidBaseRouteError, invalidBodyError, invalidRouteError, isBasicAuthProvider, isBearerAuthProvider, isCustomHeaderAuthProvider, isFetchResponse, isGqlQueryConfig, isParamValid, isQuery, isQueryStateCancelled, isQueryStateFailure, isQueryStateLoading, isQueryStatePrepared, isQueryStateSuccess, isRequestError, mergeHeaders, parseAllXhrResponseHeaders, pathParamsMissingInRouteFunctionError, queryStateAlreadyHasKeyError, queryStateCannotTransformError, queryStateDoesNotContainKeyError, request, serializeBody, shouldCacheQuery, skipPaginationPageParamCalculator, switchQueryCollectionState, switchQueryState, takeUntilResponse, transformGql, transformMethod, transformToBoolean, transformToBooleanArray, transformToDate, transformToDateArray, transformToNumber, transformToNumberArray, transformToSort, transformToSortQueryParam, transformToString, transformToStringArray };
+export { BasicAuthProvider, BearerAuthProvider, CustomHeaderAuthProvider, INFINITY_QUERY_TOKEN, InfinityQuery, InfinityQueryDirective, InfinityQueryTriggerDirective, Query, QueryClient, QueryDirective, QueryError, QueryField, QueryForm, QueryStore, buildErrorMessage, buildGqlCacheKey, buildQueryArrayString, buildQueryString, buildRoute, buildTimestampFromSeconds, createInfinityQueryConfig, createQueryCollection, decryptBearer, deepFreeze, def, detectContentTypeHeader, extractExpiresInSeconds, extractQuery, filterFailure, filterInvalidParams, filterNull, filterQueryStates, filterSuccess, forEachHeader, getDefaultHeaders, getResponseUrl, gql, hasHeader, invalidBaseRouteError, invalidBodyError, invalidRouteError, isBasicAuthProvider, isBearerAuthProvider, isCustomHeaderAuthProvider, isFetchResponse, isGqlQueryConfig, isParamValid, isQuery, isQueryStateCancelled, isQueryStateFailure, isQueryStateLoading, isQueryStatePrepared, isQueryStateSuccess, isRequestError, mergeHeaders, parseAllXhrResponseHeaders, pathParamsMissingInRouteFunctionError, queryStateAlreadyHasKeyError, queryStateCannotTransformError, queryStateDoesNotContainKeyError, request, serializeBody, shouldCacheQuery, shouldRetryRequest, skipPaginationPageParamCalculator, switchQueryCollectionState, switchQueryState, takeUntilResponse, transformGql, transformMethod, transformToBoolean, transformToBooleanArray, transformToDate, transformToDateArray, transformToNumber, transformToNumberArray, transformToSort, transformToSortQueryParam, transformToString, transformToStringArray };
 //# sourceMappingURL=ethlete-query.mjs.map