Files
bDS/tests/engine/PreviewServer.test.ts

582 lines
21 KiB
TypeScript

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { mkdtemp, mkdir, rm, writeFile } from 'node:fs/promises';
import path from 'node:path';
import { tmpdir } from 'node:os';
import type { PostData, PostFilter } from '../../src/main/engine/PostEngine';
import { PreviewServer } from '../../src/main/engine/PreviewServer';
type PostEngineLike = {
getPostsFiltered: (filter: PostFilter) => Promise<PostData[]>;
getPost: (id: string) => Promise<PostData | null>;
hasPublishedVersion: (id: string) => Promise<boolean>;
getPublishedVersion: (id: string) => Promise<PostData | null>;
setProjectContext: (projectId: string, dataDir?: string) => void;
};
type SettingsEngineLike = {
getProjectMetadata: () => Promise<{ maxPostsPerPage?: number } | null>;
setProjectContext: (projectId: string, dataDir?: string) => void;
};
function makePost(overrides: Partial<PostData> = {}): PostData {
const createdAt = overrides.createdAt ?? new Date('2025-01-02T10:00:00.000Z');
const updatedAt = overrides.updatedAt ?? createdAt;
const title = overrides.title ?? 'Title';
return {
id: overrides.id ?? 'post-1',
projectId: overrides.projectId ?? 'default',
title,
slug: overrides.slug ?? 'title',
excerpt: overrides.excerpt,
content: overrides.content ?? `# ${title}\n\nBody`,
status: overrides.status ?? 'published',
author: overrides.author,
createdAt,
updatedAt,
publishedAt: overrides.publishedAt,
tags: overrides.tags ?? [],
categories: overrides.categories ?? [],
};
}
function makeEngine(posts: PostData[]): PostEngineLike {
const byId = new Map(posts.map((post) => [post.id, post]));
return {
setProjectContext: vi.fn(),
async hasPublishedVersion(): Promise<boolean> {
return false;
},
async getPublishedVersion(): Promise<PostData | null> {
return null;
},
async getPost(id: string): Promise<PostData | null> {
return byId.get(id) ?? null;
},
async getPostsFiltered(filter: PostFilter): Promise<PostData[]> {
let result = posts.filter((post) => post.status === (filter.status ?? post.status));
if (filter.tags && filter.tags.length > 0) {
result = result.filter((post) => filter.tags!.every((tag) => post.tags.includes(tag)));
}
if (filter.categories && filter.categories.length > 0) {
result = result.filter((post) => filter.categories!.some((category) => post.categories.includes(category)));
}
if (filter.year !== undefined) {
result = result.filter((post) => post.createdAt.getUTCFullYear() === filter.year);
}
if (filter.month !== undefined && filter.year !== undefined) {
result = result.filter((post) => post.createdAt.getUTCMonth() === filter.month);
}
if (filter.startDate) {
result = result.filter((post) => post.createdAt >= filter.startDate!);
}
if (filter.endDate) {
result = result.filter((post) => post.createdAt <= filter.endDate!);
}
return result.sort((a, b) => b.createdAt.getTime() - a.createdAt.getTime());
},
};
}
function makeSettings(maxPostsPerPage = 50): SettingsEngineLike {
return {
setProjectContext: vi.fn(),
async getProjectMetadata(): Promise<{ maxPostsPerPage?: number } | null> {
return { maxPostsPerPage };
},
};
}
function makeMediaEngine(mediaItems: Array<{ id: string; filename: string; originalName: string; createdAt: Date }>) {
return {
async getAllMedia() {
return mediaItems;
},
};
}
describe('PreviewServer', () => {
let server: PreviewServer;
let tempDir: string | null = null;
afterEach(async () => {
if (server) {
await server.stop();
}
if (tempDir) {
await rm(tempDir, { recursive: true, force: true });
tempDir = null;
}
});
beforeEach(() => {
vi.clearAllMocks();
});
it('binds to localhost and serves root route', async () => {
const posts = [
makePost({ id: '1', slug: 'newest', title: 'Newest', createdAt: new Date('2025-01-03T10:00:00.000Z') }),
makePost({ id: '2', slug: 'older', title: 'Older', createdAt: new Date('2025-01-02T10:00:00.000Z') }),
];
server = new PreviewServer({
postEngine: makeEngine(posts),
settingsEngine: makeSettings(50),
getActiveProjectContext: async () => ({ projectId: 'default' }),
});
const port = await server.start(0);
expect(port).toBeGreaterThan(0);
expect(server.getBaseUrl()).toMatch(/^http:\/\/127\.0\.0\.1:\d+$/);
const response = await fetch(`${server.getBaseUrl()}/`);
expect(response.status).toBe(200);
const html = await response.text();
expect(html).toContain('<div class="post">');
expect(html).toContain('<h1>Newest</h1>');
});
it('uses local CSS/JS assets and serves them from the preview server', async () => {
server = new PreviewServer({
postEngine: makeEngine([makePost()]),
settingsEngine: makeSettings(50),
getActiveProjectContext: async () => ({ projectId: 'default' }),
});
await server.start(0);
const rootResponse = await fetch(`${server.getBaseUrl()}/`);
expect(rootResponse.status).toBe(200);
const rootHtml = await rootResponse.text();
expect(rootHtml).toContain('href="/assets/pico.min.css"');
expect(rootHtml).toContain('href="/assets/lightbox.min.css"');
expect(rootHtml).toContain('src="/assets/lightbox.min.js"');
expect(rootHtml).not.toContain('cdn.jsdelivr.net');
const picoResponse = await fetch(`${server.getBaseUrl()}/assets/pico.min.css`);
expect(picoResponse.status).toBe(200);
expect(picoResponse.headers.get('content-type')).toContain('text/css');
const lightboxCssResponse = await fetch(`${server.getBaseUrl()}/assets/lightbox.min.css`);
expect(lightboxCssResponse.status).toBe(200);
expect(lightboxCssResponse.headers.get('content-type')).toContain('text/css');
const lightboxJsResponse = await fetch(`${server.getBaseUrl()}/assets/lightbox.min.js`);
expect(lightboxJsResponse.status).toBe(200);
expect(lightboxJsResponse.headers.get('content-type')).toContain('application/javascript');
});
it('limits list routes to 50 posts', async () => {
const posts = Array.from({ length: 60 }).map((_, index) =>
makePost({
id: `p-${index + 1}`,
slug: `slug-${index + 1}`,
title: `Post ${index + 1}`,
createdAt: new Date(Date.UTC(2025, 0, 1, 0, 0, index)),
})
);
server = new PreviewServer({
postEngine: makeEngine(posts),
settingsEngine: makeSettings(50),
getActiveProjectContext: async () => ({ projectId: 'default' }),
});
await server.start(0);
const response = await fetch(`${server.getBaseUrl()}/`);
const html = await response.text();
const renderedPosts = (html.match(/<div class="post">/g) || []).length;
expect(renderedPosts).toBe(50);
});
it('supports year, month, and day archive routes', async () => {
const matchingDay = makePost({ id: 'd1', slug: 'day-post', title: 'Day Post', createdAt: new Date('2025-02-14T10:00:00.000Z') });
const sameMonth = makePost({ id: 'm1', slug: 'month-post', title: 'Month Post', createdAt: new Date('2025-02-10T10:00:00.000Z') });
const sameYear = makePost({ id: 'y1', slug: 'year-post', title: 'Year Post', createdAt: new Date('2025-08-01T10:00:00.000Z') });
const differentYear = makePost({ id: 'o1', slug: 'other', title: 'Other', createdAt: new Date('2024-02-14T10:00:00.000Z') });
server = new PreviewServer({
postEngine: makeEngine([matchingDay, sameMonth, sameYear, differentYear]),
settingsEngine: makeSettings(50),
getActiveProjectContext: async () => ({ projectId: 'default' }),
});
await server.start(0);
const yearHtml = await (await fetch(`${server.getBaseUrl()}/2025/`)).text();
expect(yearHtml).toContain('Day Post');
expect(yearHtml).toContain('Month Post');
expect(yearHtml).toContain('Year Post');
expect(yearHtml).not.toContain('Other');
const monthHtml = await (await fetch(`${server.getBaseUrl()}/2025/2/`)).text();
expect(monthHtml).toContain('Day Post');
expect(monthHtml).toContain('Month Post');
expect(monthHtml).not.toContain('Year Post');
const dayHtml = await (await fetch(`${server.getBaseUrl()}/2025/2/14/`)).text();
expect(dayHtml).toContain('Day Post');
expect(dayHtml).not.toContain('Month Post');
});
it('supports day-and-slug post route', async () => {
const post = makePost({ id: 'one', title: 'Single Post', slug: 'single-post', createdAt: new Date('2025-02-14T10:00:00.000Z') });
server = new PreviewServer({
postEngine: makeEngine([post]),
settingsEngine: makeSettings(50),
getActiveProjectContext: async () => ({ projectId: 'default' }),
});
await server.start(0);
const response = await fetch(`${server.getBaseUrl()}/2025/2/14/single-post/`);
expect(response.status).toBe(200);
const html = await response.text();
expect(html).toContain('Single Post');
});
it('supports tag, category, and page-slug routes', async () => {
const tagged = makePost({ id: 'tag1', title: 'Tagged', slug: 'tagged', tags: ['dev'] });
const categorized = makePost({ id: 'cat1', title: 'Categorized', slug: 'categorized', categories: ['news'] });
const page = makePost({ id: 'page1', title: 'About', slug: 'about', categories: ['page'] });
const regular = makePost({ id: 'post1', title: 'About Blog Post', slug: 'about', categories: ['blog'] });
server = new PreviewServer({
postEngine: makeEngine([tagged, categorized, page, regular]),
settingsEngine: makeSettings(50),
getActiveProjectContext: async () => ({ projectId: 'default' }),
});
await server.start(0);
const tagHtml = await (await fetch(`${server.getBaseUrl()}/tag/dev/`)).text();
expect(tagHtml).toContain('Tagged');
expect(tagHtml).not.toContain('Categorized');
const categoryHtml = await (await fetch(`${server.getBaseUrl()}/category/news/`)).text();
expect(categoryHtml).toContain('Categorized');
expect(categoryHtml).not.toContain('Tagged');
const pageResponse = await fetch(`${server.getBaseUrl()}/about/`);
expect(pageResponse.status).toBe(200);
const pageHtml = await pageResponse.text();
expect(pageHtml).toContain('About');
expect(pageHtml).not.toContain('About Blog Post');
});
it('uses max posts per page from preferences', async () => {
const posts = Array.from({ length: 20 }).map((_, index) =>
makePost({
id: `pref-${index + 1}`,
slug: `pref-slug-${index + 1}`,
title: `Pref Post ${index + 1}`,
createdAt: new Date(Date.UTC(2025, 0, 1, 0, 0, index)),
})
);
server = new PreviewServer({
postEngine: makeEngine(posts),
settingsEngine: makeSettings(7),
getActiveProjectContext: async () => ({ projectId: 'default' }),
});
await server.start(0);
const response = await fetch(`${server.getBaseUrl()}/`);
const html = await response.text();
const renderedPosts = (html.match(/<div class="post">/g) || []).length;
expect(renderedPosts).toBe(7);
});
it('uses project description from metadata in page title', async () => {
server = new PreviewServer({
postEngine: makeEngine([makePost()]),
settingsEngine: {
setProjectContext: vi.fn(),
async getProjectMetadata() {
return {
name: 'My Great Blog',
description: 'A wonderful publication',
maxPostsPerPage: 50,
};
},
},
getActiveProjectContext: async () => ({ projectId: 'default' }),
});
await server.start(0);
const response = await fetch(`${server.getBaseUrl()}/`);
expect(response.status).toBe(200);
const html = await response.text();
expect(html).toContain('<title>A wonderful publication</title>');
expect(html).not.toContain('<title>My Great Blog</title>');
expect(html).not.toContain('<title>Blog Preview</title>');
});
it('falls back to active project name in page title when metadata is unavailable', async () => {
server = new PreviewServer({
postEngine: makeEngine([makePost()]),
settingsEngine: {
setProjectContext: vi.fn(),
async getProjectMetadata() {
return null;
},
},
getActiveProjectContext: async () => ({
projectId: 'default',
dataDir: '/tmp/default',
projectName: 'Configured Project Name',
} as any),
});
await server.start(0);
const response = await fetch(`${server.getBaseUrl()}/`);
expect(response.status).toBe(200);
const html = await response.text();
expect(html).toContain('<title>Configured Project Name</title>');
expect(html).not.toContain('<title>Blog Preview</title>');
});
it('rewrites supported markdown links to preview-safe URLs while leaving external links unchanged', async () => {
const targetBySlug = makePost({
id: 'target-1',
slug: 'target-post',
title: 'Target Post',
createdAt: new Date('2025-02-14T10:00:00.000Z'),
content: '# Target',
});
const targetByYearMonth = makePost({
id: 'target-2',
slug: 'archive-post',
title: 'Archive Post',
createdAt: new Date('2025-02-10T10:00:00.000Z'),
content: '# Archive',
});
const legacyTarget = makePost({
id: 'target-3',
slug: 'legacy-post',
title: 'Legacy Post',
createdAt: new Date('2025-03-01T10:00:00.000Z'),
content: '# Legacy',
});
const post = makePost({
id: 'rewrite-1',
slug: 'rewrite-test',
title: 'Rewrite Test',
content: [
'[Post by slug](/posts/target-post)',
'[Post by year/month](/posts/2025/02/archive-post)',
'[Legacy post link](post/legacy-post)',
'![Local image](media/2025/02/example.jpg)',
'[External](https://example.com/path)',
].join('\n\n'),
});
server = new PreviewServer({
postEngine: makeEngine([post, targetBySlug, targetByYearMonth, legacyTarget]),
mediaEngine: makeMediaEngine([
{
id: 'media-guid-1',
filename: '3b94f5d1-91f5-4c9b-a8d4-6f3bf8f045cf.jpg',
originalName: 'example.jpg',
createdAt: new Date('2025-02-03T10:00:00.000Z'),
},
]) as any,
settingsEngine: makeSettings(50),
getActiveProjectContext: async () => ({ projectId: 'default' }),
});
await server.start(0);
const response = await fetch(`${server.getBaseUrl()}/`);
expect(response.status).toBe(200);
const html = await response.text();
expect(html).toContain('href="/2025/02/14/target-post"');
expect(html).toContain('href="/2025/02/10/archive-post"');
expect(html).toContain('href="/2025/03/01/legacy-post"');
expect(html).toContain('src="/media/2025/02/3b94f5d1-91f5-4c9b-a8d4-6f3bf8f045cf.jpg"');
expect(html).toContain('href="https://example.com/path"');
});
it('serves media files from the active project data directory at /media/...', async () => {
tempDir = await mkdtemp(path.join(tmpdir(), 'bds-preview-media-'));
const mediaDir = path.join(tempDir, 'media', '2025', '02');
await mkdir(mediaDir, { recursive: true });
await writeFile(path.join(mediaDir, 'sample.jpg'), Buffer.from('fake-image-bytes'));
server = new PreviewServer({
postEngine: makeEngine([makePost()]),
settingsEngine: makeSettings(50),
getActiveProjectContext: async () => ({
projectId: 'default',
dataDir: tempDir!,
}),
});
await server.start(0);
const response = await fetch(`${server.getBaseUrl()}/media/2025/02/sample.jpg`);
expect(response.status).toBe(200);
expect(response.headers.get('content-type')).toContain('image/jpeg');
const body = await response.text();
expect(body).toBe('fake-image-bytes');
});
it('uses published snapshot content and metadata for draft posts that have a published version', async () => {
const draftWithPublished = makePost({
id: 'draft-1',
status: 'draft',
title: 'Draft Title',
slug: 'draft-slug',
content: '# Draft content must not leak',
tags: ['draft-tag'],
categories: ['draft-category'],
createdAt: new Date('2025-02-14T10:00:00.000Z'),
});
const publishedSnapshot = makePost({
id: 'draft-1',
status: 'published',
title: 'Published Title',
slug: 'published-slug',
content: '# Published content only',
tags: ['published-tag'],
categories: ['page'],
createdAt: new Date('2025-02-14T10:00:00.000Z'),
});
const engine = makeEngine([draftWithPublished]);
engine.hasPublishedVersion = vi.fn(async (id: string) => id === 'draft-1');
engine.getPublishedVersion = vi.fn(async (id: string) => (id === 'draft-1' ? publishedSnapshot : null));
server = new PreviewServer({
postEngine: engine,
settingsEngine: makeSettings(50),
getActiveProjectContext: async () => ({ projectId: 'default' }),
});
await server.start(0);
const rootHtml = await (await fetch(`${server.getBaseUrl()}/`)).text();
expect(rootHtml).toContain('Published content only');
expect(rootHtml).not.toContain('Draft content must not leak');
const publishedSlugResponse = await fetch(`${server.getBaseUrl()}/posts/published-slug/`);
expect(publishedSlugResponse.status).toBe(200);
const draftSlugResponse = await fetch(`${server.getBaseUrl()}/posts/draft-slug/`);
expect(draftSlugResponse.status).toBe(404);
const publishedTagHtml = await (await fetch(`${server.getBaseUrl()}/tag/published-tag/`)).text();
expect(publishedTagHtml).toContain('Published content only');
const draftTagResponse = await fetch(`${server.getBaseUrl()}/tag/draft-tag/`);
expect(draftTagResponse.status).toBe(404);
const draftTagHtml = await draftTagResponse.text();
expect(draftTagHtml).not.toContain('Published content only');
});
it('discovers candidates via status-scoped DB filters for published and draft only', async () => {
const published = makePost({ id: 'pub-1', status: 'published', slug: 'pub-1', content: '# Published one' });
const draft = makePost({ id: 'draft-1', status: 'draft', slug: 'draft-1', content: '# Draft one' });
const getPostsFiltered = vi.fn(async (filter: PostFilter) => {
if (filter.status === 'published') return [published];
if (filter.status === 'draft') return [draft];
return [];
});
const engine: PostEngineLike = {
setProjectContext: vi.fn(),
getPostsFiltered,
getPost: vi.fn(async (id: string) => (id === published.id ? published : draft)),
hasPublishedVersion: vi.fn(async (id: string) => id === draft.id),
getPublishedVersion: vi.fn(async (id: string) => (id === draft.id
? makePost({ ...published, id: draft.id, slug: 'pub-draft', content: '# Published snapshot for draft' })
: null)),
};
server = new PreviewServer({
postEngine: engine,
settingsEngine: makeSettings(50),
getActiveProjectContext: async () => ({ projectId: 'default' }),
});
await server.start(0);
const response = await fetch(`${server.getBaseUrl()}/`);
expect(response.status).toBe(200);
const statusValues = getPostsFiltered.mock.calls.map((args) => args[0]?.status);
expect(statusValues.every((value) => value === 'published' || value === 'draft')).toBe(true);
expect(statusValues).toContain('published');
expect(statusValues).toContain('draft');
});
it('loads published filesystem content only for rendered posts', async () => {
const fullPublishedPosts = Array.from({ length: 60 }).map((_, index) =>
makePost({
id: `pub-full-${index + 1}`,
slug: `pub-full-${index + 1}`,
title: `Published Full ${index + 1}`,
content: `# Published Full ${index + 1}`,
status: 'published',
createdAt: new Date(Date.UTC(2025, 0, 1, 0, 0, index)),
})
);
const summaryPublishedPosts = fullPublishedPosts.map((post) => ({
...post,
content: '',
}));
const byId = new Map(fullPublishedPosts.map((post) => [post.id, post]));
const getPost = vi.fn(async (id: string) => byId.get(id) ?? null);
const engine: PostEngineLike = {
setProjectContext: vi.fn(),
getPost,
hasPublishedVersion: vi.fn(async () => false),
getPublishedVersion: vi.fn(async () => null),
getPostsFiltered: vi.fn(async (filter: PostFilter) => {
if (filter.status === 'published') {
return summaryPublishedPosts;
}
if (filter.status === 'draft') {
return [];
}
return [];
}),
};
server = new PreviewServer({
postEngine: engine,
settingsEngine: makeSettings(50),
getActiveProjectContext: async () => ({ projectId: 'default' }),
});
await server.start(0);
const response = await fetch(`${server.getBaseUrl()}/`);
expect(response.status).toBe(200);
expect(getPost).toHaveBeenCalledTimes(50);
});
});