Typescript - @sentry/utils references node types

[dleavitt]

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

Package + Version

• @sentry/browser
• @sentry/node
• raven-js
• raven-node (raven for node)
• other: @sentry/utils

Version:

5.0.7
5.0.6

Description

The browser package relies on:
@sentry/utils/dist/misc.d.ts which in turn relies on node type definitions:

/// <reference types="node" />

// ...

export declare function dynamicRequire(mod: NodeModule, request: string): any;

This causes the following errors when used in conjunction with the Fork TS Checker Webpack Plugin:

ERROR in node_modules/@sentry/utils/dist/misc.d.ts(1,23):
TS2688: Cannot find type definition file for 'node'.
ERROR in /node_modules/@sentry/utils/dist/misc.d.ts(16,45):
TS2304: Cannot find name 'NodeModule'.

These can be resolved by either including @types/node in your package.json file or by making a file in a typeRoots directory named node.d.ts with the following contents:

declare module "node" {
  interface NodeModule {}

  // this ns may no longer be needed as of 5.0.7
  namespace NodeJS {
    export type Global = any
  }
}

It seems strange that a browser library would rely on node typedefs, but these errors do not seem to occur in a more vanilla Typescript/Webpack setup. So it's possible there's nothing to fix here, but hopefully the above notes might be useful to others who encounter this issue.

[HazAT]

Fixed in master :)