ES module import issue

Question

ES module import issue

andyzaharia opened this issue 2 years ago · 19 comments

Hi guys, newbie JS developer here.

I've been using this framework in a nodejs app for quite a while and decided to update the server to use ES modules. All went great with all the dependencies that I had in the project but when I got to import the encode func, nodejs complains about the package being a CommonJS module, even thou... I don't think thats true.

import { encode } from "blurhash"; - this ends up with a _SyntaxError: Named export 'encode' not found. The requested module 'blurhash' is a CommonJS module... _ erorr

and if I do this:

import blurhash from "blurhash"; - I end up with a SyntaxError: Unexpected token 'export' error.

Does anyone have any idea what this happens?

Thanks a lot and sorry of this is a stupid question.

Later edit: This problems seems to be happening only with the 2.0.0 version, the 1.1.5 works fine.

Answer 1 · 2022-09-19T22:52:40.000Z

I have the exact same issue.
I have tried importing dist/esm/index.js directly, etc., but no matter how I try, I can't solve the issue.

Answer 2 · 2022-09-22T13:22:42.000Z

This seems to be a problem in blurhash package.json.

To fix it, I had to edit node_modules/blurhash/package.json and added the line:
"type": "module"

Then you can use object deconstruction to import blurhash

import { encode } from 'blurhash'

Answer 3 · 2022-09-22T14:00:42.000Z

I'll look into this, when I have some time.

Answer 4 · 2022-09-25T14:39:25.000Z

Confirmed, similar issue here. I'm writing a Vite plugin that leverages blurhash and get:

import { encode } from "blurhash";
         ^^^^^^
SyntaxError: Named export 'encode' not found. The requested module 'blurhash' is a CommonJS module, which may not support all module.exports as named exports.
CommonJS modules can always be imported via the default export, for example using:

import pkg from 'blurhash';
const { encode } = pkg;

The issue is detailed above but I thought provide the exact issue as seen with my bundler.

I reverted to 1.1.3 which has the correct export. Using 2.0.0 is blocked until the export detailed above is resolved.

Thanks for maintaining this neat project.

Answer 5 · 2022-09-27T08:10:32.000Z

Hi all 👋🏼

Please try out 2.0.1 and let me know if that resolves your issues.

Answer 6 · 2022-09-27T18:27:28.000Z

@Thisen am using 2.0.1 and same issue.

Looks like is still loading the CJS version in Vite, giving error: 'module' is not defined or the does not provide export one above.

Answer 7 · 2022-09-27T22:00:32.000Z

@Thisen am using 2.0.1 and same issue.

Looks like is still loading the CJS version in Vite, giving error: 'module' is not defined or the does not provide export one above.

Could you provide me with a reproduction?

Answer 8 · 2022-09-27T23:37:35.000Z

@Thisen sure...
https://github.com/kaption-co/blurhash-repro

Note that this repro excludes 'blurhash' from optimizing the default CJS file to ESM...

Answer 9 · 2022-09-28T09:08:59.000Z

@Thisen sure... https://github.com/kaption-co/blurhash-repro

Note that this repro excludes 'blurhash' from optimizing the default CJS file to ESM...

Thank you for the reproduction! It helped me to resolve the issue and it should work in 2.0.2. Please try it out.

Answer 10 · 2022-10-03T09:29:17.000Z

@Thisen sure... https://github.com/kaption-co/blurhash-repro
Note that this repro excludes 'blurhash' from optimizing the default CJS file to ESM...

Thank you for the reproduction! It helped me to resolve the issue and it should work in 2.0.2. Please try it out.

#210 pointed out in exports field order, try 2.0.3. 💪🏼

Answer 11 · 2022-10-03T09:29:57.000Z

@mrtnzlml I see you had some issues, could you try out 2.0.3? :)

Answer 12 · 2022-10-03T21:50:18.000Z

@Thisen this is resolved for me in latest version.

Answer 13 · 2022-10-04T06:20:44.000Z

Awesome! Closing.

Answer 14 · 2022-10-06T02:11:23.000Z

Hi @Thisen! 👋 There is still some breaking change in the patch release, as you can see in this PR: adeira/universe#5088

The situation got better. I can start the application with blurhash 2.0.3; however, it's still failing in Jest tests. 😞

Answer 15 · 2022-10-10T11:53:53.000Z

Hi @Thisen! 👋 There is still some breaking change in the patch release, as you can see in this PR: adeira/universe#5088

The situation got better. I can start the application with blurhash 2.0.3; however, it's still failing in Jest tests. 😞

I can't speak into that. I'd need a new issue with a reproduction :)

Answer 16 · 2022-10-14T10:25:06.000Z

Hi @Thisen! 👋 There is still some breaking change in the patch release, as you can see in this PR: adeira/universe#5088

The situation got better. I can start the application with blurhash 2.0.3; however, it's still failing in Jest tests. 😞

I'm seeing this as well. Jest tests break at 2.0.3. @mrtnzlml did you find a workaround?

Answer 17 · 2022-10-14T10:41:31.000Z

Ok I see that adding blurhash into transformIgnorePatterns in Jest config is a workaround for this bug. Not sure where this happens but it seems like a bug in this project @Thisen

Answer 18 · 2022-10-17T18:49:02.000Z

Ok I see that adding blurhash into transformIgnorePatterns in Jest config is a workaround for this bug. Not sure where this happens but it seems like a bug in this project @Thisen

A new issue with a reproduction would be great. 👍🏼

Answer 19 · 2022-10-17T23:33:21.000Z

@janpe I didn't have time to check it yet or prepare a repro. Thanks for the suggested workaround! 👏 It is certainly a breaking change in a patch release. 😞