velocious 1.0.468 → 1.0.470

package/src/error-reporting/request-details.js

@@ -0,0 +1,308 @@
+// @ts-check
+
+import UploadedFile from "../http-server/client/uploaded-file/uploaded-file.js"
+
+const REQUEST_DETAILS_BODY_MAX_SERIALIZED_LENGTH = 12000
+const REQUEST_DETAILS_STRING_MAX_LENGTH = 1000
+const REQUEST_DETAILS_ARRAY_MAX_ITEMS = 50
+const REDACTED_REQUEST_DETAILS_VALUE = "[redacted]"
+
+/**
+ * Extracts request metadata without retaining the request object.
+ * @param {import("../http-server/client/request.js").default | import("../http-server/client/websocket-request.js").default | undefined} request - Request object, when present.
+ * @returns {import("../configuration-types.js").ErrorRequestDetails | null} - Request metadata.
+ */
+export function requestDetails(request) {
+  if (!request) return null
+
+  let details
+
+  try {
+    details = {
+      httpMethod: request.httpMethod(),
+      path: request.path()
+    }
+  } catch {
+    return null
+  }
+
+  const body = requestBodySnapshot(request)
+
+  if (body !== undefined) {
+    return {...details, body}
+  }
+
+  return details
+}
+
+/**
+ * Snapshots parsed request params for error reports.
+ * @param {import("../http-server/client/request.js").default | import("../http-server/client/websocket-request.js").default} request - Request object.
+ * @returns {? | undefined} - Sanitized body snapshot.
+ */
+function requestBodySnapshot(request) {
+  if (typeof request.params !== "function") return undefined
+
+  try {
+    return requestDetailsBodySnapshot(request.params())
+  } catch (error) {
+    return {
+      __unavailable: true,
+      error: error instanceof Error ? error.message : String(error)
+    }
+  }
+}
+
+/**
+ * Builds a bounded, redacted body snapshot for error reports.
+ * @param {?} body - Parsed request body.
+ * @returns {?} - Sanitized body snapshot.
+ */
+function requestDetailsBodySnapshot(body) {
+  const originalLength = serializedLength(body)
+  const sanitized = sanitizeRequestDetailsValue(body)
+  const sanitizedLength = serializedLength(sanitized)
+
+  if (originalLength <= REQUEST_DETAILS_BODY_MAX_SERIALIZED_LENGTH && sanitizedLength <= REQUEST_DETAILS_BODY_MAX_SERIALIZED_LENGTH) {
+    return sanitized
+  }
+
+  const compactFrontendModelBody = compactFrontendModelRequestBody(sanitized, originalLength)
+
+  if (serializedLength(compactFrontendModelBody) <= REQUEST_DETAILS_BODY_MAX_SERIALIZED_LENGTH) {
+    return compactFrontendModelBody
+  }
+
+  return compactRequestDetailsBody(sanitized, originalLength)
+}
+
+/**
+ * Sanitizes a value recursively for request details.
+ * @param {?} value - Value to sanitize.
+ * @param {string} [key] - Current object key.
+ * @param {WeakSet<object>} [seen] - Seen object references.
+ * @returns {?} - Sanitized value.
+ */
+function sanitizeRequestDetailsValue(value, key = "", seen = new WeakSet()) {
+  if (sensitiveRequestDetailsKey(key)) return REDACTED_REQUEST_DETAILS_VALUE
+  if (primitiveRequestDetailsValue(value)) return value
+  if (bufferValue(value)) return bufferRequestDetailsSummary(value)
+  if (value instanceof UploadedFile) return uploadedFileRequestDetailsSummary(value)
+  if (typeof value === "string") return sanitizeRequestDetailsString(value)
+  if (Array.isArray(value)) return sanitizeRequestDetailsArray(value, seen)
+  if (typeof value === "object") return sanitizeRequestDetailsObject(value, seen)
+
+  return String(value)
+}
+
+/**
+ * Checks whether a value can be kept as-is.
+ * @param {?} value - Value.
+ * @returns {boolean} - Whether the value is primitive and safe.
+ */
+function primitiveRequestDetailsValue(value) {
+  return value == null || typeof value === "boolean" || typeof value === "number"
+}
+
+/**
+ * Sanitizes a string value.
+ * @param {string} value - String value.
+ * @returns {string} - Sanitized string.
+ */
+function sanitizeRequestDetailsString(value) {
+  if (value.length <= REQUEST_DETAILS_STRING_MAX_LENGTH) return value
+
+  return `${value.slice(0, REQUEST_DETAILS_STRING_MAX_LENGTH)}... [truncated ${value.length - REQUEST_DETAILS_STRING_MAX_LENGTH} chars]`
+}
+
+/**
+ * Sanitizes an array value.
+ * @param {Array<?>} value - Array value.
+ * @param {WeakSet<object>} seen - Seen object references.
+ * @returns {Array<?>} - Sanitized array.
+ */
+function sanitizeRequestDetailsArray(value, seen) {
+  const entries = value
+    .slice(0, REQUEST_DETAILS_ARRAY_MAX_ITEMS)
+    .map((entry) => sanitizeRequestDetailsValue(entry, "", seen))
+
+  if (value.length > REQUEST_DETAILS_ARRAY_MAX_ITEMS) {
+    entries.push({__omittedItems: value.length - REQUEST_DETAILS_ARRAY_MAX_ITEMS})
+  }
+
+  return entries
+}
+
+/**
+ * Sanitizes a plain object-like value.
+ * @param {object} value - Object value.
+ * @param {WeakSet<object>} seen - Seen object references.
+ * @returns {Record<string, ?> | string} - Sanitized object or circular marker.
+ */
+function sanitizeRequestDetailsObject(value, seen) {
+  if (seen.has(value)) return "[circular]"
+
+  seen.add(value)
+
+  /** @type {Record<string, ?>} */
+  const sanitized = {}
+
+  for (const [entryKey, entryValue] of Object.entries(value)) {
+    sanitized[entryKey] = sanitizeRequestDetailsValue(entryValue, entryKey, seen)
+  }
+
+  seen.delete(value)
+
+  return sanitized
+}
+
+/**
+ * Checks whether a value is a Node.js Buffer.
+ * @param {?} value - Value.
+ * @returns {value is Buffer} - Whether value is a Buffer.
+ */
+function bufferValue(value) {
+  return typeof Buffer !== "undefined" && typeof Buffer.isBuffer === "function" && Buffer.isBuffer(value)
+}
+
+/**
+ * Summarizes raw binary data without serializing bytes.
+ * @param {Buffer} buffer - Uploaded or request buffer.
+ * @returns {Record<string, ?>} - Request-safe buffer summary.
+ */
+function bufferRequestDetailsSummary(buffer) {
+  return {
+    __redacted: true,
+    __type: "Buffer",
+    byteLength: buffer.byteLength
+  }
+}
+
+/**
+ * Summarizes uploaded files without serializing file bytes or temp paths.
+ * @param {UploadedFile} uploadedFile - Uploaded file object.
+ * @returns {Record<string, ?>} - Request-safe upload summary.
+ */
+function uploadedFileRequestDetailsSummary(uploadedFile) {
+  return {
+    __redacted: true,
+    __type: "UploadedFile",
+    contentType: uploadedFile.contentType() ?? null,
+    fieldName: uploadedFile.fieldName(),
+    filename: uploadedFile.filename(),
+    size: uploadedFile.size()
+  }
+}
+
+/**
+ * Checks whether a key should be redacted from request details.
+ * @param {string} key - Object key.
+ * @returns {boolean} - Whether the value is sensitive.
+ */
+function sensitiveRequestDetailsKey(key) {
+  return /authorization|contentBase64|password|secret|sessionToken|token/i.test(key)
+}
+
+/**
+ * Compacts a frontend-model request envelope while preserving debugging shape.
+ * @param {?} value - Sanitized body value.
+ * @param {number} originalSerializedLength - Byte count before redaction or compaction.
+ * @returns {?} - Compacted body value.
+ */
+function compactFrontendModelRequestBody(value, originalSerializedLength) {
+  if (!value || typeof value !== "object" || !Array.isArray(/** @type {Record<string, ?>} */ (value).requests)) {
+    return compactRequestDetailsBody(value, originalSerializedLength)
+  }
+
+  return {
+    __truncated: true,
+    originalSerializedLength,
+    requests: /** @type {Array<?>} */ (/** @type {Record<string, ?>} */ (value).requests).map((request) => {
+      return compactFrontendModelRequest(request)
+    })
+  }
+}
+
+/**
+ * Compacts one frontend-model request entry.
+ * @param {?} value - Candidate request entry from the transport envelope.
+ * @returns {?} - Compacted request.
+ */
+function compactFrontendModelRequest(value) {
+  if (!value || typeof value !== "object") return value
+
+  const request = /** @type {Record<string, ?>} */ (value)
+  /** @type {Record<string, ?>} */
+  const compact = {}
+
+  for (const key of ["requestId", "model", "commandType", "customPath"]) {
+    if (request[key] !== undefined) compact[key] = request[key]
+  }
+
+  if (request.payload !== undefined) {
+    compact.payload = compactFrontendModelPayload(request.payload)
+  }
+
+  return compact
+}
+
+/**
+ * Compacts a frontend-model payload.
+ * @param {?} value - Candidate payload from a request entry.
+ * @returns {?} - Compacted payload.
+ */
+function compactFrontendModelPayload(value) {
+  if (!value || typeof value !== "object" || Array.isArray(value)) return value
+
+  const payload = /** @type {Record<string, ?>} */ (value)
+  /** @type {Record<string, ?>} */
+  const compact = {}
+
+  for (const [key, entryValue] of Object.entries(payload)) {
+    compact[key] = compactFrontendModelPayloadEntry({key, value: entryValue})
+  }
+
+  return compact
+}
+
+/**
+ * Compacts one frontend-model payload entry.
+ * @param {{key: string, value: ?}} args - Payload entry.
+ * @returns {?} - Compacted value.
+ */
+function compactFrontendModelPayloadEntry({key, value}) {
+  if (key !== "attributes" || !value || typeof value !== "object" || Array.isArray(value)) {
+    return value
+  }
+
+  return {__keys: Object.keys(/** @type {Record<string, ?>} */ (value))}
+}
+
+/**
+ * Builds a last-resort compact body summary.
+ * @param {?} value - Sanitized body.
+ * @param {number} originalSerializedLength - Byte count before redaction or compaction.
+ * @returns {Record<string, ?>} - Compact summary.
+ */
+function compactRequestDetailsBody(value, originalSerializedLength) {
+  return {
+    __truncated: true,
+    originalSerializedLength,
+    topLevelKeys: value && typeof value === "object" && !Array.isArray(value)
+      ? Object.keys(/** @type {Record<string, ?>} */ (value))
+      : []
+  }
+}
+
+/**
+ * Measures JSON serialized length.
+ * @param {?} value - Value to measure.
+ * @returns {number} - Serialized length, or Infinity when not serializable.
+ */
+function serializedLength(value) {
+  try {
+    return JSON.stringify(value).length
+  } catch {
+    return Infinity
+  }
+}

package/src/frontend-model-controller.js

@@ -8,6 +8,7 @@ import {frontendModelResourcesWithBuiltInsForBackendProject} from "./frontend-mo
 import {frontendModelResourceClassFromDefinition, frontendModelResourceConfigurationFromDefinition, frontendModelResourcePath, frontendModelResourcesForBackendProject} from "./frontend-models/resource-definition.js"
 import {FrontendModelQueryError, normalizeGroup as normalizeQueryGroup, normalizeJoins as normalizeQueryJoins, normalizePluck as normalizeQueryPluck, normalizePreload as normalizeQueryPreload, normalizeSearchOperator as normalizeQuerySearchOperator, normalizeSort as normalizeQuerySort} from "./frontend-models/query.js"
 import {assignSafeProperty, deserializeFrontendModelTransportValue, isBackendModelInstance, serializeFrontendModelTransportValue} from "./frontend-models/transport-serialization.js"
+import {requestDetails} from "./error-reporting/request-details.js"
 import RoutesResolver from "./routes/resolver.js"
 import {ValidationError} from "./database/record/index.js"
 import { normalizeDateStringForWrite } from "./database/datetime-storage.js"
@@ -3183,7 +3184,8 @@ export default class FrontendModelController extends Controller {
     const errorPayload = {
       context: errorContext,
       error: error instanceof Error ? error : new Error(String(error)),
-      request: this.getRequest()
+      request: this.getRequest(),
+      requestDetails: requestDetails(this.getRequest())
     }
 
     this.getConfiguration().getErrorEvents().emit("framework-error", errorPayload)