Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 1.8k
feat(browser): Attach host as part of error message to "Failed to fetch" errors#15729
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Uh oh!
There was an error while loading. Please reload this page.
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13 dev-packages/browser-integration-tests/suites/errors/fetch/init.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| import * as Sentry from '@sentry/browser'; | ||
| window.Sentry = Sentry; | ||
| Sentry.init({ | ||
| dsn: 'https://public@dsn.ingest.sentry.io/1337', | ||
| transportOptions: { | ||
| fetchOptions: { | ||
| // See: https://github.com/microsoft/playwright/issues/34497 | ||
| keepalive: false, | ||
| }, | ||
| }, | ||
| }); |
45 changes: 45 additions & 0 deletions
45 dev-packages/browser-integration-tests/suites/errors/fetch/subject.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| // Based on possible TypeError exceptions from https://developer.mozilla.org/en-US/docs/Web/API/Window/fetch | ||
| // Network error (e.g. ad-blocked, offline, page does not exist, ...) | ||
| window.networkError = () => { | ||
| fetch('http://sentry-test-external.io/does-not-exist'); | ||
| }; | ||
| window.networkErrorSubdomain = () => { | ||
| fetch('http://subdomain.sentry-test-external.io/does-not-exist'); | ||
| }; | ||
| // Invalid header also produces TypeError | ||
| window.invalidHeaderName = () => { | ||
| fetch('http://sentry-test-external.io/invalid-header-name', { headers: { 'C ontent-Type': 'text/xml' } }); | ||
| }; | ||
| // Invalid header value also produces TypeError | ||
| window.invalidHeaderValue = () => { | ||
| fetch('http://sentry-test-external.io/invalid-header-value', { headers: ['Content-Type', 'text/html', 'extra'] }); | ||
| }; | ||
| // Invalid URL scheme | ||
| window.invalidUrlScheme = () => { | ||
| fetch('blub://sentry-test-external.io/invalid-scheme'); | ||
| }; | ||
| // URL includes credentials | ||
| window.credentialsInUrl = () => { | ||
| fetch('https://user:password@sentry-test-external.io/credentials-in-url'); | ||
| }; | ||
| // Invalid mode | ||
| window.invalidMode = () => { | ||
| fetch('https://sentry-test-external.io/invalid-mode', { mode: 'navigate' }); | ||
| }; | ||
| // Invalid request method | ||
| window.invalidMethod = () => { | ||
| fetch('http://sentry-test-external.io/invalid-method', { method: 'CONNECT' }); | ||
| }; | ||
| // No-cors mode with cors-required method | ||
| window.noCorsMethod = () => { | ||
| fetch('http://sentry-test-external.io/no-cors-method', { mode: 'no-cors', method: 'PUT' }); | ||
| }; |
288 changes: 288 additions & 0 deletions
288 dev-packages/browser-integration-tests/suites/errors/fetch/test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,288 @@ | ||
| import { expect } from '@playwright/test'; | ||
| import { sentryTest } from '../../../utils/fixtures'; | ||
| import { envelopeRequestParser, waitForErrorRequest } from '../../../utils/helpers'; | ||
| sentryTest('handles fetch network errors @firefox', async ({ getLocalTestUrl, page, browserName }) => { | ||
| const url = await getLocalTestUrl({ testDir: __dirname }); | ||
| const reqPromise = waitForErrorRequest(page); | ||
| await page.goto(url); | ||
| await page.evaluate('networkError()'); | ||
| const eventData = envelopeRequestParser(await reqPromise); | ||
| const errorMap: Record<string, string> = { | ||
| chromium: 'Failed to fetch (sentry-test-external.io)', | ||
| webkit: 'Load failed (sentry-test-external.io)', | ||
| firefox: 'NetworkError when attempting to fetch resource. (sentry-test-external.io)', | ||
| }; | ||
| const error = errorMap[browserName]; | ||
| expect(eventData.exception?.values).toHaveLength(1); | ||
| expect(eventData.exception?.values?.[0]).toMatchObject({ | ||
| type: 'TypeError', | ||
| value: error, | ||
| mechanism: { | ||
| handled: false, | ||
| type: 'onunhandledrejection', | ||
| }, | ||
| }); | ||
| }); | ||
| sentryTest('handles fetch network errors on subdomains @firefox', async ({ getLocalTestUrl, page, browserName }) => { | ||
| const url = await getLocalTestUrl({ testDir: __dirname }); | ||
| const reqPromise = waitForErrorRequest(page); | ||
| await page.goto(url); | ||
| await page.evaluate('networkErrorSubdomain()'); | ||
| const eventData = envelopeRequestParser(await reqPromise); | ||
| const errorMap: Record<string, string> = { | ||
| chromium: 'Failed to fetch (subdomain.sentry-test-external.io)', | ||
| webkit: 'Load failed (subdomain.sentry-test-external.io)', | ||
| firefox: 'NetworkError when attempting to fetch resource. (subdomain.sentry-test-external.io)', | ||
| }; | ||
| const error = errorMap[browserName]; | ||
| expect(eventData.exception?.values).toHaveLength(1); | ||
| expect(eventData.exception?.values?.[0]).toMatchObject({ | ||
| type: 'TypeError', | ||
| value: error, | ||
| mechanism: { | ||
| handled: false, | ||
| type: 'onunhandledrejection', | ||
| }, | ||
| }); | ||
| }); | ||
| sentryTest('handles fetch invalid header name errors @firefox', async ({ getLocalTestUrl, page, browserName }) => { | ||
| const url = await getLocalTestUrl({ testDir: __dirname }); | ||
| const reqPromise = waitForErrorRequest(page); | ||
| await page.goto(url); | ||
| await page.evaluate('invalidHeaderName()'); | ||
| const eventData = envelopeRequestParser(await reqPromise); | ||
| const errorMap: Record<string, string> = { | ||
| chromium: "Failed to execute 'fetch' on 'Window': Invalid name", | ||
| webkit: "Invalid header name: 'C ontent-Type'", | ||
| firefox: 'Window.fetch: c ontent-type is an invalid header name.', | ||
| }; | ||
| const error = errorMap[browserName]; | ||
| expect(eventData.exception?.values).toHaveLength(1); | ||
| expect(eventData.exception?.values?.[0]).toMatchObject({ | ||
| type: 'TypeError', | ||
| value: error, | ||
| mechanism: { | ||
| handled: false, | ||
| type: 'onunhandledrejection', | ||
| }, | ||
| stacktrace: { | ||
| frames: expect.any(Array), | ||
| }, | ||
| }); | ||
| }); | ||
| sentryTest('handles fetch invalid header value errors @firefox', async ({ getLocalTestUrl, page, browserName }) => { | ||
| const url = await getLocalTestUrl({ testDir: __dirname }); | ||
| const reqPromise = waitForErrorRequest(page); | ||
| await page.goto(url); | ||
| await page.evaluate('invalidHeaderValue()'); | ||
| const eventData = envelopeRequestParser(await reqPromise); | ||
| const errorMap: Record<string, string> = { | ||
| chromium: | ||
| "Failed to execute 'fetch' on 'Window': Failed to read the 'headers' property from 'RequestInit': The provided value cannot be converted to a sequence.", | ||
| webkit: 'Value is not a sequence', | ||
| firefox: | ||
| "Window.fetch: Element of sequence<sequence<ByteString>> branch of (sequence<sequence<ByteString>> or record<ByteString, ByteString>) can't be converted to a sequence.", | ||
| }; | ||
| const error = errorMap[browserName]; | ||
| expect(eventData.exception?.values).toHaveLength(1); | ||
| expect(eventData.exception?.values?.[0]).toMatchObject({ | ||
| type: 'TypeError', | ||
| value: error, | ||
| mechanism: { | ||
| handled: false, | ||
| type: 'onunhandledrejection', | ||
| }, | ||
| stacktrace: { | ||
| frames: expect.any(Array), | ||
| }, | ||
| }); | ||
| }); | ||
| sentryTest('handles fetch invalid URL scheme errors @firefox', async ({ getLocalTestUrl, page, browserName }) => { | ||
| await page.route('http://sentry-test-external.io/**', route => { | ||
| return route.fulfill({ | ||
| status: 200, | ||
| }); | ||
| }); | ||
| const url = await getLocalTestUrl({ testDir: __dirname }); | ||
| const reqPromise = waitForErrorRequest(page); | ||
| await page.goto(url); | ||
| await page.evaluate('invalidUrlScheme()'); | ||
| const eventData = envelopeRequestParser(await reqPromise); | ||
| const errorMap: Record<string, string> = { | ||
| chromium: 'Failed to fetch (sentry-test-external.io)', | ||
| webkit: 'Load failed (sentry-test-external.io)', | ||
| firefox: 'NetworkError when attempting to fetch resource. (sentry-test-external.io)', | ||
| }; | ||
| const error = errorMap[browserName]; | ||
| /** | ||
| * This kind of error does show a helpful warning in the console, e.g.: | ||
| * Fetch API cannot load blub://sentry-test-external.io/invalid-scheme. URL scheme "blub" is not supported. | ||
| * But it seems we cannot really access this in the SDK :( | ||
| */ | ||
| expect(eventData.exception?.values).toHaveLength(1); | ||
| expect(eventData.exception?.values?.[0]).toMatchObject({ | ||
| type: 'TypeError', | ||
| value: error, | ||
| mechanism: { | ||
| handled: false, | ||
| type: 'onunhandledrejection', | ||
| }, | ||
| stacktrace: { | ||
| frames: expect.any(Array), | ||
| }, | ||
| }); | ||
| }); | ||
| sentryTest('handles fetch credentials in url errors @firefox', async ({ getLocalTestUrl, page, browserName }) => { | ||
| const url = await getLocalTestUrl({ testDir: __dirname }); | ||
| const reqPromise = waitForErrorRequest(page); | ||
| await page.goto(url); | ||
| await page.evaluate('credentialsInUrl()'); | ||
| const eventData = envelopeRequestParser(await reqPromise); | ||
| const errorMap: Record<string, string> = { | ||
| chromium: | ||
| "Failed to execute 'fetch' on 'Window': Request cannot be constructed from a URL that includes credentials: https://user:password@sentry-test-external.io/credentials-in-url", | ||
| webkit: 'URL is not valid or contains user credentials.', | ||
| firefox: | ||
| 'Window.fetch: https://user:password@sentry-test-external.io/credentials-in-url is an url with embedded credentials.', | ||
| }; | ||
| const error = errorMap[browserName]; | ||
| expect(eventData.exception?.values).toHaveLength(1); | ||
| expect(eventData.exception?.values?.[0]).toMatchObject({ | ||
| type: 'TypeError', | ||
| value: error, | ||
| mechanism: { | ||
| handled: false, | ||
| type: 'onunhandledrejection', | ||
| }, | ||
| stacktrace: { | ||
| frames: expect.any(Array), | ||
| }, | ||
| }); | ||
| }); | ||
| sentryTest('handles fetch invalid mode errors @firefox', async ({ getLocalTestUrl, page, browserName }) => { | ||
| const url = await getLocalTestUrl({ testDir: __dirname }); | ||
| const reqPromise = waitForErrorRequest(page); | ||
| await page.goto(url); | ||
| await page.evaluate('invalidMode()'); | ||
| const eventData = envelopeRequestParser(await reqPromise); | ||
| const errorMap: Record<string, string> = { | ||
| chromium: | ||
| "Failed to execute 'fetch' on 'Window': Cannot construct a Request with a RequestInit whose mode member is set as 'navigate'.", | ||
| webkit: 'Request constructor does not accept navigate fetch mode.', | ||
| firefox: 'Window.fetch: Invalid request mode navigate.', | ||
| }; | ||
| const error = errorMap[browserName]; | ||
| expect(eventData.exception?.values).toHaveLength(1); | ||
| expect(eventData.exception?.values?.[0]).toMatchObject({ | ||
| type: 'TypeError', | ||
| value: error, | ||
| mechanism: { | ||
| handled: false, | ||
| type: 'onunhandledrejection', | ||
| }, | ||
| stacktrace: { | ||
| frames: expect.any(Array), | ||
| }, | ||
| }); | ||
| }); | ||
| sentryTest('handles fetch invalid request method errors @firefox', async ({ getLocalTestUrl, page, browserName }) => { | ||
| const url = await getLocalTestUrl({ testDir: __dirname }); | ||
| const reqPromise = waitForErrorRequest(page); | ||
| await page.goto(url); | ||
| await page.evaluate('invalidMethod()'); | ||
| const eventData = envelopeRequestParser(await reqPromise); | ||
| const errorMap: Record<string, string> = { | ||
| chromium: "Failed to execute 'fetch' on 'Window': 'CONNECT' HTTP method is unsupported.", | ||
| webkit: 'Method is forbidden.', | ||
| firefox: 'Window.fetch: Invalid request method CONNECT.', | ||
| }; | ||
| const error = errorMap[browserName]; | ||
| expect(eventData.exception?.values).toHaveLength(1); | ||
| expect(eventData.exception?.values?.[0]).toMatchObject({ | ||
| type: 'TypeError', | ||
| value: error, | ||
| mechanism: { | ||
| handled: false, | ||
| type: 'onunhandledrejection', | ||
| }, | ||
| stacktrace: { | ||
| frames: expect.any(Array), | ||
| }, | ||
| }); | ||
| }); | ||
| sentryTest( | ||
| 'handles fetch no-cors mode with cors-required method errors @firefox', | ||
| async ({ getLocalTestUrl, page, browserName }) => { | ||
| const url = await getLocalTestUrl({ testDir: __dirname }); | ||
| const reqPromise = waitForErrorRequest(page); | ||
| await page.goto(url); | ||
| await page.evaluate('noCorsMethod()'); | ||
| const eventData = envelopeRequestParser(await reqPromise); | ||
| const errorMap: Record<string, string> = { | ||
| chromium: "Failed to execute 'fetch' on 'Window': 'PUT' is unsupported in no-cors mode.", | ||
| webkit: 'Method must be GET, POST or HEAD in no-cors mode.', | ||
| firefox: 'Window.fetch: Invalid request method PUT.', | ||
| }; | ||
| const error = errorMap[browserName]; | ||
| expect(eventData.exception?.values).toHaveLength(1); | ||
| expect(eventData.exception?.values?.[0]).toMatchObject({ | ||
| type: 'TypeError', | ||
| value: error, | ||
| mechanism: { | ||
| handled: false, | ||
| type: 'onunhandledrejection', | ||
| }, | ||
| stacktrace: { | ||
| frames: expect.any(Array), | ||
| }, | ||
| }); | ||
| }, | ||
| ); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder whether we should limit to the domain (eg
example.com) instead of the entire host (foo.bar.example.com). Domain could get pretty noisy in multi-tenant situations.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah I forgot. Message doesn't contribute to grouping if there is a stack trace. Then it's probably fine/better.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, so basically
url.host.split('.).slice(-2).join('.'), to just get the last part? 🤔There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I adjusted this and also added a test for this!