wrolpi/app/src/components/Docs.test.js
lrnselfreliance e3fa68a53c
ui: a PDF asks before it lights up a night-adapted eye (#654)
* ui: a PDF asks before it lights up a night-adapted eye

Night and amber pass media through an SVG color matrix so nothing a user opens costs
them their dark adaptation.  It reaches everything drawn in our own document -- images,
video, canvases, and same-origin iframes like the EPUB viewer.

It does not reach a PDF, and the miss is not subtle.  Chrome draws PDFs in its own
out-of-process viewer, which the compositor paints outside the parent's filter: the
computed style on the iframe really does say `filter: url(#wrolpi-night-red)` and the
page still arrives in full color.  Measured in night mode on a device, a PDF covered
55% of the doc page in non-red pixels -- a full-brightness photograph of a blue sky --
while the chrome around it was correctly red.  The preview modal measured 39.8%.

Tinting from outside was tried and does not work.  A red `mix-blend-mode: multiply`
overlay above the iframe cannot see the plugin's pixels, so it stops blending and paints
flat opaque red: zero non-red pixels by measurement, document entirely obliterated.

So the PDF is withheld and the reader chooses.  Nothing renders until they do; hiding it
with CSS would still load and paint the viewer, which is the flash being avoided.

Gated on whether the theme is CURRENTLY filtering, not on its name.  A reader who turns
night's filter off has said they do not want this, and amber with its filter on has the
same unreachable PDF and does.  Only PDFs: text and the EPUB viewer are documents of our
own and tint correctly, so gating them would hide something for no reason.

The gallery paragraph claiming the matrix remaps PDFs is corrected -- it was the one
place we told users something this measurement disproves.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

* review: the reveal that outlived its document, and a test that proved nothing

Five review comments, all correct.

The bug: MediaGate was not keyed in FilePreview.  The effect that rebuilds a preview sets
the modal to null and then to the new content in one pass, so React 18 batches both and
reconciles instead of unmounting -- the fiber survives, and a reader who revealed PDF A
would get PDF B in full color with no prompt.  Keyed by url, which is what Docs already
did with activePath.

The test named "re-gates when filtering is turned back on" never revealed anything first,
so it went from gated=false to gated=true with `revealed` already false.  That path never
reaches the reset effect: the test passed with the effect deleted.  It now clicks Show
first, and fails without the effect.

The hide control moved above the media.  A preview fills `calc(100dvh - 18.75rem)`, a
height calibrated with no room for a trailing button row, so a control after it lands
below the fold of a full-screen modal -- leaving the reader who just lit up their eyes
scrolling to find the way back.

Docs' embed -- the surface measured at 55% non-red -- had no contract test where
FilePreview had one.  It has one now, asserting the gate wraps the iframe, keys per
document, and reads mediaFilterEnabled rather than the theme's name.

Gallery copy said "night and amber withhold it"; amber's filter is off unless asked for.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-11 18:57:15 -06:00

49 lines
2.2 KiB
JavaScript

import fs from 'fs';
import path from 'path';
/*
* The document page's embedded viewer, and which of them is withheld in a filtering theme.
*
* This is the surface that measured 55% non-red pixels in night mode: a PDF is drawn by the
* browser in its own out-of-process viewer, which the theme's SVG filter never reaches, so it
* arrives in full color however the iframe is styled. The EPUB viewer is a document of our own
* and tints correctly, so gating it would hide something for no reason.
*
* Read off the source. DocPage renders only after `useDoc` resolves a file group and reaches
* the embed through several branches of file selection; a render test here would assert more
* about the mocks than about the wiring. ui.test.js covers what MediaGate itself does, and
* FilePreview.test.js covers the same contract on the other embed surface.
*/
const source = fs.readFileSync(path.join(__dirname, 'Docs.js'), 'utf8');
describe('DocPage embed gating (source contract)', () => {
it('wraps the embedded viewer in a MediaGate', () => {
// The iframe must not be reachable without passing through the gate.
const embed = source.match(/<MediaGate[^>]*>\s*<iframe/);
expect(embed).not.toBeNull();
});
it('gates on the live filter state, not on the theme name', () => {
/*
* `mediaFilterEnabled` rather than `theme === 'night'`: a reader who turns night's
* filter off has said they do not want this, and amber with its filter on has the same
* unreachable PDF and does.
*/
const gate = source.match(/<MediaGate[^>]*gated=\{([^}]*)\}/);
expect(gate).not.toBeNull();
expect(gate[1]).toContain('mediaFilterEnabled');
expect(gate[1]).toContain('isPdf');
// The theme's NAME must not appear in the condition.
expect(gate[1]).not.toMatch(/theme\s*===/);
});
it('remounts the gate per document, so revealing one does not reveal the next', () => {
// Selecting a different file reuses the same fiber otherwise, carrying `revealed` over.
const gate = source.match(/<MediaGate([^>]*)>/);
expect(gate[1]).toMatch(/key=\{/);
});
});