Support File Arrays

Signed-off-by: Frank Jogeleit <frank.jogeleit@lovoo.com>

.github/workflows/build-action.yml

@@ -14,10 +14,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: checkout repo
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         ref: ${{ inputs.ref }}
-    - uses: actions/setup-node@v3
+    - uses: actions/setup-node@v4
       with:
         node-version: '16'
     - name: Install dependencies

.github/workflows/ci.yml

@@ -26,10 +26,10 @@ jobs:
           echo "branch=$branch" >> $GITHUB_OUTPUT
         fi
     - name: checkout repo
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         ref: ${{ steps.ref.outputs.branch }}
-    - uses: actions/setup-node@v3
+    - uses: actions/setup-node@v4
       with:
         node-version: '16'
     - name: Install dependencies
@@ -56,10 +56,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: checkout repo
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         persist-credentials: false
-    - uses: actions/setup-node@v3
+    - uses: actions/setup-node@v4
       with:
         node-version: '16.17.0'
     - name: Build action
@@ -77,7 +77,7 @@ jobs:
       - integrity
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.ref }}
 
@@ -123,28 +123,49 @@ jobs:
       
       - name: Create Test File
         run: |
-          echo "test" > testfile.txt
+          echo "test" > testfile1.txt
+          echo "test" > testfile2.txt
+
       - name: Request Postman Echo POST Multipart
         uses: ./
         with:
           url: 'https://postman-echo.com/post'
           method: 'POST'
           data: '{ "key": "value" }'
-          files: '{ "file": "${{ github.workspace }}/testfile.txt" }'
+          files: '{ "file": "${{ github.workspace }}/testfile1.txt" }'
+
+      - name: Request Postman Echo POST Multipart File Array
+        uses: ./
+        with:
+          url: 'https://postman-echo.com/post'
+          method: 'POST'
+          data: '{ "key": "value" }'
+          files: '{ "file": ["${{ github.workspace }}/testfile1.txt", "${{ github.workspace }}/testfile2.txt"] }'
+
+      - name: Request Postman Echo POST and persist response
+        uses: ./
+        with:
+          url: 'https://postman-echo.com/post'
+          method: 'POST'
+          file: "${{ github.workspace }}/testfile1.txt"
+          responseFile: "${{ github.workspace }}/response.json"
+      - name: Output responseFile
+        run: |
+          cat "${{ github.workspace }}/response.json"
 
       - name: Request Postman Echo POST Multipart without data
         uses: ./
         with:
           url: 'https://postman-echo.com/post'
           method: 'POST'
-          files: '{ "file": "${{ github.workspace }}/testfile.txt" }'
+          files: '{ "file": "${{ github.workspace }}/testfile1.txt" }'
 
       - name: Request Postman Echo POST single file
         uses: ./
         with:
           url: 'https://postman-echo.com/post'
           method: 'POST'
-          file: "${{ github.workspace }}/testfile.txt"
+          file: "${{ github.workspace }}/testfile1.txt"
 
       - name: Request Postman Echo POST URLEncoded string data
         uses: ./

.gitignore

@@ -1 +1,2 @@
 node_modules
+.vscode

README.md

@@ -42,6 +42,11 @@ jobs:
 |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' ||
 |httpsCA| Certificate authority as string in PEM format ||
+|httpsCert| Client Certificate as string ||
+|httpsKey| Client Certificate Key as string ||
+|responseFile| Persist the response data to the specified file path ||
+|retry| optional amount of retries if the request is failing, does not retry if the status code is ignored ||
+|retryWait| time between each retry in millseconds | 3000 |
 
 ### Response
 
@@ -73,3 +78,25 @@ Additional information is available if debug logging is enabled:
 - 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`
+
+#### Local Usage
+
+* You can execute this tool locally with the provided CLI `bin/http-action`.
+
+```bash
+bin/http-action --help                   
+Positionals:
+  url  request URL                                                     [string]
+
+Optionen:
+      --help           helper text                                     [boolean]
+  -d, --data           request body data                               [string] [default: "{}"]
+  -f, --files          request files, send as multipart/form-data      [string] [default: "{}"]
+      --file           single file, send as application/octet-stream   [string]
+  -h, --customHeaders  custom request headers                          [string] [default: "{}"]
+  -m, --method         request method (GET, POST, PATCH, PUT, DELETE)  [string] [default: "POST"]
+  -t, --contentType    request content type                            [string] [default: "application/json"]
+      --bearerToken    bearer token without Bearer prefix, added as
+                       Authorization header                            [string]
+      --timeout        request timeout                                 [number] [default: 5000]
+```

action.yml

@@ -50,6 +50,21 @@ inputs:
     httpsCA:
         description: 'Certificate authority as string in PEM format'
         required: false
+    httpsCert:
+        description: 'Client Certificate as string'
+        required: false
+    httpsKey:
+        description: 'Client Certificate Key as string'
+        required: false
+    responseFile:
+        description: 'Persist the response data to the specified file path'
+        required: false
+    retry:
+        description: 'optional amount of retries if the request fails'
+        required: false
+    retryWait:
+        description: 'wait time between retries in milliseconds'
+        required: false
 outputs:
     response:
         description: 'HTTP Response Content'

bin/http-action

@@ -0,0 +1,55 @@
+#!/usr/bin/env node
+const yargs = require('yargs/yargs')
+const { hideBin } = require('yargs/helpers')
+const { LogActions } = require('../src/githubActions.js')
+const { request } = require('../src/httpClient');
+
+const argv = yargs(hideBin(process.argv))
+    .option('data', { alias: 'd', type: 'string', description: 'request body data', default: '{}' })
+    .option('files', { alias: 'f', type: 'string', description: 'request files, send as multipart/form-data', default: '{}' })
+    .option('file', { type: 'string', description: 'single file, send as application/octet-stream' })
+    .option('customHeaders', { alias: 'h', type: 'string', description: 'custom request headers', default: '{}' })
+    .option('method', { alias: 'm', type: 'string', description: 'request method (GET, POST, PATCH, PUT, DELETE)', default: 'POST' })
+    .option('contentType', { alias: 't', type: 'string', description: 'request content type', default: 'application/json' })
+    .option('bearerToken', { type: 'string', description: 'bearer token without Bearer prefix, added as Authorization header' })
+    .option('timeout', { type: 'number', description: 'request timeout', default: 5000 })
+    .positional('url', { type: 'string', description: 'URL', description: 'request URL' })
+    .parse()
+
+let customHeaders = {}
+
+if (!!argv.customHeaders) {
+    try {
+        customHeaders = JSON.parse(argv.customHeaders);
+    } catch(error) {
+        console.error('Could not parse customHeaders string value')
+    }
+}
+    
+const headers = { 'Content-Type': argv.contentType || 'application/json' }
+
+if (!!argv.bearerToken) {
+    headers['Authorization'] = `Bearer ${argv.bearerToken}`;
+}
+
+const instanceConfig = {
+    baseURL: argv._[0],
+    timeout: parseInt(argv.timeout || 5000, 10),
+    headers: { ...headers, ...customHeaders }
+}
+
+request({ 
+    data: argv.data,
+    method: argv.method,
+    instanceConfig,
+    files: argv.files,
+    file: argv.file,
+    actions: new LogActions(),
+    options: {
+        ignoredCodes: [],
+        escapeData: false,
+        preventFailureOnNoResponse: false,
+        retry: 0,
+        retryWait: 0
+    }
+})

package.json

@@ -1,6 +1,6 @@
 {
   "name": "http-request-action",
-  "version": "1.11.2",
+  "version": "1.14.2",
   "description": "",
   "main": "src/index.js",
   "private": false,
@@ -19,12 +19,15 @@
   },
   "homepage": "https://github.com/fjogeleit/http-request-action#readme",
   "devDependencies": {
-    "@vercel/ncc": "^0.34.0",
-    "axios": "^1.1.3",
-    "form-data": "^4.0.0"
+    "@vercel/ncc": "^0.38.1",
+    "axios": "^1.6",
+    "form-data": "^4.0.0",
+    "yargs": "^17.7.2"
   },
   "dependencies": {
-    "@actions/core": "^1.10.0"
+    "@actions/core": "^1.10.1",
+    "install": "^0.13.0",
+    "npm": "^10.2.4"
   },
   "engines": {
     "node": ">=16.0.0"

src/githubActions.js

@@ -7,6 +7,10 @@ class GithubActions {
     core.debug(message)
   }
 
+  info(message) {
+    core.info(message)
+  }
+
   warning(message) {
     core.warning(message)
   }
@@ -21,6 +25,10 @@ class GithubActions {
 }
 
 class LogActions {
+  info(message) {
+    console.info(message)
+  }
+
   debug(message) {
     console.info(message)
   }

src/handler/persist.js

@@ -0,0 +1,30 @@
+'use strict'
+
+const axios = require('axios');
+const fs = require('fs');
+const { GithubActions } = require('../githubActions');
+
+/**
+ * @param {string} filePath
+ * @param {GithubActions} actions
+ * 
+ * @returns {(response: axios.AxiosResponse) => void}
+ */
+const createPersistHandler = (filePath, actions) => (response) => {
+    let data = response.data
+
+    if (typeof data == 'object') {
+        data = JSON.stringify(data)
+    }
+
+    fs.writeFile(filePath, data, err => {
+        if (!err) {
+            actions.info(`response persisted successfully at ${filePath}`)
+            return
+        }
+    
+        actions.warning(JSON.stringify({ message: error.message, data: response.data }))
+    })
+}
+
+module.exports = { createPersistHandler }

src/helper.js

@@ -0,0 +1,81 @@
+'use strict';
+
+const { GithubActions } = require('./githubActions');
+const FormData = require('form-data');
+const fs = require('fs');
+
+/**
+ * @param {string} value
+ *
+ * @returns {Object}
+ */
+const convertToJSON = (value) => {
+  try {
+    return JSON.parse(value) || {};
+  } catch (e) {
+    return {};
+  }
+};
+
+/**
+ * @param {{ [key: string]: string }}  data
+ * @param {{ [key: string]: string }}  files
+ * @param {boolean} convertPaths
+ *
+ * @returns {FormData}
+ */
+const convertToFormData = async (data, files, convertPaths) => {
+  const formData = new FormData();
+
+  for (const [key, value] of Object.entries(data)) {
+    formData.append(key, value);
+  }
+
+  for (const [key, value] of Object.entries(files)) {
+    if (Array.isArray(value)) {
+      value.forEach(v => formData.append(key, fs.createReadStream(v)))
+    } else {
+      formData.append(key, fs.createReadStream(value));
+    }
+  }
+
+  return formData;
+};
+
+/**
+ * @param {() => Promise} callback
+ * @param {{ retry: number; sleep: number; actions: GithubActions }} options
+ *
+ * @returns {Promise}
+ */
+const retry = async (callback, options) => {
+  let lastErr = null;
+  let i = 0;
+
+  do {
+    try {
+      return await callback();
+    } catch (err) {
+      lastErr = err;
+    }
+
+    if (i < options.retries) {
+      options.actions.warning(`#${i + 1} request failed: ${err}`);
+      await sleep(options.sleep);
+    }
+
+    i++;
+  } while (i <= options.retry);
+
+  throw lastErr;
+};
+
+function sleep(milliseconds) {
+  return new Promise((resolve) => setTimeout(resolve, milliseconds));
+}
+
+module.exports = {
+  convertToJSON,
+  convertToFormData,
+  retry,
+};

src/httpClient.js

@@ -1,9 +1,11 @@
 'use strict'
 
 const axios = require('axios');
-const FormData = require('form-data')
-const fs = require('fs')
+const FormData = require('form-data');
+const fs = require('fs');
 const url = require('url');
+const { GithubActions } = require('./githubActions');
+const { convertToJSON, convertToFormData, retry } = require('./helper');
 
 const METHOD_GET = 'GET'
 const METHOD_POST = 'POST'
@@ -19,16 +21,22 @@ const CONTENT_TYPE_URLENCODED = 'application/x-www-form-urlencoded'
  * @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 {string} param0.file Single request file (absolute path)
- * @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
+ * @param {GithubActions} param0.actions 
+ * @param {{ 
+ *  ignoredCodes: number[];
+ *  preventFailureOnNoResponse: boolean,
+ *  escapeData: boolean;
+ *  retry: number;
+ *  retryWait: number;
+ * }} param0.options
  *
- * @returns {Promise<void>}
+ * @returns {Promise<axios.AxiosResponse>}
  */
-const request = async({ method, instanceConfig, data, files, file, actions, ignoredCodes, preventFailureOnNoResponse, escapeData }) => {
+const request = async({ method, instanceConfig, data, files, file, actions, options }) => {
+  actions.debug(`options: ${JSON.stringify(options)}`)
+  
   try {
-    if (escapeData) {
+    if (options.escapeData) {
       data = data.replace(/"[^"]*"/g, (match) => { 
         return match.replace(/[\n\r]\s*/g, "\\n");
       }); 
@@ -47,7 +55,7 @@ const request = async({ method, instanceConfig, data, files, file, actions, igno
           data = convertToFormData(dataJson, filesJson)
           instanceConfig = await updateConfig(instanceConfig, data, actions)
         } catch(error) {
-          actions.setFailed({ message: `Unable to convert Data and Files into FormData: ${error.message}`, data: dataJson, files: filesJson })
+          actions.setFailed(JSON.stringify({ message: `Unable to convert Data and Files into FormData: ${error.message}`, data: dataJson, files: filesJson }))
           return
         }
       }
@@ -75,68 +83,62 @@ const request = async({ method, instanceConfig, data, files, file, actions, igno
 
     actions.debug('Instance Configuration: ' + JSON.stringify(instanceConfig))
     
+    /** @type {axios.AxiosInstance} */
     const instance = axios.create(instanceConfig);
 
     actions.debug('Request Data: ' + JSON.stringify(requestData))
 
-    const response = await instance.request(requestData)
+    const execRequest = async () => {
+      try {
+        return await instance.request(requestData)
+      } catch(error) {
+        if (error.response && options.ignoredCodes.includes(error.response.status)) {
+          actions.warning(`ignored status code: ${JSON.stringify({ code: error.response.status, message: error.response.data })}`)
+          
+          return null
+        }
+        
+        if (!error.response && error.request && options.preventFailureOnNoResponse) {
+          actions.warning(`no response received: ${JSON.stringify(error)}`);
+
+          return null
+        }
+
+        throw error
+      }
+    }
+
+    /** @type {axios.AxiosResponse|null} */
+    const response = await retry(execRequest, {
+      actions,
+      retry: options.retry || 0,
+      sleep: options.retryWait // wait time after each retry
+    })
+
+    if (!response) {
+      return null
+    }
 
     actions.setOutput('response', JSON.stringify(response.data))
-    
     actions.setOutput('headers', response.headers)
+
+    return response
   } catch (error) {
     if ((typeof error === 'object') && (error.isAxiosError === true)) {
       const { name, message, code, response } = error
       actions.setOutput('requestError', JSON.stringify({ name, message, code, status: response && response.status ? response.status : null }));
     }
 
-    if (error.response && ignoredCodes.includes(error.response.status)) {
-      actions.warning(JSON.stringify({ code: error.response.status, message: error.response.data }))
-    } else if (error.response) {
+    if (error.response) {
       actions.setFailed(JSON.stringify({ code: error.response.status, message: error.response.data }))
-    } else if (error.request && !preventFailureOnNoResponse) {
+    } else if (error.request) {
       actions.setFailed(JSON.stringify({ error: "no response received" }));
-    } else if (error.request && preventFailureOnNoResponse) {
-      actions.warning(JSON.stringify(error));
     } else {
       actions.setFailed(JSON.stringify({ message: error.message, data }));
     }
   }
 }
 
-/**
- * @param {string} value
- *
- * @returns {Object}
- */
-const convertToJSON = (value) => {
-  try {
-    return JSON.parse(value) || {}
-  } catch(e) {
-    return {}
-  }
-}
-
-/**
- * @param {Object} data
- * @param {Object} files
- *
- * @returns {FormData}
- */
-const convertToFormData = (data, files) => {
-  const formData = new FormData()
-
-  for (const [key, value] of Object.entries(data)) {
-    formData.append(key, value)
-  }
-
-  for (const [key, value] of Object.entries(files)) {
-    formData.append(key, fs.createReadStream(value))
-  }
-
-  return formData
-}
-
 /**
  * @param {{ baseURL: string; timeout: number; headers: { [name: string]: string } }} instanceConfig
  * @param {FormData} formData

src/index.js

@@ -5,6 +5,7 @@ const axios = require('axios');
 const https = require('https');
 const { request, METHOD_POST } = require('./httpClient');
 const { GithubActions } = require('./githubActions');
+const { createPersistHandler } = require('./handler/persist');
 
 let customHeaders = {}
 
@@ -12,7 +13,8 @@ if (!!core.getInput('customHeaders')) {
   try {
     customHeaders = JSON.parse(core.getInput('customHeaders'));
   } catch(error) {
-    core.error('Could not parse customHeaders string value')
+    core.debug(`Invalid customHeaders string: ${core.getInput('customHeaders')}`)
+    core.error(`Could not parse customHeaders string value: ${error}`)
   }
 }
 
@@ -29,8 +31,12 @@ const instanceConfig = {
   headers: { ...headers, ...customHeaders }
 }
 
-if (!!core.getInput('httpsCA')) {
-  instanceConfig.httpsAgent = new https.Agent({ ca: core.getInput('httpsCA') })
+if (!!core.getInput('httpsCA') || !!core.getInput('httpsCert')) {
+  instanceConfig.httpsAgent = new https.Agent({ 
+    ca: core.getInput('httpsCA') || undefined,
+    cert: core.getInput('httpsCert') || undefined,
+    key: core.getInput('httpsKey') || undefined
+  })
 }
 
 if (!!core.getInput('username') || !!core.getInput('password')) {
@@ -42,18 +48,48 @@ if (!!core.getInput('username') || !!core.getInput('password')) {
   }
 }
 
+let retry = 0
+if (!!core.getInput('retry')) {
+  retry = parseInt(core.getInput('retry'))
+}
+
+let retryWait = 3000
+if (!!core.getInput('retryWait')) {
+  retry = parseInt(core.getInput('retryWait'))
+}
+
 const data = core.getInput('data') || '{}';
 const files = core.getInput('files') || '{}';
 const file = core.getInput('file')
+const responseFile = core.getInput('responseFile')
 const method = core.getInput('method') || METHOD_POST;
 const preventFailureOnNoResponse = core.getInput('preventFailureOnNoResponse') === 'true';
 const escapeData = core.getInput('escapeData') === 'true';
 
-const ignoreStatusCodes = core.getInput('ignoreStatusCodes')
-let ignoredCodes = []
+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, preventFailureOnNoResponse, escapeData, files, file, ignoredCodes, actions: new GithubActions() })
+const handler = [];
+const actions = new GithubActions();
+
+if (!!responseFile) {
+  handler.push(createPersistHandler(responseFile, actions))
+}
+
+const options = {
+  ignoredCodes,
+  preventFailureOnNoResponse,
+  escapeData,
+  retry,
+  retryWait
+}
+
+request({ data, method, instanceConfig, files, file, actions, options }).then(response => {
+  if (typeof response == 'object') {
+    handler.forEach(h => h(response))
+  }
+})