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.

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

fix: Consider an empty string header value to be present #832

Closed
wants to merge 5 commits into from
Closed
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
10 changes: 1 addition & 9 deletions Sources/SmithyHTTPAPI/Headers.swift
Original file line number Diff line number Diff line change
Expand Up @@ -138,15 +138,7 @@ public struct Headers: Sendable {
}

public func exists(name: String) -> Bool {
guard headers.index(of: name) != nil else {
return false
}

guard let value = value(for: name) else {
return false
}

return !value.isEmpty
headers.index(of: name) != nil
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The previous definition of exists was wrong because it considered a header with an empty string for its value to "not exist". Turns out a header with empty string value is valid, so it should definitely "exist".

I suspect that the reason for this logic is that the previous developers changed the definition of "exists" to suit the behavior demanded by empty-header protocol tests, which is wrong and is being fixed by Smithy team.

}

/// The dictionary representation of all headers.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
//
// Copyright Amazon.com Inc. or its affiliates.
// All Rights Reserved.
//
// SPDX-License-Identifier: Apache-2.0
//

import SmithyHTTPAPI
import XCTest
import ClientRuntime

class HttpHeadersTests: XCTestCase {
class HeadersTests: XCTestCase {

var headersAsDictionaryWithArray = [String: [String]]()
var headersAsDictionary = [String: String]()
Expand Down Expand Up @@ -123,4 +124,21 @@ class HttpHeadersTests: XCTestCase {
XCTAssertEqual(headerA, headerB)
XCTAssertEqual(headerA.hashValue, headerB.hashValue)
}

// MARK: - exists()

func test_exists_trueIfHeaderExists() {
let subject = Headers(["a": "abc"])
XCTAssertTrue(subject.exists(name: "a"))
}

func test_exists_falseIfHeaderDoesntExist() {
let subject = Headers(["a": "abc"])
XCTAssertFalse(subject.exists(name: "b"))
}

func test_exists_trueIfHeaderValueIsEmptyString() {
let subject = Headers(["a": ""])
XCTAssertTrue(subject.exists(name: "a"))
}
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These new tests check the expected behavior for the exists() method on Headers.

Loading