posthog-node 4.2.1 → 4.2.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Next
 
+# 4.2.3 - 2024-11-21
+
+1. fix: identify method allows passing a $set_once object
+
+# 4.2.2 - 2024-11-18
+
+1. fix: Shutdown will now respect the timeout and forcefully return rather than returning after the next fetch.
+
 # 4.2.1 - 2024-10-14
 
 1. fix: only log messages if debug is enabled

package/lib/index.cjs.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var rusha = require('rusha');
 
-var version = "4.2.1";
+var version = "4.2.3";
 
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
@@ -1035,6 +1035,9 @@ class PostHogCoreStateless {
     get isDebug() {
         return !!this.removeDebugCallback;
     }
+    get isDisabled() {
+        return this.disabled;
+    }
     buildPayload(payload) {
         return {
             distinct_id: payload.distinct_id,
@@ -1061,7 +1064,7 @@ class PostHogCoreStateless {
     identifyStateless(distinctId, properties, options) {
         this.wrap(() => {
             // The properties passed to identifyStateless are event properties.
-            // To add person properties, pass in all person properties to the `$set` key.
+            // To add person properties, pass in all person properties to the `$set` and `$set_once` keys.
             const payload = {
                 ...this.buildPayload({
                     distinct_id: distinctId,
@@ -1363,33 +1366,45 @@ class PostHogCoreStateless {
         }, { ...this._retryOptions, ...retryOptions });
     }
     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;
+        let hasTimedOut = false;
         this.clearFlushTimer();
-        try {
-            await Promise.all(Object.values(this.pendingPromises));
-            const startTimeWithDelay = Date.now() + shutdownTimeoutMs;
-            while (true) {
-                const queue = this.getPersistedProperty(PostHogPersistedProperty.Queue) || [];
-                if (queue.length === 0) {
-                    break;
-                }
-                // flush again to make sure we send all events, some of which might've been added
-                // while we were waiting for the pending promises to resolve
-                // For example, see sendFeatureFlags in posthog-node/src/posthog-node.ts::capture
-                await this.flush();
-                // If we've been waiting for more than the shutdownTimeoutMs, stop it
-                const now = Date.now();
-                if (startTimeWithDelay < now) {
-                    break;
+        const doShutdown = async () => {
+            try {
+                await Promise.all(Object.values(this.pendingPromises));
+                while (true) {
+                    const queue = this.getPersistedProperty(PostHogPersistedProperty.Queue) || [];
+                    if (queue.length === 0) {
+                        break;
+                    }
+                    // flush again to make sure we send all events, some of which might've been added
+                    // while we were waiting for the pending promises to resolve
+                    // For example, see sendFeatureFlags in posthog-node/src/posthog-node.ts::capture
+                    await this.flush();
+                    if (hasTimedOut) {
+                        break;
+                    }
                 }
             }
-        }
-        catch (e) {
-            if (!isPostHogFetchError(e)) {
-                throw e;
+            catch (e) {
+                if (!isPostHogFetchError(e)) {
+                    throw e;
+                }
+                this.logMsgIfDebug(() => console.error('Error while shutting down PostHog', e));
             }
-            this.logMsgIfDebug(() => console.error('Error while shutting down PostHog', e));
-        }
+        };
+        return Promise.race([
+            new Promise((_, reject) => {
+                safeSetTimeout(() => {
+                    this.logMsgIfDebug(() => console.error('Timed out while shutting down PostHog'));
+                    hasTimedOut = true;
+                    reject('Timeout while shutting down PostHog. Some events may not have been sent.');
+                }, shutdownTimeoutMs);
+            }),
+            doShutdown(),
+        ]);
     }
 }
 
@@ -2148,9 +2163,14 @@ class PostHog extends PostHogCoreStateless {
     disableGeoip
   }) {
     // Catch properties passed as $set and move them to the top level
-    const personProperties = properties?.$set || properties;
+    // promote $set and $set_once to top level
+    const userPropsOnce = properties?.$set_once;
+    delete properties?.$set_once;
+    // if no $set is provided we assume all properties are $set
+    const userProps = properties?.$set || properties;
     super.identifyStateless(distinctId, {
-      $set: personProperties
+      $set: userProps,
+      $set_once: userPropsOnce
     }, {
       disableGeoip
     });