@statsig/client-core 0.0.1-beta.9 → 1.0.0

package/src/ErrorBoundary.js

@@ -1,15 +1,4 @@
 "use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -19,113 +8,117 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ErrorBoundary = exports.EXCEPTION_ENDPOINT = void 0;
-var Log_1 = require("./Log");
-var StatsigMetadata_1 = require("./StatsigMetadata");
+const Log_1 = require("./Log");
+const SDKType_1 = require("./SDKType");
+const StatsigMetadata_1 = require("./StatsigMetadata");
 exports.EXCEPTION_ENDPOINT = 'https://statsigapi.net/v1/sdk_exception';
-var ErrorBoundary = /** @class */ (function () {
-    function ErrorBoundary(_sdkKey) {
+const UNKNOWN_ERROR = '[Statsig] UnknownError';
+class ErrorBoundary {
+    constructor(_sdkKey, _options, _emitter) {
         this._sdkKey = _sdkKey;
+        this._options = _options;
+        this._emitter = _emitter;
         this._seen = new Set();
     }
-    ErrorBoundary.prototype.capture = function (tag, task, emitter) {
-        var _this = this;
+    wrap(instance) {
         try {
-            var res = task();
+            const obj = instance;
+            _getAllInstanceMethodNames(obj).forEach((name) => {
+                const original = obj[name];
+                if ('$EB' in original) {
+                    return;
+                }
+                obj[name] = (...args) => {
+                    return this._capture(name, () => original.apply(instance, args));
+                };
+                obj[name].$EB = true;
+            });
+        }
+        catch (err) {
+            this._onError('eb:wrap', err);
+        }
+    }
+    logError(tag, error) {
+        this._onError(tag, error);
+    }
+    _capture(tag, task) {
+        try {
+            const res = task();
             if (res && res instanceof Promise) {
-                return res.catch(function (err) { return _this._onError(tag, err, emitter); });
+                return res.catch((err) => this._onError(tag, err));
             }
             return res;
         }
         catch (error) {
-            this._onError(tag, error, emitter);
+            this._onError(tag, error);
             return null;
         }
-    };
-    ErrorBoundary.prototype._onError = function (tag, error, emitter) {
-        var _this = this;
+    }
+    _onError(tag, error) {
         try {
-            Log_1.Log.warn("Caught error in ".concat(tag), { error: error });
-            var impl = function () { return __awaiter(_this, void 0, void 0, function () {
-                var unwrapped, isError, name, statsigMetadata, info, body;
-                return __generator(this, function (_a) {
-                    switch (_a.label) {
-                        case 0:
-                            unwrapped = (error !== null && error !== void 0 ? error : Error('[Statsig] Error was empty'));
-                            isError = unwrapped instanceof Error;
-                            name = isError ? unwrapped.name : 'No Name';
-                            if (this._seen.has(name)) {
-                                return [2 /*return*/];
-                            }
-                            this._seen.add(name);
-                            statsigMetadata = StatsigMetadata_1.StatsigMetadataProvider.get();
-                            info = isError ? unwrapped.stack : _getDescription(unwrapped);
-                            body = JSON.stringify(__assign({ tag: tag, exception: name, info: info }, statsigMetadata));
-                            return [4 /*yield*/, fetch(exports.EXCEPTION_ENDPOINT, {
-                                    method: 'POST',
-                                    headers: {
-                                        'STATSIG-API-KEY': this._sdkKey,
-                                        'STATSIG-SDK-TYPE': String(statsigMetadata.sdkType),
-                                        'STATSIG-SDK-VERSION': String(statsigMetadata.sdkVersion),
-                                        'Content-Type': 'application/json',
-                                    },
-                                    body: body,
-                                })];
-                        case 1:
-                            _a.sent();
-                            emitter === null || emitter === void 0 ? void 0 : emitter({ event: 'error', error: error });
-                            return [2 /*return*/];
-                    }
+            Log_1.Log.warn(`Caught error in ${tag}`, { error });
+            const impl = () => __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c, _d, _e, _f, _g;
+                const unwrapped = (error ? error : Error(UNKNOWN_ERROR));
+                const isError = unwrapped instanceof Error;
+                const name = isError ? unwrapped.name : 'No Name';
+                if (this._seen.has(name)) {
+                    return;
+                }
+                this._seen.add(name);
+                if ((_b = (_a = this._options) === null || _a === void 0 ? void 0 : _a.networkConfig) === null || _b === void 0 ? void 0 : _b.preventAllNetworkTraffic) {
+                    (_c = this._emitter) === null || _c === void 0 ? void 0 : _c.call(this, { name: 'error', error });
+                    return;
+                }
+                const sdkType = SDKType_1.SDKType._get(this._sdkKey);
+                const statsigMetadata = StatsigMetadata_1.StatsigMetadataProvider.get();
+                const info = isError ? unwrapped.stack : _getDescription(unwrapped);
+                const body = JSON.stringify(Object.assign({ tag, exception: name, info }, Object.assign(Object.assign({}, statsigMetadata), { sdkType })));
+                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, {
+                    method: 'POST',
+                    headers: {
+                        'STATSIG-API-KEY': this._sdkKey,
+                        'STATSIG-SDK-TYPE': String(sdkType),
+                        'STATSIG-SDK-VERSION': String(statsigMetadata.sdkVersion),
+                        'Content-Type': 'application/json',
+                    },
+                    body,
                 });
-            }); };
+                (_g = this._emitter) === null || _g === void 0 ? void 0 : _g.call(this, { name: 'error', error });
+            });
             impl()
-                .then(function () {
+                .then(() => {
                 /* noop */
             })
-                .catch(function () {
+                .catch(() => {
                 /* noop */
             });
         }
         catch (_error) {
             /* noop */
         }
-    };
-    return ErrorBoundary;
-}());
+    }
+}
 exports.ErrorBoundary = ErrorBoundary;
 function _getDescription(obj) {
     try {
         return JSON.stringify(obj);
     }
     catch (_a) {
-        return '[Statsig] Failed to get string for error.';
+        return UNKNOWN_ERROR;
+    }
+}
+function _getAllInstanceMethodNames(instance) {
+    const names = new Set();
+    let proto = Object.getPrototypeOf(instance);
+    while (proto && proto !== Object.prototype) {
+        Object.getOwnPropertyNames(proto)
+            .filter((prop) => typeof (proto === null || proto === void 0 ? void 0 : proto[prop]) === 'function')
+            .forEach((name) => names.add(name));
+        proto = Object.getPrototypeOf(proto);
     }
+    return Array.from(names);
 }

package/src/EvaluationOptions.d.ts

@@ -0,0 +1,20 @@
+export type EvaluationOptionsCommon = {
+    /**
+     * Prevents an exposure log being created for this check.
+     *
+     * default: `false`
+     */
+    disableExposureLog?: boolean;
+};
+export type FeatureGateEvaluationOptions = EvaluationOptionsCommon & {};
+export type DynamicConfigEvaluationOptions = EvaluationOptionsCommon & {};
+export type ExperimentEvaluationOptions = EvaluationOptionsCommon & {
+    /**
+     * Provide a map of values to be used across checks
+     *
+     * @requires {@link @statsig/js-user-persisted-storage}
+     * @see {@link https://docs.statsig.com/client/concepts/persistent_assignment#example-usage}
+     */
+    userPersistedValues?: unknown;
+};
+export type LayerEvaluationOptions = EvaluationOptionsCommon & {};

package/src/EvaluationOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/EvaluationTypes.d.ts

@@ -0,0 +1,39 @@
+import { Flatten } from './UtitlityTypes';
+type EvaluationBase<T> = {
+    id_type: string;
+    name: string;
+    rule_id: string;
+    secondary_exposures: SecondaryExposure[];
+    value: T;
+};
+export type SecondaryExposure = {
+    gate: string;
+    gateValue: string;
+    ruleID: string;
+};
+export type GateEvaluation = EvaluationBase<boolean>;
+export type ExperimentEvaluation = Flatten<EvaluationBase<Record<string, unknown>> & {
+    group_name?: string;
+    group: string;
+    id_type: string;
+    is_device_based: boolean;
+    is_experiment_active?: boolean;
+    is_user_in_experiment?: boolean;
+}>;
+export type DynamicConfigEvaluation = ExperimentEvaluation;
+export type LayerEvaluation = Flatten<Omit<ExperimentEvaluation, 'id_type'> & {
+    allocated_experiment_name: string;
+    explicit_parameters: string[];
+    undelegated_secondary_exposures?: SecondaryExposure[];
+}>;
+export type AnyEvaluation = GateEvaluation | ExperimentEvaluation | DynamicConfigEvaluation | LayerEvaluation;
+export type EvaluationDetails = {
+    reason: string;
+    lcut?: number;
+    receivedAt?: number;
+};
+export type DetailedEvaluation<T extends AnyEvaluation> = {
+    evaluation: T | null;
+    details: EvaluationDetails;
+};
+export {};

package/src/EvaluationTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/EventLogger.d.ts

@@ -1,38 +1,43 @@
 import { NetworkCore } from './NetworkCore';
 import { StatsigClientEmitEventFunc } from './StatsigClientBase';
 import { StatsigEventInternal } from './StatsigEvent';
-import { StatsigOptionsCommon } from './StatsigOptionsCommon';
-import { Visibility } from './VisibilityChangeObserver';
+import { NetworkConfigCommon, StatsigOptionsCommon } from './StatsigOptionsCommon';
 export declare class EventLogger {
     private _sdkKey;
     private _emitter;
     private _network;
     private _options;
     private _queue;
-    private _flushTimer;
-    private _lastExposureMap;
+    private _flushIntervalId;
+    private _lastExposureTimeMap;
+    private _nonExposedChecks;
     private _maxQueueSize;
-    private _failedLogs;
     private _hasRunQuickFlush;
     private _creationTime;
-    constructor(_sdkKey: string, _emitter: StatsigClientEmitEventFunc, _network: NetworkCore, _options: StatsigOptionsCommon | null);
+    private _isLoggingDisabled;
+    private _logEventUrl;
+    constructor(_sdkKey: string, _emitter: StatsigClientEmitEventFunc, _network: NetworkCore, _options: StatsigOptionsCommon<NetworkConfigCommon> | null);
+    setLoggingDisabled(isDisabled: boolean): void;
     enqueue(event: StatsigEventInternal): void;
+    incrementNonExposureCount(name: string): void;
     reset(): void;
-    onVisibilityChanged(visibility: Visibility): void;
     shutdown(): Promise<void>;
+    flush(): Promise<void>;
     /**
      * We 'Quick Flush' following the very first event enqueued
      * within the quick flush window
      */
     private _quickFlushIfNeeded;
     private _shouldLogEvent;
-    private _flushAndForget;
-    private _flush;
     private _sendEvents;
     private _sendEventsViaPost;
     private _sendEventsViaBeacon;
-    private _isBeaconSupported;
+    private _getRequestData;
     private _saveFailedLogsToStorage;
     private _retryFailedLogs;
     private _getStorageKey;
+    private _normalizeAndAppendEvent;
+    private _appendAndResetNonExposedChecks;
+    private _getCurrentPageUrl;
+    private _startBackgroundFlushInterval;
 }