graphql-anycable 1.1.1 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0437da8b1214b8c5aa81733cd8b0b4449a527f9d7f487e3d0e97034ffefea2e
-  data.tar.gz: ef6d5a734dfc73824e2a37e7b3d3bcd47eb3af597b99a9d91a7aa41c7fc85797
+  metadata.gz: 8eacc1ccd4d1c59606ade3479520714b0aab25b2107b84d5147cc47c49a692d7
+  data.tar.gz: e1f4d1342578f7f0f0068ed7047758fc1a358441028407d790da2cc09967fc50
 SHA512:
-  metadata.gz: eae7c1026142f0d4360d556af37eeae4937e9cde79bf0e05a8aed6a3dac9e40a6445f7970b11bc9c8a25def13ee42d1c0507452d6c168805452dc9a7d8fb1c30
-  data.tar.gz: f2985e19bad56f101099ca1da605f0eb62b606034d595530c86bbd672b146b65ef7f54212813fdf110dba961dfaa14e400bab390505828b4a8dc7fa289039155
+  metadata.gz: c5c875158053244e4c7d49e5886b771f9ef0a70180b3ed61e5083698ad00bf2ed2cbc62eeca93effaa35a0d034822b4da3b46504619057d5435e9b398145914a
+  data.tar.gz: b1675532c18609d4bae817292e5604e51ac84d6a327ee84618b3463d0b3a7139f777ece788c503a0226d7c7a184b60950827c687c7cc96c2f3b3dc9d100cde96

data/.github/workflows/test.yml

@@ -10,33 +10,30 @@ on:
 
 jobs:
   test:
-    name: "GraphQL-Ruby ${{ matrix.graphql }} (interpreter: ${{ matrix.interpreter }} with AnyCable ${{ matrix.anycable }}, use_client_id: ${{ matrix.client_id }}) 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'
+            graphql: '~> 1.13.0'
             client_id: 'false'
-            interpreter: yes
+            anycable_rails: '~> 1.2.0'
           - ruby: 2.7
             graphql: '~> 1.12.0'
-            anycable: '~> 1.1.0'
-            client_id: 'false'
-            interpreter: yes
-          - ruby: 2.6
-            graphql: '~> 1.11.0'
-            anycable: '~> 1.0.0'
             client_id: 'true'
-            interpreter: no
+            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
@@ -55,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,25 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+## 1.1.4 - 2022-07-28
+
+- Fix deprecation warning about using client-side channel ids shown even if deprecated functionality was disabled in application code (not via config file or environment variable). [@gsamokovarov] ([#26](https://github.com/anycable/graphql-anycable/pull/26))
+
+  However, now deprecation warning won't be shown if graphql-anycable is used not in Ruby on Rails application.
+
+## 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

data/Gemfile

@@ -9,7 +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_VERSION", "~> 1.0"), require: false
+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,7 +28,7 @@ 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"

data/lib/graphql/anycable/config.rb

@@ -12,14 +12,6 @@ module GraphQL
       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/railtie.rb

@@ -9,6 +9,14 @@ module GraphQL
         path = File.expand_path(__dir__)
         Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
       end
+
+      config.after_initialize do
+        if GraphQL::AnyCable.config.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
 end

data/lib/graphql/anycable/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module AnyCable
-    VERSION = "1.1.1"
+    VERSION = "1.1.4"
   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)
@@ -252,7 +252,7 @@ module GraphQL
       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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-anycable
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.4
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2022-07-28 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