posthog-js-lite 3.5.0 → 3.5.1

package/lib/{index.esm.js → index.mjs}

@@ -1,3 +1,5 @@
+var version = "3.5.1";
+
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
     PostHogPersistedProperty["AnonymousId"] = "anonymous_id";
@@ -287,6 +289,7 @@ const NEW_FLAGS_EXCLUDED_HASHES = new Set([
     'fc80b8e2',
     '75cc0998',
 ]);
+const STRING_FORMAT = 'utf8';
 function assert(truthyValue, message) {
     if (!truthyValue || typeof truthyValue !== 'string' || isEmpty(truthyValue)) {
         throw new Error(message);
@@ -339,12 +342,8 @@ const isError = (x) => {
     return x instanceof Error;
 };
 function getFetch() {
-    return typeof fetch !== 'undefined' ? fetch : typeof global.fetch !== 'undefined' ? global.fetch : undefined;
+    return typeof fetch !== 'undefined' ? fetch : typeof globalThis.fetch !== 'undefined' ? globalThis.fetch : undefined;
 }
-// copied from: https://github.com/PostHog/posthog-js/blob/main/react/src/utils/type-utils.ts#L4
-const isFunction = function (f) {
-    return typeof f === 'function';
-};
 // FNV-1a hash function
 // https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
 // I know, I know, I'm rolling my own hash function, but I didn't want to take on
@@ -1232,11 +1231,21 @@ const uuidv7 = () => uuidv7obj().toString();
 const uuidv7obj = () => (defaultGenerator || (defaultGenerator = new V7Generator())).generate();
 
 class PostHogFetchHttpError extends Error {
-    constructor(response) {
-        super('HTTP error while fetching PostHog: ' + response.status);
+    constructor(response, reqByteLength) {
+        super('HTTP error while fetching PostHog: status=' + response.status + ', reqByteLength=' + reqByteLength);
         this.response = response;
+        this.reqByteLength = reqByteLength;
         this.name = 'PostHogFetchHttpError';
     }
+    get status() {
+        return this.response.status;
+    }
+    get text() {
+        return this.response.text();
+    }
+    get json() {
+        return this.response.json();
+    }
 }
 class PostHogFetchNetworkError extends Error {
     constructor(error) {
@@ -1248,9 +1257,26 @@ class PostHogFetchNetworkError extends Error {
         this.name = 'PostHogFetchNetworkError';
     }
 }
+async function logFlushError(err) {
+    if (err instanceof PostHogFetchHttpError) {
+        let text = '';
+        try {
+            text = await err.text;
+        }
+        catch { }
+        console.error(`Error while flushing PostHog: message=${err.message}, response body=${text}`, err);
+    }
+    else {
+        console.error('Error while flushing PostHog', err);
+    }
+    return Promise.resolve();
+}
 function isPostHogFetchError(err) {
     return typeof err === 'object' && (err instanceof PostHogFetchHttpError || err instanceof PostHogFetchNetworkError);
 }
+function isPostHogFetchContentTooLargeError(err) {
+    return typeof err === 'object' && err instanceof PostHogFetchHttpError && err.status === 413;
+}
 var QuotaLimitedFeature;
 (function (QuotaLimitedFeature) {
     QuotaLimitedFeature["FeatureFlags"] = "feature_flags";
@@ -1259,6 +1285,7 @@ var QuotaLimitedFeature;
 class PostHogCoreStateless {
     constructor(apiKey, options) {
         this.flushPromise = null;
+        this.shutdownPromise = null;
         this.pendingPromises = {};
         // internal
         this._events = new SimpleEventEmitter();
@@ -1381,12 +1408,26 @@ class PostHogCoreStateless {
             this.enqueue('identify', payload, options);
         });
     }
+    async identifyStatelessImmediate(distinctId, properties, options) {
+        const payload = {
+            ...this.buildPayload({
+                distinct_id: distinctId,
+                event: '$identify',
+                properties,
+            }),
+        };
+        await this.sendImmediate('identify', payload, options);
+    }
     captureStateless(distinctId, event, properties, options) {
         this.wrap(() => {
             const payload = this.buildPayload({ distinct_id: distinctId, event, properties });
             this.enqueue('capture', payload, options);
         });
     }
+    async captureStatelessImmediate(distinctId, event, properties, options) {
+        const payload = this.buildPayload({ distinct_id: distinctId, event, properties });
+        await this.sendImmediate('capture', payload, options);
+    }
     aliasStateless(alias, distinctId, properties, options) {
         this.wrap(() => {
             const payload = this.buildPayload({
@@ -1401,6 +1442,18 @@ class PostHogCoreStateless {
             this.enqueue('alias', payload, options);
         });
     }
+    async aliasStatelessImmediate(alias, distinctId, properties, options) {
+        const payload = this.buildPayload({
+            event: '$create_alias',
+            distinct_id: distinctId,
+            properties: {
+                ...(properties || {}),
+                distinct_id: distinctId,
+                alias,
+            },
+        });
+        await this.sendImmediate('alias', payload, options);
+    }
     /***
      *** GROUPS
      ***/
@@ -1611,6 +1664,30 @@ class PostHogCoreStateless {
         }
         return newSurveys ?? [];
     }
+    get props() {
+        if (!this._props) {
+            this._props = this.getPersistedProperty(PostHogPersistedProperty.Props);
+        }
+        return this._props || {};
+    }
+    set props(val) {
+        this._props = val;
+    }
+    async register(properties) {
+        this.wrap(() => {
+            this.props = {
+                ...this.props,
+                ...properties,
+            };
+            this.setPersistedProperty(PostHogPersistedProperty.Props, this.props);
+        });
+    }
+    async unregister(property) {
+        this.wrap(() => {
+            delete this.props[property];
+            this.setPersistedProperty(PostHogPersistedProperty.Props, this.props);
+        });
+    }
     /***
      *** QUEUEING AND FLUSHING
      ***/
@@ -1620,25 +1697,7 @@ class PostHogCoreStateless {
                 this._events.emit(type, `Library is disabled. Not sending event. To re-enable, call posthog.optIn()`);
                 return;
             }
-            const message = {
-                ..._message,
-                type: type,
-                library: this.getLibraryId(),
-                library_version: this.getLibraryVersion(),
-                timestamp: options?.timestamp ? options?.timestamp : currentISOTime(),
-                uuid: options?.uuid ? options.uuid : uuidv7(),
-            };
-            const addGeoipDisableProperty = options?.disableGeoip ?? this.disableGeoip;
-            if (addGeoipDisableProperty) {
-                if (!message.properties) {
-                    message.properties = {};
-                }
-                message['properties']['$geoip_disable'] = true;
-            }
-            if (message.distinctId) {
-                message.distinct_id = message.distinctId;
-                delete message.distinctId;
-            }
+            const message = this.prepareMessage(type, _message, options);
             const queue = this.getPersistedProperty(PostHogPersistedProperty.Queue) || [];
             if (queue.length >= this.maxQueueSize) {
                 queue.shift();
@@ -1656,6 +1715,73 @@ class PostHogCoreStateless {
             }
         });
     }
+    async sendImmediate(type, _message, options) {
+        if (this.disabled) {
+            this.logMsgIfDebug(() => console.warn('[PostHog] The client is disabled'));
+            return;
+        }
+        if (!this._isInitialized) {
+            await this._initPromise;
+        }
+        if (this.optedOut) {
+            this._events.emit(type, `Library is disabled. Not sending event. To re-enable, call posthog.optIn()`);
+            return;
+        }
+        const data = {
+            api_key: this.apiKey,
+            batch: [this.prepareMessage(type, _message, options)],
+            sent_at: currentISOTime(),
+        };
+        if (this.historicalMigration) {
+            data.historical_migration = true;
+        }
+        const payload = JSON.stringify(data);
+        const url = this.captureMode === 'form'
+            ? `${this.host}/e/?ip=1&_=${currentTimestamp()}&v=${this.getLibraryVersion()}`
+            : `${this.host}/batch/`;
+        const fetchOptions = this.captureMode === 'form'
+            ? {
+                method: 'POST',
+                mode: 'no-cors',
+                credentials: 'omit',
+                headers: { ...this.getCustomHeaders(), 'Content-Type': 'application/x-www-form-urlencoded' },
+                body: `data=${encodeURIComponent(LZString.compressToBase64(payload))}&compression=lz64`,
+            }
+            : {
+                method: 'POST',
+                headers: { ...this.getCustomHeaders(), 'Content-Type': 'application/json' },
+                body: payload,
+            };
+        try {
+            await this.fetchWithRetry(url, fetchOptions);
+        }
+        catch (err) {
+            this._events.emit('error', err);
+            throw err;
+        }
+    }
+    prepareMessage(type, _message, options) {
+        const message = {
+            ..._message,
+            type: type,
+            library: this.getLibraryId(),
+            library_version: this.getLibraryVersion(),
+            timestamp: options?.timestamp ? options?.timestamp : currentISOTime(),
+            uuid: options?.uuid ? options.uuid : uuidv7(),
+        };
+        const addGeoipDisableProperty = options?.disableGeoip ?? this.disableGeoip;
+        if (addGeoipDisableProperty) {
+            if (!message.properties) {
+                message.properties = {};
+            }
+            message['properties']['$geoip_disable'] = true;
+        }
+        if (message.distinctId) {
+            message.distinct_id = message.distinctId;
+            delete message.distinctId;
+        }
+        return message;
+    }
     clearFlushTimer() {
         if (this._flushTimer) {
             clearTimeout(this._flushTimer);
@@ -1667,16 +1793,26 @@ class PostHogCoreStateless {
      * Avoids unnecessary promise errors
      */
     flushBackground() {
-        void this.flush().catch(() => { });
+        void this.flush().catch(async (err) => {
+            await logFlushError(err);
+        });
     }
     async flush() {
-        if (!this.flushPromise) {
-            this.flushPromise = this._flush().finally(() => {
+        // Wait for the current flush operation to finish (regardless of success or failure), then try to flush again.
+        // Use allSettled instead of finally to be defensive around flush throwing errors immediately rather than rejecting.
+        const nextFlushPromise = Promise.allSettled([this.flushPromise]).then(() => {
+            return this._flush();
+        });
+        this.flushPromise = nextFlushPromise;
+        void this.addPendingPromise(nextFlushPromise);
+        Promise.allSettled([nextFlushPromise]).then(() => {
+            // If there are no others waiting to flush, clear the promise.
+            // We don't strictly need to do this, but it could make debugging easier
+            if (this.flushPromise === nextFlushPromise) {
                 this.flushPromise = null;
-            });
-            this.addPendingPromise(this.flushPromise);
-        }
-        return this.flushPromise;
+            }
+        });
+        return nextFlushPromise;
     }
     getCustomHeaders() {
         // Don't set the user agent if we're not on a browser. The latest spec allows
@@ -1693,56 +1829,80 @@ class PostHogCoreStateless {
     async _flush() {
         this.clearFlushTimer();
         await this._initPromise;
-        const queue = this.getPersistedProperty(PostHogPersistedProperty.Queue) || [];
+        let queue = this.getPersistedProperty(PostHogPersistedProperty.Queue) || [];
         if (!queue.length) {
             return [];
         }
-        const items = queue.slice(0, this.maxBatchSize);
-        const messages = items.map((item) => item.message);
-        const persistQueueChange = () => {
-            const refreshedQueue = this.getPersistedProperty(PostHogPersistedProperty.Queue) || [];
-            this.setPersistedProperty(PostHogPersistedProperty.Queue, refreshedQueue.slice(items.length));
-        };
-        const data = {
-            api_key: this.apiKey,
-            batch: messages,
-            sent_at: currentISOTime(),
-        };
-        if (this.historicalMigration) {
-            data.historical_migration = true;
-        }
-        const payload = JSON.stringify(data);
-        const url = this.captureMode === 'form'
-            ? `${this.host}/e/?ip=1&_=${currentTimestamp()}&v=${this.getLibraryVersion()}`
-            : `${this.host}/batch/`;
-        const fetchOptions = this.captureMode === 'form'
-            ? {
-                method: 'POST',
-                mode: 'no-cors',
-                credentials: 'omit',
-                headers: { ...this.getCustomHeaders(), 'Content-Type': 'application/x-www-form-urlencoded' },
-                body: `data=${encodeURIComponent(LZString.compressToBase64(payload))}&compression=lz64`,
+        const sentMessages = [];
+        const originalQueueLength = queue.length;
+        while (queue.length > 0 && sentMessages.length < originalQueueLength) {
+            const batchItems = queue.slice(0, this.maxBatchSize);
+            const batchMessages = batchItems.map((item) => item.message);
+            const persistQueueChange = () => {
+                const refreshedQueue = this.getPersistedProperty(PostHogPersistedProperty.Queue) || [];
+                const newQueue = refreshedQueue.slice(batchItems.length);
+                this.setPersistedProperty(PostHogPersistedProperty.Queue, newQueue);
+                queue = newQueue;
+            };
+            const data = {
+                api_key: this.apiKey,
+                batch: batchMessages,
+                sent_at: currentISOTime(),
+            };
+            if (this.historicalMigration) {
+                data.historical_migration = true;
             }
-            : {
-                method: 'POST',
-                headers: { ...this.getCustomHeaders(), 'Content-Type': 'application/json' },
-                body: payload,
+            const payload = JSON.stringify(data);
+            const url = this.captureMode === 'form'
+                ? `${this.host}/e/?ip=1&_=${currentTimestamp()}&v=${this.getLibraryVersion()}`
+                : `${this.host}/batch/`;
+            const fetchOptions = this.captureMode === 'form'
+                ? {
+                    method: 'POST',
+                    mode: 'no-cors',
+                    credentials: 'omit',
+                    headers: { ...this.getCustomHeaders(), 'Content-Type': 'application/x-www-form-urlencoded' },
+                    body: `data=${encodeURIComponent(LZString.compressToBase64(payload))}&compression=lz64`,
+                }
+                : {
+                    method: 'POST',
+                    headers: { ...this.getCustomHeaders(), 'Content-Type': 'application/json' },
+                    body: payload,
+                };
+            const retryOptions = {
+                retryCheck: (err) => {
+                    // don't automatically retry on 413 errors, we want to reduce the batch size first
+                    if (isPostHogFetchContentTooLargeError(err)) {
+                        return false;
+                    }
+                    // otherwise, retry on network errors
+                    return isPostHogFetchError(err);
+                },
             };
-        try {
-            await this.fetchWithRetry(url, fetchOptions);
-        }
-        catch (err) {
-            // depending on the error type, eg a malformed JSON or broken queue, it'll always return an error
-            // and this will be an endless loop, in this case, if the error isn't a network issue, we always remove the items from the queue
-            if (!(err instanceof PostHogFetchNetworkError)) {
-                persistQueueChange();
+            try {
+                await this.fetchWithRetry(url, fetchOptions, retryOptions);
             }
-            this._events.emit('error', err);
-            throw err;
+            catch (err) {
+                if (isPostHogFetchContentTooLargeError(err) && batchMessages.length > 1) {
+                    // if we get a 413 error, we want to reduce the batch size and try again
+                    this.maxBatchSize = Math.max(1, Math.floor(batchMessages.length / 2));
+                    this.logMsgIfDebug(() => console.warn(`Received 413 when sending batch of size ${batchMessages.length}, reducing batch size to ${this.maxBatchSize}`));
+                    // do not persist the queue change, we want to retry the same batch
+                    continue;
+                }
+                // depending on the error type, eg a malformed JSON or broken queue, it'll always return an error
+                // and this will be an endless loop, in this case, if the error isn't a network issue, we always remove the items from the queue
+                if (!(err instanceof PostHogFetchNetworkError)) {
+                    persistQueueChange();
+                }
+                this._events.emit('error', err);
+                throw err;
+            }
+            persistQueueChange();
+            sentMessages.push(...batchMessages);
         }
-        persistQueueChange();
-        this._events.emit('flush', messages);
-        return messages;
+        this._events.emit('flush', sentMessages);
+        return sentMessages;
     }
     async fetchWithRetry(url, options, retryOptions, requestTimeout) {
         var _a;
@@ -1751,6 +1911,8 @@ class PostHogCoreStateless {
             setTimeout(() => ctrl.abort(), ms);
             return ctrl.signal;
         });
+        const body = options.body ? options.body : '';
+        const reqByteLength = Buffer.byteLength(body, STRING_FORMAT);
         return await retriable(async () => {
             let res = null;
             try {
@@ -1768,12 +1930,12 @@ class PostHogCoreStateless {
             // https://developer.mozilla.org/en-US/docs/Web/API/Request/mode#no-cors
             const isNoCors = options.mode === 'no-cors';
             if (!isNoCors && (res.status < 200 || res.status >= 400)) {
-                throw new PostHogFetchHttpError(res);
+                throw new PostHogFetchHttpError(res, reqByteLength);
             }
             return res;
         }, { ...this._retryOptions, ...retryOptions });
     }
-    async shutdown(shutdownTimeoutMs = 30000) {
+    async _shutdown(shutdownTimeoutMs = 30000) {
         // A little tricky - we want to have a max shutdown time and enforce it, even if that means we have some
         // dangling promises. We'll keep track of the timeout and resolve/reject based on that.
         await this._initPromise;
@@ -1800,7 +1962,7 @@ class PostHogCoreStateless {
                 if (!isPostHogFetchError(e)) {
                     throw e;
                 }
-                this.logMsgIfDebug(() => console.error('Error while shutting down PostHog', e));
+                await logFlushError(e);
             }
         };
         return Promise.race([
@@ -1814,6 +1976,22 @@ class PostHogCoreStateless {
             doShutdown(),
         ]);
     }
+    /**
+     *  Call shutdown() once before the node process exits, so ensure that all events have been sent and all promises
+     *  have resolved. Do not use this function if you intend to keep using this PostHog instance after calling it.
+     * @param shutdownTimeoutMs
+     */
+    async shutdown(shutdownTimeoutMs = 30000) {
+        if (this.shutdownPromise) {
+            this.logMsgIfDebug(() => console.warn('shutdown() called while already shutting down. shutdown() is meant to be called once before process exit - use flush() for per-request cleanup'));
+        }
+        else {
+            this.shutdownPromise = this._shutdown(shutdownTimeoutMs).finally(() => {
+                this.shutdownPromise = null;
+            });
+        }
+        return this.shutdownPromise;
+    }
 }
 class PostHogCore extends PostHogCoreStateless {
     constructor(apiKey, options) {
@@ -1866,16 +2044,6 @@ class PostHogCore extends PostHogCoreStateless {
             }
         }
     }
-    // NOTE: Props are lazy loaded from localstorage hence the complex getter setter logic
-    get props() {
-        if (!this._props) {
-            this._props = this.getPersistedProperty(PostHogPersistedProperty.Props);
-        }
-        return this._props || {};
-    }
-    set props(val) {
-        this._props = val;
-    }
     clearProps() {
         this.props = undefined;
         this.sessionProps = {};
@@ -1965,21 +2133,6 @@ class PostHogCore extends PostHogCoreStateless {
         }
         return this.getPersistedProperty(PostHogPersistedProperty.DistinctId) || this.getAnonymousId();
     }
-    async unregister(property) {
-        this.wrap(() => {
-            delete this.props[property];
-            this.setPersistedProperty(PostHogPersistedProperty.Props, this.props);
-        });
-    }
-    async register(properties) {
-        this.wrap(() => {
-            this.props = {
-                ...this.props,
-                ...properties,
-            };
-            this.setPersistedProperty(PostHogPersistedProperty.Props, this.props);
-        });
-    }
     registerForSession(properties) {
         this.sessionProps = {
             ...this.sessionProps,
@@ -2499,8 +2652,6 @@ class PostHogCore extends PostHogCoreStateless {
     }
 }
 
-var version = "3.5.0";
-
 function getContext(window) {
   let context = {};
   if (window?.navigator) {
@@ -2804,39 +2955,45 @@ const getStorage = (type, window) => {
   }
 };
 
-// import { patch } from 'rrweb/typings/utils'
-function patch(source, name, replacement) {
-    try {
-        if (!(name in source)) {
-            return () => {
-                //
-            };
-        }
-        const original = source[name];
-        const wrapped = replacement(original);
-        // Make sure it's a function first, as we need to attach an empty prototype for `defineProperties` to work
-        // otherwise it'll throw "TypeError: Object.defineProperties called on non-object"
-        if (isFunction(wrapped)) {
-            wrapped.prototype = wrapped.prototype || {};
-            Object.defineProperties(wrapped, {
-                __posthog_wrapped__: {
-                    enumerable: false,
-                    value: true,
-                },
-            });
-        }
-        source[name] = wrapped;
-        return () => {
-            source[name] = original;
-        };
-    }
-    catch {
-        return () => {
-            //
-        };
-        // This can throw if multiple fill happens on a global object like XMLHttpRequest
-        // Fixes https://github.com/getsentry/sentry-javascript/issues/2043
-    }
+// import { patch } from 'rrweb/typings/utils'
+// copied from: https://github.com/PostHog/posthog-js/blob/main/src/extensions/replay/rrweb-plugins/patch.ts
+// which was copied from https://github.com/rrweb-io/rrweb/blob/8aea5b00a4dfe5a6f59bd2ae72bb624f45e51e81/packages/rrweb/src/utils.ts#L129
+// which was copied from https://github.com/getsentry/sentry-javascript/blob/b2109071975af8bf0316d3b5b38f519bdaf5dc15/packages/utils/src/object.ts
+// copied from: https://github.com/PostHog/posthog-js/blob/main/react/src/utils/type-utils.ts#L4
+const isFunction = function (f) {
+  return typeof f === 'function';
+};
+function patch(source, name, replacement) {
+  try {
+    if (!(name in source)) {
+      return () => {
+        //
+      };
+    }
+    const original = source[name];
+    const wrapped = replacement(original);
+    // Make sure it's a function first, as we need to attach an empty prototype for `defineProperties` to work
+    // otherwise it'll throw "TypeError: Object.defineProperties called on non-object"
+    if (isFunction(wrapped)) {
+      wrapped.prototype = wrapped.prototype || {};
+      Object.defineProperties(wrapped, {
+        __posthog_wrapped__: {
+          enumerable: false,
+          value: true
+        }
+      });
+    }
+    source[name] = wrapped;
+    return () => {
+      source[name] = original;
+    };
+  } catch {
+    return () => {
+      //
+    };
+    // This can throw if multiple fill happens on a global object like XMLHttpRequest
+    // Fixes https://github.com/getsentry/sentry-javascript/issues/2043
+  }
 }
 
 class PostHog extends PostHogCore {
@@ -2942,4 +3099,4 @@ class PostHog extends PostHogCore {
 }
 
 export { PostHog, PostHog as default };
-//# sourceMappingURL=index.esm.js.map
+//# sourceMappingURL=index.mjs.map