Skip to content

Support lazy-loading to keep the initial client bundle small (@sentry/nuxt) #16700

Open
@felixgabler

Description

@felixgabler

Problem Statement

The legacy Nuxt 2 module @nuxtjs/sentry exposed a [lazy: true option](https://sentry.nuxtjs.org/guide/lazy-loading/) that:

  • removed the Sentry runtime from the default client bundle
  • injected a mocked $sentry instance together with $sentryReady() / $sentryLoad() helpers so we could load Sentry on-demand (e.g. after user consent or on the first error)

In production this shaved 40 kB (gzipped) off the initial JS sent to every visitor, important for Core Web Vitals on mobile connections.

The current Nuxt 3 integration always ships the full SDK in the main bundle. For apps that need the SDK only after explicit user consent or once the user is authenticated this is avoidable overhead.

Solution Brainstorm

It would be great if @sentry/nuxt could bring back first-class lazy-loading support, for example:

  1. Config flag

    // nuxt.config.ts
    sentry: { lazy: true, /* … */ }
  2. Mocked API injection (parity with Nuxt 2)

    • Inject a lightweight proxy that queues calls until the real SDK is loaded.
    • Expose $sentryReady() (Promise) and optionally $sentryLoad() to manually trigger the load.
  3. Route-level auto-loading
    Allow opting into SDK loading per-route via route rules or middleware so that public/landing pages remain lean.

  4. Vite split-chunk
    Generate a separate sentry.client.js chunk and load it dynamically so source-maps & release artifacts continue to work as today.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy