ESM support stopped working in Cloud Functions (GCF) #407

koistya · 2021-12-11T15:05:49Z

ESM support stopped working today in Google Cloud Functions (GCF) environment with Node.js 16 runtime. Trying to deploy an ESM codebase fails with the error:

To load an ES module, set "type": "module" in the package.

`package.json`

{
  "name": "esm",
  "type": "module",
  "exports": "./index.js",
  "packageManager": "[email protected]"
}

`index.js`

export function esm(req, res) {
  res.send("PASS");
}

$ cloud functions deploy esm \
    --project=example --region=us-central1 --allow-unauthenticated --trigger-http \
    --entry-point=esm --memory=256MB --runtime=nodejs16 --source=. \
    --set-env-vars="NODE_OPTIONS=--loader=./.pnp.loader.mjs --require=./.pnp.cjs --no-warnings"

Workaround (if you want to preserve ESM in your project)

Bundle the code. E.g. by using Rollup and Babel wtih @babel-preset/env, target: { node: "14" } preset
Deploy to Node.js v14 GCF runtime. See example: GraphQL API and Relay Starter Kit → api/rollup.config.js

Ref #233, #292, nodejs/node#41189, nodejs/node#41198

The text was updated successfully, but these errors were encountered:

rileytomasek · 2021-12-12T06:02:19Z

I'm also seeing this but noticed that switching back to Node 14 deploys successfully...

chiahung-keng · 2021-12-13T14:52:16Z

Same here.. ESM support is not working with Node.js 16 runtime.. Any update from Google?

matthewrobertson · 2021-12-15T17:46:56Z

Sorry to hear you are having trouble with this feature. I just tried this out for myself and I wasn't able to repro the issue. Could you please share more information about your project structure?

matthewrobertson · 2021-12-15T18:01:21Z

I see what is going on. The failure happens when building an ESM function with our GCP Buildpacks. We run node check on the entrypoint file here. It seems like that is failing in nodejs16 regardless of type setting in the package.json or the esm file extension:

node --check foo.mjs
(node:2290922) Warning: To load an ES module, set "type": "module" in the package.json or use the .mjs extension.
(Use `node --trace-warnings ...` to show where the warning was created)
/usr/local/google/home/mattrobertson/gcf/functions-framework-nodejs/test/data/esm_mjs/foo.mjs:12
export {testFunction};
^^^^^^

SyntaxError: Unexpected token 'export'
    at Object.compileFunction (node:vm:352:18)
    at wrapSafe (node:internal/modules/cjs/loader:1031:15)
    at checkSyntax (node:internal/main/check_syntax:66:3)
    at node:internal/main/check_syntax:39:3

matthewrobertson · 2021-12-15T18:16:15Z

This appears to be a regression in v16 of the Node.js engine. I have filed nodejs/node#41189. Unfortunately, the work around is to use nodejs14 on GCF for now.

chiahung-keng · 2021-12-16T02:23:37Z

Thanks for the update Matthew.

jthoward64 · 2021-12-17T19:31:14Z

Well there went a few hours of tinkering with my package.json; so the fix is basically just wait for a node update? Or is is this something GCP is working on? In the meantime node 14 it is!

taeold · 2021-12-17T23:23:18Z

@matthewrobertson Is it possible to revert the version of node v16 used in the GCF runtime?

jthoward64 · 2021-12-19T19:17:08Z

@matthewrobertson Is it possible to revert the version of node v16 used in the GCF runtime?

That seems like best stopgap given that the update was so recent

webervin · 2021-12-22T07:46:43Z

Actually even better solution would be to allow buildpacks take in and preserve NODE_OPTIONS from environment, that way ones who need it can pass NODE_OPTIONS=--experimental-modules which helps currently used node --check to understand and allow modules. This is both feature request (to allow custom NODE_OPTIONS build) and solution to this issue which is not blocked by nodejs release, testing etc times.

jthoward64 · 2021-12-23T04:21:08Z

Actually even better solution would be to allow buildpacks take in and preserve NODE_OPTIONS from environment, that way ones who need it can pass NODE_OPTIONS=--experimental-modules which helps currently used node --check to understand and allow modules. This is both feature request (to allow custom NODE_OPTIONS build) and solution to this issue which is not blocked by nodejs release, testing etc times.

@webervin Maybe open a new issue referencing this comment and this issue? (the ... button on the top right of your comment)

matthewrobertson · 2021-12-23T05:24:12Z

I think the easiest fix here is to just skip the node --check in the functions framework buildpack when the app is using ESM. I am happy to make that change; however, we are not scheduled to push a new release of the buildpacks until the new year.

matthewrobertson · 2021-12-23T05:41:24Z

@webervin it is already possible to set build time environment variables when deploying functions, but I am not sure setting NODE_OPTIONS=--experimental-modules will help here.

jthoward64 · 2021-12-26T20:24:00Z

A fix was pushed in node about 9 days ago, it's just a waiting game for node to release the change. nodejs/node#41189 , nodejs/node#41198 , and nodejs/node@3f7dabd

GoogleCloudPlatform/functions-framework-nodejs#407

50an6xy06r6n · 2022-01-16T19:55:52Z

@matthewrobertson is there an ETA on when this will be fixed?

matthewrobertson · 2022-01-20T19:59:08Z

I was really hoping that Node.js would have released a fix for this by now, but I just tested with v16.13.2 (npm v8.1.2) and it is still an issue. I will add a temporary workaround in the buildpacks.

matthewrobertson · 2022-01-20T20:01:54Z

side note: it does seem to be fixed in nodejs v17.4.0 (npm v8.3.1). So perhaps the fix needs to be manually back ported to 16. Would be awesome if someone could ask them to do that.

taeold · 2022-01-21T00:30:59Z

The needed commit is already scheduled for backporting as indicated by the lts-watch label in nodejs/node#41198.

We'll have to wait until the 16 LTS backporter is ready to backport and cut a new release...

jthoward64 · 2022-01-21T00:35:05Z

I'd say go for a temporary workaround until whenever Node gets around to a new release of 16 (anyone know when that might be?)

algoad · 2022-01-21T05:17:50Z

Is there any plans on resolving this soon? I'm using another package that requires Node 16 so going back to node 14 engine is not an option for me.

grant · 2022-01-21T21:13:05Z

Is there any plans on resolving this soon? I'm using another package that requires Node 16 so going back to node 14 engine is not an option for me.

Understood. Matt is actively working on a solution that is visible internally #407 (comment). There's no update since yesterday.

This is a temporary workaround for a regression in Node.js 16 that causes `node --check` to return false positives when a project is using ESM. More information here: GoogleCloudPlatform/functions-framework-nodejs#407 PiperOrigin-RevId: 423439009 Change-Id: I26ad943e8fb55e868ece996bd5d2f7470afbec5a

50an6xy06r6n · 2022-01-25T10:55:25Z

When can we expect these changes to be deployed to prod?

matthewrobertson · 2022-01-25T18:22:32Z

The work around is rolling out now. It should be in all GCP regions by the end of the week.

DibyodyutiMondal · 2022-01-29T03:36:00Z

Just to be clear: this will not be needing a rollback to node 14, right?

alexanderniebuhr · 2022-01-31T08:29:40Z

@matthewrobertson has the fix landed in all GCP regions yet? I am still seeing this issue in the europe-west1 region

christianp86 · 2022-01-31T11:12:54Z

@matthewrobertson has the fix landed in all GCP regions yet? I am still seeing this issue in the europe-west1 region

Yeah same in europe-west3

matthewrobertson · 2022-02-01T05:17:19Z

The rollout completed a few hours ago. I just confirmed that I can deploy an ESM function in europe-west1 with the nodejs16 runtime. Please re-open the bug if you are still having issues.

koistya · 2022-02-02T10:28:37Z

Might be not related to this particular update, but coincidently Yarn-based cloud functions stopped working:

ERROR: (gcloud.alpha.functions.deploy) OperationError:
  code=3, message=Build failed with status:
    FAILURE and message: Unknown Syntax Error: Invalid option name ("--production=false").

https://github.com/yarnpkg/berry/blob/43ccde3f8bfb5fd825d272dc2e305f8e4f4171dc/packages/plugin-essentials/sources/commands/install.ts#L102

Ref GoogleCloudPlatform/buildpacks#174

matthewrobertson added the bug Something isn't working label Dec 15, 2021

koistya changed the title ~~ESM support stopped working~~ ESM support stopped working in Cloud Functions (GCF) Dec 16, 2021

codyaweber mentioned this issue Dec 17, 2021

Support ES Modules for Node 14 functions firebase/firebase-tools#2994

Closed

abraham added a commit to gdg-x/hoverboard that referenced this issue Jan 3, 2022

Revert to node 14

1fcf209

GoogleCloudPlatform/functions-framework-nodejs#407

abraham mentioned this issue Jan 3, 2022

Revert to node 14 gdg-x/hoverboard#2127

Merged

abraham added a commit to gdg-x/hoverboard that referenced this issue Jan 3, 2022

Revert to node 14

c948e44

GoogleCloudPlatform/functions-framework-nodejs#407

taeold mentioned this issue Jan 21, 2022

Functions using ES modules wont deploy firebase/firebase-tools#4019

Closed

matthewrobertson closed this as completed Feb 1, 2022

Up-dawg mentioned this issue Mar 23, 2022

Deploy Issue: "Missing URI for HTTPS function in printTriggerUrls. This shouldn't happen" firebase/firebase-functions#1062

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ESM support stopped working in Cloud Functions (GCF) #407

ESM support stopped working in Cloud Functions (GCF) #407

koistya commented Dec 11, 2021 •

edited

Loading

rileytomasek commented Dec 12, 2021

chiahung-keng commented Dec 13, 2021

matthewrobertson commented Dec 15, 2021

matthewrobertson commented Dec 15, 2021 •

edited

Loading

matthewrobertson commented Dec 15, 2021

chiahung-keng commented Dec 16, 2021

jthoward64 commented Dec 17, 2021

taeold commented Dec 17, 2021

jthoward64 commented Dec 19, 2021 •

edited

Loading

webervin commented Dec 22, 2021

jthoward64 commented Dec 23, 2021

matthewrobertson commented Dec 23, 2021

matthewrobertson commented Dec 23, 2021

jthoward64 commented Dec 26, 2021 •

edited

Loading

50an6xy06r6n commented Jan 16, 2022

matthewrobertson commented Jan 20, 2022

matthewrobertson commented Jan 20, 2022

taeold commented Jan 21, 2022

jthoward64 commented Jan 21, 2022

algoad commented Jan 21, 2022

grant commented Jan 21, 2022

50an6xy06r6n commented Jan 25, 2022

matthewrobertson commented Jan 25, 2022

DibyodyutiMondal commented Jan 29, 2022

alexanderniebuhr commented Jan 31, 2022

christianp86 commented Jan 31, 2022 •

edited

Loading

matthewrobertson commented Feb 1, 2022

koistya commented Feb 2, 2022 •

edited

Loading

ESM support stopped working in Cloud Functions (GCF) #407

ESM support stopped working in Cloud Functions (GCF) #407

Comments

koistya commented Dec 11, 2021 • edited Loading

package.json

index.js

Workaround (if you want to preserve ESM in your project)

rileytomasek commented Dec 12, 2021

chiahung-keng commented Dec 13, 2021

matthewrobertson commented Dec 15, 2021

matthewrobertson commented Dec 15, 2021 • edited Loading

matthewrobertson commented Dec 15, 2021

chiahung-keng commented Dec 16, 2021

jthoward64 commented Dec 17, 2021

taeold commented Dec 17, 2021

jthoward64 commented Dec 19, 2021 • edited Loading

webervin commented Dec 22, 2021

jthoward64 commented Dec 23, 2021

matthewrobertson commented Dec 23, 2021

matthewrobertson commented Dec 23, 2021

jthoward64 commented Dec 26, 2021 • edited Loading

50an6xy06r6n commented Jan 16, 2022

matthewrobertson commented Jan 20, 2022

matthewrobertson commented Jan 20, 2022

taeold commented Jan 21, 2022

jthoward64 commented Jan 21, 2022

algoad commented Jan 21, 2022

grant commented Jan 21, 2022

50an6xy06r6n commented Jan 25, 2022

matthewrobertson commented Jan 25, 2022

DibyodyutiMondal commented Jan 29, 2022

alexanderniebuhr commented Jan 31, 2022

christianp86 commented Jan 31, 2022 • edited Loading

matthewrobertson commented Feb 1, 2022

koistya commented Feb 2, 2022 • edited Loading

koistya commented Dec 11, 2021 •

edited

Loading

`package.json`

`index.js`

matthewrobertson commented Dec 15, 2021 •

edited

Loading

jthoward64 commented Dec 19, 2021 •

edited

Loading

jthoward64 commented Dec 26, 2021 •

edited

Loading

christianp86 commented Jan 31, 2022 •

edited

Loading

koistya commented Feb 2, 2022 •

edited

Loading