@browserbasehq/orca 3.2.0-preview.3 → 3.2.0-preview.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (171) hide show
  1. package/dist/cjs/lib/utils.d.ts +1 -0
  2. package/dist/cjs/lib/utils.js +4 -0
  3. package/dist/cjs/lib/utils.js.map +1 -1
  4. package/dist/cjs/lib/v3/agent/AnthropicCUAClient.js +5 -7
  5. package/dist/cjs/lib/v3/agent/AnthropicCUAClient.js.map +1 -1
  6. package/dist/cjs/lib/v3/agent/GoogleCUAClient.js +5 -7
  7. package/dist/cjs/lib/v3/agent/GoogleCUAClient.js.map +1 -1
  8. package/dist/cjs/lib/v3/agent/OpenAICUAClient.js +5 -7
  9. package/dist/cjs/lib/v3/agent/OpenAICUAClient.js.map +1 -1
  10. package/dist/cjs/lib/v3/agent/tools/act.js +1 -10
  11. package/dist/cjs/lib/v3/agent/tools/act.js.map +1 -1
  12. package/dist/cjs/lib/v3/agent/tools/ariaTree.js +1 -12
  13. package/dist/cjs/lib/v3/agent/tools/ariaTree.js.map +1 -1
  14. package/dist/cjs/lib/v3/agent/tools/braveSearch.js.map +1 -1
  15. package/dist/cjs/lib/v3/agent/tools/browserbaseSearch.js.map +1 -1
  16. package/dist/cjs/lib/v3/agent/tools/click.js.map +1 -1
  17. package/dist/cjs/lib/v3/agent/tools/clickAndHold.js.map +1 -1
  18. package/dist/cjs/lib/v3/agent/tools/dragAndDrop.js.map +1 -1
  19. package/dist/cjs/lib/v3/agent/tools/extract.js +1 -10
  20. package/dist/cjs/lib/v3/agent/tools/extract.js.map +1 -1
  21. package/dist/cjs/lib/v3/agent/tools/fillFormVision.js.map +1 -1
  22. package/dist/cjs/lib/v3/agent/tools/fillform.js +1 -10
  23. package/dist/cjs/lib/v3/agent/tools/fillform.js.map +1 -1
  24. package/dist/cjs/lib/v3/agent/tools/index.d.ts +2 -2
  25. package/dist/cjs/lib/v3/agent/tools/index.js +53 -5
  26. package/dist/cjs/lib/v3/agent/tools/index.js.map +1 -1
  27. package/dist/cjs/lib/v3/agent/tools/keys.d.ts +1 -1
  28. package/dist/cjs/lib/v3/agent/tools/keys.js.map +1 -1
  29. package/dist/cjs/lib/v3/agent/tools/type.js.map +1 -1
  30. package/dist/cjs/lib/v3/api.js +9 -2
  31. package/dist/cjs/lib/v3/api.js.map +1 -1
  32. package/dist/cjs/lib/v3/flowlogger/EventEmitter.d.ts +7 -0
  33. package/dist/cjs/lib/v3/flowlogger/EventEmitter.js +30 -0
  34. package/dist/cjs/lib/v3/flowlogger/EventEmitter.js.map +1 -0
  35. package/dist/cjs/lib/v3/flowlogger/EventSink.d.ts +44 -0
  36. package/dist/cjs/lib/v3/flowlogger/EventSink.js +217 -0
  37. package/dist/cjs/lib/v3/flowlogger/EventSink.js.map +1 -0
  38. package/dist/cjs/lib/v3/flowlogger/EventStore.d.ts +26 -0
  39. package/dist/cjs/lib/v3/flowlogger/EventStore.js +135 -0
  40. package/dist/cjs/lib/v3/flowlogger/EventStore.js.map +1 -0
  41. package/dist/cjs/lib/v3/flowlogger/FlowLogger.d.ts +99 -0
  42. package/dist/cjs/lib/v3/flowlogger/FlowLogger.js +591 -0
  43. package/dist/cjs/lib/v3/flowlogger/FlowLogger.js.map +1 -0
  44. package/dist/cjs/lib/v3/flowlogger/prettify.d.ts +6 -0
  45. package/dist/cjs/lib/v3/flowlogger/prettify.js +395 -0
  46. package/dist/cjs/lib/v3/flowlogger/prettify.js.map +1 -0
  47. package/dist/cjs/lib/v3/handlers/handlerUtils/actHandlerUtils.js +43 -57
  48. package/dist/cjs/lib/v3/handlers/handlerUtils/actHandlerUtils.js.map +1 -1
  49. package/dist/cjs/lib/v3/handlers/v3AgentHandler.d.ts +0 -4
  50. package/dist/cjs/lib/v3/handlers/v3AgentHandler.js +2 -32
  51. package/dist/cjs/lib/v3/handlers/v3AgentHandler.js.map +1 -1
  52. package/dist/cjs/lib/v3/handlers/v3CuaAgentHandler.js +9 -13
  53. package/dist/cjs/lib/v3/handlers/v3CuaAgentHandler.js.map +1 -1
  54. package/dist/cjs/lib/v3/llm/aisdk.js +11 -17
  55. package/dist/cjs/lib/v3/llm/aisdk.js.map +1 -1
  56. package/dist/cjs/lib/v3/types/public/options.d.ts +7 -0
  57. package/dist/cjs/lib/v3/types/public/options.js.map +1 -1
  58. package/dist/cjs/lib/v3/understudy/cdp.d.ts +3 -12
  59. package/dist/cjs/lib/v3/understudy/cdp.js +134 -21
  60. package/dist/cjs/lib/v3/understudy/cdp.js.map +1 -1
  61. package/dist/cjs/lib/v3/understudy/page.js +28 -18
  62. package/dist/cjs/lib/v3/understudy/page.js.map +1 -1
  63. package/dist/cjs/lib/v3/v3.d.ts +7 -2
  64. package/dist/cjs/lib/v3/v3.js +178 -159
  65. package/dist/cjs/lib/v3/v3.js.map +1 -1
  66. package/dist/cjs/tests/integration/flowLogger.spec.d.ts +1 -0
  67. package/dist/cjs/tests/integration/flowLogger.spec.js +714 -0
  68. package/dist/cjs/tests/integration/flowLogger.spec.js.map +1 -0
  69. package/dist/cjs/tests/integration/testUtils.d.ts +33 -0
  70. package/dist/cjs/tests/integration/testUtils.js +144 -0
  71. package/dist/cjs/tests/integration/testUtils.js.map +1 -1
  72. package/dist/cjs/tests/integration/timeouts.spec.js +112 -2
  73. package/dist/cjs/tests/integration/timeouts.spec.js.map +1 -1
  74. package/dist/cjs/tests/unit/flowlogger-capturing-cdp.test.d.ts +1 -0
  75. package/dist/cjs/tests/unit/flowlogger-capturing-cdp.test.js +95 -0
  76. package/dist/cjs/tests/unit/flowlogger-capturing-cdp.test.js.map +1 -0
  77. package/dist/cjs/tests/unit/flowlogger-capturing-llm.test.d.ts +1 -0
  78. package/dist/cjs/tests/unit/flowlogger-capturing-llm.test.js +43 -0
  79. package/dist/cjs/tests/unit/flowlogger-capturing-llm.test.js.map +1 -0
  80. package/dist/cjs/tests/unit/flowlogger-eventstore.test.d.ts +1 -0
  81. package/dist/cjs/tests/unit/flowlogger-eventstore.test.js +250 -0
  82. package/dist/cjs/tests/unit/flowlogger-eventstore.test.js.map +1 -0
  83. package/dist/esm/lib/utils.d.ts +1 -0
  84. package/dist/esm/lib/utils.js +3 -0
  85. package/dist/esm/lib/utils.js.map +1 -1
  86. package/dist/esm/lib/v3/agent/AnthropicCUAClient.js +5 -7
  87. package/dist/esm/lib/v3/agent/AnthropicCUAClient.js.map +1 -1
  88. package/dist/esm/lib/v3/agent/GoogleCUAClient.js +5 -7
  89. package/dist/esm/lib/v3/agent/GoogleCUAClient.js.map +1 -1
  90. package/dist/esm/lib/v3/agent/OpenAICUAClient.js +5 -7
  91. package/dist/esm/lib/v3/agent/OpenAICUAClient.js.map +1 -1
  92. package/dist/esm/lib/v3/agent/tools/act.js +1 -10
  93. package/dist/esm/lib/v3/agent/tools/act.js.map +1 -1
  94. package/dist/esm/lib/v3/agent/tools/ariaTree.js +1 -12
  95. package/dist/esm/lib/v3/agent/tools/ariaTree.js.map +1 -1
  96. package/dist/esm/lib/v3/agent/tools/braveSearch.js.map +1 -1
  97. package/dist/esm/lib/v3/agent/tools/browserbaseSearch.js.map +1 -1
  98. package/dist/esm/lib/v3/agent/tools/click.js.map +1 -1
  99. package/dist/esm/lib/v3/agent/tools/clickAndHold.js.map +1 -1
  100. package/dist/esm/lib/v3/agent/tools/dragAndDrop.js.map +1 -1
  101. package/dist/esm/lib/v3/agent/tools/extract.js +1 -10
  102. package/dist/esm/lib/v3/agent/tools/extract.js.map +1 -1
  103. package/dist/esm/lib/v3/agent/tools/fillFormVision.js.map +1 -1
  104. package/dist/esm/lib/v3/agent/tools/fillform.js +1 -10
  105. package/dist/esm/lib/v3/agent/tools/fillform.js.map +1 -1
  106. package/dist/esm/lib/v3/agent/tools/index.d.ts +2 -2
  107. package/dist/esm/lib/v3/agent/tools/index.js +53 -5
  108. package/dist/esm/lib/v3/agent/tools/index.js.map +1 -1
  109. package/dist/esm/lib/v3/agent/tools/keys.d.ts +1 -1
  110. package/dist/esm/lib/v3/agent/tools/keys.js.map +1 -1
  111. package/dist/esm/lib/v3/agent/tools/type.js.map +1 -1
  112. package/dist/esm/lib/v3/api.js +9 -2
  113. package/dist/esm/lib/v3/api.js.map +1 -1
  114. package/dist/esm/lib/v3/flowlogger/EventEmitter.d.ts +7 -0
  115. package/dist/esm/lib/v3/flowlogger/EventEmitter.js +26 -0
  116. package/dist/esm/lib/v3/flowlogger/EventEmitter.js.map +1 -0
  117. package/dist/esm/lib/v3/flowlogger/EventSink.d.ts +44 -0
  118. package/dist/esm/lib/v3/flowlogger/EventSink.js +206 -0
  119. package/dist/esm/lib/v3/flowlogger/EventSink.js.map +1 -0
  120. package/dist/esm/lib/v3/flowlogger/EventStore.d.ts +26 -0
  121. package/dist/esm/lib/v3/flowlogger/EventStore.js +127 -0
  122. package/dist/esm/lib/v3/flowlogger/EventStore.js.map +1 -0
  123. package/dist/esm/lib/v3/flowlogger/FlowLogger.d.ts +99 -0
  124. package/dist/esm/lib/v3/flowlogger/FlowLogger.js +583 -0
  125. package/dist/esm/lib/v3/flowlogger/FlowLogger.js.map +1 -0
  126. package/dist/esm/lib/v3/flowlogger/prettify.d.ts +6 -0
  127. package/dist/esm/lib/v3/flowlogger/prettify.js +389 -0
  128. package/dist/esm/lib/v3/flowlogger/prettify.js.map +1 -0
  129. package/dist/esm/lib/v3/handlers/handlerUtils/actHandlerUtils.js +43 -57
  130. package/dist/esm/lib/v3/handlers/handlerUtils/actHandlerUtils.js.map +1 -1
  131. package/dist/esm/lib/v3/handlers/v3AgentHandler.d.ts +0 -4
  132. package/dist/esm/lib/v3/handlers/v3AgentHandler.js +2 -32
  133. package/dist/esm/lib/v3/handlers/v3AgentHandler.js.map +1 -1
  134. package/dist/esm/lib/v3/handlers/v3CuaAgentHandler.js +9 -13
  135. package/dist/esm/lib/v3/handlers/v3CuaAgentHandler.js.map +1 -1
  136. package/dist/esm/lib/v3/llm/aisdk.js +11 -17
  137. package/dist/esm/lib/v3/llm/aisdk.js.map +1 -1
  138. package/dist/esm/lib/v3/types/public/options.d.ts +7 -0
  139. package/dist/esm/lib/v3/types/public/options.js.map +1 -1
  140. package/dist/esm/lib/v3/understudy/cdp.d.ts +3 -12
  141. package/dist/esm/lib/v3/understudy/cdp.js +134 -21
  142. package/dist/esm/lib/v3/understudy/cdp.js.map +1 -1
  143. package/dist/esm/lib/v3/understudy/page.js +28 -18
  144. package/dist/esm/lib/v3/understudy/page.js.map +1 -1
  145. package/dist/esm/lib/v3/v3.d.ts +7 -2
  146. package/dist/esm/lib/v3/v3.js +178 -159
  147. package/dist/esm/lib/v3/v3.js.map +1 -1
  148. package/dist/esm/tests/integration/flowLogger.spec.d.ts +1 -0
  149. package/dist/esm/tests/integration/flowLogger.spec.js +712 -0
  150. package/dist/esm/tests/integration/flowLogger.spec.js.map +1 -0
  151. package/dist/esm/tests/integration/testUtils.d.ts +33 -0
  152. package/dist/esm/tests/integration/testUtils.js +138 -0
  153. package/dist/esm/tests/integration/testUtils.js.map +1 -1
  154. package/dist/esm/tests/integration/timeouts.spec.js +112 -2
  155. package/dist/esm/tests/integration/timeouts.spec.js.map +1 -1
  156. package/dist/esm/tests/unit/flowlogger-capturing-cdp.test.d.ts +1 -0
  157. package/dist/esm/tests/unit/flowlogger-capturing-cdp.test.js +93 -0
  158. package/dist/esm/tests/unit/flowlogger-capturing-cdp.test.js.map +1 -0
  159. package/dist/esm/tests/unit/flowlogger-capturing-llm.test.d.ts +1 -0
  160. package/dist/esm/tests/unit/flowlogger-capturing-llm.test.js +41 -0
  161. package/dist/esm/tests/unit/flowlogger-capturing-llm.test.js.map +1 -0
  162. package/dist/esm/tests/unit/flowlogger-eventstore.test.d.ts +1 -0
  163. package/dist/esm/tests/unit/flowlogger-eventstore.test.js +248 -0
  164. package/dist/esm/tests/unit/flowlogger-eventstore.test.js.map +1 -0
  165. package/package.json +3 -1
  166. package/dist/cjs/lib/v3/flowLogger.d.ts +0 -139
  167. package/dist/cjs/lib/v3/flowLogger.js +0 -881
  168. package/dist/cjs/lib/v3/flowLogger.js.map +0 -1
  169. package/dist/esm/lib/v3/flowLogger.d.ts +0 -139
  170. package/dist/esm/lib/v3/flowLogger.js +0 -868
  171. package/dist/esm/lib/v3/flowLogger.js.map +0 -1
@@ -1,868 +0,0 @@
1
- import { AsyncLocalStorage } from "node:async_hooks";
2
- import fs from "node:fs";
3
- import { Writable } from "node:stream";
4
- import { v7 as uuidv7 } from "uuid";
5
- import path from "node:path";
6
- import pino from "pino";
7
- // =============================================================================
8
- // Constants
9
- // =============================================================================
10
- const MAX_LINE_LENGTH = 160;
11
- // Flow logging config dir - empty string disables logging entirely
12
- const CONFIG_DIR = process.env.BROWSERBASE_CONFIG_DIR || "";
13
- const NOISY_CDP_EVENTS = new Set([
14
- "Target.targetInfoChanged",
15
- "Runtime.executionContextCreated",
16
- "Runtime.executionContextDestroyed",
17
- "Runtime.executionContextsCleared",
18
- "Page.lifecycleEvent",
19
- "Network.dataReceived",
20
- "Network.loadingFinished",
21
- "Network.requestWillBeSentExtraInfo",
22
- "Network.responseReceivedExtraInfo",
23
- "Network.requestWillBeSent",
24
- "Network.responseReceived",
25
- ]);
26
- const loggerContext = new AsyncLocalStorage();
27
- // =============================================================================
28
- // Formatting Utilities (used by pretty streams)
29
- // =============================================================================
30
- /** Calculate base64 data size in KB */
31
- const dataToKb = (data) => ((data.length * 0.75) / 1024).toFixed(1);
32
- /** Truncate CDP IDs: frameId:363F03EB...EF8 → frameId:363F…5EF8 */
33
- function truncateCdpIds(value) {
34
- return value.replace(/([iI]d:?"?)([0-9A-F]{32})(?="?[,})\s]|$)/g, (_, pre, id) => `${pre}${id.slice(0, 4)}…${id.slice(-4)}`);
35
- }
36
- /** Truncate line showing start...end */
37
- function truncateLine(value, maxLen) {
38
- const collapsed = value.replace(/\s+/g, " ");
39
- if (collapsed.length <= maxLen)
40
- return collapsed;
41
- const endLen = Math.floor(maxLen * 0.3);
42
- const startLen = maxLen - endLen - 1;
43
- return `${collapsed.slice(0, startLen)}…${collapsed.slice(-endLen)}`;
44
- }
45
- function formatValue(value) {
46
- if (typeof value === "string")
47
- return `'${value}'`;
48
- if (value == null || typeof value !== "object")
49
- return String(value);
50
- try {
51
- return JSON.stringify(value);
52
- }
53
- catch {
54
- return "[unserializable]";
55
- }
56
- }
57
- function formatArgs(args) {
58
- if (args === undefined)
59
- return "";
60
- return (Array.isArray(args) ? args : [args])
61
- .filter((e) => e !== undefined)
62
- .map(formatValue)
63
- .filter((e) => e.length > 0)
64
- .join(", ");
65
- }
66
- const shortId = (id) => id ? id.slice(-4) : "-";
67
- function formatTag(label, id, icon) {
68
- return id ? `[${icon} #${shortId(id)}${label ? " " + label : ""}]` : "⤑";
69
- }
70
- let nonce = 0;
71
- function formatTimestamp() {
72
- const d = new Date();
73
- const pad = (n, w = 2) => String(n).padStart(w, "0");
74
- return `${d.getFullYear()}-${pad(d.getMonth() + 1)}-${pad(d.getDate())} ${pad(d.getHours())}:${pad(d.getMinutes())}:${pad(d.getSeconds())}.${pad(d.getMilliseconds(), 3)}${pad(nonce++ % 100)}`;
75
- }
76
- const SENSITIVE_KEYS = /apikey|api_key|key|secret|token|password|passwd|pwd|credential|auth/i;
77
- function sanitizeOptions(options) {
78
- const sanitize = (obj) => {
79
- if (typeof obj !== "object" || obj === null)
80
- return obj;
81
- if (Array.isArray(obj))
82
- return obj.map(sanitize);
83
- const result = {};
84
- for (const [key, value] of Object.entries(obj)) {
85
- result[key] = SENSITIVE_KEYS.test(key) ? "******" : sanitize(value);
86
- }
87
- return result;
88
- };
89
- return sanitize({ ...options });
90
- }
91
- /** Remove unescaped quotes for cleaner log output */
92
- function removeQuotes(str) {
93
- return str
94
- .replace(/([^\\])["']/g, "$1")
95
- .replace(/^["']|["']$/g, "")
96
- .trim();
97
- }
98
- // =============================================================================
99
- // Pretty Formatting (converts FlowEvent to human-readable log line)
100
- // =============================================================================
101
- function prettifyEvent(event) {
102
- const parts = [];
103
- // Build context tags - always add parent span tags (formatTag returns ⤑ for null IDs)
104
- if (event.category === "AgentTask") {
105
- parts.push(formatTag("", event.taskId, "🅰"));
106
- }
107
- else if (event.category === "StagehandStep") {
108
- parts.push(formatTag("", event.taskId, "🅰"));
109
- parts.push(formatTag(event.stepLabel, event.stepId, "🆂"));
110
- }
111
- else if (event.category === "UnderstudyAction") {
112
- parts.push(formatTag("", event.taskId, "🅰"));
113
- parts.push(formatTag(event.stepLabel, event.stepId, "🆂"));
114
- parts.push(formatTag(event.actionLabel, event.actionId, "🆄"));
115
- }
116
- else if (event.category === "CDP") {
117
- parts.push(formatTag("", event.taskId, "🅰"));
118
- parts.push(formatTag(event.stepLabel, event.stepId, "🆂"));
119
- parts.push(formatTag(event.actionLabel, event.actionId, "🆄"));
120
- parts.push(formatTag("CDP", event.targetId, "🅲"));
121
- }
122
- else if (event.category === "LLM") {
123
- parts.push(formatTag("", event.taskId, "🅰"));
124
- parts.push(formatTag(event.stepLabel, event.stepId, "🆂"));
125
- parts.push(formatTag("LLM", event.requestId, "🧠"));
126
- }
127
- // Build details based on event type
128
- let details = "";
129
- const argsStr = event.params ? formatArgs(event.params) : "";
130
- if (event.category === "AgentTask") {
131
- if (event.event === "started") {
132
- details = `▷ ${event.method}(${argsStr})`;
133
- }
134
- else if (event.event === "completed") {
135
- const m = event.metrics;
136
- const durationSec = m?.durationMs
137
- ? (m.durationMs / 1000).toFixed(1)
138
- : "?";
139
- const llmStats = `${m?.llmRequests ?? 0} LLM calls ꜛ${m?.inputTokens ?? 0} ꜜ${m?.outputTokens ?? 0} tokens`;
140
- const cdpStats = `${m?.cdpEvents ?? 0} CDP msgs`;
141
- details = `✓ Agent.execute() DONE in ${durationSec}s | ${llmStats} | ${cdpStats}`;
142
- }
143
- }
144
- else if (event.category === "StagehandStep") {
145
- if (event.event === "started") {
146
- details = `▷ ${event.method}(${argsStr})`;
147
- }
148
- else if (event.event === "completed") {
149
- const durationSec = event.metrics?.durationMs
150
- ? (event.metrics.durationMs / 1000).toFixed(2)
151
- : "?";
152
- details = `✓ ${event.stepLabel || "STEP"} completed in ${durationSec}s`;
153
- }
154
- }
155
- else if (event.category === "UnderstudyAction") {
156
- if (event.event === "started") {
157
- details = `▷ ${event.method}(${argsStr})`;
158
- }
159
- else if (event.event === "completed") {
160
- const durationSec = event.metrics?.durationMs
161
- ? (event.metrics.durationMs / 1000).toFixed(2)
162
- : "?";
163
- details = `✓ ${event.actionLabel || "ACTION"} completed in ${durationSec}s`;
164
- }
165
- }
166
- else if (event.category === "CDP") {
167
- const icon = event.event === "call" ? "⏵" : "⏴";
168
- details = `${icon} ${event.method}(${argsStr})`;
169
- }
170
- else if (event.category === "LLM") {
171
- if (event.event === "request") {
172
- const promptStr = event.prompt ? " " + String(event.prompt) : "";
173
- details = `${event.model} ⏴${promptStr}`;
174
- }
175
- else if (event.event === "response") {
176
- const hasTokens = event.inputTokens !== undefined || event.outputTokens !== undefined;
177
- const tokenStr = hasTokens
178
- ? ` ꜛ${event.inputTokens ?? 0} ꜜ${event.outputTokens ?? 0} |`
179
- : "";
180
- const outputStr = event.output ? " " + String(event.output) : "";
181
- details = `${event.model} ↳${tokenStr}${outputStr}`;
182
- }
183
- }
184
- if (!details)
185
- return null;
186
- // Assemble line and apply final truncation
187
- const fullLine = `${formatTimestamp()} ${parts.join(" ")} ${details}`;
188
- const cleaned = removeQuotes(fullLine);
189
- const processed = event.category === "CDP" ? truncateCdpIds(cleaned) : cleaned;
190
- return truncateLine(processed, MAX_LINE_LENGTH);
191
- }
192
- /** Check if a CDP event should be filtered from pretty output */
193
- function shouldFilterCdpEvent(event) {
194
- if (event.category !== "CDP")
195
- return false;
196
- if (event.method?.endsWith(".enable") || event.method === "enable")
197
- return true;
198
- return event.event === "message" && NOISY_CDP_EVENTS.has(event.method);
199
- }
200
- // =============================================================================
201
- // Stream Creation
202
- // =============================================================================
203
- const isWritable = (s) => !!(s && !s.destroyed && s.writable);
204
- function createJsonlStream(ctx) {
205
- return new Writable({
206
- objectMode: true,
207
- write(chunk, _, cb) {
208
- if (ctx.initialized && isWritable(ctx.fileStreams.jsonl)) {
209
- ctx.fileStreams.jsonl.write(chunk, cb);
210
- }
211
- else
212
- cb();
213
- },
214
- });
215
- }
216
- function createPrettyStream(ctx, category, streamKey) {
217
- return new Writable({
218
- objectMode: true,
219
- write(chunk, _, cb) {
220
- const stream = ctx.fileStreams[streamKey];
221
- if (!ctx.initialized || !isWritable(stream))
222
- return cb();
223
- try {
224
- const event = JSON.parse(chunk);
225
- if (event.category !== category || shouldFilterCdpEvent(event))
226
- return cb();
227
- const line = prettifyEvent(event);
228
- if (line)
229
- stream.write(line + "\n", cb);
230
- else
231
- cb();
232
- }
233
- catch {
234
- cb();
235
- }
236
- },
237
- });
238
- }
239
- // =============================================================================
240
- // Public Helpers (used by external callers)
241
- // =============================================================================
242
- /**
243
- * Get the config directory. Returns empty string if logging is disabled.
244
- */
245
- export function getConfigDir() {
246
- return CONFIG_DIR ? path.resolve(CONFIG_DIR) : "";
247
- }
248
- /** Extract text and image info from a content array (handles nested tool_result) */
249
- function extractFromContent(content, result) {
250
- for (const part of content) {
251
- const p = part;
252
- // Text
253
- if (!result.text && p.text) {
254
- result.text = p.type === "text" || !p.type ? p.text : undefined;
255
- }
256
- // Images - various formats
257
- if (p.type === "image" || p.type === "image_url") {
258
- const url = p.image_url?.url;
259
- if (url?.startsWith("data:"))
260
- result.extras.push(`${dataToKb(url)}kb image`);
261
- else if (p.source?.data)
262
- result.extras.push(`${dataToKb(p.source.data)}kb image`);
263
- else
264
- result.extras.push("image");
265
- }
266
- else if (p.source?.data) {
267
- result.extras.push(`${dataToKb(p.source.data)}kb image`);
268
- }
269
- else if (p.inlineData?.data) {
270
- result.extras.push(`${dataToKb(p.inlineData.data)}kb image`);
271
- }
272
- // Recurse into tool_result content
273
- if (p.type === "tool_result" && Array.isArray(p.content)) {
274
- extractFromContent(p.content, result);
275
- }
276
- }
277
- }
278
- /** Build final preview string with extras */
279
- function buildPreview(text, extras, maxLen) {
280
- if (!text && extras.length === 0)
281
- return undefined;
282
- let result = text || "";
283
- if (maxLen && result.length > maxLen)
284
- result = result.slice(0, maxLen) + "...";
285
- if (extras.length > 0) {
286
- const extrasStr = extras.map((e) => `+{${e}}`).join(" ");
287
- result = result ? `${result} ${extrasStr}` : extrasStr;
288
- }
289
- return result || undefined;
290
- }
291
- /**
292
- * Format a prompt preview from LLM messages for logging.
293
- * Returns format like: "some text... +{5.8kb image} +{schema} +{12 tools}"
294
- */
295
- export function formatLlmPromptPreview(messages, options) {
296
- try {
297
- const lastUserMsg = messages.filter((m) => m.role === "user").pop();
298
- if (!lastUserMsg)
299
- return undefined;
300
- const result = {
301
- text: undefined,
302
- extras: [],
303
- };
304
- if (typeof lastUserMsg.content === "string") {
305
- result.text = lastUserMsg.content;
306
- }
307
- else if (Array.isArray(lastUserMsg.content)) {
308
- extractFromContent(lastUserMsg.content, result);
309
- }
310
- else {
311
- return undefined;
312
- }
313
- // Clean instruction prefix
314
- if (result.text) {
315
- result.text = result.text.replace(/^[Ii]nstruction: /, "");
316
- }
317
- if (options?.hasSchema)
318
- result.extras.push("schema");
319
- if (options?.toolCount)
320
- result.extras.push(`${options.toolCount} tools`);
321
- return buildPreview(result.text, result.extras);
322
- }
323
- catch {
324
- return undefined;
325
- }
326
- }
327
- /**
328
- * Extract a text preview from CUA-style messages.
329
- * Accepts various message formats (Anthropic, OpenAI, Google).
330
- */
331
- export function formatCuaPromptPreview(messages, maxLen = 100) {
332
- try {
333
- const lastMsg = messages
334
- .filter((m) => {
335
- const msg = m;
336
- return msg.role === "user" || msg.type === "tool_result";
337
- })
338
- .pop();
339
- if (!lastMsg)
340
- return undefined;
341
- const result = {
342
- text: undefined,
343
- extras: [],
344
- };
345
- if (typeof lastMsg.content === "string") {
346
- result.text = lastMsg.content;
347
- }
348
- else if (typeof lastMsg.text === "string") {
349
- result.text = lastMsg.text;
350
- }
351
- else if (Array.isArray(lastMsg.parts)) {
352
- extractFromContent(lastMsg.parts, result);
353
- }
354
- else if (Array.isArray(lastMsg.content)) {
355
- extractFromContent(lastMsg.content, result);
356
- }
357
- return buildPreview(result.text, result.extras, maxLen);
358
- }
359
- catch {
360
- return undefined;
361
- }
362
- }
363
- /** Format CUA response output for logging */
364
- export function formatCuaResponsePreview(output, maxLen = 100) {
365
- try {
366
- // Handle Google format or array
367
- const items = output
368
- ?.candidates?.[0]?.content?.parts ??
369
- (Array.isArray(output) ? output : []);
370
- const preview = items
371
- .map((item) => {
372
- const i = item;
373
- if (i.text)
374
- return i.text.slice(0, 50);
375
- if (i.functionCall?.name)
376
- return `fn:${i.functionCall.name}`;
377
- if (i.type === "tool_use" && i.name)
378
- return `tool_use:${i.name}`;
379
- return i.type ? `[${i.type}]` : "[item]";
380
- })
381
- .join(" ");
382
- return preview.slice(0, maxLen);
383
- }
384
- catch {
385
- return "[error]";
386
- }
387
- }
388
- // =============================================================================
389
- // SessionFileLogger - Main API
390
- // =============================================================================
391
- export class SessionFileLogger {
392
- /**
393
- * Initialize a new logging context. Call this at the start of a session.
394
- * If BROWSERBASE_CONFIG_DIR is not set, logging is disabled.
395
- */
396
- static init(sessionId, v3Options) {
397
- const configDir = getConfigDir();
398
- if (!configDir)
399
- return; // Logging disabled
400
- const sessionDir = path.join(configDir, "sessions", sessionId);
401
- // Create context with placeholder logger (will be replaced after streams init)
402
- const ctx = {
403
- logger: pino({ level: "silent" }), // Placeholder, replaced below
404
- metrics: {
405
- llmRequests: 0,
406
- llmInputTokens: 0,
407
- llmOutputTokens: 0,
408
- cdpEvents: 0,
409
- },
410
- sessionId,
411
- sessionDir,
412
- configDir,
413
- initPromise: Promise.resolve(),
414
- initialized: false,
415
- // Span context - mutable, injected into every log via mixin
416
- taskId: null,
417
- stepId: null,
418
- stepLabel: null,
419
- actionId: null,
420
- actionLabel: null,
421
- fileStreams: {
422
- agent: null,
423
- stagehand: null,
424
- understudy: null,
425
- cdp: null,
426
- llm: null,
427
- jsonl: null,
428
- },
429
- };
430
- // Store init promise for awaiting in log methods
431
- ctx.initPromise = SessionFileLogger.initAsync(ctx, v3Options);
432
- loggerContext.enterWith(ctx);
433
- }
434
- static async initAsync(ctx, v3Options) {
435
- try {
436
- await fs.promises.mkdir(ctx.sessionDir, { recursive: true });
437
- if (v3Options) {
438
- const sanitizedOptions = sanitizeOptions(v3Options);
439
- const sessionJsonPath = path.join(ctx.sessionDir, "session.json");
440
- await fs.promises.writeFile(sessionJsonPath, JSON.stringify(sanitizedOptions, null, 2), "utf-8");
441
- }
442
- // Create symlink to latest session
443
- const latestLink = path.join(ctx.configDir, "sessions", "latest");
444
- try {
445
- try {
446
- await fs.promises.unlink(latestLink);
447
- }
448
- catch {
449
- // Ignore if doesn't exist
450
- }
451
- await fs.promises.symlink(ctx.sessionId, latestLink, "dir");
452
- }
453
- catch {
454
- // Symlink creation can fail on Windows or due to permissions
455
- }
456
- // Create file streams
457
- const dir = ctx.sessionDir;
458
- ctx.fileStreams.agent = fs.createWriteStream(path.join(dir, "agent_events.log"), { flags: "a" });
459
- ctx.fileStreams.stagehand = fs.createWriteStream(path.join(dir, "stagehand_events.log"), { flags: "a" });
460
- ctx.fileStreams.understudy = fs.createWriteStream(path.join(dir, "understudy_events.log"), { flags: "a" });
461
- ctx.fileStreams.cdp = fs.createWriteStream(path.join(dir, "cdp_events.log"), { flags: "a" });
462
- ctx.fileStreams.llm = fs.createWriteStream(path.join(dir, "llm_events.log"), { flags: "a" });
463
- ctx.fileStreams.jsonl = fs.createWriteStream(path.join(dir, "session_events.jsonl"), { flags: "a" });
464
- ctx.initialized = true;
465
- // Create pino multistream: JSONL + pretty streams per category
466
- const streams = [
467
- { stream: createJsonlStream(ctx) },
468
- { stream: createPrettyStream(ctx, "AgentTask", "agent") },
469
- { stream: createPrettyStream(ctx, "StagehandStep", "stagehand") },
470
- { stream: createPrettyStream(ctx, "UnderstudyAction", "understudy") },
471
- { stream: createPrettyStream(ctx, "CDP", "cdp") },
472
- { stream: createPrettyStream(ctx, "LLM", "llm") },
473
- ];
474
- // Create logger with mixin that injects span context from AsyncLocalStorage
475
- ctx.logger = pino({
476
- level: "info",
477
- // Mixin adds eventId and current span context to every log
478
- mixin() {
479
- const store = loggerContext.getStore();
480
- return {
481
- eventId: uuidv7(),
482
- sessionId: store?.sessionId,
483
- taskId: store?.taskId,
484
- stepId: store?.stepId,
485
- stepLabel: store?.stepLabel,
486
- actionId: store?.actionId,
487
- actionLabel: store?.actionLabel,
488
- };
489
- },
490
- }, pino.multistream(streams));
491
- }
492
- catch {
493
- // Fail silently
494
- }
495
- }
496
- static async close() {
497
- const ctx = loggerContext.getStore();
498
- if (!ctx)
499
- return;
500
- await ctx.initPromise;
501
- SessionFileLogger.logAgentTaskCompleted();
502
- await Promise.all(Object.values(ctx.fileStreams)
503
- .filter(Boolean)
504
- .map((s) => new Promise((r) => s.end(r)))).catch(() => { });
505
- }
506
- static get sessionId() {
507
- return loggerContext.getStore()?.sessionId ?? null;
508
- }
509
- static get sessionDir() {
510
- return loggerContext.getStore()?.sessionDir ?? null;
511
- }
512
- /**
513
- * Get the current logger context object.
514
- */
515
- static getContext() {
516
- return loggerContext.getStore() ?? null;
517
- }
518
- // ===========================================================================
519
- // Agent Task Events
520
- // ===========================================================================
521
- /**
522
- * Start a new task and log it.
523
- */
524
- static logAgentTaskStarted({ invocation, args, }) {
525
- const ctx = loggerContext.getStore();
526
- if (!ctx)
527
- return;
528
- // Set up task context
529
- ctx.taskId = uuidv7();
530
- ctx.stepId = null;
531
- ctx.stepLabel = null;
532
- ctx.actionId = null;
533
- ctx.actionLabel = null;
534
- // Reset metrics for new task
535
- ctx.metrics = {
536
- taskStartTime: Date.now(),
537
- llmRequests: 0,
538
- llmInputTokens: 0,
539
- llmOutputTokens: 0,
540
- cdpEvents: 0,
541
- };
542
- ctx.logger.info({
543
- category: "AgentTask",
544
- event: "started",
545
- method: invocation,
546
- params: args,
547
- });
548
- }
549
- /**
550
- * Log task completion with metrics summary.
551
- */
552
- static logAgentTaskCompleted(options) {
553
- const ctx = loggerContext.getStore();
554
- if (!ctx || !ctx.metrics.taskStartTime)
555
- return;
556
- const durationMs = Date.now() - ctx.metrics.taskStartTime;
557
- const event = {
558
- category: "AgentTask",
559
- event: "completed",
560
- method: "Agent.execute",
561
- metrics: {
562
- durationMs,
563
- llmRequests: ctx.metrics.llmRequests,
564
- inputTokens: ctx.metrics.llmInputTokens,
565
- outputTokens: ctx.metrics.llmOutputTokens,
566
- cdpEvents: ctx.metrics.cdpEvents,
567
- },
568
- };
569
- if (options?.cacheHit) {
570
- event.msg = "CACHE HIT, NO LLM NEEDED";
571
- }
572
- ctx.logger.info(event);
573
- // Clear task context
574
- ctx.taskId = null;
575
- ctx.stepId = null;
576
- ctx.stepLabel = null;
577
- ctx.actionId = null;
578
- ctx.actionLabel = null;
579
- ctx.metrics.taskStartTime = undefined;
580
- }
581
- // ===========================================================================
582
- // Stagehand Step Events
583
- // ===========================================================================
584
- static logStagehandStepEvent({ invocation, args, label, }) {
585
- const ctx = loggerContext.getStore();
586
- if (!ctx)
587
- return uuidv7();
588
- // Set up step context
589
- ctx.stepId = uuidv7();
590
- ctx.stepLabel = label.toUpperCase();
591
- ctx.actionId = null;
592
- ctx.actionLabel = null;
593
- ctx.metrics.stepStartTime = Date.now();
594
- ctx.logger.info({
595
- category: "StagehandStep",
596
- event: "started",
597
- method: invocation,
598
- params: args,
599
- });
600
- return ctx.stepId;
601
- }
602
- static logStagehandStepCompleted() {
603
- const ctx = loggerContext.getStore();
604
- if (!ctx || !ctx.stepId)
605
- return;
606
- const durationMs = ctx.metrics.stepStartTime
607
- ? Date.now() - ctx.metrics.stepStartTime
608
- : 0;
609
- ctx.logger.info({
610
- category: "StagehandStep",
611
- event: "completed",
612
- metrics: { durationMs },
613
- });
614
- // Clear step context
615
- ctx.stepId = null;
616
- ctx.stepLabel = null;
617
- ctx.actionId = null;
618
- ctx.actionLabel = null;
619
- ctx.metrics.stepStartTime = undefined;
620
- }
621
- // ===========================================================================
622
- // Understudy Action Events
623
- // ===========================================================================
624
- static logUnderstudyActionEvent({ actionType, target, args, }) {
625
- const ctx = loggerContext.getStore();
626
- if (!ctx)
627
- return uuidv7();
628
- // Set up action context
629
- ctx.actionId = uuidv7();
630
- ctx.actionLabel = actionType
631
- .toUpperCase()
632
- .replace("UNDERSTUDY.", "")
633
- .replace("PAGE.", "");
634
- ctx.metrics.actionStartTime = Date.now();
635
- const params = {};
636
- if (target)
637
- params.target = target;
638
- if (args)
639
- params.args = args;
640
- ctx.logger.info({
641
- category: "UnderstudyAction",
642
- event: "started",
643
- method: actionType,
644
- params: Object.keys(params).length > 0 ? params : undefined,
645
- });
646
- return ctx.actionId;
647
- }
648
- static logUnderstudyActionCompleted() {
649
- const ctx = loggerContext.getStore();
650
- if (!ctx || !ctx.actionId)
651
- return;
652
- const durationMs = ctx.metrics.actionStartTime
653
- ? Date.now() - ctx.metrics.actionStartTime
654
- : 0;
655
- ctx.logger.info({
656
- category: "UnderstudyAction",
657
- event: "completed",
658
- metrics: { durationMs },
659
- });
660
- // Clear action context
661
- ctx.actionId = null;
662
- ctx.actionLabel = null;
663
- ctx.metrics.actionStartTime = undefined;
664
- }
665
- // ===========================================================================
666
- // CDP Events
667
- // ===========================================================================
668
- static logCdpEvent(eventType, { method, params, targetId, }, explicitCtx) {
669
- const ctx = explicitCtx ?? loggerContext.getStore();
670
- if (!ctx)
671
- return;
672
- if (eventType === "call")
673
- ctx.metrics.cdpEvents++;
674
- ctx.logger.info({
675
- category: "CDP",
676
- event: eventType,
677
- method,
678
- params,
679
- targetId,
680
- });
681
- }
682
- static logCdpCallEvent(data, ctx) {
683
- SessionFileLogger.logCdpEvent("call", data, ctx);
684
- }
685
- static logCdpMessageEvent(data, ctx) {
686
- SessionFileLogger.logCdpEvent("message", data, ctx);
687
- }
688
- // ===========================================================================
689
- // LLM Events
690
- // ===========================================================================
691
- static logLlmRequest({ requestId, model, prompt, }, explicitCtx) {
692
- const ctx = explicitCtx ?? loggerContext.getStore();
693
- if (!ctx)
694
- return;
695
- // Track LLM requests for task metrics
696
- ctx.metrics.llmRequests++;
697
- ctx.logger.info({
698
- category: "LLM",
699
- event: "request",
700
- requestId,
701
- method: "LLM.request",
702
- model,
703
- prompt,
704
- });
705
- }
706
- static logLlmResponse({ requestId, model, output, inputTokens, outputTokens, }, explicitCtx) {
707
- const ctx = explicitCtx ?? loggerContext.getStore();
708
- if (!ctx)
709
- return;
710
- // Track tokens for task metrics
711
- ctx.metrics.llmInputTokens += inputTokens ?? 0;
712
- ctx.metrics.llmOutputTokens += outputTokens ?? 0;
713
- ctx.logger.info({
714
- category: "LLM",
715
- event: "response",
716
- requestId,
717
- method: "LLM.response",
718
- model,
719
- output,
720
- inputTokens,
721
- outputTokens,
722
- });
723
- }
724
- // ===========================================================================
725
- // LLM Logging Middleware
726
- // ===========================================================================
727
- /**
728
- * Create middleware for wrapping language models with LLM call logging.
729
- * Returns a no-op middleware when logging is disabled.
730
- */
731
- static createLlmLoggingMiddleware(modelId) {
732
- // No-op middleware when logging is disabled
733
- if (!CONFIG_DIR) {
734
- return {
735
- wrapGenerate: async ({ doGenerate }) => doGenerate(),
736
- };
737
- }
738
- return {
739
- wrapGenerate: async ({ doGenerate, params }) => {
740
- const ctx = SessionFileLogger.getContext();
741
- // Skip logging overhead if no context (shouldn't happen but be safe)
742
- if (!ctx) {
743
- return doGenerate();
744
- }
745
- const llmRequestId = uuidv7();
746
- const toolCount = Array.isArray(params.tools) ? params.tools.length : 0;
747
- // Extract prompt preview from last non-system message
748
- const messages = (params.prompt ?? []);
749
- const lastMsg = messages.filter((m) => m.role !== "system").pop();
750
- const extracted = {
751
- text: undefined,
752
- extras: [],
753
- };
754
- let rolePrefix = lastMsg?.role ?? "?";
755
- if (lastMsg) {
756
- if (typeof lastMsg.content === "string") {
757
- extracted.text = lastMsg.content;
758
- }
759
- else if (Array.isArray(lastMsg.content)) {
760
- // Check for tool-result first
761
- const toolResult = lastMsg.content.find((p) => p.type === "tool-result");
762
- if (toolResult) {
763
- rolePrefix = `tool result: ${toolResult.toolName}()`;
764
- const out = toolResult.output;
765
- if (out?.type === "json" && out.value) {
766
- extracted.text = JSON.stringify(out.value).slice(0, 150);
767
- }
768
- else if (Array.isArray(out?.value)) {
769
- extractFromContent(out.value, extracted);
770
- }
771
- }
772
- else {
773
- extractFromContent(lastMsg.content, extracted);
774
- }
775
- }
776
- }
777
- const promptText = extracted.text || "(no text)";
778
- const promptPreview = `${rolePrefix}: ${promptText} +{${toolCount} tools}`;
779
- SessionFileLogger.logLlmRequest({
780
- requestId: llmRequestId,
781
- model: modelId,
782
- operation: "generateText",
783
- prompt: promptPreview,
784
- }, ctx);
785
- const result = await doGenerate();
786
- // Extract output preview
787
- const res = result;
788
- let outputPreview = res.text || "";
789
- if (!outputPreview && res.content) {
790
- if (typeof res.content === "string") {
791
- outputPreview = res.content;
792
- }
793
- else if (Array.isArray(res.content)) {
794
- outputPreview = res.content
795
- .map((c) => c.text ||
796
- (c.type === "tool-call"
797
- ? `tool call: ${c.toolName}()`
798
- : `[${c.type}]`))
799
- .join(" ");
800
- }
801
- }
802
- if (!outputPreview && res.toolCalls?.length) {
803
- outputPreview = `[${res.toolCalls.length} tool calls]`;
804
- }
805
- SessionFileLogger.logLlmResponse({
806
- requestId: llmRequestId,
807
- model: modelId,
808
- operation: "generateText",
809
- output: outputPreview || "[empty]",
810
- inputTokens: result.usage?.inputTokens,
811
- outputTokens: result.usage?.outputTokens,
812
- }, ctx);
813
- return result;
814
- },
815
- };
816
- }
817
- }
818
- /**
819
- * Method decorator for logging understudy actions with automatic start/complete.
820
- * Logs all arguments automatically. No-op when CONFIG_DIR is empty.
821
- */
822
- export function logAction(actionType) {
823
- return function (originalMethod) {
824
- // No-op when logging is disabled
825
- if (!CONFIG_DIR) {
826
- return originalMethod;
827
- }
828
- return async function (...args) {
829
- SessionFileLogger.logUnderstudyActionEvent({
830
- actionType,
831
- args: args.length > 0 ? args : undefined,
832
- });
833
- try {
834
- return await originalMethod.apply(this, args);
835
- }
836
- finally {
837
- SessionFileLogger.logUnderstudyActionCompleted();
838
- }
839
- };
840
- };
841
- }
842
- /**
843
- * Method decorator for logging Stagehand step events (act, extract, observe).
844
- * Only adds logging - does NOT wrap with withInstanceLogContext (caller handles that).
845
- * No-op when CONFIG_DIR is empty.
846
- */
847
- export function logStagehandStep(invocation, label) {
848
- return function (originalMethod) {
849
- // No-op when logging is disabled
850
- if (!CONFIG_DIR) {
851
- return originalMethod;
852
- }
853
- return async function (...args) {
854
- SessionFileLogger.logStagehandStepEvent({
855
- invocation,
856
- args: args.length > 0 ? args : undefined,
857
- label,
858
- });
859
- try {
860
- return await originalMethod.apply(this, args);
861
- }
862
- finally {
863
- SessionFileLogger.logStagehandStepCompleted();
864
- }
865
- };
866
- };
867
- }
868
- //# sourceMappingURL=flowLogger.js.map