Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

add render context prop to sentry error event #1962

Merged
merged 4 commits into from
Nov 9, 2022
Merged

add render context prop to sentry error event #1962

merged 4 commits into from
Nov 9, 2022

Conversation

anton202
Copy link
Contributor

@anton202 anton202 commented Nov 8, 2022

Fixes

Fixes #1620 by @sarayourfriend

Description

added render context property to the sentry event that is sent when there is an error
screenshot
i`ve tested it on my own sentry account and it seems to work...

Testing Instructions

someone with access to sentry needs to test this.

  1. go to util/sentry-config.ts
  2. paste the project dsn in the dsn property.
  3. comment out the disabled and clientConfig property.
  4. go to pages/index.vue
  5. insdie setup(), throw an error
  6. open the project in the browser.
  7. go to sentry, look for that error and check if there is render context -> platform: server, in the report.
  8. got to pages/index.vue again. now, encapsulate your error with an if statment that checks if the proccess is client
    if (process.client) { throw new Error('test index page') }
  9. repeat step 6 and 7, but now the platform should be client.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@anton202 anton202 requested a review from a team as a code owner November 8, 2022 14:21
@anton202 anton202 requested review from zackkrida and obulat November 8, 2022 14:21
@openverse-bot openverse-bot added 🟨 priority: medium Not blocking but should be addressed soon 🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users labels Nov 8, 2022
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this approach and it appears to work for me, too. Thanks @anton202!

Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Brilliant, thank you 🚀

@sarayourfriend
Copy link
Contributor

I've created #1963 to account for the flaky e2e test needing to be addressed.

@obulat obulat merged commit 61aa3f8 into WordPress:main Nov 9, 2022
@anton202 anton202 deleted the sentry_render_context branch November 15, 2022 05:51
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟨 priority: medium Not blocking but should be addressed soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add breadcrumb in Sentry via plugin to indicate whether the error came client or server side.
5 participants