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

ref(utils): Stop setting transaction in requestDataIntegration #14306

Merged
merged 6 commits into from
Nov 15, 2024

Conversation

mydea
Copy link
Member

@mydea mydea commented Nov 14, 2024

This is not really necessary anymore - it only sets this on transaction events, and those get the transaction in different places already anyhow.

With this, we can also actually remove some other stuff. One method is exported from utils but not otherwise used, we can also drop this in v9.

Finally, this was also the only place that used route on the request, so we can also get rid of this in remix, which is weird anyhow because we set it for errors there but don't even use it for them.

@mydea mydea self-assigned this Nov 14, 2024
Copy link
Contributor

github-actions bot commented Nov 14, 2024

size-limit report 📦

Path Size % Change Change
@sentry/browser 22.77 KB - -
@sentry/browser - with treeshaking flags 21.53 KB - -
@sentry/browser (incl. Tracing) 35.27 KB - -
@sentry/browser (incl. Tracing, Replay) 71.99 KB - -
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 62.37 KB - -
@sentry/browser (incl. Tracing, Replay with Canvas) 76.3 KB - -
@sentry/browser (incl. Tracing, Replay, Feedback) 89.15 KB - -
@sentry/browser (incl. Feedback) 39.93 KB - -
@sentry/browser (incl. sendFeedback) 27.42 KB - -
@sentry/browser (incl. FeedbackAsync) 32.23 KB - -
@sentry/react 25.52 KB - -
@sentry/react (incl. Tracing) 38.23 KB - -
@sentry/vue 26.92 KB - -
@sentry/vue (incl. Tracing) 37.1 KB - -
@sentry/svelte 22.91 KB - -
CDN Bundle 24.13 KB - -
CDN Bundle (incl. Tracing) 37.05 KB - -
CDN Bundle (incl. Tracing, Replay) 71.71 KB - -
CDN Bundle (incl. Tracing, Replay, Feedback) 77.06 KB - -
CDN Bundle - uncompressed 70.73 KB - -
CDN Bundle (incl. Tracing) - uncompressed 109.93 KB - -
CDN Bundle (incl. Tracing, Replay) - uncompressed 222.45 KB - -
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 235.67 KB - -
@sentry/nextjs (client) 38.35 KB - -
@sentry/sveltekit (client) 35.85 KB - -
@sentry/node 134.05 KB -0.18% -244 B 🔽
@sentry/node - without tracing 96.24 KB -0.23% -224 B 🔽
@sentry/aws-serverless 106.49 KB -0.22% -236 B 🔽

View base workflow run

Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

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

LGTM, happy we can get rid of this!

@@ -35,6 +34,7 @@ export type AddRequestDataToEventOptions = {
include?: {
ip?: boolean;
request?: boolean | Array<(typeof DEFAULT_REQUEST_INCLUDES)[number]>;
/** @deprecated This option will be removed in v9. It does not do anything anymore, the `transcation` is set in other places. */
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/** @deprecated This option will be removed in v9. It does not do anything anymore, the `transcation` is set in other places. */
/**
* @deprecated This option will be removed with the next major version of the SDK. If you want to disable capturing of the URL, please use the `request` option instead.
*/

maybe a bit more transparent

Copy link
Member Author

Choose a reason for hiding this comment

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

but the request is quite different from this, isn't it? Opting out of the request there will not affect the transaction being set on the transaction event - though to be honest, it probably did not actually affect it even before, because that was set anyhow by other code already 😅

@lforst
Copy link
Member

lforst commented Nov 14, 2024

Actually, I think this means we can also deprecate transactionNamingScheme.

mydea and others added 4 commits November 15, 2024 09:44
This is not really necessary anymore - it only sets this on transaction events, and those get the `transaction` in different places already anyhow.

With this, we can also actually remove some other stuff. One method is exported from utils but not otherwise used, we can also drop this in v9.

Finally, this was also the only place that used `route` on the request, so we can also get rid of this in `remix`, which is weird anyhow because we set it for errors there but don't even use it for them.
@mydea mydea force-pushed the fn/deprecate-transaction-method branch from edcca51 to 1025797 Compare November 15, 2024 08:44
@mydea mydea marked this pull request as ready for review November 15, 2024 08:52
@mydea
Copy link
Member Author

mydea commented Nov 15, 2024

Actually, I think this means we can also deprecate transactionNamingScheme.

Good point, also deprecated this!

Copy link

codecov bot commented Nov 15, 2024

❌ 1 Tests Failed:

Tests completed Failed Passed Skipped
241 1 240 9
View the top 1 failed tests by shortest run time
client-app-routing-instrumentation.test.ts Creates a navigation transaction for app router routes
Stack Traces | 30s run time
client-app-routing-instrumentation.test.ts:19:5 Creates a navigation transaction for app router routes

To view more test analytics, go to the Test Analytics Dashboard
Got feedback? Let us know on Github

@mydea mydea merged commit 12902c5 into develop Nov 15, 2024
149 checks passed
@mydea mydea deleted the fn/deprecate-transaction-method branch November 15, 2024 09:28
@mydea mydea linked an issue Nov 15, 2024 that may be closed by this pull request
onurtemizkan pushed a commit that referenced this pull request Nov 22, 2024
…14306)

This is not really necessary anymore - it only sets this on transaction
events, and those get the `transaction` in different places already
anyhow.

With this, we can also actually remove some other stuff. One method is
exported from utils but not otherwise used, we can also drop this in v9.

Finally, this was also the only place that used `route` on the request,
so we can also get rid of this in `remix`, which is weird anyhow because
we set it for errors there but don't even use it for them.

---------

Co-authored-by: Luca Forstner <luca.forstner@sentry.io>
alexandresoro pushed a commit to alexandresoro/ouca that referenced this pull request Nov 22, 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.37.1` -> `8.40.0`](https://renovatebot.com/diffs/npm/@sentry%2fnode/8.37.1/8.40.0) |
| [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.37.1` -> `8.40.0`](https://renovatebot.com/diffs/npm/@sentry%2freact/8.37.1/8.40.0) |

---

### Release Notes

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

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

[Compare Source](getsentry/sentry-javascript@8.39.0...8.40.0)

##### Important Changes

-   **feat(angular): Support Angular 19 ([#&#8203;14398](getsentry/sentry-javascript#14398

    The `@sentry/angular` SDK can now be used with Angular 19. If you're upgrading to the new Angular version, you might want to migrate from the now deprecated `APP_INITIALIZER` token to `provideAppInitializer`.
    In this case, change the Sentry `TraceService` initialization in `app.config.ts`:

    ```ts
    // Angular 18
    export const appConfig: ApplicationConfig = {
      providers: [
        // other providers
        {
          provide: TraceService,
          deps: [Router],
        },
        {
          provide: APP_INITIALIZER,
          useFactory: () => () => {},
          deps: [TraceService],
          multi: true,
        },
      ],
    };

    // Angular 19
    export const appConfig: ApplicationConfig = {
      providers: [
        // other providers
        {
          provide: TraceService,
          deps: [Router],
        },
        provideAppInitializer(() => {
          inject(TraceService);
        }),
      ],
    };
    ```

-   **feat(core): Deprecate `debugIntegration` and `sessionTimingIntegration` ([#&#8203;14363](getsentry/sentry-javascript#14363

    The `debugIntegration` was deprecated and will be removed in the next major version of the SDK.
    To log outgoing events, use [Hook Options](https://docs.sentry.io/platforms/javascript/configuration/options/#hooks) (`beforeSend`, `beforeSendTransaction`, ...).

    The `sessionTimingIntegration` was deprecated and will be removed in the next major version of the SDK.
    To capture session durations alongside events, use [Context](https://docs.sentry.io/platforms/javascript/enriching-events/context/) (`Sentry.setContext()`).

-   **feat(nestjs): Deprecate `@WithSentry` in favor of `@SentryExceptionCaptured` ([#&#8203;14323](getsentry/sentry-javascript#14323

    The `@WithSentry` decorator was deprecated. Use `@SentryExceptionCaptured` instead. This is a simple renaming and functionality stays identical.

-   **feat(nestjs): Deprecate `SentryTracingInterceptor`, `SentryService`, `SentryGlobalGenericFilter`, `SentryGlobalGraphQLFilter` ([#&#8203;14371](getsentry/sentry-javascript#14371

    The `SentryTracingInterceptor` was deprecated. If you are using `@sentry/nestjs` you can safely remove any references to the `SentryTracingInterceptor`. If you are using another package migrate to `@sentry/nestjs` and remove the `SentryTracingInterceptor` afterwards.

    The `SentryService` was deprecated and its functionality was added to `Sentry.init`. If you are using `@sentry/nestjs` you can safely remove any references to the `SentryService`. If you are using another package migrate to `@sentry/nestjs` and remove the `SentryService` afterwards.

    The `SentryGlobalGenericFilter` was deprecated. Use the `SentryGlobalFilter` instead which is a drop-in replacement.

    The `SentryGlobalGraphQLFilter` was deprecated. Use the `SentryGlobalFilter` instead which is a drop-in replacement.

-   **feat(node): Deprecate `nestIntegration` and `setupNestErrorHandler` in favor of using `@sentry/nestjs` ([#&#8203;14374](getsentry/sentry-javascript#14374

    The `nestIntegration` and `setupNestErrorHandler` functions from `@sentry/node` were deprecated and will be removed in the next major version of the SDK. If you're using `@sentry/node` in a NestJS application, we recommend switching to our new dedicated `@sentry/nestjs` package.

##### Other Changes

-   feat(browser): Send additional LCP timing info ([#&#8203;14372](getsentry/sentry-javascript#14372))
-   feat(replay): Clear event buffer when full and in buffer mode ([#&#8203;14078](getsentry/sentry-javascript#14078))
-   feat(core): Ensure `normalizedRequest` on `sdkProcessingMetadata` is merged ([#&#8203;14315](getsentry/sentry-javascript#14315))
-   feat(core): Hoist everything from `@sentry/utils` into `@sentry/core` ([#&#8203;14382](getsentry/sentry-javascript#14382))
-   fix(core): Do not throw when trying to fill readonly properties ([#&#8203;14402](getsentry/sentry-javascript#14402))
-   fix(feedback): Fix `__self` and `__source` attributes on feedback nodes ([#&#8203;14356](getsentry/sentry-javascript#14356))
-   fix(feedback): Fix non-wrapping form title ([#&#8203;14355](getsentry/sentry-javascript#14355))
-   fix(nextjs): Update check for not found navigation error ([#&#8203;14378](getsentry/sentry-javascript#14378))

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

[Compare Source](getsentry/sentry-javascript@8.38.0...8.39.0)

##### Important Changes

-   **feat(nestjs): Instrument event handlers ([#&#8203;14307](getsentry/sentry-javascript#14307

The `@sentry/nestjs` SDK will now capture performance data for [NestJS Events (`@nestjs/event-emitter`)](https://docs.nestjs.com/techniques/events)

##### Other Changes

-   feat(nestjs): Add alias `@SentryExceptionCaptured` for `@WithSentry` ([#&#8203;14322](getsentry/sentry-javascript#14322))
-   feat(nestjs): Duplicate `SentryService` behaviour into `@sentry/nestjs` SDK `init()` ([#&#8203;14321](getsentry/sentry-javascript#14321))
-   feat(nestjs): Handle GraphQL contexts in `SentryGlobalFilter` ([#&#8203;14320](getsentry/sentry-javascript#14320))
-   feat(node): Add alias `childProcessIntegration` for `processThreadBreadcrumbIntegration` and deprecate it ([#&#8203;14334](getsentry/sentry-javascript#14334))
-   feat(node): Ensure request bodies are reliably captured for http requests ([#&#8203;13746](getsentry/sentry-javascript#13746))
-   feat(replay): Upgrade rrweb packages to 2.29.0 ([#&#8203;14160](getsentry/sentry-javascript#14160))
-   fix(cdn): Ensure `_sentryModuleMetadata` is not mangled ([#&#8203;14344](getsentry/sentry-javascript#14344))
-   fix(core): Set `sentry.source` attribute to `custom` when calling `span.updateName` on `SentrySpan` ([#&#8203;14251](getsentry/sentry-javascript#14251))
-   fix(mongo): rewrite Buffer as ? during serialization ([#&#8203;14071](getsentry/sentry-javascript#14071))
-   fix(replay): Remove replay id from DSC on expired sessions ([#&#8203;14342](getsentry/sentry-javascript#14342))
-   ref(profiling) Fix electron crash ([#&#8203;14216](getsentry/sentry-javascript#14216))
-   ref(types): Deprecate `Request` type in favor of `RequestEventData` ([#&#8203;14317](getsentry/sentry-javascript#14317))
-   ref(utils): Stop setting `transaction` in `requestDataIntegration` ([#&#8203;14306](getsentry/sentry-javascript#14306))
-   ref(vue): Reduce bundle size for starting application render span ([#&#8203;14275](getsentry/sentry-javascript#14275))

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

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

-   docs: Improve docstrings for node otel integrations ([#&#8203;14217](getsentry/sentry-javascript#14217))
-   feat(browser): Add moduleMetadataIntegration lazy loading support ([#&#8203;13817](getsentry/sentry-javascript#13817))
-   feat(core): Add trpc path to context in trpcMiddleware ([#&#8203;14218](getsentry/sentry-javascript#14218))
-   feat(deps): Bump [@&#8203;opentelemetry/instrumentation-amqplib](https://github.com/opentelemetry/instrumentation-amqplib) from 0.42.0 to 0.43.0 ([#&#8203;14230](getsentry/sentry-javascript#14230))
-   feat(deps): Bump [@&#8203;sentry/cli](https://github.com/sentry/cli) from 2.37.0 to 2.38.2 ([#&#8203;14232](getsentry/sentry-javascript#14232))
-   feat(node): Add `knex` integration ([#&#8203;13526](getsentry/sentry-javascript#13526))
-   feat(node): Add `tedious` integration ([#&#8203;13486](getsentry/sentry-javascript#13486))
-   feat(utils): Single implementation to fetch debug ids ([#&#8203;14199](getsentry/sentry-javascript#14199))
-   fix(browser): Avoid recording long animation frame spans starting before their parent span ([#&#8203;14186](getsentry/sentry-javascript#14186))
-   fix(node): Include `debug_meta` with ANR events ([#&#8203;14203](getsentry/sentry-javascript#14203))
-   fix(nuxt): Fix dynamic import rollup plugin to work with latest nitro ([#&#8203;14243](getsentry/sentry-javascript#14243))
-   fix(react): Support wildcard routes on React Router 6 ([#&#8203;14205](getsentry/sentry-javascript#14205))
-   fix(spotlight): Export spotlightBrowserIntegration from the main browser package ([#&#8203;14208](getsentry/sentry-javascript#14208))
-   ref(browser): Ensure start time of interaction root and child span is aligned ([#&#8203;14188](getsentry/sentry-javascript#14188))
-   ref(nextjs): Make build-time value injection turbopack compatible ([#&#8203;14081](getsentry/sentry-javascript#14081))

Work in this release was contributed by [@&#8203;grahamhency](https://github.com/grahamhency), [@&#8203;Zen-cronic](https://github.com/Zen-cronic), [@&#8203;gilisho](https://github.com/gilisho) and [@&#8203;phuctm97](https://github.com/phuctm97). Thank you for your contributions!

</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/317
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.

Deprecate AddRequestDataToEventOptions.transaction
3 participants