graphql-anycable 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ff33e113bf80dad3da7cab49606e37f7b3b69783ce4e8b2bb0466bf3e636881
-  data.tar.gz: 6c9c58824c29cf9d35e7dc82c70c32b8e398c5482847f888133de5e9fb5ebdb9
+  metadata.gz: 335a3ba62f65f0d6dfdd5eab2e1361382d192b5fbc910c591ced6f78296fb4ff
+  data.tar.gz: 9f392057c605fc0b74d6ea2c940409540b87e25ddb0a6dee34e47ad3929f652a
 SHA512:
-  metadata.gz: 11f689864709223c38a4441b2546f285389ff7d32b694cc983ebda2cc3e829b271686eb25e2d2ca3df3bafa36d2b12ec61b6cb043c28b1b11b98683efb21c2d8
-  data.tar.gz: d973bb2885f9991b3be3fb13f0c8fec2c7815b67b993ced900d53812d0b661433f3db99cf193ee2b827c57ab59ea1d7111c34d6c8a8cf1923f8b01dfedebc34a
+  metadata.gz: 55b8fbf37efbdeff43beb7266ed627491b1a592f9cfe7e803dfd420b49d988a8057cb4ad7df7dea916df4f4c555868e29bace42cc76d2ae692755421a05f8bd5
+  data.tar.gz: d0665b9ec01879f5898c7638a9325c156c2665966552edc20cd013d3dfefbbbbada8e7e22d32e31ce7d8e6e0f59576c9a377ff92ffd1eb8e674e4cef533c7659

data/.github/workflows/test.yml

@@ -18,19 +18,19 @@ jobs:
         include:
           - ruby: "3.0"
             graphql: '~> 1.12.0'
-            anycable: '~> 1.0.0'
+            anycable: '~> 1.1.0'
             interpreter: yes
           - ruby: "3.0"
             graphql: '~> 1.12.0'
-            anycable: '~> 1.0.0'
+            anycable: '~> 1.1.0'
             interpreter: no
           - ruby: 2.7
             graphql: '~> 1.12.0'
-            anycable: '~> 1.0.0'
+            anycable: '~> 1.1.0'
             interpreter: yes
           - ruby: 2.7
             graphql: '~> 1.12.0'
-            anycable: '~> 1.0.0'
+            anycable: '~> 1.1.0'
             interpreter: no
           - ruby: 2.6
             graphql: '~> 1.11.0'

data/CHANGELOG.md

@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+## 1.1.0 - 2021-11-17
+
+### Added
+
+- Support for generating unique channel IDs server-side and storing them in the channel states.
+
+  Currently, we rely on `params["channelId"]` to track subscriptions. This value is random when using `graphql-ruby` JS client, but is not guaranteed to be random in general.
+
+  Now you can opt-in to use server-side IDs by specifying `use_client_provided_uniq_id: false` in YAML config or thru the `GRAPHQL_ANYCABLE_USE_CLIENT_PROVIDED_UNIQ_ID=false` env var.
+
+  NOTE: Relying on client-side IDs is deprecated and will be removed in the future versions.
+
+  You must also update your cleanup code in the `Channel#unsubscribed`:
+
+```diff
+-        channel_id = params.fetch("channelId")
+-        MySchema.subscriptions.delete_channel_subscriptions(channel_id)
++        MySchema.subscriptions.delete_channel_subscriptions(self)
+```
+
 ## 1.0.1 - 2021-04-16
 
 ### Added

data/README.md

@@ -77,8 +77,7 @@ Or install it yourself as:
       end
     
       def unsubscribed
-        channel_id = params.fetch("channelId")
-        MySchema.subscriptions.delete_channel_subscriptions(channel_id)
+        MySchema.subscriptions.delete_channel_subscriptions(self)
       end
     
       private
@@ -142,6 +141,7 @@ GraphQL-AnyCable uses [anyway_config] to configure itself. There are several pos
     GRAPHQL_ANYCABLE_SUBSCRIPTION_EXPIRATION_SECONDS=604800
     GRAPHQL_ANYCABLE_USE_REDIS_OBJECT_ON_CLEANUP=true
     GRAPHQL_ANYCABLE_HANDLE_LEGACY_SUBSCRIPTIONS=false
+    GRAPHQL_ANYCABLE_USE_CLIENT_PROVIDED_UNIQ_ID=false
     ```
 
  2. YAML configuration files:
@@ -152,6 +152,7 @@ GraphQL-AnyCable uses [anyway_config] to configure itself. There are several pos
       subscription_expiration_seconds: 300 # 5 minutes
       use_redis_object_on_cleanup: false # For restricted redis installations
       handle_legacy_subscriptions: false # For seamless upgrade from pre-1.0 versions
+      use_client_provided_uniq_id: false # To avoid problems with non-uniqueness of Apollo channel identifiers
     ```
 
  3. Configuration from your application code:

data/lib/graphql/anycable/config.rb

@@ -11,6 +11,15 @@ module GraphQL
       attr_config subscription_expiration_seconds: nil
       attr_config use_redis_object_on_cleanup: true
       attr_config handle_legacy_subscriptions: false
+      attr_config use_client_provided_uniq_id: true
+
+      on_load do
+        next unless use_client_provided_uniq_id?
+
+        warn "[Deprecated] Using client provided channel uniq IDs could lead to unexpected behaviour, " \
+             " please, set GraphQL::AnyCable.config.use_client_provided_uniq_id = false or GRAPHQL_ANYCABLE_USE_CLIENT_PROVIDED_UNIQ_ID=false, " \
+             " and update the `#unsubscribed` callback code according to the latest docs."
+      end
     end
   end
 end

data/lib/graphql/anycable/version.rb

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

data/lib/graphql/subscriptions/anycable_subscriptions.rb

@@ -45,8 +45,7 @@ require "graphql/anycable/errors"
 #     end
 #
 #     def unsubscribed
-#       channel_id = params.fetch("channelId")
-#       MySchema.subscriptions.delete_channel_subscriptions(channel_id)
+#       MySchema.subscriptions.delete_channel_subscriptions(self)
 #     end
 #   end
 #
@@ -143,6 +142,12 @@ module GraphQL
 
         raise GraphQL::AnyCable::ChannelConfigurationError unless channel
 
+        channel_uniq_id = config.use_client_provided_uniq_id? ? channel.params["channelId"] : subscription_id
+
+        # Store subscription_id in the channel state to cleanup on disconnect
+        write_subscription_id(channel, channel_uniq_id)
+
+
         events.each do |event|
           channel.stream_from(SUBSCRIPTIONS_PREFIX + event.fingerprint)
         end
@@ -156,14 +161,14 @@ module GraphQL
         }
 
         redis.multi do
-          redis.sadd(CHANNEL_PREFIX + channel.params["channelId"], subscription_id)
+          redis.sadd(CHANNEL_PREFIX + channel_uniq_id, subscription_id)
           redis.mapped_hmset(SUBSCRIPTION_PREFIX + subscription_id, data)
           events.each do |event|
             redis.zincrby(FINGERPRINTS_PREFIX + event.topic, 1, event.fingerprint)
             redis.sadd(SUBSCRIPTIONS_PREFIX + event.fingerprint, subscription_id)
           end
           next unless config.subscription_expiration_seconds
-          redis.expire(CHANNEL_PREFIX + channel.params["channelId"], config.subscription_expiration_seconds)
+          redis.expire(CHANNEL_PREFIX + channel_uniq_id, config.subscription_expiration_seconds)
           redis.expire(SUBSCRIPTION_PREFIX + subscription_id, config.subscription_expiration_seconds)
         end
       end
@@ -217,7 +222,9 @@ module GraphQL
       end
 
       # The channel was closed, forget about it and its subscriptions
-      def delete_channel_subscriptions(channel_id)
+      def delete_channel_subscriptions(channel_or_id)
+        # For backward compatibility
+        channel_id = channel_or_id.is_a?(String) ? channel_or_id : read_subscription_id(channel_or_id)
         redis.smembers(CHANNEL_PREFIX + channel_id).each do |subscription_id|
           delete_subscription(subscription_id)
         end
@@ -229,6 +236,17 @@ module GraphQL
       def anycable
         @anycable ||= ::AnyCable.broadcast_adapter
       end
+
+      def read_subscription_id(channel)
+        return channel.instance_variable_get(:@__sid__) if channel.instance_variable_defined?(:@__sid__)
+
+        channel.instance_variable_set(:@__sid__, channel.connection.socket.istate["sid"])
+      end
+
+      def write_subscription_id(channel, val)
+        channel.connection.socket.istate["sid"] = val
+        channel.instance_variable_set(:@__sid__, val)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-anycable
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-16 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anycable