fix: shutdownAsync flushes the whole queue

package.json

@@ -43,14 +43,14 @@
     "eslint-plugin-react": "^7.30.1",
     "eslint-plugin-react-hooks": "^4.6.0",
     "husky": "^8.0.1",
-    "jest": "^28.1.3",
+    "jest": "^29.0.0",
     "jest-environment-jsdom": "^28.1.3",
     "prettier": "^2.7.1",
     "rollup": "^2.77.0",
     "rollup-plugin-dts": "^4.2.2",
     "rollup-plugin-dts-bundle": "^1.0.0",
     "rollup-plugin-typescript2": "^0.32.1",
-    "ts-jest": "^28.0.6",
+    "ts-jest": "^29.0.0",
     "ts-node": "^10.9.1",
     "tslib": "^2.4.0",
     "typescript": "^4.7.4"

posthog-core/src/index.ts

@@ -616,23 +616,40 @@ export abstract class PostHogCoreStateless {
     )
   }
 
-  async shutdownAsync(): Promise<void> {
+  async shutdownAsync(shutdownTimeoutMs?: number): Promise<void> {
     await this._initPromise
 
     clearTimeout(this._flushTimer)
     try {
-      await this.flushAsync()
       await Promise.all(
         Object.values(this.pendingPromises).map((x) =>
           x.catch(() => {
             // ignore errors as we are shutting down and can't deal with them anyways.
           })
         )
       )
-      // 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.flushAsync()
+
+      const timeout = shutdownTimeoutMs ?? 30000
+      const startTimeWithDelay = Date.now() + timeout
+
+      while (true) {
+        const queue = this.getPersistedProperty<PostHogQueueItem[]>(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.flushAsync()
+
+        // If we've been waiting for more than the shutdownTimeoutMs, stop it
+        const now = Date.now()
+        if (startTimeWithDelay < now) {
+          break
+        }
+      }
     } catch (e) {
       if (!isPostHogFetchError(e)) {
         throw e
@@ -641,8 +658,8 @@ export abstract class PostHogCoreStateless {
     }
   }
 
-  shutdown(): void {
-    void this.shutdownAsync()
+  shutdown(shutdownTimeoutMs?: number): void {
+    void this.shutdownAsync(shutdownTimeoutMs)
   }
 }
 

posthog-core/test/posthog.shutdown.spec.ts

@@ -0,0 +1,26 @@
+import { createTestClient, PostHogCoreTestClient, PostHogCoreTestClientMocks } from './test-utils/PostHogCoreTestClient'
+
+describe('PostHog Core', () => {
+  let posthog: PostHogCoreTestClient
+  let mocks: PostHogCoreTestClientMocks
+
+  describe('shutdown', () => {
+    beforeEach(() => {
+      jest.useRealTimers()
+      ;[posthog, mocks] = createTestClient('TEST_API_KEY', {
+        flushAt: 10,
+        preloadFeatureFlags: false,
+        captureMode: 'json',
+      })
+    })
+
+    it('flush messsages once called', async () => {
+      for (let i = 0; i < 5; i++) {
+        posthog.capture('test-event')
+      }
+
+      await posthog.shutdownAsync()
+      expect(mocks.fetch).toHaveBeenCalledTimes(1)
+    })
+  })
+})

posthog-node/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 - 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.
 
 # 3.6.3 - 2024-02-15
 

posthog-node/src/posthog-node.ts

@@ -445,13 +445,13 @@ export class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
     await this.featureFlagsPoller?.loadFeatureFlags(true)
   }
 
-  shutdown(): void {
-    void this.shutdownAsync()
+  shutdown(shutdownTimeoutMs?: number): void {
+    void this.shutdownAsync(shutdownTimeoutMs)
   }
 
-  async shutdownAsync(): Promise<void> {
+  async shutdownAsync(shutdownTimeoutMs?: number): Promise<void> {
     this.featureFlagsPoller?.stopPoller()
-    return super.shutdownAsync()
+    return super.shutdownAsync(shutdownTimeoutMs)
   }
 
   private addLocalPersonAndGroupProperties(

posthog-node/src/types.ts

@@ -198,6 +198,8 @@ export type PostHogNodeV1 = {
   /**
    * @description Flushes the events still in the queue and clears the feature flags poller to allow for
    * a clean shutdown.
+   *
+   * @param shutdownTimeoutMs The shutdown timeout, in milliseconds. Defaults to 30000 (30s).
    */
-  shutdown(): void
+  shutdown(shutdownTimeoutMs?: number): void
 }

posthog-react-native/CHANGELOG.md

@@ -6,6 +6,7 @@
 - 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
 - Many methods such as `capture` and `identify` no longer return the `this` object instead returning nothing
 - 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.
 
 # 2.11.6 - 2024-02-22
 

posthog-react-native/test/__snapshots__/autocapture.spec.ts.snap

@@ -1,88 +1,88 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`PostHog React Native autocapture should capture a valid event 1`] = `
-Array [
+[
   "touch",
-  Array [
-    Object {
-      "$el_text": "I have the property \\"ph-label\\" which means touching me will be autocaptured with a specific label",
+  [
+    {
+      "$el_text": "I have the property \"ph-label\" which means touching me will be autocaptured with a specific label",
       "attr__ph-label": "special-text",
       "attr__testID": "example-ph-label",
       "tag_name": "special-text",
     },
-    Object {
-      "$el_text": "I have the property \\"ph-label\\" which means touching me will be autocaptured with a specific label",
+    {
+      "$el_text": "I have the property \"ph-label\" which means touching me will be autocaptured with a specific label",
       "attr__testID": "example-ph-label",
       "tag_name": "higher-level-element",
     },
-    Object {
+    {
       "attr__style": "backgroundColor:rgba(0,0,0,.1);padding:15;borderRadius:10;marginBottom:10",
       "tag_name": "higher-level-element",
     },
-    Object {
+    {
       "attr__ph-label": "higher-level-element",
       "tag_name": "higher-level-element",
     },
-    Object {
+    {
       "attr__style": "flex:1",
       "tag_name": "ScrollView",
     },
-    Object {
+    {
       "attr__style": "flex:1",
       "tag_name": "ScrollView",
     },
-    Object {
+    {
       "tag_name": "PostHogDemoScreen",
     },
-    Object {
+    {
       "tag_name": "StaticContainer",
     },
-    Object {
+    {
       "tag_name": "EnsureSingleNavigator",
     },
-    Object {
+    {
       "tag_name": "SceneView",
     },
-    Object {
+    {
       "attr__style": "flex:1",
       "tag_name": "View",
     },
-    Object {
+    {
       "attr__style": "flex:1;backgroundColor:rgb(242, 242, 242);flexDirection:column-reverse",
       "tag_name": "View",
     },
-    Object {
+    {
       "attr__style": "flex:1;flexDirection:column-reverse",
       "tag_name": "Background",
     },
-    Object {
+    {
       "tag_name": "Screen",
     },
-    Object {
+    {
       "attr__style": "position:absolute;left:0;right:0;top:0;bottom:0;zIndex:0",
       "tag_name": "AnimatedComponent",
     },
-    Object {
+    {
       "tag_name": "MaybeFreeze",
     },
-    Object {
+    {
       "attr__style": "position:absolute;left:0;right:0;top:0;bottom:0;zIndex:0",
       "tag_name": "Screen",
     },
-    Object {
+    {
       "attr__style": "position:absolute;left:0;right:0;top:0;bottom:0;zIndex:0",
       "tag_name": "MaybeScreen",
     },
-    Object {
+    {
       "attr__style": "flex:1;overflow:hidden",
       "tag_name": "ScreenContainer",
     },
-    Object {
+    {
       "attr__style": "flex:1;overflow:hidden",
       "tag_name": "MaybeScreenContainer",
     },
   ],
-  Object {
+  {
     "$touch_x": 1,
     "$touch_y": 2,
   },

posthog-web/CHANGELOG.md

@@ -4,6 +4,7 @@
 - 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
 - Many methods such as `capture` and `identify` no longer return the `this` object instead returning nothing
 - 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.
 
 # 2.6.2 - 2024-02-15