@pbvision/fastify-firestore-service 0.0.38 → 0.0.40

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)
@@ -542,6 +543,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 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.
+
+
 # Niche Concepts
 This section explains niche functionality.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pbvision/fastify-firestore-service",
-  "version": "0.0.38",
+  "version": "0.0.40",
   "description": "Web Framework using Fastify and Firestore ORM",
   "license": "Apache-2.0",
   "type": "module",
@@ -42,7 +42,7 @@
     "@fastify/static": "^6.12",
     "@fastify/swagger": "^8.1.0",
     "@fastify/swagger-ui": "^2.0.1",
-    "@pbvision/firestore-orm": "^0.0.19",
+    "@pbvision/firestore-orm": "^0.0.20",
     "@sentry/node": "^7.91.0",
     "fastify": "^4.10.0",
     "fastify-plugin": "^4.5.1",

package/src/api/api.js

@@ -2,6 +2,7 @@ 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'
 
@@ -214,6 +215,7 @@ class API {
     }
     reply.logRequestBodyOnError = this.constructor.LOG_REQUEST_BODY_ON_ERROR
     reply.apiName = this.constructor.name
+    this.__trackInputsWithSentry()
   }
 
   /**
@@ -405,6 +407,34 @@ 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) {
+      Sentry.setContext('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
+    }
+  }
+
   /**
    * Redirects to a URL optionally with query string and cookie.
    *