Passing `() => scope` as `captureContext` does not work

[eamon0989]

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/node

SDK Version

7.101.1

Framework Version

No response

Link to Sentry event

https://s1seven.sentry.io/issues/4488829135/?environment=local&project=5880685&query=is%3Aunresolved&referrer=issue-stream&statsPeriod=7d&stream_index=0&utc=true

SDK Setup

init({
      tracesSampleRate: 1.0,
      ...params,
      autoSessionTracking: true,
      integrations: [
        browserTracingIntegration(),
        ...(params.integrations || []),
      ],

Steps to Reproduce

Prior to v7.87.0 we were able to use setExtra and see the information in the ui, we set the data like this:

    const { method, statusCode, path, stack } = errorResponse;
    const request = context.getRequest<ExtendedRequest>();
    const scope = new Scope();
    if (request.currentUser) {
      scope.setUser(request.currentUser);
    } else if (request.currentCompany) {
      scope.setUser(request.currentCompany);
    }
    scope.setExtras({
      ...(!isEmpty(request.currentScopes) && {
        [SentryExtrasProps.access_scopes]: request.currentScopes,
      }),
      [SentryExtrasProps.request_id]: request.requestId,
      [SentryExtrasProps.stack]: stack,
      [SentryExtrasProps.http_headers]: request.headers,
      [SentryExtrasProps.http_method]: request.method,
      [SentryExtrasProps.http_params]: request.params,
      [SentryExtrasProps.http_query]: request.query,
      [SentryExtrasProps.http_body]: request.body,
      [SentryExtrasProps.error_message]: errorResponse.message,
      [SentryExtrasProps.error_details]: errorResponse.details,
    });
    const mode = extractModeFromHttpRequest(request);
    scope.setTags({
      requestId: request.requestId,
      statusCode,
      method,
      path,
      protocol: 'http',
      ...(mode ? { mode } : {}),
      ...tags,
    });

We used to use setExtra but that stopped working in v7.87.0, so we switched to setExtras, but that seemed to stop working in v7.89.0.

There is no deprecated tag on either of those methods, and in the release notes for v7.101.1 it says:
feat(core): Write data from setUser, setTags, setExtras, setTag, setExtra, and setContext to isolation scope ([#10163](https://github.com/getsentry/sentry-javascript/pull/10163)) so it appears that they are still in use.

However in the docs (https://docs.sentry.io/platforms/javascript/enriching-events/context/#additional-data) it says the following:

Additional Data is deprecated in favor of structured contexts.
Sentry used to support adding unstructured "Additional Data" via setExtra.

As you can see in the screenshot, we could previously see all this information:

Since v7.89.0 all that information is missing.

Expected Result

I should still be able to see that extra information in the UI. There should be clear documentation and deprecated tags if setExtra and setExtras are no longer to be used.

Actual Result

All that extra information is now missing:

[eamon0989]

Looking at the code in node_modules in @sentry/core/cjs/exports.js, it seems that setExtras is not deprecated, but internally it uses a method that is deprecated.

I noticed that a PR that was merged 18 hours ago updates this to use getIsolationScope instead, but in the PR description it says The hub already writes there, but this circumvents the hub now!, so it shouldn't make a difference.

https://github.com/getsentry/sentry-javascript/pull/10678/files

Not sure if this has anything to do with my issue or not.

[mydea]

Hey,

setExtra and setExtras should continue to work as expected on the scope. I wonder, what do you do with the scope = new Scope()? I would avoid this and instead use withScope there - as the manually created scope will not necessarily be picked up by events being created:

Sentry.withScope(scope => {
  scope.setExtra(...);
  // set scope stuff here
  // anything captured inside of this callback will have this applied!
});

The PR you referenced is going into v8, all the APIs that are deprecated should still works as expected!

[eamon0989]

Thank you for your quick reply, in the meantime I did some tests and when I replaced scope.setExtras with Sentry.setExtras it fixed the problem, so my bad. I am still surprised that scope.setExtras doesn't work.

This works:

    import * as Sentry from '@sentry/core';

    const scope = new Scope();
    if (request.currentUser) {
      Sentry.setUser(request.currentUser);
    } else if (request.currentCompany) {
      Sentry.setUser(request.currentCompany);
    }
    Sentry.setExtras({
      ...(!isEmpty(request.currentScopes) && {
        [SentryExtrasProps.access_scopes]: request.currentScopes,
      }),
      [SentryExtrasProps.request_id]: request.requestId,
      [SentryExtrasProps.stack]: stack,
      [SentryExtrasProps.http_headers]: request.headers,
      [SentryExtrasProps.http_method]: request.method,
      [SentryExtrasProps.http_params]: request.params,
      [SentryExtrasProps.http_query]: request.query,
      [SentryExtrasProps.http_body]: request.body,
      [SentryExtrasProps.error_message]: errorResponse.message,
      [SentryExtrasProps.error_details]: errorResponse.details,
    });
    const mode = extractModeFromHttpRequest(request);
    Sentry.setTags({
      requestId: request.requestId,
      statusCode,
      method,
      path,
      protocol: 'http',
      ...(mode ? { mode } : {}),
      ...tags,
    });
    return scope;

We used new Scope() so that we could return the scope from that function and then pass it to another method (this.sendToSentry).

      const scope = SentryExceptionService.createHttpCustomExceptionScope(
        errorResponse,
        context,
        {
          appName: this.appName,
          appVersion: this.appVersion,
          serverUrl: this.serverUrl,
        }
      );

      this.sendToSentry(exception, scope);

Thanks for the tip on using Sentry.withScope instead of new Scope(), I will try that.

[mydea]

Good that it helped! still, I'm curious - could you paste what you do in sendToSentry, e.g. how do you pass the scope etc?