@pbvision/fastify-firestore-service 0.0.40 → 0.0.42

package/docs/api.md

@@ -227,6 +227,9 @@ class DupErrorCodeAPI extends API {
   }
 
   async computeResponse (req) {
+    this.setSentryTag('test', 'me')
+    this.setSentryTag('another', 'test')
+    this.setSentryUserInfo({ email: 'x@example.com', id: '123' })
     if (req.body.exception === 'notfound') {
       throw new NotFoundException() // default error message "Not found"
     } else {
@@ -545,9 +548,9 @@ static CORS_ORIGIN = '*'
 
 ## Sentry Context
 By default, query parameter, path parameter and body parameters are included as
-context for reports to Sentry. To disable this, set
-`MAY_SHARE_INPUTS_WITH_SENTRY` to false. Note that headers are _not_ included
-by default. You can override what's included by overriding the `getInputsToTrackWithSentry()` method.
+context for reports to Sentry. To disable or customize this, override the `getInputsToTrackWithSentry()` method. You can also use the
+`setSentryContext()`, `setSentryTag()` and `setSentryUserInfo()` methods to
+add custom metadata for the request.
 
 
 # Niche Concepts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pbvision/fastify-firestore-service",
-  "version": "0.0.40",
+  "version": "0.0.42",
   "description": "Web Framework using Fastify and Firestore ORM",
   "license": "Apache-2.0",
   "type": "module",

package/src/api/api.js

@@ -2,7 +2,6 @@ import assert from 'node:assert'
 import querystring from 'node:querystring'
 
 import S from '@pbvision/schema'
-import * as Sentry from '@sentry/node'
 
 import fetchWrapper from '../fetch-wrapper.js'
 
@@ -215,6 +214,7 @@ class API {
     }
     reply.logRequestBodyOnError = this.constructor.LOG_REQUEST_BODY_ON_ERROR
     reply.apiName = this.constructor.name
+    this.req.__sentry = { context: {}, tags: {} }
     this.__trackInputsWithSentry()
   }
 
@@ -413,10 +413,10 @@ class API {
    * used if these fields don't include sensitive information.
    */
   __trackInputsWithSentry () {
-    const inputs = this.getInputsToTrackWithSentry()
+    const inputs = this.constructor.getInputsToTrackWithSentry(this.req)
     // istanbul ignore else
     if (inputs) {
-      Sentry.setContext('inputs', inputs)
+      this.setSentryContext('inputs', inputs)
     }
   }
 
@@ -427,14 +427,29 @@ class API {
    * helpful debugging information but should only be
    * used if these fields don't include sensitive information.
    */
-  getInputsToTrackWithSentry () {
+  static getInputsToTrackWithSentry (req) {
     return {
-      ...this.req.query,
-      ...this.req.params,
-      ...this.req.body
+      ...req.query,
+      ...req.params,
+      ...req.body
     }
   }
 
+  /** Sets context to be transmitted to Sentry if this request fails. */
+  setSentryContext (key, contextObject) {
+    this.req.__sentry.context[key] = contextObject
+  }
+
+  /** Sets a tag to be transmitted to Sentry if this request fails. */
+  setSentryTag (tag, tagValue) {
+    this.req.__sentry.tags[tag] = tagValue
+  }
+
+  /** Sets user info to be transmitted to Sentry if this request fails. */
+  setSentryUserInfo (userInfo) {
+    this.req.__sentry.userInfo = userInfo
+  }
+
   /**
    * Redirects to a URL optionally with query string and cookie.
    *
@@ -782,6 +797,16 @@ class API {
       let ret
       try {
         if (req.validationError) {
+          req.__sentry = { context: {} }
+          const errCopy = { ...req.validationError }
+          errCopy.validation = JSON.stringify(errCopy.validation, null, 4)
+          req.__sentry.context.validationError = errCopy
+          try {
+            req.__sentry.context.inputs = this.getInputsToTrackWithSentry(req)
+          } catch (err) {
+            // istanbul ignore next
+            console.warn('trying to get inputs to track failed', err)
+          }
           throw new InvalidInputException(req.validationError)
         }
         ret = await this._callAndHandleRequestDone(reply, async () => {

package/src/plugins/error-handler.js

@@ -106,12 +106,20 @@ export default fp(function (fastify, options, next) {
         user.ip = req.ip
       }
       scope.setLevel(isCrash ? 'error' : 'warning')
-      scope.setUser(user)
+      scope.setUser({
+        ...user,
+        ...(req.__sentry?.userInfo ?? {})
+      })
       scope.setTags({
+        ...(req.__sentry?.tags ?? {}),
         method: req.method,
         url: req.url,
         status: errInfo.status
       })
+      const customContexts = req.__sentry?.context ?? {}
+      for (const [k, v] of Object.entries(customContexts)) {
+        scope.setContext(k, v)
+      }
       const extras = {
         msg: errInfo.message,
         reqId: req.id,