Skip to content
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

use retry after instead of calculating delay #166

Merged
merged 4 commits into from
Apr 9, 2024
Merged

use retry after instead of calculating delay #166

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
04e37c2
use retry after instead of calculating delay
ndurell Mar 23, 2024
e757f66
added jitter to retry after
ajaysubra Apr 9, 2024
5cd4a32
using value for instead of all headers
ajaysubra Apr 9, 2024
faffaa3
Merge branch 'master' into noah/CHNL-6833/retry_behavior
ajaysubra Apr 9, 2024
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
4 changes: 2 additions & 2 deletions Sources/KlaviyoSwift/APIRequestErrorHandling.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ func handleRequestError(
environment.emitDeveloperWarning("Invalid data supplied for request. Skipping.")
return .deQueueCompletedResults(request)

case .rateLimitError:
case let .rateLimitError(retryAfter):
var requestRetryCount = 0
var totalRetryCount = 0
var nextBackoff = 0
Expand All @@ -112,7 +112,7 @@ func handleRequestError(
case let .retryWithBackoff(requestCount, totalCount, _):
requestRetryCount = requestCount + 1
totalRetryCount = totalCount + 1
nextBackoff = getDelaySeconds(for: totalRetryCount)
nextBackoff = retryAfter ?? getDelaySeconds(for: totalRetryCount)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we apply jitter to the retryAfter too?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose if we needed jitter, the server could apply it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jason-myers-klaviyo do you have any opinion on whether the SDKs should apply a jitter on top of the Retry-After value? Does the Retry-After just represent the time till the steady state rate limit "resets" or is there more advanced logic to it?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jitter longer than the seconds given would be fine and up to you. Nice to have I think

Jitter shorter will cause another 429 I think

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is just the time until the steady windows reset IIRC

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh ya definitely only add jitter

}
return .requestFailed(
request, .retryWithBackoff(
Expand Down
5 changes: 3 additions & 2 deletions Sources/KlaviyoSwift/KlaviyoAPI.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ struct KlaviyoAPI {

enum KlaviyoAPIError: Error {
case httpError(Int, Data)
case rateLimitError
case rateLimitError(Int?)
case missingOrInvalidResponse(URLResponse?)
case networkError(Error)
case internalError(String)
Expand Down Expand Up @@ -70,7 +70,8 @@ struct KlaviyoAPI {

if httpResponse.statusCode == 429 {
requestRateLimited(request)
return .failure(KlaviyoAPIError.rateLimitError)
let retryAfter = httpResponse.allHeaderFields["Retry-After"] as? Int
ajaysubra marked this conversation as resolved.
Show resolved Hide resolved
return .failure(KlaviyoAPIError.rateLimitError(retryAfter))
}

guard 200..<300 ~= httpResponse.statusCode else {
Expand Down
23 changes: 21 additions & 2 deletions Tests/KlaviyoSwiftTests/APIRequestErrorHandlingTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ class APIRequestErrorHandlingTests: XCTestCase {
initialState.requestsInFlight = [request]
let store = TestStore(initialState: initialState, reducer: KlaviyoReducer())

environment.analytics.klaviyoAPI.send = { _ in .failure(.rateLimitError) }
environment.analytics.klaviyoAPI.send = { _ in .failure(.rateLimitError(nil)) }

_ = await store.send(.sendRequest)

Expand All @@ -273,7 +273,7 @@ class APIRequestErrorHandlingTests: XCTestCase {
initialState.requestsInFlight = [request]
let store = TestStore(initialState: initialState, reducer: KlaviyoReducer())

environment.analytics.klaviyoAPI.send = { _ in .failure(.rateLimitError) }
environment.analytics.klaviyoAPI.send = { _ in .failure(.rateLimitError(nil)) }

_ = await store.send(.sendRequest)

Expand All @@ -285,6 +285,25 @@ class APIRequestErrorHandlingTests: XCTestCase {
}
}

func testRetryWithRetryAfter() async throws {
var initialState = INITIALIZED_TEST_STATE()
initialState.retryInfo = .retryWithBackoff(requestCount: 3, totalRetryCount: 3, currentBackoff: 4)
let request = initialState.buildProfileRequest(apiKey: initialState.apiKey!, anonymousId: initialState.anonymousId!)
initialState.requestsInFlight = [request]
let store = TestStore(initialState: initialState, reducer: KlaviyoReducer())

environment.analytics.klaviyoAPI.send = { _ in .failure(.rateLimitError(20)) }

_ = await store.send(.sendRequest)

await store.receive(.requestFailed(request, .retryWithBackoff(requestCount: 4, totalRetryCount: 4, currentBackoff: 20)), timeout: TIMEOUT_NANOSECONDS) {
$0.flushing = false
$0.queue = [request]
$0.requestsInFlight = []
$0.retryInfo = .retryWithBackoff(requestCount: 4, totalRetryCount: 4, currentBackoff: 20)
}
}

// MARK: - Missing or invalid response

func testMissingOrInvalidResponse() async throws {
Expand Down
Loading