posthog-node 4.0.0-beta.2 → 4.0.0

package/CHANGELOG.md

@@ -1,15 +1,44 @@
+# 4.0.0 - 2024-03-18
+
+## Added
+
+1. Adds a `disabled` option and the ability to change it later via `posthog.disabled = true`. Useful for disabling PostHog tracking for example in a testing environment without having complex conditional checking
+2. Adds a new `featureFlagsRequestTimeoutMs` timeout parameter for feature flags which defaults to 3 seconds, updated from the default 10s for all other API calls.
+3. `shutdown` takes a `shutdownTimeoutMs` param with a default of 30000 (30s). This is the time to wait for flushing events before shutting down the client. If the timeout is reached, the client will be shut down regardless of pending events.
+4. Flushes will now try to flush up to `maxBatchSize` (default 100) in one go
+5. Queued events are limited up to `maxQueueSize` (default 1000) and the oldest events are dropped when the limit is reached
+6. Sets `User-Agent` headers with SDK name and version for RN
+
+## Removed
+
+1. `flushAsync` and `shutdownAsync` are removed with `flush` and `shutdown` now being the async methods.
+
+## Changed
+
+1. `flush` and `shutdown` now being async methods.
+
+## Fixed
+
+1. Fixed an issue where `shutdown` would potentially exit early if a flush was already in progress
+2. Fixes some typos in types
+
+
+# 4.0.0-beta.3 - 2024-03-13
+
+1. Sets `User-Agent` headers with SDK name and version for RN
+
 # 4.0.0-beta.2 - 2024-03-12
 
-- `flushAsync` and `shutdownAsync` are removed with `flush` and `shutdown` now being the async methods.
-- Fixed an issue where `shutdown` would potentially exit early if a flush was already in progress
-- Flushes will now try to flush up to `maxBatchSize` (default 100) in one go
+1. `flushAsync` and `shutdownAsync` are removed with `flush` and `shutdown` now being the async methods.
+2. Fixed an issue where `shutdown` would potentially exit early if a flush was already in progress
+3. Flushes will now try to flush up to `maxBatchSize` (default 100) in one go
 
 # 4.0.0-beta.1 - 2024-03-04
 
-- Adds a `disabled` option and the ability to change it later via `posthog.disabled = true`. Useful for disabling PostHog tracking for example in a testing environment without having complex conditional checking
-- Fixes some typos in types
-- `shutdown` and `shutdownAsync` takes a `shutdownTimeoutMs` param with a default of 30000 (30s). This is the time to wait for flushing events before shutting down the client. If the timeout is reached, the client will be shut down regardless of pending events.
-- Adds a new `featureFlagsRequestTimeoutMs` timeout parameter for feature flags which defaults to 3 seconds, updated from the default 10s for all other API calls.
+1. Adds a `disabled` option and the ability to change it later via `posthog.disabled = true`. Useful for disabling PostHog tracking for example in a testing environment without having complex conditional checking
+2. Fixes some typos in types
+3. `shutdown` and `shutdownAsync` takes a `shutdownTimeoutMs` param with a default of 30000 (30s). This is the time to wait for flushing events before shutting down the client. If the timeout is reached, the client will be shut down regardless of pending events.
+4. Adds a new `featureFlagsRequestTimeoutMs` timeout parameter for feature flags which defaults to 3 seconds, updated from the default 10s for all other API calls.
 
 # 3.6.3 - 2024-02-15
 

package/lib/index.cjs.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var rusha = require('rusha');
 
-var version = "4.0.0-beta.2";
+var version = "4.0.0";
 
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
@@ -963,6 +963,7 @@ class PostHogCoreStateless {
         this.host = removeTrailingSlash(options?.host || 'https://app.posthog.com');
         this.flushAt = options?.flushAt ? Math.max(options?.flushAt, 1) : 20;
         this.maxBatchSize = Math.max(this.flushAt, options?.maxBatchSize ?? 100);
+        this.maxQueueSize = Math.max(this.flushAt, options?.maxQueueSize ?? 1000);
         this.flushInterval = options?.flushInterval ?? 10000;
         this.captureMode = options?.captureMode || 'form';
         // If enable is explicitly set to false we override the optout
@@ -1111,7 +1112,7 @@ class PostHogCoreStateless {
         const url = `${this.host}/decide/?v=3`;
         const fetchOptions = {
             method: 'POST',
-            headers: { 'Content-Type': 'application/json' },
+            headers: { ...this.getCustomHeaders(), 'Content-Type': 'application/json' },
             body: JSON.stringify({
                 token: this.apiKey,
                 distinct_id: distinctId,
@@ -1221,6 +1222,10 @@ class PostHogCoreStateless {
                 delete message.distinctId;
             }
             const queue = this.getPersistedProperty(PostHogPersistedProperty.Queue) || [];
+            if (queue.length >= this.maxQueueSize) {
+                queue.shift();
+                console.info('Queue is full, the oldest event is dropped.');
+            }
             queue.push({ message });
             this.setPersistedProperty(PostHogPersistedProperty.Queue, queue);
             this._events.emit(type, message);
@@ -1255,6 +1260,18 @@ class PostHogCoreStateless {
         }
         return this.flushPromise;
     }
+    getCustomHeaders() {
+        // Don't set the user agent if we're not on a browser. The latest spec allows
+        // the User-Agent header (see https://fetch.spec.whatwg.org/#terminology-headers
+        // and https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader),
+        // but browsers such as Chrome and Safari have not caught up.
+        const customUserAgent = this.getCustomUserAgent();
+        const headers = {};
+        if (customUserAgent && customUserAgent !== '') {
+            headers['User-Agent'] = customUserAgent;
+        }
+        return headers;
+    }
     async _flush() {
         this.clearFlushTimer();
         await this._initPromise;
@@ -1273,11 +1290,6 @@ class PostHogCoreStateless {
             batch: messages,
             sent_at: currentISOTime(),
         };
-        // Don't set the user agent if we're not on a browser. The latest spec allows
-        // the User-Agent header (see https://fetch.spec.whatwg.org/#terminology-headers
-        // and https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/setRequestHeader),
-        // but browsers such as Chrome and Safari have not caught up.
-        this.getCustomUserAgent();
         const payload = JSON.stringify(data);
         const url = this.captureMode === 'form'
             ? `${this.host}/e/?ip=1&_=${currentTimestamp()}&v=${this.getLibraryVersion()}`
@@ -1287,12 +1299,12 @@ class PostHogCoreStateless {
                 method: 'POST',
                 mode: 'no-cors',
                 credentials: 'omit',
-                headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+                headers: { ...this.getCustomHeaders(), 'Content-Type': 'application/x-www-form-urlencoded' },
                 body: `data=${encodeURIComponent(LZString.compressToBase64(payload))}&compression=lz64`,
             }
             : {
                 method: 'POST',
-                headers: { 'Content-Type': 'application/json' },
+                headers: { ...this.getCustomHeaders(), 'Content-Type': 'application/json' },
                 body: payload,
             };
         try {
@@ -1453,6 +1465,7 @@ class FeatureFlagsPoller {
     projectApiKey,
     timeout,
     host,
+    customHeaders,
     ...options
   }) {
     this.debugMode = false;
@@ -1470,6 +1483,7 @@ class FeatureFlagsPoller {
 
     this.fetch = options.fetch || fetch$1;
     this.onError = options.onError;
+    this.customHeaders = customHeaders;
     void this.loadFeatureFlags();
   }
 
@@ -1772,10 +1786,9 @@ class FeatureFlagsPoller {
     const url = `${this.host}/api/feature_flag/local_evaluation?token=${this.projectApiKey}&send_cohorts`;
     const options = {
       method: 'GET',
-      headers: {
+      headers: { ...this.customHeaders,
         'Content-Type': 'application/json',
-        Authorization: `Bearer ${this.personalApiKey}`,
-        'user-agent': `posthog-node/${version}`
+        Authorization: `Bearer ${this.personalApiKey}`
       }
     };
     let abortTimeout = null;
@@ -2117,7 +2130,8 @@ class PostHog extends PostHogCoreStateless {
         fetch: options.fetch,
         onError: err => {
           this._events.emit('error', err);
-        }
+        },
+        customHeaders: this.getCustomHeaders()
       });
     }
 
@@ -2146,7 +2160,7 @@ class PostHog extends PostHogCoreStateless {
   }
 
   getCustomUserAgent() {
-    return `posthog-node/${version}`;
+    return `${this.getLibraryId()}/${this.getLibraryVersion()}`;
   }
 
   enable() {