Files
odysseus/tests/test_document_rich_image_caption.py
T
Léo 345ce0a9ec test(document): read the editor through a module-set helper before it is split
static/js/document.js is 17,579 lines and is about to be decomposed behind a
re-export wrapper. 51 test files read it off disk and grep it as text, and 28
of those slice it with `src.split("function a", 1)[1].split("function b", 1)[0]`
-- "the region between a and b", which only means what the test intends while a
and b are neighbours in one file. Several also hard-code the file's two-space
indentation, which no extracted module reproduces. Left alone, the first
extraction makes those assertions cover the wrong region, and an `x in region`
check passes while covering more than it was written for.

tests/helpers/document_source is the one place that names the file now:

  - document_source() is the entry plus everything under static/js/document/,
    so a membership assertion keeps finding its subject wherever it lands;
  - function_body()/declaration() locate a construct by name in whichever
    module defines it and end at its real closing brace, so neither moving it
    nor moving its neighbour changes the region.

The rewrite only collapses a slice when the old terminator sat at the
construct's end. 28 slices deliberately span a whole family of functions --
everything from _docxHexColor to exportAsDocx -- and collapsing one to its
first member drops what the assertions look for, so those stay as they are and
are listed in KNOWN_ADJACENCY_SLICES, to be converted as each family becomes a
module. That list may only shrink.

Two guards come with it:

  - test_document_source_test_hygiene fails on a direct read of the entry file
    and on any new adjacency slice;
  - test_frontend_module_graph resolves every relative import under static/
    (718 of them, none broken today) and requires the document module set to
    stay in the sw.js precache, since the worker fetches the URLs it lists and
    not what they import.

test_document_module_api pins the 38 default-export keys and 29 named exports
by loading the module in a browser and reading what it actually exports, rather
than grepping for the literal object -- after extraction that object may be
assembled from imports, and a source-shape check would pass while the export
was broken.

No JavaScript moves here. static/ is untouched.
2026-09-30 09:39:05 +02:00

147 lines
6.4 KiB
Python

"""Browser coverage for editable, undoable Rich Text image captions."""
import json
import subprocess
from pathlib import Path
from tests.helpers.stylesheets import app_css
from tests.helpers.document_source import document_source, function_body
ROOT = Path(__file__).resolve().parents[1]
DOC_JS = document_source()
STYLE = app_css()
def test_image_caption_uses_semantic_figure_and_structured_export_paths():
caption = function_body("_editRichImageCaption")
converter = function_body("_docxFigureBlocks")
assert "function _promptImageCaption" in DOC_JS
assert "function _replaceRichImageFigure" in DOC_JS
assert "document.createElement('figure')" in caption
assert "captionElement.textContent = caption" in caption
assert "replacement = replacementImage" in caption
assert "_docxImageAlignment(image, docx)" in converter
assert "caption.childNodes" in converter
assert "figure.richtext-image .richtext-image-caption" in STYLE
def test_mobile_image_caption_survives_resize_history_and_empty_removal():
script = r"""
import { chromium } from 'playwright';
const browser = await chromium.launch({ headless: true });
const page = await browser.newPage({ viewport: { width: 390, height: 844 } });
await page.goto(`${process.env.ODYSSEUS_TEST_STATIC_ORIGIN}/static/js/documentStats.js`);
await page.setContent('<link rel="stylesheet" href="/static/style.css?v=20260831richtexttools91"><div id="toast"></div><div id="chat-container"></div><div id="sidebar"></div>');
await page.evaluate(async () => {
const mod = await import('/static/js/document.js?v=20260831richtexttools91&image-caption=1');
mod.init('/api');
mod.injectFreshDoc({
id: 'image-caption-doc',
title: 'Image caption',
language: 'richtext',
current_content: '<p>Before</p><img class="richtext-image richtext-image-align-center" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADElEQVR42mNk+M/wHwAF/gL+AvzZ8QAAAABJRU5ErkJggg==" alt="Diagram"><p>After</p>',
version_count: 1,
});
await new Promise(resolve => setTimeout(resolve, 450));
});
async function selectImage() {
await page.locator('#doc-email-richbody img.richtext-image').click();
}
async function openImageMenu() {
await page.locator('[data-dd="image"]').focus();
await page.keyboard.press('ArrowDown');
await page.waitForSelector('#doc-md-dd-menu');
}
async function editCaption(value) {
await selectImage();
await openImageMenu();
await page.locator('#doc-md-dd-menu .doc-overflow-item').filter({ hasText: 'Edit caption' }).click();
await page.waitForSelector('#doc-image-caption-input');
await page.locator('#doc-image-caption-input').fill(value);
await page.locator('#doc-image-caption-ok').click();
await page.waitForTimeout(70);
}
async function state() {
return page.evaluate(() => {
const rich = document.querySelector('#doc-email-richbody');
const image = rich.querySelector('img.richtext-image');
const figure = image?.closest('figure.richtext-image');
const caption = figure?.querySelector(':scope > .richtext-image-caption');
return {
figure: Boolean(figure),
caption: caption?.textContent || '',
size35: image?.classList.contains('richtext-image-size-35') || false,
alignCenter: image?.classList.contains('richtext-image-align-center') || false,
selected: image?.hasAttribute('data-editor-image-selected') || false,
stored: document.querySelector('#doc-editor-textarea').value,
};
});
}
await editCaption('Quarterly revenue');
const added = await state();
await page.locator('#doc-undo-btn').click();
await page.waitForTimeout(70);
const undone = await state();
await page.locator('#doc-redo-btn').click();
await page.waitForTimeout(70);
const redone = await state();
await selectImage();
await openImageMenu();
const menuRect = await page.locator('#doc-md-dd-menu').evaluate(menu => {
const rect = menu.getBoundingClientRect();
return { left: rect.left, right: rect.right, top: rect.top, bottom: rect.bottom };
});
await page.locator('#doc-md-dd-menu .doc-overflow-item').filter({ hasText: 'Small' }).click();
await page.waitForTimeout(70);
const resized = await state();
await editCaption('');
const removed = await state();
await page.locator('#doc-undo-btn').click();
await page.waitForTimeout(70);
const removalUndone = await state();
const overflow = await page.evaluate(() => ({
scrollWidth: document.documentElement.scrollWidth,
clientWidth: document.documentElement.clientWidth,
}));
console.log(JSON.stringify({ added, undone, redone, resized, removed, removalUndone, menuRect, overflow }));
await browser.close();
"""
result = subprocess.run(
["node", "--input-type=module", "-e", script],
cwd=ROOT,
check=False,
capture_output=True,
text=True,
)
assert result.returncode == 0, result.stderr
data = json.loads(result.stdout)
assert data["added"]["figure"] is True
assert data["added"]["caption"] == "Quarterly revenue", json.dumps(data, indent=2)
assert data["added"]["alignCenter"] is True
assert data["added"]["selected"] is True
assert ">Quarterly revenue</div>" in data["added"]["stored"]
assert "data-editor-image-selected" not in data["added"]["stored"]
assert data["undone"]["figure"] is False
assert data["redone"]["caption"] == "Quarterly revenue"
assert data["resized"]["figure"] is True, json.dumps(data, indent=2)
assert data["resized"]["caption"] == "Quarterly revenue"
assert data["resized"]["size35"] is True
assert data["removed"]["figure"] is False
assert data["removed"]["caption"] == ""
assert "richtext-image-caption" not in data["removed"]["stored"]
assert data["removalUndone"]["figure"] is True
assert data["removalUndone"]["caption"] == "Quarterly revenue"
assert data["menuRect"]["left"] >= 8
assert data["menuRect"]["right"] <= 382
assert data["menuRect"]["top"] >= 8
assert data["menuRect"]["bottom"] <= 836
assert data["overflow"]["scrollWidth"] == data["overflow"]["clientWidth"]