ref(typescript): Remove DOM from default lib types

[timfish]

The base TypeScript config currently includes DOM types:

sentry-javascript/packages/typescript/tsconfig.json

Line 10 in a5bfa80

"lib": ["es6", "dom"],

In the spirit of supporting other JavaScript runtimes (#5611), we need to keep these types out of the core packages.

This PR removes DOM from the base tsconfig lib types and adds it back to all the packages where it's required. For now this effectively removes the DOM types from @sentry/types, @sentry/core, @sentry/hub and @sentry/node.

@sentry/utils will follow later when all the browser code has been moved!

This PR also formats the tsconfig.json files.

Pros

• Keeps DOM types out of the core packages and node.js

Cons

• @sentry/electron, @sentry/react-native, sentry-cordova and @sentry/capacitor may need to add "lib": ["ES6", "DOM"] to their tsconfig.json.

Alternatives

Override with "lib": ["ES6"] in the packages where there shouldn't be any DOM types.

[timfish]

It looks like this actually picked up a bug in @sentry/node on v8 where the global URL isn't available 🤔

[timfish]

This isn't quite as simple as I'd hoped as there are issues around the tests and setInterval types.

[AbhiPrasad]

Can we change setInterval to use global.setInterval? I assume this is just updating the session flusher types.

[timfish]

We can, but first we'll need a common global type and there might be some issues surrounding the use of ReturnType<typeof setInterval> since this type varies on node.js.

[timfish]

On node v8 URL would have always been undefined whereas now it'll parse the url correctly.

[lobsterkatie]

On node v8 URL would have always been undefined

Yup - that's what the url.parse() line is there for.

The reason there's the bare URL is because for a hot second this code lived in utils and therefore needed to be compatible with the browser as well. Given that if any part of it ever ends up back in the land of shared code it'll be this part, I'm tempted to say we should just leave this be. (Unless is straight-up broken, but I don't believe that's the case, is it?)

[timfish]

Yup - that's what the url.parse() line is there for.

🤦🏻‍♂️

Looks like a version of this code still lives in utils with an InjectedNodeDeps:

sentry-javascript/packages/utils/src/requestdata.ts

Lines 339 to 342 in 12c19d0

	function extractQueryParams(
	req: PolymorphicRequest,
	deps?: InjectedNodeDeps,
	): string | Record<string, unknown> | undefined {

I'm tempted to say we should just leave this be

Given that we're not supporting node v8 for much longer this change is almost certainly gratuitous but after removing dom types, TypeScript was throwing a build error!

[timfish]

The errors were in the actual test code files so fixing was only a matter of adding dom lib types to the relevent tsconfig.test.json files.

[lobsterkatie]

• @sentry/electron, @sentry/react-native, sentry-cordova and @sentry/capacitor may need to add "lib": ["ES6", "DOM"] to their tsconfig.json.

Another option is to leave the tsconfig in @sentry/typescript alone and make the change in the repo-level tsconfig, from which all other tsconfigs in the repo inherit.

[timfish]

Another option is to... make the change in the repo-level tsconfig

I listed that in the PR description as a possible alternative and looking at this PR now it feels compelling. It just felt like dom types really should be opt-in rather than the default. 🤔