@pbvision/fastify-firestore-service 0.0.39 → 0.0.41

package/docs/api.md

@@ -23,6 +23,7 @@ This library is used to define APIs.
   - [Asynchronous Processing](#asynchronous-processing)
   - [Cross Origin (CORS)](#cross-origin-cors)
   - [Calling other APIs](#calling-other-apis)
+  - [Sentry Context](#sentry-context)
 - [Niche Concepts](#niche-concepts)
   - [Other API Input Data Options](#other-api-input-data-options)
   - [Custom Middleware](#custom-middleware)
@@ -226,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 {
@@ -542,6 +546,13 @@ static CORS_ORIGIN = '*'
   pass some information in a cookie, see the `redirectToWebApp()` helper method.
 
 
+## Sentry Context
+By default, query parameter, path parameter and body parameters are included as
+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
 This section explains niche functionality.
 

package/package.json

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

package/src/api/api.js

@@ -214,6 +214,8 @@ class API {
     }
     reply.logRequestBodyOnError = this.constructor.LOG_REQUEST_BODY_ON_ERROR
     reply.apiName = this.constructor.name
+    this.req.__sentry = { context: {}, tags: {} }
+    this.__trackInputsWithSentry()
   }
 
   /**
@@ -405,6 +407,49 @@ class API {
     return ret
   }
 
+  /**
+   * Adds inputs from the query string, path params and body to the Sentry
+   * context. This provides helpful debugging information but should only be
+   * used if these fields don't include sensitive information.
+   */
+  __trackInputsWithSentry () {
+    const inputs = this.getInputsToTrackWithSentry()
+    // istanbul ignore else
+    if (inputs) {
+      this.setSentryContext('inputs', inputs)
+    }
+  }
+
+  /**
+   * Returns a map of inputs to track in Sentry's context.
+   *
+   * By default, includes the query string, path params and body. This provides
+   * helpful debugging information but should only be
+   * used if these fields don't include sensitive information.
+   */
+  getInputsToTrackWithSentry () {
+    return {
+      ...this.req.query,
+      ...this.req.params,
+      ...this.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.
    *
@@ -752,6 +797,7 @@ class API {
       let ret
       try {
         if (req.validationError) {
+          req.__sentry = { context: { validationError: req.validationError } }
           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,