graphql-parallel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6286bad71786d342dd9e76db05ccc6b94b883cb
+  data.tar.gz: db3a736c1f0e2de5c168e81d431491cf4b534df4
+SHA512:
+  metadata.gz: 62fb61d65334d9926af99131ed958faf0b3d05c8d8209634b95d36e146264ed6a8a6b4ffa72f8a5d592c2ed9639b0997b4bcc6a6786c44e53fcdc03e5d640454
+  data.tar.gz: 6d70d57518d85a62ef375ebe8fcb473a061ac3ac00c62b7995e0fcb66ee48f20440a9ba673acf3dceedc529d501085257e1876b5df7db8a1a5852917215b282c

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in graphql-parallel.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 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,56 @@
+# GraphQL::Parallel
+
+Provides one layer of asynchronous field resolution to the [`graphql` gem](https://github.com/rmosolgo/graphql-ruby), backed Celluloid.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-parallel'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-parallel
+
+## Usage
+
+Require `GraphQL::Parallel`:
+
+```ruby
+require 'graphql/parallel'
+```
+
+Use `context.async` in your field resolve functions:
+
+```ruby
+resolve -> (obj, args, context) do
+  # resolve other fields while this request
+  # is in progress:
+  context.async do
+    response = Net::HTTP.get_response(obj.uri)
+    response.body
+  end
+end
+```
+
+Use `GraphQL::Parallel::ExecutionStrategy` for your schema's read queries:
+
+```ruby
+# Define your schema:
+MySchema = GraphQL::Schema.new(query: MyQueryType)
+
+# Use parallel execution for read queries:
+MySchema.query_execution_strategy = GraphQL::Parallel::ExecutionStrategy
+```
+
+_(`MySchema` will still use the default sequential execution strategy for mutations.)_
+
+## License
+
+MIT

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphql/parallel"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/graphql-parallel.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql/parallel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphql-parallel"
+  spec.version       = Graphql::Parallel::VERSION
+  spec.authors       = ["Robert Mosolgo"]
+  spec.email         = ["rdmosolgo@gmail.com"]
+
+  spec.summary       = %q{A simple parallel execution strategy for GraphQL.}
+  spec.description   = %q{Extend the GraphQL gem by allowing for one level of asynchronous field resolution.}
+  spec.homepage      = "https://github.com/rmosolgo/graphql-parallel"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  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_runtime_dependency "celluloid", "~>0.17"
+
+  spec.add_development_dependency "codeclimate-test-reporter", '~>0.4'
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-focus", "~> 1.1"
+  spec.add_development_dependency "minitest-reporters", "~>1.0"
+end

data/lib/graphql/parallel/execution_pool.rb

@@ -0,0 +1,7 @@
+module GraphQL
+  module Parallel
+    class ExecutionPool < Celluloid::Supervision::Container
+      pool GraphQL::Parallel::ExecutionWorker, as: :execution_worker_pool
+    end
+  end
+end

data/lib/graphql/parallel/execution_strategy.rb

@@ -0,0 +1,78 @@
+module GraphQL
+  module Parallel
+    class ExecutionStrategy < GraphQL::Query::BaseExecution
+      def initialize
+        # Why isn't `require "celluloid/current"` enough here?
+        Celluloid.boot unless Celluloid.running?
+        @has_futures = false
+      end
+
+      def pool
+        @pool ||= ExecutionPool.run!
+        @pool[:execution_worker_pool]
+      end
+
+      def async(block)
+        @has_futures ||= true
+        pool.future.resolve(block)
+      end
+
+      def has_futures?
+        @has_futures
+      end
+
+      class OperationResolution < GraphQL::Query::SerialExecution::OperationResolution
+        def result
+          result_futures = super
+          if execution_strategy.has_futures?
+            finished_result = finish_all_futures(result_futures)
+          else
+            # Don't bother re-traversing the result if there are no futures.
+            finished_result = result_futures
+          end
+        ensure
+          execution_strategy.pool.terminate
+          finished_result
+        end
+
+        # Recurse over `result_object`, finding any futures and
+        # getting their finished values.
+        def finish_all_futures(result_object)
+          if result_object.is_a?(GraphQL::Parallel::FutureFieldResolution)
+            resolved_value = finish_all_futures(result_object.result)
+          elsif result_object.is_a?(Hash)
+            result_object.each do |key, value|
+              result_object[key] = finish_all_futures(value)
+            end
+            resolved_value = result_object
+          elsif result_object.is_a?(Array)
+            resolved_value = result_object.map { |v| finish_all_futures(v) }
+          else
+            resolved_value = result_object
+          end
+          resolved_value
+
+        end
+      end
+
+      class SelectionResolution < GraphQL::Query::SerialExecution::SelectionResolution
+      end
+
+      class FieldResolution < GraphQL::Query::SerialExecution::FieldResolution
+        def get_finished_value(raw_value)
+          if raw_value.is_a?(Celluloid::Future)
+            GraphQL::Parallel::FutureFieldResolution.new(field_resolution: self, future: raw_value)
+          else
+            super
+          end
+        end
+      end
+
+      class InlineFragmentResolution < GraphQL::Query::SerialExecution::InlineFragmentResolution
+      end
+
+      class FragmentSpreadResolution < GraphQL::Query::SerialExecution::FragmentSpreadResolution
+      end
+    end
+  end
+end

data/lib/graphql/parallel/execution_worker.rb

@@ -0,0 +1,10 @@
+module GraphQL
+  module Parallel
+    class ExecutionWorker
+      include Celluloid
+      def resolve(proc)
+        proc.call
+      end
+    end
+  end
+end

data/lib/graphql/parallel/future_field_resolution.rb

@@ -0,0 +1,16 @@
+module GraphQL
+  module Parallel
+    class FutureFieldResolution
+      def initialize(field_resolution:, future:)
+        @field_resolution = field_resolution
+        @future = future
+      end
+
+      def result
+        resolved_value = @future.value
+        result_value = @field_resolution.get_finished_value(resolved_value)
+        result_value
+      end
+    end
+  end
+end

data/lib/graphql/parallel/monkey_patches.rb

@@ -0,0 +1,15 @@
+module GraphQL
+  class Query
+    class Context
+      # For Parallel::ExecutionStrategy, make a promise.
+      # Otherwise, it's not really async.
+      def async(&block)
+        if execution_strategy.respond_to?(:async)
+          execution_strategy.async(block)
+        else
+          block.call
+        end
+      end
+    end
+  end
+end

data/lib/graphql/parallel/version.rb

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

data/lib/graphql/parallel.rb

@@ -0,0 +1,7 @@
+require "graphql"
+require "celluloid/current"
+require "graphql/parallel/version"
+require "graphql/parallel/future_field_resolution"
+require "graphql/parallel/execution_worker"
+require "graphql/parallel/execution_pool"
+require "graphql/parallel/execution_strategy"

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: graphql-parallel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Mosolgo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-11 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: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Extend the GraphQL gem by allowing for one level of asynchronous field
+  resolution.
+email:
+- rdmosolgo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-parallel.gemspec
+- lib/graphql/parallel.rb
+- lib/graphql/parallel/execution_pool.rb
+- lib/graphql/parallel/execution_strategy.rb
+- lib/graphql/parallel/execution_worker.rb
+- lib/graphql/parallel/future_field_resolution.rb
+- lib/graphql/parallel/monkey_patches.rb
+- lib/graphql/parallel/version.rb
+homepage: https://github.com/rmosolgo/graphql-parallel
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A simple parallel execution strategy for GraphQL.
+test_files: []
+has_rdoc: