Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 13 additions & 2 deletions Sources/ContainerizationOCI/Client/RegistryClient.swift
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,8 @@ public final class RegistryClient: ContentClient {
request.headers.add(name: "Authorization", value: "\(token)")
}

// Add any arbitrary headers
headers?.forEach { (k, v) in request.headers.add(name: k, value: v) }
// Add any arbitrary headers.
requestHeaders(merging: headers).forEach { (k, v) in request.headers.add(name: k, value: v) }
var retryCount = 0
var response: HTTPClientResponse?
while true {
Expand Down Expand Up @@ -258,6 +258,17 @@ public final class RegistryClient: ContentClient {
return try await closure(response)
}

internal func requestHeaders(merging headers: [(String, String)]?) -> [(String, String)] {
var merged: [(String, String)] = []
if headers?.contains(where: { $0.0.caseInsensitiveCompare("User-Agent") == .orderedSame }) != true {
merged.append(("User-Agent", clientID))
}
if let headers {
merged.append(contentsOf: headers)
}
return merged
}

internal func requestData(
components: URLComponents,
headers: [(String, String)]? = nil
Expand Down
19 changes: 19 additions & 0 deletions Tests/ContainerizationOCITests/RegistryClientTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,25 @@ struct OCIClientTests: ~Copyable {
try await client.ping()
}

@Test func requestHeadersAddDefaultUserAgent() async throws {
let client = RegistryClient(host: "ghcr.io", clientID: "containerization-tests")
let headers = client.requestHeaders(merging: [("Accept", "*/*")])

#expect(headers.contains { $0.0 == "User-Agent" && $0.1 == "containerization-tests" })
#expect(headers.contains { $0.0 == "Accept" && $0.1 == "*/*" })
}

@Test func requestHeadersKeepExplicitUserAgent() async throws {
let client = RegistryClient(host: "ghcr.io", clientID: "containerization-tests")
let headers = client.requestHeaders(merging: [
("Accept", "*/*"),
("user-agent", "custom-client"),
])

#expect(!headers.contains { $0.0 == "User-Agent" && $0.1 == "containerization-tests" })
#expect(headers.contains { $0.0 == "user-agent" && $0.1 == "custom-client" })
}

@Test func resolve() async throws {
let client = RegistryClient(host: "ghcr.io")
let descriptor = try await client.resolve(name: "apple/containerization/dockermanifestimage", tag: "0.0.2")
Expand Down