[Access] Response limit tracker #6814
Open
68
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #6814 /- ##
==========================================
Coverage 41.18% 41.19% 0.01%
==========================================
Files 2109 2109
Lines 185660 185664 4
==========================================
Hits 76460 76489 29
Misses 102788 102766 -22
Partials 6412 6409 -3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
illia-malachyn
changed the title
|
@Guitarheroua please address merge conflicts |
…isarchuk/6640-responce-limit-tracker
peterargue
approved these changes
Jan 1, 2025
durkmurder
reviewed
Jan 3, 2025
Comment on lines
684
to
728
| s.T().Run("Enforces response rate limit", func(t *testing.T) { | ||
| totalMessages := 5 // Number of messages to simulate. | ||
|
|
||
| // Step 1: Create a mock WebSocket connection. | ||
| conn := connmock.NewWebsocketConnection(t) | ||
| conn.On("SetWriteDeadline", mock.Anything).Return(nil).Times(totalMessages) | ||
|
|
||
| // Step 2: Configure the WebSocket controller with a rate limit. | ||
| config := NewDefaultWebsocketConfig() | ||
| config.MaxResponsesPerSecond = 2 // 2 messages per second. | ||
| controller := NewWebSocketController(s.logger, config, conn, nil) | ||
|
|
||
| // Step 3: Simulate sending messages to the controller's `multiplexedStream`. | ||
| go func() { | ||
| for i := 0; i < totalMessages; i { | ||
| controller.multiplexedStream <- map[string]interface{}{ | ||
| "message": i, | ||
| } | ||
| } | ||
| close(controller.multiplexedStream) | ||
| }() | ||
|
|
||
| // Step 4: Collect timestamps of message writes for verification. | ||
| var timestamps []time.Time | ||
| conn.On("WriteJSON", mock.Anything).Run(func(args mock.Arguments) { | ||
| timestamps = append(timestamps, time.Now()) | ||
| }).Return(nil).Times(totalMessages) | ||
|
|
||
| // Invoke the `writeMessages` method to process the stream. | ||
| _ = controller.writeMessages(context.Background()) | ||
|
|
||
| // Step 5: Verify that all messages are processed. | ||
| require.Len(t, timestamps, totalMessages, "All messages should be processed") | ||
|
|
||
| // Calculate the expected delay between messages based on the rate limit. | ||
| expectedDelay := time.Second / time.Duration(config.MaxResponsesPerSecond) | ||
| const tolerance = 5 * time.Millisecond // Allow up to 5ms deviation. | ||
|
|
||
| // Step 6: Assert that the delays respect the rate limit with tolerance. | ||
| for i := 1; i < len(timestamps); i { | ||
| delay := timestamps[i].Sub(timestamps[i-1]) | ||
| assert.GreaterOrEqual(t, delay, expectedDelay-tolerance, "Messages should respect the minimum rate limit") | ||
| assert.LessOrEqual(t, delay, expectedDelay tolerance, "Messages should respect the maximum rate limit") | ||
| } | ||
| }) |
There was a problem hiding this comment.
Suggested change
| s.T().Run("Enforces response rate limit", func(t *testing.T) { | |
| totalMessages := 5 // Number of messages to simulate. | |
| // Step 1: Create a mock WebSocket connection. | |
| conn := connmock.NewWebsocketConnection(t) | |
| conn.On("SetWriteDeadline", mock.Anything).Return(nil).Times(totalMessages) | |
| // Step 2: Configure the WebSocket controller with a rate limit. | |
| config := NewDefaultWebsocketConfig() | |
| config.MaxResponsesPerSecond = 2 // 2 messages per second. | |
| controller := NewWebSocketController(s.logger, config, conn, nil) | |
| // Step 3: Simulate sending messages to the controller's `multiplexedStream`. | |
| go func() { | |
| for i := 0; i < totalMessages; i { | |
| controller.multiplexedStream <- map[string]interface{}{ | |
| "message": i, | |
| } | |
| } | |
| close(controller.multiplexedStream) | |
| }() | |
| // Step 4: Collect timestamps of message writes for verification. | |
| var timestamps []time.Time | |
| conn.On("WriteJSON", mock.Anything).Run(func(args mock.Arguments) { | |
| timestamps = append(timestamps, time.Now()) | |
| }).Return(nil).Times(totalMessages) | |
| // Invoke the `writeMessages` method to process the stream. | |
| _ = controller.writeMessages(context.Background()) | |
| // Step 5: Verify that all messages are processed. | |
| require.Len(t, timestamps, totalMessages, "All messages should be processed") | |
| // Calculate the expected delay between messages based on the rate limit. | |
| expectedDelay := time.Second / time.Duration(config.MaxResponsesPerSecond) | |
| const tolerance = 5 * time.Millisecond // Allow up to 5ms deviation. | |
| // Step 6: Assert that the delays respect the rate limit with tolerance. | |
| for i := 1; i < len(timestamps); i { | |
| delay := timestamps[i].Sub(timestamps[i-1]) | |
| assert.GreaterOrEqual(t, delay, expectedDelay-tolerance, "Messages should respect the minimum rate limit") | |
| assert.LessOrEqual(t, delay, expectedDelay tolerance, "Messages should respect the maximum rate limit") | |
| } | |
| }) | |
| totalMessages := 5 // Number of messages to simulate. | |
| // Step 1: Create a mock WebSocket connection. | |
| conn := connmock.NewWebsocketConnection(t) | |
| conn.On("SetWriteDeadline", mock.Anything).Return(nil).Times(totalMessages) | |
| // Step 2: Configure the WebSocket controller with a rate limit. | |
| config := NewDefaultWebsocketConfig() | |
| config.MaxResponsesPerSecond = 2 // 2 messages per second. | |
| controller := NewWebSocketController(s.logger, config, conn, nil) | |
| // Step 3: Simulate sending messages to the controller's `multiplexedStream`. | |
| go func() { | |
| for i := 0; i < totalMessages; i { | |
| controller.multiplexedStream <- map[string]interface{}{ | |
| "message": i, | |
| } | |
| } | |
| close(controller.multiplexedStream) | |
| }() | |
| // Step 4: Collect timestamps of message writes for verification. | |
| var timestamps []time.Time | |
| conn.On("WriteJSON", mock.Anything).Run(func(args mock.Arguments) { | |
| timestamps = append(timestamps, time.Now()) | |
| }).Return(nil).Times(totalMessages) | |
| // Invoke the `writeMessages` method to process the stream. | |
| _ = controller.writeMessages(context.Background()) | |
| // Step 5: Verify that all messages are processed. | |
| require.Len(t, timestamps, totalMessages, "All messages should be processed") | |
| // Calculate the expected delay between messages based on the rate limit. | |
| expectedDelay := time.Second / time.Duration(config.MaxResponsesPerSecond) | |
| const tolerance = 5 * time.Millisecond // Allow up to 5ms deviation. | |
| // Step 6: Assert that the delays respect the rate limit with tolerance. | |
| for i := 1; i < len(timestamps); i { | |
| delay := timestamps[i].Sub(timestamps[i-1]) | |
| assert.GreaterOrEqual(t, delay, expectedDelay-tolerance, "Messages should respect the minimum rate limit") | |
| assert.LessOrEqual(t, delay, expectedDelay tolerance, "Messages should respect the maximum rate limit") | |
| } |
durkmurder
reviewed
Jan 3, 2025
| // Step 4: Collect timestamps of message writes for verification. | ||
| var timestamps []time.Time | ||
| conn.On("WriteJSON", mock.Anything).Run(func(args mock.Arguments) { | ||
| timestamps = append(timestamps, time.Now()) |
There was a problem hiding this comment.
Lets also check that we indeed receive expected messages in expected order at this place.
durkmurder
reviewed
Jan 3, 2025
| // Step 6: Assert that the delays respect the rate limit with tolerance. | ||
| for i := 1; i < len(timestamps); i { | ||
| delay := timestamps[i].Sub(timestamps[i-1]) | ||
| assert.GreaterOrEqual(t, delay, expectedDelay-tolerance, "Messages should respect the minimum rate limit") |
There was a problem hiding this comment.
You could possibly simplify next statement using: https://github.com/stretchr/testify/blob/master/require/require.go#L869
durkmurder
approved these changes
Jan 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes: #6640
NOTE: this PR should be merged after #6798
Implements rate limiter for responses, that controller returns to client.