posthog-node 4.5.0 → 4.5.2

package/lib/posthog-node/src/error-tracking.d.ts

@@ -3,7 +3,7 @@ import { PostHog, PostHogOptions } from './posthog-node';
 export default class ErrorTracking {
     private client;
     private _exceptionAutocaptureEnabled;
-    static captureException(client: PostHog, error: unknown, distinctId: string, hint: EventHint, additionalProperties?: Record<string | number, any>): Promise<void>;
+    static captureException(client: PostHog, error: unknown, hint: EventHint, distinctId?: string, additionalProperties?: Record<string | number, any>): Promise<void>;
     constructor(client: PostHog, options: PostHogOptions);
     private startAutocaptureIfEnabled;
     private onException;

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

@@ -76,5 +76,5 @@ export declare class PostHog extends PostHogCoreStateless implements PostHogNode
     reloadFeatureFlags(): Promise<void>;
     shutdown(shutdownTimeoutMs?: number): Promise<void>;
     private addLocalPersonAndGroupProperties;
-    captureException(error: unknown, distinctId: string, additionalProperties?: Record<string | number, any>): void;
+    captureException(error: unknown, distinctId?: string, additionalProperties?: Record<string | number, any>): void;
 }

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

@@ -51,6 +51,7 @@ export type PostHogFeatureFlag = {
     };
     deleted: boolean;
     active: boolean;
+    /** @deprecated This field will be removed in a future version. **/
     is_simple_flag: boolean;
     rollout_percentage: null | number;
     ensure_experience_continuity: boolean;

package/package.json

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

package/src/error-tracking.ts

@@ -15,11 +15,14 @@ export default class ErrorTracking {
   static async captureException(
     client: PostHog,
     error: unknown,
-    distinctId: string,
     hint: EventHint,
+    distinctId?: string,
     additionalProperties?: Record<string | number, any>
   ): Promise<void> {
     const properties: EventMessage['properties'] = { ...additionalProperties }
+
+    // Given stateless nature of Node SDK we capture exceptions using personless processing when no
+    // user can be determined because a distinct_id is not provided e.g. exception autocapture
     if (!distinctId) {
       properties.$process_person_profile = false
     }
@@ -51,9 +54,7 @@ export default class ErrorTracking {
   }
 
   private onException(exception: unknown, hint: EventHint): void {
-    // Given stateless nature of Node SDK we capture exceptions using personless processing
-    // when no user can be determined e.g. in the case of exception autocapture
-    ErrorTracking.captureException(this.client, exception, uuidv7(), hint, { $process_person_profile: false })
+    ErrorTracking.captureException(this.client, exception, hint)
   }
 
   private async onFatalError(): Promise<void> {

package/src/extensions/express.ts

@@ -31,7 +31,7 @@ export function setupExpressErrorHandler(
     const hint = { mechanism: { type: 'middleware', handled: false } }
     // Given stateless nature of Node SDK we capture exceptions using personless processing
     // when no user can be determined e.g. in the case of exception autocapture
-    ErrorTracking.captureException(_posthog, error, uuidv7(), hint, { $process_person_profile: false })
+    ErrorTracking.captureException(_posthog, error, hint, uuidv7(), { $process_person_profile: false })
     next(error)
   })
 }

package/src/posthog-node.ts

@@ -135,8 +135,13 @@ export class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
           return await _getFlags(distinctId, groups, disableGeoip)
         }
 
+        if (event === '$feature_flag_called') {
+          // If we're capturing a $feature_flag_called event, we don't want to enrich the event with cached flags that may be out of date.
+          return {}
+        }
+
         if ((this.featureFlagsPoller?.featureFlags?.length || 0) > 0) {
-          // Otherwise we may as well check for the flags locally and include them if there
+          // Otherwise we may as well check for the flags locally and include them if they are already loaded
           const groupsWithStringValues: Record<string, string> = {}
           for (const [key, value] of Object.entries(groups || {})) {
             groupsWithStringValues[key] = String(value)
@@ -486,8 +491,8 @@ export class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
     return { allPersonProperties, allGroupProperties }
   }
 
-  captureException(error: unknown, distinctId: string, additionalProperties?: Record<string | number, any>): void {
+  captureException(error: unknown, distinctId?: string, additionalProperties?: Record<string | number, any>): void {
     const syntheticException = new Error('PostHog syntheticException')
-    ErrorTracking.captureException(this, error, distinctId, { syntheticException }, additionalProperties)
+    ErrorTracking.captureException(this, error, { syntheticException }, distinctId, additionalProperties)
   }
 }

package/src/types.ts

@@ -58,6 +58,7 @@ export type PostHogFeatureFlag = {
   }
   deleted: boolean
   active: boolean
+  /** @deprecated This field will be removed in a future version. **/
   is_simple_flag: boolean
   rollout_percentage: null | number
   ensure_experience_continuity: boolean

package/test/feature-flags.spec.ts

@@ -5,6 +5,7 @@ import { matchProperty, InconclusiveMatchError, relativeDateParseForFeatureFlagM
 jest.mock('../src/fetch')
 import fetch from '../src/fetch'
 import { anyDecideCall, anyLocalEvalCall, apiImplementation } from './test-utils'
+import { waitForPromises } from 'posthog-core/test/test-utils/test-utils'
 
 jest.spyOn(console, 'debug').mockImplementation()
 
@@ -31,7 +32,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'person-flag',
-          is_simple_flag: true,
           active: true,
           filters: {
             groups: [
@@ -99,7 +99,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'person-flag',
-          is_simple_flag: true,
           active: true,
           filters: {
             groups: [
@@ -143,7 +142,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'group-flag',
-          is_simple_flag: true,
           active: true,
           filters: {
             aggregation_group_type_index: 0,
@@ -222,7 +220,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'group-flag',
-          is_simple_flag: true,
           active: true,
           filters: {
             aggregation_group_type_index: 0,
@@ -271,7 +268,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'complex-flag',
-          is_simple_flag: false,
           active: true,
           filters: {
             groups: [
@@ -547,7 +543,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: true,
           active: true,
           filters: {
             groups: [
@@ -586,7 +581,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: true,
           active: true,
           filters: {
             groups: [
@@ -629,7 +623,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: true,
           active: true,
           ensure_experience_continuity: true,
           filters: {
@@ -665,7 +658,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: false,
           active: true,
           rollout_percentage: 100,
           filters: {
@@ -681,7 +673,6 @@ describe('local evaluation', () => {
           id: 2,
           name: 'Beta Feature',
           key: 'disabled-feature',
-          is_simple_flag: false,
           active: true,
           filters: {
             groups: [
@@ -696,7 +687,6 @@ describe('local evaluation', () => {
           id: 3,
           name: 'Beta Feature',
           key: 'beta-feature2',
-          is_simple_flag: false,
           active: true,
           filters: {
             groups: [
@@ -739,7 +729,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: false,
           active: true,
           rollout_percentage: 100,
           filters: {
@@ -758,7 +747,6 @@ describe('local evaluation', () => {
           id: 2,
           name: 'Beta Feature',
           key: 'disabled-feature',
-          is_simple_flag: false,
           active: true,
           filters: {
             groups: [
@@ -776,7 +764,6 @@ describe('local evaluation', () => {
           id: 3,
           name: 'Beta Feature',
           key: 'beta-feature2',
-          is_simple_flag: false,
           active: true,
           filters: {
             groups: [
@@ -822,7 +809,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: false,
           active: true,
           rollout_percentage: 100,
           filters: {
@@ -838,7 +824,6 @@ describe('local evaluation', () => {
           id: 2,
           name: 'Beta Feature',
           key: 'disabled-feature',
-          is_simple_flag: false,
           active: true,
           filters: {
             groups: [
@@ -853,7 +838,6 @@ describe('local evaluation', () => {
           id: 3,
           name: 'Beta Feature',
           key: 'beta-feature2',
-          is_simple_flag: false,
           active: true,
           filters: {
             groups: [
@@ -894,7 +878,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: false,
           active: true,
           rollout_percentage: 100,
           filters: {
@@ -913,7 +896,6 @@ describe('local evaluation', () => {
           id: 2,
           name: 'Beta Feature',
           key: 'disabled-feature',
-          is_simple_flag: false,
           active: true,
           filters: {
             groups: [
@@ -931,7 +913,6 @@ describe('local evaluation', () => {
           id: 3,
           name: 'Beta Feature',
           key: 'beta-feature2',
-          is_simple_flag: false,
           active: true,
           filters: {
             groups: [
@@ -1027,7 +1008,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: false,
           active: true,
           rollout_percentage: 100,
           filters: {
@@ -1043,7 +1023,6 @@ describe('local evaluation', () => {
           id: 2,
           name: 'Beta Feature',
           key: 'disabled-feature',
-          is_simple_flag: false,
           active: true,
           filters: {
             groups: [
@@ -1080,7 +1059,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: false,
           active: true,
           rollout_percentage: 100,
           filters: {
@@ -1099,7 +1077,6 @@ describe('local evaluation', () => {
           id: 2,
           name: 'Beta Feature',
           key: 'disabled-feature',
-          is_simple_flag: false,
           active: true,
           filters: {
             groups: [
@@ -1139,7 +1116,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: false,
           active: true,
           rollout_percentage: 100,
           filters: {
@@ -1155,7 +1131,6 @@ describe('local evaluation', () => {
           id: 2,
           name: 'Beta Feature',
           key: 'disabled-feature',
-          is_simple_flag: false,
           active: true,
           filters: {
             groups: [
@@ -1191,7 +1166,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: false,
           active: false,
           rollout_percentage: 100,
           filters: {
@@ -1207,7 +1181,6 @@ describe('local evaluation', () => {
           id: 2,
           name: 'Beta Feature',
           key: 'disabled-feature',
-          is_simple_flag: false,
           active: true,
           filters: {
             groups: [
@@ -1236,7 +1209,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: false,
           active: true,
           rollout_percentage: 100,
           filters: {
@@ -1318,7 +1290,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: false,
           active: true,
           rollout_percentage: 100,
           filters: {
@@ -1409,7 +1380,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: true,
           active: true,
           filters: {
             groups: [
@@ -1478,7 +1448,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: true,
           active: true,
           filters: {
             groups: [
@@ -1563,7 +1532,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: true,
           active: true,
           filters: {
             groups: [
@@ -1632,7 +1600,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: true,
           active: true,
           filters: {
             groups: [
@@ -1706,7 +1673,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'person-flag',
-          is_simple_flag: true,
           active: true,
           filters: {
             groups: [
@@ -1765,7 +1731,6 @@ describe('local evaluation', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'beta-feature',
-          is_simple_flag: true,
           active: true,
           filters: {
             groups: [
@@ -1832,6 +1797,84 @@ describe('local evaluation', () => {
   })
 })
 
+describe('getFeatureFlag', () => {
+  it('should capture $feature_flag_called when called, but not add all cached flags', async () => {
+    const flags = {
+      flags: [
+        {
+          id: 1,
+          name: 'Beta Feature',
+          key: 'complex-flag',
+          active: true,
+          filters: {
+            groups: [
+              {
+                variant: null,
+                properties: [{ key: 'region', type: 'person', value: 'USA', operator: 'exact' }],
+                rollout_percentage: 100,
+              },
+            ],
+          },
+        },
+        {
+          id: 2,
+          name: 'Gamma Feature',
+          key: 'simple-flag',
+          active: true,
+          filters: {
+            groups: [
+              {
+                variant: null,
+                properties: [],
+                rollout_percentage: 100,
+              },
+            ],
+          },
+        },
+      ],
+    }
+    mockedFetch.mockImplementation(apiImplementation({ localFlags: flags }))
+    const posthog = new PostHog('TEST_API_KEY', {
+      host: 'http://example.com',
+      personalApiKey: 'TEST_PERSONAL_API_KEY',
+      ...posthogImmediateResolveOptions,
+    })
+    let capturedMessage: any
+    posthog.on('capture', (message) => {
+      capturedMessage = message
+    })
+
+    expect(
+      await posthog.getFeatureFlag('complex-flag', 'some-distinct-id', {
+        personProperties: {
+          region: 'USA',
+        } as unknown as Record<string, string>,
+      })
+    ).toEqual(true)
+
+    await waitForPromises()
+
+    expect(capturedMessage).toMatchObject({
+      distinct_id: 'some-distinct-id',
+      event: '$feature_flag_called',
+      library: posthog.getLibraryId(),
+      library_version: posthog.getLibraryVersion(),
+      properties: {
+        '$feature/complex-flag': true,
+        $feature_flag: 'complex-flag',
+        $feature_flag_response: true,
+        $groups: undefined,
+        $lib: posthog.getLibraryId(),
+        $lib_version: posthog.getLibraryVersion(),
+        locally_evaluated: true,
+      },
+    })
+
+    expect(capturedMessage.properties).not.toHaveProperty('$active_feature_flags')
+    expect(capturedMessage.properties).not.toHaveProperty('$feature/simple-flag')
+  })
+})
+
 describe('match properties', () => {
   jest.useFakeTimers()
 
@@ -2073,8 +2116,8 @@ describe('match properties', () => {
     ['is_date_after', '1h', new Date('2022-05-30'), true],
     ['is_date_after', '1h', '2022-04-30', false],
     // # Try all possible relative dates
-    ['is_date_before', '1h', '2022-05-01 00:00:00', false],
-    ['is_date_before', '1h', '2022-04-30 22:00:00', true],
+    ['is_date_before', '1h', '2022-05-01 00:00:00 GMT', false],
+    ['is_date_before', '1h', '2022-04-30 22:00:00 GMT', true],
     ['is_date_before', '-1d', '2022-04-29 23:59:00 GMT', true],
     ['is_date_before', '-1d', '2022-04-30 00:00:01 GMT', false],
     ['is_date_before', '1w', '2022-04-23 00:00:00 GMT', true],
@@ -2357,7 +2400,6 @@ describe('consistency tests', () => {
           name: '',
           key: 'simple-flag',
           active: true,
-          is_simple_flag: false,
           filters: {
             groups: [{ properties: [], rollout_percentage: 45 }],
           },
@@ -3390,7 +3432,6 @@ describe('consistency tests', () => {
           id: 1,
           name: 'Beta Feature',
           key: 'multivariate-flag',
-          is_simple_flag: false,
           active: true,
           filters: {
             groups: [{ properties: [], rollout_percentage: 55 }],

package/test/posthog-node.spec.ts

@@ -506,7 +506,6 @@ describe('PostHog Node.js', () => {
         id: 1,
         name: 'Beta Feature',
         key: 'beta-feature-local',
-        is_simple_flag: false,
         active: true,
         rollout_percentage: 100,
         filters: {
@@ -533,7 +532,6 @@ describe('PostHog Node.js', () => {
         id: 1,
         name: 'Beta Feature',
         key: 'person-flag',
-        is_simple_flag: true,
         active: true,
         filters: {
           groups: [
@@ -556,7 +554,6 @@ describe('PostHog Node.js', () => {
         id: 1,
         name: 'Beta Feature',
         key: 'false-flag',
-        is_simple_flag: true,
         active: true,
         filters: {
           groups: [
@@ -1081,7 +1078,9 @@ describe('PostHog Node.js', () => {
       expect(mockedFetch).toHaveBeenCalledTimes(0)
 
       await expect(posthog.getFeatureFlagPayload('false-flag', '123', true)).resolves.toEqual(300)
-      expect(mockedFetch).toHaveBeenCalledTimes(0)
+      // Check no non-batch API calls were made
+      const additionalNonBatchCalls = mockedFetch.mock.calls.filter((call) => !call[0].includes('/batch'))
+      expect(additionalNonBatchCalls.length).toBe(0)
     })
 
     it('should not double parse json with getFeatureFlagPayloads and server eval', async () => {