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

fix(capture): apply typing, key and colour settings to a running recording in the extension

Luis Ortizc295bc83f4c4
diff --git a/apps/extension/src/capture/events/__tests__/live-settings.test.ts b/apps/extension/src/capture/events/__tests__/live-settings.test.ts
new file mode 100644
index 0000000..ee6d5b1
--- /dev/null
+++ b/apps/extension/src/capture/events/__tests__/live-settings.test.ts
@@ -0,0 +1,74 @@
+// @vitest-environment happy-dom
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { browser } from '#imports';
+import type { CaptureSink, CaptureStepData } from '@/core/capture/sink';
+import { type CaptureHandle, startCapture } from '../handlers';
+
+vi.mock('@/lib/browser-api/local-storage', () => ({
+ localStorage: { get: vi.fn().mockResolvedValue({}), set: vi.fn().mockResolvedValue(undefined) },
+}));
+
+let handle: CaptureHandle;
+let captured: CaptureStepData[];
+
+const sink: CaptureSink = {
+ captureStep: async (data) => {
+ captured.push(data);
+ return { stepId: `step-${captured.length}` };
+ },
+ updateInputStep: async () => ({ updated: true }),
+ finalizeInputStep: async () => ({ updated: true }),
+};
+
+function pressCtrlK(on: Element) {
+ on.dispatchEvent(new KeyboardEvent('keydown', { key: 'k', ctrlKey: true, bubbles: true, cancelable: true }));
+}
+
+async function settle(turns = 16) {
+ for (let i = 0; i < turns; i++) await new Promise((resolve) => setTimeout(resolve, 0));
+}
+
+beforeEach(async () => {
+ await browser.storage.local.clear();
+ document.body.innerHTML = '';
+ captured = [];
+ vi.stubGlobal('requestAnimationFrame', (cb: FrameRequestCallback) => {
+ setTimeout(() => cb(0), 0);
+ return 0;
+ });
+});
+
+afterEach(() => {
+ handle?.stop();
+ vi.unstubAllGlobals();
+});
+
+describe('settings changed during a recording', () => {
+ it('starts recording shortcuts the moment Record keys is switched on, named with the held keys', async () => {
+ handle = startCapture('guide-1', true, sink);
+ const button = document.body.appendChild(document.createElement('button'));
+ await settle();
+
+ pressCtrlK(button);
+ await settle();
+ expect(captured).toHaveLength(0);
+
+ await browser.storage.local.set({ recordKeys: true });
+ pressCtrlK(button);
+ await settle();
+
+ expect(captured.map((step) => step.action)).toEqual(['keydown:Ctrl+K']);
+ });
+
+ it('ignores setting changes once the recording stops', async () => {
+ handle = startCapture('guide-1', true, sink);
+ const button = document.body.appendChild(document.createElement('button'));
+ await handle.stop();
+
+ await browser.storage.local.set({ recordKeys: true });
+ pressCtrlK(button);
+ await settle();
+
+ expect(captured).toHaveLength(0);
+ });
+});
diff --git a/apps/extension/src/capture/events/handlers.ts b/apps/extension/src/capture/events/handlers.ts
index d496582..4e41251 100644
--- a/apps/extension/src/capture/events/handlers.ts
+++ b/apps/extension/src/capture/events/handlers.ts
@@ -1,5 +1,6 @@
import { logger } from '@mimik/core/logger';
import PQueue from 'p-queue';
+import { browser } from '#imports';
import { extensionCaptureSink } from '@/capture/sink';
import { extractDOMContext } from '@/core/capture/dom/context';
import { extractElementMeta, freezeRect } from '@/core/capture/dom/element-meta';
@@ -74,6 +75,12 @@ class CaptureController {
private busy = false;
private recordKeys = false;
private recordTyping = true;
+ private readonly onSettingsChanged = (changes: Record<string, { newValue?: unknown }>) => {
+ if (changes.recordKeys) this.recordKeys = changes.recordKeys.newValue === true;
+ if (changes.recordTyping) this.recordTyping = changes.recordTyping.newValue !== false;
+ const color = changes.targetColor?.newValue;
+ if (typeof color === 'string' && color) this.ring.setColor(color);
+ };
constructor(
private guideId: string,
@@ -113,6 +120,7 @@ class CaptureController {
this.recordTyping = recordTyping !== false;
})
.catch(() => {});
+ browser.storage.local.onChanged.addListener(this.onSettingsChanged);
for (const [event, handler, opts] of this.listeners) {
window.addEventListener(event, handler, opts);
}
@@ -334,6 +342,7 @@ class CaptureController {
}
stop(): Promise<void> {
+ browser.storage.local.onChanged.removeListener(this.onSettingsChanged);
for (const [event, handler, opts] of this.listeners) {
window.removeEventListener(event, handler, opts);
}