Sentry-javascript: Typing errors on 3.13.0 release

[pierrickouw]

Do you want to request a feature or report a bug?

Bug

What is the current behavior?

The last release (3.13.0) seems to have broken some type definitions.

In a .ts file compiled with tsc

import * as Raven from 'raven-js';
Raven.config(/*..*);

In a get ->

error TS2339: Property 'config' does not exist on type 'typeof ".../node_modules/raven-js/typescri...'

I see the same error in Visual Code.

What is the expected behavior?

This was working fine in 3.12.
I saw in the release page, that many changes occurred during the last release on ts files so I might not using it correctly anymore.
Thanks for your time, and do not hesitate if you need more information.

[tomasklingen]

The typescript declaration file has changed.
The new way to import is: import Raven from "raven-js";

[pierrickouw]

It's working, thanks !

[pierrickouw]

Actually, I still have an issue:
import Raven from "raven-js"

// when compiled 
raven_js_1.default.config(constants_1.SENTRY_URL, {
                 ^   
TypeError: Cannot read property 'config' of undefined

[michaeljones]

I have the same issue. The code appears to be doing module.exports = Raven but the typescript is using export default so they seem to be incompatible unless I am missing something? Perhaps there is a setting in typescript that allows for this? The raven typescript tests appear to use import ... from ... so perhaps it is possible to make it work?

[tomasklingen]

Same. Pinned raven-js in my package.json to "raven-js": "~3.12.2" for now.

It is working in the raven-tests.ts file because it's really just testing the .d.ts file.

[benvinegar]

So, obviously this was caused by #827. Can anything from tsconfig.json be used in your local config?

Folks, I need a hand. I don't write TypeScript, and I rely on the community to get these definitions right.

@LucaVazz @graingert @connor4312

[benvinegar]

I'm guessing it's related to this:

"compilerOptions": {
  "module": "commonjs",
  // ...
}

[benvinegar]

If I don't have a resolution by EOD I'll back out #827 entirely and publish 3.13.1.

[graingert]

the reason is your .d.ts describes an ES module, but your source code is a CJS module

[benvinegar]

the reason is your .d.ts describes an ES module, but your source code is a CJS module

Yep, I understand. So the "fix" is to tell the tsc to treat your entire project as CJS (module: "commonjs"), as the tests do? But I presume people can't do that for perfectly good reasons.

So is the only solution to go back to the old definitions? Can we amend the existing ones quickly to use the previous export statements?

[graingert]

you should be able to say that Raven is a CJS module, or switch to ESM completely.

[graingert]

Options:

declare as CJS

declare module "raven-js" {
    export = Raven
}

Then move all the exported interfaces to a new .ts file (that typescript users can import) and import into raven.d.ts

declare as ESM

Then to support const Raven = require('raven-js'); add Raven back to module.exports with Raven.default === Raven and Raven.__esModule === true:

import objectAssign from 'object-assign';

const assign = Object.assign || objectAssign;
const Raven = ...
export default Raven
module.exports = assign(Raven, module.exports);

[benvinegar]

It's definitely going to stay as CommonJS.

Can anyone try 3.13.0 with the changes Ben suggested above?

[benvinegar]

Thomas, sorry :)

[graingert]

@benvinegar I'd recommend the ESM + module.exports = Object.assign trick.

[benvinegar]

I'm going to revert for now, publish 3.13.1, then look into getting this done for the future.

[benvinegar]

3.13.1 is published. Keeping this open because I want to solve this TypeScript problem properly – and hopefully for the last time.

[LucaVazz]

Ouch, I'm really sorry to have caused this trouble.

@graingert could you please open a PR with the CJS-Variant you suggested to get it fixed?

[whatisaphone]

While Typescript support is being looked at, I'd like to reflag my PR #736 from last year. Right now we're stuck on [email protected] because of this issue. After that version there was a regression and RavenOptions changed from exported to private.

Even in that old version, we have to import it in a very hacky way:

import { RavenOptions, RavenStatic } from 'raven-js';  // this is messy because we're waiting on a raven-js bugfix
const Raven: RavenStatic = require('raven-js');  // tslint:disable-line

Ideally with proper typings, we'd be able to do something like this:

import Raven, { RavenOptions } from 'raven-js';

export function captureMessage(msg: string, options?: RavenOptions) {
    Raven.captureMessage(msg, options);
}

My PR #736 demonstrates how this can be done.