repositories / pi-ext

pi-ext

bugabingas pi extensions

owned by bugabinga

Add ui browser telemetry worker

0ddb107f8d9e09d4416f5935381c9428283f8cba

Oliver Krylow <o.krylow@isp-insoft.de> ·

unsigned

Browse filesCompare with HEAD

Changed files (3)

extensions/ui/__tests__/worker.test.ts

Added
new file mode 100644
1 +import { describe, expect, it } from "vitest";
2 +import {
3 + createTelemetryBatcher,
4 + renderTelemetryWorkerJs,
5 +} from "../web/worker.js";
7 +describe("ui telemetry worker", () => {
8 + it("batches raw events", () => {
9 + const batcher = createTelemetryBatcher({ maxBatch: 2 });
10 + expect(batcher.add({ type: "click", target: "SEND" })).toEqual([]);
11 + expect(batcher.add({ type: "scroll", y: 20, dwellMs: 100 })).toEqual([
12 + { type: "click", target: "SEND" },
13 + { type: "scroll", y: 20, dwellMs: 100 },
14 + ]);
15 + });
17 + it("redacts selection and input text before flush", () => {
18 + const batcher = createTelemetryBatcher({ maxBatch: 10 });
19 + batcher.add({ type: "selection", text: "private" });
20 + expect(batcher.flush()).toEqual([
21 + { type: "selection", text: "[redacted 7 chars]" },
22 + ]);
23 + });
25 + it("renders browser worker source", () => {
26 + const source = renderTelemetryWorkerJs();
27 + expect(source).toContain("postMessage");
28 + expect(source).toContain("telemetry_batch");
29 + });
30 +});

extensions/ui/web/app.js.ts

Modified
1 1 import { renderComposerComponentJs } from "./components/composer.js";
2 2 import { renderDialogsComponentJs } from "./components/dialogs.js";
3 3 import { renderVisualBlockComponentJs } from "./components/visual-block.js";
4 +import { renderTelemetryWorkerJs } from "./worker.js";
5 6 export function renderAppJs(): string {
6 7 return `const status = document.querySelector('#ui-status');
12 13 let commands = [];
13 14 let visibleCommands = [];
14 15 let selectedCommandIndex = 0;
16 +let telemetryWorker;
15 17 let lastEventId = 0;
16 18 let socket;
18 20 ${renderComposerComponentJs()}
19 21 ${renderDialogsComponentJs()}
20 22 ${renderVisualBlockComponentJs()}
23 +const telemetryWorkerSource = ${JSON.stringify(renderTelemetryWorkerJs())};
24 +function startTelemetryWorker() {
25 + if (!('Worker' in window)) return;
26 + const url = URL.createObjectURL(new Blob([telemetryWorkerSource], { type: 'text/javascript' }));
27 + telemetryWorker = new Worker(url);
28 + telemetryWorker.addEventListener('message', event => {
29 + if (event.data?.type === 'telemetry_batch') socket?.send(JSON.stringify(event.data));
30 + });
32 +function trackTelemetry(event) {
33 + try { telemetryWorker?.postMessage({ type: 'telemetry', event }); } catch (_) {}
35 +function deviceClass() { return innerWidth <= 520 ? 'phone' : innerWidth <= 900 ? 'tablet' : 'desktop'; }
36 +function targetLabel(target) { return target?.id || target?.name || target?.textContent?.trim()?.slice(0, 40) || target?.tagName || 'unknown'; }
22 38 function authHeaders() {
23 39 const token = new URL(location.href).searchParams.get('token');
100 116 window.addEventListener('message', event => {
101 117 const data = event.data;
102 118 if (!data || typeof data !== 'object' || !String(data.type || '').startsWith('widget_')) return;
119 + trackTelemetry({ type: 'widget_action', widgetId: data.widgetId, label: data.label || data.type });
103 120 socket?.send(JSON.stringify(data));
104 121 renderEvents([{ id: Number.MAX_SAFE_INTEGER - 2, at: Date.now(), type: 'widget_action', widgetId: data.widgetId, label: data.label || data.type, payload: data.payload || data.text || data.message }]);
123 +window.addEventListener('scroll', () => trackTelemetry({ type: 'scroll', y: scrollY, dwellMs: 0 }), { passive: true });
124 +window.addEventListener('click', event => trackTelemetry({ type: 'click', target: targetLabel(event.target) }), { passive: true });
125 +window.addEventListener('focus', event => trackTelemetry({ type: 'focus', target: targetLabel(event.target) }), true);
126 +window.addEventListener('blur', event => trackTelemetry({ type: 'blur', target: targetLabel(event.target) }), true);
127 +document.addEventListener('selectionchange', () => trackTelemetry({ type: 'selection', text: String(getSelection() || '') }));
128 +window.addEventListener('pagehide', () => trackTelemetry({ type: 'pagehide' }));
129 +form.addEventListener('submit', () => trackTelemetry({ type: 'form', formId: 'composer', state: 'submit' }));
107 131 form.addEventListener('submit', event => {
108 132 event.preventDefault();
115 139 send.disabled = false;
142 +startTelemetryWorker();
143 +trackTelemetry({ type: 'viewport', device: deviceClass(), width: innerWidth, height: innerHeight });
118 144 fetchSnapshot().then(connectSocket).catch(error => {
119 145 status.textContent = 'error';
120 146 renderEvents([{ id: Number.MAX_SAFE_INTEGER - 1, at: Date.now(), type: 'error', message: error.message }]);

extensions/ui/web/worker.js.ts

Added
new file mode 100644
1 +import { redactText, type TelemetryEvent } from "../telemetry";
3 +export type TelemetryBatcherOptions = {
4 + maxBatch?: number;
5 +};
7 +export function createTelemetryBatcher(options: TelemetryBatcherOptions = {}) {
8 + const maxBatch = options.maxBatch ?? 12;
9 + let pending: TelemetryEvent[] = [];
10 + return {
11 + add(event: TelemetryEvent): TelemetryEvent[] {
12 + pending.push(redactRawEvent(event));
13 + if (pending.length < maxBatch) return [];
14 + return flush();
15 + },
16 + flush,
17 + };
19 + function flush() {
20 + const batch = pending;
21 + pending = [];
22 + return batch;
23 + }
26 +export function renderTelemetryWorkerJs(): string {
27 + return `let pending = [];
28 +const maxBatch = 12;
29 +function redactText(text) { return text ? '[redacted ' + text.length + ' chars]' : ''; }
30 +function redact(event) {
31 + if (event.type === 'selection') return { ...event, text: redactText(event.text || '') };
32 + if (event.type === 'error') return { ...event, message: redactText(event.message || '') };
33 + return event;
35 +function flush() {
36 + if (pending.length === 0) return;
37 + postMessage({ type: 'telemetry_batch', events: pending });
38 + pending = [];
40 +onmessage = event => {
41 + const message = event.data;
42 + if (!message || message.type !== 'telemetry') return;
43 + pending.push(redact(message.event));
44 + if (pending.length >= maxBatch) flush();
45 +};
46 +setInterval(flush, 1000);
47 +`;
50 +function redactRawEvent(event: TelemetryEvent): TelemetryEvent {
51 + if (event.type === "selection")
52 + return { ...event, text: redactText(event.text) };
53 + if (event.type === "error")
54 + return { ...event, message: redactText(event.message) };
55 + return event;