요약
이 마을에 새로운 관찰자가 나타났어요! ReportingObserver는 사이트에서 지원 중단된 API를 사용하거나 브라우저 개입이 실행되는 시점을 알려주는 새로운 API입니다.
const observer = new ReportingObserver(
(reports, observer) => {
for (const report of reports) {
console.log(report.type, report.url, report.body);
}
},
{buffered: true}
);
observer.observe();
이 콜백은 추가 분석을 위해 백엔드 또는 분석 제공업체에 보고서를 전송하는 데 사용할 수 있습니다.
그것이 왜 유용한가요? 지금까지 지원 중단 및 개입 경고는 DevTools에서만 콘솔 메시지로만 제공되었습니다.
특히 개입은 기기 및 네트워크 조건과 같은 다양한 실제 제약 조건에 의해서만 트리거됩니다. 따라서 로컬에서 사이트를 개발/테스트할 때는 이러한 메시지가 표시되지 않을 수도 있습니다. ReportingObserver는 이 문제의 해결책을 제공합니다. 사용자가 실제로 문제를 경험하면 Google에 알림을 받을 수 있습니다.
소개
얼마 전에 웹 앱에서 발생하는 '항목'을 모니터링하기 위한 API가 얼마나 되는지 알게 되어 블로그 게시물 ('웹 앱 관찰')을 작성했습니다. 예를 들어 ResizeObserver, IntersectionObserver, MutationObserver와 같이 DOM에 관한 정보를 관찰할 수 있는 API가 있습니다. 성능 측정을 캡처하는 API는 PerformanceObserver입니다. window.onerror 및 window.onunhandledrejection와 같은 다른 API도 문제가 발생하면 Google에 알려줍니다.
그러나 이러한 기존 API로 캡처되지 않는 다른 유형의 경고도 있습니다. 사이트에서 지원 중단된 API를 사용하거나 브라우저 개입을 방해하여 실행되는 경우 DevTools에서 먼저 이를 알립니다.
자연스럽게 window.onerror가 이러한 경고를 캡처한다고 생각할 것입니다. 그렇지 않습니다.
사용자 에이전트 자체에서 직접 생성된 경고에는 window.onerror가 실행되지 않기 때문입니다. 코드 실행으로 인해
발생한 런타임 오류(JS 예외 및 구문 오류)가 있는 경우 실행됩니다.
ReportingObserver가 느슨한 부분을 선택합니다. 지원 중단 및 개입과 같은 브라우저에서 발생한 경고에 관한 알림을 프로그래매틱 방식으로 제공하는 방법을 제공합니다. 이를 보고 도구로 사용하면 사용자가 실시간 사이트에서 예기치 않은 문제를 경험하는지 궁금해하는 시간을 줄일 수 있습니다.
API
이 API는 IntersectionObserver 및 ResizeObserver와 같은 다른 '관찰자' API와 다릅니다. 콜백을 호출하면
정보를 제공합니다 콜백이 수신하는 정보는 페이지로 인해 발생한 문제의 목록입니다.
const observer = new ReportingObserver((reports, observer) => {
for (const report of reports) {
// → report.type === 'deprecation'
// → report.url === 'https://reporting-observer-api-demo.glitch.me'
// → report.body.id === 'XMLHttpRequestSynchronousInNonWorkerOutsideBeforeUnload'
// → report.body.message === 'Synchronous XMLHttpRequest is deprecated...'
// → report.body.lineNumber === 11
// → report.body.columnNumber === 22
// → report.body.sourceFile === 'https://reporting-observer-api-demo.glitch.me'
// → report.body.anticipatedRemoval === <JS_DATE_STR> or null
}
});
observer.observe();
필터링된 보고서
보고서를 사전에 필터링하여 특정 보고서 유형만 관찰할 수 있습니다.
const observer = new ReportingObserver((reports, observer) => {
...
}, {types: ['deprecation']});
버퍼링된 보고서
buffered: true 옵션은 관찰자가 생성되기 전에 생성된 보고서를 확인할 때 매우 유용합니다.
const observer = new ReportingObserver((reports, observer) => {
...
}, {types: ['intervention'], buffered: true});
이는 ReportingObserver를 사용하는 라이브러리의 지연 로드와 같은 상황에 유용합니다. 관찰자는 늦게 추가되지만, 페이지 로드 초기에 발생한 경우는 누락되지 않습니다.
관찰 중지
예. disconnect 메서드가 있습니다.
observer.disconnect(); // Stop the observer from collecting reports.
예
예: 브라우저 개입을 분석 제공업체에 보고합니다.
const observer = new ReportingObserver(
(reports, observer) => {
for (const report of reports) {
sendReportToAnalytics(JSON.stringify(report.body));
}
},
{types: ['intervention'], buffered: true}
);
observer.observe();
예 - API가 삭제될 때 알림 받기:
const observer = new ReportingObserver((reports, observer) => {
for (const report of reports) {
if (report.type === 'deprecation') {
sendToBackend(`Using a deprecated API in ${report.body.sourceFile} which will be
removed on ${report.body.anticipatedRemoval}. Info: ${report.body.message}`);
}
}
});
observer.observe();
결론
ReportingObserver는 웹 앱의 잠재적인 문제를 발견하고 모니터링하는 추가적인 방법을 제공합니다. 코드베이스의 상태 또는 코드베이스의 상태를 이해하는 데 유용한 도구이기도 합니다. 백엔드에 보고서를 보내고, 사용자가 사이트에서 경험하는 실제 문제를 파악하고, 코드를 업데이트하고, 수익을 창출하세요.
향후 작업
앞으로 ReportingObserver이 JS에서 모든 유형의 문제를 포착하는 사실상의 API가 되기를 바랍니다. 앱에서 발생하는 모든 문제를 포착하는 API 하나가 있다고 가정해 보겠습니다.
- 브라우저 개입
- 지원 중단
- 기능 정책 위반 crbug.com/867471을 참조하세요.
- 자바스크립트 예외 및 오류 (현재
window.onerror에서 서비스 제공) - 처리되지 않은 JS 프로미스 거부 (현재
window.onunhandledrejection에서 서비스 제공)
또한 ReportingObserver를 워크플로에 통합하는 도구에 대해서도 기쁘게 생각합니다. Lighthouse는 '지원 중단된 API 방지' 감사를 실행할 때 이미 브라우저 지원 중단을 신고하는 도구의 예입니다.
Lighthouse는 현재 DevTools 프로토콜을 사용하여 콘솔 메시지를 스크래핑하여 개발자에게 이러한 문제를 보고합니다. 대신 체계적인 지원 중단 보고서와 anticipatedRemoval 날짜와 같은 추가 메타데이터를 사용하려면 ReportingObserver로 전환하는 것이 좋을 수 있습니다.
추가 리소스: