ZDDC/tests/browse.spec.js
ZDDC 141fef88fb feat(browse): "Download (zip)" — pull the current directory's subtree as a zip
A "⤓ Download (zip)" button in the browse toolbar (shown once a
directory is loaded) downloads the directory you're currently
viewing — and everything under it you're allowed to see — as a single
.zip. Navigate into a subfolder first to grab just that subtree.

- Server mode: an <a download> at "<currentPath>?zip=1" — zddc-server
  streams the ACL-filtered zip (see the previous commit), nothing held
  in the browser.
- Offline (file://) mode: new browse/js/download.js walks the picked
  folder with the FS-Access API in two passes — metadata first (so it
  can confirm() before loading >~2000 files / ~500 MB into memory),
  then bytes — bundles with the already-vendored JSZip, and triggers a
  blob download. Hidden entries (".":/"_"-prefixed) are skipped, the
  zip's top level is "<folderName>/…" so it unpacks tidily, and the
  status bar shows progress.

Wired in browse/js/events.js (button click + show/hide alongside the
refresh button); concatenated into browse/build.sh; ARCHITECTURE.md +
AGENTS.md note the ?zip=1 endpoint and the button.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-12 13:04:04 -05:00

198 lines
9.3 KiB
JavaScript

import { test, expect } from '@playwright/test';
import { MOCK_FS_INIT_SCRIPT } from './fixtures/mock-fs-api.js';
import * as path from 'path';
import * as fs from 'fs/promises';
const HTML_PATH = path.resolve('browse/dist/browse.html');
test.describe('Browse', () => {
test.beforeEach(async ({ page }) => {
await page.addInitScript(MOCK_FS_INIT_SCRIPT);
});
test('loads with the empty state visible and add-directory button enabled', async ({ page }) => {
await page.goto(`file://${HTML_PATH}`, { waitUntil: 'load' });
await page.waitForSelector('#addDirectoryBtn', { timeout: 15000 });
// file:// + no auto-server-root → the empty state is shown and the
// browse table stays hidden until the user picks a directory.
await expect(page.locator('#emptyState')).toBeVisible();
await expect(page.locator('#browseRoot')).toBeHidden();
const addDirBtn = page.locator('#addDirectoryBtn');
await expect(addDirBtn).toBeVisible();
await expect(addDirBtn).not.toBeDisabled();
});
test('renders rows from a mock directory after picking', async ({ page }) => {
await page.goto(`file://${HTML_PATH}`, { waitUntil: 'load' });
await page.waitForSelector('#addDirectoryBtn', { timeout: 15000 });
await page.evaluate(() => {
window.__setMockDirectory('docs', [
{ name: 'spec.pdf', content: '%PDF-fixture', size: 1024 },
{ name: 'readme.md', content: '# Hello\n', size: 8 },
{ name: 'notes.txt', content: 'note one\nnote two\n', size: 16 },
]);
});
await page.locator('#addDirectoryBtn').click();
// Browse swaps from empty state to the two-pane layout. The
// tree pane is on the left; rows are <div class="tree-row">.
await page.waitForSelector('#browseRoot:not(.hidden)', { timeout: 10000 });
await page.waitForFunction(
() => document.querySelectorAll('#treeBody .tree-row').length >= 3,
{ timeout: 10000 }
);
const rows = await page.locator('#treeBody .tree-row').count();
expect(rows).toBeGreaterThanOrEqual(3);
// Right preview pane is present and starts in the empty state.
await expect(page.locator('#previewPane')).toBeVisible();
await expect(page.locator('#previewBody')).toContainText(/Click a file/);
});
test('clicking a file shows it in the preview pane', async ({ page }) => {
await page.goto(`file://${HTML_PATH}`, { waitUntil: 'load' });
await page.waitForSelector('#addDirectoryBtn', { timeout: 15000 });
await page.evaluate(() => {
window.__setMockDirectory('docs', [
{ name: 'notes.txt', content: 'hello world', size: 11 },
]);
});
await page.locator('#addDirectoryBtn').click();
await page.waitForSelector('#treeBody .tree-row', { timeout: 10000 });
// Click the file row.
await page.locator('#treeBody .tree-row[data-isdir="false"]').first().click();
// Preview title updates to the file name; pop-out button appears.
await expect(page.locator('#previewTitle')).toHaveText(/notes\.txt/);
await expect(page.locator('#previewPopout')).toBeVisible();
});
test('clicking a .md file mounts the markdown editor with a TOC', async ({ page }) => {
await page.goto(`file://${HTML_PATH}`, { waitUntil: 'load' });
await page.waitForSelector('#addDirectoryBtn', { timeout: 15000 });
await page.evaluate(() => {
window.__setMockDirectory('notes', [
{
name: 'readme.md',
content: '# Title\n\nIntro.\n\n## Section One\n\nText.\n\n### Subsection\n\nDeeper.',
size: 100,
},
]);
});
await page.locator('#addDirectoryBtn').click();
await page.waitForSelector('#treeBody .tree-row[data-isdir="false"]', { timeout: 10000 });
await page.locator('#treeBody .tree-row[data-isdir="false"]').first().click();
// Markdown plugin DOM mounts: shell, sidebar (front matter +
// TOC), content (info header + editor).
await expect(page.locator('.md-shell')).toBeVisible({ timeout: 15000 });
await expect(page.locator('.md-shell__sidebar')).toBeVisible();
await expect(page.locator('.md-shell__infohdr')).toBeVisible();
await expect(page.locator('.md-shell__editor')).toBeVisible();
// Outline lists the three headings.
await page.waitForSelector('.md-toc__list .md-toc__item', { timeout: 10000 });
const tocItems = await page.locator('.md-toc__list .md-toc__item').allTextContents();
expect(tocItems).toEqual(['Title', 'Section One', 'Subsection']);
// Source hint reflects local FS-API mode.
await expect(page.locator('.md-shell__source')).toHaveText(/local/i);
});
test('expands a .zip transmittal folder and previews a member', async ({ page }) => {
await page.goto(`file://${HTML_PATH}`, { waitUntil: 'load' });
await page.waitForSelector('#addDirectoryBtn', { timeout: 15000 });
// Build a real zip in-browser (JSZip is bundled into browse.html)
// and hand its bytes to the mock FS as a single .zip file whose
// name parses as a transmittal folder.
await page.evaluate(async () => {
const zip = new window.JSZip();
zip.file('DOC-001 (IFI) - Spec.pdf', '%PDF-1.4 fixture body');
zip.file('sub/note.txt', 'a note inside the zip');
const buf = await zip.generateAsync({ type: 'uint8array' });
window.__setMockDirectory('PartyA', [
{ name: '2025-05-12_DOC-001 (IFI) - Title.zip', content: buf, size: buf.length },
]);
});
await page.locator('#addDirectoryBtn').click();
await page.waitForSelector('#treeBody .tree-row[data-iszip="true"]', { timeout: 10000 });
// Expand the .zip — it should list its members like a folder.
await page.locator('#treeBody .tree-row[data-iszip="true"]').first().click();
await page.waitForFunction(
() => document.querySelectorAll('#treeBody .tree-row').length >= 3,
{ timeout: 10000 }
);
const labels = await page.locator('#treeBody .tree-name__label').allTextContents();
expect(labels.join('|')).toContain('DOC-001 (IFI) - Spec.pdf');
expect(labels.join('|')).toContain('sub');
// Drill into the subdir, then preview the text member.
await page.locator('#treeBody .tree-row[data-isdir="true"]').last().click();
await page.waitForFunction(
() => Array.from(document.querySelectorAll('#treeBody .tree-name__label'))
.some(el => el.textContent === 'note.txt'),
{ timeout: 10000 }
);
const noteRow = page.locator('#treeBody .tree-row', { has: page.locator('.tree-name__label', { hasText: /^note\.txt$/ }) });
await noteRow.click();
await expect(page.locator('#previewTitle')).toHaveText(/note\.txt/);
await expect(page.locator('#previewBody')).toContainText('a note inside the zip');
});
test('Download (zip) bundles the current folder offline', async ({ page }) => {
await page.goto(`file://${HTML_PATH}`, { waitUntil: 'load' });
await page.waitForSelector('#addDirectoryBtn', { timeout: 15000 });
await page.evaluate(() => {
window.__setMockDirectoryTree('mock-folder', {
'a.txt': 'AAA',
'sub': { 'b.txt': 'BBB', 'deep': { 'c.txt': 'CCC' } },
'.zddc': 'acl: { permissions: { "*": r } }', // hidden — must not be in the zip
'_template': { 'scaffold.txt': 'x' }, // hidden dir — must not be in the zip
});
});
await page.locator('#addDirectoryBtn').click();
await page.waitForSelector('#browseRoot:not(.hidden)', { timeout: 10000 });
// The Download (zip) button appears once a directory is loaded.
const dlBtn = page.locator('#downloadZipBtn');
await expect(dlBtn).toBeVisible();
const [download] = await Promise.all([
page.waitForEvent('download'),
dlBtn.click(),
]);
expect(download.suggestedFilename()).toBe('mock-folder.zip');
const file = await download.path();
const buf = await fs.readFile(file);
// Valid zip: starts with the local-file-header magic, non-trivial.
expect(buf.length).toBeGreaterThan(50);
expect(buf.subarray(0, 4)).toEqual(Buffer.from([0x50, 0x4b, 0x03, 0x04]));
// Introspect the entries with the bundled JSZip (in-page).
const b64 = buf.toString('base64');
const entries = await page.evaluate(async (b64) => {
const bin = atob(b64);
const bytes = new Uint8Array(bin.length);
for (let i = 0; i < bin.length; i++) bytes[i] = bin.charCodeAt(i);
const z = await window.JSZip.loadAsync(bytes);
return Object.keys(z.files).filter((n) => !z.files[n].dir).sort();
}, b64);
expect(entries).toEqual([
'mock-folder/a.txt',
'mock-folder/sub/b.txt',
'mock-folder/sub/deep/c.txt',
]);
});
});