orca/tests/e2e/diff-note-line-range.spec.ts

import type { Page } from '@stablyai/playwright-test'
import { expect, test } from './helpers/orca-app'
import { pressShortcut } from './helpers/shortcuts'
import { waitForActiveWorktree, waitForSessionReady } from './helpers/store'

/**
 * Selecting a range of diff lines for an AI note, through the real gutter
 * gesture rather than the store. What matters here and cannot be unit-tested:
 * the press is taken away from Monaco's own gutter selection, the band tracks
 * the pointer while the button is held, it stays lit under the open composer,
 * and a plain click still produces the single-line note it always did.
 */

const BAND = '.orca-diff-comment-range-highlight'
const COMPOSER = '.orca-diff-comment-popover'
const COMPOSER_LABEL = '.orca-diff-comment-popover-label'
const COMPOSER_TEXTAREA = '.orca-diff-comment-popover-textarea'

type StoredNote = { startLine?: number; lineNumber: number; body: string }

async function seedDiffFile(page: Page, worktreeId: string, relative: string): Promise<void> {
  await page.evaluate(
    async ({ wId, rel }) => {
      const store = window.__store
      if (!store) {
        throw new Error('window.__store is not available - is the app in dev mode?')
      }
      const state = store.getState()
      const worktree = Object.values(state.worktreesByRepo)
        .flat()
        .find((entry) => entry.id === wId)
      if (!worktree) {
        throw new Error('active worktree not found')
      }
      const separator = worktree.path.includes('\\') ? '\\' : '/'
      const lines = Array.from(
        { length: 24 },
        (_, index) => `export const line${String(index + 1).padStart(2, '0')} = ${index + 1}`
      )
      await window.api.fs.writeFile({
        filePath: `${worktree.path}${separator}${rel}`,
        content: `${lines.join('\n')}\n`
      })
      // Inline keeps the modified side's line numbers in its own margin, which is the
      // column the gesture is aimed at.
      await state.updateSettings({ diffDefaultView: 'inline' })
      state.openDiff(wId, `${worktree.path}${separator}${rel}`, rel, 'typescript', false)
    },
    { wId: worktreeId, rel: relative }
  )
  await expect(
    page.locator('.modified-in-monaco-diff-editor .margin .line-numbers').first(),
    'diff gutter never rendered'
  ).toBeVisible({ timeout: 20_000 })
}

// Centre of a line's number cell — the column the "+" lives in and the gesture starts from.
async function gutterPoint(page: Page, lineNumber: number): Promise<{ x: number; y: number }> {
  const point = await page.evaluate((lineNumber: number) => {
    const editor = document.querySelector('.monaco-editor.modified-in-monaco-diff-editor')
    if (!editor) {
      return null
    }
    for (const cell of editor.querySelectorAll('.margin .line-numbers')) {
      if (Number.parseInt(cell.textContent?.trim() ?? '', 10) === lineNumber) {
        const rect = cell.getBoundingClientRect()
        return { x: Math.round(rect.x + rect.width / 2), y: Math.round(rect.y + rect.height / 2) }
      }
    }
    return null
  }, lineNumber)
  if (!point) {
    throw new Error(`line ${lineNumber} is not rendered in the modified gutter`)
  }
  return point
}

// Box of the "+" affordance, which only exists while its line is hovered.
async function revealAddButton(
  page: Page,
  lineNumber: number
): Promise<{ x: number; y: number; top: string }> {
  const line = await gutterPoint(page, lineNumber)
  await page.mouse.move(line.x + 260, line.y)
  const button = page.locator('.orca-diff-comment-add-btn')
  await expect(button, 'the "+" never appeared on the hovered line').toBeVisible()
  const box = await button.boundingBox()
  if (!box) {
    throw new Error('the "+" has no box')
  }
  const top = await button.evaluate((node) => {
    if (!(node instanceof HTMLElement)) {
      throw new Error('the add button is not an HTMLElement')
    }
    return node.style.top
  })
  return {
    x: Math.round(box.x + box.width / 2),
    y: Math.round(box.y + box.height / 2),
    top
  }
}

async function readNotes(page: Page, worktreeId: string): Promise<StoredNote[]> {
  return page.evaluate((wId: string) => {
    const worktree = Object.values(window.__store?.getState().worktreesByRepo ?? {})
      .flat()
      .find((entry) => entry.id === wId)
    return (worktree?.diffComments ?? []).map((comment) => ({
      startLine: comment.startLine,
      lineNumber: comment.lineNumber,
      body: comment.body
    }))
  }, worktreeId)
}

async function submitNote(page: Page, body: string): Promise<void> {
  await page.locator(COMPOSER_TEXTAREA).fill(body)
  await page.keyboard.press('Enter')
  await expect(page.locator(COMPOSER), 'composer stayed open after submit').toHaveCount(0, {
    timeout: 10_000
  })
}

test.describe('Diff note line range', () => {
  test.beforeEach(async ({ orcaPage }) => {
    await waitForSessionReady(orcaPage)
    await waitForActiveWorktree(orcaPage)
  })

  test('dragging the gutter selects a range, keeps it lit, and saves one ranged note', async ({
    orcaPage
  }) => {
    const worktreeId = await waitForActiveWorktree(orcaPage)
    await seedDiffFile(orcaPage, worktreeId, 'src/diff-note-range-drag.ts')

    const from = await gutterPoint(orcaPage, 4)
    const to = await gutterPoint(orcaPage, 9)

    await orcaPage.mouse.move(from.x, from.y)
    await orcaPage.mouse.down()
    // Anchor alone is lit before the pointer travels.
    await expect(orcaPage.locator(BAND)).toHaveCount(1)

    await orcaPage.mouse.move(to.x, (from.y + to.y) / 2)
    await orcaPage.mouse.move(to.x, to.y)
    await expect(
      orcaPage.locator(BAND),
      'the band did not follow the pointer while the button was held'
    ).toHaveCount(6)

    await orcaPage.mouse.up()

    await expect(orcaPage.locator(COMPOSER_LABEL)).toHaveText('Lines 4-9')
    await expect(
      orcaPage.locator(BAND),
      'the band should stay lit while the note is being written'
    ).toHaveCount(6)
    // The gutter press belongs to us, so Monaco never started a text selection under it.
    expect(await orcaPage.evaluate(() => window.getSelection()?.toString() ?? '')).toBe('')

    await submitNote(orcaPage, 'Collapse these six lines into a loop.')

    expect(await readNotes(orcaPage, worktreeId)).toEqual([
      { startLine: 4, lineNumber: 9, body: 'Collapse these six lines into a loop.' }
    ])
    const card = orcaPage.locator('.orca-diff-comment-card').first()
    await expect(card, 'saved note card did not render').toBeVisible({ timeout: 15_000 })
    await expect(card).toContainText('lines 4-9')
    // The draft band belongs to the composer, so it clears with it.
    await expect(orcaPage.locator(BAND)).toHaveCount(0)
  })

  // Bottom-to-top: the anchor is the lower line, so the committed range only reads in document
  // order if the drag keeps anchor and focus apart instead of sorting them as it goes.
  test('dragging the gutter upward commits the same range as dragging down', async ({
    orcaPage
  }) => {
    const worktreeId = await waitForActiveWorktree(orcaPage)
    await seedDiffFile(orcaPage, worktreeId, 'src/diff-note-range-drag-up.ts')

    const from = await gutterPoint(orcaPage, 9)
    const to = await gutterPoint(orcaPage, 4)

    await orcaPage.mouse.move(from.x, from.y)
    await orcaPage.mouse.down()
    await expect(orcaPage.locator(BAND)).toHaveCount(1)

    await orcaPage.mouse.move(to.x, (from.y + to.y) / 2)
    await orcaPage.mouse.move(to.x, to.y)
    await expect(
      orcaPage.locator(BAND),
      'the band did not grow upward while the button was held'
    ).toHaveCount(6)

    await orcaPage.mouse.up()

    await expect(orcaPage.locator(COMPOSER_LABEL)).toHaveText('Lines 4-9')
    expect(await orcaPage.evaluate(() => window.getSelection()?.toString() ?? '')).toBe('')

    await submitNote(orcaPage, 'Dragged bottom to top.')

    expect(await readNotes(orcaPage, worktreeId)).toEqual([
      { startLine: 4, lineNumber: 9, body: 'Dragged bottom to top.' }
    ])
    await expect(orcaPage.locator('.orca-diff-comment-card').first()).toContainText('lines 4-9')
  })

  // The gesture that used to collapse to a single line: the press starts on the "+", a node
  // Monaco does not own, so hit-testing under the pointer resolved nothing for the whole drag.
  test('dragging from the "+" itself selects a range and the button rides the selection', async ({
    orcaPage
  }) => {
    const worktreeId = await waitForActiveWorktree(orcaPage)
    await seedDiffFile(orcaPage, worktreeId, 'src/diff-note-range-button-drag.ts')

    const button = await revealAddButton(orcaPage, 4)
    const to = await gutterPoint(orcaPage, 9)

    await orcaPage.mouse.move(button.x, button.y)
    await orcaPage.mouse.down()
    await orcaPage.mouse.move(button.x, (button.y + to.y) / 2)
    await orcaPage.mouse.move(button.x, to.y)

    await expect(
      orcaPage.locator(BAND),
      'the drag stalled because the pointer stayed over the "+"'
    ).toHaveCount(6)
    await expect
      .poll(
        async () =>
          orcaPage.locator('.orca-diff-comment-add-btn').evaluate((node) => {
            if (!(node instanceof HTMLElement)) {
              throw new Error('the add button is not an HTMLElement')
            }
            return node.style.top
          }),
        { message: 'the "+" did not ride the growing end of the selection' }
      )
      .not.toBe(button.top)

    await orcaPage.mouse.up()
    await expect(orcaPage.locator(COMPOSER_LABEL)).toHaveText('Lines 4-9')
    await submitNote(orcaPage, 'Dragged straight off the plus button.')

    expect(await readNotes(orcaPage, worktreeId)).toEqual([
      { startLine: 4, lineNumber: 9, body: 'Dragged straight off the plus button.' }
    ])
  })

  test('a press with no drag still saves the single-line note it always did', async ({
    orcaPage
  }) => {
    const worktreeId = await waitForActiveWorktree(orcaPage)
    await seedDiffFile(orcaPage, worktreeId, 'src/diff-note-range-click.ts')

    const point = await gutterPoint(orcaPage, 6)
    await orcaPage.mouse.move(point.x, point.y)
    await orcaPage.mouse.down()
    await orcaPage.mouse.up()

    await expect(orcaPage.locator(COMPOSER_LABEL)).toHaveText('Line 6')
    await expect(orcaPage.locator(BAND)).toHaveCount(1)

    await submitNote(orcaPage, 'Single line still works.')

    // startLine stays undefined: the stored shape is byte-identical to the pre-range one.
    expect(await readNotes(orcaPage, worktreeId)).toEqual([
      { startLine: undefined, lineNumber: 6, body: 'Single line still works.' }
    ])
    await expect(orcaPage.locator('.orca-diff-comment-card').first()).toContainText('line 6')
  })

  test('Escape abandons a drag without opening a composer', async ({ orcaPage }) => {
    const worktreeId = await waitForActiveWorktree(orcaPage)
    await seedDiffFile(orcaPage, worktreeId, 'src/diff-note-range-escape.ts')

    const from = await gutterPoint(orcaPage, 3)
    const to = await gutterPoint(orcaPage, 8)
    await orcaPage.mouse.move(from.x, from.y)
    await orcaPage.mouse.down()
    await orcaPage.mouse.move(to.x, to.y)
    await expect(orcaPage.locator(BAND)).toHaveCount(6)

    await orcaPage.keyboard.press('Escape')
    await expect(orcaPage.locator(BAND), 'Escape left the band behind').toHaveCount(0)

    await orcaPage.mouse.up()
    await expect(
      orcaPage.locator(COMPOSER),
      'a cancelled drag must not open a composer on release'
    ).toHaveCount(0)
    expect(await readNotes(orcaPage, worktreeId)).toEqual([])
  })

  test('the Add Review Note chord turns an editor selection into a ranged note', async ({
    orcaPage
  }) => {
    const worktreeId = await waitForActiveWorktree(orcaPage)
    await seedDiffFile(orcaPage, worktreeId, 'src/diff-note-range-chord.ts')

    // Click the code column, not the gutter: Monaco still owns that side.
    const line = await gutterPoint(orcaPage, 5)
    await orcaPage.mouse.click(line.x + 220, line.y)
    await orcaPage.keyboard.press('Shift+ArrowDown')
    await orcaPage.keyboard.press('Shift+ArrowDown')

    await pressShortcut(orcaPage, 'KeyA', { shift: true })

    await expect(orcaPage.locator(COMPOSER_LABEL)).toHaveText('Lines 5-7')
    await submitNote(orcaPage, 'Range from the keyboard.')

    expect(await readNotes(orcaPage, worktreeId)).toEqual([
      { startLine: 5, lineNumber: 7, body: 'Range from the keyboard.' }
    ])
  })
})