Centralise frontend error reporting (and suppress unactionable Sentry errors) #3850

sarayourfriend · 2024-02-29T04:49:08Z

Fixes

Superceeds #3721 after rebasing the branch to include #3811.

Description

Introduces a new plugin to centralise network error handling. This allows us to make large-scale changes to how we handle certain classes of networking errors under certain conditions. To resolve the problems in the issue, this PR ignores the types of errors mentioned there, or sends information about them to a place we can better understand them (Plausible). For many ignored errors, we have other mechanisms to inspect and understand them, like API logs, or Cloudflare traffic analysis.

Testing Instructions

Confirm the new tests sufficiently verify the behaviour of the plugin.

Run the app locally, and visit a search page. Open your browser dev tools network tab, and navigate to a single result. Find the "Related" request for the result, and block it using your dev tools (in Firefox you right click and "Block this URL" from the context menu). Navigate back to search, reload to clear the pinia cache of the related request, then go back to the same single result page. Confirm that the dev console has a log event for an analytics event, NETWORK_ERROR, and that no Sentry event was sent. You can confirm the sentry events by adding a console log at that line so you can see it in your nuxt dev console.

Checklist

My pull request has a descriptive title (not a vague title likeUpdate 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.
[N/A] I ran the DAG documentation generator (if applicable).

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.

sarayourfriend · 2024-02-29T06:52:50Z

I'm leaving this as a draft intentionally. I'll work on the Playwright tests we discussed in the original PR tomorrow.

…eature flag json See note regarding setup-after-env in this section of Jest documentation: https://jestjs.io/docs/jest-object\#jestmockmodulename-factory-options

github-actions · 2024-03-19T23:38:07Z

Full-stack documentation: https://docs.openverse.org/_preview/3850

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

obulat

I've tested this PR locally, and it seems to work really well.

obulat · 2024-03-20T05:06:25Z

frontend/test/playwright/e2e/search.spec.ts

+      // Only match the search requests, rather than any other API request the search page makes
+      return Boolean(
+        url.pathname.match(/v1\/(audio|images)/) &&
+          url.searchParams.has("q", "galah")


Nice way of matching by params!

obulat · 2024-03-20T06:30:26Z

frontend/src/plugins/errors.ts

+/**
+ * Record network errors using the appropriate tool, as needed,
+ * based on response code, status, and request kind.
+ * @param error - The error to record


This docstring needs to be updated.

obulat · 2024-03-20T06:31:01Z

frontend/src/stores/media/related-media.ts

+          {
+            id,
+          }


Suggested change

{

id,

}

{ id }

Nit

obulat · 2024-03-20T06:31:45Z

frontend/src/stores/media/index.ts

+          {
+            searchTerm: queryParams.q ?? "",
+          }


Suggested change

{

searchTerm: queryParams.q ?? "",

}

{ searchTerm: queryParams.q ?? "" }

Nit: these seem more readable when on a single line

zackkrida · 2024-03-20T18:26:42Z

frontend/src/plugins/errors.ts

+     *    implementation or configuration error suddenly causing malformed
+     *    identifiers to be used. Neither Sentry nor Plausible are the right tool
+     *    for that task. If the 404s are caused by an API issue, we'd see that in
+     *    API response code monitoring, where we can more easily trace the cause


Suggested change

* API response code monitoring, where we can more easily trace the cause

* API response code monitoring, where we can more easily trace the cause.

zackkrida · 2024-03-20T18:31:38Z

frontend/src/plugins/errors.ts

+  } else {
+    context.$sentry.captureException(originalError, {
+      extra: { fetchingError },
+    })
+  }
+}


``

Suggested change

} else {

context.$sentry.captureException(originalError, {

extra: { fetchingError },

})

}

}

return

}

// Send all other errors to Sentry

context.$sentry.captureException(originalError, {

extra: { fetchingError },

})

}

Style nit: perhaps this would make adding future additional cases less error-prone, or avoid confusion if folks think there's some special relationship between the process.client && fetchingError.code === "ERR_NETWORK" errors and Sentry specifically.

I went back and forth many times on this, and ultimately found both just as confusing, and went with a coin toss. I'll switch this, as any actual preference is better than my 50/50 non-choice!

zackkrida

This is really, really nice! Wow. Great code and works perfectly. Unit tests passed locally, failed correctly when modified, and I was able to produce a NETWORK_ERROR analytics event using the instructions. I left a minor typo and code style suggestion but LGTM.

sarayourfriend · 2024-03-21T23:23:00Z

I merged this, forgetting that the reason I didn't do so earlier was because of some outstanding minor feedback. Apologies! I am not intentionally disregarding them. If any of those pieces feel critical enough to make issues for, please let me know which ones and I can create the issues @zackkrida @obulat.

Some of them are things ESlint should be able to catch: early return vs else? And object/brace formatting.

zackkrida · 2024-03-21T23:29:39Z

Looks fine as-is for me 👍

openverse-bot added 🟨 priority: medium Not blocking but should be addressed soon 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Feb 29, 2024

github-actions bot added 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: frontend Related to the Nuxt frontend labels Feb 29, 2024

obulat removed the 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work label Feb 29, 2024

sarayourfriend and others added 11 commits March 20, 2024 10:08

Centralise frontend network error reporting

0dbfe0b

Add shim for tests

e2649b2

Revert unnecessary change to useSearch

9747a6f

Remove unnecessary errors plugin shim causing jest.mock to fail for f…

7700aa6

…eature flag json See note regarding setup-after-env in this section of Jest documentation: https://jestjs.io/docs/jest-object\#jestmockmodulename-factory-options

Fix jest types to match actual jest version

0686896

Add unit tests for errors plugin

affb7fd

Skip 429s and rearrange function for clarity

37c86af

WIP/ PR does not work due to analytics composable

40f9569

Consider SSR/CSR in test

8973e8c

Remove stray console.error

8c8719a

Add search route network error handling test

9379db2

sarayourfriend force-pushed the fix/prevent-axios-error-sentry branch from 89704b2 to 9379db2 Compare March 19, 2024 23:16

Fix bad merge of pnpm lock

c6102cd

sarayourfriend marked this pull request as ready for review March 19, 2024 23:29

sarayourfriend requested a review from a team as a code owner March 19, 2024 23:29

sarayourfriend requested review from zackkrida and obulat March 19, 2024 23:29

sarayourfriend removed the 🧱 stack: documentation Related to Sphinx documentation label Mar 19, 2024

obulat approved these changes Mar 20, 2024

View reviewed changes

zackkrida reviewed Mar 20, 2024

View reviewed changes

zackkrida approved these changes Mar 20, 2024

View reviewed changes

sarayourfriend merged commit ee3caaa into main Mar 21, 2024
53 checks passed

sarayourfriend deleted the fix/prevent-axios-error-sentry branch March 21, 2024 23:21

obulat mentioned this pull request Mar 25, 2024

SEARCH_TIME_EVENT is unusable due to plausible and CORS limitations #3775

Closed

2 tasks

This was referenced Apr 2, 2024

Related endpoint error is still sent to Sentry #4006

Closed

Related endpoint error is still sent to Sentry #4009

Merged

Handle ERR_NETWORK error in Axios requests #2903

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Centralise frontend error reporting (and suppress unactionable Sentry errors) #3850

Centralise frontend error reporting (and suppress unactionable Sentry errors) #3850

sarayourfriend commented Feb 29, 2024

sarayourfriend commented Feb 29, 2024

github-actions bot commented Mar 19, 2024

obulat left a comment

obulat Mar 20, 2024

obulat Mar 20, 2024

obulat Mar 20, 2024

obulat Mar 20, 2024

zackkrida Mar 20, 2024

zackkrida Mar 20, 2024

sarayourfriend Mar 21, 2024

zackkrida left a comment

sarayourfriend commented Mar 21, 2024

zackkrida commented Mar 21, 2024

-          {
-            id,
-          }
+          { id }

	* API response code monitoring, where we can more easily trace the cause
	* API response code monitoring, where we can more easily trace the cause.

Centralise frontend error reporting (and suppress unactionable Sentry errors) #3850

Centralise frontend error reporting (and suppress unactionable Sentry errors) #3850

Conversation

sarayourfriend commented Feb 29, 2024

Fixes

Description

Testing Instructions

Checklist

Developer Certificate of Origin

sarayourfriend commented Feb 29, 2024

github-actions bot commented Mar 19, 2024

obulat left a comment

Choose a reason for hiding this comment

obulat Mar 20, 2024

Choose a reason for hiding this comment

obulat Mar 20, 2024

Choose a reason for hiding this comment

obulat Mar 20, 2024

Choose a reason for hiding this comment

obulat Mar 20, 2024

Choose a reason for hiding this comment

zackkrida Mar 20, 2024

Choose a reason for hiding this comment

zackkrida Mar 20, 2024

Choose a reason for hiding this comment

sarayourfriend Mar 21, 2024

Choose a reason for hiding this comment

zackkrida left a comment

Choose a reason for hiding this comment

sarayourfriend commented Mar 21, 2024

zackkrida commented Mar 21, 2024