Change all references to Hard timeout to Exec timeout

This commit updates all references to a Hard timeout, replacing it with
Exec timeout for consistency with the existing Watchdog where
`exec_timeout` is used.

Signed-off-by: John McCabe <[email protected]>

Author: johnmccabe

README.md

@@ -26,7 +26,7 @@ HTTP headers cannot be sent after function starts executing due to input/output
 
 * A static Content-type can be set ahead of time.
 
-* Hard timeout: supported.
+* Exec timeout: supported.
 
 ### 2. Afterburn (mode=afterburn)
 
@@ -40,7 +40,7 @@ Vastly accelerated processing speed but requires a client library for each langu
 
 * A dynamic Content-type can be set from the client library.
 
-* Hard timeout: not supported.
+* Exec timeout: not supported.
 
 Example client libraries:
 
@@ -98,7 +98,7 @@ Reads entire request into memory from the HTTP request. At this point we seriali
 
 * A static Content-type can be set ahead of time.
 
-* Hard timeout: supported.
+* Exec timeout: supported.
 
 ## Configuration
 
@@ -109,7 +109,7 @@ Environmental variables:
 | `function_process`     | Yes          | The process to invoke for each function call function process (alias - fprocess). This must be a UNIX binary and accept input via STDIN and output via STDOUT.  |
 | `read_timeout`         | Yes          | HTTP timeout for reading the payload from the client caller (in seconds) |
 | `write_timeout`        | Yes          | HTTP timeout for writing a response body from your function (in seconds)  |
-| `hard_timeout`         | Yes          | Hard timeout for process exec'd for each incoming request (in seconds). Disabled if set to 0. |
+| `exec_timeout`         | Yes          | Exec timeout for process exec'd for each incoming request (in seconds). Disabled if set to 0. |
 | `port`                 | Yes          | Specify an alternative TCP port fo testing |
 | `write_debug`          | No           | Write all output, error messages, and additional information to the logs. Default is false. |
 | `content_type`         | Yes          | Force a specific Content-Type response for all responses - only in forking/serializing modes. |

config/config.go

@@ -12,7 +12,7 @@ type WatchdogConfig struct {
 	TCPPort          int
 	HTTPReadTimeout  time.Duration
 	HTTPWriteTimeout time.Duration
-	HardTimeout      time.Duration
+	ExecTimeout      time.Duration
 
 	FunctionProcess  string
 	ContentType      string
@@ -56,7 +56,7 @@ func New(env []string) (WatchdogConfig, error) {
 		HTTPWriteTimeout: getDuration(envMap, "write_timeout", time.Second*10),
 		FunctionProcess:  functionProcess,
 		InjectCGIHeaders: true,
-		HardTimeout:      getDuration(envMap, "hard_timeout", time.Second*10),
+		ExecTimeout:      getDuration(envMap, "exec_timeout", time.Second*10),
 		OperationalMode:  ModeStreaming,
 		ContentType:      contentType,
 	}

config/config_test.go

@@ -116,37 +116,37 @@ func Test_Timeouts(t *testing.T) {
 	cases := []struct {
 		readTimeout  time.Duration
 		writeTimeout time.Duration
-		hardTimeout  time.Duration
+		execTimeout  time.Duration
 		env          []string
 		name         string
 	}{
 		{
 			name:         "Defaults",
 			readTimeout:  time.Second * 10,
 			writeTimeout: time.Second * 10,
-			hardTimeout:  time.Second * 10,
+			execTimeout:  time.Second * 10,
 			env:          []string{},
 		},
 		{
 			name:         "Custom read-timeout",
 			readTimeout:  time.Second * 5,
 			writeTimeout: time.Second * 10,
-			hardTimeout:  time.Second * 10,
+			execTimeout:  time.Second * 10,
 			env:          []string{"read_timeout=5s"},
 		},
 		{
 			name:         "Custom write-timeout",
 			readTimeout:  time.Second * 10,
 			writeTimeout: time.Second * 5,
-			hardTimeout:  time.Second * 10,
+			execTimeout:  time.Second * 10,
 			env:          []string{"write_timeout=5s"},
 		},
 		{
-			name:         "Custom hard-timeout",
+			name:         "Custom exec-timeout",
 			readTimeout:  time.Second * 10,
 			writeTimeout: time.Second * 10,
-			hardTimeout:  time.Second * 5,
-			env:          []string{"hard_timeout=5s"},
+			execTimeout:  time.Second * 5,
+			env:          []string{"exec_timeout=5s"},
 		},
 	}
 
@@ -161,8 +161,8 @@ func Test_Timeouts(t *testing.T) {
 		if testCase.writeTimeout != actual.HTTPWriteTimeout {
 			t.Errorf("(%s) HTTPWriteTimeout want: %s, got: %s", testCase.name, actual.HTTPWriteTimeout, testCase.writeTimeout)
 		}
-		if testCase.hardTimeout != actual.HardTimeout {
-			t.Errorf("(%s) HardTimeout want: %s, got: %s", testCase.name, actual.HardTimeout, testCase.hardTimeout)
+		if testCase.execTimeout != actual.ExecTimeout {
+			t.Errorf("(%s) ExecTimeout want: %s, got: %s", testCase.name, actual.ExecTimeout, testCase.execTimeout)
 		}
 
 	}

functions/serializing_fork_runner.go

@@ -12,7 +12,7 @@ import (
 
 // SerializingForkFunctionRunner forks a process for each invocation
 type SerializingForkFunctionRunner struct {
-	HardTimeout time.Duration
+	ExecTimeout time.Duration
 }
 
 // Run run a fork for each invocation
@@ -43,17 +43,17 @@ func serializeFunction(req FunctionRequest, f *SerializingForkFunctionRunner) (*
 	cmd.Env = req.Environment
 
 	var timer *time.Timer
-	if f.HardTimeout > time.Millisecond*0 {
+	if f.ExecTimeout > time.Millisecond*0 {
 		log.Println("Started a timer.")
 
-		timer = time.NewTimer(f.HardTimeout)
+		timer = time.NewTimer(f.ExecTimeout)
 		go func() {
 			<-timer.C
 
-			log.Printf("Function was killed by HardTimeout: %s\n", f.HardTimeout)
+			log.Printf("Function was killed by ExecTimeout: %s\n", f.ExecTimeout)
 			killErr := cmd.Process.Kill()
 			if killErr != nil {
-				log.Println("Error killing function due to HardTimeout", killErr)
+				log.Println("Error killing function due to ExecTimeout", killErr)
 			}
 		}()
 	}

functions/streaming_runner.go

@@ -26,7 +26,7 @@ type FunctionRequest struct {
 
 // ForkFunctionRunner forks a process for each invocation
 type ForkFunctionRunner struct {
-	HardTimeout time.Duration
+	ExecTimeout time.Duration
 }
 
 // Run run a fork for each invocation
@@ -37,16 +37,16 @@ func (f *ForkFunctionRunner) Run(req FunctionRequest) error {
 	cmd.Env = req.Environment
 
 	var timer *time.Timer
-	if f.HardTimeout > time.Millisecond*0 {
-		timer = time.NewTimer(f.HardTimeout)
+	if f.ExecTimeout > time.Millisecond*0 {
+		timer = time.NewTimer(f.ExecTimeout)
 
 		go func() {
 			<-timer.C
 
-			fmt.Printf("Function was killed by HardTimeout: %d\n", f.HardTimeout)
+			fmt.Printf("Function was killed by ExecTimeout: %d\n", f.ExecTimeout)
 			killErr := cmd.Process.Kill()
 			if killErr != nil {
-				fmt.Println("Error killing function due to HardTimeout", killErr)
+				fmt.Println("Error killing function due to ExecTimeout", killErr)
 			}
 		}()
 	}

main.go

@@ -110,7 +110,7 @@ func makeAfterBurnRequestHandler(watchdogConfig config.WatchdogConfig) func(http
 
 func makeSerializingForkRequestHandler(watchdogConfig config.WatchdogConfig) func(http.ResponseWriter, *http.Request) {
 	functionInvoker := functions.SerializingForkFunctionRunner{
-		HardTimeout: watchdogConfig.HardTimeout,
+		ExecTimeout: watchdogConfig.ExecTimeout,
 	}
 
 	return func(w http.ResponseWriter, r *http.Request) {
@@ -141,7 +141,7 @@ func makeSerializingForkRequestHandler(watchdogConfig config.WatchdogConfig) fun
 
 func makeForkRequestHandler(watchdogConfig config.WatchdogConfig) func(http.ResponseWriter, *http.Request) {
 	functionInvoker := functions.ForkFunctionRunner{
-		HardTimeout: watchdogConfig.HardTimeout,
+		ExecTimeout: watchdogConfig.ExecTimeout,
 	}
 
 	return func(w http.ResponseWriter, r *http.Request) {