Fix image integration crash on Netlify Functions due to import.meta.url
#5888
Conversation
🦋 Changeset detectedLatest commit: 9e6be6d The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
the
pkg: integration
| */ | ||
| export function getModuleURL(url: string | undefined): string { | ||
| if (!url) { | ||
| return pathToFileURL(__dirname).toString(); |
There was a problem hiding this comment.
The __dirname refers relative to this utils file. Would it work correctly if it's used by the consumer file later on?
I see some doing
scriptDirectory = dirname(getModuleURL(import.meta.url)) + '/'which might have a different value depending on whether import.meta.url is supported.
There was a problem hiding this comment.
It's admittedly not ideal, but it does work because the __dirname call is only used in SSR where everything gets bundled 😅
If you have a better solution, I'll definitely take! Got lost in between the __dirname, __filename and import.meta.url while working on this so really I settled on the solution that actually did work, but I'm not picky 😵💫
There was a problem hiding this comment.
Ah I see. Didn't know this was bundled so it would always have the same value.
This trick sounds good to me then, though I wonder if it should be __filename instead since that reflects import.meta.url. If you've tested with __dirname and it works then I'll be fine by it too 👍
Changes
Netlify Functions are still on CJS, however they support ESM files by running them through
esbuild, this is great, butesbuilddoesn't polyfillimport.meta.urlso our function just immediately crash.This PR add a helper that either return
import.meta.urlif supported, or an URL using__dirnameso it works both directly in ESM and hazardly transpiled CJSFix #5774
Note
There's apparently a way to get Netlify functions to run in pure ESM mode already, using a per-function config file (an undocumented feature) and a (also undocumented) flag, but I could never get it to work despite multiple attempts 🤷♀️
Netlify is shipping pure ESM functions natively with no hidden flag soon, so this is really just a temporary workaround that we'll be able to remove in the future (or keep if it affects other hosts, who knows)
Testing
Tested manually, this issue only shows up when running directly on Netlify
Docs
N/A