Cover the compare and merge view in the chat input, skill files, prompt editor and terminal files

Browser tests for the side-by-side compare view: opening it from the chat input's More menu and the /compare command, Use in prompt filling the message without sending it, stepping through changes, copying a change to either side, identical texts showing no differences and Cancel asking before it discards. A revision applied in the skill file editor and the prompt editor is what gets saved, the skill file's Copy copies the open file, and two terminal files picked for comparison open side by side and swap.

Author: Classic298

e2e/chat/test_compare_text.py

@@ -0,0 +1,170 @@
+"""Journey: comparing a draft with a revision in the chat input's Compare text view.
+
+More > Compare text opens the side-by-side compare and merge view with the message being typed on
+the left as the original. Use in prompt puts the revision on the right into the message box and
+sends nothing until the person sends it. In the comparison the view counts the changes ("Change 1
+of 2") and steps through them with Previous change and Next change, copies the current change from
+the original to the proposed revision or back, and says "No differences" for two identical texts.
+Closing after an edit asks to discard the comparison first and leaves the message as it was;
+closing with nothing edited asks nothing. Opening the view from the `/compare` command is
+e2e/chat/test_slash_commands.py.
+
+Discriminates: passes on the dev 3b8205505 build (backend at 3b8205505, frontend of 226dca18c,
+which differs only in the chat input's selected-feature pills). In a build of it whose Use in prompt
+also sends the message the Use in prompt test fails, in one whose copy buttons copy the other way
+the copy test fails, in one whose Next change stays put the step-through test fails, in one that
+counts identical texts as one change the no-differences test fails, and in one whose Cancel closes
+without asking the discard test fails.
+"""
+
+from __future__ import annotations
+
+import re
+import uuid
+
+import pytest
+from playwright.sync_api import Locator, Page, expect
+
+from harness import upstream as reply
+from utils.chat_ui import chat_input, expect_reply, open_input_menu
+
+pytestmark = [pytest.mark.journey, pytest.mark.requires_browser, pytest.mark.requires_source]
+
+ORIGINAL = "alpha\nbravo\ncharlie\ndelta\necho\nfoxtrot\ngolf"
+REVISED = "alpha\nBRAVO\ncharlie\ndelta\necho\nFOXTROT\ngolf"
+
+
+def _type_draft(page: Page, text: str) -> None:
+    expect(chat_input(page)).to_be_visible()
+    chat_input(page).click()
+    page.keyboard.type(text)
+    expect(chat_input(page)).to_have_text(text)
+
+
+def _open_compare(page: Page) -> Locator:
+    open_input_menu(page).get_by_role("menuitem", name="Compare text").click()
+    compare = page.get_by_role("dialog", name="Compare text")
+    expect(compare).to_be_visible()
+    return compare
+
+
+def _pane(compare: Locator, label: str) -> Locator:
+    return compare.get_by_role("textbox", name=label, exact=True)
+
+
+def _write(compare: Locator, label: str, text: str) -> None:
+    _pane(compare, label).click()
+    compare.page.keyboard.insert_text(text)
+
+
+def _start_comparing(compare: Locator, original: str, revised: str) -> Locator:
+    """Write both sides, press Compare and return the change counter."""
+    _write(compare, "Original", original)
+    _write(compare, "Proposed revision", revised)
+    compare.get_by_role("button", name="Compare", exact=True).click()
+    return compare.get_by_role("status")
+
+
+def test_use_in_prompt_puts_the_revision_in_the_input_without_sending(
+    page_for, make_user, upstream
+):
+    page = page_for(make_user())
+    draft = f"Tell me about the tides {uuid.uuid4().hex[:6]}"
+    revised = f"{draft}, in one short sentence"
+    _type_draft(page, draft)
+    sent_before = len(upstream.chat_requests())
+
+    compare = _open_compare(page)
+    expect(_pane(compare, "Original")).to_have_text(draft)
+    _pane(compare, "Proposed revision").click()
+    page.keyboard.insert_text(revised)
+    compare.get_by_role("button", name="Use in prompt").click()
+
+    expect(compare).to_have_count(0)
+    expect(chat_input(page)).to_have_text(revised)
+    # a bounded look that nothing is sent on its own after the revision lands
+    page.wait_for_timeout(1000)
+    assert len(upstream.chat_requests()) == sent_before, "Use in prompt sent the message itself"
+    expect(page).not_to_have_url(re.compile(r"/c/"))
+
+    upstream.queue(reply.text("Noted.", match=reply.answering(revised)))
+    chat_input(page).press("Enter")
+    expect_reply(page, "Noted.")
+    [request] = [body for body in upstream.chat_requests() if reply.answering(revised)(body)]
+    assert request["messages"][-1]["content"] == revised
+
+
+def test_next_and_previous_change_step_through_the_changes(page_for, make_user):
+    page = page_for(make_user())
+    compare = _open_compare(page)
+    counter = _start_comparing(compare, ORIGINAL, REVISED)
+    previous = compare.get_by_role("button", name="Previous change")
+    following = compare.get_by_role("button", name="Next change")
+
+    expect(counter).to_have_text("Change 1 of 2")
+    expect(previous).to_be_disabled()
+    following.click()
+    expect(counter).to_have_text("Change 2 of 2")
+    expect(following).to_be_disabled()
+    previous.click()
+    expect(counter).to_have_text("Change 1 of 2")
+
+
+def test_a_change_is_copied_to_the_proposal_or_back_to_the_original(page_for, make_user):
+    page = page_for(make_user())
+    compare = _open_compare(page)
+    counter = _start_comparing(compare, ORIGINAL, REVISED)
+    expect(counter).to_have_text("Change 1 of 2")
+
+    compare.get_by_role("button", name="Copy change to proposal").click()
+    expect(counter).to_have_text("Change 1 of 1")
+    expect(_pane(compare, "Proposed revision")).to_contain_text("bravo")
+    expect(_pane(compare, "Proposed revision")).not_to_contain_text("BRAVO")
+
+    compare.get_by_role("button", name="Copy change to original").click()
+    expect(counter).to_have_text("No differences")
+    expect(_pane(compare, "Original")).to_contain_text("FOXTROT")
+    expect(_pane(compare, "Original")).not_to_contain_text("foxtrot")
+
+    compare.get_by_role("button", name="Use in prompt").click()
+    expect(compare).to_have_count(0)
+    expect(chat_input(page)).to_contain_text("bravo")
+    expect(chat_input(page)).to_contain_text("FOXTROT")
+
+
+def test_identical_texts_show_no_differences(page_for, make_user):
+    page = page_for(make_user())
+    same = "The harbour closes at dusk."
+    _type_draft(page, same)
+    compare = _open_compare(page)
+    _write(compare, "Proposed revision", same)
+    compare.get_by_role("button", name="Compare", exact=True).click()
+
+    expect(compare.get_by_role("status")).to_have_text("No differences")
+    expect(compare.get_by_role("button", name="Previous change")).to_be_disabled()
+    expect(compare.get_by_role("button", name="Next change")).to_be_disabled()
+    expect(compare.get_by_role("button", name="Copy change to proposal")).to_be_disabled()
+
+
+def test_closing_after_an_edit_asks_to_discard_and_keeps_the_message(page_for, make_user):
+    page = page_for(make_user())
+    draft = f"Keep this draft {uuid.uuid4().hex[:6]}"
+    _type_draft(page, draft)
+
+    compare = _open_compare(page)
+    compare.get_by_role("button", name="Cancel", exact=True).click()
+    expect(compare).to_have_count(0)
+
+    compare = _open_compare(page)
+    _write(compare, "Proposed revision", "Something else entirely")
+    compare.get_by_role("button", name="Cancel", exact=True).click()
+    confirm = page.get_by_role("dialog", name="Discard comparison changes?")
+    expect(confirm).to_contain_text("Your prompt will stay unchanged.")
+    confirm.get_by_role("button", name="Cancel").click()
+    expect(confirm).to_have_count(0)
+    expect(_pane(compare, "Proposed revision")).to_have_text("Something else entirely")
+
+    compare.get_by_role("button", name="Cancel", exact=True).click()
+    confirm.get_by_role("button", name="Discard").click()
+    expect(compare).to_have_count(0)
+    expect(chat_input(page)).to_have_text(draft)

e2e/chat/test_slash_commands.py

@@ -3,11 +3,13 @@
 Typing / lists the chat commands above the saved prompts. Fork copies the open conversation into
 a new chat that answers from it. `/model <id>` typed and sent switches the chat to that model, so
 the next message goes there, and an unknown id is refused and leaves the model alone. Model in the
-menu opens the model selector, Settings the settings dialog and Temporary turns a new chat
-temporary.
+menu opens the model selector, Settings the settings dialog, Compare text the compare view with an
+empty original once the typed `/compare` is taken out of the message, and Temporary turns a new
+chat temporary.
 
 Discriminates: passes on dev 30f3f6a8f; in a frontend build whose / menu commands and typed /model
-do nothing every test fails.
+do nothing every test fails. The Compare text test passes on the dev 3b8205505 build and fails in
+a build of it whose / menu leaves out Compare text.
 """
 
 from __future__ import annotations
@@ -126,6 +128,17 @@ def test_settings_in_the_menu_opens_the_settings(page_for, make_user):
     expect(page.get_by_role("dialog").get_by_role("tab", name="General")).to_be_visible()
 
 
+def test_compare_text_in_the_menu_opens_the_compare_view(page_for, make_user):
+    page = page_for(make_user())
+    menu = _command_menu(page, "compare")
+    menu.get_by_role("button", name="Compare text").click()
+
+    compare = page.get_by_role("dialog", name="Compare text")
+    expect(compare.get_by_role("textbox", name="Original", exact=True)).to_have_text("")
+    expect(compare.get_by_role("button", name="Use in prompt")).to_be_visible()
+    expect(chat_input(page)).to_have_text("")
+
+
 def test_temporary_in_the_menu_turns_the_new_chat_temporary(page_for, make_user, upstream):
     account = make_user()
     page = page_for(account)

e2e/tools/test_terminal_file_browser_actions.py

@@ -4,11 +4,14 @@
 from the input's Terminal menu and works in the File browser: New Folder and New File in its
 Actions menu make them in the terminal's home, Rename and Delete in a row's More menu rename the
 file or remove it after a confirm, and Show Hidden Files lists a dotfile the browser hides by
-default. Every change is read back from the terminal's disk.
+default. Every change is read back from the terminal's disk. Select for Compare on one file and
+Compare with Selected on another open both files side by side, read only, each under its name, and
+Swap sides puts the second file on the left.
 
 Discriminates: passes on dev 30f3f6a8f; on a build whose New Folder, New File, Rename and Delete
 handlers send nothing and whose hidden-files switch does not change the listing, every test here
-fails.
+fails. The compare test passes on the dev 3b8205505 build and fails in a build of it whose Swap
+sides leaves the files where they were.
 """
 
 from __future__ import annotations
@@ -113,3 +116,27 @@ def test_show_hidden_files_lists_a_dotfile(browser):
 
     _choose_action(browser, "Hide Hidden Files")
     expect(browser.get_by_text(".boat-secrets", exact=True)).to_have_count(0)
+
+
+def test_compare_with_selected_opens_both_files_and_swap_sides_swaps_them(browser):
+    _row_menu(browser, "draft-letter.txt").get_by_role("button", name="Select for Compare").click()
+    expect(browser.get_by_text("Comparing with draft-letter.txt")).to_be_visible()
+    _row_menu(browser, "old-receipt.txt").get_by_role(
+        "button", name="Compare with Selected"
+    ).click()
+
+    compare = _page(browser).get_by_role("dialog", name="Compare files")
+    panes = compare.get_by_role("textbox")
+    expect(panes).to_have_count(2)
+    expect(panes.first).to_have_accessible_name("draft-letter.txt")
+    expect(panes.first).to_have_text("Dear harbour master,")
+    expect(panes.last).to_have_accessible_name("old-receipt.txt")
+    expect(panes.last).to_have_text("two ropes, one lamp")
+    expect(panes.first).not_to_be_editable()
+    expect(compare.get_by_role("status")).to_have_text("Change 1 of 1")
+
+    compare.get_by_role("button", name="Swap sides").click()
+    expect(panes.first).to_have_accessible_name("old-receipt.txt")
+    expect(panes.first).to_have_text("two ropes, one lamp")
+    expect(panes.last).to_have_accessible_name("draft-letter.txt")
+    expect(panes.last).to_have_text("Dear harbour master,")

e2e/workspace/test_prompt_versions.py

@@ -8,8 +8,10 @@
 kept for the next comparison; a version that differs only in its line endings says so. Edit as new
 version makes the old text editable and saves it as a further version that is not production,
 leaving what the chat inserts unchanged. Switching versions with unsaved typing asks whether to
-discard it first, and so does leaving the editor. Ctrl+S saves the text. A user the prompt is
-shared with read only can pick and compare its versions but is offered no way to change them.
+discard it first, and so does leaving the editor. Ctrl+S saves the text. A revision written in
+the text's Compare revision view and applied to the draft is the text Save stores. A user the
+prompt is shared with read only can pick and compare its versions but is offered no way to change
+them.
 
 Discriminates: passes on dev b130fec73. In a frontend build where an old version's text box takes
 typing the read-only test goes red; where the comparison leaves out the prompt text the comparison
@@ -20,7 +22,9 @@
 the chosen layout is not remembered the layout test goes red; and where a change of line endings
 alone counts as no change the line endings test goes red. Retargeted for 6a7678ac7, which named the
 version picker History and the live version Live: the tests pass on dev 206bf9723, and a frontend
-build whose version switch keeps the current text turns the read-only test red.
+build whose version switch keeps the current text turns the read-only test red. The Compare
+revision test passes on the dev 3b8205505 build and fails in a build of it whose Apply to draft
+keeps the original text.
 """
 
 from __future__ import annotations
@@ -210,6 +214,26 @@ def test_ctrl_s_saves_the_prompt_text(page_for, writer):
     assert stored["content"] == "Summarise this in one word."
 
 
+def test_a_revision_applied_from_compare_revision_is_the_saved_text(page_for, writer):
+    first, _ = _edited_once(writer)
+    page = page_for(writer)
+    _open(page, first["id"], ONE_LINE)
+    revised = "Summarise this in one plain sentence."
+
+    page.get_by_role("button", name="Compare revision").click()
+    compare = page.get_by_role("dialog", name="Compare revision")
+    expect(compare.get_by_role("textbox", name="Original")).to_have_text(ONE_LINE)
+    compare.get_by_role("textbox", name="Proposed revision").click()
+    page.keyboard.insert_text(revised)
+    compare.get_by_role("button", name="Apply to draft").click()
+
+    expect(compare).to_have_count(0)
+    expect(_content(page)).to_have_value(revised)
+    page.get_by_role("button", name="Save", exact=True).click()
+    expect(page.get_by_text("Prompt updated successfully")).to_be_visible()
+    assert _get(writer, f"/api/v1/prompts/id/{first['id']}")["content"] == revised
+
+
 def test_leaving_the_editor_with_unsaved_typing_asks_first(page_for, writer):
     first, _ = _edited_once(writer)
     page = page_for(writer)

e2e/workspace/test_skill_file_tree.py

@@ -8,13 +8,17 @@
 Upload is saved with its bytes and shown as a picture. In SKILL.md's preview a link to another
 file of the skill opens that file. When the skill was saved in another tab meanwhile, Save warns
 that a newer version exists and keeps the draft, and Reload latest shows the other tab's work.
+A revision written in a file's Compare revision view and applied to the draft is what Save stores
+for that file, and the file's Copy puts the open file on the clipboard.
 
 Discriminates: passes on the dev 178de3666 build. In a frontend copy, an editor that sends only
 SKILL.md on create turns the create test red; one whose save keeps a renamed file under its old
 name as well, or one that does not send deletions, turns the rename and delete test red; an upload
 sent as text turns the upload test red; a preview that leaves relative links alone turns the
 preview test red; and an editor that does not show a version conflict turns the conflict test
-red.
+red. The compare and copy tests pass on the dev 3b8205505 build; a build of it whose Apply to draft
+keeps the original turns the compare test red, and one whose Copy copies the file's saved content
+turns the copy test red.
 """
 
 from __future__ import annotations
@@ -183,3 +187,45 @@ def test_a_save_after_another_tab_saved_keeps_the_draft_and_offers_the_latest(pa
     open_row(page, "tables.md")
     expect(code_editor(page)).to_contain_text("From the other tab.")
     assert current(owner, skill["id"])["version_id"] == other.json()["version_id"]
+
+
+def _open_tables(page: Page, skill: dict) -> None:
+    _open_skill(page, skill["id"])
+    open_row(page, "references")
+    open_row(page, "tables.md")
+    expect(page.get_by_title("references/tables.md", exact=True)).to_be_visible()
+    expect(code_editor(page)).to_contain_text("High water at noon.")
+
+
+def test_a_revision_applied_from_compare_revision_is_saved_in_the_file(page_for, owner):
+    skill = _tide_skill(owner)
+    page = page_for(owner)
+    _open_tables(page, skill)
+
+    page.get_by_role("main").get_by_role("button", name="Compare revision").click()
+    compare = page.get_by_role("dialog", name="Compare revision")
+    expect(compare.get_by_role("textbox", name="Original")).to_have_text("High water at noon.")
+    compare.get_by_role("textbox", name="Proposed revision").click()
+    page.keyboard.insert_text("High water at two.\n")
+    compare.get_by_role("button", name="Apply to draft").click()
+
+    expect(compare).to_have_count(0)
+    expect(code_editor(page)).to_contain_text("High water at two.")
+    _save(page)
+    expect(page.get_by_text("Skill updated successfully")).to_be_visible()
+    assert read(owner, skill["id"], "references/tables.md") == b"High water at two.\n"
+    assert b"Read [the tables]" in read(owner, skill["id"], "SKILL.md")
+
+
+def test_copy_puts_the_open_file_on_the_clipboard(page_for, owner):
+    skill = _tide_skill(owner)
+    page = page_for(owner)
+    page.context.grant_permissions(["clipboard-read", "clipboard-write"])
+    _open_tables(page, skill)
+    replace_text(page, "High water at three.\n")
+
+    page.get_by_role("main").get_by_role("button", name="Copy content").click()
+
+    expect(page.get_by_text("Copied to clipboard")).to_be_visible()
+    copied = page.evaluate("() => navigator.clipboard.readText()")
+    assert copied == "High water at three.\n", f"Copy put {copied!r} on the clipboard"