From de864ca75a2380cc9888a94aa2267b2ed9964b2c Mon Sep 17 00:00:00 2001 From: Jibran Garcia Date: Thu, 10 Apr 2025 19:46:22 +0000 Subject: [PATCH 1/2] Update docs with steps to upgrade the version in Dotcom --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index b3a58fb..7b4f1b2 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,29 @@ npm install npm test ``` +## Upgrading browser-support in Dotcom + +During upgrades, it is crucial to ensure that browser error reporting to Sentry is not disrupted. Use the following steps to validate this functionality: + +### Review lab testing +- Create a PR to upgrade the `browser-support` version in Dotcom. +- Trigger a browser error from your `review-lab` instance and confirm it is reported in Sentry: + - Append `#b00m` to your `review-lab` URL and refresh the page. + - Confirm the error is reported in [review-lab Sentry](https://github.sentry.io/issues/?environment=review-lab&groupStatsPeriod=auto&project=1890375&query=b00m&referrer=issue-list&statsPeriod=5m). + - Perform these steps in Chrome, Firefox, Edge, and Opera. Note: Errors are currently not reported in Safari due to an [open issue](https://github.com/github/web-systems/issues/3162). + +### Production deployment + +- Check the [browser-reporting](https://app.datadoghq.com/monitors/168685099) monitor. + - If the rate of reported browser errors drops, the monitor will trigger an alert in the [#web-systems-ops](https://github-grid.enterprise.slack.com/archives/C046W1V95FV) channel. +- After deploying to canary: + - Trigger a browser error by appending `#b00m` to your URL. + - Confirm the error is reported in [canary Sentry](https://github.sentry.io/issues/?environment=canary&groupStatsPeriod=auto&project=1890375&query=b00m&referrer=issue-list&statsPeriod=5m). +- After deploying to production: + - Trigger a browser error by appending `#b00m` to your URL. + - Confirm the error is reported in [production Sentry](https://github.sentry.io/issues/?environment=production&groupStatsPeriod=auto&project=1890375&query=b00m&referrer=issue-list&statsPeriod=5m). + - Check the [browser-reporting monitor](https://app.datadoghq.com/monitors/168685099) to ensure there are no anomalies in the error reporting rate. + ## Contributing ### Adding polyfills From a529549e3f2dab0bedeed3d139d717b403e97653 Mon Sep 17 00:00:00 2001 From: Jibran Garcia Date: Thu, 10 Apr 2025 16:20:18 -0400 Subject: [PATCH 2/2] Update README.md Add example. Co-authored-by: Arelia Jones <2359538+arelia@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7b4f1b2..a2cd326 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ During upgrades, it is crucial to ensure that browser error reporting to Sentry ### Review lab testing - Create a PR to upgrade the `browser-support` version in Dotcom. - Trigger a browser error from your `review-lab` instance and confirm it is reported in Sentry: - - Append `#b00m` to your `review-lab` URL and refresh the page. + - Append `#b00m` to your `review-lab` URL (e.g. `https://branchname.review-lab.github.com#b00m`) and refresh the page. - Confirm the error is reported in [review-lab Sentry](https://github.sentry.io/issues/?environment=review-lab&groupStatsPeriod=auto&project=1890375&query=b00m&referrer=issue-list&statsPeriod=5m). - Perform these steps in Chrome, Firefox, Edge, and Opera. Note: Errors are currently not reported in Safari due to an [open issue](https://github.com/github/web-systems/issues/3162).