Merge pull request #152 from NeedleInAJayStack/feat/swift-concurrency

Breaking: Uses Swift Concurrency

Author: NeedleInAJayStack

MIGRATION.md

@@ -1,5 +1,30 @@
 # Migration
 
+## 2.0 to 3.0
+
+### NIO removal
+
+All NIO-based parameters and return types were removed, including all that used `EventLoopGroup` and `EventLoopFuture`s.
+
+As such, all `API.execute` and `API.subscribe` calls should have the `eventLoopGroup` argument removed, and the `await` keyword should be used. If access to an `eventLoopGroup` is required in the resolver, one should be passed via the `Context`.
+
+Also, all resolver closures have had the `eventLoopGroup` parameter removed, and all that return an `EventLoopFuture` should be converted to an `async` function.
+
+The documentation here may be very helpful in the conversion: https://www.swift.org/documentation/server/guides/libraries/concurrency-adoption-guidelines.html
+
+### Swift Concurrency checking
+
+With the conversion from NIO to Swift Concurrency, types used across async boundaries should conform to `Sendable` to avoid errors and warnings. This includes the Swift types and functions that back the GraphQL schema, including the `Resolver` and `Context` types. For more details on the conversion, see the [Sendable documentation](https://developer.apple.com/documentation/swift/sendable).
+
+### Subscription result changes
+
+The `API.subscribe(...)` will return a `Result<AsyncThrowingStream<GraphQLResult, Error>>`, instead of an `EventStream`. This means extracting the stream via a `.stream` call and downcasting to `ConcurrentEventStream` are no longer necessary.
+The `EventStream` and `SubscriptionResult` types have been removed.
+
+### GraphQL v4 upgrades
+
+See [the GraphQL v4 migration documentation](https://github.com/GraphQLSwift/GraphQL/blob/main/MIGRATION.md#3-to-4) for additional details.
+
 ## 1.0 to 2.0
 
 ### TypeReference removal
@@ -36,4 +61,4 @@ The deprecated `Types` type has been removed. Instead define types individually
 ### Reflection `isEncodable`
 
 The deprecated `Reflection.isEncodable(type: Any.Type) -> Bool` function has been removed. Please re-implement in your
-package if this functionality is needed.
+package if this functionality is needed.

Package.resolved

@@ -3,16 +3,18 @@ import PackageDescription
 
 let package = Package(
     name: "Graphiti",
+    platforms: [.macOS(.v10_15), .iOS(.v13), .tvOS(.v13), .watchOS(.v6)],
     products: [
         .library(name: "Graphiti", targets: ["Graphiti"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/GraphQLSwift/GraphQL.git", from: "3.0.0"),
+        .package(url: "https://github.com/GraphQLSwift/GraphQL.git", from: "4.0.0"),
     ],
     targets: [
         .target(name: "Graphiti", dependencies: ["GraphQL"]),
         .testTarget(name: "GraphitiTests", dependencies: ["Graphiti"], resources: [
             .copy("FederationTests/GraphQL"),
         ]),
-    ]
+    ],
+    swiftLanguageVersions: [.v5, .version("6")]
 )

Package.swift

@@ -1,4 +1,4 @@
-# Graphiti 
+# Graphiti
 
 Graphiti is a Swift library for building GraphQL schemas fast, safely and easily.
 
@@ -86,7 +86,7 @@ struct MessageAPI : API {
     let resolver: Resolver
     let schema: Schema<Resolver, Context>
 }
-        
+
 let api = MessageAPI(
     resolver: Resolver()
     schema: try! Schema<Resolver, Context> {
@@ -124,7 +124,7 @@ let api = MessageAPI(
     resolver: Resolver()
     schema: schema
 )
-``` 
+```
 
 </details>
 <details>
@@ -136,7 +136,7 @@ final class ChatSchema: PartialSchema<Resolver, Context> {
     public override var types: Types {
         Type(Message.self) {
             Field("content", at: \.content)
-        }        
+        }
     }
 
     @FieldDefinitions
@@ -152,7 +152,7 @@ let api = MessageAPI(
     resolver: Resolver()
     schema: schema
 )
-``` 
+```
 
 </details>
 
@@ -164,7 +164,7 @@ let chatSchema = PartialSchema<Resolver, Context>(
     types:  {
         Type(Message.self) {
             Field("content", at: \.content)
-        }        
+        }
     },
     query: {
         Field("message", at: Resolver.message)
@@ -178,7 +178,7 @@ let api = MessageAPI(
     resolver: Resolver()
     schema: schema
 )
-``` 
+```
 
 </details>
 
@@ -190,20 +190,10 @@ let api = MessageAPI(
 
 #### Querying
 
-To query the schema we need to pass in a NIO EventLoopGroup to feed the execute function alongside the query itself.
-
 ```swift
-import NIO
-
-let group = MultiThreadedEventLoopGroup(numberOfThreads: System.coreCount)
-defer {
-    try? group.syncShutdownGracefully()
-}
-
 let result = try await api.execute(
     request: "{ message { content } }",
-    context: Context(),
-    on: group
+    context: Context()
 )
 print(result)
 ```
@@ -228,27 +218,13 @@ struct Resolver {
 }
 ```
 
-#### NIO resolvers
-
-The resolver functions also support `NIO`-style concurrency. To do so, just add one more parameter with type `EventLoopGroup` to the resolver function and change the return type to `EventLoopFuture<YouReturnType>`. Don't forget to import NIO.
-
-```swift
-import NIO
-
-struct Resolver {
-    func message(context: Context, arguments: NoArguments, group: EventLoopGroup) -> EventLoopFuture<Message> {
-        group.next().makeSucceededFuture(context.message())
-    }
-}
-```
-
 #### Subscription
 
 This library supports GraphQL subscriptions, and supports them through the Swift Concurrency `AsyncThrowingStream` type. See the [Usage Guide](UsageGuide.md#subscriptions) for details.
 
 If you are unable to use Swift Concurrency, you must create a concrete subclass of the `EventStream` class that implements event streaming
 functionality. If you don't feel like creating a subclass yourself, you can use the [GraphQLRxSwift](https://github.com/GraphQLSwift/GraphQLRxSwift) repository
-to integrate [RxSwift](https://github.com/ReactiveX/RxSwift) observables out-of-the-box. Or you can use that repository as a reference to connect a different 
+to integrate [RxSwift](https://github.com/ReactiveX/RxSwift) observables out-of-the-box. Or you can use that repository as a reference to connect a different
 stream library like [ReactiveSwift](https://github.com/ReactiveCocoa/ReactiveSwift), [OpenCombine](https://github.com/OpenCombine/OpenCombine), or
 one that you've created yourself.
 

README.md

@@ -1,9 +1,8 @@
 import GraphQL
-import NIO
 
 public protocol API {
-    associatedtype Resolver
-    associatedtype ContextType
+    associatedtype Resolver: Sendable
+    associatedtype ContextType: Sendable
     var resolver: Resolver { get }
     var schema: Schema<Resolver, ContextType> { get }
 }
@@ -12,143 +11,59 @@ public extension API {
     func execute(
         request: String,
         context: ContextType,
-        on eventLoopGroup: EventLoopGroup,
         variables: [String: Map] = [:],
         operationName: String? = nil,
-        validationRules: [(ValidationContext) -> Visitor] = []
-    ) -> EventLoopFuture<GraphQLResult> {
-        return schema.execute(
-            request: request,
-            resolver: resolver,
-            context: context,
-            eventLoopGroup: eventLoopGroup,
-            variables: variables,
-            operationName: operationName,
-            validationRules: validationRules
-        )
-    }
-
-    func execute(
-        request: GraphQLRequest,
-        context: ContextType,
-        on eventLoopGroup: EventLoopGroup,
-        validationRules: [(ValidationContext) -> Visitor] = []
-    ) -> EventLoopFuture<GraphQLResult> {
-        return execute(
-            request: request.query,
-            context: context,
-            on: eventLoopGroup,
-            variables: request.variables,
-            operationName: request.operationName,
-            validationRules: validationRules
-        )
-    }
-
-    func subscribe(
-        request: String,
-        context: ContextType,
-        on eventLoopGroup: EventLoopGroup,
-        variables: [String: Map] = [:],
-        operationName: String? = nil,
-        validationRules: [(ValidationContext) -> Visitor] = []
-    ) -> EventLoopFuture<SubscriptionResult> {
-        return schema.subscribe(
-            request: request,
-            resolver: resolver,
-            context: context,
-            eventLoopGroup: eventLoopGroup,
-            variables: variables,
-            operationName: operationName,
-            validationRules: validationRules
-        )
-    }
-
-    func subscribe(
-        request: GraphQLRequest,
-        context: ContextType,
-        on eventLoopGroup: EventLoopGroup,
-        validationRules: [(ValidationContext) -> Visitor] = []
-    ) -> EventLoopFuture<SubscriptionResult> {
-        return subscribe(
-            request: request.query,
-            context: context,
-            on: eventLoopGroup,
-            variables: request.variables,
-            operationName: request.operationName,
-            validationRules: validationRules
-        )
-    }
-}
-
-public extension API {
-    @available(macOS 10.15, iOS 15, watchOS 8, tvOS 15, *)
-    func execute(
-        request: String,
-        context: ContextType,
-        on eventLoopGroup: EventLoopGroup,
-        variables: [String: Map] = [:],
-        operationName: String? = nil,
-        validationRules: [(ValidationContext) -> Visitor] = []
+        validationRules: [@Sendable (ValidationContext) -> Visitor] = []
     ) async throws -> GraphQLResult {
         return try await schema.execute(
             request: request,
             resolver: resolver,
             context: context,
-            eventLoopGroup: eventLoopGroup,
             variables: variables,
             operationName: operationName,
             validationRules: validationRules
-        ).get()
+        )
     }
 
-    @available(macOS 10.15, iOS 15, watchOS 8, tvOS 15, *)
     func execute(
         request: GraphQLRequest,
         context: ContextType,
-        on eventLoopGroup: EventLoopGroup,
-        validationRules: [(ValidationContext) -> Visitor] = []
+        validationRules: [@Sendable (ValidationContext) -> Visitor] = []
     ) async throws -> GraphQLResult {
         return try await execute(
             request: request.query,
             context: context,
-            on: eventLoopGroup,
             variables: request.variables,
             operationName: request.operationName,
             validationRules: validationRules
         )
     }
 
-    @available(macOS 10.15, iOS 15, watchOS 8, tvOS 15, *)
     func subscribe(
         request: String,
         context: ContextType,
-        on eventLoopGroup: EventLoopGroup,
         variables: [String: Map] = [:],
         operationName: String? = nil,
-        validationRules: [(ValidationContext) -> Visitor] = []
-    ) async throws -> SubscriptionResult {
+        validationRules: [@Sendable (ValidationContext) -> Visitor] = []
+    ) async throws -> Result<AsyncThrowingStream<GraphQLResult, Error>, GraphQLErrors> {
         return try await schema.subscribe(
             request: request,
             resolver: resolver,
             context: context,
-            eventLoopGroup: eventLoopGroup,
             variables: variables,
             operationName: operationName,
             validationRules: validationRules
-        ).get()
+        )
     }
 
-    @available(macOS 10.15, iOS 15, watchOS 8, tvOS 15, *)
     func subscribe(
         request: GraphQLRequest,
         context: ContextType,
-        on eventLoopGroup: EventLoopGroup,
-        validationRules: [(ValidationContext) -> Visitor] = []
-    ) async throws -> SubscriptionResult {
+        validationRules: [@Sendable (ValidationContext) -> Visitor] = []
+    ) async throws -> Result<AsyncThrowingStream<GraphQLResult, Error>, GraphQLErrors> {
         return try await subscribe(
             request: request.query,
             context: context,
-            on: eventLoopGroup,
             variables: request.variables,
             operationName: request.operationName,
             validationRules: validationRules

Sources/Graphiti/API/API.swift

@@ -2,7 +2,7 @@ import GraphQL
 
 public class Argument<ArgumentsType: Decodable, ArgumentType>: ArgumentComponent<ArgumentsType> {
     let name: String
-    var defaultValue: AnyEncodable? = nil
+    var defaultValue: AnyEncodable?
 
     override func argument(
         typeProvider: TypeProvider,