Added new feature ‘pathDelays’

Configure a delay for individual path globs! Global delay is the fallback now, indivdual delays are now configurable. Signed-off-by: Quobix <dave@quobix.com>
pb33f · Aug 24, 2023 · 0e21778 · 0e21778
1 parent 43f1ed1
commit 0e21778
Show file tree

Hide file tree

Showing 28 changed files with 108 additions and 32 deletions.
diff --git a/cmd/booted_message.go b/cmd/booted_message.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package cmd
 

diff --git a/cmd/handle_http_traffic.go b/cmd/handle_http_traffic.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package cmd
 

diff --git a/cmd/load_specification.go b/cmd/load_specification.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package cmd
 

diff --git a/cmd/print_banner.go b/cmd/print_banner.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package cmd
 

diff --git a/cmd/root_command.go b/cmd/root_command.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package cmd
 
@@ -250,6 +250,12 @@ var (
 				printLoadedPathConfigurations(config.PathConfigurations)
 			}
 
+			// path delays
+			if len(config.PathDelays) > 0 {
+				config.CompilePathDelays()
+				printLoadedPathDelayConfigurations(config.PathDelays)
+			}
+
 			// static headers
 			if config.Headers != nil && len(config.Headers.DropHeaders) > 0 {
 				pterm.Info.Printf("Dropping the following %d %s globally:\n", len(config.Headers.DropHeaders),
@@ -354,6 +360,17 @@ func printLoadedPathConfigurations(configs map[string]*shared.WiretapPathConfig)
 	}
 }
 
+func printLoadedPathDelayConfigurations(pathDelays map[string]int) {
+	pterm.Info.Printf("Loaded %d path %s:\n", len(pathDelays),
+		shared.Pluralize(len(pathDelays), "delay", "delays"))
+
+	for k, v := range pathDelays {
+		pterm.Printf("⏱️ %sms --> %s\n", pterm.LightCyan(v), pterm.LightMagenta(k))
+	}
+	pterm.Println()
+
+}
+
 func printLoadedVariables(variables map[string]string) {
 	pterm.Info.Printf("Loaded %d %s:\n", len(variables),
 		shared.Pluralize(len(variables), "variable", "variables"))

diff --git a/cmd/run_service.go b/cmd/run_service.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package cmd
 

diff --git a/cmd/serve_monitor.go b/cmd/serve_monitor.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package cmd
 

diff --git a/config/config_service.go b/config/config_service.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package config
 

diff --git a/config/paths.go b/config/paths.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package config
 
@@ -19,6 +19,16 @@ func FindPaths(path string, configuration *shared.WiretapConfiguration) []*share
 	return foundConfigurations
 }
 
+func FindPathDelay(path string, configuration *shared.WiretapConfiguration) int {
+	var foundMatch int
+	for key := range configuration.CompiledPathDelays {
+		if configuration.CompiledPathDelays[key].CompiledPathDelay.Match(path) {
+			foundMatch = configuration.CompiledPathDelays[key].PathDelayValue
+		}
+	}
+	return foundMatch
+}
+
 func RewritePath(path string, configuration *shared.WiretapConfiguration) string {
 	paths := FindPaths(path, configuration)
 	var replaced string

diff --git a/config/paths_test.go b/config/paths_test.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package config
 
@@ -188,3 +188,29 @@ paths:
 	assert.Equal(t, "http://localhost:80/noKetchupPlease/-/yummy/yum?onions=true", path)
 
 }
+
+func TestLocatePathDelay(t *testing.T) {
+
+	config := `pathDelays:
+  /pb33f/test/**: 1000
+  /pb33f/cakes/123: 2000
+  /*/test/123: 3000`
+
+	var c shared.WiretapConfiguration
+	_ = yaml.Unmarshal([]byte(config), &c)
+
+	c.CompilePathDelays()
+
+	delay := FindPathDelay("/pb33f/test/burgers/fries?1234=no", &c)
+	assert.Equal(t, 1000, delay)
+
+	delay = FindPathDelay("/pb33f/cakes/123", &c)
+	assert.Equal(t, 2000, delay)
+
+	delay = FindPathDelay("/roastbeef/test/123", &c)
+	assert.Equal(t, 3000, delay)
+
+	delay = FindPathDelay("/not-registered", &c)
+	assert.Equal(t, 0, delay)
+
+}
diff --git a/controls/controls_service.go b/controls/controls_service.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package controls
 

diff --git a/daemon/api.go b/daemon/api.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package daemon
 

diff --git a/daemon/cors_middleware.go b/daemon/cors_middleware.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package daemon
 

diff --git a/daemon/dto.go b/daemon/dto.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package daemon
 

diff --git a/daemon/handle_request.go b/daemon/handle_request.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package daemon
 
@@ -188,11 +188,16 @@ func (ws *WiretapService) handleHttpRequest(request *model.Request) {
 		}
 	}
 
-	// send response back to client.
-
-	if config.GlobalAPIDelay > 0 {
-		time.Sleep(time.Duration(config.GlobalAPIDelay) * time.Millisecond) // simulate a slow response.
+	// check if this path has a delay set.
+	delay := configModel.FindPathDelay(request.HttpRequest.URL.Path, config)
+	if delay > 0 {
+		time.Sleep(time.Duration(delay) * time.Millisecond) // simulate a slow response, configured for path.
+	} else {
+		if config.GlobalAPIDelay > 0 {
+			time.Sleep(time.Duration(config.GlobalAPIDelay) * time.Millisecond) // simulate a slow response.
+		}
 	}
+
 	body, _ := io.ReadAll(returnedResponse.Body)
 	headers := extractHeaders(returnedResponse)
 

diff --git a/daemon/monitor_static.go b/daemon/monitor_static.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package daemon
 

diff --git a/daemon/validate.go b/daemon/validate.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package daemon
 

diff --git a/daemon/wiretap_broadcast.go b/daemon/wiretap_broadcast.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package daemon
 

diff --git a/daemon/wiretap_init.go b/daemon/wiretap_init.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package daemon
 

diff --git a/daemon/wiretap_service.go b/daemon/wiretap_service.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess Beef Heavy Industries LLC
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package daemon
 

diff --git a/daemon/wiretap_utils.go b/daemon/wiretap_utils.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package daemon
 

diff --git a/daemon/wiretap_utils_test.go b/daemon/wiretap_utils_test.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package daemon
 

diff --git a/report/report_service.go b/report/report_service.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package report
 

diff --git a/shared/config.go b/shared/config.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package shared
 
@@ -33,6 +33,8 @@ type WiretapConfiguration struct {
 	HardErrors          bool                          `json:"hardValidation,omitempty" yaml:"hardValidation,omitempty"`
 	HardErrorCode       int                           `json:"hardValidationCode,omitempty" yaml:"hardValidationCode,omitempty"`
 	HardErrorReturnCode int                           `json:"hardValidationReturnCode,omitempty" yaml:"hardValidationReturnCode,omitempty"`
+	PathDelays          map[string]int                `json:"pathDelays,omitempty" yaml:"pathDelays,omitempty"`
+	CompiledPathDelays  map[string]*CompiledPathDelay `json:"-" yaml:"-"`
 	CompiledVariables   map[string]*CompiledVariable  `json:"-" yaml:"-"`
 	Version             string                        `json:"-" yaml:"-"`
 	StaticPathsCompiled []glob.Glob                   `json:"-" yaml:"-"`
@@ -54,6 +56,17 @@ func (wtc *WiretapConfiguration) CompilePaths() {
 	}
 }
 
+func (wtc *WiretapConfiguration) CompilePathDelays() {
+	wtc.CompiledPathDelays = make(map[string]*CompiledPathDelay)
+	for k, v := range wtc.PathDelays {
+		compiled := &CompiledPathDelay{
+			CompiledPathDelay: glob.MustCompile(wtc.ReplaceWithVariables(k)),
+			PathDelayValue:    v,
+		}
+		wtc.CompiledPathDelays[k] = compiled
+	}
+}
+
 func (wtc *WiretapConfiguration) CompileVariables() {
 	wtc.CompiledVariables = make(map[string]*CompiledVariable)
 	for x := range wtc.Variables {
@@ -92,6 +105,11 @@ type CompiledPath struct {
 	CompiledPathRewrite map[string]*regexp.Regexp
 }
 
+type CompiledPathDelay struct {
+	CompiledPathDelay glob.Glob
+	PathDelayValue    int
+}
+
 type CompiledVariable struct {
 	CompiledVariable *regexp.Regexp
 	VariableValue    string

diff --git a/shared/error.go b/shared/error.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package shared
 

diff --git a/shared/language.go b/shared/language.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package shared
 

diff --git a/specs/spec_service.go b/specs/spec_service.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package specs
 

diff --git a/wiretap.go b/wiretap.go
@@ -1,5 +1,5 @@
 // Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
-// SPDX-License-Identifier: MIT
+// SPDX-License-Identifier: AGPL
 
 package main