@statsig/client-core 0.0.1-beta.3 → 0.0.1-beta.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statsig/client-core",
-  "version": "0.0.1-beta.3",
+  "version": "0.0.1-beta.5",
   "dependencies": {},
   "type": "commonjs",
   "main": "./src/index.js",

package/src/EventLogger.d.ts

@@ -13,11 +13,16 @@ export declare class EventLogger {
     private _lastExposureMap;
     private _maxQueueSize;
     private _failedLogs;
+    private _hasFiredQuickFlush;
     constructor(_sdkKey: string, _emitter: StatsigClientEmitEventFunc, _network: NetworkCore, _options: StatsigOptionsCommon | null);
     enqueue(event: StatsigEventInternal): void;
     reset(): void;
     onVisibilityChanged(visibility: Visibility): void;
     shutdown(): Promise<void>;
+    /**
+     * We 'Quick Flush' following the very first enqueued event
+     */
+    private _quickFlushIfNeeded;
     private _shouldLogEvent;
     private _flushAndForget;
     private _flush;

package/src/EventLogger.js

@@ -70,6 +70,7 @@ var EventLogger = /** @class */ (function () {
         this._options = _options;
         this._queue = [];
         this._lastExposureMap = {};
+        this._hasFiredQuickFlush = false;
         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);
@@ -87,6 +88,7 @@ var EventLogger = /** @class */ (function () {
         }
         var _a = StatsigMetadata_1.StatsigMetadataProvider.get(), sdkType = _a.sdkType, sdkVersion = _a.sdkVersion;
         this._queue.push(__assign(__assign({}, event), { statsigMetadata: { sdkType: sdkType, sdkVersion: sdkVersion } }));
+        this._quickFlushIfNeeded();
         if (this._queue.length > this._maxQueueSize) {
             this._flushAndForget();
         }
@@ -116,6 +118,17 @@ var EventLogger = /** @class */ (function () {
             });
         });
     };
+    /**
+     * We 'Quick Flush' following the very first enqueued event
+     */
+    EventLogger.prototype._quickFlushIfNeeded = function () {
+        var _this = this;
+        if (this._hasFiredQuickFlush) {
+            return;
+        }
+        this._hasFiredQuickFlush = true;
+        setTimeout(function () { return _this._flushAndForget(); }, 200);
+    };
     EventLogger.prototype._shouldLogEvent = function (event) {
         var _a, _b, _c, _d;
         if (!(0, StatsigEvent_1.isExposureEvent)(event)) {
@@ -213,9 +226,9 @@ var EventLogger = /** @class */ (function () {
                             },
                             url: "".concat(api, "/rgstr"),
                             retries: 3,
-                            headers: {
-                                'Content-Type': 'application/json',
-                                'STATSIG-EVENT-COUNT': String(events.length),
+                            params: {
+                                // ec = Event Count
+                                ec: String(events.length),
                             },
                         })];
                     case 1:

package/src/NetworkCore.d.ts

@@ -1,9 +1,11 @@
+import { StatsigClientEmitEventFunc } from './StatsigClientBase';
 import { StatsigOptionsCommon } from './StatsigOptionsCommon';
 type RequestArgs = {
     sdkKey: string;
     url: string;
     timeoutMs?: number;
     retries?: number;
+    params?: Record<string, string>;
     headers?: Record<string, string>;
 };
 type RequestArgsWithData = RequestArgs & {
@@ -11,8 +13,9 @@ type RequestArgsWithData = RequestArgs & {
 };
 export declare class NetworkCore {
     private _options;
+    private _emitter?;
     private readonly _timeout;
-    constructor(_options: StatsigOptionsCommon | null);
+    constructor(_options: StatsigOptionsCommon | null, _emitter?: StatsigClientEmitEventFunc | undefined);
     post(args: RequestArgsWithData): Promise<string | null>;
     get(args: RequestArgs): Promise<string | null>;
     beacon(args: RequestArgsWithData): boolean;

package/src/NetworkCore.js

@@ -79,9 +79,10 @@ var NetworkError = /** @class */ (function (_super) {
     return NetworkError;
 }(Error));
 var NetworkCore = /** @class */ (function () {
-    function NetworkCore(_options) {
+    function NetworkCore(_options, _emitter) {
         var _a;
         this._options = _options;
+        this._emitter = _emitter;
         this._timeout = (_a = _options === null || _options === void 0 ? void 0 : _options.networkTimeoutMs) !== null && _a !== void 0 ? _a : DEFAULT_TIMEOUT_MS;
     }
     NetworkCore.prototype.post = function (args) {
@@ -114,35 +115,33 @@ var NetworkCore = /** @class */ (function () {
         return navigator.sendBeacon(url, JSON.stringify(args.data));
     };
     NetworkCore.prototype._sendRequest = function (args) {
+        var _a;
         return __awaiter(this, void 0, void 0, function () {
             var method, body, retries, controller, handle, response, fullUrl, text, error_1, errorMessage;
             var _this = this;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         method = args.method, body = args.body, retries = args.retries;
                         controller = new AbortController();
                         handle = setTimeout(function () { return controller.abort("Timeout of ".concat(_this._timeout, "ms expired.")); }, this._timeout);
                         response = null;
-                        _a.label = 1;
+                        _b.label = 1;
                     case 1:
-                        _a.trys.push([1, 4, , 5]);
+                        _b.trys.push([1, 4, , 5]);
                         fullUrl = this._getPopulatedURL(args);
                         return [4 /*yield*/, fetch(fullUrl, {
                                 method: method,
                                 body: body,
-                                headers: __assign({ 
-                                    // Must set this content type to bypass cors
-                                    // can override via headers if necessary (recommended for logevent)
-                                    'Content-Type': 'text/plain' }, args.headers),
+                                headers: __assign({}, args.headers),
                                 signal: controller.signal,
                             })];
                     case 2:
-                        response = _a.sent();
+                        response = _b.sent();
                         clearTimeout(handle);
                         return [4 /*yield*/, response.text()];
                     case 3:
-                        text = _a.sent();
+                        text = _b.sent();
                         if (!response.ok) {
                             throw new NetworkError('Fetch Failure', text);
                         }
@@ -152,7 +151,7 @@ var NetworkCore = /** @class */ (function () {
                         });
                         return [2 /*return*/, text];
                     case 4:
-                        error_1 = _a.sent();
+                        error_1 = _b.sent();
                         errorMessage = _getErrorMessage(controller, error_1);
                         Diagnostics_1.Diagnostics.mark('_sendRequest:error', {
                             error: errorMessage,
@@ -160,6 +159,7 @@ var NetworkCore = /** @class */ (function () {
                             contentLength: response === null || response === void 0 ? void 0 : response.headers.get('content-length'),
                         });
                         if (!retries || retries <= 0) {
+                            (_a = this._emitter) === null || _a === void 0 ? void 0 : _a.call(this, { event: 'error', error: error_1 });
                             Log_1.Log.error('A networking error occured.', errorMessage);
                             return [2 /*return*/, null];
                         }
@@ -170,14 +170,20 @@ var NetworkCore = /** @class */ (function () {
         });
     };
     NetworkCore.prototype._getPopulatedURL = function (args) {
-        var statsigMetadata = StatsigMetadata_1.StatsigMetadataProvider.get();
-        var fullUrl = new URL(args.url);
-        fullUrl.searchParams.append('k', args.sdkKey);
-        fullUrl.searchParams.append('st', statsigMetadata.sdkType);
-        fullUrl.searchParams.append('sv', statsigMetadata.sdkVersion);
-        fullUrl.searchParams.append('t', String(Date.now()));
-        fullUrl.searchParams.append('sid', SessionID_1.SessionID.get(args.sdkKey));
-        return fullUrl.toString();
+        var metadata = StatsigMetadata_1.StatsigMetadataProvider.get();
+        var url = new URL(args.url);
+        url.searchParams.append('k', args.sdkKey);
+        url.searchParams.append('st', metadata.sdkType);
+        url.searchParams.append('sv', metadata.sdkVersion);
+        url.searchParams.append('t', String(Date.now()));
+        url.searchParams.append('sid', SessionID_1.SessionID.get(args.sdkKey));
+        if (args.params) {
+            Object.entries(args.params).forEach(function (_a) {
+                var k = _a[0], v = _a[1];
+                url.searchParams.append(k, v);
+            });
+        }
+        return url.toString();
     };
     return NetworkCore;
 }());

package/src/StatsigEvent.d.ts

@@ -1,5 +1,4 @@
-import { DataSource } from './StatsigDataProvider';
-import { DynamicConfig, FeatureGate } from './StatsigTypes';
+import { DynamicConfig, EvaluationDetails, FeatureGate } from './StatsigTypes';
 import { StatsigUser } from './StatsigUser';
 export type SecondaryExposure = {
     gate: string;
@@ -27,5 +26,5 @@ export declare function createLayerParameterExposure(user: StatsigUser, layerNam
     undelegated_secondary_exposures?: SecondaryExposure[];
     secondary_exposures: SecondaryExposure[];
     allocated_experiment_name: string;
-    source: DataSource;
+    details: EvaluationDetails;
 }): StatsigEventInternal;

package/src/StatsigEvent.js

@@ -4,12 +4,12 @@ exports.createLayerParameterExposure = exports.createConfigExposure = exports.cr
 var CONFIG_EXPOSURE_NAME = 'statsig::config_exposure';
 var GATE_EXPOSURE_NAME = 'statsig::gate_exposure';
 var LAYER_EXPOSURE_NAME = 'statsig::layer_exposure';
-function createExposure(eventName, user, metadata, secondaryExposures) {
+function createExposure(eventName, user, details, metadata, secondaryExposures) {
     return {
         eventName: eventName,
         user: user,
         value: null,
-        metadata: metadata,
+        metadata: _addEvaluationDetailsToMetadata(details, metadata),
         secondaryExposures: secondaryExposures,
         time: Date.now(),
     };
@@ -20,19 +20,17 @@ function isExposureEvent(_a) {
 }
 exports.isExposureEvent = isExposureEvent;
 function createGateExposure(user, gate, secondaryExposures) {
-    return createExposure(GATE_EXPOSURE_NAME, user, {
+    return createExposure(GATE_EXPOSURE_NAME, user, gate.details, {
         gate: gate.name,
         gateValue: String(gate.value),
         ruleID: gate.ruleID,
-        reason: gate.source,
     }, secondaryExposures !== null && secondaryExposures !== void 0 ? secondaryExposures : []);
 }
 exports.createGateExposure = createGateExposure;
 function createConfigExposure(user, config, secondaryExposures) {
-    return createExposure(CONFIG_EXPOSURE_NAME, user, {
+    return createExposure(CONFIG_EXPOSURE_NAME, user, config.details, {
         config: config.name,
         ruleID: config.ruleID,
-        reason: config.source,
     }, secondaryExposures !== null && secondaryExposures !== void 0 ? secondaryExposures : []);
 }
 exports.createConfigExposure = createConfigExposure;
@@ -45,13 +43,22 @@ function createLayerParameterExposure(user, layerName, parameterName, spec) {
         allocatedExperiment = spec.allocated_experiment_name;
         secondaryExposures = spec.secondary_exposures;
     }
-    return createExposure(LAYER_EXPOSURE_NAME, user, {
+    return createExposure(LAYER_EXPOSURE_NAME, user, spec.details, {
         config: layerName,
         parameterName: parameterName,
         ruleID: spec.rule_id,
         allocatedExperiment: allocatedExperiment,
         isExplicitParameter: String(isExplicit),
-        reason: spec.source,
     }, secondaryExposures);
 }
 exports.createLayerParameterExposure = createLayerParameterExposure;
+function _addEvaluationDetailsToMetadata(details, metadata) {
+    metadata['reason'] = details.reason;
+    if (details.lcut) {
+        metadata['lcut'] = String(details.lcut);
+    }
+    if (details.receivedAt) {
+        metadata['receivedAt'] = String(details.receivedAt);
+    }
+    return metadata;
+}

package/src/StatsigMetadata.js

@@ -12,7 +12,7 @@ var __assign = (this && this.__assign) || function () {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StatsigMetadataProvider = void 0;
-var SDK_VERSION = '0.0.1-beta.3';
+var SDK_VERSION = '0.0.1-beta.5';
 var metadata = {
     sdkVersion: SDK_VERSION,
     sdkType: 'js-mono', // js-mono is overwritten by Precomp and OnDevice clients

package/src/StatsigTypes.d.ts

@@ -1,10 +1,15 @@
 export type Flatten<T> = {
     [K in keyof T]: T[K];
 } & {};
+export type EvaluationDetails = {
+    reason: string;
+    lcut?: number;
+    receivedAt?: number;
+};
 type EvaluatedSpec = {
     readonly name: string;
     readonly ruleID: string;
-    readonly source: string;
+    readonly details: EvaluationDetails;
 };
 export type FeatureGate = EvaluatedSpec & {
     readonly value: boolean;
@@ -16,7 +21,7 @@ export type Experiment = DynamicConfig;
 export type Layer = EvaluatedSpec & {
     readonly getValue: (parameterName: string) => unknown;
 };
-export declare function makeFeatureGate(name: string, source: string, ruleID?: string, value?: boolean): FeatureGate;
-export declare function makeDynamicConfig(name: string, source: string, ruleID?: string, value?: Record<string, unknown>): DynamicConfig;
-export declare function makeLayer(name: string, source: string, ruleID?: string, getValue?: (param: string) => unknown): Layer;
+export declare function makeFeatureGate(name: string, details: EvaluationDetails, ruleID?: string, value?: boolean): FeatureGate;
+export declare function makeDynamicConfig(name: string, details: EvaluationDetails, ruleID?: string, value?: Record<string, unknown>): DynamicConfig;
+export declare function makeLayer(name: string, details: EvaluationDetails, ruleID?: string, getValue?: (param: string) => unknown): Layer;
 export {};

package/src/StatsigTypes.js

@@ -2,28 +2,28 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeLayer = exports.makeDynamicConfig = exports.makeFeatureGate = void 0;
 var DEFAULT_RULE = 'default';
-function makeFeatureGate(name, source, ruleID, value) {
+function makeFeatureGate(name, details, ruleID, value) {
     return {
         name: name,
-        source: source,
+        details: details,
         ruleID: ruleID !== null && ruleID !== void 0 ? ruleID : DEFAULT_RULE,
         value: value === true,
     };
 }
 exports.makeFeatureGate = makeFeatureGate;
-function makeDynamicConfig(name, source, ruleID, value) {
+function makeDynamicConfig(name, details, ruleID, value) {
     return {
         name: name,
-        source: source,
+        details: details,
         ruleID: ruleID !== null && ruleID !== void 0 ? ruleID : DEFAULT_RULE,
         value: value !== null && value !== void 0 ? value : {},
     };
 }
 exports.makeDynamicConfig = makeDynamicConfig;
-function makeLayer(name, source, ruleID, getValue) {
+function makeLayer(name, details, ruleID, getValue) {
     return {
         name: name,
-        source: source,
+        details: details,
         getValue: getValue !== null && getValue !== void 0 ? getValue : (function () { return undefined; }),
         ruleID: ruleID !== null && ruleID !== void 0 ? ruleID : DEFAULT_RULE,
     };