Add support ES modules for Firebase Functions #3485
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joehan
reviewed
Jun 14, 2021
joehan
reviewed
Jun 14, 2021
joehan
reviewed
Jun 14, 2021
|
LGTM to me too. This will go into the firebase runtime code before it hits production, but the discovery is still quite useful. |
taeold
changed the title
taeold
commented
Jun 27, 2021
| @@ -567,6 +576,7 @@ async function initializeFirebaseAdminStubs(frb: FunctionsRuntimeBundle): Promis | |||
| // Stub the admin module in the require cache | |||
| require.cache[adminResolution.resolution] = { | |||
| exports: proxiedAdminModule, | |||
| path: path.dirname(adminResolution.resolution), | |||
There was a problem hiding this comment.
This needed to be done - otherwise, the dynamic import called failed with errors like this:
TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received undefined
at new NodeError (node:internal/errors:363:5)
at validateString (node:internal/validators:119:11)
at Object.resolve (node:path:1098:7)
at Function.Module._nodeModulePaths (node:internal/modules/cjs/loader:625:17)
at cjsPreparseModuleExports (node:internal/modules/esm/translators:258:30)
at Loader.commonjsStrategy (node:internal/modules/esm/translators:188:35)
@samtstern Think this is safe modification, but I'm 100% unfamiliar with this code path. Let me know if this isn't going to work (I tested things out, and emulator continues to work normally).
taeold
changed the title
samtstern
approved these changes
Jun 28, 2021
devpeerapong
pushed a commit
to devpeerapong/firebase-tools
that referenced
this pull request
Dec 14, 2021
\To import modules packaged as ES module, we have to use import instead of require. Both the emulator and function deploy code hardcodes require to load user's function code and ends up throwing ERR_REQUIRE_ESM when given ES modules. We will now try using import when require fails with an ERR_REQUIRE_ESM error. This is a bit lazy - we could've detected whether given module is ES module vs CommonJS and dispatch require vs import appropriately - but I think it simplifies the script while still being correct.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To import modules packaged as ES module, we have to use
importinstead ofrequire. Both the emulator and function deploy code hardcodesrequireto load user's function code and ends up throwingERR_REQUIRE_ESMwhen given ES modules.We will now try using
importwhenrequirefails with anERR_REQUIRE_ESMerror. This is a bit lazy - we could've detected whether given module is ES module vs CommonJS and dispatchrequirevsimportappropriately - but I think it simplifies the script while still being correct.Note that this PR doesn't itself provide ES module support for Firebase Functions (#2994); we need Google Cloud Function to provide ES module support first (GoogleCloudPlatform/functions-framework-nodejs#233).Functions Framework now supports ES modules in 1.9.0! GoogleCloudPlatform/functions-framework-nodejs#301
NOTE ES Module support is available only for Node.js v13 and beyond. This leads to tricky situations where node version on dev's machine might support ES modules while the selected GCF runtime doesn't, and vice versa. Maybe a follow up item for early detection to reduce number of support tickets we might get because of this confusion?
Will fix once released: #2994