@naturalcycles/backend-lib 5.0.2 → 5.1.0

package/dist/sentry/sentry.shared.service.d.ts

@@ -1,4 +1,4 @@
-import { CommonLogger } from '@naturalcycles/js-lib';
+import { CommonLogger, Primitive, StringMap } from '@naturalcycles/js-lib';
 import type { Breadcrumb, NodeOptions, SeverityLevel } from '@sentry/node';
 import type * as SentryLib from '@sentry/node';
 import { BackendErrorRequestHandler, BackendRequestHandler } from '../index';
@@ -24,7 +24,17 @@ export declare class SentrySharedService {
     /**
      * For GDPR reasons we never send more information than just User ID.
      */
-    setUserId(id: string): void;
+    setUserId(id: string | null): void;
+    /**
+     * Tag keys have a maximum length of 32 characters and can contain only
+     * letters (a-zA-Z), numbers (0-9), underscores (_), periods (.), colons (:), and dashes (-).
+     *
+     * Tag values have a maximum length of 200 characters and they
+     * cannot contain the newline (\n) character.
+     *
+     * https://docs.sentry.io/platforms/node/enriching-events/scopes/
+     */
+    setTags(tags: StringMap<Primitive>): void;
     /**
      * Does console.log(err)
      * Returns "eventId" or undefined (if error was not reported).

package/dist/sentry/sentry.shared.service.js

@@ -60,12 +60,26 @@ class SentrySharedService {
      * For GDPR reasons we never send more information than just User ID.
      */
     setUserId(id) {
-        this.sentry().configureScope(scope => {
-            scope.setUser({
-                id,
-            });
+        if (id === null) {
+            this.sentry().setUser(null);
+            return;
+        }
+        this.sentry().setUser({
+            id,
         });
     }
+    /**
+     * Tag keys have a maximum length of 32 characters and can contain only
+     * letters (a-zA-Z), numbers (0-9), underscores (_), periods (.), colons (:), and dashes (-).
+     *
+     * Tag values have a maximum length of 200 characters and they
+     * cannot contain the newline (\n) character.
+     *
+     * https://docs.sentry.io/platforms/node/enriching-events/scopes/
+     */
+    setTags(tags) {
+        this.sentry().setTags(tags);
+    }
     /**
      * Does console.log(err)
      * Returns "eventId" or undefined (if error was not reported).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/backend-lib",
-  "version": "5.0.2",
+  "version": "5.1.0",
   "scripts": {
     "prepare": "husky",
     "dev": "APP_ENV=dev nodemon",

package/src/sentry/sentry.shared.service.ts

@@ -4,6 +4,8 @@ import {
   _Memo,
   CommonLogger,
   CommonLogLevel,
+  Primitive,
+  StringMap,
 } from '@naturalcycles/js-lib'
 import { _inspect, InspectAnyOptions } from '@naturalcycles/nodejs-lib'
 // eslint-disable-next-line import/no-duplicates
@@ -77,14 +79,30 @@ export class SentrySharedService {
   /**
    * For GDPR reasons we never send more information than just User ID.
    */
-  setUserId(id: string): void {
-    this.sentry().configureScope(scope => {
-      scope.setUser({
-        id,
-      })
+  setUserId(id: string | null): void {
+    if (id === null) {
+      this.sentry().setUser(null)
+      return
+    }
+
+    this.sentry().setUser({
+      id,
     })
   }
 
+  /**
+   * Tag keys have a maximum length of 32 characters and can contain only
+   * letters (a-zA-Z), numbers (0-9), underscores (_), periods (.), colons (:), and dashes (-).
+   *
+   * Tag values have a maximum length of 200 characters and they
+   * cannot contain the newline (\n) character.
+   *
+   * https://docs.sentry.io/platforms/node/enriching-events/scopes/
+   */
+  setTags(tags: StringMap<Primitive>): void {
+    this.sentry().setTags(tags)
+  }
+
   /**
    * Does console.log(err)
    * Returns "eventId" or undefined (if error was not reported).