Ignored status codes (#26)

* Implement StatusCode ignore list

.github/workflows/test.yml

@@ -43,6 +43,13 @@ jobs:
           username: 'postman'
           password: 'password'
       
+      - name: Request Postment Echo with 404 Response and ignore failure code
+        uses: ./
+        with:
+          url: 'https://postman-echo.com/status/404'
+          method: 'GET'
+          ignoreStatusCodes: '404'
+      
       - name: Create Test File
         id: image
         run: |

README.md

@@ -1,9 +1,9 @@
 # HTTP Request Action
 
-Create any kind of HTTP Requests in your GitHub actions to trigger Tools like Ansible AWX
+**Create HTTP Requests from GitHub Actions.** This action allows GitHub events to engage with tools like Ansible AWX that use HTTP APIs.
 
-Example Usage:
-```
+### Example
+```yaml
 jobs:
   deployment:
     runs-on: ubuntu-latest
@@ -17,7 +17,7 @@ jobs:
         password: ${{ secrets.AWX_PASSWORD }}
 ```
 
-### Input Arguments
+### Request Configuration
 
 |Argument|  Description  |  Default  |
 |--------|---------------|-----------|
@@ -31,17 +31,33 @@ jobs:
 |password| Password for Basic Auth ||
 |bearerToken| Bearer Authentication Token (without Bearer Prefix) ||
 |customHeaders| Additional header values as JSON string, keys in this object overwrite default headers like Content-Type |'{}'|
-|preventFailureOnNoResponse| Prevent this Action to fail if the request respond without an response. Use 'true' (string) as value to enable it ||
 |escapeData| Escape newlines in data string content. Use 'true' (string) as value to enable it ||
+|preventFailureOnNoResponse| Prevent this Action to fail if the request respond without an response. Use 'true' (string) as value to enable it ||
+|ignoreStatusCodes| Prevent this Action to fail if the request respond with one of the configured Status Codes. Example: '404,401' ||
 
-### Output
+### Response
 
-- `response` Request Response as JSON String
+| Variable |  Description  |
+|---|---|
+`response` | Response as JSON String
 
+To display HTTP response data in the GitHub Actions log give the request an `id` and access its `outputs`
 
-### Debug Informations
+```yaml
+steps:
+  - name: Make Request
+    id: myRequest
+    uses: fjogeleit/http-request-action@master
+    with:
+      url: "http://yoursite.com/api"
+  - name: Show Response
+    run: echo ${{ steps.myRequest.outputs.response }}
+```
 
-Enable Debug mode to get informations about
+### Additional Information
 
+Additional information is available if debug logging is enabled:
 - Instance Configuration (Url / Timeout / Headers)
 - Request Data (Body / Auth / Method)
+
+To [enable debug logging in GitHub Actions](https://docs.github.com/en/actions/managing-workflow-runs/enabling-debug-logging) create a secret `ACTIONS_RUNNER_DEBUG` with a value of `true`

action.yml

@@ -38,6 +38,9 @@ inputs:
     preventFailureOnNoResponse:
         description: 'Prevent this Action to fail if the request respond without an response'
         required: false
+    ignoreStatusCodes:
+        description: 'Prevent this Action to fail if the request respond with one of the configured StatusCodes'
+        required: false
     escapeData:
         description: 'Escape newlines in data string content'
         required: false

package-lock.json

@@ -1,8 +1,120 @@
 {
   "name": "http-request-action",
-  "version": "1.7.0",
-  "lockfileVersion": 1,
+  "version": "1.8.0",
+  "lockfileVersion": 2,
   "requires": true,
+  "packages": {
+    "": {
+      "version": "1.8.0",
+      "license": "MIT",
+      "dependencies": {
+        "@zeit/ncc": "^0.22",
+        "axios": "^0.21.1",
+        "form-data": "^3.0.1"
+      },
+      "devDependencies": {
+        "@actions/core": "^1.2.6"
+      }
+    },
+    "node_modules/@actions/core": {
+      "version": "1.2.6",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.6.tgz",
+      "integrity": "sha512-ZQYitnqiyBc3D+k7LsgSBmMDVkOVidaagDG7j3fOym77jNunWRuYx7VSHa9GNfFZh+zh61xsCjRj4JxMZlDqTA==",
+      "dev": true
+    },
+    "node_modules/@zeit/ncc": {
+      "version": "0.22.3",
+      "resolved": "https://registry.npmjs.org/@zeit/ncc/-/ncc-0.22.3.tgz",
+      "integrity": "sha512-jnCLpLXWuw/PAiJiVbLjA8WBC0IJQbFeUwF4I9M+23MvIxTxk5pD4Q8byQBSPmHQjz5aBoA7AKAElQxMpjrCLQ==",
+      "deprecated": "@zeit/ncc is no longer maintained. Please use @vercel/ncc instead.",
+      "bin": {
+        "ncc": "dist/ncc/cli.js"
+      }
+    },
+    "node_modules/asynckit": {
+      "version": "0.4.0",
+      "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz",
+      "integrity": "sha1-x57Zf380y48robyXkLzDZkdLS3k="
+    },
+    "node_modules/axios": {
+      "version": "0.21.1",
+      "resolved": "https://registry.npmjs.org/axios/-/axios-0.21.1.tgz",
+      "integrity": "sha512-dKQiRHxGD9PPRIUNIWvZhPTPpl1rf/OxTYKsqKUDjBwYylTvV7SjSHJb9ratfyzM6wCdLCOYLzs73qpg5c4iGA==",
+      "dependencies": {
+        "follow-redirects": "^1.10.0"
+      }
+    },
+    "node_modules/combined-stream": {
+      "version": "1.0.8",
+      "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz",
+      "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==",
+      "dependencies": {
+        "delayed-stream": "~1.0.0"
+      },
+      "engines": {
+        "node": ">= 0.8"
+      }
+    },
+    "node_modules/delayed-stream": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz",
+      "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk=",
+      "engines": {
+        "node": ">=0.4.0"
+      }
+    },
+    "node_modules/follow-redirects": {
+      "version": "1.13.3",
+      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.13.3.tgz",
+      "integrity": "sha512-DUgl6+HDzB0iEptNQEXLx/KhTmDb8tZUHSeLqpnjpknR70H0nC2t9N73BK6fN4hOvJ84pKlIQVQ4k5FFlBedKA==",
+      "funding": [
+        {
+          "type": "individual",
+          "url": "https://github.com/sponsors/RubenVerborgh"
+        }
+      ],
+      "engines": {
+        "node": ">=4.0"
+      },
+      "peerDependenciesMeta": {
+        "debug": {
+          "optional": true
+        }
+      }
+    },
+    "node_modules/form-data": {
+      "version": "3.0.1",
+      "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.1.tgz",
+      "integrity": "sha512-RHkBKtLWUVwd7SqRIvCZMEvAMoGUp0XU+seQiZejj0COz3RI3hWP4sCv3gZWWLjJTd7rGwcsF5eKZGii0r/hbg==",
+      "dependencies": {
+        "asynckit": "^0.4.0",
+        "combined-stream": "^1.0.8",
+        "mime-types": "^2.1.12"
+      },
+      "engines": {
+        "node": ">= 6"
+      }
+    },
+    "node_modules/mime-db": {
+      "version": "1.46.0",
+      "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.46.0.tgz",
+      "integrity": "sha512-svXaP8UQRZ5K7or+ZmfNhg2xX3yKDMUzqadsSqi4NCH/KomcH75MAMYAGVlvXn4+b/xOPhS3I2uHKRUzvjY7BQ==",
+      "engines": {
+        "node": ">= 0.6"
+      }
+    },
+    "node_modules/mime-types": {
+      "version": "2.1.29",
+      "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.29.tgz",
+      "integrity": "sha512-Y/jMt/S5sR9OaqteJtslsFZKWOIIqMACsJSiHghlCAyhf7jfVYjKBmLiX8OgpWeW+fjJ2b+Az69aPFPkUOY6xQ==",
+      "dependencies": {
+        "mime-db": "1.46.0"
+      },
+      "engines": {
+        "node": ">= 0.6"
+      }
+    }
+  },
   "dependencies": {
     "@actions/core": {
       "version": "1.2.6",
@@ -42,14 +154,14 @@
       "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk="
     },
     "follow-redirects": {
-      "version": "1.13.1",
-      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.13.1.tgz",
-      "integrity": "sha512-SSG5xmZh1mkPGyKzjZP8zLjltIfpW32Y5QpdNJyjcfGxK3qo3NDDkZOZSFiGn1A6SclQxY9GzEwAHQ3dmYRWpg=="
+      "version": "1.13.3",
+      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.13.3.tgz",
+      "integrity": "sha512-DUgl6+HDzB0iEptNQEXLx/KhTmDb8tZUHSeLqpnjpknR70H0nC2t9N73BK6fN4hOvJ84pKlIQVQ4k5FFlBedKA=="
     },
     "form-data": {
-      "version": "3.0.0",
-      "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.0.tgz",
-      "integrity": "sha512-CKMFDglpbMi6PyN+brwB9Q/GOw0eAnsrEZDgcsH5Krhz5Od/haKHAX0NmQfha2zPPz0JpWzA7GJHGSnvCRLWsg==",
+      "version": "3.0.1",
+      "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.1.tgz",
+      "integrity": "sha512-RHkBKtLWUVwd7SqRIvCZMEvAMoGUp0XU+seQiZejj0COz3RI3hWP4sCv3gZWWLjJTd7rGwcsF5eKZGii0r/hbg==",
       "requires": {
         "asynckit": "^0.4.0",
         "combined-stream": "^1.0.8",
@@ -57,16 +169,16 @@
       }
     },
     "mime-db": {
-      "version": "1.45.0",
-      "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.45.0.tgz",
-      "integrity": "sha512-CkqLUxUk15hofLoLyljJSrukZi8mAtgd+yE5uO4tqRZsdsAJKv0O+rFMhVDRJgozy+yG6md5KwuXhD4ocIoP+w=="
+      "version": "1.46.0",
+      "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.46.0.tgz",
+      "integrity": "sha512-svXaP8UQRZ5K7or+ZmfNhg2xX3yKDMUzqadsSqi4NCH/KomcH75MAMYAGVlvXn4+b/xOPhS3I2uHKRUzvjY7BQ=="
     },
     "mime-types": {
-      "version": "2.1.28",
-      "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.28.tgz",
-      "integrity": "sha512-0TO2yJ5YHYr7M2zzT7gDU1tbwHxEUWBCLt0lscSNpcdAfFyJOVEpRYNS7EXVcTLNj/25QO8gulHC5JtTzSE2UQ==",
+      "version": "2.1.29",
+      "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.29.tgz",
+      "integrity": "sha512-Y/jMt/S5sR9OaqteJtslsFZKWOIIqMACsJSiHghlCAyhf7jfVYjKBmLiX8OgpWeW+fjJ2b+Az69aPFPkUOY6xQ==",
       "requires": {
-        "mime-db": "1.45.0"
+        "mime-db": "1.46.0"
       }
     }
   }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-request-action",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "",
   "main": "src/index.js",
   "private": false,
@@ -13,7 +13,7 @@
   },
   "keywords": [],
   "author": "",
-  "license": "ISC",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/fjogeleit/http-request-action/issues"
   },
@@ -24,6 +24,6 @@
   "dependencies": {
     "@zeit/ncc": "^0.22",
     "axios": "^0.21.1",
-    "form-data": "^3.0.0"
+    "form-data": "^3.0.1"
   }
 }

src/httpClient.js

@@ -5,11 +5,25 @@ const fs = require('fs')
 const METHOD_GET = 'GET'
 const METHOD_POST = 'POST'
 
-const request = async({ method, instanceConfig, data, files, auth, actions, preventFailureOnNoResponse, escapeData }) => {
+/**
+ * @param {Object} param0
+ * @param {string} param0.method HTTP Method
+ * @param {{ baseURL: string; timeout: number; headers: { [name: string]: string } }} param0.instanceConfig
+ * @param {string} param0.data Request Body as string, default {}
+ * @param {string} param0.files Map of Request Files (name: absolute path) as JSON String, default: {}
+ * @param {{ username: string; password: string }|undefined} param0.auth Optional HTTP Basic Auth
+ * @param {*} param0.actions 
+ * @param {number[]} param0.ignoredCodes Prevent Action to fail if the API response with one of this StatusCodes
+ * @param {boolean} param0.preventFailureOnNoResponse Prevent Action to fail if the API respond without Response
+ * @param {boolean} param0.escapeData Escape unescaped JSON content in data
+ *
+ * @returns {void}
+ */
+const request = async({ method, instanceConfig, data, files, auth, actions, ignoredCodes, preventFailureOnNoResponse, escapeData }) => {
   try {
     if (escapeData) {
       data = data.replace(/"[^"]*"/g, (match) => { 
-          return match.replace(/[\n\r]\s*/g, "\\n");
+        return match.replace(/[\n\r]\s*/g, "\\n");
       }); 
     }
 
@@ -35,7 +49,9 @@ const request = async({ method, instanceConfig, data, files, auth, actions, prev
     const requestData = {
       auth,
       method,
-      data
+      data,
+      maxContentLength: Infinity,
+      maxBodyLength: Infinity
     }
 
     actions.debug('Instance Configuration: ' + JSON.stringify(instanceConfig))
@@ -49,11 +65,13 @@ const request = async({ method, instanceConfig, data, files, auth, actions, prev
     actions.setOutput('response', JSON.stringify(response.data))
   } catch (error) {
     if (error.toJSON) {
-      actions.setOutput(JSON.stringify(error.toJSON()));
+      actions.setOutput('requestError', JSON.stringify(error.toJSON()));
     }
 
-    if (error.response) {
-      actions.setFailed(JSON.stringify({ code: error.response.code, message: error.response.data }))
+    if (error.response && ignoredCodes.includes(error.response.status)) {
+      actions.warning(JSON.stringify({ code: error.response.status, message: error.response.data }))
+    } else if (error.response) {
+      actions.setFailed(JSON.stringify({ code: error.response.status, message: error.response.data }))
     } else if (error.request && !preventFailureOnNoResponse) {
       actions.setFailed(JSON.stringify({ error: "no response received" }));
     } else if (error.request && preventFailureOnNoResponse) {
@@ -64,6 +82,11 @@ const request = async({ method, instanceConfig, data, files, auth, actions, prev
   }
 }
 
+/**
+ * @param {string} value
+ *
+ * @returns {Object}
+ */
 const convertToJSON = (value) => {
   try {
     return JSON.parse(value)
@@ -72,6 +95,12 @@ const convertToJSON = (value) => {
   }
 }
 
+/**
+ * @param {Object} data
+ * @param {Object} files
+ *
+ * @returns {FormData}
+ */
 const convertToFormData = (data, files) => {
   formData = new FormData()
 
@@ -86,6 +115,13 @@ const convertToFormData = (data, files) => {
   return formData
 }
 
+/**
+ * @param {{ baseURL: string; timeout: number; headers: { [name: string]: string } }} instanceConfig
+ * @param {FormData} formData
+ * @param {*} actions
+ *
+ * @returns {{ baseURL: string; timeout: number; headers: { [name: string]: string } }}
+ */
 const updateConfig = async (instanceConfig, formData, actions) => {
   try {
     const formHeaders = formData.getHeaders()
@@ -107,6 +143,11 @@ const updateConfig = async (instanceConfig, formData, actions) => {
   }
 }
 
+/**
+ * @param {FormData} formData
+ *
+ * @returns {Promise<number>}
+ */
 const contentLength = (formData) => new Promise((resolve, reject) => {
   formData.getLength((err, length) => {
     if (err) {

src/index.js

@@ -40,4 +40,11 @@ const method = core.getInput('method') || METHOD_POST;
 const preventFailureOnNoResponse = core.getInput('preventFailureOnNoResponse') === 'true';
 const escapeData = core.getInput('escapeData') === 'true';
 
-request({ data, method, instanceConfig, auth, preventFailureOnNoResponse, escapeData, files, actions: new GithubActions() })
+const ignoreStatusCodes = core.getInput('ignoreStatusCodes')
+let ignoredCodes = []
+
+if (typeof ignoreStatusCodes === 'string' && ignoreStatusCodes.length > 0) {
+  ignoredCodes = ignoreStatusCodes.split(',').map(statusCode => parseInt(statusCode.trim()))
+}
+
+request({ data, method, instanceConfig, auth, preventFailureOnNoResponse, escapeData, files, ignoredCodes, actions: new GithubActions() })