posthog-node 2.5.2 → 2.5.4

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

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

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

@@ -27,7 +27,9 @@ declare class FeatureFlagsPoller {
     host: FeatureFlagsPollerOptions['host'];
     poller?: NodeJS.Timeout;
     fetch: (url: string, options: PostHogFetchOptions) => Promise<PostHogFetchResponse>;
+    debugMode: boolean;
     constructor({ pollingInterval, personalApiKey, projectApiKey, timeout, host, ...options }: FeatureFlagsPollerOptions);
+    debug(enabled?: boolean): void;
     getFeatureFlag(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>): Promise<string | boolean | undefined>;
     computeFeatureFlagPayloadLocally(key: string, matchValue: string | boolean): Promise<JsonType | undefined>;
     getAllFlagsAndPayloads(distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>): Promise<{

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

@@ -23,6 +23,7 @@ export declare class PostHog extends PostHogCoreStateless implements PostHogNode
     getCustomUserAgent(): string;
     enable(): void;
     disable(): void;
+    debug(enabled?: boolean): void;
     capture({ distinctId, event, properties, groups, sendFeatureFlags, timestamp }: EventMessageV1): void;
     identify({ distinctId, properties }: IdentifyMessageV1): void;
     alias(data: {
@@ -62,7 +63,7 @@ export declare class PostHog extends PostHogCoreStateless implements PostHogNode
         groupProperties?: Record<string, Record<string, string>>;
         onlyEvaluateLocally?: boolean;
     }): Promise<PosthogFlagsAndPayloadsResponse>;
-    groupIdentify({ groupType, groupKey, properties }: GroupIdentifyMessage): void;
+    groupIdentify({ groupType, groupKey, properties, distinctId }: GroupIdentifyMessage): void;
     reloadFeatureFlags(): Promise<void>;
     shutdown(): void;
     shutdownAsync(): Promise<void>;

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

@@ -13,6 +13,7 @@ export interface GroupIdentifyMessage {
     groupType: string;
     groupKey: string;
     properties?: Record<string | number, any>;
+    distinctId?: string;
 }
 export declare type FeatureFlagCondition = {
     properties: {

package/package.json

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

package/src/feature-flags.ts

@@ -51,6 +51,7 @@ class FeatureFlagsPoller {
   host: FeatureFlagsPollerOptions['host']
   poller?: NodeJS.Timeout
   fetch: (url: string, options: PostHogFetchOptions) => Promise<PostHogFetchResponse>
+  debugMode: boolean = false
 
   constructor({
     pollingInterval,
@@ -76,6 +77,10 @@ class FeatureFlagsPoller {
     void this.loadFeatureFlags()
   }
 
+  debug(enabled: boolean = true): void {
+    this.debugMode = enabled
+  }
+
   async getFeatureFlag(
     key: string,
     distinctId: string,
@@ -102,9 +107,14 @@ class FeatureFlagsPoller {
     if (featureFlag !== undefined) {
       try {
         response = this.computeFlagLocally(featureFlag, distinctId, groups, personProperties, groupProperties)
+        if (this.debugMode) {
+          console.debug(`Successfully computed flag locally: ${key} -> ${response}`)
+        }
       } catch (e) {
         if (e instanceof InconclusiveMatchError) {
-          console.error(`InconclusiveMatchError when computing flag locally: ${key}: ${e}`)
+          if (this.debugMode) {
+            console.debug(`InconclusiveMatchError when computing flag locally: ${key}: ${e}`)
+          }
         } else if (e instanceof Error) {
           console.error(`Error computing flag locally: ${key}: ${e}`)
         }

package/src/posthog-node.ts

@@ -92,6 +92,11 @@ export class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
     return super.optOut()
   }
 
+  debug(enabled: boolean = true): void {
+    super.debug(enabled)
+    this.featureFlagsPoller?.debug(enabled)
+  }
+
   capture({ distinctId, event, properties, groups, sendFeatureFlags, timestamp }: EventMessageV1): void {
     const _capture = (props: EventMessageV1['properties']): void => {
       super.captureStateless(distinctId, event, props, { timestamp })
@@ -102,11 +107,14 @@ export class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
         const featureVariantProperties: Record<string, string | boolean> = {}
         if (flags) {
           for (const [feature, variant] of Object.entries(flags)) {
-            featureVariantProperties[`$feature/${feature}`] = variant
+            if (variant !== false) {
+              featureVariantProperties[`$feature/${feature}`] = variant
+            }
           }
         }
+        const activeFlags = Object.keys(flags || {}).filter((flag) => flags?.[flag] !== false)
         const flagProperties = {
-          $active_feature_flags: flags ? Object.keys(flags) : undefined,
+          $active_feature_flags: activeFlags || undefined,
           ...featureVariantProperties,
         }
         _capture({ ...properties, $groups: groups, ...flagProperties })
@@ -332,8 +340,8 @@ export class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
     return { featureFlags, featureFlagPayloads }
   }
 
-  groupIdentify({ groupType, groupKey, properties }: GroupIdentifyMessage): void {
-    super.groupIdentifyStateless(groupType, groupKey, properties)
+  groupIdentify({ groupType, groupKey, properties, distinctId }: GroupIdentifyMessage): void {
+    super.groupIdentifyStateless(groupType, groupKey, properties, undefined, distinctId)
   }
 
   async reloadFeatureFlags(): Promise<void> {

package/src/types.ts

@@ -16,6 +16,7 @@ export interface GroupIdentifyMessage {
   groupType: string
   groupKey: string // Unique identifier for the group
   properties?: Record<string | number, any>
+  distinctId?: string // optional distinctId to associate message with a person
 }
 
 export type FeatureFlagCondition = {

package/test/posthog-node.spec.ts

@@ -234,7 +234,6 @@ describe('PostHog Node.js', () => {
       posthog.groupIdentify({ groupType: 'posthog', groupKey: 'team-1', properties: { analytics: true } })
       jest.runOnlyPendingTimers()
       const batchEvents = getLastBatchEvents()
-      console.log(batchEvents)
       expect(batchEvents).toMatchObject([
         {
           distinct_id: '$posthog_team-1',
@@ -248,6 +247,29 @@ describe('PostHog Node.js', () => {
         },
       ])
     })
+
+    it('should allow passing optional distinctID to identify group', () => {
+      posthog.groupIdentify({
+        groupType: 'posthog',
+        groupKey: 'team-1',
+        properties: { analytics: true },
+        distinctId: '123',
+      })
+      jest.runOnlyPendingTimers()
+      const batchEvents = getLastBatchEvents()
+      expect(batchEvents).toMatchObject([
+        {
+          distinct_id: '123',
+          event: '$groupidentify',
+          properties: {
+            $group_type: 'posthog',
+            $group_key: 'team-1',
+            $group_set: { analytics: true },
+            $lib: 'posthog-node',
+          },
+        },
+      ])
+    })
   })
 
   describe('feature flags', () => {
@@ -256,6 +278,7 @@ describe('PostHog Node.js', () => {
         'feature-1': true,
         'feature-2': true,
         'feature-variant': 'variant',
+        'disabled-flag': false,
       }
 
       const mockFeatureFlagPayloads = {