Add User-Agent field #158
Draft
Add User-Agent field #158
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
simolus3
reviewed
Apr 9, 2025
| @@ -449,6 +469,8 @@ internal class SyncStream( | |||
| } | |||
| } | |||
|
|
|||
| internal expect fun getOS(): String | |||
There was a problem hiding this comment.
I'd prefer this to be in a separate file (e.g. utils/OSInfo.kt).
| @@ -172,7 +190,7 @@ internal class SyncStream( | |||
| contentType(ContentType.Application.Json) | |||
| headers { | |||
| append(HttpHeaders.Authorization, "Token ${credentials.token}") | |||
| append("User-Id", credentials.userId ?: "") | |||
| append("User-Agent", powerSyncUserAgent()) | |||
There was a problem hiding this comment.
Given that we're doing this on all requests, a better place to put this may be in init:
fun HttpClientConfig<*>.configureClient() {
install(HttpTimeout)
install(ContentNegotiation)
defaultRequest {
headers {
append("User-Agent", $LIBRARY_NAME/$LIBRARY_VERSION ${getOS()}")
}
}
}
simolus3
reviewed
Apr 9, 2025
Comment on lines
+330
to
+332
| // TODO: Swift SDK relies on this too. | ||
| // Find out how to add a build flag to toggle between "powersync-kotlin" and "powersync-swift". | ||
| buildConfigField(STRING, "LIBRARY_NAME", "powersync-kotlin") |
There was a problem hiding this comment.
I think we don't have to worry about this. We'll likely add an API for clients to add their own headers in the future. The Swift SDK could use that to always override the User-Agent header if necessary. So it should be fine if this always reports powersync-kotlin for now.
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.
Adds User-Agent in similar fashion to Dart and JS repos.
Based on abandoned pull #57
Todos
android $base/$versionwithandroid <SDK_INT or OS version>- must check if can extract version string fromSDK_INT