posthog-node 3.2.0 → 3.3.0

package/lib/index.d.ts

@@ -316,7 +316,7 @@ declare class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
     private _memoryStorage;
     private featureFlagsPoller?;
     private maxCacheSize;
-    private options;
+    readonly options: PostHogOptions;
     distinctIdHasSentFlagCalls: Record<string, string[]>;
     constructor(apiKey: string, options?: PostHogOptions);
     getPersistedProperty(key: PostHogPersistedProperty): any | undefined;
@@ -379,4 +379,44 @@ declare class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
     shutdownAsync(): Promise<void>;
 }
 
-export { PostHog, PostHogOptions };
+/**
+ * @file Adapted from [posthog-js](https://github.com/PostHog/posthog-js/blob/8157df935a4d0e71d2fefef7127aa85ee51c82d1/src/extensions/sentry-integration.ts) with modifications for the Node SDK.
+ */
+
+declare type _SentryEventProcessor = any;
+declare type _SentryHub = any;
+interface _SentryIntegration {
+    name: string;
+    setupOnce(addGlobalEventProcessor: (callback: _SentryEventProcessor) => void, getCurrentHub: () => _SentryHub): void;
+}
+/**
+ * Integrate Sentry with PostHog. This will add a direct link to the person in Sentry, and an $exception event in PostHog.
+ *
+ * ### Usage
+ *
+ *     Sentry.init({
+ *          dsn: 'https://example',
+ *          integrations: [
+ *              new PostHogSentryIntegration(posthog)
+ *          ]
+ *     })
+ *
+ *     Sentry.setTag(PostHogSentryIntegration.POSTHOG_ID_TAG, 'some distinct id');
+ *
+ * @param {Object} [posthog] The posthog object
+ * @param {string} [organization] Optional: The Sentry organization, used to send a direct link from PostHog to Sentry
+ * @param {Number} [projectId] Optional: The Sentry project id, used to send a direct link from PostHog to Sentry
+ * @param {string} [prefix] Optional: Url of a self-hosted sentry instance (default: https://sentry.io/organizations/)
+ */
+declare class PostHogSentryIntegration implements _SentryIntegration {
+    private readonly posthog;
+    private readonly posthogHost?;
+    private readonly organization?;
+    private readonly prefix?;
+    readonly name = "posthog-node";
+    static readonly POSTHOG_ID_TAG = "posthog_distinct_id";
+    constructor(posthog: PostHog, posthogHost?: string | undefined, organization?: string | undefined, prefix?: string | undefined);
+    setupOnce(addGlobalEventProcessor: (callback: _SentryEventProcessor) => void, getCurrentHub: () => _SentryHub): void;
+}
+
+export { PostHog, PostHogOptions, PostHogSentryIntegration };

package/lib/index.esm.js

@@ -154,7 +154,7 @@ function __spreadArray(to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 }
 
-var version = "3.2.0";
+var version = "3.3.0";
 
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
@@ -1000,7 +1000,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() });
@@ -1743,6 +1743,7 @@ function () {
     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$1;
+    this.onError = options.onError;
     void this.loadFeatureFlags();
   }
 
@@ -1902,10 +1903,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;
@@ -1914,7 +1918,7 @@ function () {
                       , this.computeFeatureFlagPayloadLocally(flag.key, matchValue)];
 
                     case 1:
-                      matchPayload = _a.sent();
+                      matchPayload = _b.sent();
 
                       if (matchPayload) {
                         payloads[flag.key] = matchPayload;
@@ -1925,10 +1929,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;
@@ -2166,13 +2170,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);
@@ -2182,17 +2188,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");
@@ -2211,7 +2217,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)));
@@ -2229,11 +2235,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
@@ -2558,7 +2564,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);
+        }
       });
     }
 
@@ -2996,5 +3005,94 @@ function (_super) {
   return PostHog;
 }(PostHogCoreStateless);
 
-export { PostHog };
+/**
+ * Integrate Sentry with PostHog. This will add a direct link to the person in Sentry, and an $exception event in PostHog.
+ *
+ * ### Usage
+ *
+ *     Sentry.init({
+ *          dsn: 'https://example',
+ *          integrations: [
+ *              new PostHogSentryIntegration(posthog)
+ *          ]
+ *     })
+ *
+ *     Sentry.setTag(PostHogSentryIntegration.POSTHOG_ID_TAG, 'some distinct id');
+ *
+ * @param {Object} [posthog] The posthog object
+ * @param {string} [organization] Optional: The Sentry organization, used to send a direct link from PostHog to Sentry
+ * @param {Number} [projectId] Optional: The Sentry project id, used to send a direct link from PostHog to Sentry
+ * @param {string} [prefix] Optional: Url of a self-hosted sentry instance (default: https://sentry.io/organizations/)
+ */
+var PostHogSentryIntegration =
+/** @class */
+function () {
+  function PostHogSentryIntegration(posthog, posthogHost, organization, prefix) {
+    var _a;
+
+    this.posthog = posthog;
+    this.posthogHost = posthogHost;
+    this.organization = organization;
+    this.prefix = prefix;
+    this.name = 'posthog-node';
+    this.posthogHost = (_a = posthog.options.host) !== null && _a !== void 0 ? _a : 'https://app.posthog.com';
+  }
+
+  PostHogSentryIntegration.prototype.setupOnce = function (addGlobalEventProcessor, getCurrentHub) {
+    var _this = this;
+
+    addGlobalEventProcessor(function (event) {
+      var _a, _b, _c, _d, _e, _f, _g, _h;
+
+      if (((_a = event.exception) === null || _a === void 0 ? void 0 : _a.values) === undefined || event.exception.values.length === 0) {
+        return event;
+      }
+
+      if (!event.tags) {
+        event.tags = {};
+      }
+
+      var sentry = getCurrentHub(); // Get the PostHog user ID from a specific tag, which users can set on their Sentry scope as they need.
+
+      var userId = event.tags[PostHogSentryIntegration.POSTHOG_ID_TAG];
+
+      if (userId === undefined) {
+        // If we can't find a user ID, don't bother linking the event. We won't be able to send anything meaningful to PostHog without it.
+        return event;
+      }
+
+      event.tags['PostHog Person URL'] = new URL("/person/".concat(userId), _this.posthogHost).toString();
+      var properties = {
+        // PostHog Exception Properties
+        $exception_message: (_b = event.exception.values[0]) === null || _b === void 0 ? void 0 : _b.value,
+        $exception_type: (_c = event.exception.values[0]) === null || _c === void 0 ? void 0 : _c.type,
+        $exception_personURL: event.tags['PostHog Person URL'],
+        // Sentry Exception Properties
+        $sentry_event_id: event.event_id,
+        $sentry_exception: event.exception,
+        $sentry_exception_message: (_d = event.exception.values[0]) === null || _d === void 0 ? void 0 : _d.value,
+        $sentry_exception_type: (_e = event.exception.values[0]) === null || _e === void 0 ? void 0 : _e.type,
+        $sentry_tags: event.tags
+      };
+      var projectId = (_g = (_f = sentry.getClient()) === null || _f === void 0 ? void 0 : _f.getDsn()) === null || _g === void 0 ? void 0 : _g.projectId;
+
+      if (_this.organization !== undefined && projectId !== undefined && event.event_id !== undefined) {
+        properties.$sentry_url = "".concat((_h = _this.prefix) !== null && _h !== void 0 ? _h : 'https://sentry.io/organizations', "/").concat(_this.organization, "/issues/?project=").concat(projectId, "&query=").concat(event.event_id);
+      }
+
+      _this.posthog.capture({
+        event: '$exception',
+        distinctId: userId,
+        properties: properties
+      });
+
+      return event;
+    });
+  };
+
+  PostHogSentryIntegration.POSTHOG_ID_TAG = 'posthog_distinct_id';
+  return PostHogSentryIntegration;
+}();
+
+export { PostHog, PostHogSentryIntegration };
 //# sourceMappingURL=index.esm.js.map