Skip to content

feat: Send a standard User-Agent: sdk-name/version header #104

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
emyller wants to merge 2 commits into
base: main
Choose a base branch
from
+13 −1
Open

feat: Send a standard User-Agent: sdk-name/version header #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e35e076
Send SDK name and version to the Flagsmith API on every request
emyller Apr 14, 2026
6654ed1
Keep the reported SDK version current after each release
emyller Apr 14, 2026
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
6 changes: 6 additions & 0 deletions FlagsmithClient/Classes/Internal/Router.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ import Foundation
#endif

enum Router: Sendable {
// x-release-please-start-version
private static let sdkVersion = "3.9.0"
Copy link
Copy Markdown

@Zaimwa9 Zaimwa9 Apr 15, 2026

Choose a reason for hiding this comment

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

Same question about dynamic extraction. Would a const make sense?

// x-release-please-end
static let userAgent = "flagsmith-swift-ios-sdk/\(sdkVersion)"

private enum HTTPMethod: String {
case get = "GET"
case post = "POST"
Expand Down Expand Up @@ -102,6 +107,7 @@ enum Router: Sendable {
}
request.addValue(apiKey, forHTTPHeaderField: "X-Environment-Key")
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue(Router.userAgent, forHTTPHeaderField: "User-Agent")

return request
}
Expand Down
1 change: 1 addition & 0 deletions FlagsmithClient/Classes/Internal/SSEManager.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ final class SSEManager: NSObject, URLSessionDataDelegate, @unchecked Sendable {
request.setValue("text/event-stream, application/json; charset=utf-8", forHTTPHeaderField: "Accept")
request.setValue("no-cache", forHTTPHeaderField: "Cache-Control")
request.setValue("keep-alive", forHTTPHeaderField: "Connection")
request.setValue(Router.userAgent, forHTTPHeaderField: "User-Agent")

completionHandler = completion
dataTask = session.dataTask(with: request)
Expand Down
3 changes: 3 additions & 0 deletions FlagsmithClient/Tests/RouterTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ final class RouterTests: FlagsmithClientTestCase {
XCTAssertEqual(request.url?.absoluteString, "https://edge.api.flagsmith.com/api/v1/flags/")
XCTAssertTrue(request.allHTTPHeaderFields?.contains(where: { $0.key == "X-Environment-Key" }) ?? false)
XCTAssertNil(request.httpBody)
// x-release-please-start-version
XCTAssertEqual(request.allHTTPHeaderFields?["User-Agent"], "flagsmith-swift-ios-sdk/3.9.0")
// x-release-please-end
}

func testGetIdentityRequest() throws {
Expand Down
4 changes: 3 additions & 1 deletion release-please-config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
"prerelease": false,
"include-component-in-tag": false,
"extra-files": [
"FlagsmithClient.podspec"
"FlagsmithClient.podspec",
"FlagsmithClient/Classes/Internal/Router.swift",
"FlagsmithClient/Tests/RouterTests.swift"
]
}
},
Expand Down
Loading