[TT-10070] Fix/sanitize error logging (TykTechnologies#6817)

### **User description**
https://tyktech.atlassian.net/browse/TT-10070


___

### **PR Type**
Bug fix, Enhancement


___

### **Description**
- Removed unnecessary PID file reading and improved PID handling.

- Enhanced Redis connection handling with explicit connect calls.

- Improved webhook validation by checking for empty target paths.

- Added test adjustments and cleanup for PID-related functionality.


___



### **Changes walkthrough** 📝
<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Enhancement</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>config.go</strong><dd><code>Add default PID file
location configuration</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

config/config.go

- Added a default `PIDFileLocation` configuration.


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/6817/files#diff-fe44f09c4d5977b5f5eaea29170b6a0748819c9d02271746a20d81a5f3efca17">+1/-0</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

<tr>
  <td>
    <details>
<summary><strong>server.go</strong><dd><code>Improve Redis connections
and PID handling</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

gateway/server.go

<li>Added explicit Redis connection calls across multiple instances.<br>
<li> Improved PID handling by removing unnecessary file reads.<br> <li>
Enhanced storage connection initialization with timeout handling.<br>
<li> Refactored PID-related logic for clarity and reliability.


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/6817/files#diff-4652d1bf175a0be8f5e61ef7177c9666f23e077d8626b73ac9d13358fa8b525b">+41/-26</a>&nbsp;
</td>

</tr>
</table></td></tr><tr><td><strong>Bug fix</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>api_loader.go</strong><dd><code>Skip mTLS warning when
running tests</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

gateway/api_loader.go

- Added a check to skip mTLS warning during tests.


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/6817/files#diff-cdf0b7f176c9d18e1a314b78ddefc2cb3a94b3de66f1f360174692c915734c68">+2/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>

<tr>
  <td>
    <details>
<summary><strong>event_handler_webhooks.go</strong><dd><code>Improve
webhook validation and URL checks</code>&nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; </dd></summary>
<hr>

gateway/event_handler_webhooks.go

<li>Added validation for empty webhook target paths.<br> <li> Ensured
URLs are not empty before parsing.


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/6817/files#diff-6587ad3f2629cfa6c84a71144127acd6cc7824e5141f0b4961848945a87e0198">+4/-1</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>
</table></td></tr><tr><td><strong>Tests</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>server_test.go</strong><dd><code>Update tests for PID
handling changes</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

gateway/server_test.go

<li>Removed references to <code>readPIDFromFile</code> in tests.<br>
<li> Adjusted test setup to align with new PID handling logic.


</details>


  </td>
<td><a
href="https://github.com/TykTechnologies/tyk/pull/6817/files#diff-d9f006370c9748c09affd99d0a4edeb8f3419057703a67fd70838a764a485696">+6/-6</a>&nbsp;
&nbsp; &nbsp; </td>

</tr>
</table></td></tr></tr></tbody></table>

___

> 💡 **PR-Agent usage**: Comment `/help "your question"` on any pull
request to receive relevant information

---------

Co-authored-by: Tit Petric <tit@tyk.io>

Author: titpetric

config/config.go

@@ -56,6 +56,7 @@ var (
 			Enabled:     false,
 			AllowUnsafe: []string{},
 		},
+		PIDFileLocation: "/var/run/tyk/tyk-gateway.pid",
 	}
 )
 

gateway/api.go

@@ -2236,13 +2236,16 @@ func (gw *Gateway) createOauthClient(w http.ResponseWriter, r *http.Request) {
 					storageManager := gw.getGlobalMDCBStorageHandler(prefix, false)
 					storageManager.Connect()
 
+					storageDriver := &storage.RedisCluster{KeyPrefix: prefix, HashKeys: false, ConnectionHandler: gw.StorageConnectionHandler}
+					storageDriver.Connect()
+
 					apiSpec.OAuthManager = &OAuthManager{
 						OsinServer: gw.TykOsinNewServer(
 							&osin.ServerConfig{},
 							&RedisOsinStorageInterface{
 								storageManager,
 								gw.GlobalSessionManager,
-								&storage.RedisCluster{KeyPrefix: prefix, HashKeys: false, ConnectionHandler: gw.StorageConnectionHandler},
+								storageDriver,
 								apiSpec.OrgID,
 								gw,
 							}),
@@ -2623,12 +2626,16 @@ func (gw *Gateway) getOauthClientDetails(keyName, apiID string) (interface{}, in
 		prefix := generateOAuthPrefix(apiSpec.APIID)
 		storageManager := gw.getGlobalMDCBStorageHandler(prefix, false)
 		storageManager.Connect()
+
+		storageDriver := &storage.RedisCluster{KeyPrefix: prefix, HashKeys: false, ConnectionHandler: gw.StorageConnectionHandler}
+		storageDriver.Connect()
+
 		apiSpec.OAuthManager = &OAuthManager{
 			OsinServer: gw.TykOsinNewServer(&osin.ServerConfig{},
 				&RedisOsinStorageInterface{
 					storageManager,
 					gw.GlobalSessionManager,
-					&storage.RedisCluster{KeyPrefix: prefix, HashKeys: false, ConnectionHandler: gw.StorageConnectionHandler},
+					storageDriver,
 					apiSpec.OrgID,
 					gw,
 				}),

gateway/api_loader.go

@@ -45,9 +45,16 @@ type ChainObject struct {
 
 func (gw *Gateway) prepareStorage() generalStores {
 	var gs generalStores
+
 	gs.redisStore = &storage.RedisCluster{KeyPrefix: "apikey-", HashKeys: gw.GetConfig().HashKeys, ConnectionHandler: gw.StorageConnectionHandler}
+	gs.redisStore.Connect()
+
 	gs.redisOrgStore = &storage.RedisCluster{KeyPrefix: "orgkey.", ConnectionHandler: gw.StorageConnectionHandler}
+	gs.redisOrgStore.Connect()
+
 	gs.healthStore = &storage.RedisCluster{KeyPrefix: "apihealth.", ConnectionHandler: gw.StorageConnectionHandler}
+	gs.healthStore.Connect()
+
 	gs.rpcAuthStore = &RPCStorageHandler{KeyPrefix: "apikey-", HashKeys: gw.GetConfig().HashKeys, Gw: gw}
 	gs.rpcOrgStore = gw.getGlobalMDCBStorageHandler("orgkey.", false)
 
@@ -56,7 +63,6 @@ func (gw *Gateway) prepareStorage() generalStores {
 }
 
 func (gw *Gateway) skipSpecBecauseInvalid(spec *APISpec, logger *logrus.Entry) bool {
-
 	switch spec.Protocol {
 	case "", "http", "https":
 		if spec.Proxy.ListenPath == "" {
@@ -1064,7 +1070,8 @@ func (gw *Gateway) loadApps(specs []*APISpec) {
 
 	gwListenPort := gw.GetConfig().ListenPort
 	controlApiIsConfigured := (gw.GetConfig().ControlAPIPort != 0 && gw.GetConfig().ControlAPIPort != gwListenPort) || gw.GetConfig().ControlAPIHostname != ""
-	if gw.allApisAreMTLS() && !gw.GetConfig().Security.ControlAPIUseMutualTLS && !controlApiIsConfigured {
+
+	if !gw.isRunningTests() && gw.allApisAreMTLS() && !gw.GetConfig().Security.ControlAPIUseMutualTLS && !controlApiIsConfigured {
 		mainLog.Warning("All APIs are protected with mTLS, except for the control API. " +
 			"We recommend configuring the control API port or control hostname to ensure consistent security measures")
 	}

gateway/coprocess_api.go

@@ -16,13 +16,15 @@ import (
 // CoProcessDefaultKeyPrefix is used as a key prefix for this CP.
 const CoProcessDefaultKeyPrefix = "coprocess-data:"
 
-func getStorageForPython(ctx context.Context) storage.RedisCluster {
+func getStorageForPython(ctx context.Context) *storage.RedisCluster {
 	rc := storage.NewConnectionHandler(ctx)
 
 	go rc.Connect(ctx, nil, &config.Config{})
 	rc.WaitConnect(ctx)
 
-	return storage.RedisCluster{KeyPrefix: CoProcessDefaultKeyPrefix, ConnectionHandler: rc}
+	handler := &storage.RedisCluster{KeyPrefix: CoProcessDefaultKeyPrefix, ConnectionHandler: rc}
+	handler.Connect()
+	return handler
 }
 
 // TykStoreData is a CoProcess API function for storing data.

gateway/coprocess_id_extractor_test.go

@@ -31,19 +31,27 @@ const (
 
 func (ts *Test) createSpecTestFrom(tb testing.TB, def *apidef.APIDefinition) *APISpec {
 	tb.Helper()
+
 	loader := APIDefinitionLoader{Gw: ts.Gw}
 	spec, _ := loader.MakeSpec(&model.MergedAPI{APIDefinition: def}, nil)
 	tname := tb.Name()
+
 	redisStore := &storage.RedisCluster{KeyPrefix: tname + "-apikey.", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+	redisStore.Connect()
+
 	healthStore := &storage.RedisCluster{KeyPrefix: tname + "-apihealth.", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+	healthStore.Connect()
+
 	orgStore := &storage.RedisCluster{KeyPrefix: tname + "-orgKey.", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+	orgStore.Connect()
+
 	spec.Init(redisStore, redisStore, healthStore, orgStore)
 	return spec
 }
 
-func (ts *Test) prepareExtractor(tb testing.TB, extractorSource apidef.IdExtractorSource, extractorType apidef.IdExtractorType,
-	config map[string]interface{}, disabled bool) (IdExtractor, *APISpec) {
+func (ts *Test) prepareExtractor(tb testing.TB, extractorSource apidef.IdExtractorSource, extractorType apidef.IdExtractorType, config map[string]interface{}, disabled bool) (IdExtractor, *APISpec) {
 	tb.Helper()
+
 	def := &apidef.APIDefinition{
 		OrgID: MockOrgID,
 		CustomMiddleware: apidef.MiddlewareSection{

gateway/delete_api_cache.go

@@ -8,5 +8,7 @@ import (
 
 func (gw *Gateway) invalidateAPICache(apiID string) bool {
 	store := storage.RedisCluster{IsCache: true, ConnectionHandler: gw.StorageConnectionHandler}
+	store.Connect()
+
 	return store.DeleteScanMatch(fmt.Sprintf("cache-%s*", apiID))
 }

gateway/event_handler_webhooks.go

@@ -161,9 +161,14 @@ func (w *WebHookHandler) getRequestMethod(m string) WebHookRequestMethod {
 }
 
 func (w *WebHookHandler) checkURL(r string) bool {
+	if r == "" {
+		return false
+	}
+
 	log.WithFields(logrus.Fields{
 		"prefix": "webhooks",
 	}).Debug("Checking URL: ", r)
+
 	if _, err := url.ParseRequestURI(r); err != nil {
 		log.WithFields(logrus.Fields{
 			"prefix": "webhooks",

gateway/gateway_test.go

@@ -889,7 +889,10 @@ func TestCacheAllSafeRequests(t *testing.T) {
 	t.Skip() // DeleteScanMatch interferes with other tests.
 
 	ts := StartTest(nil)
+
 	cache := storage.RedisCluster{KeyPrefix: "cache-", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+	cache.Connect()
+
 	t.Cleanup(func() {
 		ts.Close()
 		cache.DeleteScanMatch("*")
@@ -919,7 +922,10 @@ func TestCacheAllSafeRequestsWithCachedHeaders(t *testing.T) {
 	t.Skip() // DeleteScanMatch interferes with other tests.
 
 	ts := StartTest(nil)
+
 	cache := storage.RedisCluster{KeyPrefix: "cache-", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+	cache.Connect()
+
 	t.Cleanup(func() {
 		ts.Close()
 		cache.DeleteScanMatch("*")
@@ -965,7 +971,10 @@ func TestCacheWithAdvanceUrlRewrite(t *testing.T) {
 	t.Skip() // DeleteScanMatch interferes with other tests.
 
 	ts := StartTest(nil)
+
 	cache := storage.RedisCluster{KeyPrefix: "cache-", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+	cache.Connect()
+
 	t.Cleanup(func() {
 		ts.Close()
 		cache.DeleteScanMatch("*")
@@ -1024,7 +1033,10 @@ func TestCachePostRequest(t *testing.T) {
 	t.Skip() // DeleteScanMatch interferes with other tests.
 
 	ts := StartTest(nil)
+
 	cache := storage.RedisCluster{KeyPrefix: "cache-", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+	cache.Connect()
+
 	t.Cleanup(func() {
 		ts.Close()
 		cache.DeleteScanMatch("*")
@@ -1071,7 +1083,10 @@ func TestAdvanceCachePutRequest(t *testing.T) {
 	t.Skip() // DeleteScanMatch interferes with other tests.
 
 	ts := StartTest(nil)
+
 	cache := storage.RedisCluster{KeyPrefix: "cache-", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+	cache.Connect()
+
 	t.Cleanup(func() {
 		ts.Close()
 		cache.DeleteScanMatch("*")
@@ -1164,7 +1179,10 @@ func TestCacheAllSafeRequestsWithAdvancedCacheEndpoint(t *testing.T) {
 	t.Skip() // DeleteScanMatch interferes with other tests.
 
 	ts := StartTest(nil)
+
 	cache := storage.RedisCluster{KeyPrefix: "cache-", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+	cache.Connect()
+
 	t.Cleanup(func() {
 		ts.Close()
 		cache.DeleteScanMatch("*")
@@ -1203,7 +1221,9 @@ func TestCacheEtag(t *testing.T) {
 	t.Skip() // DeleteScanMatch interferes with other tests.
 
 	ts := StartTest(nil)
+
 	cache := storage.RedisCluster{KeyPrefix: "cache-", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+	cache.Connect()
 
 	t.Cleanup(func() {
 		ts.Close()
@@ -1258,7 +1278,10 @@ func TestOldCachePlugin(t *testing.T) {
 		t.Helper()
 
 		ts := StartTest(nil)
+
 		cache := storage.RedisCluster{KeyPrefix: "cache-", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+		cache.Connect()
+
 		t.Cleanup(func() {
 			ts.Close()
 			cache.DeleteScanMatch("*")
@@ -1287,7 +1310,10 @@ func TestAdvanceCacheTimeoutPerEndpoint(t *testing.T) {
 	t.Skip() // DeleteScanMatch interferes with other tests.
 
 	ts := StartTest(nil)
+
 	cache := storage.RedisCluster{KeyPrefix: "cache-", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+	cache.Connect()
+
 	t.Cleanup(func() {
 		ts.Close()
 		cache.DeleteScanMatch("*")

gateway/health_check.go

@@ -79,6 +79,7 @@ func (gw *Gateway) gatherHealthChecks() {
 	allInfos := SafeHealthCheck{info: make(map[string]HealthCheckItem, 3)}
 
 	redisStore := storage.RedisCluster{KeyPrefix: "livenesscheck-", ConnectionHandler: gw.StorageConnectionHandler}
+	redisStore.Connect()
 
 	key := "tyk-liveness-probe"
 

gateway/host_checker.go

@@ -398,6 +398,10 @@ func eraseSyncMap(m *sync.Map) {
 }
 
 func (h *HostUptimeChecker) Stop() {
+	if h == nil {
+		return
+	}
+
 	was := atomic.SwapInt32(&h.isClosed, CLOSED)
 	if was == OPEN {
 		eraseSyncMap(h.samples)

gateway/host_checker_manager.go

@@ -82,7 +82,7 @@ func (hc *HostCheckerManager) Init(store storage.Handler) {
 
 func (hc *HostCheckerManager) Start(ctx context.Context) {
 	// Start loop to check if we are active instance
-	if hc.Id != "" {
+	if hc != nil {
 		go hc.CheckActivePollerLoop(ctx)
 	}
 }
@@ -181,7 +181,6 @@ func (hc *HostCheckerManager) AmIPolling() bool {
 }
 
 func (hc *HostCheckerManager) StartPoller(ctx context.Context) {
-
 	log.WithFields(logrus.Fields{
 		"prefix": "host-check-mgr",
 	}).Debug("---> Initialising checker")
@@ -192,7 +191,8 @@ func (hc *HostCheckerManager) StartPoller(ctx context.Context) {
 		hc.checker = &HostUptimeChecker{Gw: hc.Gw}
 	}
 
-	hc.checker.Init(hc.Gw.GetConfig().UptimeTests.Config.CheckerPoolSize,
+	hc.checker.Init(
+		hc.Gw.GetConfig().UptimeTests.Config.CheckerPoolSize,
 		hc.Gw.GetConfig().UptimeTests.Config.FailureTriggerSampleSize,
 		hc.Gw.GetConfig().UptimeTests.Config.TimeWait,
 		hc.currentHostList,
@@ -207,14 +207,21 @@ func (hc *HostCheckerManager) StartPoller(ctx context.Context) {
 	log.WithFields(logrus.Fields{
 		"prefix": "host-check-mgr",
 	}).Debug("---> Starting checker")
+
 	hc.checker.Start(ctx)
+
 	log.WithFields(logrus.Fields{
 		"prefix": "host-check-mgr",
 	}).Debug("---> Checker started.")
+
 	hc.checkerMu.Unlock()
 }
 
 func (hc *HostCheckerManager) StopPoller() {
+	if hc == nil {
+		return
+	}
+
 	hc.checkerMu.Lock()
 	hc.checker.Stop()
 	hc.checkerMu.Unlock()
@@ -536,11 +543,11 @@ func (hc *HostCheckerManager) RecordUptimeAnalytics(report HostHealthReport) err
 
 func (gw *Gateway) InitHostCheckManager(ctx context.Context, store storage.Handler) {
 	// Already initialized
-	if gw.GlobalHostChecker.Id != "" {
+	if gw.GlobalHostChecker != nil {
 		return
 	}
 
-	gw.GlobalHostChecker = HostCheckerManager{Gw: gw}
+	gw.GlobalHostChecker = &HostCheckerManager{Gw: gw}
 	gw.GlobalHostChecker.Init(store)
 	gw.GlobalHostChecker.Start(ctx)
 }

gateway/host_checker_manager_test.go

@@ -14,7 +14,10 @@ func TestHostCheckerManagerInit(t *testing.T) {
 	defer ts.Close()
 
 	hc := HostCheckerManager{Gw: ts.Gw}
+
 	redisStorage := &storage.RedisCluster{KeyPrefix: "host-checker-test:", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+	redisStorage.Connect()
+
 	hc.Init(redisStorage)
 
 	if hc.Id == "" {
@@ -46,6 +49,8 @@ func TestAmIPolling(t *testing.T) {
 	ts.Gw.SetConfig(globalConf)
 
 	redisStorage := &storage.RedisCluster{KeyPrefix: "host-checker-test:", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+	redisStorage.Connect()
+
 	hc.Init(redisStorage)
 	hc2 := HostCheckerManager{Gw: ts.Gw}
 	hc2.Init(redisStorage)
@@ -74,7 +79,10 @@ func TestAmIPolling(t *testing.T) {
 
 	//Testing if the PollerCacheKey doesn't contains the poller_group by default
 	hc = HostCheckerManager{Gw: ts.Gw}
+
 	redisStorage = &storage.RedisCluster{KeyPrefix: "host-checker-test:", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+	redisStorage.Connect()
+
 	hc.Init(redisStorage)
 	hc.AmIPolling()
 
@@ -106,7 +114,10 @@ func TestCheckActivePollerLoop(t *testing.T) {
 	defer ts.Close()
 
 	hc := &HostCheckerManager{Gw: ts.Gw}
+
 	redisStorage := &storage.RedisCluster{KeyPrefix: "host-checker-test-1:", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+	redisStorage.Connect()
+
 	hc.Init(redisStorage)
 
 	go hc.CheckActivePollerLoop(ts.Gw.ctx)
@@ -122,7 +133,10 @@ func TestStartPoller(t *testing.T) {
 	defer ts.Close()
 
 	hc := HostCheckerManager{Gw: ts.Gw}
+
 	redisStorage := &storage.RedisCluster{KeyPrefix: "host-checker-TestStartPoller:", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+	redisStorage.Connect()
+
 	hc.Init(redisStorage)
 
 	hc.StartPoller(ts.Gw.ctx)
@@ -135,9 +149,12 @@ func TestStartPoller(t *testing.T) {
 func TestRecordUptimeAnalytics(t *testing.T) {
 	ts := StartTest(nil)
 	defer ts.Close()
+
 	hc := &HostCheckerManager{Gw: ts.Gw}
 
 	redisStorage := &storage.RedisCluster{KeyPrefix: "host-checker-test-analytics:", ConnectionHandler: ts.Gw.StorageConnectionHandler}
+	redisStorage.Connect()
+
 	hc.Init(redisStorage)
 
 	spec := &APISpec{}