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(nextjs): Make build-time value injection turbopack compatible #14081

Merged
merged 9 commits into from
Nov 6, 2024

Conversation

lforst
Copy link
Member

@lforst lforst commented Oct 28, 2024

Ref: #8105

To inject build-time variables, in addition to doing so via a custom loader, we will be injecting them via the env option.

Caveat: We are currently using the Next.js build ID as a release name. This build id is passed to the webpack option. Since the webpack option doesn't exist for turbopack we don't have access to the build ID. For now we will simply not inject a release name, which may be better anyhow since turbopack is currently only stable for dev.

Copy link
Contributor

github-actions bot commented Oct 29, 2024

size-limit report 📦

Path Size % Change Change
@sentry/browser 22.76 KB - -
@sentry/browser - with treeshaking flags 21.54 KB - -
@sentry/browser (incl. Tracing) 35.25 KB - -
@sentry/browser (incl. Tracing, Replay) 71.96 KB - -
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 62.35 KB - -
@sentry/browser (incl. Tracing, Replay with Canvas) 76.3 KB - -
@sentry/browser (incl. Tracing, Replay, Feedback) 89.11 KB - -
@sentry/browser (incl. Feedback) 39.9 KB - -
@sentry/browser (incl. sendFeedback) 27.4 KB - -
@sentry/browser (incl. FeedbackAsync) 32.2 KB - -
@sentry/react 25.51 KB - -
@sentry/react (incl. Tracing) 38.2 KB - -
@sentry/vue 26.9 KB - -
@sentry/vue (incl. Tracing) 37.08 KB - -
@sentry/svelte 22.89 KB - -
CDN Bundle 24.11 KB - -
CDN Bundle (incl. Tracing) 37 KB - -
CDN Bundle (incl. Tracing, Replay) 71.68 KB - -
CDN Bundle (incl. Tracing, Replay, Feedback) 77.02 KB - -
CDN Bundle - uncompressed 70.66 KB - -
CDN Bundle (incl. Tracing) - uncompressed 109.84 KB - -
CDN Bundle (incl. Tracing, Replay) - uncompressed 222.36 KB - -
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 235.58 KB - -
@sentry/nextjs (client) 38.31 KB +0.03% +10 B 🔺
@sentry/sveltekit (client) 35.83 KB - -
@sentry/node 131.52 KB - -
@sentry/node - without tracing 95.64 KB - -
@sentry/aws-serverless 105.91 KB - -

View base workflow run

@lforst lforst marked this pull request as ready for review November 4, 2024 15:43
@lforst lforst requested a review from chargome November 4, 2024 15:43
@lforst lforst requested a review from AbhiPrasad November 5, 2024 14:13
@OskarD
Copy link

OskarD commented Nov 5, 2024

Thank you for this!! I can't wait for faster build times during development! 🥳

@lforst
Copy link
Member Author

lforst commented Nov 6, 2024

@OskarD Unless you want to use Sentry during development (which would be of questionable value), you can already just switch to Turbopack! Sentry will not crash you or anything.

@OskarD
Copy link

OskarD commented Nov 6, 2024

@OskarD Unless you want to use Sentry during development (which would be of questionable value), you can already just switch to Turbopack! Sentry will not crash you or anything.

My hot reloading doesn't work, and I get these warnings:

[@sentry/nextjs] WARNING: You are using the Sentry SDK with next dev --turbo. The Sentry SDK doesn't yet fully support Turbopack. The SDK will not be loaded in the browser, and serverside instrumentation will be inaccurate or incomplete. Production builds without --turbowill still fully work. If you are just trying out Sentry or attempting to configure the SDK, we recommend temporarily removing the--turbo flag while you are developing locally. Follow this issue for progress on Sentry + Turbopack: https://github.com/getsentry/sentry-javascript/issues/8105. (You can suppress this warning by setting SENTRY_SUPPRESS_TURBOPACK_WARNING=1 as environment variable)

 ⚠ Webpack is configured while Turbopack is not, which may cause problems.
 ⚠ See instructions if you need to configure Turbopack:
  https://nextjs.org/docs/app/api-reference/next-config-js/turbo

I don't get them without the dependency installed

Copy link
Member

@chargome chargome left a comment

Choose a reason for hiding this comment

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

LGTM, how will we handle this once turbopack is stable for prod?

@lforst
Copy link
Member Author

lforst commented Nov 6, 2024

@OskarD All of these are just warnings. Everything except for certain Sentry SDK features will operate normally.

The SDK causing MHR to not work is incredibly unlikely but I am happy to be proven wrong if you provide a reproduction example!

@lforst
Copy link
Member Author

lforst commented Nov 6, 2024

LGTM, how will we handle this once turbopack is stable for prod?

In theory, this should already work for prod turbopack. The only thing left is the release injection for which we need a breaking change.

@lforst lforst merged commit 3750914 into develop Nov 6, 2024
142 checks passed
@lforst lforst deleted the lforst-turbo-compatible-constant-injection branch November 6, 2024 11:23
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.

4 participants