refactor(effect): move read tool onto defineEffect
Kit Langton
parent
288eb044cb
commit
62f1421120
|
|
@ -1,4 +1,5 @@
|
||||||
import z from "zod"
|
import z from "zod"
|
||||||
|
import { Effect } from "effect"
|
||||||
import { createReadStream } from "fs"
|
import { createReadStream } from "fs"
|
||||||
import * as fs from "fs/promises"
|
import * as fs from "fs/promises"
|
||||||
import * as path from "path"
|
import * as path from "path"
|
||||||
|
|
@ -18,222 +19,227 @@ const MAX_LINE_SUFFIX = `... (line truncated to ${MAX_LINE_LENGTH} chars)`
|
||||||
const MAX_BYTES = 50 * 1024
|
const MAX_BYTES = 50 * 1024
|
||||||
const MAX_BYTES_LABEL = `${MAX_BYTES / 1024} KB`
|
const MAX_BYTES_LABEL = `${MAX_BYTES / 1024} KB`
|
||||||
|
|
||||||
export const ReadTool = Tool.define("read", {
|
const parameters = z.object({
|
||||||
description: DESCRIPTION,
|
filePath: z.string().describe("The absolute path to the file or directory to read"),
|
||||||
parameters: z.object({
|
offset: z.coerce.number().describe("The line number to start reading from (1-indexed)").optional(),
|
||||||
filePath: z.string().describe("The absolute path to the file or directory to read"),
|
limit: z.coerce.number().describe("The maximum number of lines to read (defaults to 2000)").optional(),
|
||||||
offset: z.coerce.number().describe("The line number to start reading from (1-indexed)").optional(),
|
})
|
||||||
limit: z.coerce.number().describe("The maximum number of lines to read (defaults to 2000)").optional(),
|
|
||||||
}),
|
|
||||||
async execute(params, ctx) {
|
|
||||||
if (params.offset !== undefined && params.offset < 1) {
|
|
||||||
throw new Error("offset must be greater than or equal to 1")
|
|
||||||
}
|
|
||||||
let filepath = params.filePath
|
|
||||||
if (!path.isAbsolute(filepath)) {
|
|
||||||
filepath = path.resolve(Instance.directory, filepath)
|
|
||||||
}
|
|
||||||
if (process.platform === "win32") {
|
|
||||||
filepath = Filesystem.normalizePath(filepath)
|
|
||||||
}
|
|
||||||
const title = path.relative(Instance.worktree, filepath)
|
|
||||||
|
|
||||||
const stat = Filesystem.stat(filepath)
|
export const ReadTool = Tool.defineEffect(
|
||||||
|
"read",
|
||||||
|
Effect.succeed({
|
||||||
|
description: DESCRIPTION,
|
||||||
|
parameters,
|
||||||
|
async execute(params: z.infer<typeof parameters>, ctx) {
|
||||||
|
if (params.offset !== undefined && params.offset < 1) {
|
||||||
|
throw new Error("offset must be greater than or equal to 1")
|
||||||
|
}
|
||||||
|
let filepath = params.filePath
|
||||||
|
if (!path.isAbsolute(filepath)) {
|
||||||
|
filepath = path.resolve(Instance.directory, filepath)
|
||||||
|
}
|
||||||
|
if (process.platform === "win32") {
|
||||||
|
filepath = Filesystem.normalizePath(filepath)
|
||||||
|
}
|
||||||
|
const title = path.relative(Instance.worktree, filepath)
|
||||||
|
|
||||||
await assertExternalDirectory(ctx, filepath, {
|
const stat = Filesystem.stat(filepath)
|
||||||
bypass: Boolean(ctx.extra?.["bypassCwdCheck"]),
|
|
||||||
kind: stat?.isDirectory() ? "directory" : "file",
|
|
||||||
})
|
|
||||||
|
|
||||||
await ctx.ask({
|
await assertExternalDirectory(ctx, filepath, {
|
||||||
permission: "read",
|
bypass: Boolean(ctx.extra?.["bypassCwdCheck"]),
|
||||||
patterns: [filepath],
|
kind: stat?.isDirectory() ? "directory" : "file",
|
||||||
always: ["*"],
|
})
|
||||||
metadata: {},
|
|
||||||
})
|
|
||||||
|
|
||||||
if (!stat) {
|
await ctx.ask({
|
||||||
const dir = path.dirname(filepath)
|
permission: "read",
|
||||||
const base = path.basename(filepath)
|
patterns: [filepath],
|
||||||
|
always: ["*"],
|
||||||
|
metadata: {},
|
||||||
|
})
|
||||||
|
|
||||||
const suggestions = await fs
|
if (!stat) {
|
||||||
.readdir(dir)
|
const dir = path.dirname(filepath)
|
||||||
.then((entries) =>
|
const base = path.basename(filepath)
|
||||||
entries
|
|
||||||
.filter(
|
|
||||||
(entry) =>
|
|
||||||
entry.toLowerCase().includes(base.toLowerCase()) || base.toLowerCase().includes(entry.toLowerCase()),
|
|
||||||
)
|
|
||||||
.map((entry) => path.join(dir, entry))
|
|
||||||
.slice(0, 3),
|
|
||||||
)
|
|
||||||
.catch(() => [])
|
|
||||||
|
|
||||||
if (suggestions.length > 0) {
|
const suggestions = await fs
|
||||||
throw new Error(`File not found: ${filepath}\n\nDid you mean one of these?\n${suggestions.join("\n")}`)
|
.readdir(dir)
|
||||||
|
.then((entries) =>
|
||||||
|
entries
|
||||||
|
.filter(
|
||||||
|
(entry) =>
|
||||||
|
entry.toLowerCase().includes(base.toLowerCase()) || base.toLowerCase().includes(entry.toLowerCase()),
|
||||||
|
)
|
||||||
|
.map((entry) => path.join(dir, entry))
|
||||||
|
.slice(0, 3),
|
||||||
|
)
|
||||||
|
.catch(() => [])
|
||||||
|
|
||||||
|
if (suggestions.length > 0) {
|
||||||
|
throw new Error(`File not found: ${filepath}\n\nDid you mean one of these?\n${suggestions.join("\n")}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new Error(`File not found: ${filepath}`)
|
||||||
}
|
}
|
||||||
|
|
||||||
throw new Error(`File not found: ${filepath}`)
|
if (stat.isDirectory()) {
|
||||||
}
|
const dirents = await fs.readdir(filepath, { withFileTypes: true })
|
||||||
|
const entries = await Promise.all(
|
||||||
|
dirents.map(async (dirent) => {
|
||||||
|
if (dirent.isDirectory()) return dirent.name + "/"
|
||||||
|
if (dirent.isSymbolicLink()) {
|
||||||
|
const target = await fs.stat(path.join(filepath, dirent.name)).catch(() => undefined)
|
||||||
|
if (target?.isDirectory()) return dirent.name + "/"
|
||||||
|
}
|
||||||
|
return dirent.name
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
entries.sort((a, b) => a.localeCompare(b))
|
||||||
|
|
||||||
if (stat.isDirectory()) {
|
const limit = params.limit ?? DEFAULT_READ_LIMIT
|
||||||
const dirents = await fs.readdir(filepath, { withFileTypes: true })
|
const offset = params.offset ?? 1
|
||||||
const entries = await Promise.all(
|
const start = offset - 1
|
||||||
dirents.map(async (dirent) => {
|
const sliced = entries.slice(start, start + limit)
|
||||||
if (dirent.isDirectory()) return dirent.name + "/"
|
const truncated = start + sliced.length < entries.length
|
||||||
if (dirent.isSymbolicLink()) {
|
|
||||||
const target = await fs.stat(path.join(filepath, dirent.name)).catch(() => undefined)
|
const output = [
|
||||||
if (target?.isDirectory()) return dirent.name + "/"
|
`<path>${filepath}</path>`,
|
||||||
}
|
`<type>directory</type>`,
|
||||||
return dirent.name
|
`<entries>`,
|
||||||
}),
|
sliced.join("\n"),
|
||||||
)
|
truncated
|
||||||
entries.sort((a, b) => a.localeCompare(b))
|
? `\n(Showing ${sliced.length} of ${entries.length} entries. Use 'offset' parameter to read beyond entry ${offset + sliced.length})`
|
||||||
|
: `\n(${entries.length} entries)`,
|
||||||
|
`</entries>`,
|
||||||
|
].join("\n")
|
||||||
|
|
||||||
|
return {
|
||||||
|
title,
|
||||||
|
output,
|
||||||
|
metadata: {
|
||||||
|
preview: sliced.slice(0, 20).join("\n"),
|
||||||
|
truncated,
|
||||||
|
loaded: [] as string[],
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const instructions = await Instruction.resolve(ctx.messages, filepath, ctx.messageID)
|
||||||
|
|
||||||
|
// Exclude SVG (XML-based) and vnd.fastbidsheet (.fbs extension, commonly FlatBuffers schema files)
|
||||||
|
const mime = Filesystem.mimeType(filepath)
|
||||||
|
const isImage = mime.startsWith("image/") && mime !== "image/svg+xml" && mime !== "image/vnd.fastbidsheet"
|
||||||
|
const isPdf = mime === "application/pdf"
|
||||||
|
if (isImage || isPdf) {
|
||||||
|
const msg = `${isImage ? "Image" : "PDF"} read successfully`
|
||||||
|
return {
|
||||||
|
title,
|
||||||
|
output: msg,
|
||||||
|
metadata: {
|
||||||
|
preview: msg,
|
||||||
|
truncated: false,
|
||||||
|
loaded: instructions.map((i) => i.filepath),
|
||||||
|
},
|
||||||
|
attachments: [
|
||||||
|
{
|
||||||
|
type: "file",
|
||||||
|
mime,
|
||||||
|
url: `data:${mime};base64,${Buffer.from(await Filesystem.readBytes(filepath)).toString("base64")}`,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const isBinary = await isBinaryFile(filepath, Number(stat.size))
|
||||||
|
if (isBinary) throw new Error(`Cannot read binary file: ${filepath}`)
|
||||||
|
|
||||||
|
const stream = createReadStream(filepath, { encoding: "utf8" })
|
||||||
|
const rl = createInterface({
|
||||||
|
input: stream,
|
||||||
|
// Note: we use the crlfDelay option to recognize all instances of CR LF
|
||||||
|
// ('\r\n') in file as a single line break.
|
||||||
|
crlfDelay: Infinity,
|
||||||
|
})
|
||||||
|
|
||||||
const limit = params.limit ?? DEFAULT_READ_LIMIT
|
const limit = params.limit ?? DEFAULT_READ_LIMIT
|
||||||
const offset = params.offset ?? 1
|
const offset = params.offset ?? 1
|
||||||
const start = offset - 1
|
const start = offset - 1
|
||||||
const sliced = entries.slice(start, start + limit)
|
const raw: string[] = []
|
||||||
const truncated = start + sliced.length < entries.length
|
let bytes = 0
|
||||||
|
let lines = 0
|
||||||
|
let truncatedByBytes = false
|
||||||
|
let hasMoreLines = false
|
||||||
|
try {
|
||||||
|
for await (const text of rl) {
|
||||||
|
lines += 1
|
||||||
|
if (lines <= start) continue
|
||||||
|
|
||||||
const output = [
|
if (raw.length >= limit) {
|
||||||
`<path>${filepath}</path>`,
|
hasMoreLines = true
|
||||||
`<type>directory</type>`,
|
continue
|
||||||
`<entries>`,
|
}
|
||||||
sliced.join("\n"),
|
|
||||||
truncated
|
const line = text.length > MAX_LINE_LENGTH ? text.substring(0, MAX_LINE_LENGTH) + MAX_LINE_SUFFIX : text
|
||||||
? `\n(Showing ${sliced.length} of ${entries.length} entries. Use 'offset' parameter to read beyond entry ${offset + sliced.length})`
|
const size = Buffer.byteLength(line, "utf-8") + (raw.length > 0 ? 1 : 0)
|
||||||
: `\n(${entries.length} entries)`,
|
if (bytes + size > MAX_BYTES) {
|
||||||
`</entries>`,
|
truncatedByBytes = true
|
||||||
].join("\n")
|
hasMoreLines = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
raw.push(line)
|
||||||
|
bytes += size
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
rl.close()
|
||||||
|
stream.destroy()
|
||||||
|
}
|
||||||
|
|
||||||
|
if (lines < offset && !(lines === 0 && offset === 1)) {
|
||||||
|
throw new Error(`Offset ${offset} is out of range for this file (${lines} lines)`)
|
||||||
|
}
|
||||||
|
|
||||||
|
const content = raw.map((line, index) => {
|
||||||
|
return `${index + offset}: ${line}`
|
||||||
|
})
|
||||||
|
const preview = raw.slice(0, 20).join("\n")
|
||||||
|
|
||||||
|
let output = [`<path>${filepath}</path>`, `<type>file</type>`, "<content>"].join("\n")
|
||||||
|
output += content.join("\n")
|
||||||
|
|
||||||
|
const totalLines = lines
|
||||||
|
const lastReadLine = offset + raw.length - 1
|
||||||
|
const nextOffset = lastReadLine + 1
|
||||||
|
const truncated = hasMoreLines || truncatedByBytes
|
||||||
|
|
||||||
|
if (truncatedByBytes) {
|
||||||
|
output += `\n\n(Output capped at ${MAX_BYTES_LABEL}. Showing lines ${offset}-${lastReadLine}. Use offset=${nextOffset} to continue.)`
|
||||||
|
} else if (hasMoreLines) {
|
||||||
|
output += `\n\n(Showing lines ${offset}-${lastReadLine} of ${totalLines}. Use offset=${nextOffset} to continue.)`
|
||||||
|
} else {
|
||||||
|
output += `\n\n(End of file - total ${totalLines} lines)`
|
||||||
|
}
|
||||||
|
output += "\n</content>"
|
||||||
|
|
||||||
|
// just warms the lsp client
|
||||||
|
await LSP.touchFile(filepath, false)
|
||||||
|
await FileTime.read(ctx.sessionID, filepath)
|
||||||
|
|
||||||
|
if (instructions.length > 0) {
|
||||||
|
output += `\n\n<system-reminder>\n${instructions.map((i) => i.content).join("\n\n")}\n</system-reminder>`
|
||||||
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
title,
|
title,
|
||||||
output,
|
output,
|
||||||
metadata: {
|
metadata: {
|
||||||
preview: sliced.slice(0, 20).join("\n"),
|
preview,
|
||||||
truncated,
|
truncated,
|
||||||
loaded: [] as string[],
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const instructions = await Instruction.resolve(ctx.messages, filepath, ctx.messageID)
|
|
||||||
|
|
||||||
// Exclude SVG (XML-based) and vnd.fastbidsheet (.fbs extension, commonly FlatBuffers schema files)
|
|
||||||
const mime = Filesystem.mimeType(filepath)
|
|
||||||
const isImage = mime.startsWith("image/") && mime !== "image/svg+xml" && mime !== "image/vnd.fastbidsheet"
|
|
||||||
const isPdf = mime === "application/pdf"
|
|
||||||
if (isImage || isPdf) {
|
|
||||||
const msg = `${isImage ? "Image" : "PDF"} read successfully`
|
|
||||||
return {
|
|
||||||
title,
|
|
||||||
output: msg,
|
|
||||||
metadata: {
|
|
||||||
preview: msg,
|
|
||||||
truncated: false,
|
|
||||||
loaded: instructions.map((i) => i.filepath),
|
loaded: instructions.map((i) => i.filepath),
|
||||||
},
|
},
|
||||||
attachments: [
|
|
||||||
{
|
|
||||||
type: "file",
|
|
||||||
mime,
|
|
||||||
url: `data:${mime};base64,${Buffer.from(await Filesystem.readBytes(filepath)).toString("base64")}`,
|
|
||||||
},
|
|
||||||
],
|
|
||||||
}
|
}
|
||||||
}
|
},
|
||||||
|
}),
|
||||||
const isBinary = await isBinaryFile(filepath, Number(stat.size))
|
)
|
||||||
if (isBinary) throw new Error(`Cannot read binary file: ${filepath}`)
|
|
||||||
|
|
||||||
const stream = createReadStream(filepath, { encoding: "utf8" })
|
|
||||||
const rl = createInterface({
|
|
||||||
input: stream,
|
|
||||||
// Note: we use the crlfDelay option to recognize all instances of CR LF
|
|
||||||
// ('\r\n') in file as a single line break.
|
|
||||||
crlfDelay: Infinity,
|
|
||||||
})
|
|
||||||
|
|
||||||
const limit = params.limit ?? DEFAULT_READ_LIMIT
|
|
||||||
const offset = params.offset ?? 1
|
|
||||||
const start = offset - 1
|
|
||||||
const raw: string[] = []
|
|
||||||
let bytes = 0
|
|
||||||
let lines = 0
|
|
||||||
let truncatedByBytes = false
|
|
||||||
let hasMoreLines = false
|
|
||||||
try {
|
|
||||||
for await (const text of rl) {
|
|
||||||
lines += 1
|
|
||||||
if (lines <= start) continue
|
|
||||||
|
|
||||||
if (raw.length >= limit) {
|
|
||||||
hasMoreLines = true
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
const line = text.length > MAX_LINE_LENGTH ? text.substring(0, MAX_LINE_LENGTH) + MAX_LINE_SUFFIX : text
|
|
||||||
const size = Buffer.byteLength(line, "utf-8") + (raw.length > 0 ? 1 : 0)
|
|
||||||
if (bytes + size > MAX_BYTES) {
|
|
||||||
truncatedByBytes = true
|
|
||||||
hasMoreLines = true
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
raw.push(line)
|
|
||||||
bytes += size
|
|
||||||
}
|
|
||||||
} finally {
|
|
||||||
rl.close()
|
|
||||||
stream.destroy()
|
|
||||||
}
|
|
||||||
|
|
||||||
if (lines < offset && !(lines === 0 && offset === 1)) {
|
|
||||||
throw new Error(`Offset ${offset} is out of range for this file (${lines} lines)`)
|
|
||||||
}
|
|
||||||
|
|
||||||
const content = raw.map((line, index) => {
|
|
||||||
return `${index + offset}: ${line}`
|
|
||||||
})
|
|
||||||
const preview = raw.slice(0, 20).join("\n")
|
|
||||||
|
|
||||||
let output = [`<path>${filepath}</path>`, `<type>file</type>`, "<content>"].join("\n")
|
|
||||||
output += content.join("\n")
|
|
||||||
|
|
||||||
const totalLines = lines
|
|
||||||
const lastReadLine = offset + raw.length - 1
|
|
||||||
const nextOffset = lastReadLine + 1
|
|
||||||
const truncated = hasMoreLines || truncatedByBytes
|
|
||||||
|
|
||||||
if (truncatedByBytes) {
|
|
||||||
output += `\n\n(Output capped at ${MAX_BYTES_LABEL}. Showing lines ${offset}-${lastReadLine}. Use offset=${nextOffset} to continue.)`
|
|
||||||
} else if (hasMoreLines) {
|
|
||||||
output += `\n\n(Showing lines ${offset}-${lastReadLine} of ${totalLines}. Use offset=${nextOffset} to continue.)`
|
|
||||||
} else {
|
|
||||||
output += `\n\n(End of file - total ${totalLines} lines)`
|
|
||||||
}
|
|
||||||
output += "\n</content>"
|
|
||||||
|
|
||||||
// just warms the lsp client
|
|
||||||
LSP.touchFile(filepath, false)
|
|
||||||
await FileTime.read(ctx.sessionID, filepath)
|
|
||||||
|
|
||||||
if (instructions.length > 0) {
|
|
||||||
output += `\n\n<system-reminder>\n${instructions.map((i) => i.content).join("\n\n")}\n</system-reminder>`
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
title,
|
|
||||||
output,
|
|
||||||
metadata: {
|
|
||||||
preview,
|
|
||||||
truncated,
|
|
||||||
loaded: instructions.map((i) => i.filepath),
|
|
||||||
},
|
|
||||||
}
|
|
||||||
},
|
|
||||||
})
|
|
||||||
|
|
||||||
async function isBinaryFile(filepath: string, fileSize: number): Promise<boolean> {
|
async function isBinaryFile(filepath: string, fileSize: number): Promise<boolean> {
|
||||||
const ext = path.extname(filepath).toLowerCase()
|
const ext = path.extname(filepath).toLowerCase()
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,9 @@
|
||||||
import { afterEach, describe, expect, test } from "bun:test"
|
import { afterEach, describe, expect, test } from "bun:test"
|
||||||
|
import { Effect } from "effect"
|
||||||
import path from "path"
|
import path from "path"
|
||||||
import { ReadTool } from "../../src/tool/read"
|
|
||||||
import { Instance } from "../../src/project/instance"
|
import { Instance } from "../../src/project/instance"
|
||||||
|
import { ReadTool as ReadToolFx } from "../../src/tool/read"
|
||||||
|
import { Tool } from "../../src/tool/tool"
|
||||||
import { Filesystem } from "../../src/util/filesystem"
|
import { Filesystem } from "../../src/util/filesystem"
|
||||||
import { tmpdir } from "../fixture/fixture"
|
import { tmpdir } from "../fixture/fixture"
|
||||||
import { Permission } from "../../src/permission"
|
import { Permission } from "../../src/permission"
|
||||||
|
|
@ -25,6 +27,18 @@ const ctx = {
|
||||||
ask: async () => {},
|
ask: async () => {},
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const ReadTool = {
|
||||||
|
init: async () => ({
|
||||||
|
execute: (args: Tool.InferParameters<typeof ReadToolFx>, ctx: Tool.Context) =>
|
||||||
|
Effect.runPromise(
|
||||||
|
ReadToolFx.pipe(
|
||||||
|
Effect.flatMap((tool) => Effect.promise(() => tool.init())),
|
||||||
|
Effect.flatMap((tool) => Effect.promise(() => tool.execute(args, ctx))),
|
||||||
|
),
|
||||||
|
),
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
|
||||||
const full = (p: string) => (process.platform === "win32" ? Filesystem.normalizePath(p) : p)
|
const full = (p: string) => (process.platform === "win32" ? Filesystem.normalizePath(p) : p)
|
||||||
const glob = (p: string) =>
|
const glob = (p: string) =>
|
||||||
process.platform === "win32" ? Filesystem.normalizePathPattern(p) : p.replaceAll("\\", "/")
|
process.platform === "win32" ? Filesystem.normalizePathPattern(p) : p.replaceAll("\\", "/")
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue