@rolloutctrl/js-sdk 0.0.8 → 0.0.9

package/dist/index.d.mts

@@ -32,6 +32,14 @@ interface MetricEvent {
     strategyId?: string;
     variantId?: string;
 }
+interface AggregatedMetric {
+    type: MetricType;
+    featureFlagEnvironmentId: string;
+    featureFlagId?: string;
+    strategyId?: string;
+    variantId?: string;
+    count: number;
+}
 interface RolloutCtrlOptions {
     sdkKey: string;
     environment: string;
@@ -54,10 +62,9 @@ declare class RolloutCtrlClient {
     private readonly repository;
     private readonly evaluatorManager;
     private readonly updateProvider;
-    private readonly metricsQueue;
+    private readonly metricAggregator;
     private readonly subscribers;
     private isInitialized;
-    private readonly trackedEvaluations;
     private readonly readyPromise;
     private resolveReady;
     private rejectReady;
@@ -144,19 +151,20 @@ declare class LocalStorageAdapter implements StorageAdapter {
     clear(): Promise<void>;
 }
 
-declare class MetricsQueue {
+type TrackInput = Omit<AggregatedMetric, 'count'>;
+declare class MetricAggregator {
     private readonly apiUrl;
     private readonly sdkKey;
     private readonly requestTimeout;
-    private queue;
+    private readonly metrics;
     private flushTimer;
-    constructor(apiUrl: string, sdkKey: string, requestTimeout: number);
+    private readonly maxMetricKeys;
+    constructor(apiUrl: string, sdkKey: string, requestTimeout: number, maxMetricKeys?: number);
     start(): void;
     stop(): void;
-    push(event: MetricEvent): void;
+    track(metric: TrackInput): void;
     flush(): Promise<void>;
-    private flushWithRetry;
-    private sendBatch;
+    private send;
 }
 
-export { type Configuration, type ConfigurationRepository, type Evaluator, EvaluatorManager, type FlagConfig, HttpConfigurationRepository, LocalStorageAdapter, type MetricEvent, type MetricType, MetricsQueue, PollingUpdateProvider, RolloutCtrlClient, type RolloutCtrlOptions, SseUpdateProvider, type StorageAdapter, type UpdateProvider, type VariantResult, createEvaluator };
+export { type AggregatedMetric, type Configuration, type ConfigurationRepository, type Evaluator, EvaluatorManager, type FlagConfig, HttpConfigurationRepository, LocalStorageAdapter, MetricAggregator, type MetricEvent, type MetricType, PollingUpdateProvider, RolloutCtrlClient, type RolloutCtrlOptions, SseUpdateProvider, type StorageAdapter, type UpdateProvider, type VariantResult, createEvaluator };

package/dist/index.d.ts

@@ -32,6 +32,14 @@ interface MetricEvent {
     strategyId?: string;
     variantId?: string;
 }
+interface AggregatedMetric {
+    type: MetricType;
+    featureFlagEnvironmentId: string;
+    featureFlagId?: string;
+    strategyId?: string;
+    variantId?: string;
+    count: number;
+}
 interface RolloutCtrlOptions {
     sdkKey: string;
     environment: string;
@@ -54,10 +62,9 @@ declare class RolloutCtrlClient {
     private readonly repository;
     private readonly evaluatorManager;
     private readonly updateProvider;
-    private readonly metricsQueue;
+    private readonly metricAggregator;
     private readonly subscribers;
     private isInitialized;
-    private readonly trackedEvaluations;
     private readonly readyPromise;
     private resolveReady;
     private rejectReady;
@@ -144,19 +151,20 @@ declare class LocalStorageAdapter implements StorageAdapter {
     clear(): Promise<void>;
 }
 
-declare class MetricsQueue {
+type TrackInput = Omit<AggregatedMetric, 'count'>;
+declare class MetricAggregator {
     private readonly apiUrl;
     private readonly sdkKey;
     private readonly requestTimeout;
-    private queue;
+    private readonly metrics;
     private flushTimer;
-    constructor(apiUrl: string, sdkKey: string, requestTimeout: number);
+    private readonly maxMetricKeys;
+    constructor(apiUrl: string, sdkKey: string, requestTimeout: number, maxMetricKeys?: number);
     start(): void;
     stop(): void;
-    push(event: MetricEvent): void;
+    track(metric: TrackInput): void;
     flush(): Promise<void>;
-    private flushWithRetry;
-    private sendBatch;
+    private send;
 }
 
-export { type Configuration, type ConfigurationRepository, type Evaluator, EvaluatorManager, type FlagConfig, HttpConfigurationRepository, LocalStorageAdapter, type MetricEvent, type MetricType, MetricsQueue, PollingUpdateProvider, RolloutCtrlClient, type RolloutCtrlOptions, SseUpdateProvider, type StorageAdapter, type UpdateProvider, type VariantResult, createEvaluator };
+export { type AggregatedMetric, type Configuration, type ConfigurationRepository, type Evaluator, EvaluatorManager, type FlagConfig, HttpConfigurationRepository, LocalStorageAdapter, MetricAggregator, type MetricEvent, type MetricType, PollingUpdateProvider, RolloutCtrlClient, type RolloutCtrlOptions, SseUpdateProvider, type StorageAdapter, type UpdateProvider, type VariantResult, createEvaluator };

package/dist/index.js

@@ -23,7 +23,7 @@ __export(index_exports, {
   EvaluatorManager: () => EvaluatorManager,
   HttpConfigurationRepository: () => HttpConfigurationRepository,
   LocalStorageAdapter: () => LocalStorageAdapter,
-  MetricsQueue: () => MetricsQueue,
+  MetricAggregator: () => MetricAggregator,
   PollingUpdateProvider: () => PollingUpdateProvider,
   RolloutCtrlClient: () => RolloutCtrlClient,
   SseUpdateProvider: () => SseUpdateProvider,
@@ -259,15 +259,15 @@ var SseUpdateProvider = class {
 
 // src/metrics.ts
 var FLUSH_INTERVAL_MS = 3e4;
-var FLUSH_BATCH_SIZE = 100;
-var MAX_RETRIES = 3;
-var MetricsQueue = class {
-  constructor(apiUrl, sdkKey, requestTimeout) {
+var DEFAULT_MAX_METRIC_KEYS = 1e3;
+var MetricAggregator = class {
+  constructor(apiUrl, sdkKey, requestTimeout, maxMetricKeys = DEFAULT_MAX_METRIC_KEYS) {
     this.apiUrl = apiUrl;
     this.sdkKey = sdkKey;
     this.requestTimeout = requestTimeout;
-    this.queue = [];
+    this.metrics = /* @__PURE__ */ new Map();
     this.flushTimer = null;
+    this.maxMetricKeys = maxMetricKeys;
   }
   start() {
     this.flushTimer = setInterval(() => {
@@ -281,29 +281,38 @@ var MetricsQueue = class {
       this.flushTimer = null;
     }
   }
-  push(event) {
-    this.queue.push(event);
-    if (this.queue.length >= FLUSH_BATCH_SIZE) {
+  track(metric) {
+    const key = `${metric.type}:${metric.featureFlagEnvironmentId}:${metric.featureFlagId ?? ""}:${metric.strategyId ?? ""}:${metric.variantId ?? ""}`;
+    const existing = this.metrics.get(key);
+    if (existing) {
+      existing.count++;
+      return;
+    }
+    if (this.metrics.size >= this.maxMetricKeys) return;
+    this.metrics.set(key, { ...metric, count: 1 });
+    if (this.metrics.size >= this.maxMetricKeys) {
       this.flush().catch(() => {
       });
     }
   }
   async flush() {
-    await this.flushWithRetry(0);
-  }
-  async flushWithRetry(attempt) {
-    if (this.queue.length === 0) return;
-    const batch = this.queue.splice(0, this.queue.length);
+    if (this.metrics.size === 0) return;
+    const snapshot = new Map(this.metrics);
+    this.metrics.clear();
     try {
-      await this.sendBatch(batch);
+      await this.send([...snapshot.values()]);
     } catch {
-      if (attempt < MAX_RETRIES) {
-        this.queue.unshift(...batch);
-        await this.flushWithRetry(attempt + 1);
+      for (const [key, metric] of snapshot) {
+        const current = this.metrics.get(key);
+        if (current) {
+          current.count += metric.count;
+        } else {
+          this.metrics.set(key, { ...metric });
+        }
       }
     }
   }
-  async sendBatch(events) {
+  async send(metrics) {
     const controller = new AbortController();
     const timeout = setTimeout(() => controller.abort(), this.requestTimeout);
     try {
@@ -313,7 +322,7 @@ var MetricsQueue = class {
           "x-api-key": this.sdkKey,
           "Content-Type": "application/json"
         },
-        body: JSON.stringify({ events }),
+        body: JSON.stringify({ metrics }),
         signal: controller.signal
       });
       if (!response.ok) {
@@ -334,17 +343,15 @@ var RolloutCtrlClient = class {
     this.emitter = new TinyEmitter();
     this.subscribers = /* @__PURE__ */ new Set();
     this.isInitialized = false;
-    this.trackedEvaluations = /* @__PURE__ */ new Map();
     const apiUrl = options.apiUrl ?? DEFAULT_API_URL;
     const refreshInterval = options.refreshInterval ?? DEFAULT_REFRESH_INTERVAL;
     const requestTimeout = options.requestTimeout ?? DEFAULT_REQUEST_TIMEOUT;
     this.repository = new HttpConfigurationRepository(apiUrl, options.sdkKey, options.environment, requestTimeout);
     this.evaluatorManager = new EvaluatorManager();
     this.updateProvider = new PollingUpdateProvider(refreshInterval);
-    this.metricsQueue = options.enableMetrics ?? true ? new MetricsQueue(apiUrl, options.sdkKey, requestTimeout) : null;
+    this.metricAggregator = options.enableMetrics ?? true ? new MetricAggregator(apiUrl, options.sdkKey, requestTimeout) : null;
     this.repository.subscribe((configuration) => {
       this.evaluatorManager.update(configuration);
-      this.trackedEvaluations.clear();
       options.storage?.set(configuration).catch(() => {
       });
       if (this.isInitialized) {
@@ -379,7 +386,7 @@ var RolloutCtrlClient = class {
       this.updateProvider.start(() => {
         void this.repository.refresh();
       });
-      this.metricsQueue?.start();
+      this.metricAggregator?.start();
       this.emitter.emit("ready");
       this.resolveReady();
     } catch (error) {
@@ -401,9 +408,9 @@ var RolloutCtrlClient = class {
   }
   async close() {
     this.updateProvider.stop();
-    if (this.metricsQueue) {
-      this.metricsQueue.stop();
-      await this.metricsQueue.flush();
+    if (this.metricAggregator) {
+      this.metricAggregator.stop();
+      await this.metricAggregator.flush();
     }
     this.subscribers.clear();
     this.emitter.emit("shutdown");
@@ -436,29 +443,26 @@ var RolloutCtrlClient = class {
     return this.evaluate(flagKey, context).variant;
   }
   trackEvaluation(flagKey, result) {
-    if (!this.metricsQueue || !this.isInitialized) return;
+    if (!this.metricAggregator || !this.isInitialized) return;
     try {
       const config = this.repository.getConfiguration();
       const flag = config.flags.find((f) => f.key === flagKey);
       if (!flag) return;
-      const fingerprint = `${result.enabled ? 1 : 0}:${result.strategy?.id ?? ""}:${result.variant?.id ?? ""}`;
-      if (this.trackedEvaluations.get(flagKey) === fingerprint) return;
-      this.trackedEvaluations.set(flagKey, fingerprint);
       const base = {
         featureFlagId: flag.id,
         featureFlagEnvironmentId: flag.featureFlagEnvironmentId
       };
-      this.metricsQueue.push({ ...base, type: "FLAG_EVALUATION" });
+      this.metricAggregator.track({ ...base, type: "FLAG_EVALUATION" });
       if (result.enabled) {
-        this.metricsQueue.push({ ...base, type: "FLAG_ENABLED" });
+        this.metricAggregator.track({ ...base, type: "FLAG_ENABLED" });
         if (result.strategy?.id) {
-          this.metricsQueue.push({ ...base, type: "STRATEGY_MATCH", strategyId: result.strategy.id });
+          this.metricAggregator.track({ ...base, type: "STRATEGY_MATCH", strategyId: result.strategy.id });
         }
         if (result.variant?.id) {
-          this.metricsQueue.push({ ...base, type: "VARIANT_EXPOSURE", variantId: result.variant.id });
+          this.metricAggregator.track({ ...base, type: "VARIANT_EXPOSURE", variantId: result.variant.id });
         }
       } else {
-        this.metricsQueue.push({ ...base, type: "FLAG_DISABLED" });
+        this.metricAggregator.track({ ...base, type: "FLAG_DISABLED" });
       }
     } catch {
     }
@@ -501,7 +505,7 @@ var LocalStorageAdapter = class {
   EvaluatorManager,
   HttpConfigurationRepository,
   LocalStorageAdapter,
-  MetricsQueue,
+  MetricAggregator,
   PollingUpdateProvider,
   RolloutCtrlClient,
   SseUpdateProvider,

package/dist/index.mjs

@@ -230,15 +230,15 @@ var SseUpdateProvider = class {
 
 // src/metrics.ts
 var FLUSH_INTERVAL_MS = 3e4;
-var FLUSH_BATCH_SIZE = 100;
-var MAX_RETRIES = 3;
-var MetricsQueue = class {
-  constructor(apiUrl, sdkKey, requestTimeout) {
+var DEFAULT_MAX_METRIC_KEYS = 1e3;
+var MetricAggregator = class {
+  constructor(apiUrl, sdkKey, requestTimeout, maxMetricKeys = DEFAULT_MAX_METRIC_KEYS) {
     this.apiUrl = apiUrl;
     this.sdkKey = sdkKey;
     this.requestTimeout = requestTimeout;
-    this.queue = [];
+    this.metrics = /* @__PURE__ */ new Map();
     this.flushTimer = null;
+    this.maxMetricKeys = maxMetricKeys;
   }
   start() {
     this.flushTimer = setInterval(() => {
@@ -252,29 +252,38 @@ var MetricsQueue = class {
       this.flushTimer = null;
     }
   }
-  push(event) {
-    this.queue.push(event);
-    if (this.queue.length >= FLUSH_BATCH_SIZE) {
+  track(metric) {
+    const key = `${metric.type}:${metric.featureFlagEnvironmentId}:${metric.featureFlagId ?? ""}:${metric.strategyId ?? ""}:${metric.variantId ?? ""}`;
+    const existing = this.metrics.get(key);
+    if (existing) {
+      existing.count++;
+      return;
+    }
+    if (this.metrics.size >= this.maxMetricKeys) return;
+    this.metrics.set(key, { ...metric, count: 1 });
+    if (this.metrics.size >= this.maxMetricKeys) {
       this.flush().catch(() => {
       });
     }
   }
   async flush() {
-    await this.flushWithRetry(0);
-  }
-  async flushWithRetry(attempt) {
-    if (this.queue.length === 0) return;
-    const batch = this.queue.splice(0, this.queue.length);
+    if (this.metrics.size === 0) return;
+    const snapshot = new Map(this.metrics);
+    this.metrics.clear();
     try {
-      await this.sendBatch(batch);
+      await this.send([...snapshot.values()]);
     } catch {
-      if (attempt < MAX_RETRIES) {
-        this.queue.unshift(...batch);
-        await this.flushWithRetry(attempt + 1);
+      for (const [key, metric] of snapshot) {
+        const current = this.metrics.get(key);
+        if (current) {
+          current.count += metric.count;
+        } else {
+          this.metrics.set(key, { ...metric });
+        }
       }
     }
   }
-  async sendBatch(events) {
+  async send(metrics) {
     const controller = new AbortController();
     const timeout = setTimeout(() => controller.abort(), this.requestTimeout);
     try {
@@ -284,7 +293,7 @@ var MetricsQueue = class {
           "x-api-key": this.sdkKey,
           "Content-Type": "application/json"
         },
-        body: JSON.stringify({ events }),
+        body: JSON.stringify({ metrics }),
         signal: controller.signal
       });
       if (!response.ok) {
@@ -305,17 +314,15 @@ var RolloutCtrlClient = class {
     this.emitter = new TinyEmitter();
     this.subscribers = /* @__PURE__ */ new Set();
     this.isInitialized = false;
-    this.trackedEvaluations = /* @__PURE__ */ new Map();
     const apiUrl = options.apiUrl ?? DEFAULT_API_URL;
     const refreshInterval = options.refreshInterval ?? DEFAULT_REFRESH_INTERVAL;
     const requestTimeout = options.requestTimeout ?? DEFAULT_REQUEST_TIMEOUT;
     this.repository = new HttpConfigurationRepository(apiUrl, options.sdkKey, options.environment, requestTimeout);
     this.evaluatorManager = new EvaluatorManager();
     this.updateProvider = new PollingUpdateProvider(refreshInterval);
-    this.metricsQueue = options.enableMetrics ?? true ? new MetricsQueue(apiUrl, options.sdkKey, requestTimeout) : null;
+    this.metricAggregator = options.enableMetrics ?? true ? new MetricAggregator(apiUrl, options.sdkKey, requestTimeout) : null;
     this.repository.subscribe((configuration) => {
       this.evaluatorManager.update(configuration);
-      this.trackedEvaluations.clear();
       options.storage?.set(configuration).catch(() => {
       });
       if (this.isInitialized) {
@@ -350,7 +357,7 @@ var RolloutCtrlClient = class {
       this.updateProvider.start(() => {
         void this.repository.refresh();
       });
-      this.metricsQueue?.start();
+      this.metricAggregator?.start();
       this.emitter.emit("ready");
       this.resolveReady();
     } catch (error) {
@@ -372,9 +379,9 @@ var RolloutCtrlClient = class {
   }
   async close() {
     this.updateProvider.stop();
-    if (this.metricsQueue) {
-      this.metricsQueue.stop();
-      await this.metricsQueue.flush();
+    if (this.metricAggregator) {
+      this.metricAggregator.stop();
+      await this.metricAggregator.flush();
     }
     this.subscribers.clear();
     this.emitter.emit("shutdown");
@@ -407,29 +414,26 @@ var RolloutCtrlClient = class {
     return this.evaluate(flagKey, context).variant;
   }
   trackEvaluation(flagKey, result) {
-    if (!this.metricsQueue || !this.isInitialized) return;
+    if (!this.metricAggregator || !this.isInitialized) return;
     try {
       const config = this.repository.getConfiguration();
       const flag = config.flags.find((f) => f.key === flagKey);
       if (!flag) return;
-      const fingerprint = `${result.enabled ? 1 : 0}:${result.strategy?.id ?? ""}:${result.variant?.id ?? ""}`;
-      if (this.trackedEvaluations.get(flagKey) === fingerprint) return;
-      this.trackedEvaluations.set(flagKey, fingerprint);
       const base = {
         featureFlagId: flag.id,
         featureFlagEnvironmentId: flag.featureFlagEnvironmentId
       };
-      this.metricsQueue.push({ ...base, type: "FLAG_EVALUATION" });
+      this.metricAggregator.track({ ...base, type: "FLAG_EVALUATION" });
       if (result.enabled) {
-        this.metricsQueue.push({ ...base, type: "FLAG_ENABLED" });
+        this.metricAggregator.track({ ...base, type: "FLAG_ENABLED" });
         if (result.strategy?.id) {
-          this.metricsQueue.push({ ...base, type: "STRATEGY_MATCH", strategyId: result.strategy.id });
+          this.metricAggregator.track({ ...base, type: "STRATEGY_MATCH", strategyId: result.strategy.id });
         }
         if (result.variant?.id) {
-          this.metricsQueue.push({ ...base, type: "VARIANT_EXPOSURE", variantId: result.variant.id });
+          this.metricAggregator.track({ ...base, type: "VARIANT_EXPOSURE", variantId: result.variant.id });
         }
       } else {
-        this.metricsQueue.push({ ...base, type: "FLAG_DISABLED" });
+        this.metricAggregator.track({ ...base, type: "FLAG_DISABLED" });
       }
     } catch {
     }
@@ -471,7 +475,7 @@ export {
   EvaluatorManager,
   HttpConfigurationRepository,
   LocalStorageAdapter,
-  MetricsQueue,
+  MetricAggregator,
   PollingUpdateProvider,
   RolloutCtrlClient,
   SseUpdateProvider,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rolloutctrl/js-sdk",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "RolloutCtrl JavaScript SDK for browser applications",
   "license": "MIT",
   "main": "./dist/index.js",