Multiple incompatible Scope types in v8.x

[alumni]

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?

Self-hosted/on-premise

Which SDK are you using?

@sentry/node

SDK Version

8.0.0

Framework Version

NestJS 10

Link to Sentry event

No response

SDK Setup

No response

Steps to Reproduce

It seems there are multiple types for Scope which are incompatible with each other.

withScope() from @sentry/core is using Scope from @sentry/types, but there is also a Scope in @sentry/core.

Both are directly or indirectly exported also by @sentry/node.

Expected Result

We tend to use everything from @sentry/node (since we should not care about the internals of Sentry). It would be great to have proper type compatibility.

Actual Result

The two Scope types are not compatible with each other:

Argument of type
'import(".../node_modules/@sentry/types/types/scope").Scope'
is not assignable to parameter of type
'import(".../node_modules/@sentry/core/types/scope").Scope'.

[roderik]

To make it worse, the re-exported withScope in @sentry/node is using this different Scope, so even an import line like import { Scope, addRequestDataToEvent, captureException, withScope } from '@sentry/node'; is incompatible

Nor does this work

import { Scope, withScope } from '@sentry/core';
import { addRequestDataToEvent, captureException } from '@sentry/node';

[mydea]

Hey,

could you share the actual code that is triggering this problem for you? e.g.

import {Scope} from '@sentry/node';

function myFunction(scope: Scope): void {
  xxx(scope);
}

It should be the case that you can pass the scope from @sentry/node everywhere - this is the actual scope class, while in all places that accept a scope we should be using the scope type. but it may be the case that we missed some place there 🤔

[alumni]

Sorry, I didn't write properly in the issue description, but it's exactly what @roderik is mentioning as well.

import { type Scope, withScope } from '@sentry/node';

withScope((scope: Scope) => {});
//         ^
// Argument of type
// 'import(".../node_modules/@sentry/types/types/scope").Scope'
// is not assignable to parameter of type
// 'import(".../node_modules/@sentry/core/types/scope").Scope'.

@sentry/node exports the Scope class from @sentry/core.
@sentry/node also exports withScope from @sentry/core. This withScope method has a callback argument of type Scope, an interface that comes from @sentry/types.

This was not the case in v7, where the Scope class was also used by the callback of withScope.

The class and the interface are not compatible with each other.

[mydea]

Ah, I see now.

Yeah, this is a bit annoying/tricky. What you can do for now is install @sentry/types and import all the types you use in your app from there:

import { withScope } from '@sentry/node';
import type { Scope } from '@sentry/types';

withScope(scope: Scope, () => {});

(that, or let the type be inferred, which should be correct as well).

I have opened a PR to fix this behavior in the next version: #12067
There, it should work again to do import type {Scope} from '@sentry/node' and get the expected behavior!