posthog-node 4.0.0-beta.2 → 4.0.0

package/lib/index.d.ts

@@ -8,6 +8,10 @@ declare type PostHogCoreOptions = {
     flushInterval?: number;
     /** The maximum number of queued messages to be flushed as part of a single batch (must be higher than `flushAt`) */
     maxBatchSize?: number;
+    /** The maximum number of cached messages either in memory or on the local storage.
+     * Defaults to 1000, (must be higher than `flushAt`)
+     */
+    maxQueueSize?: number;
     /** If set to true the SDK is essentially disabled (useful for local environments where you don't want to track anything) */
     disabled?: boolean;
     /** If set to false the SDK will not track until the `optIn` function is called. */
@@ -125,6 +129,7 @@ declare abstract class PostHogCoreStateless {
     host: string;
     private flushAt;
     private maxBatchSize;
+    private maxQueueSize;
     private flushInterval;
     private flushPromise;
     private requestTimeout;
@@ -195,6 +200,9 @@ declare abstract class PostHogCoreStateless {
      */
     private flushBackground;
     flush(): Promise<any[]>;
+    protected getCustomHeaders(): {
+        [key: string]: string;
+    };
     private _flush;
     private fetchWithRetry;
     shutdown(shutdownTimeoutMs?: number): Promise<void>;

package/lib/index.esm.js

@@ -1,6 +1,6 @@
 import { createHash } from 'rusha';
 
-var version = "4.0.0-beta.2";
+var version = "4.0.0";
 
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
@@ -959,6 +959,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
@@ -1107,7 +1108,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,
@@ -1217,6 +1218,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);
@@ -1251,6 +1256,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;
@@ -1269,11 +1286,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()}`
@@ -1283,12 +1295,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 {
@@ -1449,6 +1461,7 @@ class FeatureFlagsPoller {
     projectApiKey,
     timeout,
     host,
+    customHeaders,
     ...options
   }) {
     this.debugMode = false;
@@ -1466,6 +1479,7 @@ class FeatureFlagsPoller {
 
     this.fetch = options.fetch || fetch$1;
     this.onError = options.onError;
+    this.customHeaders = customHeaders;
     void this.loadFeatureFlags();
   }
 
@@ -1768,10 +1782,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;
@@ -2113,7 +2126,8 @@ class PostHog extends PostHogCoreStateless {
         fetch: options.fetch,
         onError: err => {
           this._events.emit('error', err);
-        }
+        },
+        customHeaders: this.getCustomHeaders()
       });
     }
 
@@ -2142,7 +2156,7 @@ class PostHog extends PostHogCoreStateless {
   }
 
   getCustomUserAgent() {
-    return `posthog-node/${version}`;
+    return `${this.getLibraryId()}/${this.getLibraryVersion()}`;
   }
 
   enable() {