Skip to content

Commit

Permalink
Merge pull request #241 from adobe/rum-stop
Browse files Browse the repository at this point in the history 
Update RUM, and prevent endless loops
  • Loading branch information
@trieloff
trieloff authored Mar 26, 2023
2 parents 3f9bad4 + 169b68e commit 8f332a7
Showing 1 changed file with 50 additions and 107 deletions.
157 changes: 50 additions & 107 deletions blog/scripts/scripts.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,21 @@ const PRODUCTION_DOMAINS = ['business.adobe.com'];
* @param {Object} data additional data for RUM sample
*/
export function sampleRUM(checkpoint, data = {}) {
sampleRUM.defer = sampleRUM.defer || [];
const defer = (fnname) => {
sampleRUM[fnname] = sampleRUM[fnname]
|| ((...args) => sampleRUM.defer.push({ fnname, args }));
};
sampleRUM.drain = sampleRUM.drain
|| ((dfnname, fn) => {
sampleRUM[dfnname] = fn;
sampleRUM.defer
.filter(({ fnname }) => dfnname === fnname)
.forEach(({ fnname, args }) => sampleRUM[fnname](...args));
});
sampleRUM.on = (chkpnt, fn) => { sampleRUM.cases[chkpnt] = fn; };
defer('observe');
defer('cwv');
try {
window.hlx = window.hlx || {};
if (!window.hlx.rum) {
Expand All @@ -29,39 +44,34 @@ export function sampleRUM(checkpoint, data = {}) {
const random = Math.random();
const isSelected = (random * weight < 1);
// eslint-disable-next-line object-curly-newline
window.hlx.rum = { weight, id, random, isSelected };
window.hlx.rum = { weight, id, random, isSelected, sampleRUM, pings: 0 };
}
const { random, weight, id } = window.hlx.rum;
if (random && (random * weight < 1)) {
const sendPing = () => {
const { weight, id } = window.hlx.rum;
// eslint-disable-next-line max-len, no-plusplus
if (window.hlx && window.hlx.rum && window.hlx.rum.isSelected && window.hlx.MAX_RUM_PINGS > window.hlx.rum.pings++) {
const sendPing = (pdata = data) => {
// eslint-disable-next-line object-curly-newline, max-len, no-use-before-define
const body = JSON.stringify({ weight, id, referer: window.location.href, generation: window.RUM_GENERATION, checkpoint, ...data });
const body = JSON.stringify({ weight, id, referer: window.location.href, generation: window.hlx.RUM_GENERATION, checkpoint, ...data });
const url = `https://rum.hlx.page/.rum/${weight}`;
// eslint-disable-next-line no-unused-expressions
navigator.sendBeacon(url, body);
// eslint-disable-next-line no-console
console.debug(`ping:${checkpoint}`, pdata);
};
sendPing();
// special case CWV
if (checkpoint === 'cwv') {
// use classic script to avoid CORS issues
const script = document.createElement('script');
script.src = 'https://rum.hlx.page/.rum/web-vitals/dist/web-vitals.iife.js';
script.onload = () => {
const storeCWV = (measurement) => {
data.cwv = {};
data.cwv[measurement.name] = measurement.value;
sendPing();
};
// When loading `web-vitals` using a classic script, all the public
// methods can be found on the `webVitals` global namespace.
window.webVitals.getCLS(storeCWV);
window.webVitals.getFID(storeCWV);
window.webVitals.getLCP(storeCWV);
};
document.head.appendChild(script);
}
sampleRUM.cases = sampleRUM.cases || {
cwv: () => sampleRUM.cwv(data) || true,
lazy: () => {
// use classic script to avoid CORS issues
const script = document.createElement('script');
script.src = 'https://rum.hlx.page/.rum/@adobe/helix-rum-enhancer@^1/src/index.js';
document.head.appendChild(script);
return true;
},
};
sendPing(data);
if (sampleRUM.cases[checkpoint]) { sampleRUM.cases[checkpoint](); }
}
} catch (e) {
} catch (error) {
// something went wrong
}
}
Expand Down Expand Up @@ -536,6 +546,18 @@ export function initHlx() {
console.log(e);
}
}

sampleRUM('top');

window.addEventListener('load', () => sampleRUM('load'));

window.addEventListener('unhandledrejection', (event) => {
sampleRUM('error', { source: event.reason.sourceURL, target: event.reason.line });
});

window.addEventListener('error', (event) => {
sampleRUM('error', { source: event.filename, target: event.lineno });
});
}

initHlx();
Expand Down Expand Up @@ -566,87 +588,8 @@ const usp = new URLSearchParams(window.location.search);
const alloy = true;

const LCP_BLOCKS = ['featured-article', 'article-header'];
window.RUM_GENERATION = 'biz-gen3'; // add your RUM generation information here
sampleRUM.mediaobserver = (window.IntersectionObserver) ? new IntersectionObserver((entries) => {
entries
.filter((entry) => entry.isIntersecting)
.forEach((entry) => {
sampleRUM.mediaobserver.unobserve(entry.target); // observe only once
const target = sampleRUM.targetselector(entry.target);
const source = sampleRUM.sourceselector(entry.target);
sampleRUM('viewmedia', { target, source });
});
}, { threshold: 0.25 }) : { observe: () => {} };

sampleRUM.blockobserver = (window.IntersectionObserver) ? new IntersectionObserver((entries) => {
entries
.filter((entry) => entry.isIntersecting)
.forEach((entry) => {
sampleRUM.blockobserver.unobserve(entry.target); // observe only once
const target = sampleRUM.targetselector(entry.target);
const source = sampleRUM.sourceselector(entry.target);
sampleRUM('viewblock', { target, source });
});
}, { threshold: 0.25 }) : { observe: () => {} };

sampleRUM.observe = ((elements) => {
elements.forEach((element) => {
if (element.tagName.toLowerCase() === 'img'
|| element.tagName.toLowerCase() === 'video'
|| element.tagName.toLowerCase() === 'audio'
|| element.tagName.toLowerCase() === 'iframe') {
sampleRUM.mediaobserver.observe(element);
} else {
sampleRUM.blockobserver.observe(element);
}
});
});

sampleRUM.sourceselector = (element) => {
if (element === document.body || element === document.documentElement || !element) {
return undefined;
}
if (element.id) {
return `#${element.id}`;
}
if (element.getAttribute('data-block-name')) {
return `.${element.getAttribute('data-block-name')}`;
}
return sampleRUM.sourceselector(element.parentElement);
};

sampleRUM.targetselector = (element) => {
let value = element.getAttribute('href') || element.currentSrc || element.getAttribute('src');
if (value && value.startsWith('https://')) {
// resolve relative links
value = new URL(value, window.location).href;
}
return value;
};

sampleRUM('top');
window.addEventListener('load', () => sampleRUM('load'));
document.addEventListener('click', (event) => {
sampleRUM('click', {
target: sampleRUM.targetselector(event.target),
source: sampleRUM.sourceselector(event.target),
});
});

const olderror = window.onerror;
window.onerror = (event, source, line) => {
sampleRUM('error', { source, target: line });
// keep the old error handler around
if (typeof olderror === 'function') {
olderror(event, source, line);
} else {
throw new Error(event);
}
};

sampleRUM('top');
window.addEventListener('load', () => sampleRUM('load'));
document.addEventListener('click', () => sampleRUM('click'));
window.hlx.RUM_GENERATION = 'biz-gen4'; // add your RUM generation information here
window.hlx.MAX_RUM_PINGS = 50;

loadPage(document);

Expand Down

0 comments on commit 8f332a7

Please sign in to comment.