@statsig/client-core 0.0.1-beta.2 → 0.0.1-beta.21

package/src/EventLogger.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,267 +8,239 @@ 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.EventLogger = void 0;
-var Hashing_1 = require("./Hashing");
-var Log_1 = require("./Log");
-var StatsigEvent_1 = require("./StatsigEvent");
-var StatsigMetadata_1 = require("./StatsigMetadata");
-var StorageProvider_1 = require("./StorageProvider");
-var VisibilityChangeObserver_1 = require("./VisibilityChangeObserver");
-var DEFAULT_QUEUE_SIZE = 50;
-var DEFAULT_FLUSH_INTERVAL_MS = 10000;
-var MAX_DEDUPER_KEYS = 1000;
-var DEDUPER_WINDOW_DURATION_MS = 60000;
-var MAX_FAILED_LOGS = 500;
-var DEFAULT_API = 'https://api.statsig.com/v1';
-var EventLogger = /** @class */ (function () {
-    function EventLogger(_sdkKey, _emitter, _network, _options) {
-        var _this = this;
+const Hashing_1 = require("./Hashing");
+const Log_1 = require("./Log");
+const StatsigEvent_1 = require("./StatsigEvent");
+const StatsigMetadata_1 = require("./StatsigMetadata");
+const StorageProvider_1 = require("./StorageProvider");
+const TypedJsonParse_1 = require("./TypedJsonParse");
+const UrlOverrides_1 = require("./UrlOverrides");
+const VisibilityChangeObserver_1 = require("./VisibilityChangeObserver");
+const DEFAULT_QUEUE_SIZE = 50;
+const DEFAULT_FLUSH_INTERVAL_MS = 10000;
+const MAX_DEDUPER_KEYS = 1000;
+const DEDUPER_WINDOW_DURATION_MS = 60000;
+const MAX_FAILED_LOGS = 500;
+const DEFAULT_API = 'https://api.statsig.com/v1';
+const DEFAULT_ENDPOINT = '/rgstr';
+const DEFAULT_BEACON_ENDPOINT = '/log_event_beacon';
+const QUICK_FLUSH_WINDOW_MS = 200;
+class EventLogger {
+    constructor(_sdkKey, _emitter, _network, _options) {
         var _a, _b;
         this._sdkKey = _sdkKey;
         this._emitter = _emitter;
         this._network = _network;
         this._options = _options;
         this._queue = [];
-        this._lastExposureMap = {};
+        this._lastExposureTimeMap = {};
+        this._nonExposedChecks = {};
+        this._hasRunQuickFlush = false;
+        this._creationTime = Date.now();
+        this._isLoggingDisabled = (_options === null || _options === void 0 ? void 0 : _options.disableLogging) === true;
         this._maxQueueSize = (_a = _options === null || _options === void 0 ? void 0 : _options.loggingBufferMaxSize) !== null && _a !== void 0 ? _a : DEFAULT_QUEUE_SIZE;
-        var flushInterval = (_b = _options === null || _options === void 0 ? void 0 : _options.loggingIntervalMs) !== null && _b !== void 0 ? _b : DEFAULT_FLUSH_INTERVAL_MS;
-        this._flushTimer = setInterval(function () { return _this._flushAndForget(); }, flushInterval);
+        const flushInterval = (_b = _options === null || _options === void 0 ? void 0 : _options.loggingIntervalMs) !== null && _b !== void 0 ? _b : DEFAULT_FLUSH_INTERVAL_MS;
+        this._flushTimer = setInterval(() => this._flushAndForget(), flushInterval);
+        this._logEventUrl = (0, UrlOverrides_1._getOverridableUrl)(_options === null || _options === void 0 ? void 0 : _options.logEventUrl, _options === null || _options === void 0 ? void 0 : _options.api, DEFAULT_ENDPOINT, DEFAULT_API);
+        this._logEventBeaconUrl = (0, UrlOverrides_1._getOverridableUrl)(_options === null || _options === void 0 ? void 0 : _options.logEventBeaconUrl, _options === null || _options === void 0 ? void 0 : _options.api, DEFAULT_BEACON_ENDPOINT, DEFAULT_API);
         VisibilityChangeObserver_1.VisibilityChangeObserver.add(this);
-        this._failedLogs = [];
         this._retryFailedLogs();
     }
-    EventLogger.prototype.enqueue = function (event) {
+    setLoggingDisabled(isDisabled) {
+        this._isLoggingDisabled = isDisabled;
+    }
+    enqueue(event) {
         if (!this._shouldLogEvent(event)) {
             return;
         }
-        if (event.user) {
-            event.user = __assign({}, event.user);
-            delete event.user.privateAttributes;
-        }
-        var _a = StatsigMetadata_1.StatsigMetadataProvider.get(), sdkType = _a.sdkType, sdkVersion = _a.sdkVersion;
-        this._queue.push(__assign(__assign({}, event), { statsigMetadata: { sdkType: sdkType, sdkVersion: sdkVersion } }));
+        this._normalizeAndAppendEvent(event);
+        this._quickFlushIfNeeded();
         if (this._queue.length > this._maxQueueSize) {
             this._flushAndForget();
         }
-    };
-    EventLogger.prototype.reset = function () {
-        this._lastExposureMap = {};
-    };
-    EventLogger.prototype.onVisibilityChanged = function (visibility) {
+    }
+    incrementNonExposureCount(name) {
+        var _a;
+        const current = (_a = this._nonExposedChecks[name]) !== null && _a !== void 0 ? _a : 0;
+        this._nonExposedChecks[name] = current + 1;
+    }
+    reset() {
+        this._lastExposureTimeMap = {};
+    }
+    onVisibilityChanged(visibility) {
         if (visibility === 'background') {
             this._flushAndForget();
         }
-    };
-    EventLogger.prototype.shutdown = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (this._flushTimer) {
-                            clearInterval(this._flushTimer);
-                            this._flushTimer = null;
-                        }
-                        return [4 /*yield*/, this._flush()];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
-            });
+    }
+    shutdown() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._flushTimer) {
+                clearInterval(this._flushTimer);
+                this._flushTimer = null;
+            }
+            yield this.flush();
+        });
+    }
+    flush() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this._appendAndResetNonExposedChecks();
+            if (this._queue.length === 0) {
+                return;
+            }
+            const events = this._queue;
+            this._queue = [];
+            yield this._sendEvents(events);
         });
-    };
-    EventLogger.prototype._shouldLogEvent = function (event) {
+    }
+    /**
+     * We 'Quick Flush' following the very first event enqueued
+     * within the quick flush window
+     */
+    _quickFlushIfNeeded() {
+        if (this._hasRunQuickFlush) {
+            return;
+        }
+        this._hasRunQuickFlush = true;
+        if (Date.now() - this._creationTime > QUICK_FLUSH_WINDOW_MS) {
+            return;
+        }
+        setTimeout(() => this._flushAndForget(), QUICK_FLUSH_WINDOW_MS);
+    }
+    _shouldLogEvent(event) {
         var _a, _b, _c, _d;
         if (!(0, StatsigEvent_1.isExposureEvent)(event)) {
             return true;
         }
-        var key = [
+        const key = [
             event.eventName,
             (_a = event.user) === null || _a === void 0 ? void 0 : _a.userID,
             (_b = event.metadata) === null || _b === void 0 ? void 0 : _b['gate'],
             (_c = event.metadata) === null || _c === void 0 ? void 0 : _c['config'],
             (_d = event.metadata) === null || _d === void 0 ? void 0 : _d['ruleID'],
         ].join('|');
-        var previous = this._lastExposureMap[key];
-        var now = Date.now();
+        const previous = this._lastExposureTimeMap[key];
+        const now = Date.now();
         if (previous && now - previous < DEDUPER_WINDOW_DURATION_MS) {
             return false;
         }
-        if (Object.keys(this._lastExposureMap).length > MAX_DEDUPER_KEYS) {
-            this._lastExposureMap = {};
+        if (Object.keys(this._lastExposureTimeMap).length > MAX_DEDUPER_KEYS) {
+            this._lastExposureTimeMap = {};
         }
-        this._lastExposureMap[key] = now;
+        this._lastExposureTimeMap[key] = now;
         return true;
-    };
-    EventLogger.prototype._flushAndForget = function () {
-        this._flush().catch(function () {
+    }
+    _flushAndForget() {
+        this.flush().catch(() => {
             // noop
         });
-    };
-    EventLogger.prototype._flush = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var events;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (this._queue.length === 0) {
-                            return [2 /*return*/];
-                        }
-                        events = this._queue;
-                        this._queue = [];
-                        return [4 /*yield*/, this._sendEvents(events)];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    EventLogger.prototype._sendEvents = function (events) {
-        var _a, _b;
-        return __awaiter(this, void 0, void 0, function () {
-            var isInForeground, api, response, _c, _d;
-            return __generator(this, function (_e) {
-                switch (_e.label) {
-                    case 0:
-                        _e.trys.push([0, 4, , 5]);
-                        isInForeground = VisibilityChangeObserver_1.VisibilityChangeObserver.isCurrentlyVisible();
-                        api = (_b = (_a = this._options) === null || _a === void 0 ? void 0 : _a.api) !== null && _b !== void 0 ? _b : DEFAULT_API;
-                        if (!(!isInForeground && this._isBeaconSupported())) return [3 /*break*/, 1];
-                        _c = this._sendEventsViaBeacon(api, events);
-                        return [3 /*break*/, 3];
-                    case 1: return [4 /*yield*/, this._sendEventsViaPost(api, events)];
-                    case 2:
-                        _c = _e.sent();
-                        _e.label = 3;
-                    case 3:
-                        response = _c;
-                        if (response.success) {
-                            this._emitter({
-                                event: 'logs_flushed',
-                                events: events,
-                            });
-                        }
-                        else {
-                            this._saveFailedLogsToStorage(events);
-                        }
-                        return [3 /*break*/, 5];
-                    case 4:
-                        _d = _e.sent();
-                        Log_1.Log.warn('Failed to flush events.');
-                        return [3 /*break*/, 5];
-                    case 5: return [2 /*return*/];
+    }
+    _sendEvents(events) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this._isLoggingDisabled) {
+                this._saveFailedLogsToStorage(events);
+                return;
+            }
+            try {
+                const isInForeground = VisibilityChangeObserver_1.VisibilityChangeObserver.isCurrentlyVisible();
+                const response = !isInForeground && this._network.isBeaconSupported()
+                    ? yield this._sendEventsViaBeacon(events)
+                    : yield this._sendEventsViaPost(events);
+                if (response.success) {
+                    this._emitter({
+                        name: 'logs_flushed',
+                        events,
+                    });
                 }
-            });
-        });
-    };
-    EventLogger.prototype._sendEventsViaPost = function (api, events) {
-        return __awaiter(this, void 0, void 0, function () {
-            var result;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this._network.post({
-                            sdkKey: this._sdkKey,
-                            data: {
-                                events: events,
-                            },
-                            url: "".concat(api, "/rgstr"),
-                            retries: 3,
-                            headers: {
-                                'Content-Type': 'application/json',
-                                'STATSIG-EVENT-COUNT': String(events.length),
-                            },
-                        })];
-                    case 1:
-                        result = _a.sent();
-                        if (result) {
-                            return [2 /*return*/, JSON.parse(result)];
-                        }
-                        return [2 /*return*/, { success: false }];
+                else {
+                    this._saveFailedLogsToStorage(events);
                 }
-            });
+            }
+            catch (_a) {
+                Log_1.Log.warn('Failed to flush events.');
+            }
         });
-    };
-    EventLogger.prototype._sendEventsViaBeacon = function (api, events) {
-        return {
-            success: this._network.beacon({
+    }
+    _sendEventsViaPost(events) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this._network.post({
                 sdkKey: this._sdkKey,
                 data: {
-                    events: events,
+                    events,
                 },
-                url: "".concat(api, "/log_event_beacon"),
-            }),
-        };
-    };
-    EventLogger.prototype._isBeaconSupported = function () {
-        return (typeof navigator !== 'undefined' &&
-            typeof (navigator === null || navigator === void 0 ? void 0 : navigator.sendBeacon) === 'function');
-    };
-    EventLogger.prototype._saveFailedLogsToStorage = function (events) {
-        var _a;
-        (_a = this._failedLogs).push.apply(_a, events);
-        while (this._failedLogs.length > MAX_FAILED_LOGS) {
-            this._failedLogs.shift();
+                url: this._logEventUrl,
+                retries: 3,
+                params: {
+                    // ec = Event Count
+                    ec: String(events.length),
+                },
+            });
+            const response = (result === null || result === void 0 ? void 0 : result.body)
+                ? (0, TypedJsonParse_1.typedJsonParse)(result.body, 'success', 'Failed to parse SendEventsResponse')
+                : null;
+            return { success: (response === null || response === void 0 ? void 0 : response.success) === true };
+        });
+    }
+    _sendEventsViaBeacon(events) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return {
+                success: yield this._network.beacon({
+                    sdkKey: this._sdkKey,
+                    data: {
+                        events,
+                    },
+                    url: this._logEventBeaconUrl,
+                }),
+            };
+        });
+    }
+    _saveFailedLogsToStorage(events) {
+        while (events.length > MAX_FAILED_LOGS) {
+            events.shift();
         }
-        var storageKey = this._getStorageKey();
-        (0, StorageProvider_1.setObjectInStorage)(storageKey, this._failedLogs).catch(function () {
+        const storageKey = this._getStorageKey();
+        (0, StorageProvider_1.setObjectInStorage)(storageKey, events).catch(() => {
             Log_1.Log.warn('Unable to save failed logs to storage');
         });
-    };
-    EventLogger.prototype._retryFailedLogs = function () {
-        var _this = this;
-        var storageKey = this._getStorageKey();
-        (function () { return __awaiter(_this, void 0, void 0, function () {
-            var events;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, StorageProvider_1.getObjectFromStorage)(storageKey)];
-                    case 1:
-                        events = _a.sent();
-                        if (!events) {
-                            return [2 /*return*/];
-                        }
-                        return [4 /*yield*/, this._sendEvents(events)];
-                    case 2:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
-            });
-        }); })().catch(function () {
-            Log_1.Log.warn('Unable to flush stored logs');
+    }
+    _retryFailedLogs() {
+        const storageKey = this._getStorageKey();
+        (() => __awaiter(this, void 0, void 0, function* () {
+            const events = yield (0, StorageProvider_1.getObjectFromStorage)(storageKey);
+            if (!events) {
+                return;
+            }
+            yield StorageProvider_1.Storage.removeItem(storageKey);
+            yield this._sendEvents(events);
+        }))().catch(() => {
+            Log_1.Log.warn('Failed to flush stored logs');
         });
-    };
-    EventLogger.prototype._getStorageKey = function () {
-        return "STATSIG_FAILED_LOG:".concat((0, Hashing_1.DJB2)(this._sdkKey));
-    };
-    return EventLogger;
-}());
+    }
+    _getStorageKey() {
+        return `statsig.failed_logs.${(0, Hashing_1.DJB2)(this._sdkKey)}`;
+    }
+    _normalizeAndAppendEvent(event) {
+        if (event.user) {
+            event.user = Object.assign({}, event.user);
+            delete event.user.privateAttributes;
+        }
+        const { sdkType, sdkVersion } = StatsigMetadata_1.StatsigMetadataProvider.get();
+        this._queue.push(Object.assign(Object.assign({}, event), { statsigMetadata: { sdkType, sdkVersion } }));
+    }
+    _appendAndResetNonExposedChecks() {
+        if (Object.keys(this._nonExposedChecks).length === 0) {
+            return;
+        }
+        this._normalizeAndAppendEvent({
+            eventName: 'statsig::non_exposed_checks',
+            user: null,
+            time: Date.now(),
+            metadata: {
+                checks: Object.assign({}, this._nonExposedChecks),
+            },
+        });
+        this._nonExposedChecks = {};
+    }
+}
 exports.EventLogger = EventLogger;

package/src/Hashing.d.ts

@@ -1 +1,2 @@
 export declare function DJB2(value: string): string;
+export declare function DJB2Object(value: Record<string, unknown> | null): string;

package/src/Hashing.js

@@ -1,13 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DJB2 = void 0;
+exports.DJB2Object = exports.DJB2 = void 0;
 function DJB2(value) {
-    var hash = 0;
-    for (var i = 0; i < value.length; i++) {
-        var character = value.charCodeAt(i);
+    let hash = 0;
+    for (let i = 0; i < value.length; i++) {
+        const character = value.charCodeAt(i);
         hash = (hash << 5) - hash + character;
         hash = hash & hash; // Convert to 32bit integer
     }
     return String(hash >>> 0);
 }
 exports.DJB2 = DJB2;
+function DJB2Object(value) {
+    return DJB2(JSON.stringify(_getSortedObject(value)));
+}
+exports.DJB2Object = DJB2Object;
+function _getSortedObject(object) {
+    if (object == null) {
+        return null;
+    }
+    const keys = Object.keys(object).sort();
+    const sortedObject = {};
+    keys.forEach((key) => {
+        let value = object[key];
+        if (value instanceof Object) {
+            value = _getSortedObject(value);
+        }
+        sortedObject[key] = value;
+    });
+    return sortedObject;
+}

package/src/Log.js

@@ -14,46 +14,27 @@ var LogLevel;
     LogLevel[LogLevel["Info"] = 3] = "Info";
     LogLevel[LogLevel["Debug"] = 4] = "Debug";
 })(LogLevel || (exports.LogLevel = LogLevel = {}));
-var Log = /** @class */ (function () {
-    function Log() {
-    }
-    Log.info = function () {
-        var args = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            args[_i] = arguments[_i];
-        }
+class Log {
+    static info(...args) {
         if (this.level >= LogLevel.Info) {
-            console.info.apply(console, addTag(args));
-        }
-    };
-    Log.debug = function () {
-        var args = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            args[_i] = arguments[_i];
+            console.info(...addTag(args));
         }
+    }
+    static debug(...args) {
         if (this.level >= LogLevel.Debug) {
-            console.debug.apply(console, addTag(args));
-        }
-    };
-    Log.warn = function () {
-        var args = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            args[_i] = arguments[_i];
+            console.debug(...addTag(args));
         }
+    }
+    static warn(...args) {
         if (this.level >= LogLevel.Warn) {
-            console.warn.apply(console, addTag(args));
-        }
-    };
-    Log.error = function () {
-        var args = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            args[_i] = arguments[_i];
+            console.warn(...addTag(args));
         }
+    }
+    static error(...args) {
         if (this.level >= LogLevel.Error) {
-            console.error.apply(console, addTag(args));
+            console.error(...addTag(args));
         }
-    };
-    Log.level = LogLevel.Error;
-    return Log;
-}());
+    }
+}
 exports.Log = Log;
+Log.level = LogLevel.Error;

package/src/Monitoring.d.ts

@@ -1,3 +1,2 @@
 import { ErrorBoundary } from './ErrorBoundary';
-export declare function monitorClass<T extends new (...args: any[]) => any>(errorBoundary: ErrorBoundary, target: T, instance: unknown): void;
-export declare function monitorFunction<T>(errorBoundary: ErrorBoundary, tag: string, func: () => T, instance: unknown): T;
+export declare function monitorClass(errorBoundary: ErrorBoundary, instance: object): void;