posthog-node 2.6.0 → 3.0.0

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+# 3.0.0 - 2023-04-14
+
+Breaking change:
+
+All events by default now send the `$geoip_disable` property to disable geoip lookup in app. This is because usually we don't
+want to update person properties to take the server's location.
+
+The same now happens for feature flag requests, where we discard the IP address of the server for matching on geoip properties like city, country, continent.
+
+To restore previous behaviour, you can set the default to False like so:
+
+```javascript
+const posthog = new PostHog(PH_API_KEY, {
+  host: PH_HOST,
+  disableGeoip: false
+})
+```
+
 # 2.6.0 - 2023-03-14
 
 1. Add support for all cohorts local evaluation in feature flags.

package/lib/index.cjs.js

@@ -163,7 +163,7 @@ function __spreadArray(to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 }
 
-var version = "2.6.0";
+var version = "3.0.0";
 
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
@@ -724,9 +724,10 @@ var SimpleEventEmitter = /** @class */ (function () {
 
 var PostHogCoreStateless = /** @class */ (function () {
     function PostHogCoreStateless(apiKey, options) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         this.debugMode = false;
         this.pendingPromises = {};
+        this.disableGeoip = true;
         // internal
         this._events = new SimpleEventEmitter();
         assert(apiKey, "You must pass your PostHog project's api key.");
@@ -742,6 +743,7 @@ var PostHogCoreStateless = /** @class */ (function () {
             retryDelay: (_c = options === null || options === void 0 ? void 0 : options.fetchRetryDelay) !== null && _c !== void 0 ? _c : 3000,
         };
         this.requestTimeout = (_d = options === null || options === void 0 ? void 0 : options.requestTimeout) !== null && _d !== void 0 ? _d : 10000; // 10 seconds
+        this.disableGeoip = (_e = options === null || options === void 0 ? void 0 : options.disableGeoip) !== null && _e !== void 0 ? _e : true;
     }
     PostHogCoreStateless.prototype.getCommonEventProperties = function () {
         return {
@@ -801,13 +803,13 @@ var PostHogCoreStateless = /** @class */ (function () {
         this.enqueue('capture', payload, options);
         return this;
     };
-    PostHogCoreStateless.prototype.aliasStateless = function (alias, distinctId, properties) {
+    PostHogCoreStateless.prototype.aliasStateless = function (alias, distinctId, properties, options) {
         var payload = this.buildPayload({
             event: '$create_alias',
             distinct_id: distinctId,
             properties: __assign(__assign({}, (properties || {})), { distinct_id: distinctId, alias: alias }),
         });
-        this.enqueue('alias', payload);
+        this.enqueue('alias', payload, options);
         return this;
     };
     /***
@@ -848,7 +850,7 @@ var PostHogCoreStateless = /** @class */ (function () {
             });
         });
     };
-    PostHogCoreStateless.prototype.getFeatureFlagStateless = function (key, distinctId, groups, personProperties, groupProperties) {
+    PostHogCoreStateless.prototype.getFeatureFlagStateless = function (key, distinctId, groups, personProperties, groupProperties, disableGeoip) {
         if (groups === void 0) { groups = {}; }
         if (personProperties === void 0) { personProperties = {}; }
         if (groupProperties === void 0) { groupProperties = {}; }
@@ -856,7 +858,7 @@ var PostHogCoreStateless = /** @class */ (function () {
             var featureFlags, response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getFeatureFlagsStateless(distinctId, groups, personProperties, groupProperties)];
+                    case 0: return [4 /*yield*/, this.getFeatureFlagsStateless(distinctId, groups, personProperties, groupProperties, disableGeoip)];
                     case 1:
                         featureFlags = _a.sent();
                         if (!featureFlags) {
@@ -875,7 +877,7 @@ var PostHogCoreStateless = /** @class */ (function () {
             });
         });
     };
-    PostHogCoreStateless.prototype.getFeatureFlagPayloadStateless = function (key, distinctId, groups, personProperties, groupProperties) {
+    PostHogCoreStateless.prototype.getFeatureFlagPayloadStateless = function (key, distinctId, groups, personProperties, groupProperties, disableGeoip) {
         if (groups === void 0) { groups = {}; }
         if (personProperties === void 0) { personProperties = {}; }
         if (groupProperties === void 0) { groupProperties = {}; }
@@ -883,7 +885,7 @@ var PostHogCoreStateless = /** @class */ (function () {
             var payloads, response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getFeatureFlagPayloadsStateless(distinctId, groups, personProperties, groupProperties)];
+                    case 0: return [4 /*yield*/, this.getFeatureFlagPayloadsStateless(distinctId, groups, personProperties, groupProperties, disableGeoip)];
                     case 1:
                         payloads = _a.sent();
                         if (!payloads) {
@@ -899,7 +901,7 @@ var PostHogCoreStateless = /** @class */ (function () {
             });
         });
     };
-    PostHogCoreStateless.prototype.getFeatureFlagPayloadsStateless = function (distinctId, groups, personProperties, groupProperties) {
+    PostHogCoreStateless.prototype.getFeatureFlagPayloadsStateless = function (distinctId, groups, personProperties, groupProperties, disableGeoip) {
         if (groups === void 0) { groups = {}; }
         if (personProperties === void 0) { personProperties = {}; }
         if (groupProperties === void 0) { groupProperties = {}; }
@@ -908,7 +910,7 @@ var PostHogCoreStateless = /** @class */ (function () {
             var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getFeatureFlagsAndPayloadsStateless(distinctId, groups, personProperties, groupProperties)];
+                    case 0: return [4 /*yield*/, this.getFeatureFlagsAndPayloadsStateless(distinctId, groups, personProperties, groupProperties, disableGeoip)];
                     case 1:
                         payloads = (_a.sent()).payloads;
                         if (payloads) {
@@ -930,28 +932,33 @@ var PostHogCoreStateless = /** @class */ (function () {
             return response;
         }
     };
-    PostHogCoreStateless.prototype.getFeatureFlagsStateless = function (distinctId, groups, personProperties, groupProperties) {
+    PostHogCoreStateless.prototype.getFeatureFlagsStateless = function (distinctId, groups, personProperties, groupProperties, disableGeoip) {
         if (groups === void 0) { groups = {}; }
         if (personProperties === void 0) { personProperties = {}; }
         if (groupProperties === void 0) { groupProperties = {}; }
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getFeatureFlagsAndPayloadsStateless(distinctId, groups, personProperties, groupProperties)];
+                    case 0: return [4 /*yield*/, this.getFeatureFlagsAndPayloadsStateless(distinctId, groups, personProperties, groupProperties, disableGeoip)];
                     case 1: return [2 /*return*/, (_a.sent()).flags];
                 }
             });
         });
     };
-    PostHogCoreStateless.prototype.getFeatureFlagsAndPayloadsStateless = function (distinctId, groups, personProperties, groupProperties) {
+    PostHogCoreStateless.prototype.getFeatureFlagsAndPayloadsStateless = function (distinctId, groups, personProperties, groupProperties, disableGeoip) {
         if (groups === void 0) { groups = {}; }
         if (personProperties === void 0) { personProperties = {}; }
         if (groupProperties === void 0) { groupProperties = {}; }
         return __awaiter(this, void 0, void 0, function () {
-            var decideResponse, flags, payloads;
+            var extraPayload, decideResponse, flags, payloads;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getDecide(distinctId, groups, personProperties, groupProperties)];
+                    case 0:
+                        extraPayload = {};
+                        if (disableGeoip !== null && disableGeoip !== void 0 ? disableGeoip : this.disableGeoip) {
+                            extraPayload['geoip_disable'] = true;
+                        }
+                        return [4 /*yield*/, this.getDecide(distinctId, groups, personProperties, groupProperties, extraPayload)];
                     case 1:
                         decideResponse = _a.sent();
                         flags = decideResponse === null || decideResponse === void 0 ? void 0 : decideResponse.featureFlags;
@@ -969,11 +976,19 @@ var PostHogCoreStateless = /** @class */ (function () {
      ***/
     PostHogCoreStateless.prototype.enqueue = function (type, _message, options) {
         var _this = this;
+        var _a;
         if (this.optedOut) {
             this._events.emit(type, "Library is disabled. Not sending event. To re-enable, call posthog.enable()");
             return;
         }
         var message = __assign(__assign({}, _message), { type: type, library: this.getLibraryId(), library_version: this.getLibraryVersion(), timestamp: (options === null || options === void 0 ? void 0 : options.timestamp) ? options === null || options === void 0 ? void 0 : options.timestamp : currentISOTime() });
+        var addGeoipDisableProperty = (_a = options === null || options === void 0 ? void 0 : options.disableGeoip) !== null && _a !== void 0 ? _a : this.disableGeoip;
+        if (addGeoipDisableProperty) {
+            if (!message.properties) {
+                message.properties = {};
+            }
+            message['properties']['$geoip_disable'] = true;
+        }
         if (message.distinctId) {
             message.distinct_id = message.distinctId;
             delete message.distinctId;
@@ -1100,11 +1115,13 @@ var PostHogCoreStateless = /** @class */ (function () {
     __extends(PostHogCore, _super);
     function PostHogCore(apiKey, options) {
         var _this = this;
-        var _a, _b;
-        _this = _super.call(this, apiKey, options) || this;
+        var _a, _b, _c;
+        // Default for stateful mode is to not disable geoip. Only override if explicitly set
+        var disableGeoipOption = (_a = options === null || options === void 0 ? void 0 : options.disableGeoip) !== null && _a !== void 0 ? _a : false;
+        _this = _super.call(this, apiKey, __assign(__assign({}, options), { disableGeoip: disableGeoipOption })) || this;
         _this.flagCallReported = {};
-        _this.sendFeatureFlagEvent = (_a = options === null || options === void 0 ? void 0 : options.sendFeatureFlagEvent) !== null && _a !== void 0 ? _a : true;
-        _this._sessionExpirationTimeSeconds = (_b = options === null || options === void 0 ? void 0 : options.sessionExpirationTimeSeconds) !== null && _b !== void 0 ? _b : 1800; // 30 minutes
+        _this.sendFeatureFlagEvent = (_b = options === null || options === void 0 ? void 0 : options.sendFeatureFlagEvent) !== null && _b !== void 0 ? _b : true;
+        _this._sessionExpirationTimeSeconds = (_c = options === null || options === void 0 ? void 0 : options.sessionExpirationTimeSeconds) !== null && _c !== void 0 ? _c : 1800; // 30 minutes
         // NOTE: It is important we don't initiate anything in the constructor as some async IO may still be underway on the parent
         if ((options === null || options === void 0 ? void 0 : options.preloadFeatureFlags) !== false) {
             safeSetTimeout(function () {
@@ -2491,16 +2508,18 @@ function (_super) {
         properties = _a.properties,
         groups = _a.groups,
         sendFeatureFlags = _a.sendFeatureFlags,
-        timestamp = _a.timestamp;
+        timestamp = _a.timestamp,
+        disableGeoip = _a.disableGeoip;
 
     var _capture = function (props) {
       _super.prototype.captureStateless.call(_this, distinctId, event, props, {
-        timestamp: timestamp
+        timestamp: timestamp,
+        disableGeoip: disableGeoip
       });
     };
 
     if (sendFeatureFlags) {
-      _super.prototype.getFeatureFlagsStateless.call(this, distinctId, groups).then(function (flags) {
+      _super.prototype.getFeatureFlagsStateless.call(this, distinctId, groups, undefined, undefined, disableGeoip).then(function (flags) {
         var featureVariantProperties = {};
 
         if (flags) {
@@ -2536,29 +2555,34 @@ function (_super) {
 
   PostHog.prototype.identify = function (_a) {
     var distinctId = _a.distinctId,
-        properties = _a.properties; // Catch properties passed as $set and move them to the top level
+        properties = _a.properties,
+        disableGeoip = _a.disableGeoip; // Catch properties passed as $set and move them to the top level
 
     var personProperties = (properties === null || properties === void 0 ? void 0 : properties.$set) || properties;
 
     _super.prototype.identifyStateless.call(this, distinctId, {
       $set: personProperties
+    }, {
+      disableGeoip: disableGeoip
     });
   };
 
   PostHog.prototype.alias = function (data) {
-    _super.prototype.aliasStateless.call(this, data.alias, data.distinctId);
+    _super.prototype.aliasStateless.call(this, data.alias, data.distinctId, undefined, {
+      disableGeoip: data.disableGeoip
+    });
   };
 
   PostHog.prototype.getFeatureFlag = function (key, distinctId, options) {
     var _a;
 
     return __awaiter(this, void 0, void 0, function () {
-      var _b, groups, personProperties, groupProperties, _c, onlyEvaluateLocally, sendFeatureFlagEvents, response, flagWasLocallyEvaluated, featureFlagReportedKey;
+      var _b, groups, personProperties, groupProperties, disableGeoip, _c, onlyEvaluateLocally, sendFeatureFlagEvents, response, flagWasLocallyEvaluated, featureFlagReportedKey;
 
       return __generator(this, function (_d) {
         switch (_d.label) {
           case 0:
-            _b = options || {}, groups = _b.groups, personProperties = _b.personProperties, groupProperties = _b.groupProperties;
+            _b = options || {}, groups = _b.groups, personProperties = _b.personProperties, groupProperties = _b.groupProperties, disableGeoip = _b.disableGeoip;
             _c = options || {}, onlyEvaluateLocally = _c.onlyEvaluateLocally, sendFeatureFlagEvents = _c.sendFeatureFlagEvents; // set defaults
 
             if (onlyEvaluateLocally == undefined) {
@@ -2581,7 +2605,7 @@ function (_super) {
             , 3];
             return [4
             /*yield*/
-            , _super.prototype.getFeatureFlagStateless.call(this, key, distinctId, groups, personProperties, groupProperties)];
+            , _super.prototype.getFeatureFlagStateless.call(this, key, distinctId, groups, personProperties, groupProperties, disableGeoip)];
 
           case 2:
             response = _d.sent();
@@ -2609,7 +2633,8 @@ function (_super) {
                   $feature_flag_response: response,
                   locally_evaluated: flagWasLocallyEvaluated
                 },
-                groups: groups
+                groups: groups,
+                disableGeoip: disableGeoip
               });
             }
 
@@ -2625,12 +2650,12 @@ function (_super) {
     var _a;
 
     return __awaiter(this, void 0, void 0, function () {
-      var _b, groups, personProperties, groupProperties, _c, onlyEvaluateLocally, response, payloadWasLocallyEvaluated;
+      var _b, groups, personProperties, groupProperties, disableGeoip, _c, onlyEvaluateLocally, response, payloadWasLocallyEvaluated;
 
       return __generator(this, function (_d) {
         switch (_d.label) {
           case 0:
-            _b = options || {}, groups = _b.groups, personProperties = _b.personProperties, groupProperties = _b.groupProperties;
+            _b = options || {}, groups = _b.groups, personProperties = _b.personProperties, groupProperties = _b.groupProperties, disableGeoip = _b.disableGeoip;
             _c = options || {}, onlyEvaluateLocally = _c.onlyEvaluateLocally, _c.sendFeatureFlagEvents;
             response = undefined;
             if (!!matchValue) return [3
@@ -2675,7 +2700,7 @@ function (_super) {
             , 6];
             return [4
             /*yield*/
-            , _super.prototype.getFeatureFlagPayloadStateless.call(this, key, distinctId, groups, personProperties, groupProperties)];
+            , _super.prototype.getFeatureFlagPayloadStateless.call(this, key, distinctId, groups, personProperties, groupProperties, disableGeoip)];
 
           case 5:
             response = _d.sent();
@@ -2751,12 +2776,12 @@ function (_super) {
     var _a;
 
     return __awaiter(this, void 0, void 0, function () {
-      var _b, groups, personProperties, groupProperties, onlyEvaluateLocally, localEvaluationResult, featureFlags, featureFlagPayloads, fallbackToDecide, remoteEvaluationResult;
+      var _b, groups, personProperties, groupProperties, disableGeoip, onlyEvaluateLocally, localEvaluationResult, featureFlags, featureFlagPayloads, fallbackToDecide, remoteEvaluationResult;
 
       return __generator(this, function (_c) {
         switch (_c.label) {
           case 0:
-            _b = options || {}, groups = _b.groups, personProperties = _b.personProperties, groupProperties = _b.groupProperties;
+            _b = options || {}, groups = _b.groups, personProperties = _b.personProperties, groupProperties = _b.groupProperties, disableGeoip = _b.disableGeoip;
             onlyEvaluateLocally = (options || {}).onlyEvaluateLocally; // set defaults
 
             if (onlyEvaluateLocally == undefined) {
@@ -2784,7 +2809,7 @@ function (_super) {
             , 3];
             return [4
             /*yield*/
-            , _super.prototype.getFeatureFlagsAndPayloadsStateless.call(this, distinctId, groups, personProperties, groupProperties)];
+            , _super.prototype.getFeatureFlagsAndPayloadsStateless.call(this, distinctId, groups, personProperties, groupProperties, disableGeoip)];
 
           case 2:
             remoteEvaluationResult = _c.sent();
@@ -2808,9 +2833,12 @@ function (_super) {
     var groupType = _a.groupType,
         groupKey = _a.groupKey,
         properties = _a.properties,
-        distinctId = _a.distinctId;
+        distinctId = _a.distinctId,
+        disableGeoip = _a.disableGeoip;
 
-    _super.prototype.groupIdentifyStateless.call(this, groupType, groupKey, properties, undefined, distinctId);
+    _super.prototype.groupIdentifyStateless.call(this, groupType, groupKey, properties, {
+      disableGeoip: disableGeoip
+    }, distinctId);
   };
 
   PostHog.prototype.reloadFeatureFlags = function () {