π¬ A browser extension and desktop app that turns your clicks into step-by-step guides with annotated screenshots π
TypeScript browser-extensionchrome-extensiondocumentationfirefox-extensionguide-generatorlocal-firstmanifest-v3privacy-firstproductivityreactscreenshotstep-by-step-guidetutorialtypescriptworkflowwxt
perf(export): reuse rendered screenshots across html exports
Luis Ortiz40715fe56bc2
diff --git a/src/core/export/__tests__/html-export.test.ts b/src/core/export/__tests__/html-export.test.tsnew file mode 100644index 0000000..a0c6fbc--- /dev/null+++ b/src/core/export/__tests__/html-export.test.ts@@ -0,0 +1,97 @@+// @vitest-environment jsdom+import { beforeEach, describe, expect, it, vi } from 'vitest';+import { exportGuideAsHTML } from '@/core/export/html-export';+import { DEFAULT_EXPORT_OPTIONS } from '@/core/export/options';+import type { Guide, Screenshot, Step } from '@/core/guides/types';++const rendered = vi.hoisted(() => vi.fn());++vi.mock('@/core/screenshot/render', () => ({ renderScreenshot: rendered }));++const guide: Guide = {+ id: 'guide-1',+ title: 'Test Guide',+ createdAt: new Date('2025-06-01T00:00:00Z').getTime(),+ updatedAt: new Date('2025-06-01T00:00:00Z').getTime(),+ stepIds: [],+ starred: false,+ deletedAt: null,+};++function makeStep(index: number): Step {+ return {+ id: `step-${index}`,+ guideId: 'guide-1',+ index,+ description: `Click the button ${index}`,+ action: 'click',+ url: 'https://example.com/page',+ createdAt: guide.createdAt,+ } as Step;+}++function makeScreenshot(stepId: string, edits?: Screenshot['edits']): Screenshot {+ return {+ id: `shot-${stepId}`,+ stepId,+ guideId: 'guide-1',+ blob: new Blob(['raw'], { type: 'image/png' }),+ createdAt: guide.createdAt,+ edits,+ } as Screenshot;+}++function render(steps: Step[], screenshots: Map<string, Screenshot>) {+ return exportGuideAsHTML(guide, steps, screenshots, DEFAULT_EXPORT_OPTIONS);+}++describe('exportGuideAsHTML screenshot embedding', () => {+ beforeEach(() => {+ rendered.mockReset();+ rendered.mockImplementation(async () => new Blob(['rendered'], { type: 'image/webp' }));+ });++ it('renders every step, with no cap', async () => {+ const steps = Array.from({ length: 50 }, (_, i) => makeStep(i));+ const screenshots = new Map(steps.map((s) => [s.id, makeScreenshot(s.id)]));++ const html = await render(steps, screenshots);++ expect(rendered).toHaveBeenCalledTimes(50);+ expect(html.match(/data-step="/g)).toHaveLength(50);+ expect(html).toContain('data-step="50"');+ });++ it('reuses the rendered image when the same screenshot is exported again', async () => {+ const steps = [makeStep(0)];+ const screenshots = new Map([[steps[0].id, makeScreenshot(steps[0].id)]]);++ await render(steps, screenshots);+ await render(steps, screenshots);++ expect(rendered).toHaveBeenCalledTimes(1);+ });++ it('re-renders when the screenshot edits change', async () => {+ const steps = [makeStep(0)];+ const shot = makeScreenshot(steps[0].id, { annotations: [] } as unknown as Screenshot['edits']);+ const screenshots = new Map([[steps[0].id, shot]]);++ await render(steps, screenshots);+ shot.edits = { annotations: [{ id: 'a' }] } as unknown as Screenshot['edits'];+ await render(steps, screenshots);++ expect(rendered).toHaveBeenCalledTimes(2);+ });++ it('does not cache a failed render', async () => {+ const steps = [makeStep(0)];+ const screenshots = new Map([[steps[0].id, makeScreenshot(steps[0].id)]]);++ rendered.mockRejectedValueOnce(new Error('decode failed'));+ await expect(render(steps, screenshots)).rejects.toThrow('decode failed');++ await render(steps, screenshots);+ expect(rendered).toHaveBeenCalledTimes(2);+ });+});diff --git a/src/core/export/html-export.ts b/src/core/export/html-export.tsindex 80d2082..6d88d51 100644--- a/src/core/export/html-export.ts+++ b/src/core/export/html-export.ts@@ -9,6 +9,26 @@ import { renderScreenshot } from '@/core/screenshot/render';const LOGO_MAX_WIDTH = 148;const LOGO_MAX_HEIGHT = 56;+interface EmbeddedImage {+ type: string;+ b64: string;+}++const imageCache = new WeakMap<Screenshot, { edits: unknown; image: Promise<EmbeddedImage> }>();++function embedScreenshot(screenshot: Screenshot): Promise<EmbeddedImage> {+ const cached = imageCache.get(screenshot);+ if (cached && cached.edits === screenshot.edits) return cached.image;++ const image = renderScreenshot(screenshot).then(async (rendered) => ({+ type: rendered.type,+ b64: await blobToBase64(rendered),+ }));+ image.catch(() => imageCache.delete(screenshot));+ imageCache.set(screenshot, { edits: screenshot.edits, image });+ return image;+}+function blockSection(step: Step): string {if (step.blockType === 'heading') {return `@@ -59,10 +79,9 @@ export async function exportGuideAsHTML(const screenshot = opts.screenshots ? screenshots.get(step.id) : undefined;let imgHtml = '';if (screenshot) {- const rendered = await renderScreenshot(screenshot);- const b64 = await blobToBase64(rendered);+ const { type, b64 } = await embedScreenshot(screenshot);const altText = screenshot.edits?.alt || i18n.t('export.stepLabel', [String(number)]);- imgHtml = `<img src="data:${rendered.type};base64,${b64}" alt="${escapeHtml(altText)}" style="display:block;width:${imgWidthPct}%;margin-top:14px;border:1px solid #CBD5E1;" />`;+ imgHtml = `<img src="data:${type};base64,${b64}" alt="${escapeHtml(altText)}" style="display:block;width:${imgWidthPct}%;margin-top:14px;border:1px solid #CBD5E1;" />`;}const stepNumber = String(number).padStart(2, '0');