YakumoLabs/gatus
4
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(storage): resolve race condition in memory store (#1270)

Browse Source 
* fix(storage): resolve race condition in memory store

* fix: resolve variable shadowing in CopyEndpointStatus

* fix: update test files to use CopyEndpointStatus function
This commit is contained in:
TwiN
2025-09-17 08:43:11 -04:00
committed by GitHub
parent 37ba305c34
commit 83c4fac217
4 changed files with 38 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
storage/store/memory/memory.go
View File

@@ -49,7 +49,7 @@ func (s *Store) GetAllEndpointStatuses(params *paging.EndpointStatusParams) ([]*
pagedEndpointStatuses := make([]*endpoint.Status, 0, len(allStatuses)) pagedEndpointStatuses := make([]*endpoint.Status, 0, len(allStatuses))
for _, v := range allStatuses { for _, v := range allStatuses {
if status, ok := v.(*endpoint.Status); ok { if status, ok := v.(*endpoint.Status); ok {
pagedEndpointStatuses = append(pagedEndpointStatuses, ShallowCopyEndpointStatus(status, params)) pagedEndpointStatuses = append(pagedEndpointStatuses, CopyEndpointStatus(status, params))
} }
} }
sort.Slice(pagedEndpointStatuses, func(i, j int) bool { sort.Slice(pagedEndpointStatuses, func(i, j int) bool {
@@ -87,7 +87,7 @@ func (s *Store) GetEndpointStatusByKey(key string, params *paging.EndpointStatus
if endpointStatus == nil { if endpointStatus == nil {
return nil, common.ErrEndpointNotFound return nil, common.ErrEndpointNotFound
} }
return ShallowCopyEndpointStatus(endpointStatus.(*endpoint.Status), params), nil return CopyEndpointStatus(endpointStatus.(*endpoint.Status), params), nil
} }
// GetSuiteStatusByKey returns the suite status for a given key // GetSuiteStatusByKey returns the suite status for a given key

34
storage/store/memory/util.go
View File

@@ -6,35 +6,47 @@ import (
"github.com/TwiN/gatus/v5/storage/store/common/paging" "github.com/TwiN/gatus/v5/storage/store/common/paging"
) )
// ShallowCopyEndpointStatus returns a shallow copy of a Status with only the results // CopyEndpointStatus returns a safe copy of a Status with only the results
// within the range defined by the page and pageSize parameters // within the range defined by the page and pageSize parameters.
func ShallowCopyEndpointStatus(ss *endpoint.Status, params *paging.EndpointStatusParams) *endpoint.Status { // This function performs deep copying of slices to prevent race conditions
shallowCopy := &endpoint.Status{ // when the original slice is modified concurrently.
func CopyEndpointStatus(ss *endpoint.Status, params *paging.EndpointStatusParams) *endpoint.Status {
statusCopy := &endpoint.Status{
Name: ss.Name, Name: ss.Name,
Group: ss.Group, Group: ss.Group,
Key: ss.Key, Key: ss.Key,
Uptime: endpoint.NewUptime(), Uptime: endpoint.NewUptime(),
} }
if params == nil || (params.ResultsPage == 0 && params.ResultsPageSize == 0 && params.EventsPage == 0 && params.EventsPageSize == 0) { if params == nil || (params.ResultsPage == 0 && params.ResultsPageSize == 0 && params.EventsPage == 0 && params.EventsPageSize == 0) {
shallowCopy.Results = ss.Results // Deep copy all results to prevent race conditions
shallowCopy.Events = ss.Events statusCopy.Results = make([]*endpoint.Result, len(ss.Results))
copy(statusCopy.Results, ss.Results)
// Deep copy all events to prevent race conditions
statusCopy.Events = make([]*endpoint.Event, len(ss.Events))
copy(statusCopy.Events, ss.Events)
} else { } else {
numberOfResults := len(ss.Results) numberOfResults := len(ss.Results)
resultsStart, resultsEnd := getStartAndEndIndex(numberOfResults, params.ResultsPage, params.ResultsPageSize) resultsStart, resultsEnd := getStartAndEndIndex(numberOfResults, params.ResultsPage, params.ResultsPageSize)
if resultsStart < 0 || resultsEnd < 0 { if resultsStart < 0 || resultsEnd < 0 {
shallowCopy.Results = []*endpoint.Result{} statusCopy.Results = []*endpoint.Result{}
} else { } else {
shallowCopy.Results = ss.Results[resultsStart:resultsEnd] // Deep copy the slice range to prevent race conditions
resultRange := ss.Results[resultsStart:resultsEnd]
statusCopy.Results = make([]*endpoint.Result, len(resultRange))
copy(statusCopy.Results, resultRange)
} }
numberOfEvents := len(ss.Events) numberOfEvents := len(ss.Events)
eventsStart, eventsEnd := getStartAndEndIndex(numberOfEvents, params.EventsPage, params.EventsPageSize) eventsStart, eventsEnd := getStartAndEndIndex(numberOfEvents, params.EventsPage, params.EventsPageSize)
if eventsStart < 0 || eventsEnd < 0 { if eventsStart < 0 || eventsEnd < 0 {
shallowCopy.Events = []*endpoint.Event{} statusCopy.Events = []*endpoint.Event{}
} else { } else {
shallowCopy.Events = ss.Events[eventsStart:eventsEnd] // Deep copy the slice range to prevent race conditions
eventRange := ss.Events[eventsStart:eventsEnd]
statusCopy.Events = make([]*endpoint.Event, len(eventRange))
copy(statusCopy.Events, eventRange)
} }
} }
return shallowCopy return statusCopy
} }
// ShallowCopySuiteStatus returns a shallow copy of a suite Status with only the results // ShallowCopySuiteStatus returns a shallow copy of a suite Status with only the results

4
storage/store/memory/util_bench_test.go
View File

@@ -8,14 +8,14 @@ import (
"github.com/TwiN/gatus/v5/storage/store/common/paging" "github.com/TwiN/gatus/v5/storage/store/common/paging"
) )
func BenchmarkShallowCopyEndpointStatus(b *testing.B) { func BenchmarkCopyEndpointStatus(b *testing.B) {
ep := &testEndpoint ep := &testEndpoint
status := endpoint.NewStatus(ep.Group, ep.Name) status := endpoint.NewStatus(ep.Group, ep.Name)
for i := 0; i < storage.DefaultMaximumNumberOfResults; i++ { for i := 0; i < storage.DefaultMaximumNumberOfResults; i++ {
AddResult(status, &testSuccessfulResult, storage.DefaultMaximumNumberOfResults, storage.DefaultMaximumNumberOfEvents) AddResult(status, &testSuccessfulResult, storage.DefaultMaximumNumberOfResults, storage.DefaultMaximumNumberOfEvents)
} }
for n := 0; n < b.N; n++ { for n := 0; n < b.N; n++ {
ShallowCopyEndpointStatus(status, paging.NewEndpointStatusParams().WithResults(1, 20)) CopyEndpointStatus(status, paging.NewEndpointStatusParams().WithResults(1, 20))
} }
b.ReportAllocs() b.ReportAllocs()
} }

22
storage/store/memory/util_test.go
View File

@@ -26,7 +26,7 @@ func TestAddResult(t *testing.T) {
AddResult(nil, &endpoint.Result{Timestamp: time.Now()}, storage.DefaultMaximumNumberOfResults, storage.DefaultMaximumNumberOfEvents) AddResult(nil, &endpoint.Result{Timestamp: time.Now()}, storage.DefaultMaximumNumberOfResults, storage.DefaultMaximumNumberOfEvents)
} }
func TestShallowCopyEndpointStatus(t *testing.T) { func TestCopyEndpointStatus(t *testing.T) {
ep := &endpoint.Endpoint{Name: "name", Group: "group"} ep := &endpoint.Endpoint{Name: "name", Group: "group"}
endpointStatus := endpoint.NewStatus(ep.Group, ep.Name) endpointStatus := endpoint.NewStatus(ep.Group, ep.Name)
ts := time.Now().Add(-25 * time.Hour) ts := time.Now().Add(-25 * time.Hour)
@@ -34,34 +34,34 @@ func TestShallowCopyEndpointStatus(t *testing.T) {
AddResult(endpointStatus, &endpoint.Result{Success: i%2 == 0, Timestamp: ts}, storage.DefaultMaximumNumberOfResults, storage.DefaultMaximumNumberOfEvents) AddResult(endpointStatus, &endpoint.Result{Success: i%2 == 0, Timestamp: ts}, storage.DefaultMaximumNumberOfResults, storage.DefaultMaximumNumberOfEvents)
ts = ts.Add(time.Hour) ts = ts.Add(time.Hour)
} }
if len(ShallowCopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(-1, -1)).Results) != 0 { if len(CopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(-1, -1)).Results) != 0 {
t.Error("expected to have 0 result") t.Error("expected to have 0 result")
} }
if len(ShallowCopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(1, 1)).Results) != 1 { if len(CopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(1, 1)).Results) != 1 {
t.Error("expected to have 1 result") t.Error("expected to have 1 result")
} }
if len(ShallowCopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(5, 0)).Results) != 0 { if len(CopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(5, 0)).Results) != 0 {
t.Error("expected to have 0 results") t.Error("expected to have 0 results")
} }
if len(ShallowCopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(-1, 20)).Results) != 0 { if len(CopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(-1, 20)).Results) != 0 {
t.Error("expected to have 0 result, because the page was invalid") t.Error("expected to have 0 result, because the page was invalid")
} }
if len(ShallowCopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(1, -1)).Results) != 0 { if len(CopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(1, -1)).Results) != 0 {
t.Error("expected to have 0 result, because the page size was invalid") t.Error("expected to have 0 result, because the page size was invalid")
} }
if len(ShallowCopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(1, 10)).Results) != 10 { if len(CopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(1, 10)).Results) != 10 {
t.Error("expected to have 10 results, because given a page size of 10, page 1 should have 10 elements") t.Error("expected to have 10 results, because given a page size of 10, page 1 should have 10 elements")
} }
if len(ShallowCopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(2, 10)).Results) != 10 { if len(CopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(2, 10)).Results) != 10 {
t.Error("expected to have 10 results, because given a page size of 10, page 2 should have 10 elements") t.Error("expected to have 10 results, because given a page size of 10, page 2 should have 10 elements")
} }
if len(ShallowCopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(3, 10)).Results) != 5 { if len(CopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(3, 10)).Results) != 5 {
t.Error("expected to have 5 results, because given a page size of 10, page 3 should have 5 elements") t.Error("expected to have 5 results, because given a page size of 10, page 3 should have 5 elements")
} }
if len(ShallowCopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(4, 10)).Results) != 0 { if len(CopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(4, 10)).Results) != 0 {
t.Error("expected to have 0 results, because given a page size of 10, page 4 should have 0 elements") t.Error("expected to have 0 results, because given a page size of 10, page 4 should have 0 elements")
} }
if len(ShallowCopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(1, 50)).Results) != 25 { if len(CopyEndpointStatus(endpointStatus, paging.NewEndpointStatusParams().WithResults(1, 50)).Results) != 25 {
t.Error("expected to have 25 results, because there's only 25 results") t.Error("expected to have 25 results, because there's only 25 results")
} }
} }