implement sepearte replay/heatmap enabled routes and collection

This commit is contained in:
Francis Cao committed 2026-05-19 15:46:01 -07:00
1 parent 4b40be6b5a
commit 5bd92ce950
39 files changed
+586 -295

No files matched your search

@@ -10,48 +10,59 @@ import {
Text,
TextField,
} from '@umami/react-zen';
import { useState } from 'react';
import { useEffect, useState } from 'react';
import { EmptyPlaceholder } from '@/components/common/EmptyPlaceholder';
import { useMessages, useSubscription, useUpdateQuery, useWebsite } from '@/components/hooks';
import { Video } from '@/components/icons';
import { getRecorderConfig, type RecorderConfig } from '@/lib/recorder';
const RECORDER_NAME = 'recorder.js';
interface ReplayConfig {
sampleRate?: number;
maskLevel?: string;
maxDuration?: number;
blockSelector?: string;
}
export function WebsiteReplaySettings({ websiteId }: { websiteId: string }) {
const website = useWebsite();
const { t, labels, messages } = useMessages();
const { hasFeature, cloudMode } = useSubscription(website?.teamId);
const { mutateAsync, touch, toast, isPending } = useUpdateQuery(`/websites/${websiteId}`);
const [enabled, setEnabled] = useState(website?.replayEnabled ?? false);
const config = (website?.replayConfig as ReplayConfig) || {};
const config = getRecorderConfig(website?.replayConfig);
const [replayEnabled, setReplayEnabled] = useState(config.replayEnabled === true);
const [heatmapEnabled, setHeatmapEnabled] = useState(config.heatmapEnabled === true);
const [sampleRate, setSampleRate] = useState(config.sampleRate ?? 0.15);
const [heatmapSampleRate, setHeatmapSampleRate] = useState(config.heatmapSampleRate ?? 0.15);
const [maskLevel, setMaskLevel] = useState(config.maskLevel ?? 'moderate');
const [maxDuration, setMaxDuration] = useState(String(config.maxDuration ?? 300000));
const [blockSelector, setBlockSelector] = useState(config.blockSelector ?? '');
useEffect(() => {
setReplayEnabled(config.replayEnabled === true);
setHeatmapEnabled(config.heatmapEnabled === true);
setSampleRate(config.sampleRate ?? 0.15);
setHeatmapSampleRate(config.heatmapSampleRate ?? 0.15);
setMaskLevel(config.maskLevel ?? 'moderate');
setMaxDuration(String(config.maxDuration ?? 300000));
setBlockSelector(config.blockSelector ?? '');
}, [
config.blockSelector,
config.heatmapEnabled,
config.heatmapSampleRate,
config.maskLevel,
config.maxDuration,
config.replayEnabled,
config.sampleRate,
]);
const recorderUrl = cloudMode
? `${process.env.cloudUrl}/${RECORDER_NAME}`
: `${window?.location?.origin || ''}${process.env.basePath || ''}/${RECORDER_NAME}`;
const recorderCode = `<script defer src="${recorderUrl}" data-website-id="${websiteId}"></script>`;
const sectionLabel = `${t(labels.replays)} & ${t(labels.heatmaps)}`;
const handleToggle = async (value: boolean) => {
const previous = enabled;
setEnabled(value);
const saveRecorderConfig = async (nextConfig: RecorderConfig, rollback?: () => void) => {
try {
await mutateAsync(
{
replayEnabled: value,
replayConfig: nextConfig,
},
{
onSuccess: async () => {
@@ -62,39 +73,48 @@ export function WebsiteReplaySettings({ websiteId }: { websiteId: string }) {
},
);
} catch {
setEnabled(previous);
rollback?.();
}
};
const getNextConfig = (overrides: Partial<RecorderConfig> = {}): RecorderConfig => ({
...config,
replayEnabled,
heatmapEnabled,
sampleRate,
heatmapSampleRate,
maskLevel,
maxDuration: parseInt(maxDuration, 10) || 300000,
blockSelector,
...overrides,
});
const handleReplayToggle = async (value: boolean) => {
const previous = replayEnabled;
setReplayEnabled(value);
await saveRecorderConfig(getNextConfig({ replayEnabled: value }), () => setReplayEnabled(previous));
};
const handleHeatmapToggle = async (value: boolean) => {
const previous = heatmapEnabled;
setHeatmapEnabled(value);
await saveRecorderConfig(getNextConfig({ heatmapEnabled: value }), () => setHeatmapEnabled(previous));
};
const handleSave = async () => {
await mutateAsync(
{
replayEnabled: enabled,
replayConfig: {
sampleRate,
maskLevel,
maxDuration: parseInt(maxDuration, 10) || 300000,
...(blockSelector && { blockSelector }),
},
},
{
onSuccess: async () => {
toast(t(messages.saved));
touch('websites');
touch(`website:${websiteId}`);
},
},
);
await saveRecorderConfig(getNextConfig());
};
if (cloudMode && !hasFeature('replays')) {
return (
<Column gap="4">
<Label>{t(labels.replays)}</Label>
<Label>{sectionLabel}</Label>
<EmptyPlaceholder
icon={<Video />}
title={t(messages.upgradeRequired, { plan: 'Business' })}
description="Watch real user sessions to see exactly how visitors interact with your site."
description="Watch real user sessions and build heatmaps from real visitor behavior."
>
<Button
variant="primary"
@@ -109,46 +129,73 @@ export function WebsiteReplaySettings({ websiteId }: { websiteId: string }) {
return (
<Column gap="4">
<Label>{t(labels.replays)}</Label>
<Switch isSelected={enabled} onChange={handleToggle} isDisabled={isPending}>
{t(labels.replayEnabled)}
<Label>{sectionLabel}</Label>
<Switch isSelected={replayEnabled} onChange={handleReplayToggle} isDisabled={isPending}>
{t(labels.replays)}
</Switch>
{enabled && (
<Switch isSelected={heatmapEnabled} onChange={handleHeatmapToggle} isDisabled={isPending}>
{t(labels.heatmaps)}
</Switch>
{(replayEnabled || heatmapEnabled) && (
<>
<Label>{t(labels.replayCode)}</Label>
<Label>{t(labels.recorderCode)}</Label>
<Text color="muted">{t(messages.trackingCode)}</Text>
<TextField value={recorderCode} isReadOnly allowCopy asTextArea resize="none" className="code-textarea" />
<Slider
label={t(labels.sampleRate)}
minValue={0.05}
maxValue={1}
step={0.05}
value={sampleRate}
onChange={v => setSampleRate(Array.isArray(v) ? v[0] : v)}
showValue
formatOptions={{ style: 'percent', maximumFractionDigits: 0 }}
style={{ maxWidth: '360px' }}
<TextField
value={recorderCode}
isReadOnly
allowCopy
asTextArea
resize="none"
className="code-textarea"
/>
<Column gap="1">
<Label>{t(labels.maskLevel)}</Label>
<Select value={maskLevel} onChange={setMaskLevel} style={{ maxWidth: '360px' }}>
<ListItem id="strict">strict</ListItem>
<ListItem id="moderate">moderate</ListItem>
</Select>
</Column>
<Column gap="1">
<Label>{t(labels.maxDuration)}</Label>
<Select value={maxDuration} onChange={setMaxDuration} style={{ maxWidth: '360px' }}>
<ListItem id="300000">5 minutes</ListItem>
<ListItem id="600000">10 minutes</ListItem>
<ListItem id="900000">15 minutes</ListItem>
<ListItem id="1200000">20 minutes</ListItem>
</Select>
</Column>
<Column gap="1">
<Label>{t(labels.blockSelector)}</Label>
<TextField value={blockSelector} onChange={setBlockSelector} />
</Column>
{heatmapEnabled && (
<Slider
label={`Heatmap ${t(labels.sampleRate).toLowerCase()}`}
minValue={0.05}
maxValue={1}
step={0.05}
value={heatmapSampleRate}
onChange={v => setHeatmapSampleRate(Array.isArray(v) ? v[0] : v)}
showValue
formatOptions={{ style: 'percent', maximumFractionDigits: 0 }}
style={{ maxWidth: '360px' }}
/>
)}
{replayEnabled && (
<>
<Slider
label={`Replay ${t(labels.sampleRate).toLowerCase()}`}
minValue={0.05}
maxValue={1}
step={0.05}
value={sampleRate}
onChange={v => setSampleRate(Array.isArray(v) ? v[0] : v)}
showValue
formatOptions={{ style: 'percent', maximumFractionDigits: 0 }}
style={{ maxWidth: '360px' }}
/>
<Column gap="1">
<Label>{t(labels.maskLevel)}</Label>
<Select value={maskLevel} onChange={setMaskLevel} style={{ maxWidth: '360px' }}>
<ListItem id="strict">strict</ListItem>
<ListItem id="moderate">moderate</ListItem>
</Select>
</Column>
<Column gap="1">
<Label>{t(labels.maxDuration)}</Label>
<Select value={maxDuration} onChange={setMaxDuration} style={{ maxWidth: '360px' }}>
<ListItem id="300000">5 minutes</ListItem>
<ListItem id="600000">10 minutes</ListItem>
<ListItem id="900000">15 minutes</ListItem>
<ListItem id="1200000">20 minutes</ListItem>
</Select>
</Column>
<Column gap="1">
<Label>{t(labels.blockSelector)}</Label>
<TextField value={blockSelector} onChange={setBlockSelector} />
</Column>
</>
)}
<Row>
<Button variant="primary" onPress={handleSave} isDisabled={isPending}>
{t(labels.save)}
+116 -38
View File
@@ -5,11 +5,12 @@ import { secret } from '@/lib/crypto';
import { getClientInfo, hasBlockedIp } from '@/lib/detect';
import { parseToken } from '@/lib/jwt';
import { fetchAccount, fetchTeam } from '@/lib/load';
import { HEATMAP_EVENT_TYPE } from '@/lib/constants';
import { getRecorderConfig } from '@/lib/recorder';
import { parseRequest } from '@/lib/request';
import { badRequest, forbidden, json, serverError } from '@/lib/response';
import { getWebsite } from '@/queries/prisma';
import { saveRecording } from '@/queries/sql';
import { extractHeatmapEvents } from '@/queries/sql/heatmap/extractHeatmapEvents';
import { saveHeatmapEvents } from '@/queries/sql/heatmap/saveHeatmapEvents';
interface Cache {
@@ -17,14 +18,60 @@ interface Cache {
visitId: string;
}
const schema = z.object({
type: z.literal('record'),
payload: z.object({
website: z.uuid(),
events: z.array(z.any()).max(200),
timestamp: z.coerce.number().int().optional(),
const schema = z.discriminatedUnion('type', [
z.object({
type: z.literal('record'),
payload: z.object({
website: z.uuid(),
events: z.array(z.any()).max(200),
timestamp: z.coerce.number().int().optional(),
}),
}),
});
z.object({
type: z.literal('heatmap'),
payload: z.object({
website: z.uuid(),
events: z
.array(
z.discriminatedUnion('type', [
z.object({
type: z.literal('click'),
url: z.string(),
x: z.coerce.number().optional(),
y: z.coerce.number().optional(),
pageX: z.coerce.number().optional(),
pageY: z.coerce.number().optional(),
pageW: z.coerce.number().optional(),
pageH: z.coerce.number().optional(),
viewportW: z.coerce.number().optional(),
viewportH: z.coerce.number().optional(),
timestamp: z.coerce.number().int().optional(),
}),
z.object({
type: z.literal('scroll'),
url: z.string(),
scrollPct: z.coerce.number().optional(),
pageW: z.coerce.number().optional(),
pageH: z.coerce.number().optional(),
viewportW: z.coerce.number().optional(),
viewportH: z.coerce.number().optional(),
timestamp: z.coerce.number().int().optional(),
}),
]),
)
.max(200),
timestamp: z.coerce.number().int().optional(),
}),
}),
]);
function getUrlPath(url: string) {
try {
return new URL(url).pathname || '/';
} catch {
return url.startsWith('/') ? url.split(/[?#]/)[0] || '/' : '/';
}
}
export async function POST(request: Request) {
try {
@@ -34,7 +81,9 @@ export async function POST(request: Request) {
return error();
}
const { website: websiteId, events, timestamp } = body.payload;
const { website: websiteId } = body.payload;
const events = body.payload.events;
const timestamp = body.payload.timestamp;
if (!events?.length) {
return json({ ok: true });
@@ -55,15 +104,19 @@ export async function POST(request: Request) {
const { sessionId, visitId } = cache;
// Query directly to avoid stale Redis cache for recordingEnabled
// Query directly to avoid stale Redis cache for recorderEnabled
const website = await getWebsite(websiteId);
if (!website) {
return badRequest({ message: 'Website not found.' });
}
if (!website.replayEnabled) {
return json({ ok: false, reason: 'replay_disabled' });
const recorderConfig = getRecorderConfig(website.replayConfig);
const replayEnabled = recorderConfig.replayEnabled === true;
const heatmapEnabled = recorderConfig.heatmapEnabled === true;
if (!website.recorderEnabled) {
return json({ ok: false, reason: 'recorder_disabled' });
}
if (process.env.CLOUD_MODE) {
@@ -89,38 +142,63 @@ export async function POST(request: Request) {
return forbidden();
}
// Compute timestamps from events
const eventTimestamps = events
.map((e: any) => Number(e?.timestamp))
.filter((t: number) => Number.isFinite(t) && t > 0);
if (body.type === 'record') {
if (!replayEnabled) {
return json({ ok: false, reason: 'replay_disabled' });
}
const fallbackMs = (timestamp || Math.floor(Date.now() / 1000)) * 1000;
const minTimestamp = eventTimestamps.length ? Math.min(...eventTimestamps) : fallbackMs;
const maxTimestamp = eventTimestamps.length ? Math.max(...eventTimestamps) : fallbackMs;
const eventTimestamps = events
.map((e: any) => Number(e?.timestamp))
.filter((t: number) => Number.isFinite(t) && t > 0);
const startedAt = new Date(minTimestamp);
const endedAt = new Date(maxTimestamp);
const fallbackMs = (timestamp || Math.floor(Date.now() / 1000)) * 1000;
const minTimestamp = eventTimestamps.length ? Math.min(...eventTimestamps) : fallbackMs;
const maxTimestamp = eventTimestamps.length ? Math.max(...eventTimestamps) : fallbackMs;
// Use timestamp-based chunk index for ordering
const chunkIndex = timestamp || Math.floor(Date.now() / 1000);
const startedAt = new Date(minTimestamp);
const endedAt = new Date(maxTimestamp);
const chunkIndex = timestamp || Math.floor(Date.now() / 1000);
await saveRecording({
websiteId,
sessionId,
visitId,
chunkIndex,
events,
eventCount: events.length,
startedAt,
endedAt,
});
try {
const heatmapRows = extractHeatmapEvents(events, { chunkIndex }).map(e => ({
await saveRecording({
websiteId,
sessionId,
visitId,
...e,
chunkIndex,
events,
eventCount: events.length,
startedAt,
endedAt,
});
return json({ ok: true });
}
if (!heatmapEnabled) {
return json({ ok: false, reason: 'heatmap_disabled' });
}
try {
const fallbackMs = (timestamp || Math.floor(Date.now() / 1000)) * 1000;
const heatmapRows = events.map(event => ({
websiteId,
sessionId,
visitId,
eventType: event.type === 'click' ? HEATMAP_EVENT_TYPE.click : HEATMAP_EVENT_TYPE.scroll,
nodeId: null,
x: event.type === 'click' ? event.x ?? null : null,
y: event.type === 'click' ? event.y ?? null : null,
pageX: event.type === 'click' ? event.pageX ?? null : null,
pageY: event.type === 'click' ? event.pageY ?? null : null,
pageW: event.pageW ?? null,
viewportW: event.viewportW ?? null,
viewportH: event.viewportH ?? null,
pageH: event.pageH ?? null,
scrollPct: event.type === 'scroll' ? event.scrollPct ?? null : null,
urlPath: getUrlPath(event.url),
createdAt: new Date(event.timestamp ?? fallbackMs),
replayChunkIndex: null,
replayEventIndex: null,
replayTimeMs: null,
}));
if (heatmapRows.length) {
@@ -128,7 +206,7 @@ export async function POST(request: Request) {
}
} catch (e) {
// eslint-disable-next-line no-console
console.log('heatmap extraction failed', serializeError(e));
console.log('heatmap save failed', serializeError(e));
}
return json({ ok: true });
@@ -1,14 +1,7 @@
import { parseRequest } from '@/lib/request';
import { json } from '@/lib/response';
import { getRecorderConfig } from '@/lib/recorder';
import { getWebsite } from '@/queries/prisma';
interface ReplayConfig {
sampleRate?: number;
maskLevel?: string;
maxDuration?: number;
blockSelector?: string;
}
export async function GET(
request: Request,
{ params }: { params: Promise<{ websiteId: string }> },
@@ -26,16 +19,19 @@ export async function GET(
'Cache-Control': 'public, max-age=60, stale-while-revalidate=300',
};
if (!website || !website.replayEnabled) {
if (!website || !website.recorderEnabled) {
return Response.json({ enabled: false }, { headers });
}
const config = (website.replayConfig as ReplayConfig) || {};
const config = getRecorderConfig(website.replayConfig);
return Response.json(
{
enabled: true,
replayEnabled: config.replayEnabled === true,
heatmapEnabled: config.heatmapEnabled === true,
sampleRate: config.sampleRate ?? 0.15,
heatmapSampleRate: config.heatmapSampleRate ?? 0.15,
maskLevel: config.maskLevel ?? 'moderate',
maxDuration: config.maxDuration ?? 300000,
blockSelector: config.blockSelector ?? '',
+25 -4
View File
@@ -1,6 +1,8 @@
import { z } from 'zod';
import type { Prisma } from '@/generated/prisma/client';
import { ENTITY_TYPE } from '@/lib/constants';
import { uuid } from '@/lib/crypto';
import { getRecorderConfig, getRecorderEnabled } from '@/lib/recorder';
import { parseRequest } from '@/lib/request';
import { badRequest, json, ok, serverError, unauthorized } from '@/lib/response';
import { canDeleteWebsite, canUpdateWebsite, canViewWebsite } from '@/permissions';
@@ -42,10 +44,12 @@ export async function POST(
name: z.string().optional(),
domain: z.string().optional(),
shareId: z.string().max(50).nullable().optional(),
replayEnabled: z.boolean().optional(),
replayConfig: z
.object({
replayEnabled: z.boolean().optional(),
heatmapEnabled: z.boolean().optional(),
sampleRate: z.number().min(0).max(1).optional(),
heatmapSampleRate: z.number().min(0).max(1).optional(),
maskLevel: z.enum(['strict', 'moderate']).optional(),
maxDuration: z.number().int().positive().optional(),
blockSelector: z.string().optional(),
@@ -61,18 +65,35 @@ export async function POST(
}
const { websiteId } = await params;
const { name, domain, shareId, replayEnabled, replayConfig } = body;
const { name, domain, shareId, replayConfig } = body;
if (!(await canUpdateWebsite(auth, websiteId))) {
return unauthorized();
}
try {
const currentWebsite = await getWebsite(websiteId);
if (!currentWebsite) {
return badRequest({ message: 'Website not found.' });
}
const nextReplayConfig = getRecorderConfig(
replayConfig === null
? {}
: {
...getRecorderConfig(currentWebsite.replayConfig),
...(replayConfig ?? {}),
},
);
const website = await updateWebsite(websiteId, {
name,
domain,
...(replayEnabled !== undefined && { replayEnabled }),
...(replayConfig !== undefined && { replayConfig }),
...(replayConfig !== undefined && {
replayConfig: nextReplayConfig as Prisma.InputJsonObject,
recorderEnabled: getRecorderEnabled(nextReplayConfig),
}),
});
if (shareId === null) {
+1 -1
View File
@@ -381,7 +381,7 @@ export const labels: Record<string, string> = {
replay: 'label.replay',
replayId: 'label.replay-id',
replayEnabled: 'label.replay-enabled',
replayCode: 'label.replay-code',
recorderCode: 'label.recorder-code',
sampleRate: 'label.sample-rate',
maskLevel: 'label.mask-level',
maxDuration: 'label.max-duration',
+54
View File
@@ -0,0 +1,54 @@
export interface RecorderConfig {
replayEnabled?: boolean;
heatmapEnabled?: boolean;
sampleRate?: number;
heatmapSampleRate?: number;
maskLevel?: 'strict' | 'moderate';
maxDuration?: number;
blockSelector?: string;
}
export function getRecorderConfig(value: unknown): RecorderConfig {
if (!value || typeof value !== 'object' || Array.isArray(value)) {
return {};
}
const config = value as Record<string, unknown>;
const nextConfig: RecorderConfig = {};
if (config.replayEnabled === true) {
nextConfig.replayEnabled = true;
}
if (config.heatmapEnabled === true) {
nextConfig.heatmapEnabled = true;
}
if (typeof config.sampleRate === 'number') {
nextConfig.sampleRate = config.sampleRate;
}
if (typeof config.heatmapSampleRate === 'number') {
nextConfig.heatmapSampleRate = config.heatmapSampleRate;
}
if (config.maskLevel === 'strict' || config.maskLevel === 'moderate') {
nextConfig.maskLevel = config.maskLevel;
}
if (typeof config.maxDuration === 'number' && Number.isFinite(config.maxDuration)) {
nextConfig.maxDuration = Math.round(config.maxDuration);
}
if (typeof config.blockSelector === 'string') {
nextConfig.blockSelector = config.blockSelector;
}
return nextConfig;
}
export function getRecorderEnabled(config: unknown) {
const { replayEnabled, heatmapEnabled } = getRecorderConfig(config);
return replayEnabled === true || heatmapEnabled === true;
}
+226 -137
View File
@@ -3,14 +3,15 @@ import { record } from 'rrweb';
(window => {
const { document } = window;
const { currentScript } = document;
if (!currentScript) return;
const _data = 'data-';
const attr = currentScript.getAttribute.bind(currentScript);
const config = value => attr(`${_data}${value}`);
const website = config(`website-id`);
const hostUrl = config(`host-url`);
const website = config('website-id');
const hostUrl = config('host-url');
if (!website) return;
@@ -18,41 +19,45 @@ import { record } from 'rrweb';
hostUrl || '__COLLECT_API_HOST__' || currentScript.src.split('/').slice(0, -1).join('/');
const hostBase = host.replace(/\/$/, '');
const endpoint = `${hostBase}__COLLECT_REPLAY_ENDPOINT__`;
const configEndpoint = `${hostBase}__RECORDER_CONFIG_ENDPOINT__`.replace(
'{websiteId}',
website,
);
const configEndpoint = `${hostBase}__RECORDER_CONFIG_ENDPOINT__`.replace('{websiteId}', website);
const FLUSH_EVENT_COUNT = 100;
const FLUSH_INTERVAL = 10000;
const REPLAY_FLUSH_EVENT_COUNT = 100;
const REPLAY_FLUSH_INTERVAL = 10000;
const HEATMAP_FLUSH_EVENT_COUNT = 20;
const HEATMAP_FLUSH_INTERVAL = 5000;
let replayEnabled = false;
let heatmapEnabled = false;
let sampleRate = 0.15;
let heatmapSampleRate = 0.15;
let maskLevel = 'moderate';
let maxDuration = 300000;
let blockSelector = '';
let eventBuffer = [];
let stopFn = null;
let flushTimer = null;
let startTime = null;
let stopped = false;
let recorderReady = false;
let customEventBuffer = [];
let replayBuffer = [];
let heatmapBuffer = [];
let replayStopFn = null;
let replayFlushTimer = null;
let heatmapFlushTimer = null;
let replayStartTime = null;
let replayStopped = false;
let heatmapStarted = false;
const sendEvents = (events, useKeepalive = false) => {
const session = window.umami?.getSession?.();
if (!session?.cache) return;
const getSessionCache = () => window.umami?.getSession?.()?.cache;
const sendPayload = (type, payload, useKeepalive = false) => {
const cache = getSessionCache();
if (!cache) return;
const body = JSON.stringify({
type: 'record',
type,
payload: {
website,
events,
timestamp: Math.floor(Date.now() / 1000),
...payload,
},
});
// keepalive has a 64KB body limit — only use it for small payloads on unload
const keepalive = useKeepalive && body.length < 60000;
return fetch(endpoint, {
@@ -61,67 +66,79 @@ import { record } from 'rrweb';
body,
headers: {
'Content-Type': 'application/json',
'x-umami-cache': session.cache,
'x-umami-cache': cache,
},
credentials: 'omit',
}).catch(() => {});
};
const flush = (useKeepalive = false) => {
if (!eventBuffer.length) return;
const flushReplay = (useKeepalive = false) => {
if (!replayBuffer.length) return;
const events = eventBuffer;
eventBuffer = [];
const events = replayBuffer;
replayBuffer = [];
sendEvents(events, useKeepalive);
sendPayload(
'record',
{
events,
timestamp: Math.floor(Date.now() / 1000),
},
useKeepalive,
);
};
const scheduleFlush = () => {
if (flushTimer) clearTimeout(flushTimer);
flushTimer = setTimeout(flush, FLUSH_INTERVAL);
const flushHeatmap = (useKeepalive = false) => {
if (!heatmapBuffer.length) return;
const events = heatmapBuffer;
heatmapBuffer = [];
sendPayload(
'heatmap',
{
events,
timestamp: Math.floor(Date.now() / 1000),
},
useKeepalive,
);
};
const stop = () => {
if (stopped) return;
stopped = true;
if (flushTimer) clearTimeout(flushTimer);
flush();
if (stopFn) stopFn();
const scheduleReplayFlush = () => {
if (replayFlushTimer) clearTimeout(replayFlushTimer);
replayFlushTimer = setTimeout(() => flushReplay(), REPLAY_FLUSH_INTERVAL);
};
const flushCustomEvents = () => {
if (!recorderReady || !customEventBuffer.length) return;
const events = customEventBuffer;
customEventBuffer = [];
for (const event of events) {
addCustomEvent(event.tag, event.payload);
}
const scheduleHeatmapFlush = () => {
if (heatmapFlushTimer) clearTimeout(heatmapFlushTimer);
heatmapFlushTimer = setTimeout(() => flushHeatmap(), HEATMAP_FLUSH_INTERVAL);
};
const addCustomEvent = (tag, payload) => {
if (stopped) return;
const queueHeatmapEvent = event => {
heatmapBuffer.push({
...event,
timestamp: Date.now(),
});
if (!recorderReady) {
customEventBuffer.push({ tag, payload });
if (heatmapBuffer.length >= HEATMAP_FLUSH_EVENT_COUNT) {
flushHeatmap();
return;
}
try {
record.addCustomEvent(tag, payload);
} catch (e) {
if (e?.message === 'please add custom event after start recording') {
recorderReady = false;
customEventBuffer.push({ tag, payload });
setTimeout(() => {
recorderReady = true;
flushCustomEvents();
}, 0);
return;
}
scheduleHeatmapFlush();
};
throw e;
const stopReplay = () => {
if (replayStopped) return;
replayStopped = true;
if (replayFlushTimer) clearTimeout(replayFlushTimer);
flushReplay();
if (replayStopFn) {
replayStopFn();
replayStopFn = null;
}
};
@@ -132,16 +149,25 @@ import { record } from 'rrweb';
maskAllInputs: true,
maskTextSelector: '*',
};
default: // moderate
default:
return {
maskAllInputs: true,
};
}
};
const shouldSample = value => {
if (value >= 1) return true;
if (value <= 0) return false;
return Math.random() <= value;
};
const measureElementWidth = element => {
if (!element) return 0;
const rect = element.getBoundingClientRect?.();
return Math.max(
element.scrollWidth || 0,
element.offsetWidth || 0,
@@ -152,7 +178,9 @@ import { record } from 'rrweb';
const measureElementHeight = element => {
if (!element) return 0;
const rect = element.getBoundingClientRect?.();
return Math.max(
element.scrollHeight || 0,
element.offsetHeight || 0,
@@ -163,6 +191,7 @@ import { record } from 'rrweb';
const measureDocumentBounds = doc => {
const body = doc?.body;
if (!body) {
return { width: 0, height: 0 };
}
@@ -174,10 +203,12 @@ import { record } from 'rrweb';
while (node) {
const rect = node.getBoundingClientRect?.();
if (rect && (rect.width > 0 || rect.height > 0)) {
maxRight = Math.max(maxRight, rect.right);
maxBottom = Math.max(maxBottom, rect.bottom);
}
node = walker.nextNode();
}
@@ -187,66 +218,7 @@ import { record } from 'rrweb';
};
};
const waitForSession = (attempts = 0) => {
if (attempts > 50) return;
const session = window.umami?.getSession?.();
if (session?.cache) {
beginRecording();
} else {
setTimeout(() => waitForSession(attempts + 1), 100);
}
};
const beginRecording = () => {
startTime = Date.now();
const maskConfig = getMaskConfig(maskLevel);
stopFn = record({
emit(event) {
if (stopped) return;
if (Date.now() - startTime > maxDuration) {
stop();
return;
}
eventBuffer.push(event);
recorderReady = true;
flushCustomEvents();
if (eventBuffer.length >= FLUSH_EVENT_COUNT) {
flush();
}
scheduleFlush();
},
...maskConfig,
inlineStylesheet: true,
slimDOMOptions: {
script: true,
comment: true,
headMetaDescKeywords: true,
headMetaSocial: true,
headMetaRobots: true,
headMetaHttpEquiv: true,
headMetaAuthorship: true,
headMetaVerification: true,
},
recordCanvas: false,
recordCrossOriginIframes: false,
checkoutEveryNms: 30000,
...(blockSelector && { blockSelector }),
});
recorderReady = true;
flushCustomEvents();
let scrollUrl = location.href;
let maxScrollPct = 0;
let lastFlushedScrollPct = 0;
let scrollTimer = null;
const createPageMetrics = () => {
const computePageMetrics = ({ includeBounds = false } = {}) => {
const scrollingElement = document.scrollingElement || document.documentElement;
const firstChild = document.body?.firstElementChild;
@@ -286,11 +258,69 @@ import { record } from 'rrweb';
};
};
return {
computePageMetrics,
computeScrollPct,
};
};
const beginReplayCapture = () => {
replayStartTime = Date.now();
replayStopFn = record({
emit(event) {
if (replayStopped) return;
if (Date.now() - replayStartTime > maxDuration) {
stopReplay();
return;
}
replayBuffer.push(event);
if (replayBuffer.length >= REPLAY_FLUSH_EVENT_COUNT) {
flushReplay();
}
scheduleReplayFlush();
},
...getMaskConfig(maskLevel),
inlineStylesheet: true,
slimDOMOptions: {
script: true,
comment: true,
headMetaDescKeywords: true,
headMetaSocial: true,
headMetaRobots: true,
headMetaHttpEquiv: true,
headMetaAuthorship: true,
headMetaVerification: true,
},
recordCanvas: false,
recordCrossOriginIframes: false,
checkoutEveryNms: 30000,
...(blockSelector && { blockSelector }),
});
};
const beginHeatmapCapture = () => {
if (heatmapStarted) return;
heatmapStarted = true;
const { computePageMetrics, computeScrollPct } = createPageMetrics();
let scrollUrl = location.href;
let maxScrollPct = 0;
let lastFlushedScrollPct = 0;
let scrollTimer = null;
const flushScroll = () => {
if (maxScrollPct <= 0 || maxScrollPct <= lastFlushedScrollPct) return;
const { pageW, pageH } = computePageMetrics({ includeBounds: true });
addCustomEvent('scroll-progress', {
queueHeatmapEvent({
type: 'scroll',
url: scrollUrl,
scrollPct: maxScrollPct,
viewportW: window.innerWidth,
@@ -298,6 +328,7 @@ import { record } from 'rrweb';
pageW,
pageH,
});
lastFlushedScrollPct = maxScrollPct;
maxScrollPct = 0;
};
@@ -320,7 +351,8 @@ import { record } from 'rrweb';
const pageW = Math.max(rawPageW, Math.ceil(pageX), Math.ceil(targetRight));
const pageH = Math.max(rawPageH, Math.ceil(pageY), Math.ceil(targetBottom));
addCustomEvent('heatmap-click', {
queueHeatmapEvent({
type: 'click',
url: location.href,
x: Math.round(event.clientX),
y: Math.round(event.clientY),
@@ -335,9 +367,14 @@ import { record } from 'rrweb';
const onScroll = () => {
if (scrollTimer) return;
scrollTimer = setTimeout(() => {
const { pct } = computeScrollPct();
if (pct > maxScrollPct) maxScrollPct = pct;
if (pct > maxScrollPct) {
maxScrollPct = pct;
}
flushScroll();
scrollTimer = null;
}, 400);
@@ -345,16 +382,17 @@ import { record } from 'rrweb';
const onUrlChange = () => {
if (location.href === scrollUrl) return;
flushScroll();
scrollUrl = location.href;
lastFlushedScrollPct = 0;
addCustomEvent('url-change', { url: scrollUrl });
};
const hookHistory = method => {
const orig = history[method];
const original = history[method];
history[method] = function (...args) {
const result = orig.apply(this, args);
const result = original.apply(this, args);
onUrlChange();
return result;
};
@@ -368,32 +406,80 @@ import { record } from 'rrweb';
{
const { pct } = computeScrollPct();
if (pct > maxScrollPct) maxScrollPct = pct;
if (pct > maxScrollPct) {
maxScrollPct = pct;
}
flushScroll();
}
document.addEventListener('visibilitychange', () => {
if (document.visibilityState === 'hidden') {
flushScroll();
flush(true);
flushHeatmap(true);
}
});
window.addEventListener('beforeunload', () => {
flushScroll();
flush(true);
flushHeatmap(true);
});
};
const waitForSession = (callback, attempts = 0) => {
if (attempts > 50) return;
if (getSessionCache()) {
callback();
return;
}
setTimeout(() => waitForSession(callback, attempts + 1), 100);
};
const startCaptures = () => {
const shouldRecordReplay = replayEnabled && shouldSample(sampleRate);
const shouldRecordHeatmap = heatmapEnabled && shouldSample(heatmapSampleRate);
if (shouldRecordHeatmap) {
beginHeatmapCapture();
}
if (shouldRecordReplay) {
beginReplayCapture();
}
if (!shouldRecordHeatmap && !shouldRecordReplay) {
return;
}
document.addEventListener('visibilitychange', () => {
if (document.visibilityState === 'hidden') {
flushReplay(true);
}
});
window.addEventListener('beforeunload', () => {
flushReplay(true);
});
};
const bootstrap = async () => {
try {
const response = await fetch(configEndpoint, { credentials: 'omit' });
if (!response.ok) return;
const data = await response.json();
if (!data?.enabled) return;
replayEnabled = data.replayEnabled === true;
heatmapEnabled = data.heatmapEnabled === true;
if (typeof data.sampleRate === 'number') sampleRate = data.sampleRate;
if (typeof data.heatmapSampleRate === 'number') heatmapSampleRate = data.heatmapSampleRate;
if (typeof data.maskLevel === 'string') maskLevel = data.maskLevel;
if (typeof data.maxDuration === 'number') maxDuration = data.maxDuration;
if (typeof data.blockSelector === 'string') blockSelector = data.blockSelector;
@@ -401,14 +487,17 @@ import { record } from 'rrweb';
return;
}
// Sample rate check
if (sampleRate < 1 && Math.random() > sampleRate) return;
if (!replayEnabled && !heatmapEnabled) {
return;
}
if (document.readyState === 'complete') {
waitForSession();
waitForSession(startCaptures);
} else {
document.addEventListener('readystatechange', () => {
if (document.readyState === 'complete') waitForSession();
if (document.readyState === 'complete') {
waitForSession(startCaptures);
}
});
}
};