Skip to content
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

feat(browser): Add skipBrowserExtensionCheck escape hatch option #14147

Merged
merged 5 commits into from
Oct 31, 2024

Conversation

Lms24
Copy link
Member

@Lms24 Lms24 commented Oct 31, 2024

In v8, we added a check to stop initing the SDK via Sentry.init if we detect it's being called in a browser extension. We had to adjust and add special conditions to this check multiple times because it triggered falsely in various environments we weren't aware of before (e.g. #12668). We received another issue where such a false positive was reported (#14133), so I'm thinking it's probably better to provide a general escape hatch for this check than to further bloat the bundle size by introducing more special cases in the extension check.

This way, we'd initially still block Sentry.init and make users think twice how to proceed. However, we don't have to adapt the check every time a false positive gets reported.

(note for v9: Maybe we should rethink the check. I'm not happy with the bundle size hit this produces)

Copy link
Contributor

github-actions bot commented Oct 31, 2024

size-limit report 📦

Path Size % Change Change
@sentry/browser 22.74 KB +0.08% +18 B 🔺
@sentry/browser - with treeshaking flags 21.53 KB +0.07% +15 B 🔺
@sentry/browser (incl. Tracing) 35.13 KB +0.04% +13 B 🔺
@sentry/browser (incl. Tracing, Replay) 71.84 KB +0.03% +16 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 62.28 KB +0.03% +18 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas) 76.15 KB +0.03% +17 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback) 88.95 KB +0.02% +13 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback, metrics) 90.79 KB +0.03% +20 B 🔺
@sentry/browser (incl. metrics) 26.99 KB +0.05% +13 B 🔺
@sentry/browser (incl. Feedback) 39.89 KB +0.04% +16 B 🔺
@sentry/browser (incl. sendFeedback) 27.39 KB +0.07% +17 B 🔺
@sentry/browser (incl. FeedbackAsync) 32.18 KB +0.06% +18 B 🔺
@sentry/react 25.5 KB +0.06% +15 B 🔺
@sentry/react (incl. Tracing) 38.09 KB +0.05% +17 B 🔺
@sentry/vue 26.89 KB +0.06% +14 B 🔺
@sentry/vue (incl. Tracing) 37.01 KB +0.06% +19 B 🔺
@sentry/svelte 22.88 KB +0.08% +17 B 🔺
CDN Bundle 24.1 KB +0.07% +16 B 🔺
CDN Bundle (incl. Tracing) 36.94 KB +0.05% +17 B 🔺
CDN Bundle (incl. Tracing, Replay) 71.6 KB +0.03% +15 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) 76.94 KB +0.02% +15 B 🔺
CDN Bundle - uncompressed 70.64 KB +0.05% +30 B 🔺
CDN Bundle (incl. Tracing) - uncompressed 109.64 KB +0.03% +30 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed 222.16 KB +0.02% +30 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 235.38 KB +0.02% +30 B 🔺
@sentry/nextjs (client) 38.16 KB +0.05% +16 B 🔺
@sentry/sveltekit (client) 35.73 KB +0.05% +17 B 🔺
@sentry/node 129.6 KB +0.01% +1 B 🔺
@sentry/node - without tracing 94.3 KB +0.01% +2 B 🔺
@sentry/aws-serverless 105.17 KB -0.01% -2 B 🔽

View base workflow run

@Lms24 Lms24 self-assigned this Oct 31, 2024
@Lms24 Lms24 requested review from a team, stephanie-anderson, AbhiPrasad and s1gr1d and removed request for a team and stephanie-anderson October 31, 2024 09:41
@Lms24 Lms24 marked this pull request as ready for review October 31, 2024 09:42
packages/browser/src/client.ts Outdated Show resolved Hide resolved
@Lms24 Lms24 merged commit a15ce30 into develop Oct 31, 2024
148 checks passed
@Lms24 Lms24 deleted the lms/feat-add-skip-extension-check branch October 31, 2024 10:30
Lms24 added a commit to getsentry/sentry-docs that referenced this pull request Nov 7, 2024
adds documentation for a new SDK option introduced in getsentry/sentry-javascript#14147

---------

Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
alexandresoro pushed a commit to alexandresoro/ouca that referenced this pull request Nov 9, 2024
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@sentry/node](https://github.com/getsentry/sentry-javascript/tree/master/packages/node) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.36.0` -> `8.37.1`](https://renovatebot.com/diffs/npm/@sentry%2fnode/8.36.0/8.37.1) |
| [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.36.0` -> `8.37.1`](https://renovatebot.com/diffs/npm/@sentry%2freact/8.36.0/8.37.1) |

---

### Release Notes

<details>
<summary>getsentry/sentry-javascript (@&#8203;sentry/node)</summary>

### [`v8.37.1`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8371)

[Compare Source](getsentry/sentry-javascript@8.37.0...8.37.1)

-   feat(deps): Bump [@&#8203;opentelemetry/instrumentation](https://github.com/opentelemetry/instrumentation) from 0.53.0 to 0.54.0 for [@&#8203;sentry/opentelemetry](https://github.com/sentry/opentelemetry) ([#&#8203;14187](getsentry/sentry-javascript#14187))

### [`v8.37.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8370)

[Compare Source](getsentry/sentry-javascript@8.36.0...8.37.0)

##### Important Changes

-   **feat(nuxt): Add `piniaIntegration` ([#&#8203;14138](getsentry/sentry-javascript#14138

The Nuxt SDK now allows you to track Pinia state for captured errors. To enable the Pinia plugin, add the `piniaIntegration` to your client config:

```ts
// sentry.client.config.ts
import { usePinia } from '#imports';

Sentry.init({
  integrations: [
    Sentry.piniaIntegration(usePinia(), {
      /* optional Pinia plugin options */
    }),
  ],
});
```

-   **feat: Deprecate metrics API ([#&#8203;14157](getsentry/sentry-javascript#14157

The Sentry Metrics beta has ended in favour of revisiting metrics in another form at a later date.

This new approach will include different APIs, making the current metrics API unnecessary. This release
deprecates the metrics API with the plan to remove in the next SDK major version. If you currently use the
metrics API in your code, you can safely continue to do so but sent data will no longer be processed by Sentry.

[Learn more](https://sentry.zendesk.com/hc/en-us/articles/26369339769883-Metrics-Beta-Ended-on-October-7th) about the end of the Metrics beta.

##### Other Changes

-   feat(browser): Add `http.response_delivery_type` attribute to resource spans ([#&#8203;14056](getsentry/sentry-javascript#14056))
-   feat(browser): Add `skipBrowserExtensionCheck` escape hatch option ([#&#8203;14147](getsentry/sentry-javascript#14147))
-   feat(deps): Bump [@&#8203;opentelemetry/instrumentation](https://github.com/opentelemetry/instrumentation) from 0.53.0 to 0.54.0 ([#&#8203;14174](getsentry/sentry-javascript#14174))
-   feat(deps): Bump [@&#8203;opentelemetry/instrumentation-fastify](https://github.com/opentelemetry/instrumentation-fastify) from 0.40.0 to 0.41.0 ([#&#8203;14175](getsentry/sentry-javascript#14175))
-   feat(deps): Bump [@&#8203;opentelemetry/instrumentation-graphql](https://github.com/opentelemetry/instrumentation-graphql) from 0.43.0 to 0.44.0 ([#&#8203;14173](getsentry/sentry-javascript#14173))
-   feat(deps): Bump [@&#8203;opentelemetry/instrumentation-mongodb](https://github.com/opentelemetry/instrumentation-mongodb) from 0.47.0 to 0.48.0 ([#&#8203;14171](getsentry/sentry-javascript#14171))
-   feat(deps): Bump [@&#8203;opentelemetry/propagator-aws-xray](https://github.com/opentelemetry/propagator-aws-xray) from 1.25.1 to 1.26.0 ([#&#8203;14172](getsentry/sentry-javascript#14172))
-   feat(nuxt): Add `asyncFunctionReExports` to define re-exported server functions ([#&#8203;14104](getsentry/sentry-javascript#14104))
-   feat(nuxt): Add `piniaIntegration` ([#&#8203;14138](getsentry/sentry-javascript#14138))
-   fix(browser): Avoid recording long task spans starting before their parent span ([#&#8203;14183](getsentry/sentry-javascript#14183))
-   fix(core): Ensure errors thrown in async cron jobs bubble up ([#&#8203;14182](getsentry/sentry-javascript#14182))
-   fix(core): Silently fail `maybeInstrument` ([#&#8203;14140](getsentry/sentry-javascript#14140))
-   fix(nextjs): Resolve path for dynamic webpack import ([#&#8203;13751](getsentry/sentry-javascript#13751))
-   fix(node): Make sure `modulesIntegration` does not crash esm apps ([#&#8203;14169](getsentry/sentry-javascript#14169))

Work in this release was contributed by [@&#8203;rexxars](https://github.com/rexxars). Thank you for your contribution!

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these updates again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC4xNDIuNyIsInVwZGF0ZWRJblZlciI6IjM4LjE0Mi43IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiXX0=-->

Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/299
Reviewed-by: Alexandre Soro <code@soro.dev>
Co-authored-by: renovate <renovate@git.tristess.app>
Co-committed-by: renovate <renovate@git.tristess.app>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants