posthog-node 3.0.0 → 3.1.0

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

@@ -3,7 +3,7 @@ export declare function removeTrailingSlash(url: string): string;
 export interface RetriableOptions {
     retryCount?: number;
     retryDelay?: number;
-    retryCheck?: (err: any) => true;
+    retryCheck?: (err: any) => boolean;
 }
 export declare function retriable<T>(fn: () => Promise<T>, props?: RetriableOptions): Promise<T>;
 export declare function generateUUID(globalThis?: any): string;

package/package.json

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

package/src/feature-flags.ts

@@ -425,7 +425,7 @@ class FeatureFlagsPoller {
     try {
       return await this.fetch(url, options)
     } catch (err) {
-      throw new Error(`Request failed with error: ${err}`)
+      throw err
     } finally {
       clearTimeout(abortTimeout)
     }

package/src/fetch.ts

@@ -10,11 +10,13 @@ export const fetch = async (url: string, options: PostHogFetchOptions): Promise<
     method: options.method.toLowerCase(),
     data: options.body,
     signal: options.signal,
+    // fetch only throws on network errors, not on HTTP errors
+    validateStatus: () => true,
   })
 
   return {
     status: res.status,
-    text: () => res.data,
-    json: () => res.data,
+    text: async () => res.data,
+    json: async () => res.data,
   }
 }

package/test/feature-flags.spec.ts

@@ -1,6 +1,6 @@
-// import { PostHog } from '../'
+// import { PostHog, PostHogOptions } from '../'
 // Uncomment below line while developing to not compile code everytime
-import { PostHog as PostHog } from '../src/posthog-node'
+import { PostHog as PostHog, PostHogOptions } from '../src/posthog-node'
 import { matchProperty, InconclusiveMatchError } from '../src/feature-flags'
 jest.mock('../src/fetch')
 import { fetch } from '../src/fetch'
@@ -9,6 +9,10 @@ jest.spyOn(global.console, 'debug').mockImplementation()
 
 const mockedFetch = jest.mocked(fetch, true)
 
+const posthogImmediateResolveOptions: PostHogOptions = {
+  fetchRetryCount: 0,
+}
+
 export const apiImplementation = ({
   localFlags,
   decideFlags,
@@ -105,6 +109,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     expect(
@@ -151,6 +156,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     // # groups not passed in, hence false
@@ -231,6 +237,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
     // # group_type_mappings not present, so fallback to `/decide`
     expect(
@@ -304,6 +311,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     expect(
@@ -426,6 +434,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     // # beta-feature fallbacks to decide because property type is unknown
@@ -488,6 +497,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     // # beta-feature should fallback to decide because property type is unknown
@@ -536,6 +546,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     // # beta-feature resolves to False
@@ -576,12 +587,20 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
+    })
+
+    let err: any = null
+    posthog.on('error', (e) => {
+      err = e
     })
 
     // # beta-feature2 falls back to decide, which on error returns undefined
     expect(await posthog.getFeatureFlag('beta-feature2', 'some-distinct-id')).toEqual(undefined)
     expect(await posthog.isFeatureEnabled('beta-feature2', 'some-distinct-id')).toEqual(undefined)
     expect(mockedFetch).toHaveBeenCalledWith(...anyDecideCall)
+    await posthog.shutdownAsync()
+    expect(err).toHaveProperty('name', 'PostHogFetchHttpError')
   })
 
   it('experience continuity flags are not evaluated locally', async () => {
@@ -612,6 +631,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     // # beta-feature2 falls back to decide, which on error returns default
@@ -680,6 +700,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     // # beta-feature value overridden by /decide
@@ -763,6 +784,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     // # beta-feature value overridden by /decide
@@ -835,6 +857,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     // # beta-feature2 has no value
@@ -916,6 +939,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     expect(
@@ -940,6 +964,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     expect(await posthog.getAllFlags('distinct-id')).toEqual({
@@ -965,6 +990,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     expect((await posthog.getAllFlagsAndPayloads('distinct-id')).featureFlagPayloads).toEqual({
@@ -1021,6 +1047,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     expect(await posthog.getAllFlags('distinct-id')).toEqual({ 'beta-feature': true, 'disabled-feature': false })
@@ -1079,6 +1106,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     expect((await posthog.getAllFlagsAndPayloads('distinct-id')).featureFlagPayloads).toEqual({ 'beta-feature': 'new' })
@@ -1131,6 +1159,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     expect(await posthog.getAllFlags('distinct-id')).toEqual({ 'beta-feature': true, 'disabled-feature': false })
@@ -1238,6 +1267,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     expect(
@@ -1319,6 +1349,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     expect(
@@ -1408,6 +1439,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     expect(
@@ -1489,6 +1521,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     expect(
@@ -1560,6 +1593,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     expect(
@@ -1632,6 +1666,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     expect(
@@ -1682,6 +1717,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     expect(
@@ -1762,6 +1798,7 @@ describe('local evaluation', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     expect(
@@ -1990,10 +2027,6 @@ describe('consistency tests', () => {
   let posthog: PostHog
   jest.useFakeTimers()
 
-  afterEach(async () => {
-    await posthog.shutdownAsync()
-  })
-
   it('is consistent for simple flags', () => {
     const flags = {
       flags: [
@@ -2015,6 +2048,7 @@ describe('consistency tests', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     const results = [
@@ -3057,6 +3091,7 @@ describe('consistency tests', () => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
       personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
     })
 
     const results = [

package/test/posthog-node.spec.ts

@@ -28,6 +28,7 @@ describe('PostHog Node.js', () => {
   beforeEach(() => {
     posthog = new PostHog('TEST_API_KEY', {
       host: 'http://example.com',
+      fetchRetryCount: 0,
     })
 
     mockedFetch.mockResolvedValue({
@@ -266,8 +267,7 @@ describe('PostHog Node.js', () => {
       // a serverless posthog configuration
       posthog = new PostHog('TEST_API_KEY', {
         host: 'http://example.com',
-        flushAt: 1,
-        flushInterval: 0,
+        fetchRetryCount: 0,
       })
 
       mockedFetch.mockImplementation(async () => {
@@ -290,6 +290,12 @@ describe('PostHog Node.js', () => {
     })
 
     it('should shutdown cleanly', async () => {
+      posthog = new PostHog('TEST_API_KEY', {
+        host: 'http://example.com',
+        fetchRetryCount: 0,
+        flushAt: 1,
+      })
+
       const logSpy = jest.spyOn(global.console, 'log')
       jest.useRealTimers()
       // using debug mode to check console.log output
@@ -319,9 +325,10 @@ describe('PostHog Node.js', () => {
   })
 
   describe('groupIdentify', () => {
-    it('should identify group with unique id', () => {
+    it('should identify group with unique id', async () => {
       posthog.groupIdentify({ groupType: 'posthog', groupKey: 'team-1', properties: { analytics: true } })
       jest.runOnlyPendingTimers()
+      await posthog.flushAsync()
       const batchEvents = getLastBatchEvents()
       expect(batchEvents).toMatchObject([
         {
@@ -338,7 +345,7 @@ describe('PostHog Node.js', () => {
       ])
     })
 
-    it('should allow passing optional distinctID to identify group', () => {
+    it('should allow passing optional distinctID to identify group', async () => {
       posthog.groupIdentify({
         groupType: 'posthog',
         groupKey: 'team-1',
@@ -346,6 +353,7 @@ describe('PostHog Node.js', () => {
         distinctId: '123',
       })
       jest.runOnlyPendingTimers()
+      await posthog.flushAsync()
       const batchEvents = getLastBatchEvents()
       expect(batchEvents).toMatchObject([
         {
@@ -383,6 +391,7 @@ describe('PostHog Node.js', () => {
 
       posthog = new PostHog('TEST_API_KEY', {
         host: 'http://example.com',
+        fetchRetryCount: 0,
       })
     })
 
@@ -413,6 +422,7 @@ describe('PostHog Node.js', () => {
       posthog = new PostHog('TEST_API_KEY', {
         host: 'http://example.com',
         flushAt: 1,
+        fetchRetryCount: 0,
       })
 
       posthog.capture({
@@ -463,6 +473,7 @@ describe('PostHog Node.js', () => {
       posthog = new PostHog('TEST_API_KEY', {
         host: 'http://example.com',
         flushAt: 1,
+        fetchRetryCount: 0,
       })
 
       posthog.capture({
@@ -523,6 +534,7 @@ describe('PostHog Node.js', () => {
         host: 'http://example.com',
         personalApiKey: 'TEST_PERSONAL_API_KEY',
         maxCacheSize: 10,
+        fetchRetryCount: 0,
       })
 
       expect(Object.keys(posthog.distinctIdHasSentFlagCalls).length).toEqual(0)
@@ -581,6 +593,7 @@ describe('PostHog Node.js', () => {
         host: 'http://example.com',
         personalApiKey: 'TEST_PERSONAL_API_KEY',
         maxCacheSize: 10,
+        fetchRetryCount: 0,
       })
 
       expect(