Add X-Klaviyo- request headers and use Retry-After response header #149
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
evan-masseau
added
do-not-merge
… of attempts. Consolidated and improved API Request tests, added tests for new features.
evan-masseau
force-pushed
the
ecm/CHNL-6842-new-headers
branch
from
60a8a08
to
f096525
Compare
added 2 commits
April 1, 2024 13:18
# Conflicts: # sdk/analytics/src/main/java/com/klaviyo/analytics/networking/requests/KlaviyoApiRequest.kt # sdk/analytics/src/test/java/com/klaviyo/analytics/KlaviyoTest.kt # sdk/analytics/src/test/java/com/klaviyo/analytics/networking/KlaviyoApiClientTest.kt # sdk/analytics/src/test/java/com/klaviyo/analytics/networking/requests/BaseRequestTest.kt # sdk/analytics/src/test/java/com/klaviyo/analytics/networking/requests/EventApiRequestTest.kt
evan-masseau
commented
Apr 1, 2024
| @@ -87,6 +90,17 @@ internal class KlaviyoApiClientTest : BaseRequestTest() { | |||
| } | |||
| } | |||
|
|
|||
| @After | |||
There was a problem hiding this comment.
Small thing, but I grouped setup and cleanup functions together for readability.
evan-masseau
commented
Apr 1, 2024
| every { networkMonitorMock.isNetworkConnected() } returns true | ||
| every { configMock.networkTimeout } returns 1 | ||
| every { configMock.networkFlushIntervals } returns longArrayOf(10_000L, 30_000L, 60_000L) | ||
| } | ||
|
|
||
| @After |
There was a problem hiding this comment.
for clarity, I annotated all setup/cleanup, even though overrides technically inherit it
evan-masseau
commented
Apr 1, 2024
| import org.junit.Before | ||
| import org.junit.Test | ||
|
|
||
| internal abstract class BaseApiRequestTest<T> : BaseTest() where T : KlaviyoApiRequest { |
There was a problem hiding this comment.
Abstract base class for API request tests. The tests in this class get applied to all API Request tests that inherit from here.
evan-masseau
commented
Apr 1, 2024
| Assert.assertEquals(expectedQuery, makeTestRequest().query) | ||
| } | ||
|
|
||
| inline fun <reified T> testJsonInterop(request: T) where T : KlaviyoApiRequest { |
There was a problem hiding this comment.
Couldn't quite get this to work as a @test with generics alone, so made a reusable function and call it in one-liner tests in the subclasses.
evan-masseau
changed the title
evan-masseau
changed the title
evan-masseau
changed the title
This was referenced Apr 2, 2024
Use header name "X-Klaviyo-Attempt-Count" Moved retry interval computation into Api Request since it is mainly driven by the header now Additional tests
evan-masseau
removed
the
do-not-merge
kennyklaviyo
reviewed
Apr 3, 2024
sdk/analytics/src/main/java/com/klaviyo/analytics/networking/requests/ApiRequest.kt
Outdated
Show resolved
Hide resolved
kennyklaviyo
reviewed
Apr 3, 2024
sdk/analytics/src/main/java/com/klaviyo/analytics/networking/requests/KlaviyoApiRequest.kt
Show resolved
Hide resolved
evan-masseau
commented
Apr 3, 2024
sdk/analytics/src/main/java/com/klaviyo/analytics/networking/requests/KlaviyoApiRequest.kt
Outdated
Show resolved
Hide resolved
kennyklaviyo
reviewed
Apr 3, 2024
sdk/analytics/src/main/java/com/klaviyo/analytics/networking/requests/KlaviyoApiRequest.kt
Outdated
Show resolved
Hide resolved
kennyklaviyo
reviewed
Apr 3, 2024
sdk/analytics/src/main/java/com/klaviyo/analytics/networking/requests/KlaviyoApiRequest.kt
Outdated
Show resolved
Hide resolved
kennyklaviyo
reviewed
Apr 3, 2024
sdk/analytics/src/main/java/com/klaviyo/analytics/networking/requests/KlaviyoApiRequest.kt
Outdated
Show resolved
Hide resolved
kennyklaviyo
reviewed
Apr 3, 2024
sdk/analytics/src/main/java/com/klaviyo/analytics/networking/requests/KlaviyoApiRequest.kt
Show resolved
Hide resolved
- Add explicit test that API attempts count increments on send - Use val instead of var for request headers, now that its a mutable map. - Other cleanup
kennyklaviyo
approved these changes
Apr 8, 2024
ajaysubra
approved these changes
Apr 9, 2024
sdk/analytics/src/main/java/com/klaviyo/analytics/networking/requests/KlaviyoApiRequest.kt
Show resolved
Hide resolved
evan-masseau
added
the
do-not-merge
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.
Description
Add new request headers, and make use of
Retry-Afterresponse header on rate limited requests(429s)Check List
Changelog / Code Overview
X-Klaviyo-Mobile=1X-Klaviyo-Retry-Attempt=N/MAXRetry-Afterheader on rate limited requests (previously unavailable forclient/*429s) and obey the server's retry timing, plus jitter.Sample of new request headers from test app:
Test Plan
Related Issues/Tickets
CHNL-6842
CHNL-6835