Minor final cleanup

Author: Jay Herron

Sources/GraphQL/GraphQL.swift

@@ -40,6 +40,19 @@ public struct GraphQLResult : Equatable, Codable, CustomStringConvertible {
     }
 }
 
+/// SubscriptionResult wraps the observable and error data returned by the subscribe request.
+public struct SubscriptionResult {
+    public let observable: SubscriptionObservable?
+    public let errors: [GraphQLError]
+    
+    public init(observable: SubscriptionObservable? = nil, errors: [GraphQLError] = []) {
+        self.observable = observable
+        self.errors = errors
+    }
+}
+/// SubscriptionObservable represents an event stream of fully resolved GraphQL subscription results. Subscribers can be added to this stream.
+public typealias SubscriptionObservable = Observable<Future<GraphQLResult>>
+
 /// This is the primary entry point function for fulfilling GraphQL operations
 /// by parsing, validating, and executing a GraphQL document along side a
 /// GraphQL schema.

Sources/GraphQL/Subscription/Subscribe.swift

@@ -37,7 +37,6 @@ func subscribe(
     operationName: String? = nil
 ) -> EventLoopFuture<SubscriptionResult> {
 
-    
     let sourceFuture = createSourceEventStream(
         queryStrategy: queryStrategy,
         mutationStrategy: mutationStrategy,
@@ -252,7 +251,7 @@ func executeSubscription(
             return SourceEventStreamResult(errors: context.errors)
         } else if let error = resolved as? GraphQLError {
             return SourceEventStreamResult(errors: [error])
-        } else if let observable = resolved as? SourceEventStreamObservable {
+        } else if let observable = resolved as? SourceEventObservable {
             return SourceEventStreamResult(observable: observable)
         } else if resolved == nil {
             return SourceEventStreamResult(errors: [
@@ -262,36 +261,23 @@ func executeSubscription(
             let resolvedObj = resolved as AnyObject
             return SourceEventStreamResult(errors: [
                 GraphQLError(
-                    message: "Subscription field resolver must return SourceEventStreamObservable. Received: '\(resolvedObj)'"
+                    message: "Subscription field resolver must return SourceEventObservable. Received: '\(resolvedObj)'"
                 )
             ])
         }
     }
 }
 
-/// SubscriptionResult wraps the observable and error data returned by the subscribe request.
-public struct SubscriptionResult {
-    public let observable: SubscriptionObservable?
-    public let errors: [GraphQLError]
-    
-    public init(observable: SubscriptionObservable? = nil, errors: [GraphQLError] = []) {
-        self.observable = observable
-        self.errors = errors
-    }
-}
-/// SubscriptionObservable represents an event stream of fully resolved GraphQL subscription results. It can be used to add subscribers to this stream
-public typealias SubscriptionObservable = Observable<Future<GraphQLResult>>
-
 struct SourceEventStreamResult {
-    public let observable: SourceEventStreamObservable?
+    public let observable: SourceEventObservable?
     public let errors: [GraphQLError]
 
-    public init(observable: SourceEventStreamObservable? = nil, errors: [GraphQLError] = []) {
+    public init(observable: SourceEventObservable? = nil, errors: [GraphQLError] = []) {
         self.observable = observable
         self.errors = errors
     }
 }
-/// Observables MUST be declared as 'Any' due to Swift not having covariant generic support. Resolvers should handle type checks.
-typealias SourceEventStreamObservable = Observable<Any>
-
 
+// Subscription resolvers MUST return observables that are declared as 'Any' due to Swift not having covariant generic support for type
+// checking. Normal resolvers for subscription fields should handle type casting, same as resolvers for query fields.
+typealias SourceEventObservable = Observable<Any>

Tests/GraphQLTests/Subscription/SubscriptionTests.swift

@@ -8,7 +8,7 @@ class SubscriptionTests : XCTestCase {
 
     // MARK: Test primary graphqlSubscribe function
 
-    /// This is not present in graphql-js.
+    /// This test is not present in graphql-js, but just tests basic functionality.
     func testGraphqlSubscribe() throws {
         let db = EmailDb()
         let schema = db.defaultSchema()
@@ -261,7 +261,7 @@ class SubscriptionTests : XCTestCase {
             let graphQLError = error as! GraphQLError
             XCTAssertEqual(
                 graphQLError.message,
-                "Subscription field resolver must return SourceEventStreamObservable. Received: 'test'"
+                "Subscription field resolver must return SourceEventObservable. Received: 'test'"
             )
         }
     }
@@ -462,6 +462,7 @@ class SubscriptionTests : XCTestCase {
         var currentResult = GraphQLResult()
         let _ = subscription.subscribe { event in
             currentResult = try! event.element!.wait()
+            print(currentResult)
         }.disposed(by: db.disposeBag)
 
         db.trigger(email: Email(