feat(): add webhook timeout

README.md

@@ -126,7 +126,22 @@ data: Script parameter: {"foo": "bar"}
 data: done
 ```
 
-### Notifications
+### Webhook timeout configuration
+
+By default a webhook as a timeout of 10 seconds.
+This timeout is globally configurable by setting the environment variable:
+`APP_HOOK_TIMEOUT` (in seconds).
+
+You can override this global behavior per request by setting the HTTP header:
+`X-Hook-Timeout` (in seconds).
+
+*Example:*
+
+```bash
+$ curl -XPOST -H "X-Hook-Timeout: 5" http://localhost/echo?foo=bar
+```
+
+### Post hook notifications
 
 The script's output is collected and stored into a log file (configured by the
 `APP_WORKING_DIR` environment variable).

pkg/api/api.go

@@ -3,17 +3,35 @@ package api
 import (
 	"fmt"
 	"io/ioutil"
-	"log"
 	"net/http"
+	"os"
+	"strconv"
 	"strings"
 
 	"github.com/ncarlier/webhookd/pkg/hook"
+	"github.com/ncarlier/webhookd/pkg/logger"
 	"github.com/ncarlier/webhookd/pkg/tools"
 	"github.com/ncarlier/webhookd/pkg/worker"
 )
 
-// WebhookHandler is the main handler of the API.
-func WebhookHandler(w http.ResponseWriter, r *http.Request) {
+var (
+	defaultTimeout = atoiFallback(os.Getenv("APP_HOOK_TIMEOUT"), 10)
+)
+
+func atoiFallback(str string, fallback int) int {
+	value, err := strconv.Atoi(str)
+	if err != nil || value < 0 {
+		return fallback
+	}
+	return value
+}
+
+// Index is the main handler of the API.
+func Index() http.Handler {
+	return http.HandlerFunc(webhookHandler)
+}
+
+func webhookHandler(w http.ResponseWriter, r *http.Request) {
 	flusher, ok := w.(http.Flusher)
 	if !ok {
 		http.Error(w, "Streaming unsupported!", http.StatusInternalServerError)
@@ -29,20 +47,20 @@ func WebhookHandler(w http.ResponseWriter, r *http.Request) {
 	p := strings.TrimPrefix(r.URL.Path, "/")
 	script, err := hook.ResolveScript(p)
 	if err != nil {
-		log.Println(err.Error())
+		logger.Error.Println(err.Error())
 		http.Error(w, err.Error(), http.StatusNotFound)
 		return
 	}
 
 	body, err := ioutil.ReadAll(r.Body)
 	if err != nil {
-		log.Printf("Error reading body: %v", err)
+		logger.Error.Printf("Error reading body: %v", err)
 		http.Error(w, "can't read body", http.StatusBadRequest)
 		return
 	}
 
 	params := tools.QueryParamsToShellVars(r.URL.Query())
-	log.Printf("Calling hook script \"%s\" with params %s...\n", script, params)
+	logger.Debug.Printf("Calling hook script \"%s\" with params %s...\n", script, params)
 	params = append(params, tools.HTTPHeadersToShellVars(r.Header)...)
 
 	// Create work
@@ -52,6 +70,7 @@ func WebhookHandler(w http.ResponseWriter, r *http.Request) {
 	work.Payload = string(body)
 	work.Args = params
 	work.MessageChan = make(chan []byte)
+	work.Timeout = atoiFallback(r.Header.Get("X-Hook-Timeout"), defaultTimeout)
 
 	// Put work in queue
 	worker.WorkQueue <- *work
@@ -61,7 +80,7 @@ func WebhookHandler(w http.ResponseWriter, r *http.Request) {
 	w.Header().Set("Connection", "keep-alive")
 	w.Header().Set("Access-Control-Allow-Origin", "*")
 
-	log.Println("Work request queued:", script)
+	logger.Debug.Println("Work request queued:", script)
 	fmt.Fprintf(w, "data: Hook work request \"%s\" queued...\n\n", work.Name)
 
 	for {

pkg/worker/script_runner.go

@@ -4,12 +4,12 @@ import (
 	"bufio"
 	"fmt"
 	"io"
-	"log"
 	"os"
 	"os/exec"
 	"path"
 	"time"
 
+	"github.com/ncarlier/webhookd/pkg/logger"
 	"github.com/ncarlier/webhookd/pkg/tools"
 )
 
@@ -32,7 +32,7 @@ func runScript(work *WorkRequest) (string, error) {
 		workingdir = os.TempDir()
 	}
 
-	log.Println("Starting script:", work.Script, "...")
+	logger.Info.Println("Executing script", work.Script, "...")
 	binary, err := exec.LookPath(work.Script)
 	if err != nil {
 		return "", err
@@ -50,7 +50,7 @@ func runScript(work *WorkRequest) (string, error) {
 		return "", err
 	}
 	defer logFile.Close()
-	log.Println("Writing output to file: ", logFilename, "...")
+	logger.Debug.Println("Writing output to file: ", logFilename, "...")
 
 	wLogFile := bufio.NewWriter(logFile)
 
@@ -73,22 +73,28 @@ func runScript(work *WorkRequest) (string, error) {
 			work.MessageChan <- []byte(line)
 			// writing to outfile
 			if _, err := wLogFile.WriteString(line + "\n"); err != nil {
-				log.Println("Error while writing into the log file:", logFilename, err)
+				logger.Error.Println("Error while writing into the log file:", logFilename, err)
 			}
 			if err = wLogFile.Flush(); err != nil {
-				log.Println("Error while flushing the log file:", logFilename, err)
+				logger.Error.Println("Error while flushing the log file:", logFilename, err)
 			}
 		}
 		if err := scanner.Err(); err != nil {
-			log.Println("Error scanning the script stdout: ", logFilename, err)
+			logger.Error.Println("Error scanning the script stdout: ", logFilename, err)
 		}
 	}(r)
 
+	timer := time.AfterFunc(time.Duration(work.Timeout)*time.Second, func() {
+		logger.Warning.Printf("Timeout reached (%ds). Killing script: %s\n", work.Timeout, work.Script)
+		cmd.Process.Kill()
+	})
 	err = cmd.Wait()
 	if err != nil {
-		log.Println("Starting script:", work.Script, "-> ERROR")
+		timer.Stop()
+		logger.Info.Println("Script", work.Script, "executed with ERROR.")
 		return logFilename, err
 	}
-	log.Println("Starting script:", work.Script, "-> OK")
+	timer.Stop()
+	logger.Info.Println("Script", work.Script, "executed wit SUCCESS")
 	return logFilename, nil
 }

pkg/worker/work_request.go

@@ -7,4 +7,5 @@ type WorkRequest struct {
 	Payload     string
 	Args        []string
 	MessageChan chan []byte
+	Timeout     int
 }