posthog-node 2.1.0 → 2.2.1

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 2.2.1 - 2022-11-24
+1. Add standard 10 second timeout
+
+# 2.2.0 - 2022-11-18
+
+1. Add support for variant overrides for feature flag local evaluation.
+2. Add support for date operators in feature flag local evaluation.
+
 # 2.1.0 - 2022-09-08
 
 1. Swaps `unidici` for `axios` in order to support older versions of Node

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.1.0";
+var version = "2.2.1";
 
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
@@ -724,7 +724,7 @@ var SimpleEventEmitter = /** @class */ (function () {
 var PostHogCore = /** @class */ (function () {
     function PostHogCore(apiKey, options) {
         var _this = this;
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f;
         this.flagCallReported = {};
         // internal
         this._events = new SimpleEventEmitter();
@@ -741,7 +741,8 @@ var PostHogCore = /** @class */ (function () {
             retryCount: (_c = options === null || options === void 0 ? void 0 : options.fetchRetryCount) !== null && _c !== void 0 ? _c : 3,
             retryDelay: (_d = options === null || options === void 0 ? void 0 : options.fetchRetryDelay) !== null && _d !== void 0 ? _d : 3000,
         };
-        this._sessionExpirationTimeSeconds = (_e = options === null || options === void 0 ? void 0 : options.sessionExpirationTimeSeconds) !== null && _e !== void 0 ? _e : 1800; // 30 minutes
+        this.requestTimeout = (_e = options === null || options === void 0 ? void 0 : options.requestTimeout) !== null && _e !== void 0 ? _e : 10;
+        this._sessionExpirationTimeSeconds = (_f = options === null || options === void 0 ? void 0 : options.sessionExpirationTimeSeconds) !== null && _f !== void 0 ? _f : 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 () {
@@ -760,6 +761,26 @@ var PostHogCore = /** @class */ (function () {
         }
         return __assign({ $lib: this.getLibraryId(), $lib_version: this.getLibraryVersion(), $active_feature_flags: featureFlags ? Object.keys(featureFlags) : undefined }, featureVariantProperties);
     };
+    PostHogCore.prototype.setupBootstrap = function (options) {
+        var _a, _b, _c, _d;
+        if ((_a = options === null || options === void 0 ? void 0 : options.bootstrap) === null || _a === void 0 ? void 0 : _a.distinctId) {
+            if ((_b = options === null || options === void 0 ? void 0 : options.bootstrap) === null || _b === void 0 ? void 0 : _b.isIdentifiedId) {
+                this.setPersistedProperty(PostHogPersistedProperty.DistinctId, options.bootstrap.distinctId);
+            }
+            else {
+                this.setPersistedProperty(PostHogPersistedProperty.AnonymousId, options.bootstrap.distinctId);
+            }
+        }
+        if ((_c = options === null || options === void 0 ? void 0 : options.bootstrap) === null || _c === void 0 ? void 0 : _c.featureFlags) {
+            var activeFlags = Object.keys(((_d = options.bootstrap) === null || _d === void 0 ? void 0 : _d.featureFlags) || {})
+                .filter(function (flag) { var _a, _b; return !!((_b = (_a = options.bootstrap) === null || _a === void 0 ? void 0 : _a.featureFlags) === null || _b === void 0 ? void 0 : _b[flag]); })
+                .reduce(function (res, key) {
+                var _a, _b;
+                return ((res[key] = ((_b = (_a = options.bootstrap) === null || _a === void 0 ? void 0 : _a.featureFlags) === null || _b === void 0 ? void 0 : _b[key]) || false), res);
+            }, {});
+            this.setKnownFeatureFlags(activeFlags);
+        }
+    };
     Object.defineProperty(PostHogCore.prototype, "props", {
         // NOTE: Props are lazy loaded from localstorage hence the complex getter setter logic
         get: function () {
@@ -1003,8 +1024,7 @@ var PostHogCore = /** @class */ (function () {
                     .then(function (r) { return r.json(); })
                     .then(function (res) {
                     if (res.featureFlags) {
-                        _this.setPersistedProperty(PostHogPersistedProperty.FeatureFlags, res.featureFlags);
-                        _this._events.emit('featureflags', res.featureFlags);
+                        _this.setKnownFeatureFlags(res.featureFlags);
                     }
                     return res;
                 })
@@ -1015,6 +1035,10 @@ var PostHogCore = /** @class */ (function () {
             });
         });
     };
+    PostHogCore.prototype.setKnownFeatureFlags = function (featureFlags) {
+        this.setPersistedProperty(PostHogPersistedProperty.FeatureFlags, featureFlags);
+        this._events.emit('featureflags', featureFlags);
+    };
     PostHogCore.prototype.getFeatureFlag = function (key) {
         var featureFlags = this.getFeatureFlags();
         if (!featureFlags) {
@@ -1202,10 +1226,19 @@ var PostHogCore = /** @class */ (function () {
         });
     };
     PostHogCore.prototype.fetchWithRetry = function (url, options, retryOptions) {
+        var _a;
+        var _b;
         return __awaiter(this, void 0, void 0, function () {
             var _this = this;
-            return __generator(this, function (_a) {
-                return [2 /*return*/, retriable(function () { return _this.fetch(url, options); }, retryOptions || this._retryOptions)];
+            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)];
             });
         });
     };
@@ -1505,16 +1538,44 @@ function () {
   };
 
   FeatureFlagsPoller.prototype.matchFeatureFlagProperties = function (flag, distinctId, properties) {
-    var _this = this;
+    var _a;
 
     var flagFilters = flag.filters || {};
     var flagConditions = flagFilters.groups || [];
     var isInconclusive = false;
-    var result = undefined;
-    flagConditions.forEach(function (condition) {
+    var result = undefined; // # Stable sort conditions with variant overrides to the top. This ensures that if overrides are present, they are
+    // # evaluated first, and the variant override is applied to the first matching condition.
+
+    var sortedFlagConditions = __spreadArray([], flagConditions, true).sort(function (conditionA, conditionB) {
+      var AHasVariantOverride = !!conditionA.variant;
+      var BHasVariantOverride = !!conditionB.variant;
+
+      if (AHasVariantOverride && BHasVariantOverride) {
+        return 0;
+      } else if (AHasVariantOverride) {
+        return -1;
+      } else if (BHasVariantOverride) {
+        return 1;
+      } else {
+        return 0;
+      }
+    });
+
+    var _loop_1 = function (condition) {
       try {
-        if (_this.isConditionMatch(flag, distinctId, condition, properties)) {
-          result = _this.getMatchingVariant(flag, distinctId) || true;
+        if (this_1.isConditionMatch(flag, distinctId, condition, properties)) {
+          var variantOverride_1 = condition.variant;
+          var flagVariants = ((_a = flagFilters.multivariate) === null || _a === void 0 ? void 0 : _a.variants) || [];
+
+          if (variantOverride_1 && flagVariants.some(function (variant) {
+            return variant.key === variantOverride_1;
+          })) {
+            result = variantOverride_1;
+          } else {
+            result = this_1.getMatchingVariant(flag, distinctId) || true;
+          }
+
+          return "break";
         }
       } catch (e) {
         if (e instanceof InconclusiveMatchError) {
@@ -1523,7 +1584,17 @@ function () {
           throw e;
         }
       }
-    });
+    };
+
+    var this_1 = this;
+
+    for (var _i = 0, sortedFlagConditions_1 = sortedFlagConditions; _i < sortedFlagConditions_1.length; _i++) {
+      var condition = sortedFlagConditions_1[_i];
+
+      var state_1 = _loop_1(condition);
+
+      if (state_1 === "break") break;
+    }
 
     if (result !== undefined) {
       return result;
@@ -1820,6 +1891,17 @@ function matchProperty(property, propertyValues) {
     case 'lte':
       return typeof overrideValue == typeof value && overrideValue <= value;
 
+    case 'is_date_after':
+    case 'is_date_before':
+      var parsedDate = convertToDateTime(value);
+      var overrideDate = convertToDateTime(overrideValue);
+
+      if (operator === 'is_date_before') {
+        return overrideDate < parsedDate;
+      }
+
+      return overrideDate > parsedDate;
+
     default:
       console.error("Unknown operator: ".concat(operator));
       return false;
@@ -1835,6 +1917,22 @@ function isValidRegex(regex) {
   }
 }
 
+function convertToDateTime(value) {
+  if (value instanceof Date) {
+    return value;
+  } else if (typeof value === 'string' || typeof value === 'number') {
+    var date = new Date(value);
+
+    if (!isNaN(date.valueOf())) {
+      return date;
+    }
+
+    throw new InconclusiveMatchError("".concat(value, " is in an invalid date format"));
+  } else {
+    throw new InconclusiveMatchError("The date provided ".concat(value, " must be a string, number, or date object"));
+  }
+}
+
 var THIRTY_SECONDS = 30 * 1000;
 var MAX_CACHE_SIZE = 50 * 1000;
 
@@ -1902,6 +2000,8 @@ function () {
       options = {};
     }
 
+    var _a;
+
     this._sharedClient = new PostHogClient(apiKey, options);
 
     if (options.personalApiKey) {
@@ -1909,7 +2009,7 @@ function () {
         pollingInterval: typeof options.featureFlagsPollingInterval === 'number' ? options.featureFlagsPollingInterval : THIRTY_SECONDS,
         personalApiKey: options.personalApiKey,
         projectApiKey: apiKey,
-        timeout: options.requestTimeout,
+        timeout: (_a = options.requestTimeout) !== null && _a !== void 0 ? _a : 10,
         host: this._sharedClient.host,
         fetch: options.fetch
       });