opencode/packages/opencode/test/tool/edit.test.ts

import { afterAll, afterEach, describe, test, expect } from "bun:test"
import path from "path"
import fs from "fs/promises"
import { Effect, Layer, ManagedRuntime } from "effect"
import { EditTool } from "../../src/tool/edit"
import { Instance } from "../../src/project/instance"
import { WithInstance } from "../../src/project/with-instance"
import { disposeAllInstances, tmpdir } from "../fixture/fixture"
import { LSP } from "@/lsp/lsp"
import { AppFileSystem } from "@opencode-ai/core/filesystem"
import { Format } from "../../src/format"
import { Agent } from "../../src/agent/agent"
import { Bus } from "../../src/bus"
import { BusEvent } from "../../src/bus/bus-event"
import { Truncate } from "@/tool/truncate"
import { SessionID, MessageID } from "../../src/session/schema"

const ctx = {
  sessionID: SessionID.make("ses_test-edit-session"),
  messageID: MessageID.make(""),
  callID: "",
  agent: "build",
  abort: AbortSignal.any([]),
  messages: [],
  metadata: () => Effect.void,
  ask: () => Effect.void,
}

afterEach(async () => {
  await disposeAllInstances()
})

const runtime = ManagedRuntime.make(
  Layer.mergeAll(
    LSP.defaultLayer,
    AppFileSystem.defaultLayer,
    Format.defaultLayer,
    Bus.layer,
    Truncate.defaultLayer,
    Agent.defaultLayer,
  ),
)

afterAll(async () => {
  await runtime.dispose()
})

const resolve = () =>
  runtime.runPromise(
    Effect.gen(function* () {
      const info = yield* EditTool
      return yield* info.init()
    }),
  )

const subscribeBus = <D extends BusEvent.Definition>(def: D, callback: () => unknown) =>
  runtime.runPromise(Bus.Service.use((bus) => bus.subscribeCallback(def, callback)))

async function onceBus<D extends BusEvent.Definition>(def: D) {
  const result = Promise.withResolvers<void>()
  const unsub = await subscribeBus(def, () => {
    unsub()
    result.resolve()
  })
  return {
    wait: result.promise,
    unsub,
  }
}

describe("tool.edit", () => {
  describe("creating new files", () => {
    test("creates new file when oldString is empty", async () => {
      await using tmp = await tmpdir()
      const filepath = path.join(tmp.path, "newfile.txt")

      await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const edit = await resolve()
          const result = await Effect.runPromise(
            edit.execute(
              {
                filePath: filepath,
                oldString: "",
                newString: "new content",
              },
              ctx,
            ),
          )

          expect(result.metadata.diff).toContain("new content")

          const content = await fs.readFile(filepath, "utf-8")
          expect(content).toBe("new content")
        },
      })
    })

    test("preserves BOM when oldString is empty on existing files", async () => {
      await using tmp = await tmpdir()
      const filepath = path.join(tmp.path, "existing.cs")
      const bom = String.fromCharCode(0xfeff)
      await fs.writeFile(filepath, `${bom}using System;\n`, "utf-8")

      await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const edit = await resolve()
          const result = await Effect.runPromise(
            edit.execute(
              {
                filePath: filepath,
                oldString: "",
                newString: "using Up;\n",
              },
              ctx,
            ),
          )

          expect(result.metadata.diff).toContain("-using System;")
          expect(result.metadata.diff).toContain("+using Up;")

          const content = await fs.readFile(filepath, "utf-8")
          expect(content.charCodeAt(0)).toBe(0xfeff)
          expect(content.slice(1)).toBe("using Up;\n")
        },
      })
    })

    test("creates new file with nested directories", async () => {
      await using tmp = await tmpdir()
      const filepath = path.join(tmp.path, "nested", "dir", "file.txt")

      await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const edit = await resolve()
          await Effect.runPromise(
            edit.execute(
              {
                filePath: filepath,
                oldString: "",
                newString: "nested file",
              },
              ctx,
            ),
          )

          const content = await fs.readFile(filepath, "utf-8")
          expect(content).toBe("nested file")
        },
      })
    })

    test("emits add event for new files", async () => {
      await using tmp = await tmpdir()
      const filepath = path.join(tmp.path, "new.txt")

      await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const { FileWatcher } = await import("../../src/file/watcher")

          const updated = await onceBus(FileWatcher.Event.Updated)

          try {
            const edit = await resolve()
            await Effect.runPromise(
              edit.execute(
                {
                  filePath: filepath,
                  oldString: "",
                  newString: "content",
                },
                ctx,
              ),
            )

            await updated.wait
          } finally {
            updated.unsub()
          }
        },
      })
    })
  })

  describe("editing existing files", () => {
    test("replaces text in existing file", async () => {
      await using tmp = await tmpdir()
      const filepath = path.join(tmp.path, "existing.txt")
      await fs.writeFile(filepath, "old content here", "utf-8")

      await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const edit = await resolve()
          const result = await Effect.runPromise(
            edit.execute(
              {
                filePath: filepath,
                oldString: "old content",
                newString: "new content",
              },
              ctx,
            ),
          )

          expect(result.output).toContain("Edit applied successfully")

          const content = await fs.readFile(filepath, "utf-8")
          expect(content).toBe("new content here")
        },
      })
    })

    test("replaces the first visible line in BOM files", async () => {
      await using tmp = await tmpdir()
      const filepath = path.join(tmp.path, "existing.cs")
      const bom = String.fromCharCode(0xfeff)
      await fs.writeFile(filepath, `${bom}using System;\nclass Test {}\n`, "utf-8")

      await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const edit = await resolve()
          const result = await Effect.runPromise(
            edit.execute(
              {
                filePath: filepath,
                oldString: "using System;",
                newString: "using Up;",
              },
              ctx,
            ),
          )

          expect(result.metadata.diff).toContain("-using System;")
          expect(result.metadata.diff).toContain("+using Up;")
          expect(result.metadata.diff).not.toContain(bom)

          const content = await fs.readFile(filepath, "utf-8")
          expect(content.charCodeAt(0)).toBe(0xfeff)
          expect(content.slice(1)).toBe("using Up;\nclass Test {}\n")
        },
      })
    })

    test("throws error when file does not exist", async () => {
      await using tmp = await tmpdir()
      const filepath = path.join(tmp.path, "nonexistent.txt")

      await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const edit = await resolve()
          await expect(
            Effect.runPromise(
              edit.execute(
                {
                  filePath: filepath,
                  oldString: "old",
                  newString: "new",
                },
                ctx,
              ),
            ),
          ).rejects.toThrow("not found")
        },
      })
    })

    test("throws error when oldString equals newString", async () => {
      await using tmp = await tmpdir()
      const filepath = path.join(tmp.path, "file.txt")
      await fs.writeFile(filepath, "content", "utf-8")

      await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const edit = await resolve()
          await expect(
            Effect.runPromise(
              edit.execute(
                {
                  filePath: filepath,
                  oldString: "same",
                  newString: "same",
                },
                ctx,
              ),
            ),
          ).rejects.toThrow("identical")
        },
      })
    })

    test("throws error when oldString not found in file", async () => {
      await using tmp = await tmpdir()
      const filepath = path.join(tmp.path, "file.txt")
      await fs.writeFile(filepath, "actual content", "utf-8")

      await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const edit = await resolve()
          await expect(
            Effect.runPromise(
              edit.execute(
                {
                  filePath: filepath,
                  oldString: "not in file",
                  newString: "replacement",
                },
                ctx,
              ),
            ),
          ).rejects.toThrow()
        },
      })
    })

    test("replaces all occurrences with replaceAll option", async () => {
      await using tmp = await tmpdir()
      const filepath = path.join(tmp.path, "file.txt")
      await fs.writeFile(filepath, "foo bar foo baz foo", "utf-8")

      await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const edit = await resolve()
          await Effect.runPromise(
            edit.execute(
              {
                filePath: filepath,
                oldString: "foo",
                newString: "qux",
                replaceAll: true,
              },
              ctx,
            ),
          )

          const content = await fs.readFile(filepath, "utf-8")
          expect(content).toBe("qux bar qux baz qux")
        },
      })
    })

    test("emits change event for existing files", async () => {
      await using tmp = await tmpdir()
      const filepath = path.join(tmp.path, "file.txt")
      await fs.writeFile(filepath, "original", "utf-8")

      await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const { FileWatcher } = await import("../../src/file/watcher")

          const updated = await onceBus(FileWatcher.Event.Updated)

          try {
            const edit = await resolve()
            await Effect.runPromise(
              edit.execute(
                {
                  filePath: filepath,
                  oldString: "original",
                  newString: "modified",
                },
                ctx,
              ),
            )

            await updated.wait
          } finally {
            updated.unsub()
          }
        },
      })
    })
  })

  describe("edge cases", () => {
    test("handles multiline replacements", async () => {
      await using tmp = await tmpdir()
      const filepath = path.join(tmp.path, "file.txt")
      await fs.writeFile(filepath, "line1\nline2\nline3", "utf-8")

      await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const edit = await resolve()
          await Effect.runPromise(
            edit.execute(
              {
                filePath: filepath,
                oldString: "line2",
                newString: "new line 2\nextra line",
              },
              ctx,
            ),
          )

          const content = await fs.readFile(filepath, "utf-8")
          expect(content).toBe("line1\nnew line 2\nextra line\nline3")
        },
      })
    })

    test("handles CRLF line endings", async () => {
      await using tmp = await tmpdir()
      const filepath = path.join(tmp.path, "file.txt")
      await fs.writeFile(filepath, "line1\r\nold\r\nline3", "utf-8")

      await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const edit = await resolve()
          await Effect.runPromise(
            edit.execute(
              {
                filePath: filepath,
                oldString: "old",
                newString: "new",
              },
              ctx,
            ),
          )

          const content = await fs.readFile(filepath, "utf-8")
          expect(content).toBe("line1\r\nnew\r\nline3")
        },
      })
    })

    test("throws error when oldString equals newString", async () => {
      await using tmp = await tmpdir()
      const filepath = path.join(tmp.path, "file.txt")
      await fs.writeFile(filepath, "content", "utf-8")

      await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const edit = await resolve()
          await expect(
            Effect.runPromise(
              edit.execute(
                {
                  filePath: filepath,
                  oldString: "",
                  newString: "",
                },
                ctx,
              ),
            ),
          ).rejects.toThrow("identical")
        },
      })
    })

    test("throws error when path is directory", async () => {
      await using tmp = await tmpdir()
      const dirpath = path.join(tmp.path, "adir")
      await fs.mkdir(dirpath)

      await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const edit = await resolve()
          await expect(
            Effect.runPromise(
              edit.execute(
                {
                  filePath: dirpath,
                  oldString: "old",
                  newString: "new",
                },
                ctx,
              ),
            ),
          ).rejects.toThrow("directory")
        },
      })
    })

    test("tracks file diff statistics", async () => {
      await using tmp = await tmpdir()
      const filepath = path.join(tmp.path, "file.txt")
      await fs.writeFile(filepath, "line1\nline2\nline3", "utf-8")

      await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const edit = await resolve()
          const result = await Effect.runPromise(
            edit.execute(
              {
                filePath: filepath,
                oldString: "line2",
                newString: "new line a\nnew line b",
              },
              ctx,
            ),
          )

          expect(result.metadata.filediff).toBeDefined()
          expect(result.metadata.filediff.file).toBe(filepath)
          expect(result.metadata.filediff.additions).toBeGreaterThan(0)
        },
      })
    })
  })

  describe("line endings", () => {
    const old = "alpha\nbeta\ngamma"
    const next = "alpha\nbeta-updated\ngamma"
    const alt = "alpha\nbeta\nomega"

    const normalize = (text: string, ending: "\n" | "\r\n") => {
      const normalized = text.replaceAll("\r\n", "\n")
      if (ending === "\n") return normalized
      return normalized.replaceAll("\n", "\r\n")
    }

    const count = (content: string) => {
      const crlf = content.match(/\r\n/g)?.length ?? 0
      const lf = content.match(/\n/g)?.length ?? 0
      return {
        crlf,
        lf: lf - crlf,
      }
    }

    const expectLf = (content: string) => {
      const counts = count(content)
      expect(counts.crlf).toBe(0)
      expect(counts.lf).toBeGreaterThan(0)
    }

    const expectCrlf = (content: string) => {
      const counts = count(content)
      expect(counts.lf).toBe(0)
      expect(counts.crlf).toBeGreaterThan(0)
    }

    type Input = {
      content: string
      oldString: string
      newString: string
      replaceAll?: boolean
    }

    const apply = async (input: Input) => {
      await using tmp = await tmpdir({
        init: async (dir) => {
          await Bun.write(path.join(dir, "test.txt"), input.content)
        },
      })

      return await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const edit = await resolve()
          const filePath = path.join(tmp.path, "test.txt")
          await Effect.runPromise(
            edit.execute(
              {
                filePath,
                oldString: input.oldString,
                newString: input.newString,
                replaceAll: input.replaceAll,
              },
              ctx,
            ),
          )
          return await Bun.file(filePath).text()
        },
      })
    }

    test("preserves LF with LF multi-line strings", async () => {
      const content = normalize(old + "\n", "\n")
      const output = await apply({
        content,
        oldString: normalize(old, "\n"),
        newString: normalize(next, "\n"),
      })
      expect(output).toBe(normalize(next + "\n", "\n"))
      expectLf(output)
    })

    test("preserves CRLF with CRLF multi-line strings", async () => {
      const content = normalize(old + "\n", "\r\n")
      const output = await apply({
        content,
        oldString: normalize(old, "\r\n"),
        newString: normalize(next, "\r\n"),
      })
      expect(output).toBe(normalize(next + "\n", "\r\n"))
      expectCrlf(output)
    })

    test("preserves LF when old/new use CRLF", async () => {
      const content = normalize(old + "\n", "\n")
      const output = await apply({
        content,
        oldString: normalize(old, "\r\n"),
        newString: normalize(next, "\r\n"),
      })
      expect(output).toBe(normalize(next + "\n", "\n"))
      expectLf(output)
    })

    test("preserves CRLF when old/new use LF", async () => {
      const content = normalize(old + "\n", "\r\n")
      const output = await apply({
        content,
        oldString: normalize(old, "\n"),
        newString: normalize(next, "\n"),
      })
      expect(output).toBe(normalize(next + "\n", "\r\n"))
      expectCrlf(output)
    })

    test("preserves LF when newString uses CRLF", async () => {
      const content = normalize(old + "\n", "\n")
      const output = await apply({
        content,
        oldString: normalize(old, "\n"),
        newString: normalize(next, "\r\n"),
      })
      expect(output).toBe(normalize(next + "\n", "\n"))
      expectLf(output)
    })

    test("preserves CRLF when newString uses LF", async () => {
      const content = normalize(old + "\n", "\r\n")
      const output = await apply({
        content,
        oldString: normalize(old, "\r\n"),
        newString: normalize(next, "\n"),
      })
      expect(output).toBe(normalize(next + "\n", "\r\n"))
      expectCrlf(output)
    })

    test("preserves LF with mixed old/new line endings", async () => {
      const content = normalize(old + "\n", "\n")
      const output = await apply({
        content,
        oldString: "alpha\nbeta\r\ngamma",
        newString: "alpha\r\nbeta\nomega",
      })
      expect(output).toBe(normalize(alt + "\n", "\n"))
      expectLf(output)
    })

    test("preserves CRLF with mixed old/new line endings", async () => {
      const content = normalize(old + "\n", "\r\n")
      const output = await apply({
        content,
        oldString: "alpha\r\nbeta\ngamma",
        newString: "alpha\nbeta\r\nomega",
      })
      expect(output).toBe(normalize(alt + "\n", "\r\n"))
      expectCrlf(output)
    })

    test("replaceAll preserves LF for multi-line blocks", async () => {
      const blockOld = "alpha\nbeta"
      const blockNew = "alpha\nbeta-updated"
      const content = normalize(blockOld + "\n" + blockOld + "\n", "\n")
      const output = await apply({
        content,
        oldString: normalize(blockOld, "\n"),
        newString: normalize(blockNew, "\n"),
        replaceAll: true,
      })
      expect(output).toBe(normalize(blockNew + "\n" + blockNew + "\n", "\n"))
      expectLf(output)
    })

    test("replaceAll preserves CRLF for multi-line blocks", async () => {
      const blockOld = "alpha\nbeta"
      const blockNew = "alpha\nbeta-updated"
      const content = normalize(blockOld + "\n" + blockOld + "\n", "\r\n")
      const output = await apply({
        content,
        oldString: normalize(blockOld, "\r\n"),
        newString: normalize(blockNew, "\r\n"),
        replaceAll: true,
      })
      expect(output).toBe(normalize(blockNew + "\n" + blockNew + "\n", "\r\n"))
      expectCrlf(output)
    })
  })

  describe("concurrent editing", () => {
    test("preserves concurrent edits to different sections of the same file", async () => {
      await using tmp = await tmpdir()
      const filepath = path.join(tmp.path, "file.txt")
      await fs.writeFile(filepath, "top = 0\nmiddle = keep\nbottom = 0\n", "utf-8")

      await WithInstance.provide({
        directory: tmp.path,
        fn: async () => {
          const edit = await resolve()
          let asks = 0
          const firstAsk = Promise.withResolvers<void>()
          const delayedCtx = {
            ...ctx,
            ask: () =>
              Effect.gen(function* () {
                asks++
                if (asks !== 1) return
                firstAsk.resolve()
                yield* Effect.promise(() => Bun.sleep(50))
              }),
          }

          const promise1 = Effect.runPromise(
            edit.execute(
              {
                filePath: filepath,
                oldString: "top = 0",
                newString: "top = 1",
              },
              delayedCtx,
            ),
          )

          await firstAsk.promise

          const promise2 = Effect.runPromise(
            edit.execute(
              {
                filePath: filepath,
                oldString: "bottom = 0",
                newString: "bottom = 2",
              },
              delayedCtx,
            ),
          )

          const results = await Promise.allSettled([promise1, promise2])
          expect(results[0]?.status).toBe("fulfilled")
          expect(results[1]?.status).toBe("fulfilled")
          expect(await fs.readFile(filepath, "utf-8")).toBe("top = 1\nmiddle = keep\nbottom = 2\n")
        },
      })
    })
  })
})