@saptools/cf-inspector 0.3.7 → 0.3.9

package/dist/index.d.ts

@@ -245,6 +245,7 @@ declare function getProperties(session: InspectorSession, objectId: string): Pro
 interface CaptureSnapshotOptions {
     readonly captures?: readonly string[];
     readonly includeScopes?: boolean;
+    readonly maxValueLength?: number;
 }
 declare function captureSnapshot(session: InspectorSession, pause: PauseEvent, options?: CaptureSnapshotOptions): Promise<SnapshotCaptureResult>;
 

package/dist/index.js

@@ -923,12 +923,12 @@ async function getProperties(session, objectId) {
 }
 
 // src/snapshot.ts
+init_types();
 var MAX_SCOPES = 3;
 var MAX_SCOPE_VARIABLES = 20;
 var MAX_CHILD_VARIABLES = 8;
 var MAX_VARIABLE_DEPTH = 2;
-var MAX_VALUE_LENGTH = 240;
-var SENSITIVE_NAME_REGEX = /(pass(?:word)?|credentials?|creds?|token|secret|api[_-]?key|authorization|cookie|session|private[_-]?key)/i;
+var DEFAULT_MAX_VALUE_LENGTH = 4096;
 var PRIORITY_BY_TYPE = {
   local: 0,
   arguments: 1,
@@ -989,37 +989,43 @@ function formatPrimitive(value) {
   }
   return String(value);
 }
-function isSensitiveName(name) {
-  return SENSITIVE_NAME_REGEX.test(name);
-}
-function sanitizeValue(name, raw) {
-  if (isSensitiveName(name)) {
-    return "[REDACTED]";
+function resolveMaxValueLength(value) {
+  if (value === void 0) {
+    return DEFAULT_MAX_VALUE_LENGTH;
+  }
+  if (!Number.isInteger(value) || value <= 0) {
+    throw new CfInspectorError(
+      "INVALID_ARGUMENT",
+      `Invalid maxValueLength: ${value.toString()} \u2014 expected a positive integer`
+    );
   }
-  if (raw.length <= MAX_VALUE_LENGTH) {
+  return value;
+}
+function limitValueLength(raw, maxValueLength = DEFAULT_MAX_VALUE_LENGTH) {
+  if (raw.length <= maxValueLength) {
     return raw;
   }
-  return `${raw.slice(0, MAX_VALUE_LENGTH)}...`;
+  return `${raw.slice(0, maxValueLength)}...`;
 }
 function isExpandable(type) {
   return type === "object" || type === "function";
 }
-async function captureProperties(session, objectId, limit, depth) {
+async function captureProperties(session, objectId, limit, depth, maxValueLength) {
   const properties = await getProperties(session, objectId);
   const limited = properties.slice(0, limit);
   const variables = await Promise.all(
     limited.map(async (prop) => {
       const name = typeof prop.name === "string" ? prop.name : "?";
       const described = describeProperty(prop);
-      const sensitive = isSensitiveName(name);
       let children;
-      if (!sensitive && depth > 0 && described.objectId !== void 0 && isExpandable(described.type)) {
+      if (depth > 0 && described.objectId !== void 0 && isExpandable(described.type)) {
         try {
           const nested = await captureProperties(
             session,
             described.objectId,
             MAX_CHILD_VARIABLES,
-            depth - 1
+            depth - 1,
+            maxValueLength
           );
           if (nested.length > 0) {
             children = nested;
@@ -1027,7 +1033,7 @@ async function captureProperties(session, objectId, limit, depth) {
         } catch {
         }
       }
-      const sanitizedValue = sensitive ? "[REDACTED]" : sanitizeValue(name, described.value);
+      const sanitizedValue = limitValueLength(described.value, maxValueLength);
       const base = { name, value: sanitizedValue };
       const withType = described.type === void 0 ? base : { ...base, type: described.type };
       return children === void 0 ? withType : { ...withType, children };
@@ -1042,7 +1048,7 @@ function selectScopes(scopeChain) {
 function priorityOf(type) {
   return PRIORITY_BY_TYPE[type] ?? Number.MAX_SAFE_INTEGER;
 }
-async function captureScopes(session, frame) {
+async function captureScopes(session, frame, maxValueLength) {
   const scopes = selectScopes(frame.scopeChain);
   return await Promise.all(
     scopes.map(async (scope) => {
@@ -1051,7 +1057,13 @@ async function captureScopes(session, frame) {
         return { type: scope.type, variables: [] };
       }
       try {
-        const variables = await captureProperties(session, objectId, MAX_SCOPE_VARIABLES, MAX_VARIABLE_DEPTH);
+        const variables = await captureProperties(
+          session,
+          objectId,
+          MAX_SCOPE_VARIABLES,
+          MAX_VARIABLE_DEPTH,
+          maxValueLength
+        );
         return { type: scope.type, variables };
       } catch {
         return { type: scope.type, variables: [] };
@@ -1059,10 +1071,10 @@ async function captureScopes(session, frame) {
     })
   );
 }
-function evalResultToCaptured(expression, result) {
+function evalResultToCaptured(expression, result, maxValueLength = DEFAULT_MAX_VALUE_LENGTH) {
   if (result.exceptionDetails !== void 0) {
     const text = typeof result.exceptionDetails.exception?.description === "string" ? result.exceptionDetails.exception.description : typeof result.exceptionDetails.text === "string" ? result.exceptionDetails.text : "evaluation failed";
-    return { expression, error: sanitizeValue(expression, text) };
+    return { expression, error: limitValueLength(text, maxValueLength) };
   }
   const inner = result.result;
   if (!inner) {
@@ -1070,7 +1082,7 @@ function evalResultToCaptured(expression, result) {
   }
   const type = typeof inner.type === "string" ? inner.type : void 0;
   const buildCaptured = (rendered) => {
-    const sanitized = sanitizeValue(expression, rendered);
+    const sanitized = limitValueLength(rendered, maxValueLength);
     const base = { expression, value: sanitized };
     return type === void 0 ? base : { ...base, type };
   };
@@ -1165,9 +1177,15 @@ function toStructuredValue(variable) {
   }
   return out;
 }
-async function renderObjectCapture(session, objectId) {
+async function renderObjectCapture(session, objectId, maxValueLength) {
   try {
-    const properties = await captureProperties(session, objectId, MAX_SCOPE_VARIABLES, MAX_VARIABLE_DEPTH);
+    const properties = await captureProperties(
+      session,
+      objectId,
+      MAX_SCOPE_VARIABLES,
+      MAX_VARIABLE_DEPTH,
+      maxValueLength
+    );
     const structured = {};
     for (const variable of properties) {
       structured[variable.name] = toStructuredValue(variable);
@@ -1186,7 +1204,7 @@ function normalizeRenderedObjectCapture(rendered, original) {
   }
   return rendered;
 }
-async function withSerializedObjectCapture(session, expression, evalResult, captured) {
+async function withSerializedObjectCapture(session, expression, evalResult, captured, maxValueLength) {
   if (captured.error !== void 0 || captured.value === void 0) {
     return captured;
   }
@@ -1194,7 +1212,7 @@ async function withSerializedObjectCapture(session, expression, evalResult, capt
   if (objectId === void 0) {
     return captured;
   }
-  const rendered = await renderObjectCapture(session, objectId);
+  const rendered = await renderObjectCapture(session, objectId, maxValueLength);
   if (rendered === void 0) {
     return captured;
   }
@@ -1202,10 +1220,11 @@ async function withSerializedObjectCapture(session, expression, evalResult, capt
   if (normalized === void 0) {
     return captured;
   }
-  const value = sanitizeValue(expression, normalized);
+  const value = limitValueLength(normalized, maxValueLength);
   return captured.type === void 0 ? { expression, value } : { expression, value, type: captured.type };
 }
 async function captureSnapshot(session, pause, options = {}) {
+  const maxValueLength = resolveMaxValueLength(options.maxValueLength);
   const top = pause.callFrames[0];
   let topFrame;
   let captures = [];
@@ -1217,7 +1236,7 @@ async function captureSnapshot(session, pause, options = {}) {
       column: top.columnNumber + 1
     };
     if (options.includeScopes === true) {
-      const scopes = await captureScopes(session, top);
+      const scopes = await captureScopes(session, top, maxValueLength);
       topFrame = { ...topFrame, scopes };
     }
     if (options.captures !== void 0 && options.captures.length > 0) {
@@ -1225,11 +1244,17 @@ async function captureSnapshot(session, pause, options = {}) {
         options.captures.map(async (expression) => {
           try {
             const result = await evaluateOnFrame(session, top.callFrameId, expression);
-            const captured = evalResultToCaptured(expression, result);
-            return await withSerializedObjectCapture(session, expression, result, captured);
+            const captured = evalResultToCaptured(expression, result, maxValueLength);
+            return await withSerializedObjectCapture(
+              session,
+              expression,
+              result,
+              captured,
+              maxValueLength
+            );
           } catch (err) {
             const message = err instanceof Error ? err.message : String(err);
-            return { expression, error: message };
+            return { expression, error: limitValueLength(message, maxValueLength) };
           }
         })
       );