Skip to content

fix(aws/recommendations): protect RateLimiter against concurrent access (closes #271) #865

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cristim wants to merge 1 commit into
base: feat/multicloud-web-frontend
Choose a base branch
from
Open

fix(aws/recommendations): protect RateLimiter against concurrent access (closes #271) #865

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions providers/aws/recommendations/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ type CostExplorerAPI interface {
type Client struct {
costExplorerClient CostExplorerAPI
region string
rateLimiter *RateLimiter
// newRateLimiter is called once per API call (not shared across goroutines).
// Tests can replace it with a factory returning a faster limiter.
newRateLimiter func() *RateLimiter
}

// NewClient creates a new recommendations client
Expand All @@ -46,7 +48,7 @@ func NewClient(cfg aws.Config) *Client {
return &Client{
costExplorerClient: costexplorer.NewFromConfig(ceConfig),
region: cfg.Region,
rateLimiter: NewRateLimiter(),
newRateLimiter: NewRateLimiter,
}
}

Expand All @@ -55,7 +57,7 @@ func NewClientWithAPI(api CostExplorerAPI, region string) *Client {
return &Client{
costExplorerClient: api,
region: region,
rateLimiter: NewRateLimiter(),
newRateLimiter: NewRateLimiter,
}
}

Expand Down Expand Up @@ -133,12 +135,12 @@ func (c *Client) fetchRIPageWithRetry(
ctx context.Context,
input *costexplorer.GetReservationPurchaseRecommendationInput,
) (*costexplorer.GetReservationPurchaseRecommendationOutput, error) {
c.rateLimiter.Reset()
rl := c.newRateLimiter()
var result *costexplorer.GetReservationPurchaseRecommendationOutput
var err error

for {
if waitErr := c.rateLimiter.Wait(ctx); waitErr != nil {
if waitErr := rl.Wait(ctx); waitErr != nil {
return nil, fmt.Errorf("rate limiter wait failed: %w", waitErr)
}

Expand All @@ -147,13 +149,13 @@ func (c *Client) fetchRIPageWithRetry(
}
result, err = c.costExplorerClient.GetReservationPurchaseRecommendation(ctx, input)
concurrency.Release(ctx)
if !c.rateLimiter.ShouldRetry(err) {
if !rl.ShouldRetry(err) {
break
}
}

if err != nil {
return nil, fmt.Errorf("failed to get RI recommendations after %d retries: %w", c.rateLimiter.GetRetryCount(), err)
return nil, fmt.Errorf("failed to get RI recommendations after %d retries: %w", rl.GetRetryCount(), err)
}

return result, nil
Expand Down
36 changes: 25 additions & 11 deletions providers/aws/recommendations/client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package recommendations
import (
"context"
"fmt"
"sync"
"testing"
"time"

Expand All @@ -17,6 +18,7 @@ import (

// Mock CostExplorerAPI for testing
type mockCostExplorerAPI struct {
mu sync.Mutex
riRecommendations *costexplorer.GetReservationPurchaseRecommendationOutput
spRecommendations *costexplorer.GetSavingsPlansPurchaseRecommendationOutput
riError error
Expand All @@ -28,20 +30,28 @@ type mockCostExplorerAPI struct {
}

func (m *mockCostExplorerAPI) GetReservationPurchaseRecommendation(ctx context.Context, params *costexplorer.GetReservationPurchaseRecommendationInput, optFns ...func(*costexplorer.Options)) (*costexplorer.GetReservationPurchaseRecommendationOutput, error) {
m.mu.Lock()
m.callCount++
m.riCalls = append(m.riCalls, params)
if m.riError != nil {
return nil, m.riError
riErr := m.riError
riRecs := m.riRecommendations
m.mu.Unlock()
if riErr != nil {
return nil, riErr
}
return m.riRecommendations, nil
return riRecs, nil
}

func (m *mockCostExplorerAPI) GetSavingsPlansPurchaseRecommendation(ctx context.Context, params *costexplorer.GetSavingsPlansPurchaseRecommendationInput, optFns ...func(*costexplorer.Options)) (*costexplorer.GetSavingsPlansPurchaseRecommendationOutput, error) {
m.mu.Lock()
m.callCount++
if m.spError != nil {
return nil, m.spError
spErr := m.spError
spRecs := m.spRecommendations
m.mu.Unlock()
if spErr != nil {
return nil, spErr
}
return m.spRecommendations, nil
return spRecs, nil
}

func (m *mockCostExplorerAPI) GetReservationUtilization(ctx context.Context, params *costexplorer.GetReservationUtilizationInput, optFns ...func(*costexplorer.Options)) (*costexplorer.GetReservationUtilizationOutput, error) {
Expand All @@ -61,7 +71,7 @@ func TestNewClient(t *testing.T) {

assert.NotNil(t, client)
assert.NotNil(t, client.costExplorerClient)
assert.NotNil(t, client.rateLimiter)
assert.NotNil(t, client.newRateLimiter)
assert.Equal(t, "us-west-2", client.region)
}

Expand All @@ -74,7 +84,7 @@ func TestNewClientWithAPI(t *testing.T) {
assert.NotNil(t, client)
assert.Equal(t, mockAPI, client.costExplorerClient)
assert.Equal(t, region, client.region)
assert.NotNil(t, client.rateLimiter)
assert.NotNil(t, client.newRateLimiter)
}

func TestGetRecommendations_EC2_Success(t *testing.T) {
Expand Down Expand Up @@ -262,9 +272,11 @@ func TestGetRecommendations_Error(t *testing.T) {
riError: newThrottleError(),
}

// Use custom rate limiter to speed up test
// Use custom rate limiter factory to speed up test
client := NewClientWithAPI(mockAPI, "us-east-1")
client.rateLimiter = NewRateLimiterWithOptions(1*time.Millisecond, 10*time.Millisecond, 2)
client.newRateLimiter = func() *RateLimiter {
return NewRateLimiterWithOptions(1*time.Millisecond, 10*time.Millisecond, 2)
}

params := common.RecommendationParams{
Service: common.ServiceEC2,
Expand Down Expand Up @@ -506,7 +518,9 @@ func TestGetRecommendations_ContextCancellation(t *testing.T) {
}

client := NewClientWithAPI(mockAPI, "us-east-1")
client.rateLimiter = NewRateLimiterWithOptions(100*time.Millisecond, 1*time.Second, 5)
client.newRateLimiter = func() *RateLimiter {
return NewRateLimiterWithOptions(100*time.Millisecond, 1*time.Second, 5)
}

ctx, cancel := context.WithCancel(context.Background())
cancel() // Cancel immediately
Expand Down
6 changes: 3 additions & 3 deletions providers/aws/recommendations/coverage.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,13 +318,13 @@ func serviceRegionFilter(service, region string) *types.Expression {
// Mirrors fetchUtilizationPage so the two paths fail and back off the
// same way.
func (c *Client) fetchCoveragePage(ctx context.Context, input *costexplorer.GetReservationCoverageInput) (*costexplorer.GetReservationCoverageOutput, error) {
c.rateLimiter.Reset()
rl := c.newRateLimiter()
for {
if waitErr := c.rateLimiter.Wait(ctx); waitErr != nil {
if waitErr := rl.Wait(ctx); waitErr != nil {
return nil, fmt.Errorf("rate limiter wait failed: %w", waitErr)
}
result, err := c.costExplorerClient.GetReservationCoverage(ctx, input)
if !c.rateLimiter.ShouldRetry(err) {
if !rl.ShouldRetry(err) {
if err != nil {
return nil, fmt.Errorf("failed to get reservation coverage: %w", err)
}
Expand Down
6 changes: 3 additions & 3 deletions providers/aws/recommendations/parser_sp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,12 +120,12 @@ func (c *Client) fetchSPPageWithRetry(
ctx context.Context,
input *costexplorer.GetSavingsPlansPurchaseRecommendationInput,
) (*costexplorer.GetSavingsPlansPurchaseRecommendationOutput, error) {
c.rateLimiter.Reset()
rl := c.newRateLimiter()
var result *costexplorer.GetSavingsPlansPurchaseRecommendationOutput
var err error

for {
if waitErr := c.rateLimiter.Wait(ctx); waitErr != nil {
if waitErr := rl.Wait(ctx); waitErr != nil {
return nil, fmt.Errorf("rate limiter wait failed: %w", waitErr)
}

Expand All @@ -134,7 +134,7 @@ func (c *Client) fetchSPPageWithRetry(
}
result, err = c.costExplorerClient.GetSavingsPlansPurchaseRecommendation(ctx, input)
concurrency.Release(ctx)
if !c.rateLimiter.ShouldRetry(err) {
if !rl.ShouldRetry(err) {
break
}
}
Expand Down
6 changes: 3 additions & 3 deletions providers/aws/recommendations/utilization.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,14 +92,14 @@ func (c *Client) GetRIUtilization(ctx context.Context, lookbackDays int) ([]RIUt

// fetchUtilizationPage calls the Cost Explorer API with rate-limit retry.
func (c *Client) fetchUtilizationPage(ctx context.Context, input *costexplorer.GetReservationUtilizationInput) (*costexplorer.GetReservationUtilizationOutput, error) {
c.rateLimiter.Reset()
rl := c.newRateLimiter()
for {
if waitErr := c.rateLimiter.Wait(ctx); waitErr != nil {
if waitErr := rl.Wait(ctx); waitErr != nil {
return nil, fmt.Errorf("rate limiter wait failed: %w", waitErr)
}

result, err := c.costExplorerClient.GetReservationUtilization(ctx, input)
if !c.rateLimiter.ShouldRetry(err) {
if !rl.ShouldRetry(err) {
if err != nil {
return nil, fmt.Errorf("failed to get reservation utilization: %w", err)
}
Expand Down
Loading