Using Prisma with Rollup or Webpack in Node causes a runtime error

[f0rr0]

Bug description

I have traced this to node-fetch v 2.x which is a dependency of the fetch engine.

https://github.com/node-fetch/node-fetch/blob/b5e2e41b2b50bf2997720d6125accaf0dd68c0ab/src/body.js#L14

node-fetch/node-fetch#412

encoding seems to be a peer dependency for node-fetch. A bundler like webpack or rollup will include the require and crash at runtime since encoding is not installed.

Either prisma should upgrade the node-fetch dependency to v3 which does away with this or include a cautionary note in the README like node-fetch did : https://github.com/node-fetch/node-fetch/blob/2.x/README.md#bodytextconverted

Other repos depending on node-fetch 2.x also faced a similar issue netlify/create-react-app-lambda#24

[pantharshit00]

Can you share a simple reproduction? Then we can confirm this and maybe replace node-fetch with something else as it is not a very core dependency.

We have some e2e tests for bundlers which havent failed so maybe you can look them as an example: https://github.com/prisma/e2e-tests/tree/dev/bundlers

[f0rr0]

I’ll create a reproduction. The e2e tests are not failing because this test is basically ignoring everything under node_modules when bundling through webpack-node-externals plugin. I can’t do that for my use case. I need to provide a single archive of my app to lambda including all dependencies so I need to bundle them. Get Outlook for iOS<https://aka.ms/o0ukef>

…

________________________________ From: Harshit Pant <notifications@github.com> Sent: Wednesday, January 27, 2021 8:10:59 PM To: prisma/prisma <prisma@noreply.github.com> Cc: Sid <sid_26@outlook.com>; Author <author@noreply.github.com> Subject: Re: [prisma/prisma] Using Prisma with Rollup or Webpack in Node causes a runtime error (#5250) Can you share a simple reproduction? Then we can confirm this and maybe replace node-fetch with something else as it is not a very core dependency. We have some e2e tests for bundlers which havent failed so maybe you can look them as an example: https://github.com/prisma/e2e-tests/tree/dev/bundlers — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub<#5250 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ACBNKC57RQTRLNPTG7QH4CTS4AQXXANCNFSM4WPTU7IA>.

[f0rr0]

Here is the reproduction
prisma/ecosystem-tests#1314

[pantharshit00]

THanks for that. Marking this as confirmed. We can try eliminating this dep.

[matthewmueller]

You're try bundling node_modules all together in one output JS file, you get a runtime error trying to run that output JS file. PR for context.

Am I understanding this correctly?

If so, a couple questions:

• What's your use case? Perhaps something to do with Lambda?
• What is the runtime error that you're seeing @f0rr0?

[f0rr0]

Use case is generating a single asset that I can distribute to serverless environments. without the need to manage things like lambda layers. Also the generated asset is run through a minifier to reduce size and gain marginal improvement in startup perf.

The error is basically that a dependency of prisma has an implicit dependency on a module called encoding. This dependency is not installed when installing prisma. Neither is it mentioned in the prisma readme. Under normal circumstances the code path never reaches the require for that dependency but when bundled it does causing an error.

Ideally considering the reach and popularity of this project, it will be better to not have such implicit dependencies or make assumptions about the modules available at runtime. I suggest to either add a note in the docs or better yet replace this dependency with a more sensible choice.

[dvins]

Closely related to this is the ESM support. See #5030 and #4920.

[f0rr0]

Tbh I don't fully understand why/how the crash happens and it's been a while since I encountered it. I was able to resolve it by making modifications to the bundler config.

A guess is that perhaps the bundler hoists the require calls.

[f0rr0]

This is the config that worked for me: #2303 (comment)

[janpio]

Why isn't renovate suggesting an update to node-fetch@3 here anyway @Jolg42?

[Jolg42]

Because v3 in not on latest but on next.
https://www.npmjs.com/package/node-fetch

I re-configured Renovate, it should open a PR soon 3c00990

[janpio]

Ugh, so the README at https://github.com/node-fetch/node-fetch lies to us :/

[Jolg42]

Indeed... README is incorrect Current stable release (3.x) should be 2.x here
I found the v3 roadmap issue here node-fetch/node-fetch#668

Created an issue node-fetch/node-fetch#1184

[mbalc]

what can I do to circumvent this issue?

[millsp]

You can mark this dependency as external for now.

[matthewmueller]

It seems like the current workaround is to mark the dependency as external.

The longer-term fix is to upgrade to node-fetch 3.x, which is currently blocked by #7618.

[millsp]

Closing this as this is not an issue anymore
prisma/ecosystem-tests#2857