mirror of
https://github.com/lrnselfreliance/wrolpi.git
synced 2026-10-26 19:01:39 -04:00
review: the spread was overwriting the stack, and the guard was blind
Acting on the review of #622. Two bugs, both real, and the second one is a test of mine that could not fail for its stated reason. The stack props were set BEFORE `{...props}`, so any call site passing `closeOnEscape` overwrote the stack's decision and re-armed Mantine's window-level Escape listener on a modal that is not on top -- reinstating the bug the change exists to fix. Three call sites pass it: CollectionReorganizeModal and BatchReorganizeModal disable Escape while a reorganize runs, Flasher while it writes an image. The concrete breakage is the one place the app really does stack two modals: ConflictResolutionModal opens as a sibling above the reorganize modal, so the moment the reorganize finished and `closeOnEscape` returned to true, one Escape closed both. They are now destructured out and composed -- `isTop && closeOnEscape` -- because "only the top modal answers Escape" and "do not dismiss me while I am busy" are both true. Mantine's own Modal.Stack applies its stack props after the caller's for the same reason. Two Cypress cases, one per direction; planting the old order reddens the first. `Confirm` was still passing Mantine's raw `sm`, and the audit guard I added in the same PR was supposed to catch exactly that. It did not, and the reason is worse than the miss: the scanner matched `<Modal\b[^>]*?\bsize='...'`, and `onClose={() => ...}` contains a `>`, so it stopped at the arrow and never saw the rest of the tag. It read 44 of the 56 modals that declare a size; the twelve it skipped included the single offender in the codebase, in this very file. A guard that scans a fifth of nothing looks identical to a clean codebase. It now walks the tag with a paren counter, accepts either quote style, and asserts it scanned more than fifty tags first -- so a scanner that silently matches nothing fails instead of passing. Confirm says `tiny`. Also from the review: a bare `expect(titles()).to.not.include('Parent')` in the Cypress spec ran during the synchronous phase, before any cy command executed and while nothing was open, so it always passed and guarded nothing. Deleted rather than repaired -- the retried assertion above it already makes the claim. An unregistered-but-open modal reported `isTop` even with a parent registered, which gave both the same z-index for the frame before the effect ran -- a visible flash of the wrong modal in front. It is only top now if the stack is empty. Nit: the comment claimed Mantine ignores unknown size names. It ignores unknown SEMANTIC names and falls back to 440px; it recognises and honours its own. Two different hazards, both silent, and the comment now says which is which. 1124 jest / 62 suites, 10 in modal-stack.cy.js, 196 in ui-layout.cy.js, clean npm run build.
This commit is contained in:
parent
afa127a992
commit
ad78cdee7c
3 changed files with 141 additions and 25 deletions
|
|
@ -1530,13 +1530,34 @@ describe('modal sizes', () => {
|
|||
|
||||
it('never lets a call site name a size the table does not know', () => {
|
||||
/*
|
||||
* A name the table has never heard of is passed straight to Mantine, which ignores
|
||||
* anything it does not recognise and renders the default -- so a typo is a modal that
|
||||
* silently reverts to 440px with no warning anywhere. Flasher was passing Mantine's
|
||||
* own `sm` directly, which worked but bypassed the naming the audit used.
|
||||
* Two different hazards, and neither announces itself.
|
||||
*
|
||||
* A misspelled SEMANTIC name is not in the table, so it passes through untranslated,
|
||||
* Mantine does not recognise it either, and the modal silently renders at the default
|
||||
* 440px. A raw MANTINE name -- `sm`, `md` -- is recognised and honoured: it works,
|
||||
* so nothing ever complains, and the call site quietly sits outside the vocabulary
|
||||
* the widths were audited in and outside the table that can retune them. Flasher and
|
||||
* Confirm were both doing the second.
|
||||
*
|
||||
* The tag is scanned with a paren counter rather than matched with `[^>]*?`, which is
|
||||
* what the first version of this did. `onClose={() => ...}` contains a `>`, so that
|
||||
* pattern stopped at the arrow and skipped the rest of the tag: it saw 44 of the 56
|
||||
* modals that declare a size, and the twelve it missed included Confirm's `size='sm'`
|
||||
* in this very library -- the one offender it was written to catch.
|
||||
*/
|
||||
const known = new Set(['mini', 'tiny', 'small', 'large', 'fullscreen']);
|
||||
const offenders = [];
|
||||
|
||||
/** The opening tag starting at `start`, honouring braces in prop expressions. */
|
||||
const openingTag = (source, start) => {
|
||||
let depth = 0;
|
||||
for (let i = start; i < source.length; i++) {
|
||||
const character = source[i];
|
||||
if (character === '{' || character === '(') depth += 1;
|
||||
else if (character === '}' || character === ')') depth -= 1;
|
||||
else if (character === '>' && depth === 0) return source.slice(start, i + 1);
|
||||
}
|
||||
return '';
|
||||
};
|
||||
|
||||
const walk = (directory) => fs.readdirSync(directory, {withFileTypes: true})
|
||||
.flatMap(entry => {
|
||||
|
|
@ -1547,15 +1568,24 @@ describe('modal sizes', () => {
|
|||
return [[full, fs.readFileSync(full, 'utf8')]];
|
||||
});
|
||||
|
||||
const offenders = [];
|
||||
let scanned = 0;
|
||||
for (const [file, source] of walk(path.join(__dirname, '..', '..'))) {
|
||||
// Only `<Modal ... size='x'>`; a computed `size={...}` is the caller's business.
|
||||
for (const match of source.matchAll(/<Modal\b[^>]*?\bsize='([^']+)'/g)) {
|
||||
if (!known.has(match[1])) {
|
||||
offenders.push(`${path.basename(file)}: size='${match[1]}'`);
|
||||
for (const match of source.matchAll(/<Modal\b/g)) {
|
||||
const tag = openingTag(source, match.index);
|
||||
// Quote-agnostic; a computed `size={...}` is the caller's business.
|
||||
const declared = tag.match(/\bsize=["']([^"']+)["']/);
|
||||
if (!declared) continue;
|
||||
scanned += 1;
|
||||
if (!known.has(declared[1])) {
|
||||
offenders.push(`${path.basename(file)}: size='${declared[1]}'`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// The premise. A scanner that silently matched nothing would report no offenders
|
||||
// and read exactly like a clean codebase, which is how the first version passed.
|
||||
expect(scanned).toBeGreaterThan(50);
|
||||
expect(offenders).toEqual([]);
|
||||
});
|
||||
});
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue