Setting memory to more than 1 GiB still only allow 1 GiB to be used

[ibobo]

Related issues

None.

[REQUIRED] Version info

node: v12.22.1

firebase-functions: 3.15.4

firebase-tools: 9.16.5

firebase-admin: 9.11.1

[REQUIRED] Test case

export const test = functions
  .runWith({
    memory: '8GB',
  })
  .https.onRequest(async (req, res) => {
    console.log(process.env);
  });

[REQUIRED] Steps to reproduce

Just try to deploy the above mentioned function

[REQUIRED] Expected behavior

The function gets deployed with the indicated memory and it can fully use the 8 GiB memory.

[REQUIRED] Actual behavior

The function gets deployed with the indicated memory, but, it won't be able to use it all, since the runtime is configured to only use 1 or 2 GiB.

As stated in the Google Cloud documentation here, you need to specify the NODE_OPTIONS environment variable to have a max_old_space_size value (8192 for 8 GiB), but this is not possible with current firebase-functions deployment process.

I suggest that when a function is required to have more than 1 GiB memory size the given NODE_OPTIONS environment variable is set automatically. At this stage, to have it set, I need to go to Google Cloud Console, edit the function and manually add the environment variable (or at least check it was retained) after every deploy.

Were you able to successfully deploy your functions?

Yes.

[google-oss-bot]

I found a few problems with this issue:

• I couldn't figure out how to label this issue, so I've labeled it for a human to triage. Hang tight.
• This issue does not seem to follow the issue template. Make sure you provide all the required information.

[colerogers]

Thanks for reporting this issue, we're going to look into it.

[taeold]

@ibobo This is a great feature request. I'm moving this issue to firebase-tools where i think the implementation will need to happen.

[ikusuki]

So right now we can add the NODE_OPTIONS runtime env var with --max_old_space_size=2048 (for 2GB for example) but it will be reset on every deploy, right?

any news on this?

[taeold]

@ikusuki Good news - Google Cloud Functions team recently made a patch to the Node.js runtime that will automatically set the appropriate --max_old_space_size based on the memory you selected to deploy the function. e.g.

const functions = require("firebase-functions");
const v8 = require('v8');

exports.heap = functions.runWith({ memory: "8GB" }).https.onRequest((request, response) => {
  functions.logger.log("memory", v8.getHeapStatistics());
  response.send(v8.getHeapStatistics());
});

returns for me

{
 "total_heap_size":27226112,
 "total_heap_size_executable":573440,
 "total_physical_size":17225552,
 "total_available_size":8539261544, /* LOOK - 8GB */
 "used_heap_size":8431848, 
 "heap_size_limit":8547991552,
 "malloced_memory":8192,
 "peak_malloced_memory":1255904,
  "does_zap_garbage":0,
  "number_of_native_contexts":1,
  "number_of_detached_contexts":0
}

Please give your functions another deploy and let us know if you are not seeing this on your side.