posthog-node 2.5.0 → 2.5.2

package/lib/posthog-core/src/index.d.ts

@@ -11,6 +11,7 @@ export declare abstract class PostHogCoreStateless {
     private requestTimeout;
     private captureMode;
     private removeDebugCallback?;
+    private pendingPromises;
     private _optoutOverride;
     protected _events: SimpleEventEmitter;
     protected _flushTimer?: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "posthog-node",
-  "version": "2.5.0",
+  "version": "2.5.2",
   "description": "PostHog Node.js integration",
   "repository": "PostHog/posthog-node",
   "scripts": {

package/src/posthog-node.ts

@@ -117,7 +117,12 @@ export class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
   }
 
   identify({ distinctId, properties }: IdentifyMessageV1): void {
-    super.identifyStateless(distinctId, properties)
+    // Catch properties passed as $set and move them to the top level
+    const personProperties = properties?.$set || properties
+
+    super.identifyStateless(distinctId, {
+      $set: personProperties,
+    })
   }
 
   alias(data: { distinctId: string; alias: string }): void {

package/test/posthog-node.spec.ts

@@ -3,7 +3,7 @@ import { PostHog as PostHog } from '../src/posthog-node'
 jest.mock('../src/fetch')
 import { fetch } from '../src/fetch'
 import { anyDecideCall, anyLocalEvalCall, apiImplementation } from './feature-flags.spec'
-import { waitForPromises } from '../../posthog-core/test/test-utils/test-utils'
+import { waitForPromises, wait } from '../../posthog-core/test/test-utils/test-utils'
 
 jest.mock('../package.json', () => ({ version: '1.2.3' }))
 
@@ -114,7 +114,27 @@ describe('PostHog Node.js', () => {
           distinct_id: '123',
           event: '$identify',
           properties: {
-            foo: 'bar',
+            $set: {
+              foo: 'bar',
+            },
+          },
+        },
+      ])
+    })
+
+    it('should handle identify mistakenly using $set', async () => {
+      expect(mockedFetch).toHaveBeenCalledTimes(0)
+      posthog.identify({ distinctId: '123', properties: { foo: 'bar', $set: { foo: 'other' } } })
+      jest.runOnlyPendingTimers()
+      const batchEvents = getLastBatchEvents()
+      expect(batchEvents).toMatchObject([
+        {
+          distinct_id: '123',
+          event: '$identify',
+          properties: {
+            $set: {
+              foo: 'other',
+            },
           },
         },
       ])
@@ -152,6 +172,63 @@ describe('PostHog Node.js', () => {
     })
   })
 
+  describe('shutdown', () => {
+    beforeEach(() => {
+      // a serverless posthog configuration
+      posthog = new PostHog('TEST_API_KEY', {
+        host: 'http://example.com',
+        flushAt: 1,
+        flushInterval: 0,
+      })
+
+      mockedFetch.mockImplementation(async () => {
+        // simulate network delay
+        await wait(500)
+
+        return Promise.resolve({
+          status: 200,
+          text: () => Promise.resolve('ok'),
+          json: () =>
+            Promise.resolve({
+              status: 'ok',
+            }),
+        } as any)
+      })
+    })
+
+    afterEach(() => {
+      posthog.debug(false)
+    })
+
+    it('should shutdown cleanly', async () => {
+      const logSpy = jest.spyOn(global.console, 'log')
+      jest.useRealTimers()
+      // using debug mode to check console.log output
+      // which tells us when the flush is complete
+      posthog.debug(true)
+      for (let i = 0; i < 10; i++) {
+        posthog.capture({ event: 'test-event', distinctId: '123' })
+        // requests come 100ms apart
+        await wait(100)
+      }
+
+      // 10 capture calls to debug log
+      // 6 flush calls to debug log
+      expect(logSpy).toHaveBeenCalledTimes(16)
+      expect(10).toEqual(logSpy.mock.calls.filter((call) => call[1].includes('capture')).length)
+      expect(6).toEqual(logSpy.mock.calls.filter((call) => call[1].includes('flush')).length)
+
+      logSpy.mockClear()
+
+      await posthog.shutdownAsync()
+      // remaining 4 flush calls to debug log
+      // happen during shutdown
+      expect(4).toEqual(logSpy.mock.calls.filter((call) => call[1].includes('flush')).length)
+      jest.useFakeTimers()
+      logSpy.mockRestore()
+    })
+  })
+
   describe('groupIdentify', () => {
     it('should identify group with unique id', () => {
       posthog.groupIdentify({ groupType: 'posthog', groupKey: 'team-1', properties: { analytics: true } })