Skip to content

armgit / mimik

Public Imported from GitHub
0

🎬 A browser extension and desktop app that turns your clicks into step-by-step guides with annotated screenshots πŸ“–

perf(ui): keep a thumbnail drawn between visits to the library

Luis Ortiz9abb8cdd5adb
diff --git a/packages/ui/src/guide/components/ScreenshotView.tsx b/packages/ui/src/guide/components/ScreenshotView.tsx
index da323e8..e91bda9 100644
--- a/packages/ui/src/guide/components/ScreenshotView.tsx
+++ b/packages/ui/src/guide/components/ScreenshotView.tsx
@@ -19,6 +19,7 @@ import {
} from '../../components/ui/dropdown-menu';
import { Popover, PopoverContent, PopoverTrigger } from '../../components/ui/popover';
import { Tooltip, TooltipContent, TooltipTrigger } from '../../components/ui/tooltip';
+import { renderKey } from '../lib/render-key';
import { withFullViewport } from '../lib/with-full-viewport';
import { ImagePlaceholder } from './ImagePlaceholder';
import { ReplaceImageDialog } from './ReplaceImageDialog';
@@ -31,6 +32,7 @@ interface ScreenshotViewProps {
crop?: boolean;
frameRatio?: number;
readOnly?: boolean;
+ cache?: boolean;
onOpenEditor?: (tool: 'annotate' | 'redact' | 'crop' | 'target') => void;
onChanged?: () => void;
}
@@ -51,6 +53,8 @@ const VIEWPORT_EPSILON = 0.5;
const FRAME_EASING = 'cubic-bezier(0.22, 1, 0.36, 1)';
const FRAME_TRANSITION = `width 0.4s ${FRAME_EASING}, height 0.4s ${FRAME_EASING}, left 0.4s ${FRAME_EASING}, top 0.4s ${FRAME_EASING}`;
const FRAME_RATIO_EPSILON = 0.01;
+const RENDERED = new Map<string, string>();
+const RENDERED_LIMIT = 48;
export function ScreenshotView({
screenshot,
@@ -60,11 +64,15 @@ export function ScreenshotView({
crop = false,
frameRatio,
readOnly = false,
+ cache = false,
onOpenEditor,
onChanged,
}: ScreenshotViewProps) {
- const [fullUrl, setFullUrl] = useState<string | null>(null);
- const [showViewport, setShowViewport] = useState(false);
+ const [fullUrl, setFullUrl] = useState<string | null>(() => {
+ const key = cache ? renderKey(screenshot, screenshot.edits) : null;
+ return key ? (RENDERED.get(key) ?? null) : null;
+ });
+ const [showViewport, setShowViewport] = useState(!animate && fullUrl !== null);
const [editsOverride, setEditsOverride] = useState<ScreenshotEdits | undefined>(undefined);
const [screenshotOverride, setScreenshotOverride] = useState<Screenshot | null>(null);
const [deleted, setDeleted] = useState(false);
@@ -72,7 +80,7 @@ export function ScreenshotView({
const [altDraft, setAltDraft] = useState('');
const [confirmDelete, setConfirmDelete] = useState(false);
const [replaceOpen, setReplaceOpen] = useState(false);
- const processedKeyRef = useRef<string | null>(null);
+ const processedKeyRef = useRef<string | null>(fullUrl ? renderKey(screenshot, screenshot.edits) : null);
const urlRef = useRef<string | null>(null);
const propScreenshotRef = useRef(screenshot);
const saveTimerRef = useRef<ReturnType<typeof setTimeout> | null>(null);
@@ -100,9 +108,15 @@ export function ScreenshotView({
const targetForRender = effectiveEdits?.target;
useEffect(() => {
- if (!baseScreenshot.blob) return;
- const cacheKey = `${baseScreenshot.id}:${baseScreenshot.blob.size}:${JSON.stringify(annotationsForRender ?? null)}:${JSON.stringify(targetForRender ?? null)}`;
- if (processedKeyRef.current === cacheKey) return;
+ const cacheKey = renderKey(baseScreenshot, { annotations: annotationsForRender, target: targetForRender });
+ if (!cacheKey || processedKeyRef.current === cacheKey) return;
+ const hit = cache ? RENDERED.get(cacheKey) : undefined;
+ if (hit) {
+ processedKeyRef.current = cacheKey;
+ setShowViewport(false);
+ setFullUrl(hit);
+ return;
+ }
let cancelled = false;
const current: Screenshot = {
@@ -120,8 +134,17 @@ export function ScreenshotView({
}
processedKeyRef.current = cacheKey;
- if (urlRef.current) URL.revokeObjectURL(urlRef.current);
- urlRef.current = newUrl;
+ if (cache) {
+ RENDERED.set(cacheKey, newUrl);
+ const oldest = RENDERED.size > RENDERED_LIMIT ? RENDERED.entries().next().value : undefined;
+ if (oldest) {
+ RENDERED.delete(oldest[0]);
+ URL.revokeObjectURL(oldest[1]);
+ }
+ } else {
+ if (urlRef.current) URL.revokeObjectURL(urlRef.current);
+ urlRef.current = newUrl;
+ }
setShowViewport(false);
setFullUrl(newUrl);
})();
@@ -129,7 +152,7 @@ export function ScreenshotView({
return () => {
cancelled = true;
};
- }, [baseScreenshot, annotationsForRender, targetForRender]);
+ }, [baseScreenshot, annotationsForRender, targetForRender, cache]);
useEffect(() => {
if (!fullUrl || showViewport) return;
diff --git a/packages/ui/src/guide/components/__tests__/screenshot-view-cache.test.tsx b/packages/ui/src/guide/components/__tests__/screenshot-view-cache.test.tsx
new file mode 100644
index 0000000..022e205
--- /dev/null
+++ b/packages/ui/src/guide/components/__tests__/screenshot-view-cache.test.tsx
@@ -0,0 +1,39 @@
+// @vitest-environment jsdom
+
+import type { Screenshot } from '@mimik/core/guides/types';
+import { render, waitFor } from '@testing-library/react';
+import { describe, expect, it, vi } from 'vitest';
+
+const renderScreenshot = vi.fn(async () => new Blob(['png'], { type: 'image/png' }));
+
+vi.mock('@mimik/core/screenshot/render', () => ({
+ renderScreenshot: () => renderScreenshot(),
+ imageDimensions: vi.fn(),
+}));
+
+let next = 0;
+URL.createObjectURL = () => `blob:shot-${++next}`;
+URL.revokeObjectURL = () => {};
+
+import { ScreenshotView } from '../ScreenshotView';
+
+const shot: Screenshot = {
+ id: 'shot-1',
+ stepId: 'step-1',
+ blob: new Blob(['raw']),
+ mimeType: 'image/png',
+ width: 1600,
+ height: 900,
+};
+
+describe('ScreenshotView cache', () => {
+ it('draws a cached thumbnail once and shows it on the first render of the next mount', async () => {
+ const first = render(<ScreenshotView screenshot={shot} cache readOnly />);
+ await waitFor(() => expect(first.container.querySelector('img')).not.toBeNull());
+ first.unmount();
+
+ const second = render(<ScreenshotView screenshot={{ ...shot, blob: new Blob(['raw']) }} cache readOnly />);
+ expect(second.container.querySelector('img')?.getAttribute('src')).toBe('blob:shot-1');
+ expect(renderScreenshot).toHaveBeenCalledTimes(1);
+ });
+});
diff --git a/packages/ui/src/guide/lib/render-key.ts b/packages/ui/src/guide/lib/render-key.ts
new file mode 100644
index 0000000..103f973
--- /dev/null
+++ b/packages/ui/src/guide/lib/render-key.ts
@@ -0,0 +1,7 @@
+import type { Screenshot } from '@mimik/core/guides/types';
+import type { ScreenshotEdits } from '@mimik/core/screenshot/types';
+
+export function renderKey(screenshot: Screenshot, edits: ScreenshotEdits | undefined): string | null {
+ if (!screenshot.blob) return null;
+ return `${screenshot.id}:${screenshot.blob.size}:${JSON.stringify(edits?.annotations ?? null)}:${JSON.stringify(edits?.target ?? null)}`;
+}