@statsig/client-core 3.32.5 → 3.32.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statsig/client-core",
-  "version": "3.32.5",
+  "version": "3.32.6",
   "license": "ISC",
   "homepage": "https://github.com/statsig-io/js-client-monorepo",
   "repository": {

package/src/ErrorBoundary.d.ts

@@ -11,7 +11,7 @@ export declare class ErrorBoundary {
     wrap(instance: unknown, namePrefix?: string): void;
     logError(tag: string, error: unknown): void;
     logDroppedEvents(count: number, reason: string, metadata?: Record<string, unknown>): void;
-    logEventRequestFailure(count: number, reason: string, flushType: string, statusCode: number, retries: number, failurePath?: string, failureErrorMessage?: string): void;
+    logEventRequestFailure(count: number, reason: string, flushType: string, statusCode: number, retries: number, failurePath?: string, failureErrorMessage?: string, failureDiagnosticBucket?: string, failureDiagnosticMetadata?: Record<string, string>): void;
     getLastSeenErrorAndReset(): Error | null;
     attachErrorIfNoneExists(error: unknown): void;
     private _capture;

package/src/ErrorBoundary.js

@@ -56,7 +56,7 @@ class ErrorBoundary {
         }
         this._onError(`statsig::log_event_dropped_event_count`, new Error(reason), true, extra);
     }
-    logEventRequestFailure(count, reason, flushType, statusCode, retries, failurePath, failureErrorMessage) {
+    logEventRequestFailure(count, reason, flushType, statusCode, retries, failurePath, failureErrorMessage, failureDiagnosticBucket, failureDiagnosticMetadata) {
         const extra = {
             eventCount: String(count),
             flushType: flushType,
@@ -71,6 +71,18 @@ class ErrorBoundary {
             failureErrorMessage.length > 0) {
             extra['failureErrorMessage'] = failureErrorMessage;
         }
+        if (typeof failureDiagnosticBucket === 'string' &&
+            failureDiagnosticBucket.length > 0) {
+            extra['failureDiagnosticBucket'] = failureDiagnosticBucket;
+        }
+        if (failureDiagnosticMetadata) {
+            Object.keys(failureDiagnosticMetadata).forEach((key) => {
+                const value = failureDiagnosticMetadata[key];
+                if (value.length > 0) {
+                    extra[`failureDiagnostic_${key}`] = value;
+                }
+            });
+        }
         this._onError(`statsig::log_event_failed`, new Error(reason), true, extra);
     }
     getLastSeenErrorAndReset() {
@@ -123,8 +135,9 @@ class ErrorBoundary {
                 const statsigMetadata = StatsigMetadata_1.StatsigMetadataProvider.get();
                 const info = isError ? unwrapped.stack : _getDescription(unwrapped);
                 const body = Object.assign(Object.assign({ tag, exception: name, info, statsigOptions: _getStatsigOptionLoggingCopy(this._options) }, Object.assign(Object.assign({}, statsigMetadata), { sdkType })), (extra !== null && extra !== void 0 ? extra : {}));
-                const func = (_f = (_e = (_d = this._options) === null || _d === void 0 ? void 0 : _d.networkConfig) === null || _e === void 0 ? void 0 : _e.networkOverrideFunc) !== null && _f !== void 0 ? _f : fetch;
-                yield func(exports.EXCEPTION_ENDPOINT, {
+                const networkConfig = (_d = this._options) === null || _d === void 0 ? void 0 : _d.networkConfig;
+                const func = (_e = networkConfig === null || networkConfig === void 0 ? void 0 : networkConfig.networkOverrideFunc) !== null && _e !== void 0 ? _e : fetch;
+                yield func((_f = networkConfig === null || networkConfig === void 0 ? void 0 : networkConfig.sdkExceptionUrl) !== null && _f !== void 0 ? _f : exports.EXCEPTION_ENDPOINT, {
                     method: 'POST',
                     headers: {
                         'STATSIG-API-KEY': this._sdkKey,

package/src/EventRetryConstants.d.ts

@@ -1,7 +1,7 @@
 export declare const EventRetryConstants: {
-    readonly MAX_RETRY_ATTEMPTS: 5;
+    readonly MAX_RETRY_ATTEMPTS: 8;
     readonly DEFAULT_BATCH_SIZE: 100;
-    readonly MAX_PENDING_BATCHES: 30;
+    readonly MAX_PENDING_BATCHES: 40;
     readonly TICK_INTERVAL_MS: 1000;
     readonly QUICK_FLUSH_WINDOW_MS: 200;
     readonly MAX_LOCAL_STORAGE: 500;

package/src/EventRetryConstants.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EventRetryConstants = void 0;
 exports.EventRetryConstants = {
-    MAX_RETRY_ATTEMPTS: 5,
+    MAX_RETRY_ATTEMPTS: 8,
     DEFAULT_BATCH_SIZE: 100,
-    MAX_PENDING_BATCHES: 30,
+    MAX_PENDING_BATCHES: 40,
     TICK_INTERVAL_MS: 1000,
     QUICK_FLUSH_WINDOW_MS: 200,
     MAX_LOCAL_STORAGE: 500,

package/src/EventSender.d.ts

@@ -8,6 +8,8 @@ type EventSendResult = {
     statusCode: number;
     failurePath?: string;
     failureErrorMessage?: string;
+    failureDiagnosticBucket?: string;
+    failureDiagnosticMetadata?: Record<string, string>;
 };
 export declare class EventSender {
     private _network;

package/src/EventSender.js

@@ -55,14 +55,22 @@ class EventSender {
                     });
                     return response;
                 }
-                return Object.assign({ success: false, statusCode: response.statusCode, failurePath: response.failurePath }, (response.failureErrorMessage
+                return Object.assign(Object.assign(Object.assign({ success: false, statusCode: response.statusCode, failurePath: response.failurePath }, (response.failureErrorMessage
                     ? { failureErrorMessage: response.failureErrorMessage }
+                    : {})), (response.failureDiagnosticBucket
+                    ? { failureDiagnosticBucket: response.failureDiagnosticBucket }
+                    : {})), (response.failureDiagnosticMetadata
+                    ? { failureDiagnosticMetadata: response.failureDiagnosticMetadata }
                     : {}));
             }
             catch (error) {
                 Log_1.Log.warn('Failed to send batch:', error);
-                return Object.assign({ success: false, statusCode: -1, failurePath: (_c = transportFailure.path) !== null && _c !== void 0 ? _c : failurePath }, (transportFailure.errorMessage
+                return Object.assign(Object.assign(Object.assign({ success: false, statusCode: -1, failurePath: (_c = transportFailure.path) !== null && _c !== void 0 ? _c : failurePath }, (transportFailure.errorMessage
                     ? { failureErrorMessage: transportFailure.errorMessage }
+                    : {})), (transportFailure.diagnosticBucket
+                    ? { failureDiagnosticBucket: transportFailure.diagnosticBucket }
+                    : {})), (transportFailure.diagnosticMetadata
+                    ? { failureDiagnosticMetadata: transportFailure.diagnosticMetadata }
                     : {}));
             }
         });
@@ -73,10 +81,14 @@ class EventSender {
             const result = yield this._network.post(this._getRequestData(batch), failureInfo);
             const code = (_a = result === null || result === void 0 ? void 0 : result.code) !== null && _a !== void 0 ? _a : -1;
             if (code === -1) {
-                return Object.assign({ success: false, statusCode: -1, failurePath: (_b = failureInfo.path) !== null && _b !== void 0 ? _b : (result === undefined
+                return Object.assign(Object.assign(Object.assign({ success: false, statusCode: -1, failurePath: (_b = failureInfo.path) !== null && _b !== void 0 ? _b : (result === undefined
                         ? 'event_sender_post_returned_undefined'
                         : 'event_sender_post_returned_null') }, (failureInfo.errorMessage
                     ? { failureErrorMessage: failureInfo.errorMessage }
+                    : {})), (failureInfo.diagnosticBucket
+                    ? { failureDiagnosticBucket: failureInfo.diagnosticBucket }
+                    : {})), (failureInfo.diagnosticMetadata
+                    ? { failureDiagnosticMetadata: failureInfo.diagnosticMetadata }
                     : {}));
             }
             return { success: code >= 200 && code < 300, statusCode: code };
@@ -85,10 +97,14 @@ class EventSender {
     _sendEventsViaBeacon(batch, failureInfo) {
         var _a;
         const success = this._network.beacon(this._getRequestData(batch), failureInfo);
-        return Object.assign({ success, statusCode: success ? 200 : -1, failurePath: success
+        return Object.assign(Object.assign(Object.assign({ success, statusCode: success ? 200 : -1, failurePath: success
                 ? undefined
                 : (_a = failureInfo.path) !== null && _a !== void 0 ? _a : 'beacon_send_false' }, (!success && failureInfo.errorMessage
             ? { failureErrorMessage: failureInfo.errorMessage }
+            : {})), (!success && failureInfo.diagnosticBucket
+            ? { failureDiagnosticBucket: failureInfo.diagnosticBucket }
+            : {})), (!success && failureInfo.diagnosticMetadata
+            ? { failureDiagnosticMetadata: failureInfo.diagnosticMetadata }
             : {}));
     }
     _getRequestData(batch) {

package/src/FlushCoordinator.js

@@ -261,7 +261,7 @@ class FlushCoordinator {
                 return true;
             }
             this._flushInterval.adjustForFailure();
-            this._handleFailure(batch, flushType, result.statusCode, result.failurePath, result.failureErrorMessage);
+            this._handleFailure(batch, flushType, result.statusCode, result.failurePath, result.failureErrorMessage, result.failureDiagnosticBucket, result.failureDiagnosticMetadata);
             return false;
         });
     }
@@ -301,7 +301,7 @@ class FlushCoordinator {
         }
         return false;
     }
-    _handleFailure(batch, flushType, statusCode, failurePath, failureErrorMessage) {
+    _handleFailure(batch, flushType, statusCode, failurePath, failureErrorMessage, failureDiagnosticBucket, failureDiagnosticMetadata) {
         if (flushType === FlushTypes_1.FlushType.Shutdown) {
             Log_1.Log.warn(`${flushType} flush failed during shutdown. ` +
                 `${batch.events.length} event(s) will be saved to storage for retry in next session.`);
@@ -309,15 +309,17 @@ class FlushCoordinator {
             return;
         }
         if (!this._isRetryableBatch(statusCode, failurePath)) {
+            const reason = `non-retryable error`;
             Log_1.Log.warn(`${flushType} flush failed after ${batch.attempts} attempt(s). ` +
                 `${batch.events.length} event(s) will be dropped. Non-retryable error: ${statusCode}`);
-            this._errorBoundary.logEventRequestFailure(batch.events.length, `non-retryable error`, flushType, statusCode, batch.attempts, failurePath, failureErrorMessage);
+            this._errorBoundary.logEventRequestFailure(batch.events.length, reason, flushType, statusCode, batch.attempts, failurePath, failureErrorMessage, failureDiagnosticBucket, failureDiagnosticMetadata);
             return;
         }
         if (batch.attempts >= EventRetryConstants_1.EventRetryConstants.MAX_RETRY_ATTEMPTS) {
+            const reason = `max retry attempts exceeded`;
             Log_1.Log.warn(`${flushType} flush failed after ${batch.attempts} attempt(s). ` +
                 `${batch.events.length} event(s) will be dropped.`);
-            this._errorBoundary.logEventRequestFailure(batch.events.length, `max retry attempts exceeded`, flushType, statusCode, batch.attempts, failurePath, failureErrorMessage);
+            this._errorBoundary.logEventRequestFailure(batch.events.length, reason, flushType, statusCode, batch.attempts, failurePath, failureErrorMessage, failureDiagnosticBucket, failureDiagnosticMetadata);
             return;
         }
         batch.incrementAttempts();

package/src/NetworkCore.d.ts

@@ -27,6 +27,8 @@ export type RequestArgsWithData = Flatten<RequestArgs & {
 export type RequestFailureInfo = {
     path?: string;
     errorMessage?: string;
+    diagnosticBucket?: string;
+    diagnosticMetadata?: Record<string, string>;
 };
 type BeaconRequestArgs = Pick<RequestArgsWithData, 'data' | 'sdkKey' | 'urlConfig' | 'params' | 'isCompressable' | 'attempt'>;
 type NetworkResponse = {

package/src/NetworkCore.js

@@ -138,6 +138,7 @@ class NetworkCore {
             const currentAttempt = attempt !== null && attempt !== void 0 ? attempt : 1;
             let reqTimedOut = false;
             const populatedUrl = this._getPopulatedURL(args);
+            const startTime = Date.now();
             let response = null;
             const keepalive = (0, VisibilityObserving_1._isUnloading)();
             try {
@@ -213,6 +214,14 @@ class NetworkCore {
                             if (errorMessage) {
                                 failureInfo.errorMessage = errorMessage;
                             }
+                            try {
+                                const diagnostics = _getNoResponseDiagnostics(args, populatedUrl, timedOut, Date.now() - startTime);
+                                failureInfo.diagnosticBucket = diagnostics.bucket;
+                                failureInfo.diagnosticMetadata = diagnostics.metadata;
+                            }
+                            catch (_e) {
+                                // Diagnostics should not affect request failure handling.
+                            }
                         }
                     }
                     return null;
@@ -389,6 +398,89 @@ function _didTimeout(errorMsg, abortedByTimeout) {
     const timeout = errorMsg.includes('Timeout'); // probably not needed but just in case
     return timeout || abortedByTimeout;
 }
+function _getNoResponseDiagnostics(args, populatedUrl, timedOut, elapsedMs) {
+    var _a, _b, _c;
+    const win = (0, SafeJs_1._getWindowSafe)();
+    const doc = win === null || win === void 0 ? void 0 : win.document;
+    const nav = typeof navigator !== 'undefined' ? navigator : null;
+    const isUnloading = (0, VisibilityObserving_1._isUnloading)();
+    const online = nav && typeof nav.onLine === 'boolean' ? String(nav.onLine) : 'unknown';
+    const visibilityState = (_a = doc === null || doc === void 0 ? void 0 : doc.visibilityState) !== null && _a !== void 0 ? _a : 'unknown';
+    const hasCustomHeaders = Object.keys((_b = args.headers) !== null && _b !== void 0 ? _b : {}).length > 0;
+    const crossOrigin = _isCrossOrigin(populatedUrl, (_c = win === null || win === void 0 ? void 0 : win.location) === null || _c === void 0 ? void 0 : _c.origin);
+    const hasCustomUrl = args.urlConfig.customUrl != null;
+    const hasFallbackUrl = args.fallbackUrl != null;
+    const elapsedMsBucket = _bucketNumber(elapsedMs, [250, 1000, 5000, 10000]);
+    const bodySizeBucket = _bucketNumber(_getBodySize(args.body), [16384, 65536, 262144, 1048576]);
+    let bucket = 'unknown_no_response';
+    if (timedOut) {
+        bucket = 'timeout';
+    }
+    else if (online === 'false') {
+        bucket = 'browser_offline';
+    }
+    else if (isUnloading) {
+        bucket = 'page_unloading';
+    }
+    else if (visibilityState === 'hidden') {
+        bucket = 'page_hidden';
+    }
+    else if (crossOrigin && hasCustomHeaders) {
+        bucket = 'cross_origin_custom_headers_preflight_risk';
+    }
+    else if (hasCustomUrl || hasFallbackUrl) {
+        bucket = 'custom_url_no_response';
+    }
+    else if (elapsedMs < 250) {
+        bucket = 'immediate_network_rejection';
+    }
+    return {
+        bucket,
+        metadata: {
+            elapsedMsBucket,
+            bodySizeBucket,
+            online,
+            visibilityState,
+            isUnloading: String(isUnloading),
+            crossOrigin: String(crossOrigin),
+            hasCustomUrl: String(hasCustomUrl),
+        },
+    };
+}
+function _isCrossOrigin(url, currentOrigin) {
+    if (!currentOrigin) {
+        return true;
+    }
+    return (!url.startsWith(`${currentOrigin}/`) &&
+        !url.startsWith(`${currentOrigin}?`) &&
+        url !== currentOrigin);
+}
+function _getBodySize(body) {
+    if (body == null) {
+        return 0;
+    }
+    if (typeof body === 'string') {
+        return body.length;
+    }
+    if (body instanceof Uint8Array) {
+        return body.byteLength;
+    }
+    if (typeof Blob !== 'undefined' && body instanceof Blob) {
+        return body.size;
+    }
+    return -1;
+}
+function _bucketNumber(value, thresholds) {
+    if (value < 0) {
+        return 'unknown';
+    }
+    for (const threshold of thresholds) {
+        if (value < threshold) {
+            return `<${threshold}`;
+        }
+    }
+    return `>=${thresholds[thresholds.length - 1]}`;
+}
 function _tryMarkInitStart(args, attempt) {
     if (args.urlConfig.endpoint !== NetworkConfig_1.Endpoint._initialize) {
         return;

package/src/StatsigMetadata.d.ts

@@ -1,4 +1,4 @@
-export declare const SDK_VERSION = "3.32.5";
+export declare const SDK_VERSION = "3.32.6";
 export type StatsigMetadata = {
     readonly [key: string]: string | undefined | null;
     readonly appVersion?: string;

package/src/StatsigMetadata.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StatsigMetadataProvider = exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = '3.32.5';
+exports.SDK_VERSION = '3.32.6';
 let metadata = {
     sdkVersion: exports.SDK_VERSION,
     sdkType: 'js-mono', // js-mono is overwritten by Precomp and OnDevice clients

package/src/StatsigOptionsCommon.d.ts

@@ -57,6 +57,12 @@ export type NetworkConfigCommon = {
      * default: `https://prodregistryv2.org/v1/rgstr`
      */
     logEventUrl?: string;
+    /**
+     * The URL used to report SDK exceptions via a POST request.
+     *
+     * default: `https://statsigapi.net/v1/sdk_exception`
+     */
+    sdkExceptionUrl?: string;
     /**
      * A list of URLs to try if the primary logEventUrl fails.
      */