Merge pull request #5 from gagoar/gg/addingHTTPTimeout

Adding HTTP_TIMEOUT and MAX_RETRIES options

Author: gagoar

__tests__/index.spec.ts

@@ -1,4 +1,5 @@
-import { main, Props, Credentials } from '../src';
+import AWS from 'aws-sdk/global';
+import { main, Props, Credentials, ExtraOptions } from '../src';
 import { setFailed, getInput, setOutput } from '../__mocks__/@actions/core';
 import Lambda, { constructorMock } from '../__mocks__/aws-sdk/clients/lambda';
 
@@ -8,12 +9,12 @@ describe('invoke-aws-lambda', () => {
     [Props.LogType]: 'None',
     [Props.Payload]: '{"input": {value: "1"}',
     [Props.Qualifier]: 'production',
+    [ExtraOptions.HTTP_TIMEOUT]: '220000',
+    [ExtraOptions.MAX_RETRIES]: '3',
     [Credentials.AWS_ACCESS_KEY_ID]: 'someAccessKey',
     [Credentials.AWS_SECRET_ACCESS_KEY]: 'someSecretKey',
     REGION: 'us-west-2',
   };
-
-
   getInput.mockImplementation(
     (key: Partial<Props & Credentials & 'REGION'>) => {
       return mockedInput[key];
@@ -27,14 +28,18 @@ describe('invoke-aws-lambda', () => {
   });
 
   it('runs when provided the correct input', async () => {
-
     const handler = jest.fn(() => ({ response: 'ok' }));
 
     Lambda.__setResponseForMethods({ invoke: handler });
 
     await main();
-    expect(getInput).toHaveBeenCalledTimes(10);
+    expect(getInput).toHaveBeenCalledTimes(12);
     expect(setFailed).not.toHaveBeenCalled();
+    expect(AWS.config.httpOptions).toMatchInlineSnapshot(`
+      Object {
+        "timeout": 220000,
+      }
+    `);
     expect(constructorMock.mock.calls).toMatchInlineSnapshot(`
       Array [
         Array [
@@ -45,8 +50,7 @@ describe('invoke-aws-lambda', () => {
         ],
       ]
     `);
-    expect(handler.mock.calls).toMatchInlineSnapshot(
-      `
+    expect(handler.mock.calls).toMatchInlineSnapshot(`
       Array [
         Array [
           Object {
@@ -57,8 +61,7 @@ describe('invoke-aws-lambda', () => {
           },
         ],
       ]
-    `
-    );
+    `);
     expect(setOutput.mock.calls).toMatchInlineSnapshot(`
       Array [
         Array [
@@ -72,14 +75,21 @@ describe('invoke-aws-lambda', () => {
   });
 
   it('fails when lambda throws an error', async () => {
-    const handler = jest.fn(() => { throw new Error('something went horribly wrong') });
+    const handler = jest.fn(() => {
+      throw new Error('something went horribly wrong');
+    });
+
     Lambda.__setResponseForMethods({ invoke: handler });
 
     await main();
-    expect(getInput).toHaveBeenCalledTimes(10);
+
+    expect(getInput).toHaveBeenCalledTimes(12);
+    expect(AWS.config.httpOptions).toMatchInlineSnapshot(`
+      Object {
+        "timeout": 220000,
+      }
+    `);
     expect(setFailed).toHaveBeenCalled();
     expect(setOutput).not.toHaveBeenCalled();
   });
-
 });
-

action.yml

@@ -37,6 +37,12 @@ inputs:
   Qualifier:
     description: "Specify a version or alias to invoke a published version of the function."
     required: false
+  HTTP_TIMEOUT:
+    description: Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000)
+    required: false
+  MAX_RETRIES:
+    description: Returns the maximum amount of retries to perform for a service request. By default this value is calculated by the specific service object that the request is being made to.
+    required: false
 outputs:
   response: # id of output
     description: "response from lambda invocation"

dist/index.js

@@ -9140,13 +9140,17 @@ var core = __webpack_require__(470);
 
 
 const apiVersion = '2015-03-31';
+var ExtraOptions;
+(function (ExtraOptions) {
+    ExtraOptions["HTTP_TIMEOUT"] = "HTTP_TIMEOUT";
+    ExtraOptions["MAX_RETRIES"] = "MAX_RETRIES";
+})(ExtraOptions || (ExtraOptions = {}));
 var Credentials;
 (function (Credentials) {
     Credentials["AWS_ACCESS_KEY_ID"] = "AWS_ACCESS_KEY_ID";
     Credentials["AWS_SECRET_ACCESS_KEY"] = "AWS_SECRET_ACCESS_KEY";
     Credentials["AWS_SESSION_TOKEN"] = "AWS_SESSION_TOKEN";
 })(Credentials || (Credentials = {}));
-;
 var Props;
 (function (Props) {
     Props["FunctionName"] = "FunctionName";
@@ -9156,12 +9160,11 @@ var Props;
     Props["Payload"] = "Payload";
     Props["Qualifier"] = "Qualifier";
 })(Props || (Props = {}));
-;
 const setAWSCredentials = () => {
     global_default.a.config.credentials = {
         accessKeyId: Object(core.getInput)(Credentials.AWS_ACCESS_KEY_ID),
         secretAccessKey: Object(core.getInput)(Credentials.AWS_SECRET_ACCESS_KEY),
-        sessionToken: Object(core.getInput)(Credentials.AWS_SESSION_TOKEN)
+        sessionToken: Object(core.getInput)(Credentials.AWS_SESSION_TOKEN),
     };
 };
 const getParams = () => {
@@ -9170,9 +9173,20 @@ const getParams = () => {
         return value ? Object.assign(Object.assign({}, memo), { [prop]: value }) : memo;
     }, {});
 };
+const setAWSConfigOptions = () => {
+    const httpTimeout = Object(core.getInput)(ExtraOptions.HTTP_TIMEOUT);
+    if (httpTimeout) {
+        global_default.a.config.httpOptions = { timeout: parseInt(httpTimeout, 10) };
+    }
+    const maxRetries = Object(core.getInput)(ExtraOptions.MAX_RETRIES);
+    if (maxRetries) {
+        global_default.a.config.maxRetries = parseInt(maxRetries, 10);
+    }
+};
 const main = async () => {
     try {
         setAWSCredentials();
+        setAWSConfigOptions();
         const params = getParams();
         const lambda = new lambda_default.a({ apiVersion, region: Object(core.getInput)('REGION') });
         const response = await lambda.invoke(params).promise();

dist/src/index.d.ts

@@ -1,3 +1,7 @@
+export declare enum ExtraOptions {
+    HTTP_TIMEOUT = "HTTP_TIMEOUT",
+    MAX_RETRIES = "MAX_RETRIES"
+}
 export declare enum Credentials {
     AWS_ACCESS_KEY_ID = "AWS_ACCESS_KEY_ID",
     AWS_SECRET_ACCESS_KEY = "AWS_SECRET_ACCESS_KEY",

package-lock.json

@@ -2,7 +2,7 @@
   "name": "invoke-aws-lambda",
   "repository": "[email protected]:gagoar/invoke-aws-lambda.git",
   "license": "MIT",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "Invoke AWS Lambda",
   "main": "index.ts",
   "husky": {
@@ -30,10 +30,12 @@
     ],
     "*.ts": [
       "eslint --fix",
-      "bash -c \"npm run build\""
+      "bash -c \"npm run build\"",
+      "git add ."
     ]
   },
   "eslintConfig": {
+    "ignorePatterns": "dist/",
     "extends": [
       "plugin:@typescript-eslint/recommended",
       "prettier",

package.json

@@ -19,15 +19,15 @@ This action allows you to synchronously invoke a Lambda function and get the res
 
 ## Table of contents
 
-  - [Input parameters](#input-parameters)
-    - [Credentials](#credentials)
-    - [Invocation](#invocation)
-  - [Output](#output)
-  - [Examples](#examples)
-    - [Basic example](#basic-example)
-    - [Using output](#using-output)
-    - [Specifying alias/version](#specifying-aliasversion)
-    - [Handling logs](#handling-logs)
+- [Input parameters](#input-parameters)
+  - [Credentials](#credentials)
+  - [Invocation](#invocation)
+- [Output](#output)
+- [Examples](#examples)
+  - [Basic example](#basic-example)
+  - [Using output](#using-output)
+  - [Specifying alias/version](#specifying-aliasversion)
+  - [Handling logs](#handling-logs)
 
 <hr>
 
@@ -47,14 +47,16 @@ This action allows you to synchronously invoke a Lambda function and get the res
 
 ### Invocation
 
-| Key              |                     Type                     | Required | Description                                                                                                                                                      |
-| ---------------- | :------------------------------------------: | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `FunctionName`   |                   `string`                   |   Yes    | Name of the Lambda function to be invoked.                                                                                                                       |
-| `InvocationType` | `RequestResponse\|`<br>`Event\|`<br>`DryRun` |    No    | Default `RequestResponse`. See the [AWS Javascript SDK docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Lambda.html#invoke-property) for more info. |
-| `LogType`        |                 `Tail\|None`                 |    No    | Default `None`. Set to `Tail` to include the execution log in the response.                                                                                      |
-| `Payload`        |                   `string`                   |    No    | JSON that you want to provide to your Lambda function as input.                                                                                                  |
-| `Qualifier`      |                   `string`                   |    No    | Version or alias of the function to be invoked.                                                                                                                  |
-| `ClientContext`  |                   `string`                   |    No    | Base64-encoded data about the invoking client to pass to the function.                                                                                           |
+| Key              |                     Type                     | Required | Description                                                                                                                                                                                                                                                                                      |
+| ---------------- | :------------------------------------------: | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `FunctionName`   |                   `string`                   |   Yes    | Name of the Lambda function to be invoked.                                                                                                                                                                                                                                                       |
+| `InvocationType` | `RequestResponse\|`<br>`Event\|`<br>`DryRun` |    No    | Default `RequestResponse`. See the [AWS Javascript SDK docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Lambda.html#invoke-property) for more info.                                                                                                                                 |
+| `LogType`        |                 `Tail\|None`                 |    No    | Default `None`. Set to `Tail` to include the execution log in the response.                                                                                                                                                                                                                      |
+| `Payload`        |                   `string`                   |    No    | JSON that you want to provide to your Lambda function as input.                                                                                                                                                                                                                                  |
+| `Qualifier`      |                   `string`                   |    No    | Version or alias of the function to be invoked.                                                                                                                                                                                                                                                  |
+| `ClientContext`  |                   `string`                   |    No    | Base64-encoded data about the invoking client to pass to the function.                                                                                                                                                                                                                           |
+| `HTTP_TIMEOUT`   |                   `number`                   |    No    | Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000). See the [AWS Javascript SDK docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Config.html)                                                                      |
+| `MAX_RETRIES`    |                   `number`                   |    No    | Returns the maximum amount of retries to perform for a service request. By default this value is calculated by the specific service object that the request is being made to. [AWS Javascript SDK docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Config.html#maxRetries-property) |
 
 For more details on the parameters accepted by `Lambda.invoke()`, see the [AWS Javascript SDK](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Lambda.html#invoke-property) docs
 
@@ -153,4 +155,4 @@ These steps process logs returned from the invocation:
     Payload: '{ "myParameter": false }'
 - name: Store tail logs to file
   run: echo "${{ fromJSON(steps.foobar.outputs.response).LogResult }}" > invocation-logs.json
-```
+```

readme.md

@@ -4,26 +4,31 @@ import { getInput, setOutput, setFailed } from '@actions/core';
 
 const apiVersion = '2015-03-31';
 
+export enum ExtraOptions {
+  HTTP_TIMEOUT = 'HTTP_TIMEOUT',
+  MAX_RETRIES = 'MAX_RETRIES',
+}
+
 export enum Credentials {
   AWS_ACCESS_KEY_ID = 'AWS_ACCESS_KEY_ID',
   AWS_SECRET_ACCESS_KEY = 'AWS_SECRET_ACCESS_KEY',
-  AWS_SESSION_TOKEN = 'AWS_SESSION_TOKEN'
-};
+  AWS_SESSION_TOKEN = 'AWS_SESSION_TOKEN',
+}
 
 export enum Props {
   FunctionName = 'FunctionName',
   InvocationType = 'InvocationType',
   LogType = 'LogType',
   ClientContext = 'ClientContext',
   Payload = 'Payload',
-  Qualifier = 'Qualifier'
-};
+  Qualifier = 'Qualifier',
+}
 
 const setAWSCredentials = () => {
   AWS.config.credentials = {
     accessKeyId: getInput(Credentials.AWS_ACCESS_KEY_ID),
     secretAccessKey: getInput(Credentials.AWS_SECRET_ACCESS_KEY),
-    sessionToken: getInput(Credentials.AWS_SESSION_TOKEN)
+    sessionToken: getInput(Credentials.AWS_SESSION_TOKEN),
   };
 };
 
@@ -34,20 +39,33 @@ const getParams = () => {
   }, {} as Lambda.InvocationRequest);
 };
 
+const setAWSConfigOptions = () => {
+  const httpTimeout = getInput(ExtraOptions.HTTP_TIMEOUT);
+
+  if (httpTimeout) {
+    AWS.config.httpOptions = { timeout: parseInt(httpTimeout, 10) };
+  }
+
+  const maxRetries = getInput(ExtraOptions.MAX_RETRIES);
+
+  if (maxRetries) {
+    AWS.config.maxRetries = parseInt(maxRetries, 10);
+  }
+};
 export const main = async () => {
   try {
-
     setAWSCredentials();
 
+    setAWSConfigOptions();
+
     const params = getParams();
 
     const lambda = new Lambda({ apiVersion, region: getInput('REGION') });
 
     const response = await lambda.invoke(params).promise();
 
     setOutput('response', response);
-
   } catch (error) {
     setFailed(error.message);
   }
-};
+};

src/index.ts

@@ -5,6 +5,7 @@
     "index.ts",
     "__mocks__/**/*.ts",
     "__tests__/**/*.ts",
-    "jest.config.js"
+    "jest.config.js",
+    "!dist/"
   ]
 }