chore: Make modeled errors Sendable #883
Conversation
| @@ -234,7 +235,7 @@ class StructureGenerator( | |||
| private fun generateErrorStructMembers() { | |||
| if (membersSortedByName.isNotEmpty()) { | |||
| writer.write("") | |||
| writer.openBlock("public struct Properties {", "}") { | |||
| writer.openBlock("public struct Properties: \$N {", "}", SwiftTypes.Protocols.Sendable) { | |||
There was a problem hiding this comment.
Modeled errors' internal Properties structure (when rendered) is marked Sendable. No other code change required for sendability since all possible model struct properties are already Sendable.
| ClientRuntimeTypes.Core.ModeledError, | ||
| ClientRuntimeTypes.Http.HttpError, | ||
| SwiftTypes.Error | ||
| SwiftTypes.Error, | ||
| SwiftTypes.Protocols.Sendable, |
There was a problem hiding this comment.
The Sendable protocol is added to all rendered errors.
| lock.lock() | ||
| defer { lock.unlock() } | ||
| return try block(_headers) | ||
| } |
There was a problem hiding this comment.
Above, the headers property is protected with exclusive access. Below, various mutating methods & accessors are modified to use exclusive access.
| } | ||
|
|
||
| public let reason: String? |
There was a problem hiding this comment.
The reason property is never used, I do not know what the intended use is for it.
It has been converted to read-only.
|
|
||
| public class HTTPResponse: HTTPURLResponse, ResponseMessage { | ||
| public final class HTTPResponse: ResponseMessage, @unchecked Sendable { | ||
| private var lock = NSRecursiveLock() |
There was a problem hiding this comment.
The headers, body, and statusCode properties on HTTPResponse are locked with a recursive lock.
(A DispatchQueue was previously used on statusCode; it has been converted to NSRecursiveLock for simplicity, and also because use of GCD is discouraged in Swift concurrency code.)
|
|
||
| public struct Properties { | ||
| public struct Properties: Swift.Sendable { | ||
| /// This is documentation about the member. | ||
| public internal(set) var baz: Swift.Int? = nil |
There was a problem hiding this comment.
The above codegen test expectation is an example of how generated errors are changed.
Description of changes
Swift
Sendableconformance is added to all modeled errors. There is no change to public APIs except the addition of theSendableprotocol to various types.Headersis made@unchecked Sendableby placing exclusive locking on its properties.HTTPResponseis made@unchecked Sendableby placing exclusive locking on its properties as well.Sendableconformance is added to code-generated error structures and their internalProperties.Also:
HTTPURLResponseprotocol, which is unused and scopedinternal, is deleted.Scope
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.