`gcp-build` not executed in node.js 10

[ricbir]

Hi
I have been trying to use the gcp-build feature documented here, but it only seems to work in node.js 8.
When I use node.js 10 the step is skipped entirely.

Any help you can provide would be very much appreciated

[hdp617]

Thanks for reporting this issue. Could you provide reproducible steps?

[ricbir]

Sure.

Create a directory with the following files:

package.json

{
    "scripts": {
        "gcp-build": "tsc index.ts"
    },
    "dependencies": {
        "@google-cloud/functions-framework": "1.3.2"
    },
    "devDependencies": {
        "typescript": "^3.7.2"
    }
}

index.ts

export const helloWorld = (req, res) => {
    let message = req.query.message || req.body.message || 'Hello World!';
    res.status(200).send(message);
  };

If you run

gcloud functions deploy --runtime=nodejs8 --region=europe-west2 --trigger-http --entry-point=helloWorld test-function

The function deploys succesfully, as gcp-build is run and index.ts is compiled to index.js

If you run

gcloud functions deploy --runtime=nodejs10 --region=europe-west2 --trigger-http --entry-point=helloWorld test-function

The deployment times out, and in the logs it reads:

Provided code is not a loadable module.

[hdp617]

Thanks for the reproducible steps. This is a bug with GCF. I'll make sure this is fixed before GA.

[hdp617]

Closed since this is not a Functions Framework bug. I'll give an update when the fix is in GCF.

[chrisfischer]

Any update on this?

[hdp617]

This issue should be fixed now.

[killthekitten]

@hdp617 I'm getting the same issue locally by copying @ricbir's code and running:

yarn install
node --inspect node_modules/@google-cloud/functions-framework --target=helloWorld

The output:

Debugger listening on ws://127.0.0.1:9229/a3c4b9fa-3fd3-4d89-93d0-2ae3d00492e5
For help, see: https://nodejs.org/en/docs/inspector
Provided code is not a loadable module.
Could not load the function, shutting down.

[hdp617]

yarn install doesn't run the gcp-build script so you'd have to do

yarn install
yarn run gcp-build
node --inspect node_modules/@google-cloud/functions-framework --target=helloWorld

If you want yarn install to run gcp-build script, you can add a prepare script [0]. For example, in package.json,

"scripts": {
    "prepare": "yarn run gcp-build",
    "gcp-build": "tsc -p ."
 }

[0] https://classic.yarnpkg.com/en/docs/package-json/#toc-scripts

[killthekitten]

@hdp617 thanks for clarification. I was under impression that the framework is aware of gcp-build script and should somehow pick it up. I can see now there are no mentions of it in the codebase.

Turns out it's a part of the gcp node docker image

[hdp617]

The framework just loads a function and sets up a web server to invoke the function. If you're interested, the gcp-build script is handled here.

[killthekitten]

@hdp617 that's it, thanks!