posthog-node 4.0.0 → 4.0.1

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

@@ -37,7 +37,7 @@ export declare type PostHogCoreOptions = {
     featureFlagsRequestTimeoutMs?: number;
     /** For Session Analysis how long before we expire a session (defaults to 30 mins) */
     sessionExpirationTimeSeconds?: number;
-    /** Whether to post events to PostHog in JSON or compressed format */
+    /** Whether to post events to PostHog in JSON or compressed format. Defaults to 'form' */
     captureMode?: 'json' | 'form';
     disableGeoip?: boolean;
 };

package/lib/posthog-node/src/types.d.ts

@@ -47,7 +47,7 @@ export declare type PostHogFeatureFlag = {
                 rollout_percentage: number;
             }[];
         };
-        payloads?: Record<string, JsonType>;
+        payloads?: Record<string, string>;
     };
     deleted: boolean;
     active: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "posthog-node",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "PostHog Node.js integration",
   "repository": {
     "type": "git",

package/src/feature-flags.ts

@@ -148,11 +148,15 @@ class FeatureFlagsPoller {
     }
 
     // Undefined means a loading or missing data issue. Null means evaluation happened and there was no match
-    if (response === undefined) {
+    if (response === undefined || response === null) {
       return null
     }
 
-    return response
+    try {
+      return JSON.parse(response)
+    } catch {
+      return response
+    }
   }
 
   async getAllFlagsAndPayloads(
@@ -308,7 +312,7 @@ class FeatureFlagsPoller {
         let matches = false
 
         if (propertyType === 'cohort') {
-          matches = matchCohort(prop, properties, this.cohorts)
+          matches = matchCohort(prop, properties, this.cohorts, this.debugMode)
         } else {
           matches = matchProperty(prop, properties)
         }
@@ -558,7 +562,8 @@ function matchProperty(
 function matchCohort(
   property: FeatureFlagCondition['properties'][number],
   propertyValues: Record<string, any>,
-  cohortProperties: FeatureFlagsPoller['cohorts']
+  cohortProperties: FeatureFlagsPoller['cohorts'],
+  debugMode: boolean = false
 ): boolean {
   const cohortId = String(property.value)
   if (!(cohortId in cohortProperties)) {
@@ -566,13 +571,14 @@ function matchCohort(
   }
 
   const propertyGroup = cohortProperties[cohortId]
-  return matchPropertyGroup(propertyGroup, propertyValues, cohortProperties)
+  return matchPropertyGroup(propertyGroup, propertyValues, cohortProperties, debugMode)
 }
 
 function matchPropertyGroup(
   propertyGroup: PropertyGroup,
   propertyValues: Record<string, any>,
-  cohortProperties: FeatureFlagsPoller['cohorts']
+  cohortProperties: FeatureFlagsPoller['cohorts'],
+  debugMode: boolean = false
 ): boolean {
   if (!propertyGroup) {
     return true
@@ -592,7 +598,7 @@ function matchPropertyGroup(
     // a nested property group
     for (const prop of properties as PropertyGroup[]) {
       try {
-        const matches = matchPropertyGroup(prop, propertyValues, cohortProperties)
+        const matches = matchPropertyGroup(prop, propertyValues, cohortProperties, debugMode)
         if (propertyGroupType === 'AND') {
           if (!matches) {
             return false
@@ -605,7 +611,9 @@ function matchPropertyGroup(
         }
       } catch (err) {
         if (err instanceof InconclusiveMatchError) {
-          console.debug(`Failed to compute property ${prop} locally: ${err}`)
+          if (debugMode) {
+            console.debug(`Failed to compute property ${prop} locally: ${err}`)
+          }
           errorMatchingLocally = true
         } else {
           throw err
@@ -623,7 +631,7 @@ function matchPropertyGroup(
       try {
         let matches: boolean
         if (prop.type === 'cohort') {
-          matches = matchCohort(prop, propertyValues, cohortProperties)
+          matches = matchCohort(prop, propertyValues, cohortProperties, debugMode)
         } else {
           matches = matchProperty(prop, propertyValues)
         }
@@ -649,7 +657,9 @@ function matchPropertyGroup(
         }
       } catch (err) {
         if (err instanceof InconclusiveMatchError) {
-          console.debug(`Failed to compute property ${prop} locally: ${err}`)
+          if (debugMode) {
+            console.debug(`Failed to compute property ${prop} locally: ${err}`)
+          }
           errorMatchingLocally = true
         } else {
           throw err

package/src/posthog-node.ts

@@ -340,12 +340,7 @@ export class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
         disableGeoip
       )
     }
-
-    try {
-      return JSON.parse(response as any)
-    } catch {
-      return response
-    }
+    return response
   }
 
   async isFeatureEnabled(

package/src/types.ts

@@ -54,7 +54,7 @@ export type PostHogFeatureFlag = {
         rollout_percentage: number
       }[]
     }
-    payloads?: Record<string, JsonType>
+    payloads?: Record<string, string>
   }
   deleted: boolean
   active: boolean

package/test/posthog-node.spec.ts

@@ -466,11 +466,14 @@ describe('PostHog Node.js', () => {
         'feature-2': true,
         'feature-variant': 'variant',
         'disabled-flag': false,
+        'feature-array': true,
       }
 
+      // these are stringified in apiImplementation
       const mockFeatureFlagPayloads = {
         'feature-1': { color: 'blue' },
         'feature-variant': 2,
+        'feature-array': [1],
       }
 
       const multivariateFlag = {
@@ -497,7 +500,7 @@ describe('PostHog Node.js', () => {
               { key: 'third-variant', name: 'Third Variant', rollout_percentage: 25 },
             ],
           },
-          payloads: { 'first-variant': 'some-payload', 'third-variant': { a: 'json' } },
+          payloads: { 'first-variant': 'some-payload', 'third-variant': JSON.stringify({ a: 'json' }) },
         },
       }
       const basicFlag = {
@@ -520,7 +523,7 @@ describe('PostHog Node.js', () => {
               rollout_percentage: 100,
             },
           ],
-          payloads: { true: 300 },
+          payloads: { true: '300' },
         },
       }
       const falseFlag = {
@@ -536,7 +539,23 @@ describe('PostHog Node.js', () => {
               rollout_percentage: 0,
             },
           ],
-          payloads: { true: 300 },
+          payloads: { true: '300' },
+        },
+      }
+
+      const arrayFlag = {
+        id: 5,
+        name: 'Beta Feature',
+        key: 'feature-array',
+        active: true,
+        filters: {
+          groups: [
+            {
+              properties: [],
+              rollout_percentage: 100,
+            },
+          ],
+          payloads: { true: JSON.stringify([1]) },
         },
       }
 
@@ -544,7 +563,7 @@ describe('PostHog Node.js', () => {
         apiImplementation({
           decideFlags: mockFeatureFlags,
           decideFlagPayloads: mockFeatureFlagPayloads,
-          localFlags: { flags: [multivariateFlag, basicFlag, falseFlag] },
+          localFlags: { flags: [multivariateFlag, basicFlag, falseFlag, arrayFlag] },
         })
       )
 
@@ -603,9 +622,10 @@ describe('PostHog Node.js', () => {
           distinct_id: 'distinct_id',
           event: 'node test event',
           properties: expect.objectContaining({
-            $active_feature_flags: ['feature-1', 'feature-2', 'feature-variant'],
+            $active_feature_flags: ['feature-1', 'feature-2', 'feature-variant', 'feature-array'],
             '$feature/feature-1': true,
             '$feature/feature-2': true,
+            '$feature/feature-array': true,
             '$feature/feature-variant': 'variant',
             $lib: 'posthog-node',
             $lib_version: '1.2.3',
@@ -659,8 +679,9 @@ describe('PostHog Node.js', () => {
           distinct_id: 'distinct_id',
           event: 'node test event',
           properties: expect.objectContaining({
-            $active_feature_flags: ['beta-feature-local'],
+            $active_feature_flags: ['beta-feature-local', 'feature-array'],
             '$feature/beta-feature-local': 'third-variant',
+            '$feature/feature-array': true,
             '$feature/false-flag': false,
             $lib: 'posthog-node',
             $lib_version: '1.2.3',
@@ -756,9 +777,10 @@ describe('PostHog Node.js', () => {
       )
 
       expect(getLastBatchEvents()?.[0].properties).toEqual({
-        $active_feature_flags: ['feature-1', 'feature-2', 'feature-variant'],
+        $active_feature_flags: ['feature-1', 'feature-2', 'feature-variant', 'feature-array'],
         '$feature/feature-1': true,
         '$feature/feature-2': true,
+        '$feature/feature-array': true,
         '$feature/disabled-flag': false,
         '$feature/feature-variant': 'variant',
         $lib: 'posthog-node',
@@ -1008,6 +1030,46 @@ describe('PostHog Node.js', () => {
       )
     })
 
+    it('should not double parse json with getFeatureFlagPayloads and local eval', async () => {
+      expect(mockedFetch).toHaveBeenCalledTimes(0)
+
+      posthog = new PostHog('TEST_API_KEY', {
+        host: 'http://example.com',
+        flushAt: 1,
+        fetchRetryCount: 0,
+        personalApiKey: 'TEST_PERSONAL_API_KEY',
+      })
+
+      mockedFetch.mockClear()
+      expect(mockedFetch).toHaveBeenCalledTimes(0)
+
+      await expect(
+        posthog.getFeatureFlagPayload('feature-array', '123', true, { onlyEvaluateLocally: true })
+      ).resolves.toEqual([1])
+      expect(mockedFetch).toHaveBeenCalledTimes(1)
+      expect(mockedFetch).toHaveBeenCalledWith(...anyLocalEvalCall)
+
+      mockedFetch.mockClear()
+
+      await expect(posthog.getFeatureFlagPayload('feature-array', '123')).resolves.toEqual([1])
+      expect(mockedFetch).toHaveBeenCalledTimes(0)
+
+      await expect(posthog.getFeatureFlagPayload('false-flag', '123', true)).resolves.toEqual(300)
+      expect(mockedFetch).toHaveBeenCalledTimes(0)
+    })
+
+    it('should not double parse json with getFeatureFlagPayloads and server eval', async () => {
+      expect(mockedFetch).toHaveBeenCalledTimes(0)
+      await expect(
+        posthog.getFeatureFlagPayload('feature-array', '123', undefined, { groups: { org: '123' } })
+      ).resolves.toEqual([1])
+      expect(mockedFetch).toHaveBeenCalledTimes(1)
+      expect(mockedFetch).toHaveBeenCalledWith(
+        'http://example.com/decide/?v=3',
+        expect.objectContaining({ method: 'POST', body: expect.stringContaining('"geoip_disable":true') })
+      )
+    })
+
     it('should do getFeatureFlagPayloads without matchValue', async () => {
       expect(mockedFetch).toHaveBeenCalledTimes(0)
       await expect(

package/test/test-utils.ts

@@ -20,7 +20,9 @@ export const apiImplementation = ({
           } else {
             return Promise.resolve({
               featureFlags: decideFlags,
-              featureFlagPayloads: decideFlagPayloads,
+              featureFlagPayloads: Object.fromEntries(
+                Object.entries(decideFlagPayloads || {}).map(([k, v]) => [k, JSON.stringify(v)])
+              ),
             })
           }
         },