aboutsummaryrefslogtreecommitdiff
path: root/src/domains/network.ts
blob: aeb1aa62907ad901ca7fcc8883f7f09a7f6df101 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
import { Type } from "typebox";
import { Markdown, Text } from "@mariozechner/pi-tui";
import { getMarkdownTheme, keyHint } from "@mariozechner/pi-coding-agent";
import { type Result, err, ok } from "../util/result";
import { formatBytes } from "../util/bytes";
import { defineBrowserTool, type ToolErr, type ToolOk } from "../util/tool";
import { cdpCall } from "./cdp-call";
import { applyTruncation } from "../util/truncate";
import { asArrayOf, asBoolean, asNumber, asRecord, asString } from "../util/guards";
import type { NetworkRecord } from "../cdp/network-buffer";

const HttpGetArgs = Type.Object({
  url: Type.String({ description: "URL to GET" }),
  headers: Type.Optional(Type.Record(Type.String(), Type.String(), { description: "Optional HTTP headers" })),
  timeout: Type.Optional(
    Type.Number({ default: 20, minimum: 1, maximum: 120, description: "Total seconds (covers headers AND body)" }),
  ),
});

export const httpGetTool = defineBrowserTool({
  name: "browser_http_get",
  label: "Browser HTTP GET",
  description:
    "Fetch a URL outside the browser (faster than browser_navigate for APIs and static pages). Timeout covers headers AND body read.",
  promptSnippet: "HTTP GET (outside browser; for APIs/static pages)",
  promptGuidelines: [
    "Faster than navigate+execute_js for JSON/HTML APIs.",
    "No JS rendering — for SPAs use browser_navigate.",
  ],
  parameters: HttpGetArgs,
  concurrency: "parallel",
  ensureAlive: false,
  async handler(args): Promise<Result<ToolOk, ToolErr>> {
    const ac = new AbortController();
    const timer = setTimeout(() => ac.abort(), (args.timeout ?? 20) * 1000);
    try {
      const fetchInit: RequestInit = { signal: ac.signal };
      if (args.headers !== undefined) fetchInit.headers = args.headers;
      const res = await fetch(args.url, fetchInit);
      const body = await res.text();
      clearTimeout(timer);
      const ct = res.headers.get("content-type") ?? "";
      const truncated = await applyTruncation(body, "http");
      return ok({
        text: `HTTP ${res.status} ${ct}\n${truncated.text}`,
        details: truncated.fullOutputPath !== undefined
          ? { status: res.status, contentType: ct, length: body.length, fullOutputPath: truncated.fullOutputPath, wasTruncated: truncated.wasTruncated }
          : { status: res.status, contentType: ct, length: body.length, wasTruncated: truncated.wasTruncated },
      });
    } catch (e) {
      clearTimeout(timer);
      const msg = e instanceof Error ? e.message : String(e);
      const kind: ToolErr["kind"] = msg.toLowerCase().includes("abort") ? "timeout" : "io_error";
      return err({ kind, message: msg });
    }
  },
});

const NetworkRequestsArgs = Type.Object({
  urlPattern: Type.Optional(
    Type.String({ description: "Substring match by default. Wrap in slashes (e.g. /api\\\\.example/) for regex." }),
  ),
  methodFilter: Type.Optional(
    Type.Array(Type.String(), { description: 'HTTP methods to include, e.g. ["GET","POST"].' }),
  ),
  statusFilter: Type.Optional(
    Type.Object(
      {
        min: Type.Optional(Type.Integer({ minimum: 100, maximum: 599 })),
        max: Type.Optional(Type.Integer({ minimum: 100, maximum: 599 })),
      },
      { description: "Inclusive HTTP status range." },
    ),
  ),
  resourceTypes: Type.Optional(
    Type.Array(Type.String(), { description: 'CDP resource types: "Document","Stylesheet","Image","Media","Font","Script","TextTrack","XHR","Fetch","EventSource","WebSocket","Manifest","SignedExchange","Ping","CSPViolationReport","Preflight","Other".' }),
  ),
  sinceMs: Type.Optional(
    Type.Integer({ minimum: 0, description: "Only requests started in the last N ms." }),
  ),
  limit: Type.Optional(
    Type.Integer({ default: 50, minimum: 1, maximum: 500, description: "Max records to return." }),
  ),
  includeResponseBodies: Type.Optional(
    Type.Boolean({ default: false, description: "Fetch response bodies via Network.getResponseBody. Costs one CDP call per matched request." }),
  ),
});

const BODY_BUDGET_MS = 5_000;
const PER_BODY_CAP = 50_000;

const renderNetworkMarkdown = (
  records: ReadonlyArray<NetworkRecord>,
  opts: { includeBodies: boolean; total: number; bufferOverflowed: boolean; expanded: boolean },
): string => {
  if (records.length === 0) {
    if (opts.bufferOverflowed) return "_No matching requests. (Buffer overflowed since last drain — some events were dropped.)_";
    return "_No matching requests captured yet._";
  }

  const failed = records.filter((r) => r.failed || (r.status !== undefined && r.status >= 500)).length;
  const totalBytes = records.reduce((s, r) => s + (r.responseBodySize ?? 0), 0);
  const showWindow = (() => {
    const finished = records.filter((r) => r.durationMs !== undefined);
    if (finished.length === 0) return "";
    const span = Math.max(...records.map((r) => r.requestStartedMs)) - Math.min(...records.map((r) => r.requestStartedMs));
    return ` · ${(span / 1000).toFixed(1)}s window`;
  })();

  const headerLines: string[] = [
    `**${records.length} requests** · ${failed} failed · ${formatBytes(totalBytes)}${showWindow}`,
  ];
  if (opts.bufferOverflowed) headerLines.push("⚠ buffer overflowed since last drain — older events dropped");
  if (opts.total > records.length) headerLines.push(`(${records.length} of ${opts.total} matches shown — increase \`limit\` for more)`);

  const compactRows = (records.length > 5 && !opts.expanded ? records.slice(0, 5) : records).map((r) => {
    const status = r.failed ? "ERR" : r.status !== undefined ? String(r.status) : "—";
    const warn = r.failed || (r.status !== undefined && r.status >= 500) ? " ⚠" : "";
    const ms = r.durationMs !== undefined ? `${r.durationMs} ms` : "—";
    const url = r.url.length > 60 ? r.url.slice(0, 57) + "…" : r.url;
    return `\`${r.method.padEnd(4)} ${status.padStart(3)}\`  ${url}  _${ms}_${warn}`;
  });

  const rows = compactRows.join("\n");

  if (!opts.expanded) {
    const more = records.length > 5 ? `\n  … ${records.length - 5} more` : "";
    return `${headerLines.join("\n")}\n\n${rows}${more}`;
  }

  const tableHeader = `| # | Method | Status | URL | Type | ms |\n|---|---|---|---|---|---|`;
  const tableRows = records
    .map((r, i) => {
      const status = r.failed ? "ERR" : r.status !== undefined ? String(r.status) : "—";
      const ms = r.durationMs !== undefined ? String(r.durationMs) : "—";
      const url = r.url.length > 80 ? r.url.slice(0, 77) + "…" : r.url;
      return `| ${i + 1} | ${r.method} | ${status} | \`${url}\` | ${r.type} | ${ms} |`;
    })
    .join("\n");

  let bodySections = "";
  if (opts.includeBodies) {
    const sections: string[] = [];
    records.forEach((r, i) => {
      if (r.body === undefined) return;
      const sizes = `${r.requestBodySize} B → ${r.responseBodySize ?? 0} B`;
      const status = r.failed ? "failed" : r.status ?? "?";
      const header = `── #${i + 1} ${r.method} ${r.url} (${status}, ${r.durationMs ?? "?"} ms, ${r.type}, ${sizes}) ──`;
      const bodyText = r.body === null ? "_(body unavailable — already GC'd by Chrome)_" : "```\n" + r.body + "\n```";
      sections.push(`${header}\n\n${bodyText}`);
    });
    if (sections.length > 0) bodySections = "\n\n" + sections.join("\n\n");
  }

  return [headerLines.join("\n"), "", tableHeader, tableRows, bodySections].filter((s) => s !== "").join("\n");
};

type NetworkDetails = {
  total: number;
  returned: number;
  bufferOverflowed: boolean;
  truncated: boolean;
  fullOutputPath?: string;
  requests: ReadonlyArray<NetworkRecord>;
  includeBodies: boolean;
};

const asNetworkRecord = (v: unknown): NetworkRecord | undefined => {
  const o = asRecord(v);
  if (o === undefined) return undefined;
  const method = asString(o["method"]);
  const url = asString(o["url"]);
  const type = asString(o["type"]);
  if (method === undefined || url === undefined || type === undefined) return undefined;
  const status = asNumber(o["status"]);
  const statusText = asString(o["statusText"]);
  const mimeType = asString(o["mimeType"]);
  const durationMs = asNumber(o["durationMs"]);
  const responseBodySize = asNumber(o["responseBodySize"]);
  const failed = asBoolean(o["failed"]);
  const errorText = asString(o["errorText"]);
  const bodyRaw = o["body"];
  const body = typeof bodyRaw === "string" || bodyRaw === null ? bodyRaw : undefined;
  return {
    requestId: asString(o["requestId"]) ?? "",
    method,
    url,
    type,
    requestStartedMs: asNumber(o["requestStartedMs"]) ?? 0,
    requestBodySize: asNumber(o["requestBodySize"]) ?? 0,
    ...(status !== undefined ? { status } : {}),
    ...(statusText !== undefined ? { statusText } : {}),
    ...(mimeType !== undefined ? { mimeType } : {}),
    ...(durationMs !== undefined ? { durationMs } : {}),
    ...(responseBodySize !== undefined ? { responseBodySize } : {}),
    ...(failed !== undefined ? { failed } : {}),
    ...(errorText !== undefined ? { errorText } : {}),
    ...(body !== undefined ? { body } : {}),
  };
};

const asNetworkDetails = (v: unknown): NetworkDetails | undefined => {
  const o = asRecord(v);
  if (o === undefined) return undefined;
  const requests = asArrayOf(o["requests"], asNetworkRecord);
  if (requests === undefined) return undefined;
  const fullOutputPath = asString(o["fullOutputPath"]);
  return {
    total: asNumber(o["total"]) ?? requests.length,
    returned: asNumber(o["returned"]) ?? requests.length,
    bufferOverflowed: asBoolean(o["bufferOverflowed"]) ?? false,
    truncated: asBoolean(o["truncated"]) ?? false,
    requests,
    includeBodies: asBoolean(o["includeBodies"]) ?? false,
    ...(fullOutputPath !== undefined ? { fullOutputPath } : {}),
  };
};

export const networkRequestsTool = defineBrowserTool({
  name: "browser_network_requests",
  label: "Browser Network Requests",
  description:
    "List recent network requests captured on the current tab since attach. Filter by URL pattern, method, status, resource type, or recency. Optionally include response bodies.",
  promptSnippet: "Inspect recent network requests on the current page",
  promptGuidelines: [
    "Buffer is reset on tab switch — only requests on the current tab since attach are visible.",
    'urlPattern is a substring; wrap in slashes for regex (e.g. "/\\\\.json$/").',
    "includeResponseBodies:true costs an extra CDP call per matched request — use only when you need payloads.",
    "If bufferOverflowed:true in the result, older events were dropped (capacity 500 records/tab).",
  ],
  parameters: NetworkRequestsArgs,
  concurrency: "parallel",

  async handler(args, { client }): Promise<Result<ToolOk, ToolErr>> {
    const session = client.session();
    const drained = session.drainNetworkBuffer({
      ...(args.urlPattern !== undefined ? { urlPattern: args.urlPattern } : {}),
      ...(args.methodFilter !== undefined ? { methodFilter: args.methodFilter } : {}),
      ...(args.statusFilter !== undefined ? { statusFilter: args.statusFilter } : {}),
      ...(args.resourceTypes !== undefined ? { resourceTypes: args.resourceTypes } : {}),
      ...(args.sinceMs !== undefined ? { sinceMs: args.sinceMs } : {}),
      limit: args.limit ?? 50,
    });

    if (args.includeResponseBodies) {
      const ac = new AbortController();
      const timer = setTimeout(() => ac.abort(), BODY_BUDGET_MS);
      const fills = drained.records.map(async (r) => {
        if (ac.signal.aborted) return;
        const bodyRes = await cdpCall(client, "Network.getResponseBody", { requestId: r.requestId });
        if (!bodyRes.success) {
          r.body = null;
          return;
        }
        const b = bodyRes.data;
        let body = b.base64Encoded ? Buffer.from(b.body, "base64").toString("utf8") : b.body;
        if (body.length > PER_BODY_CAP) body = body.slice(0, PER_BODY_CAP) + "…";
        r.body = body;
      });
      await Promise.allSettled(fills);
      clearTimeout(timer);
    }

    const text = renderNetworkMarkdown(drained.records, {
      includeBodies: args.includeResponseBodies ?? false,
      total: drained.total,
      bufferOverflowed: drained.bufferOverflowed,
      expanded: true,
    });
    const trunc = await applyTruncation(text, "network");

    const details: NetworkDetails = {
      total: drained.total,
      returned: drained.records.length,
      bufferOverflowed: drained.bufferOverflowed,
      truncated: trunc.wasTruncated,
      requests: drained.records,
      includeBodies: args.includeResponseBodies ?? false,
    };
    if (trunc.fullOutputPath !== undefined) details.fullOutputPath = trunc.fullOutputPath;

    return ok({ text: trunc.text, details });
  },

  renderResult(result, expanded, theme) {
    const details = asNetworkDetails(result.details);
    if (!details) return new Text(theme.fg("error", "network: no details"), 0, 0);

    const md = renderNetworkMarkdown(details.requests, {
      includeBodies: details.includeBodies && expanded,
      total: details.total,
      bufferOverflowed: details.bufferOverflowed,
      expanded,
    });
    const tail = expanded
      ? `\n\n${keyHint("app.tools.expand", "to collapse")}${details.fullOutputPath ? ` · full payload at \`${details.fullOutputPath}\`` : ""}`
      : `\n\n${keyHint("app.tools.expand", "to expand")}`;

    return new Markdown(md + tail, 0, 0, getMarkdownTheme());
  },
});