graphql-batch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3cf4d18124c65f414eb8fcdc54c0dab15e569041
+  data.tar.gz: fddb094273f8333c2cf25300c9a813104d382d6b
+SHA512:
+  metadata.gz: 2867edc13e5537b9999d2f1e0752c16524fa8a818ee5d834e2e7ef5273fcbf19db6e3a1f90a22a7874ca38ec7b312c35fd2412d6afae0dda07970bef23cff564
+  data.tar.gz: bc0e578c9315a211acd23748e765b8b1e993c34edf30e0f4dbd05acf97bc69b5a5671aa5015931491b6017f6940afbf57d2b5f29b0d1faa79f84530161a42488

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.1.5
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Shopify Inc.
+
+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,117 @@
+# Graphql::Batch
+
+Provides an executor for the [`graphql` gem](https://github.com/rmosolgo/graphql-ruby) which allows queries to be batched.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-batch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-batch
+
+## Usage
+
+### Basic Usage
+
+Require the library
+
+```ruby
+require 'graphql/batch'
+```
+
+Define a GraphQL::Batch::Query derived class. Use group_key to specify which queries can be reduced into a batch query, and an execute class method which makes that batch query and passes the result to each individual query.
+
+```ruby
+class FindQuery < GraphQL::Batch::Query
+  attr_reader :model, :id
+
+  def initialize(model, id, &block)
+    @model = model
+    @id = id
+    super(&block)
+  end
+
+  # super returns the class name
+  def group_key
+    "#{super}:#{model.name}"
+  end
+
+  def self.execute(queries)
+    model = queries.first.model
+    ids = queries.map(&:id)
+    records_by_id = model.where(id: ids).index_by(&:id)
+    queries.each do |query|
+      query.complete(records_by_id[query.id])
+    end
+  end
+end
+```
+
+When defining your schema, using the graphql gem, return a your batch query object from the resolve proc.
+
+```ruby
+resolve -> (obj, args, context) { FindQuery.new(Product, args["id"]) }
+```
+
+Use the batch execution strategy with your schema
+
+```ruby
+MySchema = GraphQL::Schema.new(query: MyQueryType)
+MySchema.query_execution_strategy = GraphQL::Batch::ExecutionStrategy
+```
+
+### Query Dependant Computed Fields
+
+If you don't want to use a query result directly, then you can pass a block which gets called after the query completes.
+
+```ruby
+resolve -> (obj, args, context) do
+  FindQuery.new(Product, args["id"]) do |product|
+    product.title
+  end
+end
+```
+
+You may also need to do another query that depends on the first one to get the result, in which case the query block can return another query.
+
+```ruby
+resolve -> (obj, args, context) do
+  FindQuery.new(Product, args["id"]) do |product|
+    FindQuery.new(Image, product.image_id)
+  end
+end
+```
+
+If the second query doesn't depend on the other one, then you can use GraphQL::Batch::QueryGroup, which allows each query in the group to be batched with other queries.
+
+```ruby
+resolve -> (obj, args, context) do
+  smart_collection_query = CountQuery.new(SmartCollection, context.shop_id)
+  custom_collection_query = CountQuery.new(CustomCollection, context.shop_id)
+
+  QueryGroup.new([smart_collection_query, custom_collection_query]) do
+    smart_collection_query.result + custom_collection_query.result
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/graphql-batch.
+
+## 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 => :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphql/batch"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/graphql-batch.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql/batch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql-batch"
+  spec.version       = Graphql::Batch::VERSION
+  spec.authors       = ["Dylan Thacker-Smith"]
+  spec.email         = ["Dylan.Smith@shopify.com"]
+
+  spec.summary       = "A query batching executor for the graphql gem"
+  spec.homepage      = "https://github.com/Shopify/graphql-batch"
+  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", "~>0.8"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/graphql/batch.rb

@@ -0,0 +1,6 @@
+require "graphql"
+require_relative "batch/version"
+require_relative "batch/query_container"
+require_relative "batch/query"
+require_relative "batch/query_group"
+require_relative "batch/execution_strategy"

data/lib/graphql/batch/execution_strategy.rb

@@ -0,0 +1,57 @@
+module GraphQL::Batch
+  class ExecutionStrategy < GraphQL::Query::SerialExecution
+    attr_reader :batched_queries
+
+    def initialize
+      @batched_queries = Hash.new{ |hash, key| hash[key] = [] }
+    end
+
+    class OperationResolution < GraphQL::Query::SerialExecution::OperationResolution
+      def result
+        result = super
+        until execution_strategy.batched_queries.empty?
+          queries = execution_strategy.batched_queries.shift.last
+          queries.first.class.execute(queries)
+        end
+        result
+      end
+    end
+
+    class SelectionResolution < GraphQL::Query::SerialExecution::SelectionResolution
+      def result
+        result_hash = super
+        result_hash.each do |key, value|
+          if value.is_a?(FieldResolution)
+            value.result_hash = result_hash
+          end
+        end
+        result_hash
+      end
+    end
+
+    class FieldResolution < GraphQL::Query::SerialExecution::FieldResolution
+      attr_accessor :result_hash
+
+      def get_finished_value(raw_value)
+        if raw_value.is_a?(QueryContainer)
+          raw_value.query_listener = self
+          register_queries(raw_value)
+          self
+        else
+          super
+        end
+      end
+
+      def register_queries(query_container)
+        query_container.each_query do |query|
+          execution_strategy.batched_queries[query.group_key] << query
+        end
+      end
+
+      def query_completed(query)
+        result_key = ast_node.alias || ast_node.name
+        @result_hash[result_key] = get_finished_value(query.result)
+      end
+    end
+  end
+end

data/lib/graphql/batch/query.rb

@@ -0,0 +1,29 @@
+module GraphQL::Batch
+  class Query < QueryContainer
+    def initialize(&block)
+      @block = block
+    end
+
+    # batched queries with the same key are merged together
+    def group_key
+      self.class.name
+    end
+
+    def each_query
+      yield self
+    end
+
+    def complete(result)
+      if @block
+        result = @block.call(result)
+        @block = nil
+      end
+      super(result)
+    end
+
+    # execute queries, with the same group_key, as a batch
+    def self.execute(queries)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/graphql/batch/query_container.rb

@@ -0,0 +1,30 @@
+module GraphQL::Batch
+  class QueryContainer
+    attr_accessor :query_listener, :result
+
+    def each_query
+      raise NotImplementedError
+    end
+
+    def complete(result)
+      if result.is_a?(QueryContainer)
+        result.query_listener = self
+        register_queries(result)
+      else
+        if instance_variable_defined?(:@result)
+          raise "Query was already completed"
+        end
+        @result = result
+        query_listener.query_completed(self)
+      end
+    end
+
+    def query_completed(query)
+      complete(query.result)
+    end
+
+    def register_queries(query_container)
+      query_listener.register_queries(query_container)
+    end
+  end
+end

data/lib/graphql/batch/query_group.rb

@@ -0,0 +1,35 @@
+module GraphQL::Batch
+  class QueryGroup < QueryContainer
+    def initialize(queries, &block)
+      @pending_queries = queries.dup
+      @pending_queries.each do |query|
+        query.query_listener = self
+      end
+      @block = block
+      raise ArgumentError, "QueryGroup requires a block" unless block
+    end
+
+    def each_query
+      @pending_queries.each do |query_container|
+        query_container.each_query do |query|
+          yield query
+        end
+      end
+    end
+
+    def query_completed(query)
+      @pending_queries.delete(query)
+      if @pending_queries.empty?
+        result = @block.call
+        @block = nil
+        if result.is_a?(QueryContainer)
+          result.query_listener = self
+          @pending_queries << result
+          register_queries(result)
+        else
+          complete(result)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/batch/version.rb

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

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: graphql-batch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dylan Thacker-Smith
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- Dylan.Smith@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-batch.gemspec
+- lib/graphql/batch.rb
+- lib/graphql/batch/execution_strategy.rb
+- lib/graphql/batch/query.rb
+- lib/graphql/batch/query_container.rb
+- lib/graphql/batch/query_group.rb
+- lib/graphql/batch/version.rb
+homepage: https://github.com/Shopify/graphql-batch
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A query batching executor for the graphql gem
+test_files: []