posthog-node 3.1.3 → 3.2.1

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 3.2.1 - 2023-12-15
+
+1. Fixes issue where a background refresh of feature flags could throw an unhandled error. It now emits to be detected by `.on('error', ...)`
+
+# 3.2.0 - 2023-12-05
+
+1. Fixes issues with Axios imports for non-node environments like Cloudflare workers
+2. Uses the globally defined `fetch` if available, otherwise imports and uses axios as a polyfill
+
 # 3.1.3 - 2023-10-27
 
 1. Updates axios dependency

package/lib/index.cjs.js

@@ -3,11 +3,6 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var rusha = require('rusha');
-var axios = require('axios');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -163,7 +158,7 @@ function __spreadArray(to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 }
 
-var version = "3.1.3";
+var version = "3.2.1";
 
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
@@ -1009,7 +1004,7 @@ var PostHogCoreStateless = /** @class */ (function () {
         var _this = this;
         var _a;
         if (this.optedOut) {
-            this._events.emit(type, "Library is disabled. Not sending event. To re-enable, call posthog.enable()");
+            this._events.emit(type, "Library is disabled. Not sending event. To re-enable, call posthog.optIn()");
             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() });
@@ -1380,13 +1375,20 @@ var PostHogCoreStateless = /** @class */ (function () {
     /***
      * PROPERTIES
      ***/
-    PostHogCore.prototype.personProperties = function (properties) {
+    PostHogCore.prototype.setPersonPropertiesForFlags = function (properties) {
         // Get persisted person properties
         var existingProperties = this.getPersistedProperty(PostHogPersistedProperty.PersonProperties) || {};
         this.setPersistedProperty(PostHogPersistedProperty.PersonProperties, __assign(__assign({}, existingProperties), properties));
         return this;
     };
-    PostHogCore.prototype.groupProperties = function (properties) {
+    PostHogCore.prototype.resetPersonPropertiesForFlags = function () {
+        this.setPersistedProperty(PostHogPersistedProperty.PersonProperties, {});
+    };
+    /** @deprecated - Renamed to setPersonPropertiesForFlags */
+    PostHogCore.prototype.personProperties = function (properties) {
+        return this.setPersonPropertiesForFlags(properties);
+    };
+    PostHogCore.prototype.setGroupPropertiesForFlags = function (properties) {
         // Get persisted group properties
         var existingProperties = this.getPersistedProperty(PostHogPersistedProperty.GroupProperties) || {};
         if (Object.keys(existingProperties).length !== 0) {
@@ -1398,6 +1400,13 @@ var PostHogCoreStateless = /** @class */ (function () {
         this.setPersistedProperty(PostHogPersistedProperty.GroupProperties, __assign(__assign({}, existingProperties), properties));
         return this;
     };
+    PostHogCore.prototype.resetGroupPropertiesForFlags = function () {
+        this.setPersistedProperty(PostHogPersistedProperty.GroupProperties, {});
+    };
+    /** @deprecated - Renamed to setGroupPropertiesForFlags */
+    PostHogCore.prototype.groupProperties = function (properties) {
+        return this.setGroupPropertiesForFlags(properties);
+    };
     /***
      *** FEATURE FLAGS
      ***/
@@ -1602,57 +1611,76 @@ var PostHogMemoryStorage = /** @class */ (function () {
     return PostHogMemoryStorage;
 }());
 
-// So that alternative implementations can be used if desired
-
-var fetch = function (url, options) {
-  return __awaiter(void 0, void 0, void 0, function () {
-    var res;
-    return __generator(this, function (_a) {
-      switch (_a.label) {
-        case 0:
-          return [4
-          /*yield*/
-          , axios__default["default"].request({
-            url: url,
-            headers: options.headers,
-            method: options.method.toLowerCase(),
-            data: options.body,
-            signal: options.signal,
-            // fetch only throws on network errors, not on HTTP errors
-            validateStatus: function () {
-              return true;
-            }
-          })];
-
-        case 1:
-          res = _a.sent();
-          return [2
-          /*return*/
-          , {
-            status: res.status,
-            text: function () {
-              return __awaiter(void 0, void 0, void 0, function () {
-                return __generator(this, function (_a) {
-                  return [2
-                  /*return*/
-                  , res.data];
+/**
+ * Fetch wrapper
+ *
+ * We want to polyfill fetch when not available with axios but use it when it is.
+ * NOTE: The current version of Axios has an issue when in non-node environments like Clouflare Workers.
+ * This is currently solved by using the global fetch if available instead.
+ * See https://github.com/PostHog/posthog-js-lite/issues/127 for more info
+ */
+
+var _fetch = // eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error
+// @ts-ignore
+typeof fetch !== 'undefined' ? fetch : typeof global.fetch !== 'undefined' ? global.fetch : undefined;
+
+if (!_fetch) {
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  var axios_1 = require('axios');
+
+  _fetch = function (url, options) {
+    return __awaiter(void 0, void 0, void 0, function () {
+      var res;
+      return __generator(this, function (_a) {
+        switch (_a.label) {
+          case 0:
+            return [4
+            /*yield*/
+            , axios_1.request({
+              url: url,
+              headers: options.headers,
+              method: options.method.toLowerCase(),
+              data: options.body,
+              signal: options.signal,
+              // fetch only throws on network errors, not on HTTP errors
+              validateStatus: function () {
+                return true;
+              }
+            })];
+
+          case 1:
+            res = _a.sent();
+            return [2
+            /*return*/
+            , {
+              status: res.status,
+              text: function () {
+                return __awaiter(void 0, void 0, void 0, function () {
+                  return __generator(this, function (_a) {
+                    return [2
+                    /*return*/
+                    , res.data];
+                  });
                 });
-              });
-            },
-            json: function () {
-              return __awaiter(void 0, void 0, void 0, function () {
-                return __generator(this, function (_a) {
-                  return [2
-                  /*return*/
-                  , res.data];
+              },
+              json: function () {
+                return __awaiter(void 0, void 0, void 0, function () {
+                  return __generator(this, function (_a) {
+                    return [2
+                    /*return*/
+                    , res.data];
+                  });
                 });
-              });
-            }
-          }];
-      }
+              }
+            }];
+        }
+      });
     });
-  });
-};
+  };
+} // NOTE: We have to export this as default, even though we prefer named exports as we are relying on detecting "fetch" in the global scope
+
+
+var fetch$1 = _fetch;
 
 var LONG_SCALE = 0xfffffffffffffff;
 
@@ -1718,7 +1746,8 @@ function () {
     this.host = host;
     this.poller = undefined; // NOTE: as any is required here as the AbortSignal typing is slightly misaligned but works just fine
 
-    this.fetch = options.fetch || fetch;
+    this.fetch = options.fetch || fetch$1;
+    this.onError = options.onError;
     void this.loadFeatureFlags();
   }
 
@@ -1878,10 +1907,13 @@ function () {
             this.featureFlags.map(function (flag) {
               return __awaiter(_this, void 0, void 0, function () {
                 var matchValue, matchPayload, e_1;
-                return __generator(this, function (_a) {
-                  switch (_a.label) {
+
+                var _a;
+
+                return __generator(this, function (_b) {
+                  switch (_b.label) {
                     case 0:
-                      _a.trys.push([0, 2,, 3]);
+                      _b.trys.push([0, 2,, 3]);
 
                       matchValue = this.computeFlagLocally(flag, distinctId, groups, personProperties, groupProperties);
                       response[flag.key] = matchValue;
@@ -1890,7 +1922,7 @@ function () {
                       , this.computeFeatureFlagPayloadLocally(flag.key, matchValue)];
 
                     case 1:
-                      matchPayload = _a.sent();
+                      matchPayload = _b.sent();
 
                       if (matchPayload) {
                         payloads[flag.key] = matchPayload;
@@ -1901,10 +1933,10 @@ function () {
                       , 3];
 
                     case 2:
-                      e_1 = _a.sent();
+                      e_1 = _b.sent();
 
                       if (e_1 instanceof InconclusiveMatchError) ; else if (e_1 instanceof Error) {
-                        console.error("Error computing flag locally: ".concat(flag.key, ": ").concat(e_1));
+                        (_a = this.onError) === null || _a === void 0 ? void 0 : _a.call(this, new Error("Error computing flag locally: ".concat(flag.key, ": ").concat(e_1)));
                       }
 
                       fallbackToDecide = true;
@@ -2142,13 +2174,15 @@ function () {
   };
 
   FeatureFlagsPoller.prototype._loadFeatureFlags = function () {
+    var _a;
+
     return __awaiter(this, void 0, void 0, function () {
       var res, responseJson, err_1;
 
       var _this = this;
 
-      return __generator(this, function (_a) {
-        switch (_a.label) {
+      return __generator(this, function (_b) {
+        switch (_b.label) {
           case 0:
             if (this.poller) {
               clearTimeout(this.poller);
@@ -2158,17 +2192,17 @@ function () {
             this.poller = setTimeout(function () {
               return _this._loadFeatureFlags();
             }, this.pollingInterval);
-            _a.label = 1;
+            _b.label = 1;
 
           case 1:
-            _a.trys.push([1, 4,, 5]);
+            _b.trys.push([1, 4,, 5]);
 
             return [4
             /*yield*/
             , this._requestFeatureFlagDefinitions()];
 
           case 2:
-            res = _a.sent();
+            res = _b.sent();
 
             if (res && res.status === 401) {
               throw new ClientError("Your personalApiKey is invalid. Are you sure you're not using your Project API key? More information: https://posthog.com/docs/api/overview");
@@ -2187,7 +2221,7 @@ function () {
             , res.json()];
 
           case 3:
-            responseJson = _a.sent();
+            responseJson = _b.sent();
 
             if (!('flags' in responseJson)) {
               console.error("Invalid response when getting feature flags: ".concat(JSON.stringify(responseJson)));
@@ -2205,11 +2239,11 @@ function () {
             , 5];
 
           case 4:
-            err_1 = _a.sent(); // if an error that is not an instance of ClientError is thrown
+            err_1 = _b.sent(); // if an error that is not an instance of ClientError is thrown
             // we silently ignore the error when reloading feature flags
 
             if (err_1 instanceof ClientError) {
-              throw err_1;
+              (_a = this.onError) === null || _a === void 0 ? void 0 : _a.call(this, err_1);
             }
 
             return [3
@@ -2534,7 +2568,10 @@ function (_super) {
         projectApiKey: apiKey,
         timeout: (_a = options.requestTimeout) !== null && _a !== void 0 ? _a : 10000,
         host: _this.host,
-        fetch: options.fetch
+        fetch: options.fetch,
+        onError: function (err) {
+          _this._events.emit('error', err);
+        }
       });
     }
 
@@ -2552,7 +2589,7 @@ function (_super) {
   };
 
   PostHog.prototype.fetch = function (url, options) {
-    return this.options.fetch ? this.options.fetch(url, options) : fetch(url, options);
+    return this.options.fetch ? this.options.fetch(url, options) : fetch$1(url, options);
   };
 
   PostHog.prototype.getLibraryId = function () {