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 πŸ“–

test(desktop): cover the screenshot scheme, the sweep and finishing a recording

Luis Ortiz244e781c37a7
diff --git a/apps/desktop/scripts/check-overlay.ts b/apps/desktop/scripts/check-overlay.ts
index 49fbb85..63f8a18 100644
--- a/apps/desktop/scripts/check-overlay.ts
+++ b/apps/desktop/scripts/check-overlay.ts
@@ -102,6 +102,18 @@ app.whenReady().then(async () => {
commands.includes('pause') && overlay.state === 'paused',
`commands: ${commands.join(', ')}; state is ${overlay.state}`,
);
+ await windowWithHash('controls')?.webContents.executeJavaScript(
+ "document.querySelectorAll('button')[document.querySelectorAll('button').length - 1].click()",
+ );
+ await settle();
+ check(
+ 'finishing hides the area and the controls',
+ overlay.state === 'hidden' && overlayWindows().every((w) => !w.isVisible()),
+ `state is ${overlay.state}; ${overlayWindows().filter((w) => w.isVisible()).length} window(s) still visible`,
+ );
+ overlay.arm();
+ await settle();
+
let hiddenDuringCapture = false;
await overlay.withHidden(async () => {
hiddenDuringCapture = overlayWindows().every((w) => !w.isVisible());
diff --git a/apps/desktop/scripts/check-pipeline.ts b/apps/desktop/scripts/check-pipeline.ts
index 34d9658..12a4b57 100644
--- a/apps/desktop/scripts/check-pipeline.ts
+++ b/apps/desktop/scripts/check-pipeline.ts
@@ -1,8 +1,10 @@
+import { randomUUID } from 'node:crypto';
import { join } from 'node:path';
-import { app, BrowserWindow, nativeImage, screen } from 'electron';
+import { app, BrowserWindow, nativeImage, protocol, screen } from 'electron';
import { ask } from '../src/main/ask';
import { DesktopRecorder, shouldCapture } from '../src/main/capture/recorder';
import { clampToDisplays } from '../src/main/capture/region';
+import { registerScreenshotProtocol, SCREENSHOT_SCHEME, sweepScreenshots } from '../src/main/capture/screenshot-store';
import { DEFAULT_CAPTURE_SETTINGS, loadSettings, normaliseSettings, saveSettings } from '../src/main/capture/settings';
import type { Capture } from '../src/main/capture/screenshot';
@@ -20,10 +22,15 @@ function bail(error: unknown): never {
setTimeout(() => bail(new Error('check did not finish within 120s')), 120_000).unref();
+protocol.registerSchemesAsPrivileged([
+ { scheme: SCREENSHOT_SCHEME, privileges: { standard: true, secure: true, supportFetchAPI: true } },
+]);
+
app.disableHardwareAcceleration();
app.on('window-all-closed', () => {});
app.whenReady().then(async () => {
+ registerScreenshotProtocol();
const win = new BrowserWindow({
show: false,
webPreferences: { preload: join(__dirname, '../preload/index.cjs'), contextIsolation: true },
@@ -106,13 +113,17 @@ app.whenReady().then(async () => {
settings = { ...DEFAULT_CAPTURE_SETTINGS, showCursor: true, cursorStyle: 'arrow', screenshotDelayMs: 0 };
await recorder.capture({ x: region.x + 200, y: region.y + 150 });
- const cursorSizes = await ask<number[]>(win.webContents, 'mimik:check:blobSizes', activeGuide, 30_000);
+ const cursorSizes = await ask<number[]>(win.webContents, 'mimik:check:renderedSizes', activeGuide, 30_000);
+ const bare = cursorSizes[cursorSizes.length - 2] ?? 0;
+ const drawn = cursorSizes[cursorSizes.length - 1] ?? 0;
results.push({
- name: 'cursor is drawn into the frame',
- ok: cursorSizes.length >= 2 && cursorSizes[cursorSizes.length - 1] !== cursorSizes[0],
- detail: `${cursorSizes[0]} bytes without a cursor, ${cursorSizes[cursorSizes.length - 1]} bytes with one`,
+ name: 'cursor is drawn when rendered',
+ ok: bare > 0 && drawn > 0 && bare !== drawn,
+ detail: `${bare} bytes rendered without a cursor, ${drawn} bytes with one`,
});
+ const probeSrc = await ask<string | null>(win.webContents, 'mimik:check:screenshotSrc', activeGuide, 20_000);
+
await ask(win.webContents, 'mimik:check:cleanup', [guideId, activeGuide], 30_000);
const app_ = new BrowserWindow({
@@ -149,6 +160,24 @@ app.whenReady().then(async () => {
detail: titled,
});
+ const probe = probeSrc ?? `${SCREENSHOT_SCHEME}://${randomUUID()}`;
+ const fetched = await app_.webContents.executeJavaScript(
+ `fetch(${JSON.stringify(probe)}).then(r => r.ok ? r.blob().then(b => 'ok ' + b.size + ' bytes') : 'status ' + r.status).catch(e => 'threw ' + e.message)`,
+ );
+ results.push({
+ name: 'the app window can reach the scheme',
+ ok: typeof fetched === 'string' && fetched.startsWith('ok '),
+ detail: String(fetched),
+ });
+
+ const kept = await ask<string[]>(win.webContents, 'mimik:check:screenshotIds', undefined, 20_000);
+ const swept = sweepScreenshots(kept);
+ results.push({
+ name: 'deleted guides leave no files',
+ ok: sweepScreenshots(kept) === 0,
+ detail: `${swept} orphaned file(s) removed, none left behind`,
+ });
+
const stopped = 'bc4e4a1e-0000-4000-8000-000000000001';
app_.webContents.send('mimik:capture:command', 'stop', 'idle', region, stopped);
let shown = 'no navigation';
diff --git a/apps/desktop/src/renderer/check-pipeline.ts b/apps/desktop/src/renderer/check-pipeline.ts
index 0e5f665..79b153a 100644
--- a/apps/desktop/src/renderer/check-pipeline.ts
+++ b/apps/desktop/src/renderer/check-pipeline.ts
@@ -4,8 +4,9 @@ import { exportGuideAsDOCX } from '@mimik/core/export/docx-export';
import { exportGuideAsHTML } from '@mimik/core/export/html-export';
import { exportGuideAsMarkdown } from '@mimik/core/export/markdown-export';
import { exportGuideAsPDF } from '@mimik/core/export/pdf-export';
-import { getGuide, permanentlyDeleteGuide } from '@mimik/core/guides/service';
+import { allScreenshotIds, getGuide, permanentlyDeleteGuide } from '@mimik/core/guides/service';
import { elementSource } from '@mimik/core/guides/types';
+import { renderScreenshot } from '@mimik/core/screenshot/render';
import { DesktopCaptureSink } from './capture-sink';
interface CheckResult {
@@ -19,12 +20,28 @@ const sink = new DesktopCaptureSink();
window.mimik.onRequest('mimik:capture:startGuide', () => sink.startGuide());
window.mimik.onRequest('mimik:capture:step', (payload) => sink.captureStep(payload as CaptureStepData));
-window.mimik.onRequest('mimik:check:blobSizes', async (payload) => {
+window.mimik.onRequest('mimik:check:renderedSizes', async (payload) => {
const found = await getGuide(payload as string);
if (!found) return [];
- return found.steps.map((step) => found.screenshots.get(step.id)?.blob.size ?? 0);
+ const sizes: number[] = [];
+ for (const step of found.steps) {
+ const shot = found.screenshots.get(step.id);
+ if (!shot) continue;
+ const bare = await renderScreenshot({ ...shot, edits: { ...shot.edits, cursor: null } });
+ const drawn = await renderScreenshot(shot);
+ sizes.push(bare.size, drawn.size);
+ }
+ return sizes;
});
+window.mimik.onRequest('mimik:check:screenshotSrc', async (payload) => {
+ const found = await getGuide(payload as string);
+ const first = found ? [...found.screenshots.values()][0] : undefined;
+ return first?.src ?? null;
+});
+
+window.mimik.onRequest('mimik:check:screenshotIds', () => allScreenshotIds());
+
window.mimik.onRequest('mimik:check:cleanup', async (payload) => {
for (const id of payload as string[]) await permanentlyDeleteGuide(id);
return true;