offline integration requires typescript dom lib in integration package

[jstewmon]

• [ x ] Review the documentation: https://docs.sentry.io/
• [ x ] Search for existing issues: https://github.com/getsentry/sentry-javascript/issues
• [ x ] Use the latest release: https://github.com/getsentry/sentry-javascript/releases

Package + Version

• [ x ] @sentry/integrations 5.22.3

Description

The recently added offline integration (#2778) depends on the TypeScript dom lib, which cannot be safely included in node.js projects due to incompatible interface definitions, such as Timers.

I found an existing mention of this problem, but no issue tracking it yet:

#2853 (comment)

I see that dom is included in the repo-wide tsconfig.json file:
https://github.com/getsentry/sentry-javascript/blob/master/packages/typescript/tsconfig.json#L9

It may help to remove dom from that shared file and only include dom in the browser package to avoid this problem.

[davidmyersdev]

@jstewmon since I added the Offline integration, I would be happy to help out here if possible. Do you have an example of how to reproduce this problem?

[davidmyersdev]

Not directly related, but previous changes to this piece of the codebase lead to #2868, so we'll want to keep that in mind.

[jstewmon]

@voraciousdev sure, I put up a minimal reproduction repo here: https://github.com/jstewmon/sentry-javascript-2877

If you run npm i && npx tsc -b, you'll see the errors. The only way around it currently is to enable skipLibCheck to avoid checking the dom types referenced by localforage.

[jstewmon]

@HazAT @voraciousdev @kamilogorek The sentry packages have been essentially unusable in typescript projects targeting node for 2 months now. Is there any plan to remediate this issue?

[kirillgroshkov]

We've pinned to 5.21.4 (the last working version) about 2 months ago

[brandonb927]

Just chiming in here to say that we tried to upgrade to latest version this morning in our Typescript project and cannot do so because of the dom lib issue. Hoping for a timely resolution as there are a lot of fixes between 5.19.x (which we're on) and latest.

@kirillgroshkov I think we were able to get around this by adding dom to the tsconfig#compilerOptions in our project:

"compilerOptions": {
  "lib": [
    "dom"
  ]
}

I know this doesn't work for everyone, but it solved the errors we were seeing like:

node_modules/localforage/typings/localforage.d.ts(65,43): error TS2304: Cannot find name 'Blob'.
node_modules/localforage/typings/localforage.d.ts(67,54): error TS2304: Cannot find name 'Blob'.

After going through this, I don't actually think the issue we were encountering is the same as OP at this point, but I will leave this comment for anyone else that is curious.

[kirillgroshkov]

Yeah, we're still on 5.21.4 as a last working version

[kamilogorek]

I just tested one of the possible solutions to this issue. Basically using Triple-Slash Directive /// <reference lib="dom" /> instead of relying on project config - https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html
The only downside here, is that it will include the built-in typing compilation-wide, not only in this specific file.

[dearsaturn]

Is there an acceptable fix for this that doesn't include adding dom typings? I'm using Sentry in a backend service, adding typings that aren't supported by what's actually available in Node doesn't seem like the right way.

[felipeochoa]

Bump from a paying customer