graphql-anycable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c494ac593becba11ed50d2ffe1af1c16afa91e4dec8393b59a4d3e17fedaf926
+  data.tar.gz: 15682a1ca82073419efb27600383443f0db2bbf2288b3b494d77512eace7096e
+SHA512:
+  metadata.gz: b630183f77e927586116388aa8c975bbb04242ca956a8dfcb10453afa7c6d1ba324a3eaca85cb6237d855dab4fd612ae269d380ecc0a5c3e786186c1836b0067
+  data.tar.gz: b35bd5536f6d6460aa97af5d69aa0fab63962111a53854f429796e70d8b5b9831a550f9d19698853e4bd7b551096d90a653bd616a3f6100a7b54bc592126adee

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+.rspec_status
+
+

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,46 @@
+---
+require:
+- rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+  - "Gemfile"
+  - "spec/**/*"
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# Allow to use let!
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-params-comma'
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  Description: 'Checks for trailing comma in array literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  Description: 'Checks for trailing comma in hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.4

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in graphql-anycable.gemspec
+gemspec
+
+group :development, :test do
+  gem "pry"
+  gem "pry-byebug", platform: :mri
+
+  gem "rubocop"
+  gem "rubocop-rspec"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrey Novikov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+# GraphQL subscriptions for AnyCable
+
+A (mostly) drop-in replacement for default ActionCable subscriptions adapter shipped with [graphql gem] but works with [AnyCable]!
+
+**IMPORTANT**: This gem is still in _proof of concept_ stage. It is not yet tested in production and everything may change without any notice. You have warned. 
+
+[![Gem Version](https://badge.fury.io/rb/graphql-anycable.svg)](https://badge.fury.io/rb/graphql-anycable)
+
+<a href="https://evilmartians.com/?utm_source=graphql-anycable&utm_campaign=project_page">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
+</a>
+
+## Why?
+
+AnyCable is fast because it does not execute any Ruby code. But default subscription implementation shipped with [graphql gem] requires to do exactly that: re-evaluate GraphQL queries in ActionCable process. AnyCable doesn't support this (it's possible but hard to implement).
+
+See https://github.com/anycable/anycable-rails/issues/40 for more details and discussion.
+
+## Differences
+
+ - Subscription information is stored in Redis database configured to be used by AnyCable. No expiration or data cleanup yet.
+ - GraphQL queries for all subscriptions are re-executed in the process that triggers event (it may be web server, async jobs, rake tasks or whatever)
+
+## Compatibility
+
+ - Should work with ActionCable in development
+ - Should work without Rails via [LiteCable] 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-anycable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-anycable
+
+## Usage
+
+ 1. Plug it into the schema (replace from ActionCable adapter if you have one):
+ 
+    ```ruby
+    class MySchema < GraphQL::Schema
+      use GraphQL::Subscriptions::AnyCableSubscriptions
+    
+      subscription SubscriptionType
+    end
+    ```
+ 
+ 2. Execute query in ActionCable/LiteCable channel.
+ 
+    ```ruby
+    class GraphqlChannel < ApplicationCable::Channel
+      def execute(data)
+        result = 
+          MySchema.execute(
+            query: data["query"],
+            context: context,
+            variables: Hash(data["variables"]),
+            operation_name: data["operationName"],
+          )
+
+        transmit(
+          result: result.subscription? ? { data: nil } : result.to_h,
+          more: result.subscription?,
+        )
+      end
+    
+      def unsubscribed
+        channel_id = params.fetch("channelId")
+        MySchema.subscriptions.delete_channel_subscriptions(channel_id)
+      end
+    
+      private
+
+      def context
+        {
+          account_id: account&.id,
+          channel: self,
+        }
+      end
+    end
+    ```
+ 
+    Make sure that you're passing channel instance as `channel` key to the context. 
+ 
+ 3. Trigger events as usual:
+ 
+    ```ruby
+    MySchema.subscriptions.trigger(:product_updated, {}, Product.first!, scope: account.id)
+    ```
+
+## Development
+
+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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Envek/graphql-anycable.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[graphql gem]: https://github.com/rmosolgo/graphql-ruby "Ruby implementation of GraphQL"
+[AnyCable]: https://github.com/anycable/anycable "Polyglot replacement for Ruby WebSocket servers with Action Cable protocol"
+[LiteCable]: https://github.com/palkan/litecable "Lightweight Action Cable implementation (Rails-free)"

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "graphql/anycable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/graphql-anycable.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "graphql/anycable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql-anycable"
+  spec.version       = Graphql::Anycable::VERSION
+  spec.authors       = ["Andrey Novikov"]
+  spec.email         = ["envek@envek.name"]
+
+  spec.summary       = <<~SUMMARY
+    A drop-in replacement for GraphQL ActionCable subscriptions for AnyCable.
+  SUMMARY
+
+  spec.homepage      = "https://github.com/Envek/graphql-anycable"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "anycable", "~> 0.5"
+  spec.add_dependency "graphql",  "~> 1.8"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "fakeredis"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/graphql/anycable/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Graphql
+  module Anycable
+    VERSION = "0.1.0"
+  end
+end

data/lib/graphql/anycable.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "../graphql-anycable"

data/lib/graphql/subscriptions/anycable_subscriptions.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require "anycable"
+require "graphql/subscriptions"
+
+# rubocop: disable Metrics/AbcSize, Metrics/LineLength, Metrics/MethodLength
+
+# A subscriptions implementation that sends data as AnyCable broadcastings.
+#
+# Since AnyCable is aimed to be compatible with ActionCable, this adapter
+# may be used as (practically) drop-in replacement to ActionCable adapter
+# shipped with graphql-ruby.
+#
+# @example Adding AnyCableSubscriptions to your schema
+#   MySchema = GraphQL::Schema.define do
+#     use GraphQL::Subscriptions::AnyCableSubscriptions
+#   end
+#
+# @example Implementing a channel for GraphQL Subscriptions
+#   class GraphqlChannel < ApplicationCable::Channel
+#     def execute(data)
+#       query = data["query"]
+#       variables = ensure_hash(data["variables"])
+#       operation_name = data["operationName"]
+#       context = {
+#         current_user: current_user,
+#         # Make sure the channel is in the context
+#         channel: self,
+#       }
+#
+#       result = MySchema.execute({
+#         query: query,
+#         context: context,
+#         variables: variables,
+#         operation_name: operation_name
+#       })
+#
+#       payload = {
+#         result: result.subscription? ? {data: nil} : result.to_h,
+#         more: result.subscription?,
+#       }
+#
+#       transmit(payload)
+#     end
+#
+#     def unsubscribed
+#       channel_id = params.fetch("channelId")
+#       MySchema.subscriptions.delete_channel_subscriptions(channel_id)
+#     end
+#   end
+#
+module GraphQL
+  class Subscriptions
+    class AnyCableSubscriptions < GraphQL::Subscriptions
+      SUBSCRIPTION_PREFIX = "graphql-subscription:"
+      EVENT_PREFIX = "graphql-event:"
+      CHANNEL_PREFIX = "graphql-channel:"
+
+      # @param serializer [<#dump(obj), #load(string)] Used for serializing messages before handing them to `.broadcast(msg)`
+      def initialize(serializer: Serialize, **rest)
+        @serializer = serializer
+        super
+      end
+
+      # An event was triggered.
+      # Re-evaluate all subscribed queries and push the data over ActionCable.
+      def execute_all(event, object)
+        redis.smembers(EVENT_PREFIX + event.topic).each do |subscription_id|
+          execute(subscription_id, event, object)
+        end
+      end
+
+      # This subscription was re-evaluated.
+      # Send it to the specific stream where this client was waiting.
+      def deliver(subscription_id, result)
+        payload = { result: result.to_h, more: true }
+        anycable.broadcast(SUBSCRIPTION_PREFIX + subscription_id, payload.to_json)
+      end
+
+      # Save query to "storage" (in redis)
+      def write_subscription(query, events)
+        context = query.context.to_h
+        subscription_id = context[:subscription_id] ||= build_id
+        channel = context.delete(:channel)
+        stream = context[:action_cable_stream] ||= SUBSCRIPTION_PREFIX + subscription_id
+        channel.stream_from(stream)
+
+        data = {
+          query_string: query.query_string,
+          variables: query.provided_variables.to_json,
+          context: @serializer.dump(context.to_h),
+          operation_name: query.operation_name,
+          events: events.map(&:topic).to_json,
+        }
+
+        redis.multi do
+          redis.sadd(CHANNEL_PREFIX + channel.params["channelId"], subscription_id)
+          redis.mapped_hmset(SUBSCRIPTION_PREFIX + subscription_id, data)
+          events.each do |event|
+            redis.sadd(EVENT_PREFIX + event.topic, subscription_id)
+          end
+        end
+      end
+
+      # Return the query from "storage" (in redis)
+      def read_subscription(subscription_id)
+        redis.mapped_hmget(
+          "#{SUBSCRIPTION_PREFIX}#{subscription_id}",
+          :query_string, :variables, :context, :operation_name,
+        ).tap do |subscription|
+          subscription[:context]   = @serializer.load(subscription[:context])
+          subscription[:variables] = JSON.parse(subscription[:variables])
+        end
+      end
+
+      # The channel was closed, forget about it.
+      def delete_subscription(subscription_id)
+        # Remove subscription ids from all events
+        events_data = redis.hget(SUBSCRIPTION_PREFIX + subscription_id, :events)
+        events_data && JSON.parse(events_data).each do |event_topic|
+          redis.srem(EVENT_PREFIX + event_topic, subscription_id)
+        end
+        # Delete subscription itself
+        redis.del(SUBSCRIPTION_PREFIX + subscription_id)
+      end
+
+      def delete_channel_subscriptions(channel_id)
+        redis.smembers(CHANNEL_PREFIX + channel_id).each do |subscription_id|
+          delete_subscription(subscription_id)
+        end
+        redis.del(CHANNEL_PREFIX + channel_id)
+      end
+
+      private
+
+      def anycable
+        @pub_sub ||= Anycable::PubSub.new
+      end
+
+      def redis
+        @redis ||= anycable.redis_conn
+      end
+    end
+  end
+end
+# rubocop: enable Metrics/AbcSize, Metrics/LineLength, Metrics/MethodLength

data/lib/graphql-anycable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "graphql"
+
+require_relative "graphql/anycable/version"
+require_relative "graphql/subscriptions/anycable_subscriptions"
+
+module Graphql
+  module Anycable
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: graphql-anycable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrey Novikov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: anycable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- envek@envek.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-anycable.gemspec
+- lib/graphql-anycable.rb
+- lib/graphql/anycable.rb
+- lib/graphql/anycable/version.rb
+- lib/graphql/subscriptions/anycable_subscriptions.rb
+homepage: https://github.com/Envek/graphql-anycable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A drop-in replacement for GraphQL ActionCable subscriptions for AnyCable.
+test_files: []