Release health sessions not sent when using a direct client

[rodolfoBee]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Sentry Saas (sentry.io)

Which SDK are you using?

@sentry/browser

SDK Version

"@sentry/browser": "^8.47.0"

Framework Version

No response

Link to Sentry event

No response

Reproduction Example/SDK Setup

import {
  BrowserClient,
  defaultStackParser,
  getDefaultIntegrations,
  browserSessionIntegration,
  makeFetchTransport,
  Scope,
} from "@sentry/browser";

// filter integrations that use the global variable
const integrations = getDefaultIntegrations({}).filter(
  (defaultIntegration) => {
    return !["BrowserApiErrors", "Breadcrumbs", "GlobalHandlers"].includes(
      defaultIntegration.name,
    );
  },
);

const client = new BrowserClient({
  dsn: "...",
  transport: makeFetchTransport,
  stackParser: defaultStackParser,
  integrations: [ ...integrations, browserSessionIntegration()],
  release:"directClient@1.0.0",
  autoSessionTracking:true,
  initialScope: {
    user: { id: 42, email: "john.doe@example.com" },
  },
});

const scope = new Scope();
scope.setClient(client);

client.init(); // initializing has to be done after setting the client on the scope
// rest of the logic

Steps to Reproduce

1. Run a simple app with the configuration above

Expected Result

The SDK sends release health sessions to Sentry to track release health and adoption on the Releases page.

Actual Result

No release session event is sent to Sentry.

Explicitly setting the browserSessionIntegration integration and/or autoSessionTracking have no effect on the result, this should also be automatic when a release version is set in the init as per:

• https://docs.sentry.io/platforms/javascript/configuration/releases/#release-health

[s1gr1d]

Hello,
I'm gonna try to reproduce this. But one follow-up questions: How does the application look like where Sentry is running? Is this a browser extension or any other shared environment as a BrowserClient is explicitly created?

[ionutholbia]

@s1gr1d In our case Sentry is initialized in the service worker of a browser extension. I think @rodolfoBee also reproduced the issue but now sure how he tested.

[s1gr1d]

in the service worker of a browser extension

The BrowserSession integration might not be set up correctly. Can you enable debug: true and check if you get a warning like this: "Using the browserSessionIntegration in non-browser environments is not supported.".

The SDK checks if WINDOW.document is available. I just want to check if you're running into this condition.

[ionutholbia]

The first print is mine.

Haven't received a print like: "Using the browserSessionIntegration in non-browser environments is not supported."

Maybe it's worth mentioning that if I initialize Sentry on a global scope using Sentry.init then Release healthy sessions work fine.

[s1gr1d]

Thanks for this information! I'll look into this.

[ionutholbia]

Hi @s1gr1d ! Do you have an update on this ticket?

[s1gr1d]

Hello, not so far as I was busy with other things during the holiday break. I will take a look this week and give you an update.

[lforst]

I think I figured it out. So basically previously we didn't support session tracking for client-based setups at all. We then extracted the logic from Sentry.init() into an integration, however the logic depends on the fact that the client is set on the "current scope" (Sentry.getCurrentScope()). This means that the browserSessionIntegration() only works if Sentry.getCurrentScope().setClient(client) is called before calling client.init().

All of this is obviously suboptimal - we'll look into fixing it.

[ionutholbia]

Hi @lforst,

Thank you for you answer! Setting a client at a global scope using getCurrentScope wouldn't help much for our usecase. We would like to initialize a Sentry client (Two different Sentry Projects) for two different modules. I would guess that if we would implement this workaround we will have Sessions only for one project.

I will still try to do that until we would have a fix.

[lforst]

@ionutholbia Thanks for the background! Can I ask for the exact outcome you have with the API? Also, would you mind elaborating how your setup looks like with the different projects? I don't think I fully comprehended it yet.

The fix I have in mind is probably that for every client on the page that has the browserSessionIntegration() sessions will be sent via the respective client. This means you could have 2+ sessions per page. Is this also what you are looking for?

[ionutholbia]

Basically our browser extension has two different functionalities that are more or less independent. We want to have two different Sentry Projects (2 DSNs) for these two functionalities. To implement this we will use 2 clients. Here is a snippet of the code. Current as a workaround for sessions we are setting only one client as current scope.

IMO your proposed solution should work for us.

this.client = new BrowserClient({
      dsn: this.configuration.dsn, 
      transport: makeFetchTransport,
      stackParser: defaultStackParser,
      integrations,
      tracesSampleRate: this.configuration.sampleRate,
      release: this.configuration.productVersion,
      environment: this.configuration.environment,
    })

    this.scope = new Scope()

    this.scope.setUser({ id: this.configuration.telemetryId })

    this.scope.setClient(this.client)
    if (this.configuration.setClientAsGlobalScope) { //Workaround for one client
      getCurrentScope().setClient(this.client)
    }

    this.client.init() // initializing has to be done after setting the client on the scope

[lforst]

Okay that tracks. Thanks for clarifying!

[ionutholbia]

Hi @lforst,
Do you have any updates on this bug? Unfortunately the workaround suggested by you to call Sentry.getCurrentScope().setClient(client) before calling client.init() didn't work for me.

[lforst]

no updates

[swissmo]

Hello,
I was wondering if there was any news about this issue?

[lforst]

Hi, there are no updates. Also, and please don't take this the wrong way, it is entirely meant as a heads up: I recommend not asking for updates on issues unless they were obviously forgotten about. This issue is on our backlog but is currently not a priority. "Update comments" create noise for us that we have to filter out and slow us down which is in no one's interest. In the meantime, I want to encourage you to propose and contribute a solution - we are open to accepting them. Thanks and hope you understand!