feat(ui): Add support for endpoints[].ui.hide-errors to hide errors (#1361)

Supersedes #1292

README.md

@@ -50,6 +50,7 @@ Have any feedback or questions? [Create a discussion](https://github.com/TwiN/ga
   - [Conditions](#conditions)
     - [Placeholders](#placeholders)
     - [Functions](#functions)
+  - [Announcements](#announcements)
   - [Storage](#storage)
   - [Client configuration](#client-configuration)
   - [Tunneling](#tunneling)
@@ -95,7 +96,6 @@ Have any feedback or questions? [Create a discussion](https://github.com/TwiN/ga
     - [Configuring Zulip alerts](#configuring-zulip-alerts)
     - [Configuring custom alerts](#configuring-custom-alerts)
     - [Setting a default alert](#setting-a-default-alert)
-  - [Announcements](#announcements)
   - [Maintenance](#maintenance)
   - [Security](#security)
     - [Basic Authentication](#basic-authentication)
@@ -309,6 +309,7 @@ You can then configure alerts to be triggered when an endpoint is unhealthy once
 | `endpoints[].ui.hide-hostname`                  | Whether to hide the hostname from the results.                                                                                              | `false`                    |
 | `endpoints[].ui.hide-port`                      | Whether to hide the port from the results.                                                                                                  | `false`                    |
 | `endpoints[].ui.hide-url`                       | Whether to hide the URL from the results. Useful if the URL contains a token.                                                               | `false`                    |
+| `endpoints[].ui.hide-errors`                    | Whether to hide errors from the results.                                                                                                    | `false`                    |
 | `endpoints[].ui.dont-resolve-failed-conditions` | Whether to resolve failed conditions for the UI.                                                                                            | `false`                    |
 | `endpoints[].ui.badge.response-time`            | List of response time thresholds. Each time a threshold is reached, the badge has a different color.                                        | `[50, 200, 300, 500, 750]` |
 | `endpoints[].extra-labels`                      | Extra labels to add to the metrics. Useful for grouping endpoints together.                                                                 | `{}`                       |
@@ -1300,7 +1301,7 @@ endpoints:
 ```
 
 
-#### Configuring ilert alerts
+#### Configuring Ilert alerts
 | Parameter                          | Description                                                                                | Default |
 |:-----------------------------------|:-------------------------------------------------------------------------------------------|:--------|
 | `alerting.ilert`                   | Configuration for alerts of type `ilert`                                                   | `{}`    |
@@ -1852,6 +1853,40 @@ endpoints:
 ```
 
 
+#### Configuring SendGrid alerts
+
+> ⚠️ **WARNING**: This alerting provider has not been tested yet. If you've tested it and confirmed that it works, please remove this warning and create a pull request, or comment on [#1223](https://github.com/TwiN/gatus/discussions/1223) with whether the provider works as intended. Thank you for your cooperation.
+
+| Parameter                             | Description                                                                                | Default       |
+|:--------------------------------------|:-------------------------------------------------------------------------------------------|:--------------|
+| `alerting.sendgrid`                   | Configuration for alerts of type `sendgrid`                                                | `{}`          |
+| `alerting.sendgrid.api-key`           | SendGrid API key                                                                           | Required `""` |
+| `alerting.sendgrid.from`              | Email address to send from                                                                 | Required `""` |
+| `alerting.sendgrid.to`                | Email address(es) to send alerts to (comma-separated for multiple recipients)              | Required `""` |
+| `alerting.sendgrid.default-alert`     | Default alert configuration. <br />See [Setting a default alert](#setting-a-default-alert) | N/A           |
+| `alerting.sendgrid.overrides`         | List of overrides that may be prioritized over the default configuration                   | `[]`          |
+| `alerting.sendgrid.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration        | `""`          |
+| `alerting.sendgrid.overrides[].*`     | See `alerting.sendgrid.*` parameters                                                       | `{}`          |
+
+```yaml
+alerting:
+  sendgrid:
+    api-key: "SG.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+    from: "alerts@example.com"
+    to: "admin@example.com,ops@example.com"
+
+endpoints:
+  - name: website
+    url: "https://twin.sh/health"
+    interval: 5m
+    conditions:
+      - "[STATUS] == 200"
+    alerts:
+      - type: sendgrid
+        send-on-resolved: true
+```
+
+
 #### Configuring Signal alerts
 
 > ⚠️ **WARNING**: This alerting provider has not been tested yet. If you've tested it and confirmed that it works, please remove this warning and create a pull request, or comment on [#1223](https://github.com/TwiN/gatus/discussions/1223) with whether the provider works as intended. Thank you for your cooperation.
@@ -1918,40 +1953,6 @@ endpoints:
 ```
 
 
-#### Configuring SendGrid alerts
-
-> ⚠️ **WARNING**: This alerting provider has not been tested yet. If you've tested it and confirmed that it works, please remove this warning and create a pull request, or comment on [#1223](https://github.com/TwiN/gatus/discussions/1223) with whether the provider works as intended. Thank you for your cooperation.
-
-| Parameter                             | Description                                                                                | Default       |
-|:--------------------------------------|:-------------------------------------------------------------------------------------------|:--------------|
-| `alerting.sendgrid`                   | Configuration for alerts of type `sendgrid`                                                | `{}`          |
-| `alerting.sendgrid.api-key`           | SendGrid API key                                                                           | Required `""` |
-| `alerting.sendgrid.from`              | Email address to send from                                                                 | Required `""` |
-| `alerting.sendgrid.to`                | Email address(es) to send alerts to (comma-separated for multiple recipients)              | Required `""` |
-| `alerting.sendgrid.default-alert`     | Default alert configuration. <br />See [Setting a default alert](#setting-a-default-alert) | N/A           |
-| `alerting.sendgrid.overrides`         | List of overrides that may be prioritized over the default configuration                   | `[]`          |
-| `alerting.sendgrid.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration        | `""`          |
-| `alerting.sendgrid.overrides[].*`     | See `alerting.sendgrid.*` parameters                                                       | `{}`          |
-
-```yaml
-alerting:
-  sendgrid:
-    api-key: "SG.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-    from: "alerts@example.com"
-    to: "admin@example.com,ops@example.com"
-
-endpoints:
-  - name: website
-    url: "https://twin.sh/health"
-    interval: 5m
-    conditions:
-      - "[STATUS] == 200"
-    alerts:
-      - type: sendgrid
-        send-on-resolved: true
-```
-
-
 #### Configuring Slack alerts
 | Parameter                          | Description                                                                                | Default                             |
 |:-----------------------------------|:-------------------------------------------------------------------------------------------|:------------------------------------|

client/client_test.go

@@ -131,8 +131,8 @@ func TestPing(t *testing.T) {
 
 func TestCanPerformStartTLS(t *testing.T) {
 	type args struct {
-		address  string
-		insecure bool
+		address     string
+		insecure    bool
 		dnsresolver string
 	}
 	tests := []struct {
@@ -168,7 +168,7 @@ func TestCanPerformStartTLS(t *testing.T) {
 		{
 			name: "dns resolver",
 			args: args{
-				address: "smtp.gmail.com:587",
+				address:     "smtp.gmail.com:587",
 				dnsresolver: "tcp://1.1.1.1:53",
 			},
 			wantConnected: true,
@@ -340,7 +340,7 @@ func TestQueryWebSocket(t *testing.T) {
 }
 
 func TestTlsRenegotiation(t *testing.T) {
-	tests := []struct {
+	scenarios := []struct {
 		name           string
 		cfg            TLSConfig
 		expectedConfig tls.RenegotiationSupport
@@ -371,12 +371,12 @@ func TestTlsRenegotiation(t *testing.T) {
 			expectedConfig: tls.RenegotiateNever,
 		},
 	}
-	for _, test := range tests {
-		t.Run(test.name, func(t *testing.T) {
+	for _, scenario := range scenarios {
+		t.Run(scenario.name, func(t *testing.T) {
 			tls := &tls.Config{}
-			tlsConfig := configureTLS(tls, test.cfg)
-			if tlsConfig.Renegotiation != test.expectedConfig {
-				t.Errorf("expected tls renegotiation to be %v, but got %v", test.expectedConfig, tls.Renegotiation)
+			tlsConfig := configureTLS(tls, scenario.cfg)
+			if tlsConfig.Renegotiation != scenario.expectedConfig {
+				t.Errorf("expected tls renegotiation to be %v, but got %v", scenario.expectedConfig, tls.Renegotiation)
 			}
 		})
 	}
@@ -513,14 +513,11 @@ func TestQueryDNS(t *testing.T) {
 
 func TestCheckSSHBanner(t *testing.T) {
 	cfg := &Config{Timeout: 3}
-
 	t.Run("no-auth-ssh", func(t *testing.T) {
 		connected, status, err := CheckSSHBanner("tty.sdf.org", cfg)
-
 		if err != nil {
 			t.Errorf("Expected: error != nil, got: %v ", err)
 		}
-
 		if connected == false {
 			t.Errorf("Expected: connected == true, got: %v", connected)
 		}
@@ -528,14 +525,11 @@ func TestCheckSSHBanner(t *testing.T) {
 			t.Errorf("Expected: 0, got: %v", status)
 		}
 	})
-
 	t.Run("invalid-address", func(t *testing.T) {
 		connected, status, err := CheckSSHBanner("idontplaytheodds.com", cfg)
-
 		if err == nil {
 			t.Errorf("Expected: error, got: %v ", err)
 		}
-
 		if connected != false {
 			t.Errorf("Expected: connected == false, got: %v", connected)
 		}
@@ -543,5 +537,4 @@ func TestCheckSSHBanner(t *testing.T) {
 			t.Errorf("Expected: 1, got: %v", status)
 		}
 	})
-
 }

config/endpoint/endpoint.go

@@ -353,6 +353,9 @@ func (e *Endpoint) EvaluateHealthWithContext(context *gontext.Gontext) *Result {
 		}
 		result.port = ""
 	}
+	if processedEndpoint.UIConfig.HideErrors {
+		result.Errors = nil
+	}
 	if processedEndpoint.UIConfig.HideConditions {
 		result.ConditionResults = nil
 	}
@@ -498,7 +501,7 @@ func (e *Endpoint) call(result *Result) {
 		result.Duration = time.Since(startTime)
 	} else if endpointType == TypeSSH {
 		// If there's no username/password specified, attempt to validate just the SSH banner
-		if len(e.SSHConfig.Username) == 0 && len(e.SSHConfig.Password) == 0 {
+		if e.SSHConfig == nil || (len(e.SSHConfig.Username) == 0 && len(e.SSHConfig.Password) == 0) {
 			result.Connected, result.HTTPStatus, err = client.CheckSSHBanner(strings.TrimPrefix(e.URL, "ssh://"), e.ClientConfig)
 			if err != nil {
 				result.AddError(err.Error())

config/endpoint/endpoint_test.go

@@ -1448,3 +1448,168 @@ func TestEndpoint_preprocessWithContext(t *testing.T) {
 		})
 	}
 }
+
+func TestEndpoint_HideUIFeatures(t *testing.T) {
+	defer client.InjectHTTPClient(nil)
+	tests := []struct {
+		name              string
+		endpoint          Endpoint
+		mockResponse      test.MockRoundTripper
+		checkHostname     bool
+		expectHostname    string
+		checkErrors       bool
+		expectErrors      bool
+		checkConditions   bool
+		expectConditions  bool
+		checkErrorContent string
+	}{
+		{
+			name: "hide-conditions",
+			endpoint: Endpoint{
+				Name:       "test-endpoint",
+				URL:        "https://example.com/health",
+				Conditions: []Condition{"[STATUS] == 200", "[BODY].status == UP"},
+				UIConfig:   &ui.Config{HideConditions: true},
+			},
+			mockResponse: test.MockRoundTripper(func(r *http.Request) *http.Response {
+				return &http.Response{StatusCode: http.StatusOK, Body: io.NopCloser(bytes.NewBufferString(`{"status": "UP"}`))}
+			}),
+			checkConditions:  true,
+			expectConditions: false,
+		},
+		{
+			name: "hide-hostname",
+			endpoint: Endpoint{
+				Name:       "test-endpoint",
+				URL:        "https://example.com/health",
+				Conditions: []Condition{"[STATUS] == 200"},
+				UIConfig:   &ui.Config{HideHostname: true},
+			},
+			mockResponse: test.MockRoundTripper(func(r *http.Request) *http.Response {
+				return &http.Response{StatusCode: http.StatusOK, Body: http.NoBody}
+			}),
+			checkHostname:  true,
+			expectHostname: "",
+		},
+		{
+			name: "hide-url-in-errors",
+			endpoint: Endpoint{
+				Name:         "test-endpoint",
+				URL:          "https://example.com/health",
+				Conditions:   []Condition{"[CONNECTED] == true"},
+				UIConfig:     &ui.Config{HideURL: true},
+				ClientConfig: &client.Config{Timeout: time.Millisecond},
+			},
+			mockResponse:      nil,
+			checkErrors:       true,
+			expectErrors:      true,
+			checkErrorContent: "<redacted>",
+		},
+		{
+			name: "hide-port-in-errors",
+			endpoint: Endpoint{
+				Name:         "test-endpoint",
+				URL:          "https://example.com:9999/health",
+				Conditions:   []Condition{"[CONNECTED] == true"},
+				UIConfig:     &ui.Config{HidePort: true},
+				ClientConfig: &client.Config{Timeout: time.Millisecond},
+			},
+			mockResponse:      nil,
+			checkErrors:       true,
+			expectErrors:      true,
+			checkErrorContent: "<redacted>",
+		},
+		{
+			name: "hide-errors",
+			endpoint: Endpoint{
+				Name:         "test-endpoint",
+				URL:          "https://example.com/health",
+				Conditions:   []Condition{"[CONNECTED] == true"},
+				UIConfig:     &ui.Config{HideErrors: true},
+				ClientConfig: &client.Config{Timeout: time.Millisecond},
+			},
+			mockResponse: nil,
+			checkErrors:  true,
+			expectErrors: false,
+		},
+		{
+			name: "dont-resolve-failed-conditions",
+			endpoint: Endpoint{
+				Name:       "test-endpoint",
+				URL:        "https://example.com/health",
+				Conditions: []Condition{"[STATUS] == 200"},
+				UIConfig:   &ui.Config{DontResolveFailedConditions: true},
+			},
+			mockResponse: test.MockRoundTripper(func(r *http.Request) *http.Response {
+				return &http.Response{StatusCode: http.StatusBadGateway, Body: http.NoBody}
+			}),
+			checkConditions:  true,
+			expectConditions: true,
+		},
+		{
+			name: "multiple-hide-features",
+			endpoint: Endpoint{
+				Name:       "test-endpoint",
+				URL:        "https://example.com/health",
+				Conditions: []Condition{"[STATUS] == 200"},
+				UIConfig:   &ui.Config{HideConditions: true, HideHostname: true, HideErrors: true},
+			},
+			mockResponse: test.MockRoundTripper(func(r *http.Request) *http.Response {
+				return &http.Response{StatusCode: http.StatusOK, Body: http.NoBody}
+			}),
+			checkConditions:  true,
+			expectConditions: false,
+			checkHostname:    true,
+			expectHostname:   "",
+			checkErrors:      true,
+			expectErrors:     false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if tt.mockResponse != nil {
+				mockClient := &http.Client{Transport: tt.mockResponse}
+				if tt.endpoint.ClientConfig != nil && tt.endpoint.ClientConfig.Timeout > 0 {
+					mockClient.Timeout = tt.endpoint.ClientConfig.Timeout
+				}
+				client.InjectHTTPClient(mockClient)
+			} else {
+				client.InjectHTTPClient(nil)
+			}
+			err := tt.endpoint.ValidateAndSetDefaults()
+			if err != nil {
+				t.Fatalf("ValidateAndSetDefaults failed: %v", err)
+			}
+			result := tt.endpoint.EvaluateHealth()
+			if tt.checkHostname {
+				if result.Hostname != tt.expectHostname {
+					t.Errorf("Expected hostname '%s', got '%s'", tt.expectHostname, result.Hostname)
+				}
+			}
+			if tt.checkErrors {
+				hasErrors := len(result.Errors) > 0
+				if hasErrors != tt.expectErrors {
+					t.Errorf("Expected errors=%v, got errors=%v (actual errors: %v)", tt.expectErrors, hasErrors, result.Errors)
+				}
+				if tt.checkErrorContent != "" && len(result.Errors) > 0 {
+					found := false
+					for _, err := range result.Errors {
+						if strings.Contains(err, tt.checkErrorContent) {
+							found = true
+							break
+						}
+					}
+					if !found {
+						t.Errorf("Expected error to contain '%s', but got: %v", tt.checkErrorContent, result.Errors)
+					}
+				}
+			}
+			if tt.checkConditions {
+				hasConditions := result.ConditionResults != nil && len(result.ConditionResults) > 0
+				if hasConditions != tt.expectConditions {
+					t.Errorf("Expected conditions=%v, got conditions=%v (actual: %v)", tt.expectConditions, hasConditions, result.ConditionResults)
+				}
+			}
+		})
+	}
+}

config/endpoint/ui/ui.go

@@ -16,6 +16,9 @@ type Config struct {
 	// HidePort whether to hide the port in the Result
 	HidePort bool `yaml:"hide-port"`
 
+	// HideErrors whether to hide the errors in the Result
+	HideErrors bool `yaml:"hide-errors"`
+
 	// DontResolveFailedConditions whether to resolve failed conditions in the Result for display in the UI
 	DontResolveFailedConditions bool `yaml:"dont-resolve-failed-conditions"`
 
@@ -58,6 +61,7 @@ func GetDefaultConfig() *Config {
 		HideHostname:                false,
 		HideURL:                     false,
 		HidePort:                    false,
+		HideErrors:                  false,
 		DontResolveFailedConditions: false,
 		HideConditions:              false,
 		Badge: &Badge{

web/app/src/App.vue

@@ -197,13 +197,12 @@ const buttons = computed(() => {
 const fetchConfig = async () => {
   try {
     const response = await fetch(`${SERVER_URL}/api/v1/config`, { credentials: 'include' })
-    retrievedConfig.value = true
-    
     if (response.status === 200) {
       const data = await response.json()
       config.value = data
       announcements.value = data.announcements || []
     }
+    retrievedConfig.value = true
   } catch (error) {
     console.error('Failed to fetch config:', error)
     retrievedConfig.value = true