graphql-anycable 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e8f296cdfe805ab7eb4ea8247b3880b785ba1314c3c2ef25d3ac316765714b5
-  data.tar.gz: d010e06e309c4724a111ebb5cff503678bf53b0ba8039f438ecd86892073ef7d
+  metadata.gz: 2ff33e113bf80dad3da7cab49606e37f7b3b69783ce4e8b2bb0466bf3e636881
+  data.tar.gz: 6c9c58824c29cf9d35e7dc82c70c32b8e398c5482847f888133de5e9fb5ebdb9
 SHA512:
-  metadata.gz: c84765a3b9461f431da8e3ad4a31fdc50e28836d9b331e04af7374676002bb9b02c78d6e18512b1e776a8d13fa431232c5c019b059497ccdee6953adecbde53c
-  data.tar.gz: 3a741fbaaf27eea28bd0a1885cee1e7ac1b24e8bb8a270537751465fa78e1f73f1ef1a3ca1538670e7d90503292dc5e05d8511a8f81861144ee999c6a9f30e25
+  metadata.gz: 11f689864709223c38a4441b2546f285389ff7d32b694cc983ebda2cc3e829b271686eb25e2d2ca3df3bafa36d2b12ec61b6cb043c28b1b11b98683efb21c2d8
+  data.tar.gz: d973bb2885f9991b3be3fb13f0c8fec2c7815b67b993ced900d53812d0b661433f3db99cf193ee2b827c57ab59ea1d7111c34d6c8a8cf1923f8b01dfedebc34a

data/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+## 1.0.1 - 2021-04-16
+
+### Added
+
+ - Guard check for presence of ActionCable channel instance in the GraphQL execution context.
+
+   This allows to detect wrong configuration (user forgot to pass channel into context) or wrong usage (subscription query was sent via HTTP request, not via WebSocket channel) of the library and provides clear error message to gem users.
+
 ## 1.0.0 - 2021-04-01
 
 ### Added

data/lib/graphql/anycable/errors.rb

@@ -0,0 +1,20 @@
+module GraphQL
+  module AnyCable
+    # This error is thrown when ActionCable channel wasn't provided to subscription implementation.
+    # Typical cases:
+    #  1. application developer forgot to pass ActionCable channel into context
+    #  2. subscription query was sent via usual HTTP request, not websockets as intended
+    class ChannelConfigurationError < ::RuntimeError
+      def initialize(msg = nil)
+        super(msg || <<~DEFAULT_MESSAGE)
+          ActionCable channel wasn't provided in the context for GraphQL query execution!
+
+          This can occur in the following cases:
+           1. ActionCable channel instance wasn't passed into GraphQL execution context in the channel's execute method.
+              See https://github.com/anycable/graphql-anycable#usage
+           2. Subscription query was sent via usual HTTP request, not via WebSocket as intended
+        DEFAULT_MESSAGE
+      end
+    end
+  end
+end

data/lib/graphql/anycable/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module AnyCable
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/lib/graphql/subscriptions/anycable_subscriptions.rb

@@ -2,6 +2,7 @@
 
 require "anycable"
 require "graphql/subscriptions"
+require "graphql/anycable/errors"
 
 # rubocop: disable Metrics/AbcSize, Metrics/LineLength, Metrics/MethodLength
 
@@ -140,6 +141,8 @@ module GraphQL
         subscription_id = context.delete(:subscription_id) || build_id
         channel = context.delete(:channel)
 
+        raise GraphQL::AnyCable::ChannelConfigurationError unless channel
+
         events.each do |event|
           channel.stream_from(SUBSCRIPTIONS_PREFIX + event.fingerprint)
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-anycable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anycable
@@ -155,6 +155,7 @@ files:
 - lib/graphql/anycable.rb
 - lib/graphql/anycable/cleaner.rb
 - lib/graphql/anycable/config.rb
+- lib/graphql/anycable/errors.rb
 - lib/graphql/anycable/railtie.rb
 - lib/graphql/anycable/tasks/clean_expired_subscriptions.rake
 - lib/graphql/anycable/version.rb
@@ -178,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A drop-in replacement for GraphQL ActionCable subscriptions for AnyCable.