Fix imports for ESM modules. #1173
Conversation
| @@ -12,8 +12,8 @@ | |||
| "jsx": "preserve", | |||
| "importHelpers": true, | |||
| "moduleResolution": "node", | |||
| "esModuleInterop": false, | |||
| "allowSyntheticDefaultImports": false, | |||
| "esModuleInterop": true, | |||
There was a problem hiding this comment.
This setting could have negative effects in other scenarios, there is a risk this could break production build chains if changed.
There was a problem hiding this comment.
Hi @manast
I was a bit concerned regarding the building process but the TSC checks are passing, esbuild and babel are unable to bundle BullMQ tho.
There was a problem hiding this comment.
But maybe there are no drawbacks with this setting, I am not sure. I remember battling this setting in the past, but I do not remember the details.
There was a problem hiding this comment.
Here is some old discussion, since this flag was actually true in the initial version: #129
Maybe they lured me into changing it :). But the question is, will BullMQ still work for those dependants that have the flag set to false?
There was a problem hiding this comment.
Huh, you are right but basically, that's more an issue with ioredis. It seems that one way or another the build will fail for some of us based on the way we are consuming bullmq. Honestly, I think I could live by using bullmq as a common-js module in order to avoid the hustle.
There was a problem hiding this comment.
I think both ioredis@4 and ioredis@5 don't require esModuleInterop to be enabled and it should be able to be imported via import Redis from 'ioredis', but lmk if I'm wrong on this. Happy to make changes if there is anything we can do on ioredis side.
There was a problem hiding this comment.
@luin actually I just tried the following with ioredis version 4.28.5:
import IORedis from 'ioredis';Building with tsc (3.9.109), gives this error:
works with this instead:
import * as IORedis from 'ioredis';There was a problem hiding this comment.
So the problem seems to be in the typings, it should say:
export default IORedisThere was a problem hiding this comment.
Hmm...yeah that sounds to be an issue on @types/ioredis. ioredis@5 provides official TypeScript declarations so it doesn't have the issue. Probably can create a PR on @types/ioredis but not sure whether it introduces breaking changes.
There was a problem hiding this comment.
I tried to quickly upgrade to version 5 but got tons of errors. Anyway, I think I will wait a couple of months before upgrading.
Using ESM imports along with Esbuild or Tsup fails on runtime due to default importing the
get-portandioredismodules. This pull request changes thetsconfigfile and the failing imports across the BullMQ package in order to play nicely with these bundlers.Reference: trying to bundle BullMQ failed Esbuild error
