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

refactor(extension): name the tab capture messages attach and detach, since pausing sends them too

Luis Ortizbb31c45d3e79
diff --git a/src/entrypoints/background/__tests__/pause-narration.test.ts b/src/entrypoints/background/__tests__/pause-narration.test.ts
index 0b95e45..c77fa8c 100644
--- a/src/entrypoints/background/__tests__/pause-narration.test.ts
+++ b/src/entrypoints/background/__tests__/pause-narration.test.ts
@@ -15,8 +15,8 @@ vi.mock('@/lib/browser-api', () => ({ getActiveTab: () => Promise.resolve({ id:
vi.mock('@/lib/logger', () => ({ logger: { info: vi.fn(), debug: vi.fn(), warn: vi.fn(), error: vi.fn() } }));
vi.mock('../tab-manager', () => ({
broadcastDismissBlur: vi.fn().mockResolvedValue(undefined),
- broadcastStartCapture: vi.fn().mockResolvedValue(undefined),
- broadcastStopCaptureAndFlush: vi.fn().mockResolvedValue(undefined),
+ broadcastAttachCapture: vi.fn().mockResolvedValue(undefined),
+ broadcastDetachCaptureAndFlush: vi.fn().mockResolvedValue(undefined),
injectContentScript: vi.fn().mockResolvedValue(undefined),
isInjectableTab: () => true,
}));
diff --git a/src/entrypoints/background/__tests__/pause.test.ts b/src/entrypoints/background/__tests__/pause.test.ts
index d068f9b..bbf3110 100644
--- a/src/entrypoints/background/__tests__/pause.test.ts
+++ b/src/entrypoints/background/__tests__/pause.test.ts
@@ -22,8 +22,8 @@ vi.mock('../actor', () => ({ getActor: () => actor }));
vi.mock('../tab-manager', () => ({
broadcastDismissBlur: record('dismissBlur'),
broadcastClearBlur: record('clearBlur'),
- broadcastStopCaptureAndFlush: vi.fn(record('flush')),
- broadcastStartCapture: record('startCapture'),
+ broadcastDetachCaptureAndFlush: vi.fn(record('flush')),
+ broadcastAttachCapture: record('attachCapture'),
injectContentScript: record('inject'),
isInjectableTab: (tab: { url?: string }) => !!tab.url?.startsWith('https://'),
}));
@@ -60,9 +60,9 @@ describe('pauseCapture', () => {
});
it('flushes the frames while still recording, so a click made just before the pause is kept', async () => {
- const { broadcastStopCaptureAndFlush } = await import('../tab-manager');
+ const { broadcastDetachCaptureAndFlush } = await import('../tab-manager');
let stateDuringFlush: string | null = null;
- vi.mocked(broadcastStopCaptureAndFlush).mockImplementationOnce(async () => {
+ vi.mocked(broadcastDetachCaptureAndFlush).mockImplementationOnce(async () => {
stateDuringFlush = actor.getSnapshot().value;
});
@@ -140,7 +140,7 @@ describe('resumeCapture', () => {
await resumeCapture();
- expect(calls).toEqual(['inject', 'startCapture']);
+ expect(calls).toEqual(['inject', 'attachCapture']);
});
it('skips injection on a tab that cannot take a content script', async () => {
@@ -150,7 +150,7 @@ describe('resumeCapture', () => {
await resumeCapture();
- expect(calls).toEqual(['startCapture']);
+ expect(calls).toEqual(['attachCapture']);
});
it('restarts narration only when the pause stopped it', async () => {
@@ -209,7 +209,7 @@ describe('resumeFromPause', () => {
await resumeFromPause();
- expect(calls.indexOf('dismissBlur')).toBeLessThan(calls.indexOf('startCapture'));
+ expect(calls.indexOf('dismissBlur')).toBeLessThan(calls.indexOf('attachCapture'));
});
it('still dismisses when there is nothing to resume', async () => {
diff --git a/src/entrypoints/background/__tests__/tab-manager.test.ts b/src/entrypoints/background/__tests__/tab-manager.test.ts
index 6ba856a..3fc62b7 100644
--- a/src/entrypoints/background/__tests__/tab-manager.test.ts
+++ b/src/entrypoints/background/__tests__/tab-manager.test.ts
@@ -13,8 +13,8 @@ vi.mock('@mimik/core/logger', () => ({ logger: { info: vi.fn(), debug: vi.fn(),
import {
broadcastClearBlur,
+ broadcastDetachCaptureAndFlush,
broadcastDismissBlur,
- broadcastStopCaptureAndFlush,
isInjectableTab,
} from '../tab-manager';
@@ -43,7 +43,7 @@ describe('blur broadcasts', () => {
});
});
-describe('broadcastStopCaptureAndFlush', () => {
+describe('broadcastDetachCaptureAndFlush', () => {
it('waits for every tab to answer before resolving', async () => {
let answered = 0;
sendMessageToTab.mockImplementation(
@@ -56,20 +56,20 @@ describe('broadcastStopCaptureAndFlush', () => {
}),
);
- await broadcastStopCaptureAndFlush();
+ await broadcastDetachCaptureAndFlush();
expect(answered).toBe(2);
- expect(typesSent()).toEqual(['STOP_CAPTURE', 'STOP_CAPTURE']);
+ expect(typesSent()).toEqual(['DETACH_CAPTURE', 'DETACH_CAPTURE']);
});
it('resolves even when a tab never answers', async () => {
sendMessageToTab.mockImplementation(() => new Promise(() => {}));
- await expect(broadcastStopCaptureAndFlush()).resolves.toBeUndefined();
+ await expect(broadcastDetachCaptureAndFlush()).resolves.toBeUndefined();
});
it('resolves when a tab rejects', async () => {
sendMessageToTab.mockRejectedValue(new Error('no receiving end'));
- await expect(broadcastStopCaptureAndFlush()).resolves.toBeUndefined();
+ await expect(broadcastDetachCaptureAndFlush()).resolves.toBeUndefined();
});
});
diff --git a/src/entrypoints/background/index.ts b/src/entrypoints/background/index.ts
index c182c0f..b79f10e 100644
--- a/src/entrypoints/background/index.ts
+++ b/src/entrypoints/background/index.ts
@@ -35,10 +35,10 @@ import { registerNavigationListeners } from './navigation';
import { pauseCapture, resumeFromPause, whenPauseSettled } from './pause';
import { handleCaptureStep, handleFinalizeInputStep, handleUpdateInputStep } from './step-pipeline';
import {
+ broadcastAttachCapture,
broadcastClearBlur,
- broadcastStartCapture,
- broadcastStopCapture,
- broadcastStopCaptureAndFlush,
+ broadcastDetachCapture,
+ broadcastDetachCaptureAndFlush,
isInjectableTab,
showNotificationOnTab,
} from './tab-manager';
@@ -150,7 +150,7 @@ export default defineBackground(() => {
await startVoiceNarration(activeTab?.id);
- await broadcastStartCapture(guideId);
+ await broadcastAttachCapture(guideId);
return { guideId };
});
@@ -159,7 +159,7 @@ export default defineBackground(() => {
await whenPauseSettled();
const actor = getActor();
const { currentGuideId: guideId, insertTargetGuideId, insertAtIndex } = actor.getSnapshot().context;
- await broadcastStopCaptureAndFlush();
+ await broadcastDetachCaptureAndFlush();
await broadcastClearBlur();
actor.send({ type: 'STOP_RECORDING' });
@@ -182,7 +182,7 @@ export default defineBackground(() => {
await whenPauseSettled();
const actor = getActor();
const { currentGuideId: guideId, insertTargetGuideId } = actor.getSnapshot().context;
- await broadcastStopCapture();
+ await broadcastDetachCapture();
await broadcastClearBlur();
actor.send({ type: 'STOP_RECORDING' });
await abortVoiceNarration();
diff --git a/src/entrypoints/background/pause.ts b/src/entrypoints/background/pause.ts
index 12fd6ba..38012ac 100644
--- a/src/entrypoints/background/pause.ts
+++ b/src/entrypoints/background/pause.ts
@@ -3,9 +3,9 @@ import { CaptureState, type PauseReason } from '@/core/capture/machine';
import { getActiveTab } from '@/lib/browser-api/get-active-tab';
import { getActor } from './actor';
import {
+ broadcastAttachCapture,
+ broadcastDetachCaptureAndFlush,
broadcastDismissBlur,
- broadcastStartCapture,
- broadcastStopCaptureAndFlush,
injectContentScript,
isInjectableTab,
} from './tab-manager';
@@ -45,7 +45,7 @@ async function pauseAndStopNarration(reason: PauseReason): Promise<boolean> {
if (actor.getSnapshot().value !== CaptureState.RECORDING) return false;
const narrationWasLive = (await isNarrationLive()) || isNarrationSettling();
- await broadcastStopCaptureAndFlush();
+ await broadcastDetachCaptureAndFlush();
if (actor.getSnapshot().value !== CaptureState.RECORDING) return false;
actor.send({ type: 'PAUSE_CAPTURE', reason, narrationWasLive });
@@ -66,7 +66,7 @@ export async function resumeCapture(tryStartNarration?: NarrationStarter): Promi
if (guideId) {
const activeTab = await getActiveTab();
if (activeTab?.id && isInjectableTab(activeTab)) await injectContentScript(activeTab.id);
- await broadcastStartCapture(guideId);
+ await broadcastAttachCapture(guideId);
}
if (narrationWasLive && tryStartNarration) {
diff --git a/src/entrypoints/background/tab-manager.ts b/src/entrypoints/background/tab-manager.ts
index edfc838..75c9b42 100644
--- a/src/entrypoints/background/tab-manager.ts
+++ b/src/entrypoints/background/tab-manager.ts
@@ -27,16 +27,16 @@ export async function showNotificationOnTab(tabId: number): Promise<void> {
}
}
-export async function broadcastStartCapture(guideId: string): Promise<void> {
+export async function broadcastAttachCapture(guideId: string): Promise<void> {
try {
const tabs = await queryTabs({});
for (const tab of tabs) {
if (tab.id && isInjectableTab(tab)) {
- sendMessageToTab(tab.id, { type: TabMessage.START_CAPTURE, guideId }).catch(() => {});
+ sendMessageToTab(tab.id, { type: TabMessage.ATTACH_CAPTURE, guideId }).catch(() => {});
}
}
} catch (err) {
- logger.warn(' broadcastStartCapture failed', err);
+ logger.warn(' broadcastAttachCapture failed', err);
}
}
@@ -63,28 +63,28 @@ async function broadcastBlur(type: TabMessageType): Promise<void> {
const FLUSH_TIMEOUT_MS = 1500;
-export async function broadcastStopCaptureAndFlush(): Promise<void> {
+export async function broadcastDetachCaptureAndFlush(): Promise<void> {
try {
const tabs = await queryTabs({});
const sends = tabs
.filter((tab): tab is typeof tab & { id: number } => tab.id !== undefined)
- .map((tab) => sendMessageToTab(tab.id, { type: TabMessage.STOP_CAPTURE }).catch(() => {}));
+ .map((tab) => sendMessageToTab(tab.id, { type: TabMessage.DETACH_CAPTURE }).catch(() => {}));
const timeout = new Promise<void>((resolve) => setTimeout(resolve, FLUSH_TIMEOUT_MS));
await Promise.race([Promise.allSettled(sends), timeout]);
} catch (err) {
- logger.warn(' broadcastStopCaptureAndFlush failed', err);
+ logger.warn(' broadcastDetachCaptureAndFlush failed', err);
}
}
-export async function broadcastStopCapture(): Promise<void> {
+export async function broadcastDetachCapture(): Promise<void> {
try {
const tabs = await queryTabs({});
for (const tab of tabs) {
if (tab.id) {
- sendMessageToTab(tab.id, { type: TabMessage.STOP_CAPTURE }).catch(() => {});
+ sendMessageToTab(tab.id, { type: TabMessage.DETACH_CAPTURE }).catch(() => {});
}
}
} catch (err) {
- logger.warn(' broadcastStopCapture failed', err);
+ logger.warn(' broadcastDetachCapture failed', err);
}
}
diff --git a/src/entrypoints/content.ts b/src/entrypoints/content.ts
index 82dc780..23657ff 100644
--- a/src/entrypoints/content.ts
+++ b/src/entrypoints/content.ts
@@ -27,14 +27,14 @@ function createTabMessageHandler(session: CaptureSession, guideMe: GuideMeContro
sendResponse({ alive: true, capturing: session.isActive });
return true;
- case TabMessage.START_CAPTURE:
+ case TabMessage.ATTACH_CAPTURE:
if (msg.guideId) {
session.start(msg.guideId as string);
sendResponse({ started: true });
}
return true;
- case TabMessage.STOP_CAPTURE:
+ case TabMessage.DETACH_CAPTURE:
session.stop().then(() => sendResponse({ stopped: true }));
return true;
diff --git a/src/lib/tab-messages.ts b/src/lib/tab-messages.ts
index 7307e42..cf50ede 100644
--- a/src/lib/tab-messages.ts
+++ b/src/lib/tab-messages.ts
@@ -1,7 +1,7 @@
export const TabMessage = {
PING: 'PING',
- START_CAPTURE: 'START_CAPTURE',
- STOP_CAPTURE: 'STOP_CAPTURE',
+ ATTACH_CAPTURE: 'ATTACH_CAPTURE',
+ DETACH_CAPTURE: 'DETACH_CAPTURE',
GET_ROUTE: 'GET_ROUTE',
URL_CHANGED: 'URL_CHANGED',
SHOW_NOTIFICATION: 'SHOW_NOTIFICATION',