feat(config): Fix storage config naming and code cleanup

README.md

@@ -296,14 +296,14 @@ Here are some examples of conditions you can use:
 
 
 ### Storage
-| Parameter                        | Description                                                                                                                                        | Default    |
-|:---------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:-----------|
-| `storage`                        | Storage configuration                                                                                                                              | `{}`       |
-| `storage.path`                   | Path to persist the data in. Only supported for types `sqlite` and `postgres`.                                                                     | `""`       |
-| `storage.type`                   | Type of storage. Valid types: `memory`, `sqlite`, `postgres`.                                                                                      | `"memory"` |
-| `storage.caching`                | Whether to use write-through caching. Improves loading time for large dashboards. <br />Only supported if `storage.type` is `sqlite` or `postgres` | `false`    |
-| `storage.maximumNumberOfResults` | The maximum number of results that an endpoint can have                                                                                            | `100`      |
-| `storage.maximumNumberOfEvents`  | The maximum number of events that an endpoint can have                                                                                             | `50`       |
+| Parameter                           | Description                                                                                                                                        | Default    |
+|:------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:-----------|
+| `storage`                           | Storage configuration                                                                                                                              | `{}`       |
+| `storage.path`                      | Path to persist the data in. Only supported for types `sqlite` and `postgres`.                                                                     | `""`       |
+| `storage.type`                      | Type of storage. Valid types: `memory`, `sqlite`, `postgres`.                                                                                      | `"memory"` |
+| `storage.caching`                   | Whether to use write-through caching. Improves loading time for large dashboards. <br />Only supported if `storage.type` is `sqlite` or `postgres` | `false`    |
+| `storage.maximum-number-of-results` | The maximum number of results that an endpoint can have                                                                                            | `100`      |
+| `storage.maximum-number-of-events`  | The maximum number of events that an endpoint can have                                                                                             | `50`       |
 
 The results for each endpoint health check as well as the data for uptime and the past events must be persisted
 so that they can be displayed on the dashboard. These parameters allow you to configure the storage in question.

config/config_test.go

@@ -303,8 +303,8 @@ func TestParseAndValidateConfigBytes(t *testing.T) {
 storage:
   type: sqlite
   path: %s
-  maximumNumberOfResults: 10
-  maximumNumberOfEvents: 5
+  maximum-number-of-results: 10
+  maximum-number-of-events: 5
 maintenance:
   enabled: true
   start: 00:00

config/ui/ui.go

@@ -3,9 +3,9 @@ package ui
 import (
 	"bytes"
 	"errors"
-	"github.com/TwiN/gatus/v5/storage"
 	"html/template"
 
+	"github.com/TwiN/gatus/v5/storage"
 	static "github.com/TwiN/gatus/v5/web"
 )
 

controller/handler/endpoint_status.go

@@ -31,7 +31,7 @@ var (
 // Due to how intensive this operation can be on the storage, this function leverages a cache.
 func EndpointStatuses(cfg *config.Config) http.HandlerFunc {
 	return func(writer http.ResponseWriter, r *http.Request) {
-		page, pageSize := extractPageAndPageSizeFromRequest(r, cfg)
+		page, pageSize := extractPageAndPageSizeFromRequest(r, cfg.Storage.MaximumNumberOfResults)
 		value, exists := cache.Get(fmt.Sprintf("endpoint-status-%d-%d", page, pageSize))
 		var data []byte
 		if !exists {
@@ -100,7 +100,7 @@ func getEndpointStatusesFromRemoteInstances(remoteConfig *remote.Config) ([]*cor
 // EndpointStatus retrieves a single core.EndpointStatus by group and endpoint name
 func EndpointStatus(cfg *config.Config) http.HandlerFunc {
 	return func(writer http.ResponseWriter, r *http.Request) {
-		page, pageSize := extractPageAndPageSizeFromRequest(r, cfg)
+		page, pageSize := extractPageAndPageSizeFromRequest(r, cfg.Storage.MaximumNumberOfResults)
 		vars := mux.Vars(r)
 		endpointStatus, err := store.Get().GetEndpointStatusByKey(vars["key"], paging.NewEndpointStatusParams().WithResults(page, pageSize).WithEvents(1, cfg.Storage.MaximumNumberOfEvents))
 		if err != nil {

controller/handler/endpoint_status_test.go

@@ -1,14 +1,14 @@
 package handler
 
 import (
-	"github.com/TwiN/gatus/v5/storage"
 	"net/http"
 	"net/http/httptest"
 	"testing"
 	"time"
 
 	"github.com/TwiN/gatus/v5/config"
 	"github.com/TwiN/gatus/v5/core"
+	"github.com/TwiN/gatus/v5/storage"
 	"github.com/TwiN/gatus/v5/storage/store"
 	"github.com/TwiN/gatus/v5/watchdog"
 )

controller/handler/util.go

@@ -1,7 +1,6 @@
 package handler
 
 import (
-	"github.com/TwiN/gatus/v5/config"
 	"net/http"
 	"strconv"
 )
@@ -14,7 +13,7 @@ const (
 	DefaultPageSize = 20
 )
 
-func extractPageAndPageSizeFromRequest(r *http.Request, cfg *config.Config) (page int, pageSize int) {
+func extractPageAndPageSizeFromRequest(r *http.Request, maximumNumberOfResults int) (page int, pageSize int) {
 	var err error
 	if pageParameter := r.URL.Query().Get("page"); len(pageParameter) == 0 {
 		page = DefaultPage
@@ -34,8 +33,8 @@ func extractPageAndPageSizeFromRequest(r *http.Request, cfg *config.Config) (pag
 		if err != nil {
 			pageSize = DefaultPageSize
 		}
-		if pageSize > cfg.Storage.MaximumNumberOfResults {
-			pageSize = cfg.Storage.MaximumNumberOfResults
+		if pageSize > maximumNumberOfResults {
+			pageSize = maximumNumberOfResults
 		} else if pageSize < 1 {
 			pageSize = DefaultPageSize
 		}

controller/handler/util_test.go

@@ -2,10 +2,11 @@ package handler
 
 import (
 	"fmt"
-	"github.com/TwiN/gatus/v5/config"
-	"github.com/TwiN/gatus/v5/storage"
 	"net/http"
 	"testing"
+
+	"github.com/TwiN/gatus/v5/config"
+	"github.com/TwiN/gatus/v5/storage"
 )
 
 func TestExtractPageAndPageSizeFromRequest(t *testing.T) {
@@ -62,7 +63,7 @@ func TestExtractPageAndPageSizeFromRequest(t *testing.T) {
 	for _, scenario := range scenarios {
 		t.Run("page-"+scenario.Page+"-pageSize-"+scenario.PageSize, func(t *testing.T) {
 			request, _ := http.NewRequest("GET", fmt.Sprintf("/api/v1/statuses?page=%s&pageSize=%s", scenario.Page, scenario.PageSize), http.NoBody)
-			actualPage, actualPageSize := extractPageAndPageSizeFromRequest(request, cfg)
+			actualPage, actualPageSize := extractPageAndPageSizeFromRequest(request, cfg.Storage.MaximumNumberOfResults)
 			if actualPage != scenario.ExpectedPage {
 				t.Errorf("expected %d, got %d", scenario.ExpectedPage, actualPage)
 			}

storage/config.go

@@ -32,10 +32,10 @@ type Config struct {
 	Caching bool `yaml:"caching,omitempty"`
 
 	// MaximumNumberOfResults is the maximum number of results that an endpoint can have
-	MaximumNumberOfResults int `yaml:"maximumNumberOfResults,omitempty"`
+	MaximumNumberOfResults int `yaml:"maximum-number-of-results,omitempty"`
 
 	// MaximumNumberOfEvents is the maximum number of events that an endpoint can have
-	MaximumNumberOfEvents int `yaml:"maximumNumberOfEvents,omitempty"`
+	MaximumNumberOfEvents int `yaml:"maximum-number-of-events,omitempty"`
 }
 
 // ValidateAndSetDefaults validates the configuration and sets the default values (if applicable)

storage/store/memory/util_test.go

@@ -1,11 +1,11 @@
 package memory
 
 import (
-	"github.com/TwiN/gatus/v5/storage"
 	"testing"
 	"time"
 
 	"github.com/TwiN/gatus/v5/core"
+	"github.com/TwiN/gatus/v5/storage"
 	"github.com/TwiN/gatus/v5/storage/store/common/paging"
 )