graphql-anycable 1.1.0 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 335a3ba62f65f0d6dfdd5eab2e1361382d192b5fbc910c591ced6f78296fb4ff
-  data.tar.gz: 9f392057c605fc0b74d6ea2c940409540b87e25ddb0a6dee34e47ad3929f652a
+  metadata.gz: fe8111474650b5580715d08c4122d70db3dcf45a4e1760d561e05119124181f7
+  data.tar.gz: 02e62b9ab477143af5889de901181de56aab1d88ec6a174041f4a2307090bbb0
 SHA512:
-  metadata.gz: 55b8fbf37efbdeff43beb7266ed627491b1a592f9cfe7e803dfd420b49d988a8057cb4ad7df7dea916df4f4c555868e29bace42cc76d2ae692755421a05f8bd5
-  data.tar.gz: d0665b9ec01879f5898c7638a9325c156c2665966552edc20cd013d3dfefbbbbada8e7e22d32e31ce7d8e6e0f59576c9a377ff92ffd1eb8e674e4cef533c7659
+  metadata.gz: 9ff1cfaa560fc9361704545d6c071658e8847d07b8d37f72b2680396046788f5c65ce3d63a026b1af10192a96684a54e078d1b7a5572e13bf778d52fd1e5fd53
+  data.tar.gz: bc67b3fb5b20f6e0ec06637b40410ecdd6420d58f7cb4eb3eaa610a4258fda1139d2cfd24237280e1af74893c06a363b6e6611ae5c0146439c4d9094cb07b0c6

data/.github/workflows/test.yml

@@ -10,50 +10,31 @@ on:
 
 jobs:
   test:
-    name: "GraphQL-Ruby ${{ matrix.graphql }} (interpreter: ${{ matrix.interpreter }}) with AnyCable ${{ matrix.anycable }} on Ruby ${{ matrix.ruby }}"
+    name: "GraphQL-Ruby ${{ matrix.graphql }} on Ruby ${{ matrix.ruby }} (use_client_id: ${{ matrix.client_id }})"
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
         include:
+          - ruby: "3.1"
+            graphql: '~> 2.0.0'
+            client_id: 'false'
+            anycable_rails: '~> 1.3'
           - ruby: "3.0"
-            graphql: '~> 1.12.0'
-            anycable: '~> 1.1.0'
-            interpreter: yes
-          - ruby: "3.0"
-            graphql: '~> 1.12.0'
-            anycable: '~> 1.1.0'
-            interpreter: no
-          - ruby: 2.7
-            graphql: '~> 1.12.0'
-            anycable: '~> 1.1.0'
-            interpreter: yes
+            graphql: '~> 1.13.0'
+            client_id: 'false'
+            anycable_rails: '~> 1.2.0'
           - ruby: 2.7
             graphql: '~> 1.12.0'
-            anycable: '~> 1.1.0'
-            interpreter: no
-          - ruby: 2.6
-            graphql: '~> 1.11.0'
-            anycable: '~> 1.0.0'
-            interpreter: yes
-          - ruby: 2.6
-            graphql: '~> 1.11.0'
-            anycable: '~> 1.0.0'
-            interpreter: no
-          - ruby: 2.5
-            graphql: '~> 1.11.0'
-            anycable: '~> 1.0.0'
-            interpreter: yes
-          - ruby: 2.5
-            graphql: '~> 1.11.0'
-            anycable: '~> 1.0.0'
-            interpreter: no
+            client_id: 'true'
+            anycable_rails: '~> 1.1.0'
     container:
       image: ruby:${{ matrix.ruby }}
       env:
         CI: true
         GRAPHQL_RUBY_VERSION: ${{ matrix.graphql }}
-        ANYCABLE_VERSION: ${{ matrix.anycable }}
+        ANYCABLE_RAILS_VERSION: ${{ matrix.anycable_rails }}
+        GRAPHQL_ANYCABLE_USE_CLIENT_PROVIDED_UNIQ_ID: ${{ matrix.client_id }}
     steps:
       - uses: actions/checkout@v2
       - uses: actions/cache@v2
@@ -71,6 +52,4 @@ jobs:
           bundle install
           bundle update
       - name: Run RSpec
-        env:
-          GRAPHQL_RUBY_INTERPRETER: ${{ matrix.interpreter }}
         run: bundle exec rspec

data/CHANGELOG.md

@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+## 1.1.3 - 2022-03-11
+
+### Changed
+
+- Allow using graphql-anycable with GraphQL-Ruby 2.x (it seem to be already compatible). [@Envek]
+
+## 1.1.2 - 2022-03-11
+
+### Fixed
+
+- AnyCable 1.3.0 compatibility. [@palkan] [#21](https://github.com/anycable/graphql-anycable/pull/21)
+- Redis.rb 5.0 compatibility. [@palkan] [#21](https://github.com/anycable/graphql-anycable/pull/21)
+
+## 1.1.1 - 2021-12-06
+
+### Fixed
+
+- Handling of buggy istate values on unsubscribe (when `use_client_provided_uniq_id: false`). [@palkan] [#20](https://github.com/anycable/graphql-anycable/pull/20)
+- A bug when `#unsubscribe` happens before `#execute`. [@palkan] [#20](https://github.com/anycable/graphql-anycable/pull/20)
+
 ## 1.1.0 - 2021-11-17
 
 ### Added
@@ -142,3 +162,4 @@ Initial version: store subscriptions on redis, re-execute queries in sync. [@Env
 [@bibendi]: https://github.com/bibendi "Misha Merkushin"
 [@FX-HAO]: https://github.com/FX-HAO "Fuxin Hao"
 [@Envek]: https://github.com/Envek "Andrey Novikov"
+[@palkan]: https://github.com/palkan "Vladimir Dementyev"

data/Gemfile

@@ -9,6 +9,7 @@ gemspec
 
 gem "graphql",  ENV.fetch("GRAPHQL_RUBY_VERSION", "~> 1.12")
 gem "anycable", ENV.fetch("ANYCABLE_VERSION", "~> 1.0")
+gem "anycable-rails", ENV.fetch("ANYCABLE_RAILS_VERSION", "~> 1.2")
 
 group :development, :test do
   gem "pry"

data/README.md

@@ -111,8 +111,8 @@ By default all fields are marked as _not safe for broadcasting_. If a subscripti
 
 ```ruby
 class MySchema < GraphQL::Schema
-  use GraphQL::Execution::Interpreter # Required for graphql-ruby before 1.12.4
-  use GraphQL::Analysis::AST
+  use GraphQL::Execution::Interpreter # Required for graphql-ruby before 1.12. Remove it when upgrading to 2.0
+  use GraphQL::Analysis::AST # Required for graphql-ruby before 1.12. Remove it when upgrading to 2.0
   use GraphQL::AnyCable, broadcast: true, default_broadcastable: true
 
   subscription SubscriptionType
@@ -144,7 +144,7 @@ GraphQL-AnyCable uses [anyway_config] to configure itself. There are several pos
     GRAPHQL_ANYCABLE_USE_CLIENT_PROVIDED_UNIQ_ID=false
     ```
 
- 2. YAML configuration files:
+ 2. YAML configuration files (note that this is `config/graphql_anycable.yml`, *not* `config/anycable.yml`):
 
     ```yaml
     # config/graphql_anycable.yml
@@ -215,6 +215,39 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Releasing new versions
+
+1. Bump version number in `lib/graphql/anycable/version.rb`
+
+   In case of pre-releases keep in mind [rubygems/rubygems#3086](https://github.com/rubygems/rubygems/issues/3086) and check version with command like `Gem::Version.new(AfterCommitEverywhere::VERSION).to_s`
+
+2. Fill `CHANGELOG.md` with missing changes, add header with version and date.
+
+3. Make a commit:
+
+   ```sh
+   git add lib/graphql/anycable/version.rb CHANGELOG.md
+   version=$(ruby -r ./lib/graphql/anycable/version.rb -e "puts Gem::Version.new(GraphQL::AnyCable::VERSION)")
+   git commit --message="${version}: " --edit
+   ```
+
+4. Create annotated tag:
+
+   ```sh
+   git tag v${version} --annotate --message="${version}: " --edit --sign
+   ```
+
+5. Fill version name into subject line and (optionally) some description (list of changes will be taken from `CHANGELOG.md` and appended automatically)
+
+6. Push it:
+
+   ```sh
+   git push --follow-tags
+   ```
+
+7. GitHub Actions will create a new release, build and push gem into [rubygems.org](https://rubygems.org)! You're done!
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Envek/graphql-anycable.

data/graphql-anycable.gemspec

@@ -28,11 +28,14 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "anycable",      "~> 1.0"
   spec.add_dependency "anyway_config", ">= 1.3", "< 3"
-  spec.add_dependency "graphql",       "~> 1.11"
+  spec.add_dependency "graphql",       ">= 1.11", "< 3"
   spec.add_dependency "redis",         ">= 4.2.0"
 
+  spec.add_development_dependency "anycable-rails"
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "fakeredis"
+  spec.add_development_dependency "rack"
+  spec.add_development_dependency "railties"
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/graphql/anycable/version.rb

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

data/lib/graphql/subscriptions/anycable_subscriptions.rb

@@ -79,9 +79,9 @@ module GraphQL
         return if fingerprints.empty?
 
         fingerprint_subscription_ids = Hash[fingerprints.zip(
-          redis.pipelined do
+          redis.pipelined do |pipeline|
             fingerprints.map do |fingerprint|
-              redis.smembers(SUBSCRIPTIONS_PREFIX + fingerprint)
+              pipeline.smembers(SUBSCRIPTIONS_PREFIX + fingerprint)
             end
           end
         )]
@@ -160,16 +160,16 @@ module GraphQL
           events: events.map { |e| [e.topic, e.fingerprint] }.to_h.to_json,
         }
 
-        redis.multi do
-          redis.sadd(CHANNEL_PREFIX + channel_uniq_id, subscription_id)
-          redis.mapped_hmset(SUBSCRIPTION_PREFIX + subscription_id, data)
+        redis.multi do |pipeline|
+          pipeline.sadd(CHANNEL_PREFIX + channel_uniq_id, subscription_id)
+          pipeline.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)
+            pipeline.zincrby(FINGERPRINTS_PREFIX + event.topic, 1, event.fingerprint)
+            pipeline.sadd(SUBSCRIPTIONS_PREFIX + event.fingerprint, subscription_id)
           end
           next unless 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)
+          pipeline.expire(CHANNEL_PREFIX + channel_uniq_id, config.subscription_expiration_seconds)
+          pipeline.expire(SUBSCRIPTION_PREFIX + subscription_id, config.subscription_expiration_seconds)
         end
       end
 
@@ -191,19 +191,19 @@ module GraphQL
         events = redis.hget(SUBSCRIPTION_PREFIX + subscription_id, :events)
         events = events ? JSON.parse(events) : {}
         fingerprint_subscriptions = {}
-        redis.pipelined do
+        redis.pipelined do |pipeline|
           events.each do |topic, fingerprint|
-            redis.srem(SUBSCRIPTIONS_PREFIX + fingerprint, subscription_id)
-            score = redis.zincrby(FINGERPRINTS_PREFIX + topic, -1, fingerprint)
+            pipeline.srem(SUBSCRIPTIONS_PREFIX + fingerprint, subscription_id)
+            score = pipeline.zincrby(FINGERPRINTS_PREFIX + topic, -1, fingerprint)
             fingerprint_subscriptions[FINGERPRINTS_PREFIX + topic] = score
           end
           # Delete subscription itself
-          redis.del(SUBSCRIPTION_PREFIX + subscription_id)
+          pipeline.del(SUBSCRIPTION_PREFIX + subscription_id)
         end
         # Clean up fingerprints that doesn't have any subscriptions left
-        redis.pipelined do
+        redis.pipelined do |pipeline|
           fingerprint_subscriptions.each do |key, score|
-            redis.zremrangebyscore(key, '-inf', '0') if score.value.zero?
+            pipeline.zremrangebyscore(key, '-inf', '0') if score.value.zero?
           end
         end
         delete_legacy_subscription(subscription_id)
@@ -225,6 +225,10 @@ module GraphQL
       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)
+
+        # Missing in case disconnect happens before #execute
+        return unless channel_id
+
         redis.smembers(CHANNEL_PREFIX + channel_id).each do |subscription_id|
           delete_subscription(subscription_id)
         end
@@ -240,13 +244,30 @@ module GraphQL
       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"])
+        istate = fetch_channel_istate(channel)
+
+        return unless istate
+
+        channel.instance_variable_set(:@__sid__, istate["sid"])
       end
 
       def write_subscription_id(channel, val)
-        channel.connection.socket.istate["sid"] = val
+        channel.connection.anycable_socket.istate["sid"] = val
         channel.instance_variable_set(:@__sid__, val)
       end
+
+      def fetch_channel_istate(channel)
+        # For Rails integration
+        return channel.__istate__ if channel.respond_to?(:__istate__)
+
+        return unless channel.connection.socket.istate
+
+        if channel.connection.socket.istate[channel.identifier]
+          JSON.parse(channel.connection.socket.istate[channel.identifier])
+        else
+          channel.connection.socket.istate
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-anycable
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.3
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2022-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anycable
@@ -48,16 +48,22 @@ dependencies:
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +78,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: anycable-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +120,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement