feat: Make models Sendable #829

jbelkins · 2024-09-20T21:04:43Z

Issue #

Description of changes

Generated models are now Sendable. Generated structures, unions, enums, and intEnums all declare Sendable conformance in their definitions. Changes needed to enable this conformance:

The SmithyDocument protocol now conforms to Sendable. All of our document implementation types are fully Sendable without modification because their properties are already either immutable or Sendable.
The ByteStream enumeration is now Sendable. To support this:
- ReadableStream and WriteableStream protocols both now conform to Sendable.
- All of our concrete stream types are marked either Sendable or @unchecked Sendable. Streams were built to be thread-safe so this merely requires us to manually maintain that thread safety on stream types going forward.
The @Indirect property wrapper (used for enabling recursive structures) is provided with @unchecked Sendable conformance that uses a lock to enforce exclusive access to its wrapped value.
The Header and Headers properties are made Sendable with no changes to implementation.

Also:

Fixed some formatting in structure & union rendering.
Deleted extensions on CRTError and AsyncThrowingStream that were unused and causing compiler warnings.

Scope

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

jbelkins · 2024-09-21T01:51:27Z

Sources/ClientRuntime/PrimitiveTypeExtensions/Indirect.swift

+            defer { lock.unlock() }
+            _wrappedValue = newValue
+        }
+    }


This property wrapper is mostly same as before, but now stores its value in private storage that is protected by a lock when getting & setting.

Since it enforces exclusive access to its wrapped value, it can now be Sendable.

jbelkins · 2024-09-21T01:52:10Z

Sources/Smithy/ByteStream.swift

@@ -8,7 +8,7 @@
 import class Foundation.FileHandle
 import struct Foundation.Data

-public enum ByteStream {
+public enum ByteStream: Sendable {


This conformance is possible since Stream has been made Sendable in this PR.

jbelkins · 2024-09-21T01:53:17Z

Sources/Smithy/Document/SmithyDocument.swift

@@ -8,8 +8,9 @@
 import struct Foundation.Data
 import struct Foundation.Date

-public protocol SmithyDocument {
+public protocol SmithyDocument: Sendable {


All of the SmithyDocument implementations are now sendable without any code change, since they only store data that is either immutable and/or Sendable.

jbelkins · 2024-09-21T01:54:15Z

Sources/SmithyChecksums/ChunkedStream.swift

-public class ChunkedStream {
-    private var inputStream: Stream
+public class ChunkedStream: @unchecked Sendable {
+    private let inputStream: Stream


Streams were designed to be thread-safe so they may be marked @unchecked Sendable so long as we maintain that thread safety.

jbelkins · 2024-09-21T02:02:18Z

Sources/SmithyEventStreamsAPI/EventStreamError.swift

@@ -15,11 +15,3 @@ public enum EventStreamError: Error {
    /// This may be due to missing required headers
    case invalidMessage(String)
 }
-


The extension below was unused and causing compiler warnings, so it was deleted.

jbelkins · 2024-09-21T02:03:39Z

Sources/SmithyStreams/FileStream.swift

@@ -26,7 +26,7 @@ public final class FileStream: Stream {
    let fileHandle: FileHandle

    /// Returns the current position of the stream.
-    public var position: Data.Index
+    public private(set) var position: Data.Index


Technically this is a breaking API change but it would cause a bug to alter this property from outside this type.

jbelkins · 2024-09-21T02:07:46Z

smithy-swift-codegen/src/test/kotlin/EnumGeneratorTests.kt

@@ -39,7 +39,7 @@ class EnumGeneratorTests {

        val expectedGeneratedEnum = """


Below changes are Kotlin codegen tests. Changes in test expectations:

All generated structs, unions, enums, & intEnums are Sendable.

Whitespace around type declarations is made uniform, with an empty line before a declaration & none after.

Test strings are left-justified to allow for easy maintenance.

Try turning off whitespace changes on the Github diff to see the more substantial part of the test changes.

jbelkins · 2024-09-22T16:03:34Z

Sources/SmithyHTTPAPI/Headers.swift

@@ -5,7 +5,7 @@
 // SPDX-License-Identifier: Apache-2.0
 //

-public struct Headers {
+public struct Headers: Sendable {


Headers and Header may be marked Sendable without any further change since they are structs that only store value types.

jbelkins · 2024-09-22T16:04:09Z

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/EnumGenerator.kt

            "}",
+            SwiftTypes.Protocols.Sendable,


Mark generated enums with Sendable.

jbelkins · 2024-09-22T16:04:42Z

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/IntEnumGenerator.kt

            "}",
+            SwiftTypes.Protocols.Sendable,


Mark generated intEnums with Sendable.

Also adjust spacing a bit.

jbelkins · 2024-09-22T16:05:15Z

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/StructureGenerator.kt

-        val equatableConformance = writer.format(": \$N ", SwiftTypes.Protocols.Equatable).takeIf { shape.hasTrait<EquatableConformanceTrait>() } ?: ""
-        writer.openBlock("public struct \$struct.name:L $equatableConformance{")
+        val equatableConformance = writer.format(", \$N", SwiftTypes.Protocols.Equatable).takeIf { shape.hasTrait<EquatableConformanceTrait>() } ?: ""
+        writer.openBlock("public struct \$struct.name:L: \$N$equatableConformance {", SwiftTypes.Protocols.Sendable)


Mark generated structs with Sendable.

Also adjust spacing of generated code.

jbelkins · 2024-09-22T16:05:42Z

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/UnionGenerator.kt

-        val equatableConformance = (": " + SwiftTypes.Protocols.Equatable + " ").takeIf { shape.hasTrait<EquatableConformanceTrait>() } ?: ""
-        writer.openBlock("public ${indirectOrNot}enum \$union.name:L $equatableConformance{", "}\n") {
+        val equatableConformance = writer.format(", \$N", SwiftTypes.Protocols.Equatable).takeIf { shape.hasTrait<EquatableConformanceTrait>() } ?: ""
+        writer.openBlock("public ${indirectOrNot}enum \$union.name:L: \$N$equatableConformance {", "}", SwiftTypes.Protocols.Sendable) {


Mark generated unions with Sendable.

Also adjust formatting.

jbelkins · 2024-09-22T16:06:05Z

...wift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/swiftmodules/SwiftTypes.kt

@@ -31,6 +31,7 @@ object SwiftTypes {
        val RawRepresentable = builtInSymbol("RawRepresentable", SwiftDeclaration.PROTOCOL)
        val CaseIterable = builtInSymbol("CaseIterable", SwiftDeclaration.PROTOCOL)
        val CustomDebugStringConvertible = builtInSymbol("CustomDebugStringConvertible", SwiftDeclaration.PROTOCOL)
+        val Sendable = builtInSymbol("Sendable", SwiftDeclaration.PROTOCOL)


SwiftSymbol for the Sendable protocol.

feat: Mark Document and ByteStream as Sendable

60a44e7

jbelkins requested review from dayaffe and sichanyoo September 20, 2024 21:04

jbelkins changed the title ~~feat: Mark Document and ByteStream as Sendable~~ feat: Make models Sendable Sep 20, 2024

jbelkins added 2 commits September 20, 2024 19:53

Make models Sendable

9561ade

Fix tests

65ce5bc

jbelkins commented Sep 21, 2024

View reviewed changes

Deleted extensions on Swift & CRT types

95767ce

jbelkins commented Sep 21, 2024

View reviewed changes

jbelkins mentioned this pull request Sep 22, 2024

feat: Make models Sendable awslabs/aws-sdk-swift#1771

Draft

jbelkins commented Sep 22, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Make models Sendable #829

feat: Make models Sendable #829

jbelkins commented Sep 20, 2024 •

edited

Loading

jbelkins Sep 21, 2024

jbelkins Sep 21, 2024

jbelkins Sep 21, 2024

jbelkins Sep 21, 2024

jbelkins Sep 21, 2024

jbelkins Sep 21, 2024

jbelkins Sep 21, 2024

jbelkins Sep 22, 2024

jbelkins Sep 22, 2024

jbelkins Sep 22, 2024

jbelkins Sep 22, 2024

jbelkins Sep 22, 2024

jbelkins Sep 22, 2024

jbelkins Sep 22, 2024

		@@ -39,7 +39,7 @@ class EnumGeneratorTests {

		val expectedGeneratedEnum = """

feat: Make models Sendable #829

Are you sure you want to change the base?

feat: Make models Sendable #829

Conversation

jbelkins commented Sep 20, 2024 • edited Loading

Issue #

Description of changes

Scope

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jbelkins commented Sep 20, 2024 •

edited

Loading