feat: Make models Sendable #829

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

Issue #

Description of changes

Make all model types Sendable. This requires the following be performed:

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, value types and/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 is made Sendable. Because @Indirect is a reference type, it must provide locking around its state to expose its wrapped value synchronously.

Once this is done, all possible model properties are themselves Sendable, and all generated Smithy models (structures, unions, enums, intEnums) may be marked Sendable.

Also:

Eliminate two type extensions (on CRTError and AsyncThrowingStream) that were unused & causing compiler warnings.
Fix whitespace / formatting in some generated code.

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.

author Josh Elkins <[email protected]> 1725075023 -0500 committer Josh Elkins <[email protected]> 1730244524 -0500 parent 0de1791 author Josh Elkins <[email protected]> 1725075023 -0500 committer Josh Elkins <[email protected]> 1730244464 -0500 parent 0de1791 author Josh Elkins <[email protected]> 1725075023 -0500 committer Josh Elkins <[email protected]> 1730244451 -0500 parent 0de1791 author Josh Elkins <[email protected]> 1725075023 -0500 committer Josh Elkins <[email protected]> 1730244433 -0500 parent 0de1791 author Josh Elkins <[email protected]> 1725075023 -0500 committer Josh Elkins <[email protected]> 1730244416 -0500 parent 0de1791 author Josh Elkins <[email protected]> 1725075023 -0500 committer Josh Elkins <[email protected]> 1730244397 -0500 parent 0de1791 author Josh Elkins <[email protected]> 1725075023 -0500 committer Josh Elkins <[email protected]> 1730244381 -0500 parent 0de1791 author Josh Elkins <[email protected]> 1725075023 -0500 committer Josh Elkins <[email protected]> 1730244297 -0500 parent 0de1791 author Josh Elkins <[email protected]> 1725075023 -0500 committer Josh Elkins <[email protected]> 1730244277 -0500 WIP chore: Organize codegen tests & Kotlin unit tests (#830) * Organize codegen tests & refactor setup tests for XML codegen tests to reduce duplicate code. * ktlint --------- Co-authored-by: Sichan Yoo <[email protected]> feat: Make models Sendable (#829) chore: Specify Xcode_16 application name same as on Github runner (#831) chore: Move HTTP status code test out of SmithyTestUtil (#836) chore: Protocol tests set their own AWS credentials (#837) Don't import Darwin on Windows. (#835) chore: Run macOS 15 with Xcode 16 on CI (#838) fix: Don't unwrap unneeded value during event marshal (#839) fix: Don't supply a default value when reading a non-optional value (#840) feat: Enable sigv4a for SESv2 service (#842) feat!: Bump CRT version to 0.37.0 & add CRC64NVME checksum algorithm wrapper (#845) * Bump CRT version to 0.37.0 and add wrapper for new checksum algorithm. * Add doc comment re: checksum algorithms may expand in future. --------- Co-authored-by: Sichan Yoo <[email protected]> chore: Use Smithy 1.52.1 (#846) feat: Smoke Tests V2 (#841) * Basic scaffold. * Add SmokeTestGenerator for generic Smithy spec, with customization points via open functions. * Refactor both codegen logic and generated code to fix runtime / compile errors in generated code. * Generate test runner only if there's >=1 test case(s) for the service. Narrow down imports to specific class used. * Add manual ignore lists for disabling codegen for smoke tests by their test ID or their test tag. * Add generic codegen for smoke tests * Rename variables to be more specific. --------- Co-authored-by: Sichan Yoo <[email protected]> chore: Updates version to 0.86.0

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

Merged

jbelkins commented Sep 22, 2024

View reviewed changes

Merge branch 'main' into jbe/sendable_document_and_streams

01cdc4d

sichanyoo approved these changes Sep 24, 2024

View reviewed changes

Merge branch 'main' into jbe/sendable_document_and_streams

51c9e67

jbelkins merged commit ea842e8 into main Sep 24, 2024
27 checks passed

jbelkins deleted the jbe/sendable_document_and_streams branch September 24, 2024 20:47

jbelkins added a commit that referenced this pull request Oct 28, 2024

feat: Make models Sendable (#829)

a2c0109

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

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