feat: Add optional memory input (#27)

* feat: Add optional memory input

* fmt

Author: bharathkkb

.github/workflows/deploy-cf-it.yml

@@ -96,6 +96,7 @@ jobs:
         region: us-east1
         runtime: nodejs10
         entry_point: helloWorld
+        memory_mb: 512
         source_dir: ./tests/test-node-func/
         credentials: ${{ secrets.DEPLOY_CF_SA_KEY_JSON }}
     - uses: actions/setup-node@master

README.md

@@ -49,7 +49,9 @@ steps:
 
 - `runtime`: (Required) Runtime to use for the function. Possible options documented [here][runtimes].
 
-- `entry_point`: (Optional) Name of a function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. 
+- `entry_point`: (Optional) Name of a function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified.
+
+- `memory_mb`: (Optional) The amount of memory in MB available for a function. Defaults to 256MB. 
 
 - `region`: (Optional) [Region](https://cloud.google.com/functions/docs/locations) in which the function should be deployed. Defaults to `us-central1`.
 

action.yaml

@@ -66,6 +66,11 @@ inputs:
       Runtime to use for the function.
     required: true
 
+  memory_mb:
+    description: |-
+      The amount of memory in MB available for a function. Defaults to 256MB.
+    required: false
+
   vpc_connector:
     description: |-
       The VPC Access connector that the function can connect to.

src/cloudFunction.ts

@@ -29,6 +29,7 @@ export type EnvVar = {
  * @param envVars List of key-value pairs to set as environment variables.
  * @param entryPoint Name of function to execute.
  * @param runtime Runtime to use for the function.
+ * @param availableMemoryMb The amount of memory in MB available for a function.
  * @param vpcConnector The VPC Access connector that the function can connect to.
  * @param parent Parent of the form projects/${projectId}/locations/${region}.
  * @param serviceAccountEmail The email address of the IAM service account associated with the function at runtime.
@@ -46,6 +47,7 @@ export type CloudFunctionOptions = {
   envVars?: string;
   entryPoint?: string;
   runtime: string;
+  availableMemoryMb?: number;
   vpcConnector?: string;
   parent: string;
   serviceAccountEmail?: string;
@@ -102,6 +104,9 @@ export class CloudFunction {
     request.vpcConnector = opts?.vpcConnector ? opts.vpcConnector : null;
     request.timeout = opts?.timeout ? `${opts.timeout}s` : null;
     request.maxInstances = opts?.maxInstances ? opts.maxInstances : null;
+    request.availableMemoryMb = opts?.availableMemoryMb
+      ? opts.availableMemoryMb
+      : null;
 
     // Parse env vars
     let envVars;

src/main.ts

@@ -25,6 +25,7 @@ async function run(): Promise<void> {
     const runtime = core.getInput('runtime', { required: true });
     const credentials = core.getInput('credentials');
     const projectId = core.getInput('project_id');
+    const availableMemoryMb = core.getInput('memory_mb');
     const region = core.getInput('region') || 'us-central1';
     const envVars = core.getInput('env_vars');
     const entryPoint = core.getInput('entry_point');
@@ -46,6 +47,7 @@ async function run(): Promise<void> {
       parent: client.parent,
       sourceDir,
       runtime,
+      availableMemoryMb: +availableMemoryMb,
       entryPoint,
       envVars,
       timeout,

tests/cloudFunction.test.ts

@@ -39,6 +39,7 @@ describe('CloudFunction', function () {
       serviceAccountEmail: '[email protected]',
       timeout: '500',
       maxInstances: 10,
+      availableMemoryMb: 512,
     };
     const cf = new CloudFunction(funcOptions);
     expect(cf.request.name).equal(`${parent}/functions/${name}`);
@@ -52,6 +53,7 @@ describe('CloudFunction', function () {
     );
     expect(cf.request.timeout).equal(`${funcOptions.timeout}s`);
     expect(cf.request.maxInstances).equal(funcOptions.maxInstances);
+    expect(cf.request.availableMemoryMb).equal(funcOptions.availableMemoryMb);
     expect(cf.request.httpsTrigger).not.to.be.null;
     expect(cf.request.environmentVariables?.KEY1).equal('VALUE1');
   });

tests/cloudFunctionClient.test.ts

@@ -56,6 +56,7 @@ describe('CloudFunction', function () {
       runtime: 'nodejs10',
       envVars: 'KEY1=VALUE1,KEY2=VALUE2',
       entryPoint: 'helloWorld',
+      availableMemoryMb: 512,
     });
     const result = await client.deploy(newHttpFunc);
     // expect function to be deployed without error