Multiple incompatible `Scope` types in v8.x

[alumni]

Multiple incompatible `Scope` types in v8.x

[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!