graphql-anycable 0.3.3 → 1.0.0
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/ISSUE_TEMPLATE/bug_report.md +63 -0
- data/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
- data/.github/workflows/build-release.yml +82 -0
- data/.github/workflows/test.yml +76 -0
- data/CHANGELOG.md +116 -0
- data/Gemfile +6 -0
- data/README.md +103 -4
- data/graphql-anycable.gemspec +4 -4
- data/lib/graphql-anycable.rb +16 -3
- data/lib/graphql/anycable/cleaner.rb +91 -0
- data/lib/graphql/anycable/config.rb +2 -1
- data/lib/graphql/anycable/railtie.rb +1 -1
- data/lib/graphql/anycable/tasks/clean_expired_subscriptions.rake +15 -42
- data/lib/graphql/anycable/version.rb +2 -2
- data/lib/graphql/subscriptions/anycable_subscriptions.rb +103 -28
- metadata +29 -34
- data/.travis.yml +0 -19
- data/Appraisals +0 -7
- data/gemfiles/.bundle/config +0 -2
- 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: 6e8f296cdfe805ab7eb4ea8247b3880b785ba1314c3c2ef25d3ac316765714b5
|
|
4
|
+
data.tar.gz: d010e06e309c4724a111ebb5cff503678bf53b0ba8039f438ecd86892073ef7d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c84765a3b9461f431da8e3ad4a31fdc50e28836d9b331e04af7374676002bb9b02c78d6e18512b1e776a8d13fa431232c5c019b059497ccdee6953adecbde53c
|
|
7
|
+
data.tar.gz: 3a741fbaaf27eea28bd0a1885cee1e7ac1b24e8bb8a270537751465fa78e1f73f1ef1a3ca1538670e7d90503292dc5e05d8511a8f81861144ee999c6a9f30e25
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Bug report
|
|
3
|
+
about: Create a report to help us improve graphql-anycable
|
|
4
|
+
title: ''
|
|
5
|
+
labels: ''
|
|
6
|
+
assignees: ''
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
**Describe the bug**
|
|
11
|
+
A clear and concise description of what the bug is.
|
|
12
|
+
|
|
13
|
+
**Versions**
|
|
14
|
+
ruby:
|
|
15
|
+
rails (or other framework):
|
|
16
|
+
graphql:
|
|
17
|
+
graphql-anycable:
|
|
18
|
+
anycable:
|
|
19
|
+
|
|
20
|
+
**GraphQL schema**
|
|
21
|
+
Provide relevant details. Are you using [subscription classes](https://graphql-ruby.org/subscriptions/subscription_classes.html) or not (graphql-ruby behavior differs there)?
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
class Product < GraphQL::Schema::Object
|
|
25
|
+
field :id, ID, null: false, hash_key: :id
|
|
26
|
+
field :title, String, null: true, hash_key: :title
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
class SubscriptionType < GraphQL::Schema::Object
|
|
30
|
+
field :product_created, Product, null: false
|
|
31
|
+
field :product_updated, Product, null: false
|
|
32
|
+
|
|
33
|
+
def product_created; end
|
|
34
|
+
def product_updated; end
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
class ApplicationSchema < GraphQL::Schema
|
|
38
|
+
subscription SubscriptionType
|
|
39
|
+
end
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
**GraphQL query**
|
|
43
|
+
|
|
44
|
+
How do you subscribe to subscriptions?
|
|
45
|
+
|
|
46
|
+
```graphql
|
|
47
|
+
subscription {
|
|
48
|
+
productCreated { id title }
|
|
49
|
+
productUpdated { id }
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
**Steps to reproduce**
|
|
54
|
+
Steps to reproduce the behavior
|
|
55
|
+
|
|
56
|
+
**Expected behavior**
|
|
57
|
+
A clear and concise description of what you expected to happen.
|
|
58
|
+
|
|
59
|
+
**Actual behavior**
|
|
60
|
+
What specifically went wrong?
|
|
61
|
+
|
|
62
|
+
**Additional context**
|
|
63
|
+
Add any other context about the problem here. Tracebacks, your thoughts. anything that may be useful.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Feature request
|
|
3
|
+
about: Suggest an idea for this project
|
|
4
|
+
title: ''
|
|
5
|
+
labels: ''
|
|
6
|
+
assignees: ''
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
**Is your feature request related to a problem? Please describe.**
|
|
11
|
+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
|
12
|
+
|
|
13
|
+
**Describe the solution you'd like**
|
|
14
|
+
A clear and concise description of what you want to happen.
|
|
15
|
+
|
|
16
|
+
**Describe alternatives you've considered**
|
|
17
|
+
A clear and concise description of any alternative solutions or features you've considered.
|
|
18
|
+
|
|
19
|
+
**Additional context**
|
|
20
|
+
Add any other context or screenshots about the feature request here.
|
|
@@ -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
ADDED
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
|
6
|
+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## Unreleased
|
|
9
|
+
|
|
10
|
+
## 1.0.0 - 2021-04-01
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- 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))
|
|
15
|
+
|
|
16
|
+
### Changed
|
|
17
|
+
|
|
18
|
+
- Subscription data storage format changed to support broadcasting feature (see [#15](https://github.com/anycable/graphql-anycable/pull/15))
|
|
19
|
+
|
|
20
|
+
### Removed
|
|
21
|
+
|
|
22
|
+
- Drop support for GraphQL-Ruby before 1.11
|
|
23
|
+
|
|
24
|
+
- Drop support for AnyCable before 1.0
|
|
25
|
+
|
|
26
|
+
- Drop `:action_cable_stream` option from context: it is not used in reality.
|
|
27
|
+
|
|
28
|
+
See [rmosolgo/graphql-ruby#3076](https://github.com/rmosolgo/graphql-ruby/pull/3076) for details
|
|
29
|
+
|
|
30
|
+
### Upgrading notes
|
|
31
|
+
|
|
32
|
+
1. Change method of plugging in of this gem from `use GraphQL::Subscriptions::AnyCableSubscriptions` to `use GraphQL::AnyCable`:
|
|
33
|
+
|
|
34
|
+
```ruby
|
|
35
|
+
use GraphQL::AnyCable
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
If you need broadcasting, add `broadcast: true` option and ensure that [Interpreter mode](https://graphql-ruby.org/queries/interpreter.html) is enabled.
|
|
39
|
+
|
|
40
|
+
```ruby
|
|
41
|
+
use GraphQL::Execution::Interpreter
|
|
42
|
+
use GraphQL::Analysis::AST
|
|
43
|
+
use GraphQL::AnyCable, broadcast: true, default_broadcastable: true
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
2. Enable `handle_legacy_subscriptions` setting for seamless upgrade from previous versions:
|
|
47
|
+
|
|
48
|
+
```sh
|
|
49
|
+
GRAPHQL_ANYCABLE_HANDLE_LEGACY_SUBSCRIPTIONS=true
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
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.
|
|
53
|
+
|
|
54
|
+
## 0.5.0 - 2020-08-26
|
|
55
|
+
|
|
56
|
+
### Changed
|
|
57
|
+
|
|
58
|
+
- Allow to plug in this gem by calling `use GraphQL::AnyCable` instead of `use GraphQL::Subscriptions::AnyCableSubscriptions`. [@Envek]
|
|
59
|
+
- Rename `GraphQL::Anycable` constant to `GraphQL::AnyCable` for consistency with AnyCable itself. [@Envek]
|
|
60
|
+
|
|
61
|
+
## 0.4.2 - 2020-08-25
|
|
62
|
+
|
|
63
|
+
Technical release to test publishing via GitHub Actions.
|
|
64
|
+
|
|
65
|
+
## 0.4.1 - 2020-08-21
|
|
66
|
+
|
|
67
|
+
### Fixed
|
|
68
|
+
|
|
69
|
+
- 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]
|
|
70
|
+
|
|
71
|
+
## 0.4.0 - 2020-03-19
|
|
72
|
+
|
|
73
|
+
### Added
|
|
74
|
+
|
|
75
|
+
- Ability to configure the gem via `configure` block, in addition to enironment variables and yaml files. [@gsamokovarov] ([#11](https://github.com/Envek/graphql-anycable/pull/11))
|
|
76
|
+
- Ability to run Redis cleaning operations outside of Rake. [@gsamokovarov] ([#11](https://github.com/Envek/graphql-anycable/pull/11))
|
|
77
|
+
- AnyCable 1.0 compatibility. [@bibendi], [@Envek] ([#10](https://github.com/Envek/graphql-anycable/pull/10))
|
|
78
|
+
|
|
79
|
+
## 0.3.3 - 2020-03-03
|
|
80
|
+
|
|
81
|
+
### Fixed
|
|
82
|
+
|
|
83
|
+
- Redis command error on subscription query with multiple fields. [@Envek] ([#9](https://github.com/Envek/graphql-anycable/issues/9))
|
|
84
|
+
|
|
85
|
+
## 0.3.2 - 2020-03-02
|
|
86
|
+
|
|
87
|
+
### Added
|
|
88
|
+
|
|
89
|
+
- Ability to skip some cleanup on restricted Redis instances (like Heroku). [@Envek] ([#8](https://github.com/Envek/graphql-anycable/issues/8))
|
|
90
|
+
|
|
91
|
+
## 0.3.1 - 2019-06-13
|
|
92
|
+
|
|
93
|
+
### Fixed
|
|
94
|
+
|
|
95
|
+
- Empty operation name handling. [@FX-HAO] ([#3](https://github.com/Envek/graphql-anycable/pull/3))
|
|
96
|
+
|
|
97
|
+
## 0.3.0 - 2018-11-16
|
|
98
|
+
|
|
99
|
+
### Added
|
|
100
|
+
|
|
101
|
+
- AnyCable 0.6 compatibility. [@Envek]
|
|
102
|
+
|
|
103
|
+
## 0.2.0 - 2018-09-17
|
|
104
|
+
|
|
105
|
+
### Added
|
|
106
|
+
|
|
107
|
+
- Subscription expiration and rake task for stale subscriptions cleanup. [@Envek]
|
|
108
|
+
|
|
109
|
+
### 0.1.0 - 2018-08-26
|
|
110
|
+
|
|
111
|
+
Initial version: store subscriptions on redis, re-execute queries in sync. [@Envek]
|
|
112
|
+
|
|
113
|
+
[@gsamokovarov]: https://github.com/gsamokovarov "Genadi Samokovarov"
|
|
114
|
+
[@bibendi]: https://github.com/bibendi "Misha Merkushin"
|
|
115
|
+
[@FX-HAO]: https://github.com/FX-HAO "Fuxin Hao"
|
|
116
|
+
[@Envek]: https://github.com/Envek "Andrey Novikov"
|
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,15 +100,113 @@ 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:
|
|
105
128
|
|
|
106
|
-
1. Set `
|
|
129
|
+
1. Set `subscription_expiration_seconds` setting to number of seconds (e.g. `604800` for 1 week). See [configuration](#Configuration) section below for details.
|
|
107
130
|
|
|
108
131
|
2. Execute `rake graphql:anycable:clean` once in a while to clean up stale subscription data.
|
|
109
132
|
|
|
110
|
-
Heroku users should set up `
|
|
133
|
+
Heroku users should set up `use_redis_object_on_cleanup` setting to `false` due to [limitations in Heroku Redis](https://devcenter.heroku.com/articles/heroku-redis#connection-permissions).
|
|
134
|
+
|
|
135
|
+
## Configuration
|
|
136
|
+
|
|
137
|
+
GraphQL-AnyCable uses [anyway_config] to configure itself. There are several possibilities to configure this gem:
|
|
138
|
+
|
|
139
|
+
1. Environment variables:
|
|
140
|
+
|
|
141
|
+
```.env
|
|
142
|
+
GRAPHQL_ANYCABLE_SUBSCRIPTION_EXPIRATION_SECONDS=604800
|
|
143
|
+
GRAPHQL_ANYCABLE_USE_REDIS_OBJECT_ON_CLEANUP=true
|
|
144
|
+
GRAPHQL_ANYCABLE_HANDLE_LEGACY_SUBSCRIPTIONS=false
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
2. YAML configuration files:
|
|
148
|
+
|
|
149
|
+
```yaml
|
|
150
|
+
# config/graphql_anycable.yml
|
|
151
|
+
production:
|
|
152
|
+
subscription_expiration_seconds: 300 # 5 minutes
|
|
153
|
+
use_redis_object_on_cleanup: false # For restricted redis installations
|
|
154
|
+
handle_legacy_subscriptions: false # For seamless upgrade from pre-1.0 versions
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
3. Configuration from your application code:
|
|
158
|
+
|
|
159
|
+
```ruby
|
|
160
|
+
GraphQL::AnyCable.configure do |config|
|
|
161
|
+
config.subscription_expiration_seconds = 3600 # 1 hour
|
|
162
|
+
end
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
And any other way provided by [anyway_config]. Check its documentation!
|
|
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
|
+
```
|
|
111
210
|
|
|
112
211
|
## Development
|
|
113
212
|
|
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
|
@@ -3,23 +3,36 @@
|
|
|
3
3
|
require "graphql"
|
|
4
4
|
|
|
5
5
|
require_relative "graphql/anycable/version"
|
|
6
|
+
require_relative "graphql/anycable/cleaner"
|
|
6
7
|
require_relative "graphql/anycable/config"
|
|
7
8
|
require_relative "graphql/anycable/railtie" if defined?(Rails)
|
|
8
9
|
require_relative "graphql/subscriptions/anycable_subscriptions"
|
|
9
10
|
|
|
10
11
|
module GraphQL
|
|
11
|
-
module
|
|
12
|
+
module AnyCable
|
|
13
|
+
def self.use(schema, **options)
|
|
14
|
+
schema.use GraphQL::Subscriptions::AnyCableSubscriptions, **options
|
|
15
|
+
end
|
|
16
|
+
|
|
12
17
|
module_function
|
|
13
18
|
|
|
14
19
|
def redis
|
|
15
20
|
@redis ||= begin
|
|
16
|
-
adapter = ::
|
|
21
|
+
adapter = ::AnyCable.broadcast_adapter
|
|
17
22
|
unless adapter.is_a?(::AnyCable::BroadcastAdapters::Redis)
|
|
18
23
|
raise "Unsupported AnyCable adapter: #{adapter.class}. " \
|
|
19
24
|
"graphql-anycable works only with redis broadcast adapter."
|
|
20
25
|
end
|
|
21
|
-
::
|
|
26
|
+
::AnyCable.broadcast_adapter.redis_conn
|
|
22
27
|
end
|
|
23
28
|
end
|
|
29
|
+
|
|
30
|
+
def config
|
|
31
|
+
@config ||= GraphQL::AnyCable::Config.new
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
def configure
|
|
35
|
+
yield(config) if block_given?
|
|
36
|
+
end
|
|
24
37
|
end
|
|
25
38
|
end
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module GraphQL
|
|
4
|
+
module AnyCable
|
|
5
|
+
module Cleaner
|
|
6
|
+
extend self
|
|
7
|
+
|
|
8
|
+
def clean
|
|
9
|
+
clean_channels
|
|
10
|
+
clean_subscriptions
|
|
11
|
+
clean_events
|
|
12
|
+
clean_fingerprint_subscriptions
|
|
13
|
+
clean_topic_fingerprints
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
def clean_channels
|
|
17
|
+
return unless config.subscription_expiration_seconds
|
|
18
|
+
return unless config.use_redis_object_on_cleanup
|
|
19
|
+
|
|
20
|
+
redis.scan_each(match: "#{adapter::CHANNEL_PREFIX}*") do |key|
|
|
21
|
+
idle = redis.object("IDLETIME", key)
|
|
22
|
+
next if idle&.<= config.subscription_expiration_seconds
|
|
23
|
+
|
|
24
|
+
redis.del(key)
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
def clean_subscriptions
|
|
29
|
+
return unless config.subscription_expiration_seconds
|
|
30
|
+
return unless config.use_redis_object_on_cleanup
|
|
31
|
+
|
|
32
|
+
redis.scan_each(match: "#{adapter::SUBSCRIPTION_PREFIX}*") do |key|
|
|
33
|
+
idle = redis.object("IDLETIME", key)
|
|
34
|
+
next if idle&.<= config.subscription_expiration_seconds
|
|
35
|
+
|
|
36
|
+
redis.del(key)
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
def clean_events
|
|
41
|
+
return unless config.handle_legacy_subscriptions
|
|
42
|
+
|
|
43
|
+
redis.scan_each(match: "#{adapter::SUBSCRIPTION_EVENTS_PREFIX}*") do |key|
|
|
44
|
+
subscription_id = key.sub(/\A#{adapter::SUBSCRIPTION_EVENTS_PREFIX}/, "")
|
|
45
|
+
next if redis.exists?(adapter::SUBSCRIPTION_PREFIX + subscription_id)
|
|
46
|
+
|
|
47
|
+
redis.smembers(key).each do |event_topic|
|
|
48
|
+
redis.srem(adapter::EVENT_PREFIX + event_topic, subscription_id)
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
redis.del(key)
|
|
52
|
+
end
|
|
53
|
+
end
|
|
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
|
+
|
|
76
|
+
private
|
|
77
|
+
|
|
78
|
+
def adapter
|
|
79
|
+
GraphQL::Subscriptions::AnyCableSubscriptions
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
def redis
|
|
83
|
+
GraphQL::AnyCable.redis
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
def config
|
|
87
|
+
GraphQL::AnyCable.config
|
|
88
|
+
end
|
|
89
|
+
end
|
|
90
|
+
end
|
|
91
|
+
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
|
|
@@ -1,64 +1,37 @@
|
|
|
1
|
-
require "graphql-anycable"
|
|
2
|
-
|
|
3
1
|
# frozen_string_literal: true
|
|
4
2
|
|
|
3
|
+
require "graphql-anycable"
|
|
4
|
+
|
|
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
|
-
KLASS = GraphQL::Subscriptions::AnyCableSubscriptions
|
|
15
|
-
|
|
16
11
|
# Clean up old channels
|
|
17
12
|
task :channels do
|
|
18
|
-
|
|
19
|
-
next unless config.use_redis_object_on_cleanup
|
|
20
|
-
|
|
21
|
-
redis.scan_each(match: "#{KLASS::CHANNEL_PREFIX}*") do |key|
|
|
22
|
-
idle = redis.object("IDLETIME", key)
|
|
23
|
-
next if idle&.<= config.subscription_expiration_seconds
|
|
24
|
-
|
|
25
|
-
redis.del(key)
|
|
26
|
-
end
|
|
13
|
+
GraphQL::AnyCable::Cleaner.clean_channels
|
|
27
14
|
end
|
|
28
15
|
|
|
29
16
|
# Clean up old subscriptions (they should have expired by themselves)
|
|
30
17
|
task :subscriptions do
|
|
31
|
-
|
|
32
|
-
next unless config.use_redis_object_on_cleanup
|
|
33
|
-
|
|
34
|
-
redis.scan_each(match: "#{KLASS::SUBSCRIPTION_PREFIX}*") do |key|
|
|
35
|
-
idle = redis.object("IDLETIME", key)
|
|
36
|
-
next if idle&.<= config.subscription_expiration_seconds
|
|
37
|
-
|
|
38
|
-
redis.del(key)
|
|
39
|
-
end
|
|
18
|
+
GraphQL::AnyCable::Cleaner.clean_subscriptions
|
|
40
19
|
end
|
|
41
20
|
|
|
42
|
-
# Clean up subscription_ids from events for expired subscriptions
|
|
21
|
+
# Clean up legacy subscription_ids from events for expired subscriptions
|
|
43
22
|
task :events do
|
|
44
|
-
|
|
45
|
-
subscription_id = key.sub(/\A#{KLASS::SUBSCRIPTION_EVENTS_PREFIX}/, "")
|
|
46
|
-
next if redis.exists(KLASS::SUBSCRIPTION_PREFIX + subscription_id)
|
|
47
|
-
|
|
48
|
-
redis.smembers(key).each do |event_topic|
|
|
49
|
-
redis.srem(KLASS::EVENT_PREFIX + event_topic, subscription_id)
|
|
50
|
-
end
|
|
51
|
-
redis.del(key)
|
|
52
|
-
end
|
|
23
|
+
GraphQL::AnyCable::Cleaner.clean_events
|
|
53
24
|
end
|
|
54
|
-
end
|
|
55
25
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
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
|
|
59
30
|
|
|
60
|
-
|
|
61
|
-
|
|
31
|
+
# Clean up fingerprints from event topics. for expired subscriptions
|
|
32
|
+
task :topic_fingerprints do
|
|
33
|
+
GraphQL::AnyCable::Cleaner.clean_topic_fingerprints
|
|
34
|
+
end
|
|
62
35
|
end
|
|
63
36
|
end
|
|
64
37
|
end
|
|
@@ -54,12 +54,15 @@ module GraphQL
|
|
|
54
54
|
class AnyCableSubscriptions < GraphQL::Subscriptions
|
|
55
55
|
extend Forwardable
|
|
56
56
|
|
|
57
|
-
def_delegators :"GraphQL::
|
|
57
|
+
def_delegators :"GraphQL::AnyCable", :redis, :config
|
|
58
58
|
|
|
59
|
-
SUBSCRIPTION_PREFIX
|
|
60
|
-
|
|
59
|
+
SUBSCRIPTION_PREFIX = "graphql-subscription:" # HASH: Stores subscription data: query, context, …
|
|
60
|
+
FINGERPRINTS_PREFIX = "graphql-fingerprints:" # ZSET: To get fingerprints by topic
|
|
61
|
+
SUBSCRIPTIONS_PREFIX = "graphql-subscriptions:" # SET: To get subscriptions by fingerprint
|
|
62
|
+
CHANNEL_PREFIX = "graphql-channel:" # SET: Auxiliary structure for whole channel's subscriptions cleanup
|
|
63
|
+
# For backward compatibility:
|
|
61
64
|
EVENT_PREFIX = "graphql-event:"
|
|
62
|
-
|
|
65
|
+
SUBSCRIPTION_EVENTS_PREFIX = "graphql-subscription-events:"
|
|
63
66
|
|
|
64
67
|
# @param serializer [<#dump(obj), #load(string)] Used for serializing messages before handing them to `.broadcast(msg)`
|
|
65
68
|
def initialize(serializer: Serialize, **rest)
|
|
@@ -70,40 +73,91 @@ module GraphQL
|
|
|
70
73
|
# An event was triggered.
|
|
71
74
|
# Re-evaluate all subscribed queries and push the data over ActionCable.
|
|
72
75
|
def execute_all(event, object)
|
|
76
|
+
execute_legacy(event, object) if config.handle_legacy_subscriptions
|
|
77
|
+
|
|
78
|
+
fingerprints = redis.zrange(FINGERPRINTS_PREFIX + event.topic, 0, -1)
|
|
79
|
+
return if fingerprints.empty?
|
|
80
|
+
|
|
81
|
+
fingerprint_subscription_ids = Hash[fingerprints.zip(
|
|
82
|
+
redis.pipelined do
|
|
83
|
+
fingerprints.map do |fingerprint|
|
|
84
|
+
redis.smembers(SUBSCRIPTIONS_PREFIX + fingerprint)
|
|
85
|
+
end
|
|
86
|
+
end
|
|
87
|
+
)]
|
|
88
|
+
|
|
89
|
+
fingerprint_subscription_ids.each do |fingerprint, subscription_ids|
|
|
90
|
+
execute_grouped(fingerprint, subscription_ids, event, object)
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
# Call to +trigger+ returns this. Convenient for playing in console
|
|
94
|
+
Hash[fingerprint_subscription_ids.map { |k,v| [k, v.size] }]
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
# The fingerprint has told us that this response should be shared by all subscribers,
|
|
98
|
+
# so just run it once, then deliver the result to every subscriber
|
|
99
|
+
def execute_grouped(fingerprint, subscription_ids, event, object)
|
|
100
|
+
return if subscription_ids.empty?
|
|
101
|
+
|
|
102
|
+
subscription_id = subscription_ids.find { |sid| redis.exists?(SUBSCRIPTION_PREFIX + sid) }
|
|
103
|
+
return unless subscription_id # All subscriptions has expired but haven't cleaned up yet
|
|
104
|
+
|
|
105
|
+
result = execute_update(subscription_id, event, object)
|
|
106
|
+
return unless result
|
|
107
|
+
|
|
108
|
+
# Having calculated the result _once_, send the same payload to all subscribers
|
|
109
|
+
deliver(SUBSCRIPTIONS_PREFIX + fingerprint, result)
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
# For migration from pre-1.0 graphql-anycable gem
|
|
113
|
+
def execute_legacy(event, object)
|
|
73
114
|
redis.smembers(EVENT_PREFIX + event.topic).each do |subscription_id|
|
|
74
|
-
next unless redis.exists(SUBSCRIPTION_PREFIX + subscription_id)
|
|
75
|
-
|
|
115
|
+
next unless redis.exists?(SUBSCRIPTION_PREFIX + subscription_id)
|
|
116
|
+
result = execute_update(subscription_id, event, object)
|
|
117
|
+
next unless result
|
|
118
|
+
|
|
119
|
+
deliver(SUBSCRIPTION_PREFIX + subscription_id, result)
|
|
76
120
|
end
|
|
77
121
|
end
|
|
78
122
|
|
|
123
|
+
# Disable this method as there is no fingerprint (it can be retrieved from subscription though)
|
|
124
|
+
def execute(subscription_id, event, object)
|
|
125
|
+
raise NotImplementedError, "Use execute_all method instead of execute to get actual event fingerprint"
|
|
126
|
+
end
|
|
127
|
+
|
|
79
128
|
# This subscription was re-evaluated.
|
|
80
129
|
# Send it to the specific stream where this client was waiting.
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
130
|
+
# @param strean_key [String]
|
|
131
|
+
# @param result [#to_h] result to send to clients
|
|
132
|
+
def deliver(stream_key, result)
|
|
133
|
+
payload = { result: result.to_h, more: true }.to_json
|
|
134
|
+
anycable.broadcast(stream_key, payload)
|
|
84
135
|
end
|
|
85
136
|
|
|
86
137
|
# Save query to "storage" (in redis)
|
|
87
138
|
def write_subscription(query, events)
|
|
88
139
|
context = query.context.to_h
|
|
89
|
-
subscription_id = context
|
|
140
|
+
subscription_id = context.delete(:subscription_id) || build_id
|
|
90
141
|
channel = context.delete(:channel)
|
|
91
|
-
|
|
92
|
-
|
|
142
|
+
|
|
143
|
+
events.each do |event|
|
|
144
|
+
channel.stream_from(SUBSCRIPTIONS_PREFIX + event.fingerprint)
|
|
145
|
+
end
|
|
93
146
|
|
|
94
147
|
data = {
|
|
95
148
|
query_string: query.query_string,
|
|
96
149
|
variables: query.provided_variables.to_json,
|
|
97
150
|
context: @serializer.dump(context.to_h),
|
|
98
151
|
operation_name: query.operation_name,
|
|
152
|
+
events: events.map { |e| [e.topic, e.fingerprint] }.to_h.to_json,
|
|
99
153
|
}
|
|
100
154
|
|
|
101
155
|
redis.multi do
|
|
102
156
|
redis.sadd(CHANNEL_PREFIX + channel.params["channelId"], subscription_id)
|
|
103
157
|
redis.mapped_hmset(SUBSCRIPTION_PREFIX + subscription_id, data)
|
|
104
|
-
redis.sadd(SUBSCRIPTION_EVENTS_PREFIX + subscription_id, events.map(&:topic))
|
|
105
158
|
events.each do |event|
|
|
106
|
-
redis.
|
|
159
|
+
redis.zincrby(FINGERPRINTS_PREFIX + event.topic, 1, event.fingerprint)
|
|
160
|
+
redis.sadd(SUBSCRIPTIONS_PREFIX + event.fingerprint, subscription_id)
|
|
107
161
|
end
|
|
108
162
|
next unless config.subscription_expiration_seconds
|
|
109
163
|
redis.expire(CHANNEL_PREFIX + channel.params["channelId"], config.subscription_expiration_seconds)
|
|
@@ -115,26 +169,51 @@ module GraphQL
|
|
|
115
169
|
def read_subscription(subscription_id)
|
|
116
170
|
redis.mapped_hmget(
|
|
117
171
|
"#{SUBSCRIPTION_PREFIX}#{subscription_id}",
|
|
118
|
-
:query_string, :variables, :context, :operation_name
|
|
172
|
+
:query_string, :variables, :context, :operation_name
|
|
119
173
|
).tap do |subscription|
|
|
120
|
-
subscription
|
|
174
|
+
return if subscription.values.all?(&:nil?) # Redis returns hash with all nils for missing key
|
|
175
|
+
|
|
176
|
+
subscription[:context] = @serializer.load(subscription[:context])
|
|
121
177
|
subscription[:variables] = JSON.parse(subscription[:variables])
|
|
122
178
|
subscription[:operation_name] = nil if subscription[:operation_name].strip == ""
|
|
123
179
|
end
|
|
124
180
|
end
|
|
125
181
|
|
|
126
|
-
# The channel was closed, forget about it.
|
|
127
182
|
def delete_subscription(subscription_id)
|
|
128
|
-
|
|
183
|
+
events = redis.hget(SUBSCRIPTION_PREFIX + subscription_id, :events)
|
|
184
|
+
events = events ? JSON.parse(events) : {}
|
|
185
|
+
fingerprint_subscriptions = {}
|
|
186
|
+
redis.pipelined do
|
|
187
|
+
events.each do |topic, fingerprint|
|
|
188
|
+
redis.srem(SUBSCRIPTIONS_PREFIX + fingerprint, subscription_id)
|
|
189
|
+
score = redis.zincrby(FINGERPRINTS_PREFIX + topic, -1, fingerprint)
|
|
190
|
+
fingerprint_subscriptions[FINGERPRINTS_PREFIX + topic] = score
|
|
191
|
+
end
|
|
192
|
+
# Delete subscription itself
|
|
193
|
+
redis.del(SUBSCRIPTION_PREFIX + subscription_id)
|
|
194
|
+
end
|
|
195
|
+
# Clean up fingerprints that doesn't have any subscriptions left
|
|
196
|
+
redis.pipelined do
|
|
197
|
+
fingerprint_subscriptions.each do |key, score|
|
|
198
|
+
redis.zremrangebyscore(key, '-inf', '0') if score.value.zero?
|
|
199
|
+
end
|
|
200
|
+
end
|
|
201
|
+
delete_legacy_subscription(subscription_id)
|
|
202
|
+
end
|
|
203
|
+
|
|
204
|
+
def delete_legacy_subscription(subscription_id)
|
|
205
|
+
return unless config.handle_legacy_subscriptions
|
|
206
|
+
|
|
129
207
|
events = redis.smembers(SUBSCRIPTION_EVENTS_PREFIX + subscription_id)
|
|
130
|
-
|
|
131
|
-
|
|
208
|
+
redis.pipelined do
|
|
209
|
+
events.each do |event_topic|
|
|
210
|
+
redis.srem(EVENT_PREFIX + event_topic, subscription_id)
|
|
211
|
+
end
|
|
212
|
+
redis.del(SUBSCRIPTION_EVENTS_PREFIX + subscription_id)
|
|
132
213
|
end
|
|
133
|
-
# Delete subscription itself
|
|
134
|
-
redis.del(SUBSCRIPTION_EVENTS_PREFIX + subscription_id)
|
|
135
|
-
redis.del(SUBSCRIPTION_PREFIX + subscription_id)
|
|
136
214
|
end
|
|
137
215
|
|
|
216
|
+
# The channel was closed, forget about it and its subscriptions
|
|
138
217
|
def delete_channel_subscriptions(channel_id)
|
|
139
218
|
redis.smembers(CHANNEL_PREFIX + channel_id).each do |subscription_id|
|
|
140
219
|
delete_subscription(subscription_id)
|
|
@@ -145,11 +224,7 @@ module GraphQL
|
|
|
145
224
|
private
|
|
146
225
|
|
|
147
226
|
def anycable
|
|
148
|
-
@anycable ||= ::
|
|
149
|
-
end
|
|
150
|
-
|
|
151
|
-
def config
|
|
152
|
-
@config ||= GraphQL::Anycable::Config.new
|
|
227
|
+
@anycable ||= ::AnyCable.broadcast_adapter
|
|
153
228
|
end
|
|
154
229
|
end
|
|
155
230
|
end
|
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.0
|
|
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-01 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
|
|
@@ -141,24 +135,25 @@ executables: []
|
|
|
141
135
|
extensions: []
|
|
142
136
|
extra_rdoc_files: []
|
|
143
137
|
files:
|
|
138
|
+
- ".github/ISSUE_TEMPLATE/bug_report.md"
|
|
139
|
+
- ".github/ISSUE_TEMPLATE/feature_request.md"
|
|
140
|
+
- ".github/workflows/build-release.yml"
|
|
141
|
+
- ".github/workflows/test.yml"
|
|
144
142
|
- ".gitignore"
|
|
145
143
|
- ".rspec"
|
|
146
144
|
- ".rubocop.yml"
|
|
147
|
-
-
|
|
148
|
-
- Appraisals
|
|
145
|
+
- CHANGELOG.md
|
|
149
146
|
- Gemfile
|
|
150
147
|
- LICENSE.txt
|
|
151
148
|
- README.md
|
|
152
149
|
- Rakefile
|
|
153
150
|
- bin/console
|
|
154
151
|
- bin/setup
|
|
155
|
-
- gemfiles/.bundle/config
|
|
156
|
-
- gemfiles/graphql_1.10.gemfile
|
|
157
|
-
- gemfiles/graphql_1.9.gemfile
|
|
158
152
|
- graphql-anycable.gemspec
|
|
159
153
|
- lib/Rakefile
|
|
160
154
|
- lib/graphql-anycable.rb
|
|
161
155
|
- lib/graphql/anycable.rb
|
|
156
|
+
- lib/graphql/anycable/cleaner.rb
|
|
162
157
|
- lib/graphql/anycable/config.rb
|
|
163
158
|
- lib/graphql/anycable/railtie.rb
|
|
164
159
|
- lib/graphql/anycable/tasks/clean_expired_subscriptions.rake
|
|
@@ -183,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
183
178
|
- !ruby/object:Gem::Version
|
|
184
179
|
version: '0'
|
|
185
180
|
requirements: []
|
|
186
|
-
rubygems_version: 3.
|
|
181
|
+
rubygems_version: 3.1.4
|
|
187
182
|
signing_key:
|
|
188
183
|
specification_version: 4
|
|
189
184
|
summary: A drop-in replacement for GraphQL ActionCable subscriptions for AnyCable.
|
data/.travis.yml
DELETED
|
@@ -1,19 +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
|
-
before_install: gem install bundler -v "~> 2.0"
|
|
14
|
-
|
|
15
|
-
matrix:
|
|
16
|
-
exclude:
|
|
17
|
-
# grpc gem isn't ready for ruby 2.7 yet: https://github.com/grpc/grpc/issues/21514
|
|
18
|
-
# goole-protobuf gem isn't ready for ruby 2.7 yet: https://github.com/protocolbuffers/protobuf/issues/7070
|
|
19
|
-
- rvm: 2.7.0
|
data/Appraisals
DELETED
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 "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: "../"
|