posthog-js-lite 2.2.1 → 2.4.0

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 2.4.0 - 2023-04-20
+
+1. Fixes a race condition that could occur when initialising PostHog
+2. Fixes an issue where feature flags would not be reloaded after a reset
+
+# 2.3.0 - 2023-04-19
+
+1. Some small fixes to incorrect types
+2. Fixed fetch compatibility by aligning error handling
+3. Added two errors: PostHogFetchHttpError (non-2xx status) and PostHogFetchNetworkError (fetch network error)
+4. Added .on('error', (err) => void)
+5. shutdownAsync now ignores fetch errors. They should be handled with .on('error', ...) from now on.
+
 # 2.2.1 - 2023-02-13
 
 1. Fixes an issue where background network errors would trigger unhandled promise warnings

package/lib/index.cjs.js

@@ -180,29 +180,31 @@ function retriable(fn, props) {
                     i = 0;
                     _d.label = 1;
                 case 1:
-                    if (!(i < retryCount + 1)) return [3 /*break*/, 8];
-                    _d.label = 2;
+                    if (!(i < retryCount + 1)) return [3 /*break*/, 7];
+                    if (!(i > 0)) return [3 /*break*/, 3];
+                    // don't wait when it's the last try
+                    return [4 /*yield*/, new Promise(function (r) { return setTimeout(r, retryDelay); })];
                 case 2:
-                    _d.trys.push([2, 4, , 5]);
-                    return [4 /*yield*/, fn()];
+                    // don't wait when it's the last try
+                    _d.sent();
+                    _d.label = 3;
                 case 3:
+                    _d.trys.push([3, 5, , 6]);
+                    return [4 /*yield*/, fn()];
+                case 4:
                     res = _d.sent();
                     return [2 /*return*/, res];
-                case 4:
+                case 5:
                     e_1 = _d.sent();
                     lastError = e_1;
                     if (!retryCheck(e_1)) {
                         throw e_1;
                     }
-                    return [3 /*break*/, 5];
-                case 5: return [4 /*yield*/, new Promise(function (r) { return setTimeout(r, retryDelay); })];
+                    return [3 /*break*/, 6];
                 case 6:
-                    _d.sent();
-                    _d.label = 7;
-                case 7:
                     i++;
                     return [3 /*break*/, 1];
-                case 8: throw lastError;
+                case 7: throw lastError;
             }
         });
     });
@@ -701,9 +703,35 @@ var SimpleEventEmitter = /** @class */ (function () {
     return SimpleEventEmitter;
 }());
 
+var PostHogFetchHttpError = /** @class */ (function (_super) {
+    __extends(PostHogFetchHttpError, _super);
+    function PostHogFetchHttpError(response) {
+        var _this = _super.call(this, 'HTTP error while fetching PostHog: ' + response.status) || this;
+        _this.response = response;
+        _this.name = 'PostHogFetchHttpError';
+        return _this;
+    }
+    return PostHogFetchHttpError;
+}(Error));
+var PostHogFetchNetworkError = /** @class */ (function (_super) {
+    __extends(PostHogFetchNetworkError, _super);
+    function PostHogFetchNetworkError(error) {
+        var _this = _super.call(this, 'Network error while fetching PostHog', error instanceof Error ? { cause: error } : {}) || this;
+        _this.error = error;
+        _this.name = 'PostHogFetchNetworkError';
+        return _this;
+    }
+    return PostHogFetchNetworkError;
+}(Error));
+function isPostHogFetchError(err) {
+    return typeof err === 'object' && (err.name === 'PostHogFetchHttpError' || err.name === 'PostHogFetchNetworkError');
+}
 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.");
@@ -717,8 +745,10 @@ var PostHogCoreStateless = /** @class */ (function () {
         this._retryOptions = {
             retryCount: (_b = options === null || options === void 0 ? void 0 : options.fetchRetryCount) !== null && _b !== void 0 ? _b : 3,
             retryDelay: (_c = options === null || options === void 0 ? void 0 : options.fetchRetryDelay) !== null && _c !== void 0 ? _c : 3000,
+            retryCheck: isPostHogFetchError,
         };
         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 {
@@ -747,6 +777,7 @@ var PostHogCoreStateless = /** @class */ (function () {
         var _a;
         if (enabled === void 0) { enabled = true; }
         (_a = this.removeDebugCallback) === null || _a === void 0 ? void 0 : _a.call(this);
+        this.debugMode = enabled;
         if (enabled) {
             this.removeDebugCallback = this.on('*', function (event, payload) { return console.log('PostHog Debug', event, payload); });
         }
@@ -777,13 +808,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;
     };
     /***
@@ -824,7 +855,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 = {}; }
@@ -832,7 +863,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) {
@@ -851,7 +882,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 = {}; }
@@ -859,7 +890,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) {
@@ -875,7 +906,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 = {}; }
@@ -884,7 +915,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) {
@@ -906,28 +937,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;
@@ -945,11 +981,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;
@@ -992,8 +1036,14 @@ var PostHogCoreStateless = /** @class */ (function () {
             batch: messages,
             sent_at: currentISOTime(),
         };
+        var promiseUUID = generateUUID();
         var done = function (err) {
+            if (err) {
+                _this._events.emit('error', err);
+            }
             callback === null || callback === void 0 ? void 0 : callback(err, messages);
+            // remove promise from pendingPromises
+            delete _this.pendingPromises[promiseUUID];
             _this._events.emit('flush', messages);
         };
         // Don't set the user agent if we're not on a browser. The latest spec allows
@@ -1018,13 +1068,11 @@ var PostHogCoreStateless = /** @class */ (function () {
                 headers: { 'Content-Type': 'application/json' },
                 body: payload,
             };
-        this.fetchWithRetry(url, fetchOptions)
+        var requestPromise = this.fetchWithRetry(url, fetchOptions);
+        this.pendingPromises[promiseUUID] = requestPromise;
+        requestPromise
             .then(function () { return done(); })
             .catch(function (err) {
-            if (err.response) {
-                var error = new Error(err.response.statusText);
-                return done(error);
-            }
             done(err);
         });
     };
@@ -1034,27 +1082,72 @@ var PostHogCoreStateless = /** @class */ (function () {
         return __awaiter(this, void 0, void 0, function () {
             var _this = this;
             return __generator(this, function (_c) {
-                (_a = (_b = AbortSignal).timeout) !== null && _a !== void 0 ? _a : (_b.timeout = function timeout(ms) {
-                    var ctrl = new AbortController();
-                    setTimeout(function () { return ctrl.abort(); }, ms);
-                    return ctrl.signal;
-                });
-                return [2 /*return*/, retriable(function () {
-                        return _this.fetch(url, __assign({ signal: AbortSignal.timeout(_this.requestTimeout) }, options));
-                    }, retryOptions || this._retryOptions)];
+                switch (_c.label) {
+                    case 0:
+                        (_a = (_b = AbortSignal).timeout) !== null && _a !== void 0 ? _a : (_b.timeout = function timeout(ms) {
+                            var ctrl = new AbortController();
+                            setTimeout(function () { return ctrl.abort(); }, ms);
+                            return ctrl.signal;
+                        });
+                        return [4 /*yield*/, retriable(function () { return __awaiter(_this, void 0, void 0, function () {
+                                var res, e_1;
+                                return __generator(this, function (_a) {
+                                    switch (_a.label) {
+                                        case 0:
+                                            res = null;
+                                            _a.label = 1;
+                                        case 1:
+                                            _a.trys.push([1, 3, , 4]);
+                                            return [4 /*yield*/, this.fetch(url, __assign({ signal: AbortSignal.timeout(this.requestTimeout) }, options))];
+                                        case 2:
+                                            res = _a.sent();
+                                            return [3 /*break*/, 4];
+                                        case 3:
+                                            e_1 = _a.sent();
+                                            // fetch will only throw on network errors or on timeouts
+                                            throw new PostHogFetchNetworkError(e_1);
+                                        case 4:
+                                            if (res.status < 200 || res.status >= 400) {
+                                                throw new PostHogFetchHttpError(res);
+                                            }
+                                            return [2 /*return*/, res];
+                                    }
+                                });
+                            }); }, __assign(__assign({}, this._retryOptions), retryOptions))];
+                    case 1: return [2 /*return*/, _c.sent()];
+                }
             });
         });
     };
     PostHogCoreStateless.prototype.shutdownAsync = function () {
         return __awaiter(this, void 0, void 0, function () {
+            var e_2;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         clearTimeout(this._flushTimer);
-                        return [4 /*yield*/, this.flushAsync()];
+                        _a.label = 1;
                     case 1:
+                        _a.trys.push([1, 4, , 5]);
+                        return [4 /*yield*/, this.flushAsync()];
+                    case 2:
                         _a.sent();
-                        return [2 /*return*/];
+                        return [4 /*yield*/, Promise.all(Object.values(this.pendingPromises).map(function (x) {
+                                return x.catch(function () {
+                                    // ignore errors as we are shutting down and can't deal with them anyways.
+                                });
+                            }))];
+                    case 3:
+                        _a.sent();
+                        return [3 /*break*/, 5];
+                    case 4:
+                        e_2 = _a.sent();
+                        if (!isPostHogFetchError(e_2)) {
+                            throw e_2;
+                        }
+                        console.error('Error while shutting down PostHog', e_2);
+                        return [3 /*break*/, 5];
+                    case 5: return [2 /*return*/];
                 }
             });
         });
@@ -1068,17 +1161,13 @@ var PostHogCore = /** @class */ (function (_super) {
     __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
-        // 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 () {
-                _this.reloadFeatureFlags();
-            }, 1);
-        }
+        _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
         return _this;
     }
     PostHogCore.prototype.setupBootstrap = function (options) {
@@ -1193,9 +1282,7 @@ var PostHogCore = /** @class */ (function (_super) {
             // We keep the AnonymousId to be used by decide calls and identify to link the previousId
             this.setPersistedProperty(PostHogPersistedProperty.AnonymousId, previousDistinctId);
             this.setPersistedProperty(PostHogPersistedProperty.DistinctId, distinctId);
-            if (this.getFeatureFlags()) {
-                this.reloadFeatureFlags();
-            }
+            this.reloadFeatureFlags();
         }
         _super.prototype.identifyStateless.call(this, distinctId, allProperties, options);
         return this;
@@ -1235,7 +1322,7 @@ var PostHogCore = /** @class */ (function (_super) {
         this.register({
             $groups: __assign(__assign({}, existingGroups), groups),
         });
-        if (Object.keys(groups).find(function (type) { return existingGroups[type] !== groups[type]; }) && this.getFeatureFlags()) {
+        if (Object.keys(groups).find(function (type) { return existingGroups[type] !== groups[type]; })) {
             this.reloadFeatureFlags();
         }
         return this;
@@ -1468,7 +1555,7 @@ var PostHogCore = /** @class */ (function (_super) {
     return PostHogCore;
 }(PostHogCoreStateless));
 
-var version = "2.2.1";
+var version = "2.4.0";
 
 function getContext(window) {
   var context = {};
@@ -1833,6 +1920,10 @@ function (_super) {
 
     _this.setupBootstrap(options);
 
+    if ((options === null || options === void 0 ? void 0 : options.preloadFeatureFlags) !== false) {
+      _this.reloadFeatureFlags();
+    }
+
     return _this;
   }