posthog-node 4.3.1 → 4.3.2

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

@@ -140,7 +140,7 @@ export type PostHogNodeV1 = {
     }): Promise<string | boolean | undefined>;
     /**
      * @description Retrieves payload associated with the specified flag and matched value that is passed in.
-     * (Expected to be used in conjuction with getFeatureFlag but allows for manual lookup).
+     * (Expected to be used in conjunction with getFeatureFlag but allows for manual lookup).
      * If matchValue isn't passed, getFeatureFlag is called implicitly.
      * Will try to evaluate for payload locally first otherwise default to network call if allowed
      *

package/package.json

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

package/src/posthog-node.ts

@@ -294,80 +294,59 @@ export class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
       disableGeoip?: boolean
     }
   ): Promise<JsonType | undefined> {
-    const { groups, disableGeoip, onlyEvaluateLocally = false, personProperties, groupProperties } = options || {}
+    const { groups, disableGeoip } = options || {}
+    let { onlyEvaluateLocally, sendFeatureFlagEvents, personProperties, groupProperties } = options || {}
 
-    const { allPersonProperties, allGroupProperties } = this.addLocalPersonAndGroupProperties(
+    const adjustedProperties = this.addLocalPersonAndGroupProperties(
       distinctId,
       groups,
       personProperties,
       groupProperties
     )
 
-    if (matchValue === undefined) {
+    personProperties = adjustedProperties.allPersonProperties
+    groupProperties = adjustedProperties.allGroupProperties
+
+    let response = undefined
+
+    // Try to get match value locally if not provided
+    if (!matchValue) {
       matchValue = await this.getFeatureFlag(key, distinctId, {
         ...options,
         onlyEvaluateLocally: true,
-        sendFeatureFlagEvents: false,
       })
     }
 
-    let response: string | boolean | undefined
-    let payload: JsonType | undefined
-
     if (matchValue) {
-      response = matchValue
-      payload = await this.featureFlagsPoller?.computeFeatureFlagPayloadLocally(key, matchValue)
-    } else {
-      response = undefined
-      payload = undefined
+      response = await this.featureFlagsPoller?.computeFeatureFlagPayloadLocally(key, matchValue)
+    }
+
+    // set defaults
+    if (onlyEvaluateLocally == undefined) {
+      onlyEvaluateLocally = false
+    }
+    if (sendFeatureFlagEvents == undefined) {
+      sendFeatureFlagEvents = true
     }
 
-    // Determine if the payload was evaluated locally
-    const payloadWasLocallyEvaluated = payload !== undefined
+    // set defaults
+    if (onlyEvaluateLocally == undefined) {
+      onlyEvaluateLocally = false
+    }
 
-    // Fetch final flags and payloads either locally or from the remote server
-    let fetchedOrLocalFlags: Record<string, string | boolean> | undefined
-    let fetchedOrLocalPayloads: Record<string, JsonType | undefined> | undefined
+    const payloadWasLocallyEvaluated = response !== undefined
 
-    if (payloadWasLocallyEvaluated || onlyEvaluateLocally) {
-      if (response !== undefined) {
-        fetchedOrLocalFlags = { [key]: response }
-        fetchedOrLocalPayloads = { [key]: payload }
-      } else {
-        fetchedOrLocalFlags = {}
-        fetchedOrLocalPayloads = {}
-      }
-    } else {
-      const fetchedData = await super.getFeatureFlagsAndPayloadsStateless(
+    if (!payloadWasLocallyEvaluated && !onlyEvaluateLocally) {
+      response = await super.getFeatureFlagPayloadStateless(
+        key,
         distinctId,
         groups,
-        allPersonProperties,
-        allGroupProperties,
+        personProperties,
+        groupProperties,
         disableGeoip
       )
-      fetchedOrLocalFlags = fetchedData.flags || {}
-      fetchedOrLocalPayloads = fetchedData.payloads || {}
     }
-
-    const finalResponse = fetchedOrLocalFlags[key]
-    const finalPayload = fetchedOrLocalPayloads[key]
-    const finalLocallyEvaluated = payloadWasLocallyEvaluated
-
-    this.capture({
-      distinctId,
-      event: '$feature_flag_called',
-      properties: {
-        $feature_flag: key,
-        $feature_flag_response: finalResponse,
-        $feature_flag_payload: finalPayload,
-        locally_evaluated: finalLocallyEvaluated,
-        [`$feature/${key}`]: finalResponse,
-      },
-      groups,
-      disableGeoip,
-    })
-
-    return finalPayload
+    return response
   }
 
   async isFeatureEnabled(

package/src/types.ts

@@ -158,7 +158,7 @@ export type PostHogNodeV1 = {
 
   /**
    * @description Retrieves payload associated with the specified flag and matched value that is passed in.
-   * (Expected to be used in conjuction with getFeatureFlag but allows for manual lookup).
+   * (Expected to be used in conjunction with getFeatureFlag but allows for manual lookup).
    * If matchValue isn't passed, getFeatureFlag is called implicitly.
    * Will try to evaluate for payload locally first otherwise default to network call if allowed
    *

package/test/posthog-node.spec.ts

@@ -897,18 +897,13 @@ describe('PostHog Node.js', () => {
                   rollout_percentage: 100,
                 },
               ],
-              payloads: { true: { variant: 'A' } },
             },
           },
         ],
       }
 
       mockedFetch.mockImplementation(
-        apiImplementation({
-          localFlags: flags,
-          decideFlags: { 'decide-flag': 'decide-value' },
-          decideFlagPayloads: { 'beta-feature': { variant: 'A' } },
-        })
+        apiImplementation({ localFlags: flags, decideFlags: { 'decide-flag': 'decide-value' } })
       )
 
       posthog = new PostHog('TEST_API_KEY', {
@@ -950,34 +945,6 @@ describe('PostHog Node.js', () => {
       )
       mockedFetch.mockClear()
 
-      expect(
-        await posthog.getFeatureFlagPayload('beta-feature', 'some-distinct-id', undefined, {
-          personProperties: { region: 'USA', name: 'Aloha' },
-        })
-      ).toEqual({ variant: 'A' })
-
-      // TRICKY: There's now an extra step before events are queued, so need to wait for that to resolve
-      jest.runOnlyPendingTimers()
-      await waitForPromises()
-      await posthog.flush()
-
-      expect(mockedFetch).toHaveBeenCalledWith('http://example.com/batch/', expect.any(Object))
-
-      expect(getLastBatchEvents()?.[0]).toEqual(
-        expect.objectContaining({
-          distinct_id: 'some-distinct-id',
-          event: '$feature_flag_called',
-          properties: expect.objectContaining({
-            $feature_flag: 'beta-feature',
-            $feature_flag_response: true,
-            $feature_flag_payload: { variant: 'A' },
-            locally_evaluated: true,
-            [`$feature/${'beta-feature'}`]: true,
-          }),
-        })
-      )
-      mockedFetch.mockClear()
-
       // # called again for same user, shouldn't call capture again
       expect(
         await posthog.getFeatureFlag('beta-feature', 'some-distinct-id', {
@@ -1114,7 +1081,7 @@ describe('PostHog Node.js', () => {
       expect(mockedFetch).toHaveBeenCalledTimes(0)
 
       await expect(posthog.getFeatureFlagPayload('false-flag', '123', true)).resolves.toEqual(300)
-      expect(mockedFetch).toHaveBeenCalledTimes(1) // this now calls the server, because in this case the flag is not locally evaluated but we have a payload that we need to calculate
+      expect(mockedFetch).toHaveBeenCalledTimes(0)
     })
 
     it('should not double parse json with getFeatureFlagPayloads and server eval', async () => {