graphql-streaming 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5ec7f6cbeb19b73697a7a70311260bd8a741316
+  data.tar.gz: 4fa0ca9c16f693ed294860248a55559ef8060471
+SHA512:
+  metadata.gz: 1b1ece8cadcbaf967a114bf782f96845cbc5600686278b3a443844a850031b8d935a251ce9cec70e4e16e38b78109a374029b81405aa6798ca69f351d2d68ede
+  data.tar.gz: 9a0e5d527a300ae45377bfdf12e6ea3538574f6c2b5b4fd7d2134f08e28b26e20075d8b6e9dc787207d7ce30f2e5981d8e87ba46b0b7b4891650a54f67b1a2b7

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in graphql-streaming.gemspec
+gemspec
+gem "graphql", github: "rmosolgo/graphql", branch: "defer-directive"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Robert Mosolgo
+
+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,246 @@
+# Graphql::Streaming
+
+Experimental tools for GraphQL over a long-lived connection, including `subscription`, `@defer` and `@stream`. ([demo](https://github.com/rmosolgo/graphql-ruby-stream-defer-demo))
+
+## Installation
+
+```ruby
+# Requires an experimental branch of graphql:
+gem "graphql", github: "rmosolgo/graphql-ruby", branch: "defer-directive"
+gem "graphql-streaming"
+```
+
+## Usage
+
+### Defer & Stream
+
+This gem supports [queries with `@defer` and `@stream`](https://youtu.be/ViXL0YQnioU?t=12m49s).
+
+- Use `GraphQL::Execution::DeferredExecution`:
+
+  ```ruby
+  # only available in the defer-directive branch:
+  MySchema.query_execution_strategy = GraphQL::Execution::DeferredExecution
+  MySchema.subscription_execution_strategy = GraphQL::Execution::DeferredExecution
+  ```
+
+- Choose a transport ([HTTP Streaming](#http-streaming-transport) or [ActionCable](#actioncable-transport)) and get its client (both built-in clients depend on `Object.assign`)
+
+#### HTTP Streaming Transport
+
+`StreamCollector` uses `stream.write(patch)` to send chunked responses to the client. For example, you can use it with [`ActionController::Live`](http://api.rubyonrails.org/classes/ActionController/Live.html).
+
+Create a `collector` and include it in the query as `context[:collector]`:
+
+```ruby
+class ChunkedGraphqlsController < ApplicationController
+  include ActionController::Live
+
+  def create
+    # ...
+
+    # initialize the collector with `response.stream`
+    context = {
+      collector: StreamCollector.new(response.stream)
+    }
+
+    Schema.execute(query_string, variables: variables, context: context)
+
+    # close the stream when the query is done:
+    response.stream.close
+  end
+end
+```
+
+From JavaScript, use `StreamingGraphQLClient` to fetch data:
+
+```js
+//= require graphql-streaming/streaming_graphql_client
+
+onResponse = function(response) {
+  // Handle response.errors / response.data
+}
+
+StreamingGraphQLClient.fetch(
+  "/graphql/",
+  `query getPost($postId: Int!){
+    post(id: $postId) {
+      title
+      comments @stream {
+        body
+      }
+    }
+  }`,
+  {postId: 1},
+  onResponse,
+)
+```
+
+The `onResponse` function will be called with GraphQL response after each patch is added.
+
+#### ActionCable Transport
+
+You can use [Rails 5's `ActionCable`](http://edgeguides.rubyonrails.org/action_cable_overview.html) to send and receive GraphQL.
+
+In your channel, implement an action called `#fetch(data)` for executing GraphQL queries. It should add an `ActionCableCollector` as `context[:collector]`, using `data["query_id"]` from the client. For example:
+
+```ruby
+class GraphqlChannel < ApplicationCable::Channel
+  # ...
+
+  def fetch(data)
+    query_string = data["query"]
+    variables = ensure_hash(data["variables"] || {})
+    context = {}
+
+    # Get the query ID, which is added by the GraphQLChannel client
+    query_id = data["query_id"]
+    # Get a broadcaster, which is the target for patches
+    broadcaster = ActionCable.server.broadcaster_for(channel_name)
+    # The collector passes patches on to the broadcaster
+    context[:collector] = GraphQL::Streaming::ActionCableCollector.new(query_id, broadcaster)
+
+    # Run the query
+    Schema.execute(query_string, variables: variables, context: context)
+
+    # Tell the client to stop listening for patches
+    context[:collector].close
+  end
+end
+```
+
+Then, create a `GraphQLChannel` to make requests. `GraphQLChannel.subscription` contains defaults for `App.cable.subscription.create`:
+
+```js
+//= require graphql-streaming/graphql_channel
+App.graphqlChannel = App.cable.subscriptions.create("GraphqlChannel", GraphQLChannel.subscription)
+
+// OPTIONAL forward log messages to console.log:
+// GraphQLChannel.log = console.log.bind(console)
+```
+
+And you can provide overrides if you want:
+
+```js
+// Trigger `graphql-channel:ready` when the channel is connected
+App.graphqlChannel = App.cable.subscriptions.create(
+  "GraphqlChannel",
+  Object.assign(GraphQLChannel.subscription, {
+    connected: function() {
+      $(document).trigger("graphql-channel:ready")
+    },
+  })
+)
+```
+
+Send queries with `graphqlChannel.fetch`:
+
+```js
+var queryString = "{ ... }"
+var queryVariables = { /* ... */ }
+var onResponse = function(response) { /* handle response.errors & response.data */}
+App.graphqlChannel.fetch(queryString, queryVariables, onResponse)
+```
+
+The `onResponse` handler will be called with the whole response _each time_ a patch is received.
+
+### Subscription
+
+`ActionCableSubscriber` uses `ActionCable` as a backend for GraphQL subscriptions. There are three parts:
+
+- Send a __subscriber__ along with your query
+- Define a __Subscription type__ which registers subscriptions during resolve
+- Make __triggers__ from application code
+
+#### Subscriber
+
+The subscriber rides along with your query (as `context[:subscriber]`). It listens for triggers from the application, and when they happen, it re-evaluates the query and pushes an update over its channel.
+
+```ruby
+# Get the query ID from the client
+query_id = data["query_id"]
+
+context = { current_user: user_from_session(session) }
+
+context[:subscriber] = GraphQL::Streaming::ActionCableSubscriber.new(self, query_id) do
+  # This block is called when a matching trigger occurs
+  context[:current_user].reload
+  Schema.execute(query_string, variables: variables, context: context)
+end
+
+Schema.execute(query_string, variables: variables, context: context)
+
+
+# If there are no outstanding subscriptions,
+# tell the client to stop listening for patches
+if !context[:subscriber].subscribed?
+  context[:collector].close
+end
+```
+
+#### Subscription Type
+
+`SubscriptionType` is a plain `GraphQL::ObjectType`, but its fields are special. They correspond to application triggers. When a trigger is fired, any subscriber who is listening to the corresponding field will re-evaluate its query.
+
+
+Define subscription fields with `subscription`:
+
+```ruby
+SubscriptionType = GraphQL::ObjectType.define do
+  name "Subscription"
+  subscription :post, PostType do
+    argument :id, !types.Int
+    resolve -> (obj, args, ctx) {
+      Post.find(args[:id])
+    }
+  end
+end
+
+MySchema = GraphQL::Schema.new(subscription: SubscriptionType ...)
+```
+
+#### Triggers
+
+From your application, you can trigger events on subscription fields. For example, to tell clients that a Post with a given ID changed:
+
+```ruby
+class Post
+  def after_commit
+    GraphQL::Streaming::ActionCableSubscriber.trigger(:post, {id: id})
+  end
+end
+```
+
+The arguments passed to `.trigger` will be tested against field arguments. Any subscribers who requested a matching query will be updated. For example:
+
+```graphql
+subscription {
+  post(id: 1) {
+    ... postFields
+  }
+}
+```
+
+would be updated by
+
+```ruby
+GraphQL::Streaming::ActionCableSubscriber.trigger(:post, {id: 1})
+```
+
+## Development
+
+- `bundle exec rake test` to run the tests
+- Sadly, no JS tests! See the [demo repo](https://github.com/rmosolgo/graphql-ruby-stream-defer-demo) for poke-around testing
+
+## TODO
+
+- What happens to subscriptions when you redeploy or ActionCable loses its connection? Need to handle reconnecting in some way.
+- Handle errors in subscriber block
+- Improve middleware so you don't have to manually close `ActionCableCollector`s
+- Tests for JS?
+- Other platforms (Pusher, HTTP/2)?
+- Public alternative to `@channel.send(:transmit, payload)`?
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphql/streaming"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.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-streaming.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql/streaming/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql-streaming"
+  spec.version       = Graphql::Streaming::VERSION
+  spec.authors       = ["Robert Mosolgo"]
+  spec.email         = ["rdmosolgo@gmail.com"]
+
+  spec.summary       = %q{Tools for GraphQL over a long-lived connection}
+  spec.description   = %q{Tools for GraphQL over a long-lived connection}
+  spec.homepage      = "https://github.com/rmosolgo/graphql-streaming-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "graphql"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/graphql/streaming.rb

@@ -0,0 +1,10 @@
+require "graphql"
+require "graphql/streaming/action_cable_collector"
+require "graphql/streaming/action_cable_subscriber"
+require "graphql/streaming/assign_subscription_field"
+require "graphql/streaming/stream_collector"
+require "graphql/streaming/version"
+
+if defined?(Rails)
+  require "graphql/streaming/railtie"
+end

data/lib/graphql/streaming/action_cable_collector.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+module GraphQL
+  module Streaming
+    # Accept patches from GraphQL and send them to clients via `channel_name`.
+    #
+    # Patches are also issued with `query_id`. This way, clients on the same channel
+    # can tell whether a patch is for their query or someone else's.
+    #
+    # When a query is finished (no more patches will be sent), the collector can
+    # notify clients with {#close}
+    #
+    # @example Sending patches over ActionCable
+    #   # Use this middleware to close queries when they're finished:
+    #   MySchema.middleware << GraphQL::Streaming::ActionCableMiddleware.new
+    #
+    #   class GraphqlChannel < ApplicationCable::Channel
+    #     # Implement `#fetch(data)`, which corresponds with GraphQLCable client
+    #     def fetch(data)
+    #       query_string = data["query"]
+    #       variables = ensure_hash(data["variables"] || {})
+    #
+    #       # build a collector including `query_id`
+    #       # which comes from GraphQLCable client
+    #       broadcaster = ActionCable.server.broadcaster_for(channel_name)
+    #       query_id = query_id = data["query_id"]
+    #       collector = GraphQL::Streaming::ActionCableCollector.new(query_id, broadcaster)
+    #
+    #       context = { collector: collector }
+    #       Schema.execute(query_string, variables: variables, context: context)
+    #     end
+    #   end
+    #
+    # @example Tell the client to stop listening for patches
+    #    collector = GraphQL::Streaming::ActionCableCollector.new(query_id, broadcaster)
+    #    # ...
+    #    collector.close
+    #
+    class ActionCableCollector
+      # @param [String] A unique identifier for this query (probably provided by the client)
+      # @param [ActionCable::Server::Broadcasting::Broadcaster] The broadcast target for GraphQL's patches
+      def initialize(query_id, broadcaster)
+        @query_id = query_id
+        @broadcaster = broadcaster
+      end
+
+      # Implements the "collector" API for DeferredExecution.
+      # Sends `{patch: {...}, query_id: @query_id}` over `@broadcaster`.
+      # @return [void]
+      def patch(path:, value:)
+        @broadcaster.broadcast({
+          query_id: @query_id,
+          patch: {
+            path: path,
+            value: value,
+          },
+        })
+      end
+
+      # Broadcast a message to terminate listeners on this query
+      # @return [void]
+      def close
+        @broadcaster.broadcast({
+          query_id: @query_id,
+          close: true,
+        })
+      end
+    end
+  end
+end

data/lib/graphql/streaming/action_cable_subscriber.rb

@@ -0,0 +1,87 @@
+module GraphQL
+  module Streaming
+    # A subscriber for a channel-query combo.
+    #
+    # @example Subscribe to a query in an ActionCable action, re-evaluating it when things change
+    #   # Initialize `context` ahead of time so it can be closed over in the subscription block
+    #   context = {}
+    #
+    #   context[:subscriber] = GraphQLSubscriber.new(self, query_id) do
+    #     # Tell the schema how to re-fetch results:
+    #     context[:current_user].reload
+    #     MySchema.execute(query_string, context: context, variables: variables)
+    #   end
+    #
+    #   # Run the query
+    #   MySchema.execute(query_string, context: context, variables: variables)
+    #
+    #   # detect whether any subscriptions were added
+    #   context[:subscriber].subscribed?
+    #
+    class ActionCableSubscriber
+      CHANNEL_PREFIX = "graphql_subscription_"
+
+      # @param [ActionCable::Channel::Base] The channel to push updates to
+      # @param [Object] The query who the updates belong to (probably provided by the client)
+      # @yield Reruns the query
+      def initialize(channel, query_id, &query_exec)
+        @channel = channel
+        @query_id = query_id
+        @query_exec = query_exec
+        @subscribed = false
+      end
+
+
+      # Trigger an event with arguments
+      #
+      # @example Trigger post_changed
+      #   # First, subscribe with "{ post_changed(id: 1) { title } }"
+      #   # Then, trigger the event:
+      #   GraphQL::Streaming::ActionCableSubscriber.trigger(:post_changed, {id: 1})
+      #
+      # @param [Symbol] The subscription name to trigger
+      # @param [Hash] Arguments to send with the subscription
+      def self.trigger(subscription_handle, trigger_options = {})
+        ActionCable.server.broadcast("#{CHANNEL_PREFIX}#{subscription_handle}", trigger_options)
+      end
+
+      def register(subscription_handle, arguments)
+        @subscribed = true
+        original_args = stringify_hash(arguments)
+
+        @channel.stream_from("#{CHANNEL_PREFIX}#{subscription_handle}") do |trigger_json|
+          trigger_args = JSON.parse(trigger_json)
+          if original_args == trigger_args
+            payload = {
+              patch: {
+                path: [],
+                value: @query_exec.call,
+              },
+              query_id: @query_id,
+            }
+            # TODO: request public method for this?
+            @channel.send(:transmit, payload)
+          end
+        end
+      end
+
+      # @return [Boolean] True if this subscriber registered any subscriptions
+      def subscribed?
+        @subscribed
+      end
+
+      private
+
+      def stringify_hash(value)
+        case value
+        when Hash
+          value.inject({}) { |memo, (k, v)| memo[k.to_s] = stringify_hash(v); memo }
+        when Array
+          value.map { |v| stringify_hash(v) }
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/graphql/streaming/assign_subscription_field.rb

@@ -0,0 +1,39 @@
+module GraphQL
+  module Streaming
+    module AssignSubscriptionField
+      # Wrap resolve_proc with subscription registration logic.
+      #
+      # @example Lookup a post and subscribe to it
+      #   subscription :post, PostType do
+      #     argument :id, !types.Int
+      #     resolve -> (obj, args, ctx) {
+      #       Post.find(args[:id])
+      #     end
+      #   end
+      def self.call(*args, &block)
+        underlying_field = GraphQL::Define::AssignObjectField.call(*args, &block)
+        # ensure defined
+        # TODO: resolve_proc should be a lazy attr reader
+        field_name = underlying_field.name
+        original_resolve = underlying_field.resolve_proc
+        underlying_field.resolve = SubscriptionResolve.new(field_name, original_resolve)
+        # Field was assigned to type_defn in AssignObjectField
+      end
+
+      class SubscriptionResolve
+        def initialize(subscription_handle, resolve_proc)
+          @subscription_handle = subscription_handle
+          @resolve_proc = resolve_proc
+        end
+
+        def call(obj, args, ctx)
+          subscriber = ctx[:subscriber]
+          subscriber && subscriber.register(@subscription_handle, args.to_h)
+          @resolve_proc.call(obj, args, ctx)
+        end
+      end
+
+      GraphQL::ObjectType.accepts_definitions(subscription: AssignSubscriptionField)
+    end
+  end
+end

data/lib/graphql/streaming/clients/graphql-streaming/graphql_channel.js

@@ -0,0 +1,90 @@
+if (!Object.assign) { throw "GraphQLChannel requires Object.assign" }
+
+var GraphQLChannel = {
+  _getQueryId: function() {
+    return Date.now()
+  },
+
+  // Override to log sends and receives
+  log: function() {
+    // pass
+  },
+
+  subscription: {
+    // Called by server-sent events
+    received: function(data) {
+      GraphQLChannel.log("[GraphQLChannel received]", data)
+      var queryId = data.query_id
+      var entry = GraphQLChannel.registry.get(queryId)
+      if (!entry) {
+        // The queryId doesn't exist on this client,
+        // it must be for another one of this user's tabs
+      } else if (data.close) {
+        // An existing request is now completed
+        GraphQLChannel.log("[GraphQLChannel closing]", queryId)
+        GraphQLChannel.registry.unset(queryId)
+      } else {
+        // Patch for an existing request
+        GraphQLChannel.registry.mergePatch(entry, data.patch)
+        entry.onResponse(entry.responseData)
+      }
+    },
+
+    fetch: function(queryString, variables, onResponse) {
+      var queryId = GraphQLChannel._getQueryId()
+      GraphQLChannel.registry.set(queryId, onResponse)
+
+      GraphQLChannel.log("[GraphQLChannel sending]", queryString, variables, queryId)
+      this.perform("fetch", {
+        query: queryString,
+        variables: JSON.stringify(variables),
+        query_id: queryId,
+      })
+    }
+  },
+
+  // This registry keeps track of outstanding requests
+  registry: {
+    // {queryId => entry} pairs of outstanding queries.
+    // They should be removed when we receive a payload with `close: true`
+    _requests: {},
+
+    // Store handlers & results for `queryId`.
+    // These handlers & results can be fetched by `.get(queryId)`
+    set: function(queryId, onResponse) {
+      var entry = {
+        queryId: queryId,
+        onResponse: onResponse,
+        responseData: {},
+      }
+      this._requests[queryId] = entry
+    },
+
+    get: function(queryId) {
+      return this._requests[queryId]
+    },
+
+    unset: function(queryId) {
+      delete this._requests[queryId]
+    },
+
+    // Mutate `entry` by merging `patch` into its `responseData`
+    mergePatch: function(entry, patch) {
+      if (patch.path.length === 0) {
+        entry.responseData = patch.value
+      } else {
+        var targetHash = entry.responseData
+        var steps = patch.path.slice(0, patch.path.length - 1)
+        var lastKey = patch.path[patch.path.length - 1]
+        steps.forEach(function(step) {
+          var nextStep = targetHash[step]
+          if (nextStep == null) {
+            nextStep = targetHash[step] = {}
+          }
+          targetHash = nextStep
+        })
+        targetHash[lastKey] = patch.value
+      }
+    },
+  }
+}

data/lib/graphql/streaming/clients/graphql-streaming/streaming_graphql_client.js

@@ -0,0 +1,77 @@
+if (!Object.assign) { throw "StreamingGraphQLClient requires Object.assign" }
+
+var StreamingGraphQLClient = {
+  // Send a GraphQL query to the server,
+  // then receive patches from `\n\n`-delimited chunks.
+  // For each patch, call `onResponse` with the updated response (data and errors)
+  // @example Send a GraphQL query and handle the response
+  //   var queryString = "{ items @stream { name } }"
+  //   var queryVariables = {}
+  //
+  //   // Response handler checks for errors
+  //   var handleResponse = function(response) {
+  //     if (response.errors) {
+  //       alert("Uh oh, something went wrong!\n\n" + JSON.stringify(response.errors))
+  //     } else {
+  //       _this.setState({items: response.items})
+  //     }
+  //   }
+  //
+  //   StreamingGraphQL.fetch("/graphql", queryString, queryVariables, handleResponse)
+  //
+  fetch: function(endpointPath, queryString, variables, onResponse) {
+    var xhr = new XMLHttpRequest()
+    xhr.open("POST", endpointPath)
+    xhr.setRequestHeader('Content-Type', 'application/json')
+    var csrfToken = $('meta[name="csrf-token"]').attr('content')
+    xhr.setRequestHeader('X-CSRF-Token', csrfToken)
+
+    // This will collect patches to publish to `onResponse`
+    var responseData = {}
+
+    // It seems like `onprogress` was called once with the first _two_ patches.
+    // Track the index to make sure we don't miss any double-patches.
+    var nextPatchIdx = 0
+
+    var _this = this
+    xhr.onprogress = function () {
+      // responseText grows; we only care about the most recent patch
+      // TODO: it's a waste to split the text over and over, can
+      // we maintain a indicator to the last-read patch?
+      var patchStrings = xhr.responseText.split("\n\n")
+
+      while (patchStrings.length > nextPatchIdx) {
+        var nextPatchString = patchStrings[nextPatchIdx]
+        var nextPatch = JSON.parse(nextPatchString)
+        _this._mergePatch(responseData, nextPatch)
+        nextPatchIdx += 1
+      }
+
+      onResponse(responseData)
+    }
+
+    xhr.send(JSON.stringify({
+      query: queryString,
+      variables: variables,
+    }))
+  },
+
+  // merge `patch` into `responseData` (destructive)
+  _mergePatch: function(responseData, patch) {
+    if (patch.path.length === 0) {
+      Object.assign(responseData, patch.value)
+    } else {
+      var targetHash = responseData
+      var steps = patch.path.slice(0, patch.path.length - 1)
+      var lastKey = patch.path[patch.path.length - 1]
+      steps.forEach(function(step) {
+        var nextStep = targetHash[step]
+        if (nextStep == null) {
+          nextStep = targetHash[step] = {}
+        }
+        targetHash = nextStep
+      })
+      targetHash[lastKey] = patch.value
+    }
+  }
+}

data/lib/graphql/streaming/railtie.rb

@@ -0,0 +1,9 @@
+module GraphQL
+  module Streaming
+    class Railtie < Rails::Railtie
+      config.before_initialize do |app|
+        app.config.assets.paths << File.expand_path("../clients", __FILE__)
+      end
+    end
+  end
+end

data/lib/graphql/streaming/stream_collector.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module GraphQL
+  module Streaming
+    # Send patches by calling `stream.write`
+    # Each patch is serialized as JSON and delimited with "\n\n"
+    # @example Streaming a response with Rails
+    #   class ChunkedGraphqlsController < ApplicationController
+    #     include ActionController::Live
+    #
+    #     def create
+    #       # initialize the collector with `response.stream`
+    #       context = {
+    #         collector: StreamCollector.new(response.stream)
+    #       }
+    #
+    #       Schema.execute(query_string, variables: variables, context: context)
+    #
+    #       # close the stream when the query is done:
+    #       response.stream.close
+    #     end
+    #   end
+    class StreamCollector
+      DELIMITER = "\n\n"
+
+      # @param [<#write(String)>] A stream to write patches to
+      def initialize(stream)
+        @stream = stream
+        @first_patch = true
+      end
+
+      # Implement the collector API for DeferredExecution
+      def patch(path:, value:)
+        patch_string = JSON.dump({path: path, value: value})
+
+        if @first_patch
+          @first_patch = false
+          @stream.write(patch_string)
+        else
+          @stream.write(DELIMITER + patch_string)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/streaming/version.rb

@@ -0,0 +1,5 @@
+module Graphql
+  module Streaming
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: graphql-streaming
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Mosolgo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Tools for GraphQL over a long-lived connection
+email:
+- rdmosolgo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-streaming.gemspec
+- lib/graphql/streaming.rb
+- lib/graphql/streaming/action_cable_collector.rb
+- lib/graphql/streaming/action_cable_subscriber.rb
+- lib/graphql/streaming/assign_subscription_field.rb
+- lib/graphql/streaming/clients/graphql-streaming/graphql_channel.js
+- lib/graphql/streaming/clients/graphql-streaming/streaming_graphql_client.js
+- lib/graphql/streaming/railtie.rb
+- lib/graphql/streaming/stream_collector.rb
+- lib/graphql/streaming/version.rb
+homepage: https://github.com/rmosolgo/graphql-streaming-ruby
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Tools for GraphQL over a long-lived connection
+test_files: []