Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

Enhance session replay functionality with API key support (#483)

Bill Yangf30ba1955294
diff --git a/server/public/script-full.js b/server/public/script-full.js
index 360ab55ed..bac84b142 100644
--- a/server/public/script-full.js
+++ b/server/public/script-full.js
@@ -309,6 +309,9 @@
}
async sendSessionReplayBatch(batch) {
try {
+ if (this.config.apiKey) {
+ batch.apiKey = this.config.apiKey;
+ }
await fetch(
`${this.config.analyticsHost}/session-replay/record/${this.config.siteId}`,
{
diff --git a/server/public/script.js b/server/public/script.js
index 11545b5ec..82209179e 100644
--- a/server/public/script.js
+++ b/server/public/script.js
@@ -1 +1 @@
-"use strict";(()=>{var se=Object.defineProperty;var ae=(i,e,t)=>e in i?se(i,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):i[e]=t;var h=(i,e,t)=>ae(i,typeof e!="symbol"?e+"":e,t);function oe(i){let e="__DOUBLE_ASTERISK_TOKEN__",t="__SINGLE_ASTERISK_TOKEN__",n=i.replace(/\*\*/g,e).replace(/\*/g,t).replace(/[.+?^${}()|[\]\\]/g,"\\$&");n=n.replace(new RegExp(`/${e}/`,"g"),"/(?:.+/)?"),n=n.replace(new RegExp(e,"g"),".*"),n=n.replace(/\//g,"\\/");let c=n.replace(new RegExp(t,"g"),"[^/]+");return new RegExp("^"+c+"$")}function k(i,e){for(let t of e)try{if(oe(t).test(i))return t}catch(r){console.error(`Invalid pattern: ${t}`,r)}return null}function x(i,e){let t=null;return(...r)=>{t&&clearTimeout(t),t=setTimeout(()=>i(...r),e)}}function F(i){try{let e=window.location.hostname,t=new URL(i).hostname;return t!==e&&t!==""}catch{return!1}}function E(i,e){if(!i)return e;try{let t=JSON.parse(i);return Array.isArray(e)&&!Array.isArray(t)?e:t}catch(t){return console.error("Error parsing JSON:",t),e}}function W(i){let e=i.getAttribute("src");if(!e)return console.error("Script src attribute is missing"),null;let t=e.split("/script.js")[0];if(!t)return console.error("Please provide a valid analytics host"),null;let r=i.getAttribute("data-site-id")||i.getAttribute("site-id");if(!r||isNaN(Number(r)))return console.error("Please provide a valid site ID using the data-site-id attribute"),null;let n=i.getAttribute("data-debounce")?Math.max(0,parseInt(i.getAttribute("data-debounce"))):500,c=E(i.getAttribute("data-skip-patterns"),[]),a=E(i.getAttribute("data-mask-patterns"),[]),s=i.getAttribute("data-api-key")||void 0,o=i.getAttribute("data-replay-batch-size")?Math.max(1,parseInt(i.getAttribute("data-replay-batch-size"))):25,l=i.getAttribute("data-replay-batch-interval")?Math.max(1e3,parseInt(i.getAttribute("data-replay-batch-interval"))):2e3;return{analyticsHost:t,siteId:r,debounceDuration:n,autoTrackPageview:i.getAttribute("data-auto-track-pageview")!=="false",autoTrackSpa:i.getAttribute("data-track-spa")!=="false",trackQuerystring:i.getAttribute("data-track-query")!=="false",trackOutbound:i.getAttribute("data-track-outbound")!=="false",enableWebVitals:i.getAttribute("data-web-vitals")==="true",trackErrors:i.getAttribute("data-track-errors")==="true",enableSessionReplay:i.getAttribute("data-session-replay")==="true",sessionReplayBatchSize:o,sessionReplayBatchInterval:l,skipPatterns:c,maskPatterns:a,apiKey:s}}var v=class{constructor(e,t,r){this.isRecording=!1;this.eventBuffer=[];this.config=e,this.userId=t,this.sendBatch=r}async initialize(){this.config.enableSessionReplay&&(window.rrweb||await this.loadRrweb(),window.rrweb&&this.startRecording())}async loadRrweb(){return new Promise((e,t)=>{let r=document.createElement("script");r.src=`${this.config.analyticsHost}/replay.js`,r.async=!1,r.onload=()=>{e()},r.onerror=()=>t(new Error("Failed to load rrweb")),document.head.appendChild(r)})}startRecording(){if(!(this.isRecording||!window.rrweb||!this.config.enableSessionReplay))try{this.stopRecordingFn=window.rrweb.record({emit:e=>{this.addEvent({type:e.type,data:e.data,timestamp:e.timestamp||Date.now()})},recordCanvas:!0,collectFonts:!0,checkoutEveryNms:3e4,checkoutEveryNth:200,maskAllInputs:!0,maskInputOptions:{password:!0,email:!0},slimDOMOptions:{script:!1,comment:!0,headFavicon:!0,headWhitespace:!0,headMetaDescKeywords:!0,headMetaSocial:!0,headMetaRobots:!0,headMetaHttpEquiv:!0,headMetaAuthorship:!0,headMetaVerification:!0},sampling:{mousemove:!1,mouseInteraction:!0,scroll:150,input:"last"}}),this.isRecording=!0,this.setupBatchTimer()}catch{}}stopRecording(){this.isRecording&&(this.stopRecordingFn&&this.stopRecordingFn(),this.isRecording=!1,this.clearBatchTimer(),this.eventBuffer.length>0&&this.flushEvents())}isActive(){return this.isRecording}addEvent(e){this.eventBuffer.push(e),this.eventBuffer.length>=this.config.sessionReplayBatchSize&&this.flushEvents()}setupBatchTimer(){this.clearBatchTimer(),this.batchTimer=window.setInterval(()=>{this.eventBuffer.length>0&&this.flushEvents()},this.config.sessionReplayBatchInterval)}clearBatchTimer(){this.batchTimer&&(clearInterval(this.batchTimer),this.batchTimer=void 0)}async flushEvents(){if(this.eventBuffer.length===0)return;let e=[...this.eventBuffer];this.eventBuffer=[];let t={userId:this.userId,events:e,metadata:{pageUrl:window.location.href,viewportWidth:screen.width,viewportHeight:screen.height,language:navigator.language}};try{await this.sendBatch(t)}catch{this.eventBuffer.unshift(...e)}}updateUserId(e){this.userId=e}onPageChange(){this.isRecording&&this.flushEvents()}cleanup(){this.stopRecording()}};var y=class{constructor(e){this.customUserId=null;this.config=e,this.loadUserId(),e.enableSessionReplay&&this.initializeSessionReplay()}loadUserId(){try{let e=localStorage.getItem("rybbit-user-id");e&&(this.customUserId=e)}catch{}}async initializeSessionReplay(){try{this.sessionReplayRecorder=new v(this.config,this.customUserId||"",e=>this.sendSessionReplayBatch(e)),await this.sessionReplayRecorder.initialize()}catch(e){console.error("Failed to initialize session replay:",e)}}async sendSessionReplayBatch(e){try{await fetch(`${this.config.analyticsHost}/session-replay/record/${this.config.siteId}`,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(e),mode:"cors",keepalive:!1})}catch(t){throw console.error("Failed to send session replay batch:",t),t}}createBasePayload(){let e=new URL(window.location.href),t=e.pathname;if(e.hash&&e.hash.startsWith("#/")&&(t=e.hash.substring(1)),k(t,this.config.skipPatterns))return null;let r=k(t,this.config.maskPatterns);r&&(t=r);let n={site_id:this.config.siteId,hostname:e.hostname,pathname:t,querystring:this.config.trackQuerystring?e.search:"",screenWidth:screen.width,screenHeight:screen.height,language:navigator.language,page_title:document.title,referrer:document.referrer};return this.customUserId&&(n.user_id=this.customUserId),this.config.apiKey&&(n.api_key=this.config.apiKey),n}async sendTrackingData(e){try{await fetch(`${this.config.analyticsHost}/track`,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(e),mode:"cors",keepalive:!0})}catch(t){console.error("Failed to send tracking data:",t)}}track(e,t="",r={}){if(e==="custom_event"&&(!t||typeof t!="string")){console.error("Event name is required and must be a string for custom events");return}let n=this.createBasePayload();if(!n)return;let c={...n,type:e,event_name:t,properties:e==="custom_event"||e==="outbound"||e==="error"?JSON.stringify(r):void 0};this.sendTrackingData(c)}trackPageview(){this.track("pageview")}trackEvent(e,t={}){this.track("custom_event",e,t)}trackOutbound(e,t="",r="_self"){this.track("outbound","",{url:e,text:t,target:r})}trackWebVitals(e){let t=this.createBasePayload();if(!t)return;let r={...t,type:"performance",event_name:"web-vitals",...e};this.sendTrackingData(r)}trackError(e,t={}){let r=window.location.origin,n=t.filename||"",c=e.stack||"";if(n)try{if(new URL(n).origin!==r)return}catch{}else if(c&&!c.includes(r))return;let a={message:e.message?.substring(0,500)||"Unknown error",stack:c.substring(0,2e3)||""};if(n&&(a.fileName=n),t.lineno){let s=typeof t.lineno=="string"?parseInt(t.lineno,10):t.lineno;s&&s!==0&&(a.lineNumber=s)}if(t.colno){let s=typeof t.colno=="string"?parseInt(t.colno,10):t.colno;s&&s!==0&&(a.columnNumber=s)}for(let s in t)!["lineno","colno"].includes(s)&&t[s]!==void 0&&(a[s]=t[s]);this.track("error",e.name||"Error",a)}identify(e){if(typeof e!="string"||e.trim()===""){console.error("User ID must be a non-empty string");return}this.customUserId=e.trim();try{localStorage.setItem("rybbit-user-id",this.customUserId)}catch{console.warn("Could not persist user ID to localStorage")}this.sessionReplayRecorder&&this.sessionReplayRecorder.updateUserId(this.customUserId)}clearUserId(){this.customUserId=null;try{localStorage.removeItem("rybbit-user-id")}catch{}}getUserId(){return this.customUserId}startSessionReplay(){this.sessionReplayRecorder?this.sessionReplayRecorder.startRecording():console.warn("Session replay not initialized")}stopSessionReplay(){this.sessionReplayRecorder&&this.sessionReplayRecorder.stopRecording()}isSessionReplayActive(){return this.sessionReplayRecorder?.isActive()??!1}onPageChange(){this.sessionReplayRecorder&&this.sessionReplayRecorder.onPageChange()}cleanup(){this.sessionReplayRecorder&&this.sessionReplayRecorder.cleanup()}};var Q=-1,g=i=>{addEventListener("pageshow",e=>{e.persisted&&(Q=e.timeStamp,i(e))},!0)},d=(i,e,t,r)=>{let n,c;return a=>{e.value>=0&&(a||r)&&(c=e.value-(n??0),(c||n===void 0)&&(n=e.value,e.delta=c,e.rating=((s,o)=>s>o[1]?"poor":s>o[0]?"needs-improvement":"good")(e.value,t),i(e)))}},_=i=>{requestAnimationFrame(()=>requestAnimationFrame(()=>i()))},D=()=>{let i=performance.getEntriesByType("navigation")[0];if(i&&i.responseStart>0&&i.responseStart<performance.now())return i},f=()=>D()?.activationStart??0,u=(i,e=-1)=>{let t=D(),r="navigate";return Q>=0?r="back-forward-cache":t&&(document.prerendering||f()>0?r="prerender":document.wasDiscarded?r="restore":t.type&&(r=t.type.replace(/_/g,"-"))),{name:i,value:e,rating:"good",delta:0,entries:[],id:`v5-${Date.now()}-${Math.floor(8999999999999*Math.random())+1e12}`,navigationType:r}},P=new WeakMap;function O(i,e){return P.get(i)||P.set(i,new e),P.get(i)}var I=class{constructor(){h(this,"t");h(this,"i",0);h(this,"o",[])}h(e){if(e.hadRecentInput)return;let t=this.o[0],r=this.o.at(-1);this.i&&t&&r&&e.startTime-r.startTime<1e3&&e.startTime-t.startTime<5e3?(this.i+=e.value,this.o.push(e)):(this.i=e.value,this.o=[e]),this.t?.(e)}},m=(i,e,t={})=>{try{if(PerformanceObserver.supportedEntryTypes.includes(i)){let r=new PerformanceObserver(n=>{Promise.resolve().then(()=>{e(n.getEntries())})});return r.observe({type:i,buffered:!0,...t}),r}}catch{}},U=i=>{let e=!1;return()=>{e||(i(),e=!0)}},p=-1,H=()=>document.visibilityState!=="hidden"||document.prerendering?1/0:0,R=i=>{document.visibilityState==="hidden"&&p>-1&&(p=i.type==="visibilitychange"?i.timeStamp:0,ce())},V=()=>{addEventListener("visibilitychange",R,!0),addEventListener("prerenderingchange",R,!0)},ce=()=>{removeEventListener("visibilitychange",R,!0),removeEventListener("prerenderingchange",R,!0)},Y=()=>{if(p<0){let i=f();p=(document.prerendering?void 0:globalThis.performance.getEntriesByType("visibility-state").filter(t=>t.name==="hidden"&&t.startTime>i)[0]?.startTime)??H(),V(),g(()=>{setTimeout(()=>{p=H(),V()})})}return{get firstHiddenTime(){return p}}},w=i=>{document.prerendering?addEventListener("prerenderingchange",()=>i(),!0):i()},z=[1800,3e3],N=(i,e={})=>{w(()=>{let t=Y(),r,n=u("FCP"),c=m("paint",a=>{for(let s of a)s.name==="first-contentful-paint"&&(c.disconnect(),s.startTime<t.firstHiddenTime&&(n.value=Math.max(s.startTime-f(),0),n.entries.push(s),r(!0)))});c&&(r=d(i,n,z,e.reportAllChanges),g(a=>{n=u("FCP"),r=d(i,n,z,e.reportAllChanges),_(()=>{n.value=performance.now()-a.timeStamp,r(!0)})}))})},$=[.1,.25],X=(i,e={})=>{N(U(()=>{let t,r=u("CLS",0),n=O(e,I),c=s=>{for(let o of s)n.h(o);n.i>r.value&&(r.value=n.i,r.entries=n.o,t())},a=m("layout-shift",c);a&&(t=d(i,r,$,e.reportAllChanges),document.addEventListener("visibilitychange",()=>{document.visibilityState==="hidden"&&(c(a.takeRecords()),t(!0))}),g(()=>{n.i=0,r=u("CLS",0),t=d(i,r,$,e.reportAllChanges),_(()=>t())}),setTimeout(t))}))},Z=0,C=1/0,b=0,le=i=>{for(let e of i)e.interactionId&&(C=Math.min(C,e.interactionId),b=Math.max(b,e.interactionId),Z=b?(b-C)/7+1:0)},A,K=()=>A?Z:performance.interactionCount??0,de=()=>{"interactionCount"in performance||A||(A=m("event",le,{type:"event",buffered:!0,durationThreshold:0}))},J=0,B=class{constructor(){h(this,"u",[]);h(this,"l",new Map);h(this,"m");h(this,"v")}p(){J=K(),this.u.length=0,this.l.clear()}P(){let e=Math.min(this.u.length-1,Math.floor((K()-J)/50));return this.u[e]}h(e){if(this.m?.(e),!e.interactionId&&e.entryType!=="first-input")return;let t=this.u.at(-1),r=this.l.get(e.interactionId);if(r||this.u.length<10||e.duration>t.T){if(r?e.duration>r.T?(r.entries=[e],r.T=e.duration):e.duration===r.T&&e.startTime===r.entries[0].startTime&&r.entries.push(e):(r={id:e.interactionId,entries:[e],T:e.duration},this.l.set(r.id,r),this.u.push(r)),this.u.sort((n,c)=>c.T-n.T),this.u.length>10){let n=this.u.splice(10);for(let c of n)this.l.delete(c.id)}this.v?.(r)}}},ee=i=>{let e=globalThis.requestIdleCallback||setTimeout;document.visibilityState==="hidden"?i():(i=U(i),document.addEventListener("visibilitychange",i,{once:!0}),e(()=>{i(),document.removeEventListener("visibilitychange",i)}))},j=[200,500],te=(i,e={})=>{globalThis.PerformanceEventTiming&&"interactionId"in PerformanceEventTiming.prototype&&w(()=>{de();let t,r=u("INP"),n=O(e,B),c=s=>{ee(()=>{for(let l of s)n.h(l);let o=n.P();o&&o.T!==r.value&&(r.value=o.T,r.entries=o.entries,t())})},a=m("event",c,{durationThreshold:e.durationThreshold??40});t=d(i,r,j,e.reportAllChanges),a&&(a.observe({type:"first-input",buffered:!0}),document.addEventListener("visibilitychange",()=>{document.visibilityState==="hidden"&&(c(a.takeRecords()),t(!0))}),g(()=>{n.p(),r=u("INP"),t=d(i,r,j,e.reportAllChanges)}))})},L=class{constructor(){h(this,"m")}h(e){this.m?.(e)}},q=[2500,4e3],ie=(i,e={})=>{w(()=>{let t=Y(),r,n=u("LCP"),c=O(e,L),a=o=>{e.reportAllChanges||(o=o.slice(-1));for(let l of o)c.h(l),l.startTime<t.firstHiddenTime&&(n.value=Math.max(l.startTime-f(),0),n.entries=[l],r())},s=m("largest-contentful-paint",a);if(s){r=d(i,n,q,e.reportAllChanges);let o=U(()=>{a(s.takeRecords()),s.disconnect(),r(!0)});for(let l of["keydown","click","visibilitychange"])addEventListener(l,()=>ee(o),{capture:!0,once:!0});g(l=>{n=u("LCP"),r=d(i,n,q,e.reportAllChanges),_(()=>{n.value=performance.now()-l.timeStamp,r(!0)})})}})},G=[800,1800],M=i=>{document.prerendering?w(()=>M(i)):document.readyState!=="complete"?addEventListener("load",()=>M(i),!0):setTimeout(i)},re=(i,e={})=>{let t=u("TTFB"),r=d(i,t,G,e.reportAllChanges);M(()=>{let n=D();n&&(t.value=Math.max(n.responseStart-f(),0),t.entries=[n],r(!0),g(()=>{t=u("TTFB",0),r=d(i,t,G,e.reportAllChanges),r(!0)}))})};var S=class{constructor(e){this.data={lcp:null,cls:null,inp:null,fcp:null,ttfb:null};this.sent=!1;this.timeout=null;this.onReadyCallback=null;this.onReadyCallback=e}initialize(){try{ie(this.collectMetric.bind(this)),X(this.collectMetric.bind(this)),te(this.collectMetric.bind(this)),N(this.collectMetric.bind(this)),re(this.collectMetric.bind(this)),this.timeout=setTimeout(()=>{this.sent||this.sendData()},2e4),window.addEventListener("beforeunload",()=>{this.sent||this.sendData()})}catch(e){console.warn("Error initializing web vitals tracking:",e)}}collectMetric(e){if(this.sent)return;let t=e.name.toLowerCase();this.data[t]=e.value,Object.values(this.data).every(n=>n!==null)&&this.sendData()}sendData(){this.sent||(this.sent=!0,this.timeout&&(clearTimeout(this.timeout),this.timeout=null),this.onReadyCallback&&this.onReadyCallback(this.data))}getData(){return{...this.data}}};(function(){let i=document.currentScript;if(!i){console.error("Could not find current script tag");return}if(window.__RYBBIT_OPTOUT__||localStorage.getItem("disable-rybbit")!==null){window.rybbit={pageview:()=>{},event:()=>{},trackOutbound:()=>{},identify:()=>{},clearUserId:()=>{},getUserId:()=>null,startSessionReplay:()=>{},stopSessionReplay:()=>{},isSessionReplayActive:()=>!1};return}let e=W(i);if(!e)return;let t=new y(e);e.enableWebVitals&&new S(s=>{t.trackWebVitals(s)}).initialize(),e.trackErrors&&(window.addEventListener("error",a=>{t.trackError(a.error||new Error(a.message),{filename:a.filename,lineno:a.lineno,colno:a.colno})}),window.addEventListener("unhandledrejection",a=>{let s=a.reason instanceof Error?a.reason:new Error(String(a.reason));t.trackError(s,{type:"unhandledrejection"})}));let r=()=>t.trackPageview(),n=e.debounceDuration>0?x(r,e.debounceDuration):r;function c(){if(document.addEventListener("click",function(a){let s=a.target;for(;s&&s!==document.documentElement;){if(s.hasAttribute("data-rybbit-event")){let o=s.getAttribute("data-rybbit-event");if(o){let l={};for(let T of s.attributes)if(T.name.startsWith("data-rybbit-prop-")){let ne=T.name.replace("data-rybbit-prop-","");l[ne]=T.value}t.trackEvent(o,l)}break}s=s.parentElement}if(e.trackOutbound){let o=a.target.closest("a");o?.href&&F(o.href)&&t.trackOutbound(o.href,o.innerText||o.textContent||"",o.target||"_self")}}),e.autoTrackSpa){let a=history.pushState,s=history.replaceState;history.pushState=function(...o){a.apply(this,o),n(),t.onPageChange()},history.replaceState=function(...o){s.apply(this,o),n(),t.onPageChange()},window.addEventListener("popstate",()=>{n(),t.onPageChange()}),window.addEventListener("hashchange",()=>{n(),t.onPageChange()})}}window.rybbit={pageview:()=>t.trackPageview(),event:(a,s={})=>t.trackEvent(a,s),trackOutbound:(a,s="",o="_self")=>t.trackOutbound(a,s,o),identify:a=>t.identify(a),clearUserId:()=>t.clearUserId(),getUserId:()=>t.getUserId(),startSessionReplay:()=>t.startSessionReplay(),stopSessionReplay:()=>t.stopSessionReplay(),isSessionReplayActive:()=>t.isSessionReplayActive()},c(),window.addEventListener("beforeunload",()=>{t.cleanup()}),e.autoTrackPageview&&t.trackPageview()})();})();
+"use strict";(()=>{var se=Object.defineProperty;var ae=(i,e,t)=>e in i?se(i,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):i[e]=t;var h=(i,e,t)=>ae(i,typeof e!="symbol"?e+"":e,t);function oe(i){let e="__DOUBLE_ASTERISK_TOKEN__",t="__SINGLE_ASTERISK_TOKEN__",n=i.replace(/\*\*/g,e).replace(/\*/g,t).replace(/[.+?^${}()|[\]\\]/g,"\\$&");n=n.replace(new RegExp(`/${e}/`,"g"),"/(?:.+/)?"),n=n.replace(new RegExp(e,"g"),".*"),n=n.replace(/\//g,"\\/");let c=n.replace(new RegExp(t,"g"),"[^/]+");return new RegExp("^"+c+"$")}function k(i,e){for(let t of e)try{if(oe(t).test(i))return t}catch(r){console.error(`Invalid pattern: ${t}`,r)}return null}function x(i,e){let t=null;return(...r)=>{t&&clearTimeout(t),t=setTimeout(()=>i(...r),e)}}function F(i){try{let e=window.location.hostname,t=new URL(i).hostname;return t!==e&&t!==""}catch{return!1}}function E(i,e){if(!i)return e;try{let t=JSON.parse(i);return Array.isArray(e)&&!Array.isArray(t)?e:t}catch(t){return console.error("Error parsing JSON:",t),e}}function W(i){let e=i.getAttribute("src");if(!e)return console.error("Script src attribute is missing"),null;let t=e.split("/script.js")[0];if(!t)return console.error("Please provide a valid analytics host"),null;let r=i.getAttribute("data-site-id")||i.getAttribute("site-id");if(!r||isNaN(Number(r)))return console.error("Please provide a valid site ID using the data-site-id attribute"),null;let n=i.getAttribute("data-debounce")?Math.max(0,parseInt(i.getAttribute("data-debounce"))):500,c=E(i.getAttribute("data-skip-patterns"),[]),a=E(i.getAttribute("data-mask-patterns"),[]),s=i.getAttribute("data-api-key")||void 0,o=i.getAttribute("data-replay-batch-size")?Math.max(1,parseInt(i.getAttribute("data-replay-batch-size"))):25,l=i.getAttribute("data-replay-batch-interval")?Math.max(1e3,parseInt(i.getAttribute("data-replay-batch-interval"))):2e3;return{analyticsHost:t,siteId:r,debounceDuration:n,autoTrackPageview:i.getAttribute("data-auto-track-pageview")!=="false",autoTrackSpa:i.getAttribute("data-track-spa")!=="false",trackQuerystring:i.getAttribute("data-track-query")!=="false",trackOutbound:i.getAttribute("data-track-outbound")!=="false",enableWebVitals:i.getAttribute("data-web-vitals")==="true",trackErrors:i.getAttribute("data-track-errors")==="true",enableSessionReplay:i.getAttribute("data-session-replay")==="true",sessionReplayBatchSize:o,sessionReplayBatchInterval:l,skipPatterns:c,maskPatterns:a,apiKey:s}}var y=class{constructor(e,t,r){this.isRecording=!1;this.eventBuffer=[];this.config=e,this.userId=t,this.sendBatch=r}async initialize(){this.config.enableSessionReplay&&(window.rrweb||await this.loadRrweb(),window.rrweb&&this.startRecording())}async loadRrweb(){return new Promise((e,t)=>{let r=document.createElement("script");r.src=`${this.config.analyticsHost}/replay.js`,r.async=!1,r.onload=()=>{e()},r.onerror=()=>t(new Error("Failed to load rrweb")),document.head.appendChild(r)})}startRecording(){if(!(this.isRecording||!window.rrweb||!this.config.enableSessionReplay))try{this.stopRecordingFn=window.rrweb.record({emit:e=>{this.addEvent({type:e.type,data:e.data,timestamp:e.timestamp||Date.now()})},recordCanvas:!0,collectFonts:!0,checkoutEveryNms:3e4,checkoutEveryNth:200,maskAllInputs:!0,maskInputOptions:{password:!0,email:!0},slimDOMOptions:{script:!1,comment:!0,headFavicon:!0,headWhitespace:!0,headMetaDescKeywords:!0,headMetaSocial:!0,headMetaRobots:!0,headMetaHttpEquiv:!0,headMetaAuthorship:!0,headMetaVerification:!0},sampling:{mousemove:!1,mouseInteraction:!0,scroll:150,input:"last"}}),this.isRecording=!0,this.setupBatchTimer()}catch{}}stopRecording(){this.isRecording&&(this.stopRecordingFn&&this.stopRecordingFn(),this.isRecording=!1,this.clearBatchTimer(),this.eventBuffer.length>0&&this.flushEvents())}isActive(){return this.isRecording}addEvent(e){this.eventBuffer.push(e),this.eventBuffer.length>=this.config.sessionReplayBatchSize&&this.flushEvents()}setupBatchTimer(){this.clearBatchTimer(),this.batchTimer=window.setInterval(()=>{this.eventBuffer.length>0&&this.flushEvents()},this.config.sessionReplayBatchInterval)}clearBatchTimer(){this.batchTimer&&(clearInterval(this.batchTimer),this.batchTimer=void 0)}async flushEvents(){if(this.eventBuffer.length===0)return;let e=[...this.eventBuffer];this.eventBuffer=[];let t={userId:this.userId,events:e,metadata:{pageUrl:window.location.href,viewportWidth:screen.width,viewportHeight:screen.height,language:navigator.language}};try{await this.sendBatch(t)}catch{this.eventBuffer.unshift(...e)}}updateUserId(e){this.userId=e}onPageChange(){this.isRecording&&this.flushEvents()}cleanup(){this.stopRecording()}};var v=class{constructor(e){this.customUserId=null;this.config=e,this.loadUserId(),e.enableSessionReplay&&this.initializeSessionReplay()}loadUserId(){try{let e=localStorage.getItem("rybbit-user-id");e&&(this.customUserId=e)}catch{}}async initializeSessionReplay(){try{this.sessionReplayRecorder=new y(this.config,this.customUserId||"",e=>this.sendSessionReplayBatch(e)),await this.sessionReplayRecorder.initialize()}catch(e){console.error("Failed to initialize session replay:",e)}}async sendSessionReplayBatch(e){try{this.config.apiKey&&(e.apiKey=this.config.apiKey),await fetch(`${this.config.analyticsHost}/session-replay/record/${this.config.siteId}`,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(e),mode:"cors",keepalive:!1})}catch(t){throw console.error("Failed to send session replay batch:",t),t}}createBasePayload(){let e=new URL(window.location.href),t=e.pathname;if(e.hash&&e.hash.startsWith("#/")&&(t=e.hash.substring(1)),k(t,this.config.skipPatterns))return null;let r=k(t,this.config.maskPatterns);r&&(t=r);let n={site_id:this.config.siteId,hostname:e.hostname,pathname:t,querystring:this.config.trackQuerystring?e.search:"",screenWidth:screen.width,screenHeight:screen.height,language:navigator.language,page_title:document.title,referrer:document.referrer};return this.customUserId&&(n.user_id=this.customUserId),this.config.apiKey&&(n.api_key=this.config.apiKey),n}async sendTrackingData(e){try{await fetch(`${this.config.analyticsHost}/track`,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(e),mode:"cors",keepalive:!0})}catch(t){console.error("Failed to send tracking data:",t)}}track(e,t="",r={}){if(e==="custom_event"&&(!t||typeof t!="string")){console.error("Event name is required and must be a string for custom events");return}let n=this.createBasePayload();if(!n)return;let c={...n,type:e,event_name:t,properties:e==="custom_event"||e==="outbound"||e==="error"?JSON.stringify(r):void 0};this.sendTrackingData(c)}trackPageview(){this.track("pageview")}trackEvent(e,t={}){this.track("custom_event",e,t)}trackOutbound(e,t="",r="_self"){this.track("outbound","",{url:e,text:t,target:r})}trackWebVitals(e){let t=this.createBasePayload();if(!t)return;let r={...t,type:"performance",event_name:"web-vitals",...e};this.sendTrackingData(r)}trackError(e,t={}){let r=window.location.origin,n=t.filename||"",c=e.stack||"";if(n)try{if(new URL(n).origin!==r)return}catch{}else if(c&&!c.includes(r))return;let a={message:e.message?.substring(0,500)||"Unknown error",stack:c.substring(0,2e3)||""};if(n&&(a.fileName=n),t.lineno){let s=typeof t.lineno=="string"?parseInt(t.lineno,10):t.lineno;s&&s!==0&&(a.lineNumber=s)}if(t.colno){let s=typeof t.colno=="string"?parseInt(t.colno,10):t.colno;s&&s!==0&&(a.columnNumber=s)}for(let s in t)!["lineno","colno"].includes(s)&&t[s]!==void 0&&(a[s]=t[s]);this.track("error",e.name||"Error",a)}identify(e){if(typeof e!="string"||e.trim()===""){console.error("User ID must be a non-empty string");return}this.customUserId=e.trim();try{localStorage.setItem("rybbit-user-id",this.customUserId)}catch{console.warn("Could not persist user ID to localStorage")}this.sessionReplayRecorder&&this.sessionReplayRecorder.updateUserId(this.customUserId)}clearUserId(){this.customUserId=null;try{localStorage.removeItem("rybbit-user-id")}catch{}}getUserId(){return this.customUserId}startSessionReplay(){this.sessionReplayRecorder?this.sessionReplayRecorder.startRecording():console.warn("Session replay not initialized")}stopSessionReplay(){this.sessionReplayRecorder&&this.sessionReplayRecorder.stopRecording()}isSessionReplayActive(){return this.sessionReplayRecorder?.isActive()??!1}onPageChange(){this.sessionReplayRecorder&&this.sessionReplayRecorder.onPageChange()}cleanup(){this.sessionReplayRecorder&&this.sessionReplayRecorder.cleanup()}};var Q=-1,g=i=>{addEventListener("pageshow",e=>{e.persisted&&(Q=e.timeStamp,i(e))},!0)},d=(i,e,t,r)=>{let n,c;return a=>{e.value>=0&&(a||r)&&(c=e.value-(n??0),(c||n===void 0)&&(n=e.value,e.delta=c,e.rating=((s,o)=>s>o[1]?"poor":s>o[0]?"needs-improvement":"good")(e.value,t),i(e)))}},_=i=>{requestAnimationFrame(()=>requestAnimationFrame(()=>i()))},D=()=>{let i=performance.getEntriesByType("navigation")[0];if(i&&i.responseStart>0&&i.responseStart<performance.now())return i},f=()=>D()?.activationStart??0,u=(i,e=-1)=>{let t=D(),r="navigate";return Q>=0?r="back-forward-cache":t&&(document.prerendering||f()>0?r="prerender":document.wasDiscarded?r="restore":t.type&&(r=t.type.replace(/_/g,"-"))),{name:i,value:e,rating:"good",delta:0,entries:[],id:`v5-${Date.now()}-${Math.floor(8999999999999*Math.random())+1e12}`,navigationType:r}},P=new WeakMap;function O(i,e){return P.get(i)||P.set(i,new e),P.get(i)}var I=class{constructor(){h(this,"t");h(this,"i",0);h(this,"o",[])}h(e){if(e.hadRecentInput)return;let t=this.o[0],r=this.o.at(-1);this.i&&t&&r&&e.startTime-r.startTime<1e3&&e.startTime-t.startTime<5e3?(this.i+=e.value,this.o.push(e)):(this.i=e.value,this.o=[e]),this.t?.(e)}},m=(i,e,t={})=>{try{if(PerformanceObserver.supportedEntryTypes.includes(i)){let r=new PerformanceObserver(n=>{Promise.resolve().then(()=>{e(n.getEntries())})});return r.observe({type:i,buffered:!0,...t}),r}}catch{}},U=i=>{let e=!1;return()=>{e||(i(),e=!0)}},p=-1,H=()=>document.visibilityState!=="hidden"||document.prerendering?1/0:0,R=i=>{document.visibilityState==="hidden"&&p>-1&&(p=i.type==="visibilitychange"?i.timeStamp:0,ce())},V=()=>{addEventListener("visibilitychange",R,!0),addEventListener("prerenderingchange",R,!0)},ce=()=>{removeEventListener("visibilitychange",R,!0),removeEventListener("prerenderingchange",R,!0)},Y=()=>{if(p<0){let i=f();p=(document.prerendering?void 0:globalThis.performance.getEntriesByType("visibility-state").filter(t=>t.name==="hidden"&&t.startTime>i)[0]?.startTime)??H(),V(),g(()=>{setTimeout(()=>{p=H(),V()})})}return{get firstHiddenTime(){return p}}},w=i=>{document.prerendering?addEventListener("prerenderingchange",()=>i(),!0):i()},z=[1800,3e3],N=(i,e={})=>{w(()=>{let t=Y(),r,n=u("FCP"),c=m("paint",a=>{for(let s of a)s.name==="first-contentful-paint"&&(c.disconnect(),s.startTime<t.firstHiddenTime&&(n.value=Math.max(s.startTime-f(),0),n.entries.push(s),r(!0)))});c&&(r=d(i,n,z,e.reportAllChanges),g(a=>{n=u("FCP"),r=d(i,n,z,e.reportAllChanges),_(()=>{n.value=performance.now()-a.timeStamp,r(!0)})}))})},K=[.1,.25],X=(i,e={})=>{N(U(()=>{let t,r=u("CLS",0),n=O(e,I),c=s=>{for(let o of s)n.h(o);n.i>r.value&&(r.value=n.i,r.entries=n.o,t())},a=m("layout-shift",c);a&&(t=d(i,r,K,e.reportAllChanges),document.addEventListener("visibilitychange",()=>{document.visibilityState==="hidden"&&(c(a.takeRecords()),t(!0))}),g(()=>{n.i=0,r=u("CLS",0),t=d(i,r,K,e.reportAllChanges),_(()=>t())}),setTimeout(t))}))},Z=0,C=1/0,b=0,le=i=>{for(let e of i)e.interactionId&&(C=Math.min(C,e.interactionId),b=Math.max(b,e.interactionId),Z=b?(b-C)/7+1:0)},A,$=()=>A?Z:performance.interactionCount??0,de=()=>{"interactionCount"in performance||A||(A=m("event",le,{type:"event",buffered:!0,durationThreshold:0}))},J=0,B=class{constructor(){h(this,"u",[]);h(this,"l",new Map);h(this,"m");h(this,"v")}p(){J=$(),this.u.length=0,this.l.clear()}P(){let e=Math.min(this.u.length-1,Math.floor(($()-J)/50));return this.u[e]}h(e){if(this.m?.(e),!e.interactionId&&e.entryType!=="first-input")return;let t=this.u.at(-1),r=this.l.get(e.interactionId);if(r||this.u.length<10||e.duration>t.T){if(r?e.duration>r.T?(r.entries=[e],r.T=e.duration):e.duration===r.T&&e.startTime===r.entries[0].startTime&&r.entries.push(e):(r={id:e.interactionId,entries:[e],T:e.duration},this.l.set(r.id,r),this.u.push(r)),this.u.sort((n,c)=>c.T-n.T),this.u.length>10){let n=this.u.splice(10);for(let c of n)this.l.delete(c.id)}this.v?.(r)}}},ee=i=>{let e=globalThis.requestIdleCallback||setTimeout;document.visibilityState==="hidden"?i():(i=U(i),document.addEventListener("visibilitychange",i,{once:!0}),e(()=>{i(),document.removeEventListener("visibilitychange",i)}))},j=[200,500],te=(i,e={})=>{globalThis.PerformanceEventTiming&&"interactionId"in PerformanceEventTiming.prototype&&w(()=>{de();let t,r=u("INP"),n=O(e,B),c=s=>{ee(()=>{for(let l of s)n.h(l);let o=n.P();o&&o.T!==r.value&&(r.value=o.T,r.entries=o.entries,t())})},a=m("event",c,{durationThreshold:e.durationThreshold??40});t=d(i,r,j,e.reportAllChanges),a&&(a.observe({type:"first-input",buffered:!0}),document.addEventListener("visibilitychange",()=>{document.visibilityState==="hidden"&&(c(a.takeRecords()),t(!0))}),g(()=>{n.p(),r=u("INP"),t=d(i,r,j,e.reportAllChanges)}))})},L=class{constructor(){h(this,"m")}h(e){this.m?.(e)}},q=[2500,4e3],ie=(i,e={})=>{w(()=>{let t=Y(),r,n=u("LCP"),c=O(e,L),a=o=>{e.reportAllChanges||(o=o.slice(-1));for(let l of o)c.h(l),l.startTime<t.firstHiddenTime&&(n.value=Math.max(l.startTime-f(),0),n.entries=[l],r())},s=m("largest-contentful-paint",a);if(s){r=d(i,n,q,e.reportAllChanges);let o=U(()=>{a(s.takeRecords()),s.disconnect(),r(!0)});for(let l of["keydown","click","visibilitychange"])addEventListener(l,()=>ee(o),{capture:!0,once:!0});g(l=>{n=u("LCP"),r=d(i,n,q,e.reportAllChanges),_(()=>{n.value=performance.now()-l.timeStamp,r(!0)})})}})},G=[800,1800],M=i=>{document.prerendering?w(()=>M(i)):document.readyState!=="complete"?addEventListener("load",()=>M(i),!0):setTimeout(i)},re=(i,e={})=>{let t=u("TTFB"),r=d(i,t,G,e.reportAllChanges);M(()=>{let n=D();n&&(t.value=Math.max(n.responseStart-f(),0),t.entries=[n],r(!0),g(()=>{t=u("TTFB",0),r=d(i,t,G,e.reportAllChanges),r(!0)}))})};var S=class{constructor(e){this.data={lcp:null,cls:null,inp:null,fcp:null,ttfb:null};this.sent=!1;this.timeout=null;this.onReadyCallback=null;this.onReadyCallback=e}initialize(){try{ie(this.collectMetric.bind(this)),X(this.collectMetric.bind(this)),te(this.collectMetric.bind(this)),N(this.collectMetric.bind(this)),re(this.collectMetric.bind(this)),this.timeout=setTimeout(()=>{this.sent||this.sendData()},2e4),window.addEventListener("beforeunload",()=>{this.sent||this.sendData()})}catch(e){console.warn("Error initializing web vitals tracking:",e)}}collectMetric(e){if(this.sent)return;let t=e.name.toLowerCase();this.data[t]=e.value,Object.values(this.data).every(n=>n!==null)&&this.sendData()}sendData(){this.sent||(this.sent=!0,this.timeout&&(clearTimeout(this.timeout),this.timeout=null),this.onReadyCallback&&this.onReadyCallback(this.data))}getData(){return{...this.data}}};(function(){let i=document.currentScript;if(!i){console.error("Could not find current script tag");return}if(window.__RYBBIT_OPTOUT__||localStorage.getItem("disable-rybbit")!==null){window.rybbit={pageview:()=>{},event:()=>{},trackOutbound:()=>{},identify:()=>{},clearUserId:()=>{},getUserId:()=>null,startSessionReplay:()=>{},stopSessionReplay:()=>{},isSessionReplayActive:()=>!1};return}let e=W(i);if(!e)return;let t=new v(e);e.enableWebVitals&&new S(s=>{t.trackWebVitals(s)}).initialize(),e.trackErrors&&(window.addEventListener("error",a=>{t.trackError(a.error||new Error(a.message),{filename:a.filename,lineno:a.lineno,colno:a.colno})}),window.addEventListener("unhandledrejection",a=>{let s=a.reason instanceof Error?a.reason:new Error(String(a.reason));t.trackError(s,{type:"unhandledrejection"})}));let r=()=>t.trackPageview(),n=e.debounceDuration>0?x(r,e.debounceDuration):r;function c(){if(document.addEventListener("click",function(a){let s=a.target;for(;s&&s!==document.documentElement;){if(s.hasAttribute("data-rybbit-event")){let o=s.getAttribute("data-rybbit-event");if(o){let l={};for(let T of s.attributes)if(T.name.startsWith("data-rybbit-prop-")){let ne=T.name.replace("data-rybbit-prop-","");l[ne]=T.value}t.trackEvent(o,l)}break}s=s.parentElement}if(e.trackOutbound){let o=a.target.closest("a");o?.href&&F(o.href)&&t.trackOutbound(o.href,o.innerText||o.textContent||"",o.target||"_self")}}),e.autoTrackSpa){let a=history.pushState,s=history.replaceState;history.pushState=function(...o){a.apply(this,o),n(),t.onPageChange()},history.replaceState=function(...o){s.apply(this,o),n(),t.onPageChange()},window.addEventListener("popstate",()=>{n(),t.onPageChange()}),window.addEventListener("hashchange",()=>{n(),t.onPageChange()})}}window.rybbit={pageview:()=>t.trackPageview(),event:(a,s={})=>t.trackEvent(a,s),trackOutbound:(a,s="",o="_self")=>t.trackOutbound(a,s,o),identify:a=>t.identify(a),clearUserId:()=>t.clearUserId(),getUserId:()=>t.getUserId(),startSessionReplay:()=>t.startSessionReplay(),stopSessionReplay:()=>t.stopSessionReplay(),isSessionReplayActive:()=>t.isSessionReplayActive()},c(),window.addEventListener("beforeunload",()=>{t.cleanup()}),e.autoTrackPageview&&t.trackPageview()})();})();
diff --git a/server/src/analytics-script/tracking.ts b/server/src/analytics-script/tracking.ts
index 5db0b3bf7..4218ab4f3 100644
--- a/server/src/analytics-script/tracking.ts
+++ b/server/src/analytics-script/tracking.ts
@@ -50,6 +50,11 @@ export class Tracker {
batch: SessionReplayBatch
): Promise<void> {
try {
+ // Include API key if configured
+ if (this.config.apiKey) {
+ batch.apiKey = this.config.apiKey;
+ }
+
await fetch(
`${this.config.analyticsHost}/session-replay/record/${this.config.siteId}`,
{
diff --git a/server/src/analytics-script/types.ts b/server/src/analytics-script/types.ts
index ee64913ac..1839d0afc 100644
--- a/server/src/analytics-script/types.ts
+++ b/server/src/analytics-script/types.ts
@@ -77,4 +77,5 @@ export interface SessionReplayBatch {
viewportHeight?: number;
language?: string;
};
+ apiKey?: string;
}
diff --git a/server/src/api/sessionReplay/recordSessionReplay.ts b/server/src/api/sessionReplay/recordSessionReplay.ts
index 65ff3489d..e23021e00 100644
--- a/server/src/api/sessionReplay/recordSessionReplay.ts
+++ b/server/src/api/sessionReplay/recordSessionReplay.ts
@@ -3,6 +3,7 @@ import { z } from "zod";
import { SessionReplayIngestService } from "../../services/replay/sessionReplayIngestService.js";
import { RecordSessionReplayRequest } from "../../types/sessionReplay.js";
import { getIpAddress } from "../../utils.js";
+import { validateApiKey, validateOrigin, checkApiKeyRateLimit } from "../../services/shared/requestValidation.js";
const recordSessionReplaySchema = z.object({
userId: z.string(),
@@ -21,6 +22,7 @@ const recordSessionReplaySchema = z.object({
language: z.string().optional(),
})
.optional(),
+ apiKey: z.string().max(35).optional(), // rb_ prefix + 32 hex chars
});
export async function recordSessionReplay(
@@ -34,6 +36,46 @@ export async function recordSessionReplay(
const siteId = Number(request.params.site);
const body = recordSessionReplaySchema.parse(request.body) as RecordSessionReplayRequest;
+ // First check if API key is provided and valid
+ const apiKeyValidation = await validateApiKey(siteId, body.apiKey);
+
+ // If API key validation failed with an error, reject the request
+ if (apiKeyValidation.error) {
+ console.warn(`[SessionReplay] Request rejected for site ${siteId}: ${apiKeyValidation.error}`);
+ return reply.status(403).send({
+ success: false,
+ error: apiKeyValidation.error,
+ });
+ }
+
+ // Check rate limit for API key authenticated requests
+ // ratelimit for session replays doesn't really work right now
+
+ // if (apiKeyValidation.success && body.apiKey) {
+ // if (!checkApiKeyRateLimit(body.apiKey)) {
+ // console.warn(
+ // `[SessionReplay] Rate limit exceeded for API key ${body.apiKey} on site ${siteId}`,
+ // );
+ // return reply.status(429).send({
+ // success: false,
+ // error: "Rate limit exceeded. Maximum 20 requests per second per API key.",
+ // });
+ // }
+ // }
+
+ // If no valid API key, validate origin
+ if (!apiKeyValidation.success) {
+ const originValidation = await validateOrigin(siteId, request.headers.origin as string);
+
+ if (!originValidation.success) {
+ console.warn(`[SessionReplay] Request rejected for site ${siteId}: ${originValidation.error}`);
+ return reply.status(403).send({
+ success: false,
+ error: originValidation.error,
+ });
+ }
+ }
+
// Extract request metadata for tracking
const userAgent = request.headers["user-agent"] || "";
const ipAddress = getIpAddress(request);
diff --git a/server/src/index.ts b/server/src/index.ts
index 2d475c7b8..f1c2e10da 100644
--- a/server/src/index.ts
+++ b/server/src/index.ts
@@ -66,7 +66,7 @@ import { getSessionFromReq, mapHeaders } from "./lib/auth-utils.js";
import { auth } from "./lib/auth.js";
import { IS_CLOUD } from "./lib/const.js";
import { siteConfig } from "./lib/siteConfig.js";
-import { trackEvent } from "./tracker/trackEvent.js";
+import { trackEvent } from "./services/tracker/trackEvent.js";
import { extractSiteId, isSitePublic } from "./utils.js";
const __filename = fileURLToPath(import.meta.url);
@@ -114,7 +114,7 @@ server.register(
/* c8 ignore next 3 */
(_request, _payload, done) => {
done(null, null);
- }
+ },
);
fastify.all("/api/auth/*", async (request, reply: any) => {
@@ -127,7 +127,7 @@ server.register(
});
});
},
- { auth: auth! }
+ { auth: auth! },
);
const PUBLIC_ROUTES: string[] = [
@@ -221,21 +221,13 @@ server.addHook("onRequest", async (request, reply) => {
// Serve analytics scripts with generic names to avoid ad-blocker detection
server.get("/api/script.js", async (_, reply) => reply.sendFile("script.js"));
-server.get("/api/replay.js", async (_, reply) =>
- reply.sendFile("rrweb.min.js")
-);
-server.get("/api/metrics.js", async (_, reply) =>
- reply.sendFile("web-vitals.iife.js")
-);
+server.get("/api/replay.js", async (_, reply) => reply.sendFile("rrweb.min.js"));
+server.get("/api/metrics.js", async (_, reply) => reply.sendFile("web-vitals.iife.js"));
// Analytics
// This endpoint gets called a lot so we don't want to log it
-server.get(
- "/api/live-user-count/:site",
- { logLevel: "silent" },
- getLiveUsercount
-);
+server.get("/api/live-user-count/:site", { logLevel: "silent" }, getLiveUsercount);
server.get("/api/overview/:site", getOverview);
server.get("/api/overview-bucketed/:site", getOverviewBucketed);
server.get("/api/single-col/:site", getSingleCol);
@@ -289,10 +281,7 @@ server.get("/api/get-sites-from-org/:organizationId", getSitesFromOrg);
server.get("/api/get-site/:id", getSite);
server.get("/api/site/:siteId/api-config", getSiteApiConfig);
server.post("/api/site/:siteId/api-config", updateSiteApiConfig);
-server.get(
- "/api/list-organization-members/:organizationId",
- listOrganizationMembers
-);
+server.get("/api/list-organization-members/:organizationId", listOrganizationMembers);
server.get("/api/user/organizations", getUserOrganizations);
if (IS_CLOUD) {
@@ -300,11 +289,7 @@ if (IS_CLOUD) {
server.post("/api/stripe/create-checkout-session", createCheckoutSession);
server.post("/api/stripe/create-portal-session", createPortalSession);
server.get("/api/stripe/subscription", getSubscription);
- server.post(
- "/api/stripe/webhook",
- { config: { rawBody: true } },
- handleWebhook
- ); // Use rawBody parser config for webhook
+ server.post("/api/stripe/webhook", { config: { rawBody: true } }, handleWebhook); // Use rawBody parser config for webhook
// Admin Routes
server.get("/api/admin/sites", getAdminSites);
@@ -314,9 +299,7 @@ if (IS_CLOUD) {
server.post("/track", trackEvent);
server.post("/api/track", trackEvent);
-server.get("/api/health", { logLevel: "silent" }, (_, reply) =>
- reply.send("OK")
-);
+server.get("/api/health", { logLevel: "silent" }, (_, reply) => reply.send("OK"));
const start = async () => {
try {
diff --git a/server/src/services/replay/trackingUtils.ts b/server/src/services/replay/trackingUtils.ts
index 9c9cb20e4..909384fad 100644
--- a/server/src/services/replay/trackingUtils.ts
+++ b/server/src/services/replay/trackingUtils.ts
@@ -1,6 +1,6 @@
import { UAParser } from "ua-parser-js";
import { getLocation } from "../../db/geolocation/geolocation.js";
-import { getChannel } from "../../tracker/getChannel.js";
+import { getChannel } from "../tracker/getChannel.js";
import { getDeviceType } from "../../utils.js";
export interface TrackingData {
@@ -32,7 +32,7 @@ export async function parseTrackingData(
hostname: string,
language: string,
screenWidth: number,
- screenHeight: number
+ screenHeight: number,
): Promise<TrackingData> {
// Parse user agent
const ua = UAParser(userAgent);
@@ -112,11 +112,7 @@ export function getOSInfo(userAgent: string): {
/**
* Get device type from user agent and screen dimensions
*/
-export function getDeviceTypeFromUA(
- userAgent: string,
- screenWidth: number,
- screenHeight: number
-): string {
+export function getDeviceTypeFromUA(userAgent: string, screenWidth: number, screenHeight: number): string {
const ua = UAParser(userAgent);
return getDeviceType(screenWidth, screenHeight, ua);
}
diff --git a/server/src/services/shared/requestValidation.ts b/server/src/services/shared/requestValidation.ts
new file mode 100644
index 000000000..557add514
--- /dev/null
+++ b/server/src/services/shared/requestValidation.ts
@@ -0,0 +1,141 @@
+import { apiKeyRateLimiter } from "../../lib/rateLimiter.js";
+import { siteConfig } from "../../lib/siteConfig.js";
+import { normalizeOrigin } from "../../utils.js";
+import { DISABLE_ORIGIN_CHECK } from "../tracker/const.js";
+
+/**
+ * Result of API key validation
+ */
+export interface ApiKeyValidationResult {
+ success: boolean;
+ error?: string;
+}
+
+/**
+ * Result of origin validation
+ */
+export interface OriginValidationResult {
+ success: boolean;
+ error?: string;
+}
+
+/**
+ * Validates API key for the site
+ * @param siteId The site ID from the tracking payload
+ * @param apiKey The API key from the payload
+ * @returns An object with success status and optional error message
+ */
+export async function validateApiKey(
+ siteId: string | number,
+ apiKey?: string
+): Promise<ApiKeyValidationResult> {
+ if (!apiKey) {
+ return { success: false };
+ }
+
+ try {
+ await siteConfig.ensureInitialized();
+ const numericSiteId = typeof siteId === "string" ? parseInt(siteId, 10) : siteId;
+ const site = await siteConfig.getSiteConfig(numericSiteId);
+
+ if (!site) {
+ return { success: false, error: "Site not found" };
+ }
+
+ if (site.apiKey && apiKey === site.apiKey) {
+ console.info(`[Validation] Valid API key for site ${siteId}`);
+ return { success: true };
+ }
+
+ return { success: false, error: "Invalid API key" };
+ } catch (error) {
+ console.error("Error validating API key:", error);
+ return { success: false, error: "Failed to validate API key" };
+ }
+}
+
+/**
+ * Validates if the request's origin matches the registered domain for the site
+ * @param siteId The site ID from the tracking payload
+ * @param requestOrigin The origin header from the request
+ * @returns An object with success status and optional error message
+ */
+export async function validateOrigin(
+ siteId: string | number,
+ requestOrigin?: string
+): Promise<OriginValidationResult> {
+ try {
+ // If origin checking is disabled, return success
+ if (DISABLE_ORIGIN_CHECK) {
+ console.info(
+ `[Validation] Origin check disabled. Allowing request for site ${siteId} from origin: ${
+ requestOrigin || "none"
+ }`
+ );
+ return { success: true };
+ }
+
+ // Ensure site config is initialized
+ await siteConfig.ensureInitialized();
+
+ // Convert siteId to number
+ const numericSiteId = typeof siteId === "string" ? parseInt(siteId, 10) : siteId;
+
+ // Get the site configuration
+ const site = await siteConfig.getSiteConfig(numericSiteId);
+
+ if (!site) {
+ return {
+ success: false,
+ error: "Site not found",
+ };
+ }
+
+ // If no origin header, reject the request
+ if (!requestOrigin) {
+ return {
+ success: false,
+ error: "Origin header required",
+ };
+ }
+
+ try {
+ // Get the domain associated with this site
+ const siteDomain = site.domain;
+
+ // Normalize domains by removing all subdomain prefixes
+ const normalizedOriginHost = normalizeOrigin(requestOrigin);
+ const normalizedSiteDomain = normalizeOrigin(`https://${siteDomain}`);
+
+ // Check if the normalized domains match
+ if (normalizedOriginHost !== normalizedSiteDomain) {
+ return {
+ success: false,
+ error: `Origin mismatch. Received: ${requestOrigin}`,
+ };
+ }
+
+ return { success: true };
+ } catch (error) {
+ return {
+ success: false,
+ error: `Invalid origin format: ${requestOrigin}`,
+ };
+ }
+ } catch (error) {
+ console.error("Error validating origin:", error);
+ return {
+ success: false,
+ error: "Internal error validating origin",
+ };
+ }
+}
+
+/**
+ * Checks if the API key rate limit has been exceeded
+ * @param apiKey The API key to check
+ * @returns true if the request is allowed, false if rate limit exceeded
+ */
+export function checkApiKeyRateLimit(apiKey: string): boolean {
+ return apiKeyRateLimiter.isAllowed(apiKey);
+}
\ No newline at end of file
diff --git a/server/src/tracker/const.ts b/server/src/services/tracker/const.ts
similarity index 100%
rename from server/src/tracker/const.ts
rename to server/src/services/tracker/const.ts
diff --git a/server/src/tracker/getChannel.ts b/server/src/services/tracker/getChannel.ts
similarity index 100%
rename from server/src/tracker/getChannel.ts
rename to server/src/services/tracker/getChannel.ts
diff --git a/server/src/tracker/pageviewQueue.ts b/server/src/services/tracker/pageviewQueue.ts
similarity index 94%
rename from server/src/tracker/pageviewQueue.ts
rename to server/src/services/tracker/pageviewQueue.ts
index 6eb977c57..049540e10 100644
--- a/server/src/tracker/pageviewQueue.ts
+++ b/server/src/services/tracker/pageviewQueue.ts
@@ -1,7 +1,7 @@
import { DateTime } from "luxon";
-import { clickhouse } from "../db/clickhouse/clickhouse.js";
-import { getLocation } from "../db/geolocation/geolocation.js";
-import { getDeviceType } from "../utils.js";
+import { clickhouse } from "../../db/clickhouse/clickhouse.js";
+import { getLocation } from "../../db/geolocation/geolocation.js";
+import { getDeviceType } from "../../utils.js";
import { getChannel } from "./getChannel.js";
import { clearSelfReferrer, getAllUrlParams } from "./utils.js";
import { TrackingPayload } from "./types.js";
@@ -92,9 +92,7 @@ class PageviewQueue {
return {
site_id: pv.site_id,
- timestamp: DateTime.fromISO(pv.timestamp).toFormat(
- "yyyy-MM-dd HH:mm:ss"
- ),
+ timestamp: DateTime.fromISO(pv.timestamp).toFormat("yyyy-MM-dd HH:mm:ss"),
session_id: pv.sessionId,
user_id: pv.userId,
hostname: pv.hostname || "",
diff --git a/server/src/tracker/trackEvent.ts b/server/src/services/tracker/trackEvent.ts
similarity index 63%
rename from server/src/tracker/trackEvent.ts
rename to server/src/services/tracker/trackEvent.ts
index fd8a8a3f4..28a5e892a 100644
--- a/server/src/tracker/trackEvent.ts
+++ b/server/src/services/tracker/trackEvent.ts
@@ -1,11 +1,9 @@
import { FastifyReply, FastifyRequest } from "fastify";
import { isbot } from "isbot";
import { z, ZodError } from "zod";
-import { apiKeyRateLimiter } from "../lib/rateLimiter.js";
-import { siteConfig } from "../lib/siteConfig.js";
-import { sessionsService } from "../services/sessions/sessionsService.js";
-import { normalizeOrigin } from "../utils.js";
-import { DISABLE_ORIGIN_CHECK } from "./const.js";
+import { siteConfig } from "../../lib/siteConfig.js";
+import { sessionsService } from "../sessions/sessionsService.js";
+import { validateApiKey, validateOrigin, checkApiKeyRateLimit } from "../shared/requestValidation.js";
import { createBasePayload, isSiteOverLimit } from "./utils.js";
import { pageviewQueue } from "./pageviewQueue.js";
@@ -56,7 +54,7 @@ export const trackingPayloadSchema = z.discriminatedUnion("type", [
return false;
}
},
- { message: "Properties must be a valid JSON string" }
+ { message: "Properties must be a valid JSON string" },
)
.optional(), // Optional but must be valid JSON if present
user_id: z.string().max(255).optional(),
@@ -113,21 +111,14 @@ export const trackingPayloadSchema = z.discriminatedUnion("type", [
const parsed = JSON.parse(val);
// Validate error-specific properties
if (typeof parsed.message !== "string") return false;
- if (parsed.stack && typeof parsed.stack !== "string")
- return false;
+ if (parsed.stack && typeof parsed.stack !== "string") return false;
// Support both camelCase and lowercase for backwards compatibility
- if (parsed.fileName && typeof parsed.fileName !== "string")
- return false;
+ if (parsed.fileName && typeof parsed.fileName !== "string") return false;
- if (parsed.lineNumber && typeof parsed.lineNumber !== "number")
- return false;
+ if (parsed.lineNumber && typeof parsed.lineNumber !== "number") return false;
- if (
- parsed.columnNumber &&
- typeof parsed.columnNumber !== "number"
- )
- return false;
+ if (parsed.columnNumber && typeof parsed.columnNumber !== "number") return false;
// Apply truncation limits
if (parsed.message && parsed.message.length > 500) {
@@ -145,7 +136,7 @@ export const trackingPayloadSchema = z.discriminatedUnion("type", [
{
message:
"Properties must be valid JSON with error fields (message, stack, fileName, lineNumber, columnNumber)",
- }
+ },
),
user_id: z.string().max(255).optional(),
api_key: z.string().max(35).optional(), // rb_ prefix + 32 hex chars
@@ -155,113 +146,6 @@ export const trackingPayloadSchema = z.discriminatedUnion("type", [
.strict(),
]);
-/**
- * Validates API key for the site
- * @param siteId The site ID from the tracking payload
- * @param apiKey The API key from the payload
- * @returns An object with success status and optional error message
- */
-async function validateApiKey(siteId: string, apiKey?: string) {
- if (!apiKey) {
- return { success: false, error: null };
- }
-
- try {
- await siteConfig.ensureInitialized();
- const numericSiteId =
- typeof siteId === "string" ? parseInt(siteId, 10) : siteId;
- const site = await siteConfig.getSiteConfig(numericSiteId);
-
- if (!site) {
- return { success: false, error: "Site not found" };
- }
-
- if (site.apiKey && apiKey === site.apiKey) {
- console.info(`[Tracking] Valid API key for site ${siteId}`);
- return { success: true };
- }
-
- return { success: false, error: "Invalid API key" };
- } catch (error) {
- console.error("Error validating API key:", error);
- return { success: false, error: "Failed to validate API key" };
- }
-}
-
-/**
- * Validates if the request's origin matches the registered domain for the site
- * @param siteId The site ID from the tracking payload
- * @param requestOrigin The origin header from the request
- * @returns An object with success status and optional error message
- */
-async function validateOrigin(siteId: string, requestOrigin?: string) {
- try {
- // If origin checking is disabled, return success
- if (DISABLE_ORIGIN_CHECK) {
- console.info(
- `[Tracking] Origin check disabled. Allowing request for site ${siteId} from origin: ${
- requestOrigin || "none"
- }`
- );
- return { success: true };
- }
-
- // Ensure site config is initialized
- await siteConfig.ensureInitialized();
-
- // Convert siteId to number
- const numericSiteId =
- typeof siteId === "string" ? parseInt(siteId, 10) : siteId;
-
- // Get the site configuration
- const site = await siteConfig.getSiteConfig(numericSiteId);
-
- if (!site) {
- return {
- success: false,
- error: "Site not found",
- };
- }
-
- // If no origin header, reject the request
- if (!requestOrigin) {
- return {
- success: false,
- error: "Origin header required",
- };
- }
-
- try {
- // Get the domain associated with this site
- const siteDomain = site.domain;
-
- // Normalize domains by removing all subdomain prefixes
- const normalizedOriginHost = normalizeOrigin(requestOrigin);
- const normalizedSiteDomain = normalizeOrigin(`https://${siteDomain}`);
-
- // Check if the normalized domains match
- if (normalizedOriginHost !== normalizedSiteDomain) {
- return {
- success: false,
- error: `Origin mismatch. Received: ${requestOrigin}`,
- };
- }
-
- return { success: true };
- } catch (error) {
- return {
- success: false,
- error: `Invalid origin format: ${requestOrigin}`,
- };
- }
- } catch (error) {
- console.error("Error validating origin:", error);
- return {
- success: false,
- error: "Internal error validating origin",
- };
- }
-}
// Unified handler for all events (pageviews and custom events)
export async function trackEvent(request: FastifyRequest, reply: FastifyReply) {
@@ -281,16 +165,11 @@ export async function trackEvent(request: FastifyRequest, reply: FastifyReply) {
const validatedPayload = validationResult.data;
// First check if API key is provided and valid
- const apiKeyValidation = await validateApiKey(
- validatedPayload.site_id,
- validatedPayload.api_key
- );
+ const apiKeyValidation = await validateApiKey(validatedPayload.site_id, validatedPayload.api_key);
// If API key validation failed with an error, reject the request
if (apiKeyValidation.error) {
- console.warn(
- `[Tracking] Request rejected for site ${validatedPayload.site_id}: ${apiKeyValidation.error}`
- );
+ console.warn(`[Tracking] Request rejected for site ${validatedPayload.site_id}: ${apiKeyValidation.error}`);
return reply.status(403).send({
success: false,
error: apiKeyValidation.error,
@@ -299,29 +178,23 @@ export async function trackEvent(request: FastifyRequest, reply: FastifyReply) {
// Check rate limit for API key authenticated requests
if (apiKeyValidation.success && validatedPayload.api_key) {
- if (!apiKeyRateLimiter.isAllowed(validatedPayload.api_key)) {
+ if (!checkApiKeyRateLimit(validatedPayload.api_key)) {
console.warn(
- `[Tracking] Rate limit exceeded for API key ${validatedPayload.api_key} on site ${validatedPayload.site_id}`
+ `[Tracking] Rate limit exceeded for API key ${validatedPayload.api_key} on site ${validatedPayload.site_id}`,
);
return reply.status(429).send({
success: false,
- error:
- "Rate limit exceeded. Maximum 20 requests per second per API key.",
+ error: "Rate limit exceeded. Maximum 20 requests per second per API key.",
});
}
}
// If no valid API key, validate origin
if (!apiKeyValidation.success) {
- const originValidation = await validateOrigin(
- validatedPayload.site_id,
- request.headers.origin as string
- );
+ const originValidation = await validateOrigin(validatedPayload.site_id, request.headers.origin as string);
if (!originValidation.success) {
- console.warn(
- `[Tracking] Request rejected for site ${validatedPayload.site_id}: ${originValidation.error}`
- );
+ console.warn(`[Tracking] Request rejected for site ${validatedPayload.site_id}: ${originValidation.error}`);
return reply.status(403).send({
success: false,
error: originValidation.error,
@@ -334,17 +207,12 @@ export async function trackEvent(request: FastifyRequest, reply: FastifyReply) {
// Check if bot blocking is enabled for this site and if the request is from a bot
// Skip bot check for API key authenticated requests
- if (
- !validatedPayload.api_key &&
- siteConfig.shouldBlockBots(validatedPayload.site_id)
- ) {
+ if (!validatedPayload.api_key && siteConfig.shouldBlockBots(validatedPayload.site_id)) {
// Use custom user agent if provided, otherwise fall back to header
- const userAgent =
- validatedPayload.user_agent ||
- (request.headers["user-agent"] as string);
+ const userAgent = validatedPayload.user_agent || (request.headers["user-agent"] as string);
if (userAgent && isbot(userAgent)) {
console.log(
- `[Tracking] Bot request filtered for site ${validatedPayload.site_id} from User-Agent: ${userAgent}`
+ `[Tracking] Bot request filtered for site ${validatedPayload.site_id} from User-Agent: ${userAgent}`,
);
return reply.status(200).send({
success: true,
@@ -355,19 +223,15 @@ export async function trackEvent(request: FastifyRequest, reply: FastifyReply) {
// Check if the site has exceeded its monthly limit
if (isSiteOverLimit(validatedPayload.site_id)) {
- console.log(
- `[Tracking] Skipping event for site ${validatedPayload.site_id} - over monthly limit`
- );
- return reply
- .status(200)
- .send("Site over monthly limit, event not tracked");
+ console.log(`[Tracking] Skipping event for site ${validatedPayload.site_id} - over monthly limit`);
+ return reply.status(200).send("Site over monthly limit, event not tracked");
}
// Create base payload for the event using validated data
const payload = createBasePayload(
request, // Pass request for IP/UA
validatedPayload.type,
- validatedPayload // Add validated payload back
+ validatedPayload, // Add validated payload back
);
// Update session
const { sessionId } = await sessionsService.updateSession({
diff --git a/server/src/tracker/types.ts b/server/src/services/tracker/types.ts
similarity index 100%
rename from server/src/tracker/types.ts
rename to server/src/services/tracker/types.ts
diff --git a/server/src/tracker/utils.ts b/server/src/services/tracker/utils.ts
similarity index 95%
rename from server/src/tracker/utils.ts
rename to server/src/services/tracker/utils.ts
index c4d5df935..4a23a1bfc 100644
--- a/server/src/tracker/utils.ts
+++ b/server/src/services/tracker/utils.ts
@@ -1,11 +1,11 @@
import { FastifyRequest } from "fastify";
import UAParser, { UAParser as userAgentParser } from "ua-parser-js";
import { z } from "zod";
-import { usageService } from "../services/usageService.js";
-import { userIdService } from "../services/userId/userIdService.js";
+import { usageService } from "../usageService.js";
+import { userIdService } from "../userId/userIdService.js";
import { trackingPayloadSchema } from "./trackEvent.js";
import { TrackingPayload } from "./types.js";
-import { getIpAddress } from "../utils.js";
+import { getIpAddress } from "../../utils.js";
export type TotalTrackingPayload = TrackingPayload & {
type?: string;
diff --git a/server/src/types/sessionReplay.ts b/server/src/types/sessionReplay.ts
index b8037021e..7a771c8f4 100644
--- a/server/src/types/sessionReplay.ts
+++ b/server/src/types/sessionReplay.ts
@@ -56,6 +56,7 @@ export interface RecordSessionReplayRequest {
viewportHeight?: number;
language?: string;
};
+ apiKey?: string;
}
export interface SessionReplayListItem {