Merge pull request #3935 from rmosolgo/better-context-for-subscriptions-trigger

Build out a Query::Context instance for .trigger(...)

Author: rmosolgo

lib/graphql/subscriptions.rb

@@ -58,7 +58,13 @@ def initialize(schema:, broadcast: false, default_broadcastable: false, **rest)
     # @param scope [Symbol, String]
     # @param context [Hash]
     # @return [void]
-    def trigger(event_name, args, object, scope: nil, context: GraphQL::Query::NullContext)
+    def trigger(event_name, args, object, scope: nil, context: {})
+      # Make something as context-like as possible, even though there isn't a current query:
+      context = @schema.context_class.new(
+        query: GraphQL::Query.new(@schema, "", validate: false),
+        object: nil,
+        values: context
+      )
       event_name = event_name.to_s
 
       # Try with the verbatim input first:

spec/graphql/schema/subscription_spec.rb

@@ -395,7 +395,7 @@ def in_memory_subscription_count
       GRAPHQL
       assert_equal 1, in_memory_subscription_count
       obj = OpenStruct.new(toot: { body: "I am a C programmer" }, user: SubscriptionFieldSchema::USERS["matz"])
-      SubscriptionFieldSchema.subscriptions.trigger(:toot_was_tooted, {handle: "matz"}, obj, context: {})
+      SubscriptionFieldSchema.subscriptions.trigger(:toot_was_tooted, {handle: "matz"}, obj)
 
       mailbox = res.context[:subscription_mailbox]
       update_payload = mailbox.first
@@ -414,7 +414,7 @@ def in_memory_subscription_count
       GRAPHQL
 
       assert_equal 1, in_memory_subscription_count
-      SubscriptionFieldSchema.subscriptions.trigger(:users_joined, {}, {new_users: [{handle: "eileencodes"}, {handle: "tenderlove"}]}, context: {})
+      SubscriptionFieldSchema.subscriptions.trigger(:users_joined, {}, {new_users: [{handle: "eileencodes"}, {handle: "tenderlove"}]})
 
       update = res.context[:subscription_mailbox].first
       assert_equal [{"handle" => "eileencodes"}, {"handle" => "tenderlove"}], update["data"]["usersJoined"]["users"]
@@ -434,7 +434,7 @@ def in_memory_subscription_count
       assert_equal 2, in_memory_subscription_count
 
       obj = OpenStruct.new(toot: { body: "Merry Christmas, here's a new Ruby version" }, user: SubscriptionFieldSchema::USERS["matz"])
-      SubscriptionFieldSchema.subscriptions.trigger(:toot_was_tooted, {handle: "matz"}, obj, context: {})
+      SubscriptionFieldSchema.subscriptions.trigger(:toot_was_tooted, {handle: "matz"}, obj)
 
       mailbox1 = res1.context[:subscription_mailbox]
       mailbox2 = res2.context[:subscription_mailbox]
@@ -456,7 +456,7 @@ def in_memory_subscription_count
       GRAPHQL
       assert_equal 1, in_memory_subscription_count
       obj = OpenStruct.new(toot: { body: "I am a C programmer" }, user: SubscriptionFieldSchema::USERS["matz"])
-      SubscriptionFieldSchema.subscriptions.trigger(:toot_was_tooted, {handle: "matz"}, obj, context: {})
+      SubscriptionFieldSchema.subscriptions.trigger(:toot_was_tooted, {handle: "matz"}, obj)
 
       # Get 1 successful update
       mailbox = res.context[:subscription_mailbox]
@@ -467,7 +467,7 @@ def in_memory_subscription_count
       # Then cause a not-found and update again
       matz = SubscriptionFieldSchema::USERS.delete("matz")
       obj = OpenStruct.new(toot: { body: "Merry Christmas, here's a new Ruby version" }, user: matz)
-      SubscriptionFieldSchema.subscriptions.trigger(:toot_was_tooted, {handle: "matz"}, obj, context: {})
+      SubscriptionFieldSchema.subscriptions.trigger(:toot_was_tooted, {handle: "matz"}, obj)
       # there was no subsequent update
       assert_equal 1, mailbox.size
       # The database was cleaned up
@@ -485,7 +485,7 @@ def in_memory_subscription_count
       assert_equal 1, in_memory_subscription_count
       matz = SubscriptionFieldSchema::USERS["matz"]
       obj = OpenStruct.new(toot: { body: "I am a C programmer" }, user: matz)
-      SubscriptionFieldSchema.subscriptions.trigger(:toot_was_tooted, {handle: "matz"}, obj, context: {})
+      SubscriptionFieldSchema.subscriptions.trigger(:toot_was_tooted, {handle: "matz"}, obj)
 
       # Get 1 successful update
       mailbox = res.context[:subscription_mailbox]
@@ -496,7 +496,7 @@ def in_memory_subscription_count
       # Cause an authorized failure
       matz[:private] = true
       obj = OpenStruct.new(toot: { body: "Merry Christmas, here's a new Ruby version" }, user: matz)
-      SubscriptionFieldSchema.subscriptions.trigger(:toot_was_tooted, {handle: "matz"}, obj, context: {})
+      SubscriptionFieldSchema.subscriptions.trigger(:toot_was_tooted, {handle: "matz"}, obj)
       assert_equal 2, mailbox.size
       assert_equal ["Can't subscribe to private user ([\"tootWasTooted\"])"], mailbox.last["errors"].map { |e| e["message"] }
       # The subscription remains in place
@@ -516,7 +516,7 @@ def in_memory_subscription_count
       assert_equal 1, in_memory_subscription_count
       matz = SubscriptionFieldSchema::USERS["matz"]
       obj = OpenStruct.new(toot: { likes_count: 42 }, user: matz)
-      SubscriptionFieldSchema.subscriptions.trigger(:toot_was_tooted, {handle: "matz"}, obj, context: {})
+      SubscriptionFieldSchema.subscriptions.trigger(:toot_was_tooted, {handle: "matz"}, obj)
 
       # Get 1 successful update
       mailbox = res.context[:subscription_mailbox]
@@ -531,7 +531,7 @@ def in_memory_subscription_count
       assert_equal [], SubscriptionFieldSchema::InMemorySubscriptions::EVENT_REGISTRY.keys
       matz = SubscriptionFieldSchema::USERS["matz"]
       obj = OpenStruct.new(toot: { body: "I am a C programmer" }, user: matz)
-      SubscriptionFieldSchema.subscriptions.trigger(:toot_was_tooted, {handle: "matz"}, obj, context: {})
+      SubscriptionFieldSchema.subscriptions.trigger(:toot_was_tooted, {handle: "matz"}, obj)
       assert_equal [":tootWasTooted:user:matz"], SubscriptionFieldSchema::InMemorySubscriptions::EVENT_REGISTRY.keys
     end
   end
@@ -568,7 +568,7 @@ def in_memory_subscription_count
 
       obj = OpenStruct.new(toot: { body: "Hello from matz!" }, user: SubscriptionFieldSchema::USERS["matz"])
       err = assert_raises GraphQL::Subscriptions::SubscriptionScopeMissingError do
-        SubscriptionFieldSchema.subscriptions.trigger(:direct_toot_was_tooted, {}, obj, context: {})
+        SubscriptionFieldSchema.subscriptions.trigger(:direct_toot_was_tooted, {}, obj)
       end
       assert_equal expected_message, err.message
     end
@@ -594,11 +594,11 @@ def in_memory_subscription_count
 
       obj = OpenStruct.new(toot: { body: "Hello from matz!" }, user: SubscriptionFieldSchema::USERS["matz"])
 
-      SubscriptionFieldSchema.subscriptions.trigger(:direct_toot_was_tooted_with_optional_scope, {}, obj, context: {})
+      SubscriptionFieldSchema.subscriptions.trigger(:direct_toot_was_tooted_with_optional_scope, {}, obj)
       assert_equal 0, res.context[:subscription_mailbox].length
       assert_equal 1, res2.context[:subscription_mailbox].length
 
-      SubscriptionFieldSchema.subscriptions.trigger(:direct_toot_was_tooted_with_optional_scope, {}, obj, scope: :me, context: {})
+      SubscriptionFieldSchema.subscriptions.trigger(:direct_toot_was_tooted_with_optional_scope, {}, obj, scope: :me)
       assert_equal 1, res.context[:subscription_mailbox].length
       assert_equal 1, res2.context[:subscription_mailbox].length
     end
@@ -615,8 +615,8 @@ def in_memory_subscription_count
 
       # Only the subscription with scope :me should be in the mailbox
       obj = OpenStruct.new(toot: { body: "Hello from matz!" }, user: SubscriptionFieldSchema::USERS["matz"])
-      SubscriptionFieldSchema.subscriptions.trigger(:direct_toot_was_tooted, {}, obj, scope: :me, context: {})
-      SubscriptionFieldSchema.subscriptions.trigger(:direct_toot_was_tooted, {}, obj, scope: :not_me, context: {})
+      SubscriptionFieldSchema.subscriptions.trigger(:direct_toot_was_tooted, {}, obj, scope: :me)
+      SubscriptionFieldSchema.subscriptions.trigger(:direct_toot_was_tooted, {}, obj, scope: :not_me)
       mailbox = res.context[:subscription_mailbox]
 
       assert_equal 1, mailbox.length