Sync public snapshot from freebuff-private

Source: CodebuffAI/freebuff-private@3383374160cf4a5b7da54f12960f67b4e62e800b

Author: github-actions[bot]

cli/src/utils/__tests__/open-file.test.ts

@@ -0,0 +1,73 @@
+import { existsSync, mkdtempSync, readFileSync, rmSync } from 'fs'
+import os from 'os'
+import path from 'path'
+
+import { afterEach, beforeEach, describe, expect, test } from 'bun:test'
+
+import { openFileAtPath } from '../open-file'
+
+import type { CliEnv } from '../../types/env'
+
+// The editor command runs through `shell: true`; these use POSIX `sh`.
+describe.skipIf(process.platform === 'win32')('openFileAtPath placeholders', () => {
+  let dir: string
+
+  beforeEach(() => {
+    dir = mkdtempSync(path.join(os.tmpdir(), 'open-file-'))
+  })
+
+  afterEach(() => {
+    rmSync(dir, { recursive: true, force: true })
+  })
+
+  // A repo-controlled agent file name: shell metacharacters, a quote, and
+  // `$&` / `$'` (special in String.replace replacement strings).
+  const hostile = () =>
+    path.join(dir, `a b';touch ${path.join(dir, 'pwned')};echo '$&$'c`)
+
+  const run = async (editor: string, filePath: string) => {
+    const out = path.join(dir, 'out')
+    const env = {
+      CODEBUFF_EDITOR: editor.replace('OUT', out),
+    } as unknown as CliEnv
+    const ok = await openFileAtPath(filePath, env)
+    return { ok, out }
+  }
+
+  // Quoted forms too: a user's `code -g "%f"` must not hand the editor the
+  // already-quoted path wrapped in a second pair of quotes.
+  test.each(['%f', '{file}', '"%f"', "'%f'", '"{file}"'])(
+    '%s passes the path as one literal argument and runs nothing else',
+    async (placeholder) => {
+      const filePath = hostile()
+      const { ok, out } = await run(
+        `sh -c 'printf %s "$1" > OUT' _ ${placeholder}`,
+        filePath,
+      )
+
+      expect(ok).toBe(true)
+      expect(readFileSync(out, 'utf8')).toBe(filePath)
+      expect(existsSync(path.join(dir, 'pwned'))).toBe(false)
+    },
+  )
+
+  test('a command separator in the file name does not run a second command', async () => {
+    const filePath = path.join(dir, `a;touch ${path.join(dir, 'pwned')}`)
+    const { ok } = await run(`true %f`, filePath)
+
+    expect(ok).toBe(true)
+    expect(existsSync(path.join(dir, 'pwned'))).toBe(false)
+  })
+
+  test('an editor without a placeholder still gets the quoted path appended', async () => {
+    const filePath = hostile()
+    const { ok, out } = await run(
+      `sh -c 'printf %s "$1" > OUT' _`,
+      filePath,
+    )
+
+    expect(ok).toBe(true)
+    expect(readFileSync(out, 'utf8')).toBe(filePath)
+    expect(existsSync(path.join(dir, 'pwned'))).toBe(false)
+  })
+})

cli/src/utils/open-file.ts

@@ -15,23 +15,23 @@ const escapeForShell = (value: string): string =>
 const escapeForCmd = (value: string): string =>
   `"${value.replace(/"/g, '""')}"`
 
-const replaceFilePlaceholder = (command: string, filePath: string): string => {
-  if (command.includes('%f')) {
-    return command.replace(/%f/g, filePath)
-  }
-  if (command.includes('{file}')) {
-    return command.replace(/{file}/g, filePath)
-  }
-  return command
-}
+// `%f` or `{file}`, with any matching quotes a user put around it (`"%f"`):
+// the substituted path is already quoted, and quoting it twice would hand the
+// editor a path with literal quote marks in it.
+const FILE_PLACEHOLDER = /(["']?)(%f|\{file\})\1/g
+
+// filePath must already be shell-quoted: the command runs with `shell: true`, and
+// the path can come from a repo (agent file names). The function replacer keeps
+// `$&` / `$'` in a file name from being read as replacement patterns.
+const replaceFilePlaceholder = (command: string, filePath: string): string =>
+  command.replace(FILE_PLACEHOLDER, () => filePath)
 
 const buildEditorCommands = (
   filePath: string,
   env: CliEnv = getCliEnv(),
 ): string[] => {
   const commands: string[] = []
   const shellPath = isWindows ? escapeForCmd(filePath) : escapeForShell(filePath)
-  const rawPath = filePath
 
   // Check custom editor env vars
   const editorValues = [
@@ -43,11 +43,11 @@ const buildEditorCommands = (
 
   for (const value of editorValues) {
     if (!value) continue
-    const withFile = replaceFilePlaceholder(value, rawPath)
+    const withFile = replaceFilePlaceholder(value, shellPath)
     if (withFile !== value) {
       commands.push(withFile)
     } else {
-      commands.push(`${value} ${isWindows ? shellPath : shellPath}`)
+      commands.push(`${value} ${shellPath}`)
     }
   }