graphql-anycable 0.4.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/workflows/build-release.yml +82 -0
- data/.github/workflows/test.yml +76 -0
- data/CHANGELOG.md +71 -0
- data/Gemfile +6 -0
- data/README.md +73 -4
- data/graphql-anycable.gemspec +4 -4
- data/lib/graphql-anycable.rb +6 -2
- data/lib/graphql/anycable/cleaner.rb +29 -4
- data/lib/graphql/anycable/config.rb +2 -1
- data/lib/graphql/anycable/errors.rb +20 -0
- data/lib/graphql/anycable/railtie.rb +1 -1
- data/lib/graphql/anycable/tasks/clean_expired_subscriptions.rake +15 -8
- data/lib/graphql/anycable/version.rb +2 -2
- data/lib/graphql/subscriptions/anycable_subscriptions.rb +104 -22
- metadata +26 -36
- data/.travis.yml +0 -35
- data/Appraisals +0 -15
- data/gemfiles/.bundle/config +0 -2
- data/gemfiles/anycable_0.6.gemfile +0 -14
- data/gemfiles/anycable_1.0.gemfile +0 -14
- data/gemfiles/graphql_1.10.gemfile +0 -14
- data/gemfiles/graphql_1.9.gemfile +0 -14
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2ff33e113bf80dad3da7cab49606e37f7b3b69783ce4e8b2bb0466bf3e636881
|
|
4
|
+
data.tar.gz: 6c9c58824c29cf9d35e7dc82c70c32b8e398c5482847f888133de5e9fb5ebdb9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 11f689864709223c38a4441b2546f285389ff7d32b694cc983ebda2cc3e829b271686eb25e2d2ca3df3bafa36d2b12ec61b6cb043c28b1b11b98683efb21c2d8
|
|
7
|
+
data.tar.gz: d973bb2885f9991b3be3fb13f0c8fec2c7815b67b993ced900d53812d0b661433f3db99cf193ee2b827c57ab59ea1d7111c34d6c8a8cf1923f8b01dfedebc34a
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
name: Build and release gem
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags:
|
|
6
|
+
- v*
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
release:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
steps:
|
|
12
|
+
- uses: actions/checkout@v2
|
|
13
|
+
with:
|
|
14
|
+
fetch-depth: 0 # Fetch current tag as annotated. See https://github.com/actions/checkout/issues/290
|
|
15
|
+
- uses: ruby/setup-ruby@v1
|
|
16
|
+
with:
|
|
17
|
+
ruby-version: 2.7
|
|
18
|
+
- name: "Extract data from tag: version, message, body"
|
|
19
|
+
id: tag
|
|
20
|
+
run: |
|
|
21
|
+
git fetch --tags --force # Really fetch annotated tag. See https://github.com/actions/checkout/issues/290#issuecomment-680260080
|
|
22
|
+
echo ::set-output name=version::${GITHUB_REF#refs/tags/v}
|
|
23
|
+
echo ::set-output name=subject::$(git for-each-ref $GITHUB_REF --format='%(contents:subject)')
|
|
24
|
+
BODY="$(git for-each-ref $GITHUB_REF --format='%(contents:body)')"
|
|
25
|
+
# Extract changelog entries between this and previous version headers
|
|
26
|
+
escaped_version=$(echo ${GITHUB_REF#refs/tags/v} | sed -e 's/[]\/$*.^[]/\\&/g')
|
|
27
|
+
changelog=$(awk "BEGIN{inrelease=0} /## ${escaped_version}/{inrelease=1;next} /## [0-9]+\.[0-9]+\.[0-9]+/{inrelease=0;exit} {if (inrelease) print}" CHANGELOG.md)
|
|
28
|
+
# Multiline body for release. See https://github.community/t/set-output-truncates-multiline-strings/16852/5
|
|
29
|
+
BODY="${BODY}"$'\n'"${changelog}"
|
|
30
|
+
BODY="${BODY//'%'/'%25'}"
|
|
31
|
+
BODY="${BODY//$'\n'/'%0A'}"
|
|
32
|
+
BODY="${BODY//$'\r'/'%0D'}"
|
|
33
|
+
echo "::set-output name=body::$BODY"
|
|
34
|
+
# Add pre-release option if tag name has any suffix after vMAJOR.MINOR.PATCH
|
|
35
|
+
if [[ ${GITHUB_REF#refs/tags/} =~ ^v[0-9]+\.[0-9]+\.[0-9]+.+ ]]; then
|
|
36
|
+
echo ::set-output name=prerelease::true
|
|
37
|
+
fi
|
|
38
|
+
- name: Build gem
|
|
39
|
+
run: gem build
|
|
40
|
+
- name: Calculate checksums
|
|
41
|
+
run: sha256sum graphql-anycable-${{ steps.tag.outputs.version }}.gem > SHA256SUM
|
|
42
|
+
- name: Check version
|
|
43
|
+
run: ls -l graphql-anycable-${{ steps.tag.outputs.version }}.gem
|
|
44
|
+
- name: Create Release
|
|
45
|
+
id: create_release
|
|
46
|
+
uses: actions/create-release@v1
|
|
47
|
+
env:
|
|
48
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
49
|
+
with:
|
|
50
|
+
tag_name: ${{ github.ref }}
|
|
51
|
+
release_name: ${{ steps.tag.outputs.subject }}
|
|
52
|
+
body: ${{ steps.tag.outputs.body }}
|
|
53
|
+
draft: false
|
|
54
|
+
prerelease: ${{ steps.tag.outputs.prerelease }}
|
|
55
|
+
- name: Upload built gem as release asset
|
|
56
|
+
uses: actions/upload-release-asset@v1
|
|
57
|
+
env:
|
|
58
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
59
|
+
with:
|
|
60
|
+
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
|
61
|
+
asset_path: graphql-anycable-${{ steps.tag.outputs.version }}.gem
|
|
62
|
+
asset_name: graphql-anycable-${{ steps.tag.outputs.version }}.gem
|
|
63
|
+
asset_content_type: application/x-tar
|
|
64
|
+
- name: Upload checksums as release asset
|
|
65
|
+
uses: actions/upload-release-asset@v1
|
|
66
|
+
env:
|
|
67
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
68
|
+
with:
|
|
69
|
+
upload_url: ${{ steps.create_release.outputs.upload_url }}
|
|
70
|
+
asset_path: SHA256SUM
|
|
71
|
+
asset_name: SHA256SUM
|
|
72
|
+
asset_content_type: text/plain
|
|
73
|
+
- name: Publish to GitHub packages
|
|
74
|
+
env:
|
|
75
|
+
GEM_HOST_API_KEY: Bearer ${{ secrets.GITHUB_TOKEN }}
|
|
76
|
+
run: |
|
|
77
|
+
gem push graphql-anycable-${{ steps.tag.outputs.version }}.gem --host https://rubygems.pkg.github.com/${{ github.repository_owner }}
|
|
78
|
+
- name: Publish to RubyGems
|
|
79
|
+
env:
|
|
80
|
+
GEM_HOST_API_KEY: "${{ secrets.RUBYGEMS_API_KEY }}"
|
|
81
|
+
run: |
|
|
82
|
+
gem push graphql-anycable-${{ steps.tag.outputs.version }}.gem
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
name: Tests
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
pull_request:
|
|
5
|
+
push:
|
|
6
|
+
branches:
|
|
7
|
+
- '**'
|
|
8
|
+
tags-ignore:
|
|
9
|
+
- 'v*'
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
test:
|
|
13
|
+
name: "GraphQL-Ruby ${{ matrix.graphql }} (interpreter: ${{ matrix.interpreter }}) with AnyCable ${{ matrix.anycable }} on Ruby ${{ matrix.ruby }}"
|
|
14
|
+
runs-on: ubuntu-latest
|
|
15
|
+
strategy:
|
|
16
|
+
fail-fast: false
|
|
17
|
+
matrix:
|
|
18
|
+
include:
|
|
19
|
+
- ruby: "3.0"
|
|
20
|
+
graphql: '~> 1.12.0'
|
|
21
|
+
anycable: '~> 1.0.0'
|
|
22
|
+
interpreter: yes
|
|
23
|
+
- ruby: "3.0"
|
|
24
|
+
graphql: '~> 1.12.0'
|
|
25
|
+
anycable: '~> 1.0.0'
|
|
26
|
+
interpreter: no
|
|
27
|
+
- ruby: 2.7
|
|
28
|
+
graphql: '~> 1.12.0'
|
|
29
|
+
anycable: '~> 1.0.0'
|
|
30
|
+
interpreter: yes
|
|
31
|
+
- ruby: 2.7
|
|
32
|
+
graphql: '~> 1.12.0'
|
|
33
|
+
anycable: '~> 1.0.0'
|
|
34
|
+
interpreter: no
|
|
35
|
+
- ruby: 2.6
|
|
36
|
+
graphql: '~> 1.11.0'
|
|
37
|
+
anycable: '~> 1.0.0'
|
|
38
|
+
interpreter: yes
|
|
39
|
+
- ruby: 2.6
|
|
40
|
+
graphql: '~> 1.11.0'
|
|
41
|
+
anycable: '~> 1.0.0'
|
|
42
|
+
interpreter: no
|
|
43
|
+
- ruby: 2.5
|
|
44
|
+
graphql: '~> 1.11.0'
|
|
45
|
+
anycable: '~> 1.0.0'
|
|
46
|
+
interpreter: yes
|
|
47
|
+
- ruby: 2.5
|
|
48
|
+
graphql: '~> 1.11.0'
|
|
49
|
+
anycable: '~> 1.0.0'
|
|
50
|
+
interpreter: no
|
|
51
|
+
container:
|
|
52
|
+
image: ruby:${{ matrix.ruby }}
|
|
53
|
+
env:
|
|
54
|
+
CI: true
|
|
55
|
+
GRAPHQL_RUBY_VERSION: ${{ matrix.graphql }}
|
|
56
|
+
ANYCABLE_VERSION: ${{ matrix.anycable }}
|
|
57
|
+
steps:
|
|
58
|
+
- uses: actions/checkout@v2
|
|
59
|
+
- uses: actions/cache@v2
|
|
60
|
+
with:
|
|
61
|
+
path: vendor/bundle
|
|
62
|
+
key: bundle-${{ matrix.ruby }}-${{ matrix.graphql }}-${{ matrix.anycable }}-${{ hashFiles('**/*.gemspec') }}-${{ hashFiles('**/Gemfile') }}
|
|
63
|
+
restore-keys: |
|
|
64
|
+
bundle-${{ matrix.ruby }}-${{ matrix.graphql }}-${{ matrix.anycable }}-
|
|
65
|
+
bundle-${{ matrix.ruby }}-
|
|
66
|
+
- name: Upgrade Bundler to 2.0 (for older Rubies)
|
|
67
|
+
run: gem install bundler -v '~> 2.0'
|
|
68
|
+
- name: Bundle install
|
|
69
|
+
run: |
|
|
70
|
+
bundle config path vendor/bundle
|
|
71
|
+
bundle install
|
|
72
|
+
bundle update
|
|
73
|
+
- name: Run RSpec
|
|
74
|
+
env:
|
|
75
|
+
GRAPHQL_RUBY_INTERPRETER: ${{ matrix.interpreter }}
|
|
76
|
+
run: bundle exec rspec
|
data/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,77 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
|
6
6
|
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## Unreleased
|
|
9
|
+
|
|
10
|
+
## 1.0.1 - 2021-04-16
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- Guard check for presence of ActionCable channel instance in the GraphQL execution context.
|
|
15
|
+
|
|
16
|
+
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.
|
|
17
|
+
|
|
18
|
+
## 1.0.0 - 2021-04-01
|
|
19
|
+
|
|
20
|
+
### Added
|
|
21
|
+
|
|
22
|
+
- Support for [Subscriptions Broadcast](https://graphql-ruby.org/subscriptions/broadcast.html) feature in GraphQL-Ruby 1.11+. [@Envek] ([#15](https://github.com/anycable/graphql-anycable/pull/15))
|
|
23
|
+
|
|
24
|
+
### Changed
|
|
25
|
+
|
|
26
|
+
- Subscription data storage format changed to support broadcasting feature (see [#15](https://github.com/anycable/graphql-anycable/pull/15))
|
|
27
|
+
|
|
28
|
+
### Removed
|
|
29
|
+
|
|
30
|
+
- Drop support for GraphQL-Ruby before 1.11
|
|
31
|
+
|
|
32
|
+
- Drop support for AnyCable before 1.0
|
|
33
|
+
|
|
34
|
+
- Drop `:action_cable_stream` option from context: it is not used in reality.
|
|
35
|
+
|
|
36
|
+
See [rmosolgo/graphql-ruby#3076](https://github.com/rmosolgo/graphql-ruby/pull/3076) for details
|
|
37
|
+
|
|
38
|
+
### Upgrading notes
|
|
39
|
+
|
|
40
|
+
1. Change method of plugging in of this gem from `use GraphQL::Subscriptions::AnyCableSubscriptions` to `use GraphQL::AnyCable`:
|
|
41
|
+
|
|
42
|
+
```ruby
|
|
43
|
+
use GraphQL::AnyCable
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
If you need broadcasting, add `broadcast: true` option and ensure that [Interpreter mode](https://graphql-ruby.org/queries/interpreter.html) is enabled.
|
|
47
|
+
|
|
48
|
+
```ruby
|
|
49
|
+
use GraphQL::Execution::Interpreter
|
|
50
|
+
use GraphQL::Analysis::AST
|
|
51
|
+
use GraphQL::AnyCable, broadcast: true, default_broadcastable: true
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
2. Enable `handle_legacy_subscriptions` setting for seamless upgrade from previous versions:
|
|
55
|
+
|
|
56
|
+
```sh
|
|
57
|
+
GRAPHQL_ANYCABLE_HANDLE_LEGACY_SUBSCRIPTIONS=true
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Disable or remove this setting when you sure that all clients has re-subscribed (e.g. after `subscription_expiration_seconds` has passed after upgrade) as it imposes small performance penalty.
|
|
61
|
+
|
|
62
|
+
## 0.5.0 - 2020-08-26
|
|
63
|
+
|
|
64
|
+
### Changed
|
|
65
|
+
|
|
66
|
+
- Allow to plug in this gem by calling `use GraphQL::AnyCable` instead of `use GraphQL::Subscriptions::AnyCableSubscriptions`. [@Envek]
|
|
67
|
+
- Rename `GraphQL::Anycable` constant to `GraphQL::AnyCable` for consistency with AnyCable itself. [@Envek]
|
|
68
|
+
|
|
69
|
+
## 0.4.2 - 2020-08-25
|
|
70
|
+
|
|
71
|
+
Technical release to test publishing via GitHub Actions.
|
|
72
|
+
|
|
73
|
+
## 0.4.1 - 2020-08-21
|
|
74
|
+
|
|
75
|
+
### Fixed
|
|
76
|
+
|
|
77
|
+
- Deprecation warning for `Redis#exist` usage on Redis Ruby client 4.2+. Switch to `exists?` method and require Redis 4.2+ (see [#14](https://github.com/anycable/graphql-anycable/issues/14)). [@Envek]
|
|
78
|
+
|
|
8
79
|
## 0.4.0 - 2020-03-19
|
|
9
80
|
|
|
10
81
|
### Added
|
data/Gemfile
CHANGED
|
@@ -7,10 +7,16 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
|
|
|
7
7
|
# Specify your gem's dependencies in graphql-anycable.gemspec
|
|
8
8
|
gemspec
|
|
9
9
|
|
|
10
|
+
gem "graphql", ENV.fetch("GRAPHQL_RUBY_VERSION", "~> 1.12")
|
|
11
|
+
gem "anycable", ENV.fetch("ANYCABLE_VERSION", "~> 1.0")
|
|
12
|
+
|
|
10
13
|
group :development, :test do
|
|
11
14
|
gem "pry"
|
|
12
15
|
gem "pry-byebug", platform: :mri
|
|
13
16
|
|
|
14
17
|
gem "rubocop"
|
|
15
18
|
gem "rubocop-rspec"
|
|
19
|
+
|
|
20
|
+
# See https://github.com/guilleiguaran/fakeredis/pull/247
|
|
21
|
+
gem "fakeredis", github: 'guilleiguaran/fakeredis'
|
|
16
22
|
end
|
data/README.md
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
A (mostly) drop-in replacement for default ActionCable subscriptions adapter shipped with [graphql gem] but works with [AnyCable]!
|
|
4
4
|
|
|
5
5
|
[](https://badge.fury.io/rb/graphql-anycable)
|
|
6
|
+
[](https://github.com/anycable/graphql-anycable/actions/workflows/test.yml)
|
|
6
7
|
|
|
7
8
|
<a href="https://evilmartians.com/?utm_source=graphql-anycable&utm_campaign=project_page">
|
|
8
9
|
<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
|
|
@@ -33,7 +34,7 @@ AnyCable must be configured with redis broadcast adapter (this is default).
|
|
|
33
34
|
Add this line to your application's Gemfile:
|
|
34
35
|
|
|
35
36
|
```ruby
|
|
36
|
-
gem 'graphql-anycable'
|
|
37
|
+
gem 'graphql-anycable', '~> 1.0'
|
|
37
38
|
```
|
|
38
39
|
|
|
39
40
|
And then execute:
|
|
@@ -50,7 +51,7 @@ Or install it yourself as:
|
|
|
50
51
|
|
|
51
52
|
```ruby
|
|
52
53
|
class MySchema < GraphQL::Schema
|
|
53
|
-
use GraphQL::
|
|
54
|
+
use GraphQL::AnyCable, broadcast: true
|
|
54
55
|
|
|
55
56
|
subscription SubscriptionType
|
|
56
57
|
end
|
|
@@ -99,6 +100,28 @@ Or install it yourself as:
|
|
|
99
100
|
MySchema.subscriptions.trigger(:product_updated, {}, Product.first!, scope: account.id)
|
|
100
101
|
```
|
|
101
102
|
|
|
103
|
+
## Broadcasting
|
|
104
|
+
|
|
105
|
+
By default, graphql-anycable evaluates queries and transmits results for every subscription client individually. Of course, it is a waste of resources if you have hundreds or thousands clients subscribed to the same data (and has huge negative impact on performance).
|
|
106
|
+
|
|
107
|
+
Thankfully, GraphQL-Ruby has added [Subscriptions Broadcast](https://graphql-ruby.org/subscriptions/broadcast.html) feature that allows to group exact same subscriptions, execute them and transmit results only once.
|
|
108
|
+
|
|
109
|
+
To enable this feature, turn on [Interpreter](https://graphql-ruby.org/queries/interpreter.html) and pass `broadcast` option set to `true` to graphql-anycable.
|
|
110
|
+
|
|
111
|
+
By default all fields are marked as _not safe for broadcasting_. If a subscription has at least one non-broadcastable field in its query, GraphQL-Ruby will execute every subscription for every client independently. If you sure that all your fields are safe to be broadcasted, you can pass `default_broadcastable` option set to `true` (but be aware that it can have security impllications!)
|
|
112
|
+
|
|
113
|
+
```ruby
|
|
114
|
+
class MySchema < GraphQL::Schema
|
|
115
|
+
use GraphQL::Execution::Interpreter # Required for graphql-ruby before 1.12.4
|
|
116
|
+
use GraphQL::Analysis::AST
|
|
117
|
+
use GraphQL::AnyCable, broadcast: true, default_broadcastable: true
|
|
118
|
+
|
|
119
|
+
subscription SubscriptionType
|
|
120
|
+
end
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
See GraphQL-Ruby [broadcasting docs](https://graphql-ruby.org/subscriptions/broadcast.html) for more details.
|
|
124
|
+
|
|
102
125
|
## Operations
|
|
103
126
|
|
|
104
127
|
To avoid filling Redis storage with stale subscription data:
|
|
@@ -111,13 +134,14 @@ To avoid filling Redis storage with stale subscription data:
|
|
|
111
134
|
|
|
112
135
|
## Configuration
|
|
113
136
|
|
|
114
|
-
GraphQL-
|
|
137
|
+
GraphQL-AnyCable uses [anyway_config] to configure itself. There are several possibilities to configure this gem:
|
|
115
138
|
|
|
116
139
|
1. Environment variables:
|
|
117
140
|
|
|
118
141
|
```.env
|
|
119
142
|
GRAPHQL_ANYCABLE_SUBSCRIPTION_EXPIRATION_SECONDS=604800
|
|
120
143
|
GRAPHQL_ANYCABLE_USE_REDIS_OBJECT_ON_CLEANUP=true
|
|
144
|
+
GRAPHQL_ANYCABLE_HANDLE_LEGACY_SUBSCRIPTIONS=false
|
|
121
145
|
```
|
|
122
146
|
|
|
123
147
|
2. YAML configuration files:
|
|
@@ -127,18 +151,63 @@ GraphQL-Anycable uses [anyway_config] to configure itself. There are several pos
|
|
|
127
151
|
production:
|
|
128
152
|
subscription_expiration_seconds: 300 # 5 minutes
|
|
129
153
|
use_redis_object_on_cleanup: false # For restricted redis installations
|
|
154
|
+
handle_legacy_subscriptions: false # For seamless upgrade from pre-1.0 versions
|
|
130
155
|
```
|
|
131
156
|
|
|
132
157
|
3. Configuration from your application code:
|
|
133
158
|
|
|
134
159
|
```ruby
|
|
135
|
-
GraphQL::
|
|
160
|
+
GraphQL::AnyCable.configure do |config|
|
|
136
161
|
config.subscription_expiration_seconds = 3600 # 1 hour
|
|
137
162
|
end
|
|
138
163
|
```
|
|
139
164
|
|
|
140
165
|
And any other way provided by [anyway_config]. Check its documentation!
|
|
141
166
|
|
|
167
|
+
## Data model
|
|
168
|
+
|
|
169
|
+
As in AnyCable there is no place to store subscription data in-memory, it should be persisted somewhere to be retrieved on `GraphQLSchema.subscriptions.trigger` and sent to subscribed clients. `graphql-anycable` uses the same Redis database as AnyCable itself.
|
|
170
|
+
|
|
171
|
+
1. Grouped event subscriptions: `graphql-fingerprints:#{event.topic}` sorted set. Used to find all subscriptions on `GraphQLSchema.subscriptions.trigger`.
|
|
172
|
+
|
|
173
|
+
```
|
|
174
|
+
ZREVRANGE graphql-fingerprints:1:myStats: 0 -1
|
|
175
|
+
=> 1:myStats:/MyStats/fBDZmJU1UGTorQWvOyUeaHVwUxJ3T9SEqnetj6SKGXc=/0/RBNvo1WzZ4oRRq0W9-hknpT7T8If536DEMBg9hyq_4o=
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
2. Event subscriptions: `graphql-subscriptions:#{event.fingerptint}` set containing identifiers for all subscriptions for given operation with certain context and arguments (serialized in _topic_). Fingerprints are already scoped by topic.
|
|
179
|
+
|
|
180
|
+
```
|
|
181
|
+
SMEMBERS graphql-subscriptions:1:myStats:/MyStats/fBDZmJU1UGTorQWvOyUeaHVwUxJ3T9SEqnetj6SKGXc=/0/RBNvo1WzZ4oRRq0W9-hknpT7T8If536DEMBg9hyq_4o=
|
|
182
|
+
=> 52ee8d65-275e-4d22-94af-313129116388
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
> For backward compatibility with pre-1.0 versions of this gem older `graphql-event:#{event.topic}` set containing subscription identifiers is also supported.
|
|
186
|
+
>
|
|
187
|
+
> ```
|
|
188
|
+
> SMEMBERS graphql-event:1:myStats:
|
|
189
|
+
> => 52ee8d65-275e-4d22-94af-313129116388
|
|
190
|
+
> ```
|
|
191
|
+
|
|
192
|
+
3. Subscription data: `graphql-subscription:#{subscription_id}` hash contains everything required to evaluate subscription on trigger and create data for client.
|
|
193
|
+
|
|
194
|
+
```
|
|
195
|
+
HGETALL graphql-subscription:52ee8d65-275e-4d22-94af-313129116388
|
|
196
|
+
=> {
|
|
197
|
+
context: '{"user_id":1,"user":{"__gid__":"Z2lkOi8vZWJheS1tYWcyL1VzZXIvMQ"}}',
|
|
198
|
+
variables: '{}',
|
|
199
|
+
operation_name: 'MyStats'
|
|
200
|
+
query_string: 'subscription MyStats { myStatsUpdated { completed total processed __typename } }',
|
|
201
|
+
}
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
4. Channel subscriptions: `graphql-channel:#{channel_id}` set containing identifiers for subscriptions created in ActionCable channel to delete them on client disconnect.
|
|
205
|
+
|
|
206
|
+
```
|
|
207
|
+
SMEMBERS graphql-channel:17420c6ed9e
|
|
208
|
+
=> 52ee8d65-275e-4d22-94af-313129116388
|
|
209
|
+
```
|
|
210
|
+
|
|
142
211
|
## Development
|
|
143
212
|
|
|
144
213
|
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
data/graphql-anycable.gemspec
CHANGED
|
@@ -6,7 +6,7 @@ require "graphql/anycable/version"
|
|
|
6
6
|
|
|
7
7
|
Gem::Specification.new do |spec|
|
|
8
8
|
spec.name = "graphql-anycable"
|
|
9
|
-
spec.version = GraphQL::
|
|
9
|
+
spec.version = GraphQL::AnyCable::VERSION
|
|
10
10
|
spec.authors = ["Andrey Novikov"]
|
|
11
11
|
spec.email = ["envek@envek.name"]
|
|
12
12
|
|
|
@@ -26,13 +26,13 @@ Gem::Specification.new do |spec|
|
|
|
26
26
|
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
|
27
27
|
spec.require_paths = ["lib"]
|
|
28
28
|
|
|
29
|
-
spec.add_dependency "anycable", "
|
|
29
|
+
spec.add_dependency "anycable", "~> 1.0"
|
|
30
30
|
spec.add_dependency "anyway_config", ">= 1.3", "< 3"
|
|
31
|
-
spec.add_dependency "graphql", "~> 1.
|
|
31
|
+
spec.add_dependency "graphql", "~> 1.11"
|
|
32
|
+
spec.add_dependency "redis", ">= 4.2.0"
|
|
32
33
|
|
|
33
34
|
spec.add_development_dependency "bundler", "~> 2.0"
|
|
34
35
|
spec.add_development_dependency "fakeredis"
|
|
35
36
|
spec.add_development_dependency "rake", ">= 12.3.3"
|
|
36
37
|
spec.add_development_dependency "rspec", "~> 3.0"
|
|
37
|
-
spec.add_development_dependency "appraisal"
|
|
38
38
|
end
|
data/lib/graphql-anycable.rb
CHANGED
|
@@ -9,7 +9,11 @@ require_relative "graphql/anycable/railtie" if defined?(Rails)
|
|
|
9
9
|
require_relative "graphql/subscriptions/anycable_subscriptions"
|
|
10
10
|
|
|
11
11
|
module GraphQL
|
|
12
|
-
module
|
|
12
|
+
module AnyCable
|
|
13
|
+
def self.use(schema, **options)
|
|
14
|
+
schema.use GraphQL::Subscriptions::AnyCableSubscriptions, **options
|
|
15
|
+
end
|
|
16
|
+
|
|
13
17
|
module_function
|
|
14
18
|
|
|
15
19
|
def redis
|
|
@@ -24,7 +28,7 @@ module GraphQL
|
|
|
24
28
|
end
|
|
25
29
|
|
|
26
30
|
def config
|
|
27
|
-
@config ||= GraphQL::
|
|
31
|
+
@config ||= GraphQL::AnyCable::Config.new
|
|
28
32
|
end
|
|
29
33
|
|
|
30
34
|
def configure
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
module GraphQL
|
|
4
|
-
module
|
|
4
|
+
module AnyCable
|
|
5
5
|
module Cleaner
|
|
6
6
|
extend self
|
|
7
7
|
|
|
@@ -9,6 +9,8 @@ module GraphQL
|
|
|
9
9
|
clean_channels
|
|
10
10
|
clean_subscriptions
|
|
11
11
|
clean_events
|
|
12
|
+
clean_fingerprint_subscriptions
|
|
13
|
+
clean_topic_fingerprints
|
|
12
14
|
end
|
|
13
15
|
|
|
14
16
|
def clean_channels
|
|
@@ -36,9 +38,11 @@ module GraphQL
|
|
|
36
38
|
end
|
|
37
39
|
|
|
38
40
|
def clean_events
|
|
41
|
+
return unless config.handle_legacy_subscriptions
|
|
42
|
+
|
|
39
43
|
redis.scan_each(match: "#{adapter::SUBSCRIPTION_EVENTS_PREFIX}*") do |key|
|
|
40
44
|
subscription_id = key.sub(/\A#{adapter::SUBSCRIPTION_EVENTS_PREFIX}/, "")
|
|
41
|
-
next if redis.exists(adapter::SUBSCRIPTION_PREFIX + subscription_id)
|
|
45
|
+
next if redis.exists?(adapter::SUBSCRIPTION_PREFIX + subscription_id)
|
|
42
46
|
|
|
43
47
|
redis.smembers(key).each do |event_topic|
|
|
44
48
|
redis.srem(adapter::EVENT_PREFIX + event_topic, subscription_id)
|
|
@@ -48,6 +52,27 @@ module GraphQL
|
|
|
48
52
|
end
|
|
49
53
|
end
|
|
50
54
|
|
|
55
|
+
def clean_fingerprint_subscriptions
|
|
56
|
+
redis.scan_each(match: "#{adapter::SUBSCRIPTIONS_PREFIX}*") do |key|
|
|
57
|
+
redis.smembers(key).each do |subscription_id|
|
|
58
|
+
next if redis.exists?(adapter::SUBSCRIPTION_PREFIX + subscription_id)
|
|
59
|
+
|
|
60
|
+
redis.srem(key, subscription_id)
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
def clean_topic_fingerprints
|
|
66
|
+
redis.scan_each(match: "#{adapter::FINGERPRINTS_PREFIX}*") do |key|
|
|
67
|
+
redis.zremrangebyscore(key, '-inf', '0')
|
|
68
|
+
redis.zrange(key, 0, -1).each do |fingerprint|
|
|
69
|
+
next if redis.exists?(adapter::SUBSCRIPTIONS_PREFIX + fingerprint)
|
|
70
|
+
|
|
71
|
+
redis.zrem(key, fingerprint)
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
|
|
51
76
|
private
|
|
52
77
|
|
|
53
78
|
def adapter
|
|
@@ -55,11 +80,11 @@ module GraphQL
|
|
|
55
80
|
end
|
|
56
81
|
|
|
57
82
|
def redis
|
|
58
|
-
GraphQL::
|
|
83
|
+
GraphQL::AnyCable.redis
|
|
59
84
|
end
|
|
60
85
|
|
|
61
86
|
def config
|
|
62
|
-
GraphQL::
|
|
87
|
+
GraphQL::AnyCable.config
|
|
63
88
|
end
|
|
64
89
|
end
|
|
65
90
|
end
|
|
@@ -3,13 +3,14 @@
|
|
|
3
3
|
require "anyway"
|
|
4
4
|
|
|
5
5
|
module GraphQL
|
|
6
|
-
module
|
|
6
|
+
module AnyCable
|
|
7
7
|
class Config < Anyway::Config
|
|
8
8
|
config_name :graphql_anycable
|
|
9
9
|
env_prefix :graphql_anycable
|
|
10
10
|
|
|
11
11
|
attr_config subscription_expiration_seconds: nil
|
|
12
12
|
attr_config use_redis_object_on_cleanup: true
|
|
13
|
+
attr_config handle_legacy_subscriptions: false
|
|
13
14
|
end
|
|
14
15
|
end
|
|
15
16
|
end
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
module GraphQL
|
|
2
|
+
module AnyCable
|
|
3
|
+
# This error is thrown when ActionCable channel wasn't provided to subscription implementation.
|
|
4
|
+
# Typical cases:
|
|
5
|
+
# 1. application developer forgot to pass ActionCable channel into context
|
|
6
|
+
# 2. subscription query was sent via usual HTTP request, not websockets as intended
|
|
7
|
+
class ChannelConfigurationError < ::RuntimeError
|
|
8
|
+
def initialize(msg = nil)
|
|
9
|
+
super(msg || <<~DEFAULT_MESSAGE)
|
|
10
|
+
ActionCable channel wasn't provided in the context for GraphQL query execution!
|
|
11
|
+
|
|
12
|
+
This can occur in the following cases:
|
|
13
|
+
1. ActionCable channel instance wasn't passed into GraphQL execution context in the channel's execute method.
|
|
14
|
+
See https://github.com/anycable/graphql-anycable#usage
|
|
15
|
+
2. Subscription query was sent via usual HTTP request, not via WebSocket as intended
|
|
16
|
+
DEFAULT_MESSAGE
|
|
17
|
+
end
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|
|
@@ -5,25 +5,32 @@ require "graphql-anycable"
|
|
|
5
5
|
namespace :graphql do
|
|
6
6
|
namespace :anycable do
|
|
7
7
|
desc "Clean up stale graphql channels, subscriptions, and events from redis"
|
|
8
|
-
task clean: %i[clean:channels clean:subscriptions clean:events]
|
|
9
|
-
|
|
10
|
-
# Old name that was used earlier
|
|
11
|
-
task clean_expired_subscriptions: :clean
|
|
8
|
+
task clean: %i[clean:channels clean:subscriptions clean:events clean:fingerprint_subscriptions clean:topic_fingerprints]
|
|
12
9
|
|
|
13
10
|
namespace :clean do
|
|
14
11
|
# Clean up old channels
|
|
15
12
|
task :channels do
|
|
16
|
-
GraphQL::
|
|
13
|
+
GraphQL::AnyCable::Cleaner.clean_channels
|
|
17
14
|
end
|
|
18
15
|
|
|
19
16
|
# Clean up old subscriptions (they should have expired by themselves)
|
|
20
17
|
task :subscriptions do
|
|
21
|
-
GraphQL::
|
|
18
|
+
GraphQL::AnyCable::Cleaner.clean_subscriptions
|
|
22
19
|
end
|
|
23
20
|
|
|
24
|
-
# Clean up subscription_ids from events for expired subscriptions
|
|
21
|
+
# Clean up legacy subscription_ids from events for expired subscriptions
|
|
25
22
|
task :events do
|
|
26
|
-
GraphQL::
|
|
23
|
+
GraphQL::AnyCable::Cleaner.clean_events
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
# Clean up subscription_ids from event fingerprints for expired subscriptions
|
|
27
|
+
task :fingerprint_subscriptions do
|
|
28
|
+
GraphQL::AnyCable::Cleaner.clean_fingerprint_subscriptions
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
# Clean up fingerprints from event topics. for expired subscriptions
|
|
32
|
+
task :topic_fingerprints do
|
|
33
|
+
GraphQL::AnyCable::Cleaner.clean_topic_fingerprints
|
|
27
34
|
end
|
|
28
35
|
end
|
|
29
36
|
end
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
require "anycable"
|
|
4
4
|
require "graphql/subscriptions"
|
|
5
|
+
require "graphql/anycable/errors"
|
|
5
6
|
|
|
6
7
|
# rubocop: disable Metrics/AbcSize, Metrics/LineLength, Metrics/MethodLength
|
|
7
8
|
|
|
@@ -54,12 +55,15 @@ module GraphQL
|
|
|
54
55
|
class AnyCableSubscriptions < GraphQL::Subscriptions
|
|
55
56
|
extend Forwardable
|
|
56
57
|
|
|
57
|
-
def_delegators :"GraphQL::
|
|
58
|
+
def_delegators :"GraphQL::AnyCable", :redis, :config
|
|
58
59
|
|
|
59
|
-
SUBSCRIPTION_PREFIX
|
|
60
|
-
|
|
60
|
+
SUBSCRIPTION_PREFIX = "graphql-subscription:" # HASH: Stores subscription data: query, context, …
|
|
61
|
+
FINGERPRINTS_PREFIX = "graphql-fingerprints:" # ZSET: To get fingerprints by topic
|
|
62
|
+
SUBSCRIPTIONS_PREFIX = "graphql-subscriptions:" # SET: To get subscriptions by fingerprint
|
|
63
|
+
CHANNEL_PREFIX = "graphql-channel:" # SET: Auxiliary structure for whole channel's subscriptions cleanup
|
|
64
|
+
# For backward compatibility:
|
|
61
65
|
EVENT_PREFIX = "graphql-event:"
|
|
62
|
-
|
|
66
|
+
SUBSCRIPTION_EVENTS_PREFIX = "graphql-subscription-events:"
|
|
63
67
|
|
|
64
68
|
# @param serializer [<#dump(obj), #load(string)] Used for serializing messages before handing them to `.broadcast(msg)`
|
|
65
69
|
def initialize(serializer: Serialize, **rest)
|
|
@@ -70,40 +74,93 @@ module GraphQL
|
|
|
70
74
|
# An event was triggered.
|
|
71
75
|
# Re-evaluate all subscribed queries and push the data over ActionCable.
|
|
72
76
|
def execute_all(event, object)
|
|
77
|
+
execute_legacy(event, object) if config.handle_legacy_subscriptions
|
|
78
|
+
|
|
79
|
+
fingerprints = redis.zrange(FINGERPRINTS_PREFIX + event.topic, 0, -1)
|
|
80
|
+
return if fingerprints.empty?
|
|
81
|
+
|
|
82
|
+
fingerprint_subscription_ids = Hash[fingerprints.zip(
|
|
83
|
+
redis.pipelined do
|
|
84
|
+
fingerprints.map do |fingerprint|
|
|
85
|
+
redis.smembers(SUBSCRIPTIONS_PREFIX + fingerprint)
|
|
86
|
+
end
|
|
87
|
+
end
|
|
88
|
+
)]
|
|
89
|
+
|
|
90
|
+
fingerprint_subscription_ids.each do |fingerprint, subscription_ids|
|
|
91
|
+
execute_grouped(fingerprint, subscription_ids, event, object)
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
# Call to +trigger+ returns this. Convenient for playing in console
|
|
95
|
+
Hash[fingerprint_subscription_ids.map { |k,v| [k, v.size] }]
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
# The fingerprint has told us that this response should be shared by all subscribers,
|
|
99
|
+
# so just run it once, then deliver the result to every subscriber
|
|
100
|
+
def execute_grouped(fingerprint, subscription_ids, event, object)
|
|
101
|
+
return if subscription_ids.empty?
|
|
102
|
+
|
|
103
|
+
subscription_id = subscription_ids.find { |sid| redis.exists?(SUBSCRIPTION_PREFIX + sid) }
|
|
104
|
+
return unless subscription_id # All subscriptions has expired but haven't cleaned up yet
|
|
105
|
+
|
|
106
|
+
result = execute_update(subscription_id, event, object)
|
|
107
|
+
return unless result
|
|
108
|
+
|
|
109
|
+
# Having calculated the result _once_, send the same payload to all subscribers
|
|
110
|
+
deliver(SUBSCRIPTIONS_PREFIX + fingerprint, result)
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
# For migration from pre-1.0 graphql-anycable gem
|
|
114
|
+
def execute_legacy(event, object)
|
|
73
115
|
redis.smembers(EVENT_PREFIX + event.topic).each do |subscription_id|
|
|
74
|
-
next unless redis.exists(SUBSCRIPTION_PREFIX + subscription_id)
|
|
75
|
-
|
|
116
|
+
next unless redis.exists?(SUBSCRIPTION_PREFIX + subscription_id)
|
|
117
|
+
result = execute_update(subscription_id, event, object)
|
|
118
|
+
next unless result
|
|
119
|
+
|
|
120
|
+
deliver(SUBSCRIPTION_PREFIX + subscription_id, result)
|
|
76
121
|
end
|
|
77
122
|
end
|
|
78
123
|
|
|
124
|
+
# Disable this method as there is no fingerprint (it can be retrieved from subscription though)
|
|
125
|
+
def execute(subscription_id, event, object)
|
|
126
|
+
raise NotImplementedError, "Use execute_all method instead of execute to get actual event fingerprint"
|
|
127
|
+
end
|
|
128
|
+
|
|
79
129
|
# This subscription was re-evaluated.
|
|
80
130
|
# Send it to the specific stream where this client was waiting.
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
131
|
+
# @param strean_key [String]
|
|
132
|
+
# @param result [#to_h] result to send to clients
|
|
133
|
+
def deliver(stream_key, result)
|
|
134
|
+
payload = { result: result.to_h, more: true }.to_json
|
|
135
|
+
anycable.broadcast(stream_key, payload)
|
|
84
136
|
end
|
|
85
137
|
|
|
86
138
|
# Save query to "storage" (in redis)
|
|
87
139
|
def write_subscription(query, events)
|
|
88
140
|
context = query.context.to_h
|
|
89
|
-
subscription_id = context
|
|
141
|
+
subscription_id = context.delete(:subscription_id) || build_id
|
|
90
142
|
channel = context.delete(:channel)
|
|
91
|
-
|
|
92
|
-
channel
|
|
143
|
+
|
|
144
|
+
raise GraphQL::AnyCable::ChannelConfigurationError unless channel
|
|
145
|
+
|
|
146
|
+
events.each do |event|
|
|
147
|
+
channel.stream_from(SUBSCRIPTIONS_PREFIX + event.fingerprint)
|
|
148
|
+
end
|
|
93
149
|
|
|
94
150
|
data = {
|
|
95
151
|
query_string: query.query_string,
|
|
96
152
|
variables: query.provided_variables.to_json,
|
|
97
153
|
context: @serializer.dump(context.to_h),
|
|
98
|
-
operation_name: query.operation_name
|
|
154
|
+
operation_name: query.operation_name,
|
|
155
|
+
events: events.map { |e| [e.topic, e.fingerprint] }.to_h.to_json,
|
|
99
156
|
}
|
|
100
157
|
|
|
101
158
|
redis.multi do
|
|
102
159
|
redis.sadd(CHANNEL_PREFIX + channel.params["channelId"], subscription_id)
|
|
103
160
|
redis.mapped_hmset(SUBSCRIPTION_PREFIX + subscription_id, data)
|
|
104
|
-
redis.sadd(SUBSCRIPTION_EVENTS_PREFIX + subscription_id, events.map(&:topic))
|
|
105
161
|
events.each do |event|
|
|
106
|
-
redis.
|
|
162
|
+
redis.zincrby(FINGERPRINTS_PREFIX + event.topic, 1, event.fingerprint)
|
|
163
|
+
redis.sadd(SUBSCRIPTIONS_PREFIX + event.fingerprint, subscription_id)
|
|
107
164
|
end
|
|
108
165
|
next unless config.subscription_expiration_seconds
|
|
109
166
|
redis.expire(CHANNEL_PREFIX + channel.params["channelId"], config.subscription_expiration_seconds)
|
|
@@ -117,24 +174,49 @@ module GraphQL
|
|
|
117
174
|
"#{SUBSCRIPTION_PREFIX}#{subscription_id}",
|
|
118
175
|
:query_string, :variables, :context, :operation_name
|
|
119
176
|
).tap do |subscription|
|
|
177
|
+
return if subscription.values.all?(&:nil?) # Redis returns hash with all nils for missing key
|
|
178
|
+
|
|
120
179
|
subscription[:context] = @serializer.load(subscription[:context])
|
|
121
180
|
subscription[:variables] = JSON.parse(subscription[:variables])
|
|
122
181
|
subscription[:operation_name] = nil if subscription[:operation_name].strip == ""
|
|
123
182
|
end
|
|
124
183
|
end
|
|
125
184
|
|
|
126
|
-
# The channel was closed, forget about it.
|
|
127
185
|
def delete_subscription(subscription_id)
|
|
128
|
-
|
|
186
|
+
events = redis.hget(SUBSCRIPTION_PREFIX + subscription_id, :events)
|
|
187
|
+
events = events ? JSON.parse(events) : {}
|
|
188
|
+
fingerprint_subscriptions = {}
|
|
189
|
+
redis.pipelined do
|
|
190
|
+
events.each do |topic, fingerprint|
|
|
191
|
+
redis.srem(SUBSCRIPTIONS_PREFIX + fingerprint, subscription_id)
|
|
192
|
+
score = redis.zincrby(FINGERPRINTS_PREFIX + topic, -1, fingerprint)
|
|
193
|
+
fingerprint_subscriptions[FINGERPRINTS_PREFIX + topic] = score
|
|
194
|
+
end
|
|
195
|
+
# Delete subscription itself
|
|
196
|
+
redis.del(SUBSCRIPTION_PREFIX + subscription_id)
|
|
197
|
+
end
|
|
198
|
+
# Clean up fingerprints that doesn't have any subscriptions left
|
|
199
|
+
redis.pipelined do
|
|
200
|
+
fingerprint_subscriptions.each do |key, score|
|
|
201
|
+
redis.zremrangebyscore(key, '-inf', '0') if score.value.zero?
|
|
202
|
+
end
|
|
203
|
+
end
|
|
204
|
+
delete_legacy_subscription(subscription_id)
|
|
205
|
+
end
|
|
206
|
+
|
|
207
|
+
def delete_legacy_subscription(subscription_id)
|
|
208
|
+
return unless config.handle_legacy_subscriptions
|
|
209
|
+
|
|
129
210
|
events = redis.smembers(SUBSCRIPTION_EVENTS_PREFIX + subscription_id)
|
|
130
|
-
|
|
131
|
-
|
|
211
|
+
redis.pipelined do
|
|
212
|
+
events.each do |event_topic|
|
|
213
|
+
redis.srem(EVENT_PREFIX + event_topic, subscription_id)
|
|
214
|
+
end
|
|
215
|
+
redis.del(SUBSCRIPTION_EVENTS_PREFIX + subscription_id)
|
|
132
216
|
end
|
|
133
|
-
# Delete subscription itself
|
|
134
|
-
redis.del(SUBSCRIPTION_EVENTS_PREFIX + subscription_id)
|
|
135
|
-
redis.del(SUBSCRIPTION_PREFIX + subscription_id)
|
|
136
217
|
end
|
|
137
218
|
|
|
219
|
+
# The channel was closed, forget about it and its subscriptions
|
|
138
220
|
def delete_channel_subscriptions(channel_id)
|
|
139
221
|
redis.smembers(CHANNEL_PREFIX + channel_id).each do |subscription_id|
|
|
140
222
|
delete_subscription(subscription_id)
|
metadata
CHANGED
|
@@ -1,35 +1,29 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: graphql-anycable
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 1.0.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Andrey Novikov
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2021-04-16 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: anycable
|
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
|
16
16
|
requirements:
|
|
17
|
-
- - "
|
|
18
|
-
- !ruby/object:Gem::Version
|
|
19
|
-
version: 0.6.0
|
|
20
|
-
- - "<"
|
|
17
|
+
- - "~>"
|
|
21
18
|
- !ruby/object:Gem::Version
|
|
22
|
-
version: '
|
|
19
|
+
version: '1.0'
|
|
23
20
|
type: :runtime
|
|
24
21
|
prerelease: false
|
|
25
22
|
version_requirements: !ruby/object:Gem::Requirement
|
|
26
23
|
requirements:
|
|
27
|
-
- - "
|
|
28
|
-
- !ruby/object:Gem::Version
|
|
29
|
-
version: 0.6.0
|
|
30
|
-
- - "<"
|
|
24
|
+
- - "~>"
|
|
31
25
|
- !ruby/object:Gem::Version
|
|
32
|
-
version: '
|
|
26
|
+
version: '1.0'
|
|
33
27
|
- !ruby/object:Gem::Dependency
|
|
34
28
|
name: anyway_config
|
|
35
29
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -56,14 +50,28 @@ dependencies:
|
|
|
56
50
|
requirements:
|
|
57
51
|
- - "~>"
|
|
58
52
|
- !ruby/object:Gem::Version
|
|
59
|
-
version: '1.
|
|
53
|
+
version: '1.11'
|
|
60
54
|
type: :runtime
|
|
61
55
|
prerelease: false
|
|
62
56
|
version_requirements: !ruby/object:Gem::Requirement
|
|
63
57
|
requirements:
|
|
64
58
|
- - "~>"
|
|
65
59
|
- !ruby/object:Gem::Version
|
|
66
|
-
version: '1.
|
|
60
|
+
version: '1.11'
|
|
61
|
+
- !ruby/object:Gem::Dependency
|
|
62
|
+
name: redis
|
|
63
|
+
requirement: !ruby/object:Gem::Requirement
|
|
64
|
+
requirements:
|
|
65
|
+
- - ">="
|
|
66
|
+
- !ruby/object:Gem::Version
|
|
67
|
+
version: 4.2.0
|
|
68
|
+
type: :runtime
|
|
69
|
+
prerelease: false
|
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
71
|
+
requirements:
|
|
72
|
+
- - ">="
|
|
73
|
+
- !ruby/object:Gem::Version
|
|
74
|
+
version: 4.2.0
|
|
67
75
|
- !ruby/object:Gem::Dependency
|
|
68
76
|
name: bundler
|
|
69
77
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -120,20 +128,6 @@ dependencies:
|
|
|
120
128
|
- - "~>"
|
|
121
129
|
- !ruby/object:Gem::Version
|
|
122
130
|
version: '3.0'
|
|
123
|
-
- !ruby/object:Gem::Dependency
|
|
124
|
-
name: appraisal
|
|
125
|
-
requirement: !ruby/object:Gem::Requirement
|
|
126
|
-
requirements:
|
|
127
|
-
- - ">="
|
|
128
|
-
- !ruby/object:Gem::Version
|
|
129
|
-
version: '0'
|
|
130
|
-
type: :development
|
|
131
|
-
prerelease: false
|
|
132
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
133
|
-
requirements:
|
|
134
|
-
- - ">="
|
|
135
|
-
- !ruby/object:Gem::Version
|
|
136
|
-
version: '0'
|
|
137
131
|
description:
|
|
138
132
|
email:
|
|
139
133
|
- envek@envek.name
|
|
@@ -143,11 +137,11 @@ extra_rdoc_files: []
|
|
|
143
137
|
files:
|
|
144
138
|
- ".github/ISSUE_TEMPLATE/bug_report.md"
|
|
145
139
|
- ".github/ISSUE_TEMPLATE/feature_request.md"
|
|
140
|
+
- ".github/workflows/build-release.yml"
|
|
141
|
+
- ".github/workflows/test.yml"
|
|
146
142
|
- ".gitignore"
|
|
147
143
|
- ".rspec"
|
|
148
144
|
- ".rubocop.yml"
|
|
149
|
-
- ".travis.yml"
|
|
150
|
-
- Appraisals
|
|
151
145
|
- CHANGELOG.md
|
|
152
146
|
- Gemfile
|
|
153
147
|
- LICENSE.txt
|
|
@@ -155,17 +149,13 @@ files:
|
|
|
155
149
|
- Rakefile
|
|
156
150
|
- bin/console
|
|
157
151
|
- bin/setup
|
|
158
|
-
- gemfiles/.bundle/config
|
|
159
|
-
- gemfiles/anycable_0.6.gemfile
|
|
160
|
-
- gemfiles/anycable_1.0.gemfile
|
|
161
|
-
- gemfiles/graphql_1.10.gemfile
|
|
162
|
-
- gemfiles/graphql_1.9.gemfile
|
|
163
152
|
- graphql-anycable.gemspec
|
|
164
153
|
- lib/Rakefile
|
|
165
154
|
- lib/graphql-anycable.rb
|
|
166
155
|
- lib/graphql/anycable.rb
|
|
167
156
|
- lib/graphql/anycable/cleaner.rb
|
|
168
157
|
- lib/graphql/anycable/config.rb
|
|
158
|
+
- lib/graphql/anycable/errors.rb
|
|
169
159
|
- lib/graphql/anycable/railtie.rb
|
|
170
160
|
- lib/graphql/anycable/tasks/clean_expired_subscriptions.rake
|
|
171
161
|
- lib/graphql/anycable/version.rb
|
|
@@ -189,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
189
179
|
- !ruby/object:Gem::Version
|
|
190
180
|
version: '0'
|
|
191
181
|
requirements: []
|
|
192
|
-
rubygems_version: 3.
|
|
182
|
+
rubygems_version: 3.1.6
|
|
193
183
|
signing_key:
|
|
194
184
|
specification_version: 4
|
|
195
185
|
summary: A drop-in replacement for GraphQL ActionCable subscriptions for AnyCable.
|
data/.travis.yml
DELETED
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
sudo: false
|
|
3
|
-
language: ruby
|
|
4
|
-
cache: bundler
|
|
5
|
-
rvm:
|
|
6
|
-
- 2.7.0
|
|
7
|
-
- 2.6.5
|
|
8
|
-
- 2.5.7
|
|
9
|
-
- 2.4.9
|
|
10
|
-
gemfile:
|
|
11
|
-
- gemfiles/graphql_1.9.gemfile
|
|
12
|
-
- gemfiles/graphql_1.10.gemfile
|
|
13
|
-
- gemfiles/anycable_0.6.gemfile
|
|
14
|
-
- gemfiles/anycable_1.0.gemfile
|
|
15
|
-
before_install: gem install bundler -v "~> 2.0"
|
|
16
|
-
|
|
17
|
-
matrix:
|
|
18
|
-
exclude:
|
|
19
|
-
# grpc gem isn't ready for ruby 2.7 yet: https://github.com/grpc/grpc/issues/21514
|
|
20
|
-
# goole-protobuf gem isn't ready for ruby 2.7 yet: https://github.com/protocolbuffers/protobuf/issues/7070
|
|
21
|
-
- rvm: 2.7.0
|
|
22
|
-
# Exclude new dependencies on old rubies to run less jobs
|
|
23
|
-
- rvm: 2.4.9
|
|
24
|
-
gemfile: gemfiles/anycable_1.0.gemfile
|
|
25
|
-
- rvm: 2.4.9
|
|
26
|
-
gemfile: gemfiles/graphql_1.10.gemfile
|
|
27
|
-
- rvm: 2.5.7
|
|
28
|
-
gemfile: gemfiles/anycable_1.0.gemfile
|
|
29
|
-
- rvm: 2.5.7
|
|
30
|
-
gemfile: gemfiles/graphql_1.10.gemfile
|
|
31
|
-
# Exclude old dependencies on new rubies to run less jobs
|
|
32
|
-
- rvm: 2.6.5
|
|
33
|
-
gemfile: gemfiles/anycable_0.6.gemfile
|
|
34
|
-
- rvm: 2.6.5
|
|
35
|
-
gemfile: gemfiles/graphql_1.9.gemfile
|
data/Appraisals
DELETED
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
appraise "graphql-1.9" do
|
|
2
|
-
gem "graphql", "~> 1.9.0"
|
|
3
|
-
end
|
|
4
|
-
|
|
5
|
-
appraise "graphql-1.10" do
|
|
6
|
-
gem "graphql", "~> 1.10.0"
|
|
7
|
-
end
|
|
8
|
-
|
|
9
|
-
appraise "anycable-0.6" do
|
|
10
|
-
gem "anycable", "~> 0.6.0"
|
|
11
|
-
end
|
|
12
|
-
|
|
13
|
-
appraise "anycable-1.0" do
|
|
14
|
-
gem "anycable", "~> 1.0.0.preview1"
|
|
15
|
-
end
|
data/gemfiles/.bundle/config
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
# This file was generated by Appraisal
|
|
2
|
-
|
|
3
|
-
source "https://rubygems.org"
|
|
4
|
-
|
|
5
|
-
gem "anycable", "~> 0.6.0"
|
|
6
|
-
|
|
7
|
-
group :development, :test do
|
|
8
|
-
gem "pry"
|
|
9
|
-
gem "pry-byebug", platform: :mri
|
|
10
|
-
gem "rubocop"
|
|
11
|
-
gem "rubocop-rspec"
|
|
12
|
-
end
|
|
13
|
-
|
|
14
|
-
gemspec path: "../"
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
# This file was generated by Appraisal
|
|
2
|
-
|
|
3
|
-
source "https://rubygems.org"
|
|
4
|
-
|
|
5
|
-
gem "anycable", "~> 1.0.0.preview1"
|
|
6
|
-
|
|
7
|
-
group :development, :test do
|
|
8
|
-
gem "pry"
|
|
9
|
-
gem "pry-byebug", platform: :mri
|
|
10
|
-
gem "rubocop"
|
|
11
|
-
gem "rubocop-rspec"
|
|
12
|
-
end
|
|
13
|
-
|
|
14
|
-
gemspec path: "../"
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
# This file was generated by Appraisal
|
|
2
|
-
|
|
3
|
-
source "https://rubygems.org"
|
|
4
|
-
|
|
5
|
-
gem "graphql", "~> 1.10.0"
|
|
6
|
-
|
|
7
|
-
group :development, :test do
|
|
8
|
-
gem "pry"
|
|
9
|
-
gem "pry-byebug", platform: :mri
|
|
10
|
-
gem "rubocop"
|
|
11
|
-
gem "rubocop-rspec"
|
|
12
|
-
end
|
|
13
|
-
|
|
14
|
-
gemspec path: "../"
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
# This file was generated by Appraisal
|
|
2
|
-
|
|
3
|
-
source "https://rubygems.org"
|
|
4
|
-
|
|
5
|
-
gem "graphql", "~> 1.9.0"
|
|
6
|
-
|
|
7
|
-
group :development, :test do
|
|
8
|
-
gem "pry"
|
|
9
|
-
gem "pry-byebug", platform: :mri
|
|
10
|
-
gem "rubocop"
|
|
11
|
-
gem "rubocop-rspec"
|
|
12
|
-
end
|
|
13
|
-
|
|
14
|
-
gemspec path: "../"
|