graphql-result_cache 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ba79fe918d359fba4d366fd3becfd4779860b3af1c4083c634578bba7258fbf9
+  data.tar.gz: 814addd76ffa4ccb92a4641d27c58d71d0359005eff4e1bc9145cd6d47cf2b0b
+SHA512:
+  metadata.gz: 7a8cb8d375f740c870acd94feaafded3d38e911acafa73573748ff63c49c9134e844488308a054ab601daafe56fa6af23a71bb9b7e4a68c7b3e27975d9a1a5f0
+  data.tar.gz: 59ca4da7a641b8c66f8de5452c647cf56301a37ce5a62e0b0de4a02165d90749f594c5ad6b139fef361f18e7a2dd63f0bb2b2e1eea13590d5a77a99bcdd0e3e5

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/.idea/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at saharaying@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in graphql-result_cache.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    graphql-result_cache (0.1.0)
+      graphql (~> 1.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    graphql (1.9.7)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  graphql-result_cache!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ying Fu
+
+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::ResultCache
+
+This gem is to cache the json result, instead of resolved object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphql-result_cache'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install graphql-result_cache
+
+## Usage
+
+1. Use `GraphQL::ResultCache` as a plugin in your schema.
+ 
+```ruby
+class MySchema < GraphQL::Schema
+  mutation Types::MutationType
+  query Types::QueryType
+ 
+  use GraphQL::ResultCache
+end
+```
+
+2. Add the custom field class to accept `result_cache` metadata.
+
+```ruby
+module Types
+  class BaseObject < GraphQL::Schema::Object
+    field_class GraphQL::ResultCache::Field
+  end
+end
+```
+
+3. Config the fields which need to be cached with `result_cache` definition.
+
+```ruby
+field :theme, Types::ThemeType, null: false, result_cache: true
+```
+
+4. Wrap query result with `GraphQL::ResultCache::Result`.
+
+```ruby
+class GraphqlController < ApplicationController
+  def execute
+    # ...
+    result = if params[:_json]
+               multiple_execute(params[:_json], context: context)
+             else
+               execute_query(context: context)
+             end
+    render json: GraphQL::ResultCache::Result.new(result)
+  end
+end
+```
+
+## Result Cache Customization
+
+### Cache condition
+
+```ruby
+field :theme, Types::ThemeType, null: false, result_cache: { if: :published? }
+```
+The `if` condition can be either a Symbol or a Proc.
+
+### Customized cache key
+
+By default, `GraphQL::ResultCache` will generate a cache key combining the field path, arguments and object. 
+But you can customize the object clause by specify the `key` option.
+
+```ruby
+field :theme, Types::ThemeType, null: false, result_cache: { key: :theme_cache_key }
+```
+The `key` can be either a Symbol or a Proc.
+
+## Global Configuration
+
+`GraphQL::ResultCache` can be configured in initializer.
+
+```ruby
+# config/initializers/graphql/result_cache.rb
+
+GraphQL::ResultCache.configure do |config|
+  config.namespace   = "GraphQL:Result"                         # Cache key namespace
+  config.expires_in  = 1.hour                                   # Expire time for the cache, default to 1.hour
+  config.client_hash = -> { Rails.cache.read(:deploy_version) } # GraphQL client package hash key, used in cache key generation, default to nil
+  config.cache       = Rails.cache                              # The cache object, default to Rails.cache in Rails
+  config.logger      = Rails.logger                             # The Logger, default to Rails.logger in Rails
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/saharaying/graphql-result_cache. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GraphQL::ResultCache project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/saharaying/graphql-result_cache/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "graphql/result_cache"
+
+# 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(__FILE__)

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-result_cache.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphql/result_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'graphql-result_cache'
+  spec.version       = GraphQL::ResultCache::VERSION
+  spec.authors       = ['Ying Fu']
+  spec.email         = ['saharaying@gmail.com']
+
+  spec.summary       = 'A result caching plugin for graphql-ruby'
+  spec.description   = 'A result caching plugin for graphql-ruby'
+  spec.homepage      = 'https://github.com/saharaying/graphql-result_cache'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency 'graphql', '~> 1.9'
+
+  spec.required_ruby_version = '>= 2.1.0'
+end

data/lib/graphql/result_cache.rb

@@ -0,0 +1,41 @@
+require 'graphql'
+require 'graphql/result_cache/version'
+require 'graphql/result_cache/field'
+require 'graphql/result_cache/result'
+require 'graphql/result_cache/field_instrument'
+
+module GraphQL
+  module ResultCache
+    class << self
+      attr_accessor :expires_in
+      attr_accessor :namespace
+      attr_accessor :cache
+      attr_accessor :logger
+
+      # to expire the cache when client hash changes, should be a proc. eg:
+      # c.client_hash = -> { Rails.cache.read(:deploy_version) }
+      attr_accessor :client_hash
+
+      # ```
+      # GraphQL::ResultCache.configure do |c|
+      #   c.namespace = "GraphQL:Result"
+      #   c.expires_in = 1.hour
+      #   c.client_hash = -> { Rails.cache.read(:deploy_version) }
+      # end
+      # ```
+      def configure
+        yield self
+      end
+    end
+
+    # Default configuration
+    @expires_in = 3600              # 1.hour
+    @namespace = 'GraphQL:Result'
+
+    def self.use(schema_def, options: {})
+      schema_def.instrument(:field, ::GraphQL::ResultCache::FieldInstrument.new)
+    end
+  end
+end
+
+require 'graphql/result_cache/rails' if defined?(::Rails::Engine)

data/lib/graphql/result_cache/condition.rb

@@ -0,0 +1,23 @@
+module GraphQL
+  module ResultCache
+    class Condition
+      def initialize config, obj:, args:, ctx:
+        @if = config[:if]
+        @obj = obj
+        @args = args
+        @ctx = ctx
+      end
+
+      def true?
+        case @if
+          when Symbol
+            @obj.send(@if)
+          when Proc
+            @if.call(@obj, @args, @ctx)
+          else
+            true
+        end
+      end
+    end
+  end
+end

data/lib/graphql/result_cache/context_config.rb

@@ -0,0 +1,71 @@
+module GraphQL
+  module ResultCache
+    class ContextConfig
+
+      attr_accessor :value
+
+      def initialize
+        @value = {}
+      end
+
+      def add context:, key:
+        @value[context.query] ||= []
+        cached = cache.exist? key
+        logger&.info "GraphQL result cache key #{cached ? 'hit' : 'miss'}: #{key}"
+        @value[context.query] << { path: context.path, key: key, result: cached ? cache.read(key) : nil }
+        cached
+      end
+
+      def process result
+        config_of_query = of_query(result.query)
+        blank?(config_of_query) ? result : cache_or_amend_result(result, config_of_query)
+      end
+
+      def of_query query
+        @value[query]
+      end
+
+      private
+
+      def blank? obj
+        obj.respond_to?(:empty?) ? !!obj.empty? : !obj
+      end
+
+      def cache_or_amend_result result, config_of_query
+        config_of_query.each do |config|
+          if config[:result].nil?
+            cache.write config[:key], result.dig('data', *config[:path]), expires_in: expires_in
+          else
+            # result already got from cache, need to amend to response
+            deep_merge! result.to_h, 'data' => config[:path].reverse.inject(config[:result]) { |a, n| {n => a} }
+          end
+        end
+        result
+      end
+
+      def deep_merge! hash, other_hash, &block
+        hash.merge!(other_hash) do |key, this_val, other_val|
+          if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+            deep_merge!(this_val.dup, other_val, &block)
+          elsif block_given?
+            block.call(key, this_val, other_val)
+          else
+            other_val
+          end
+        end
+      end
+
+      def cache
+        ::GraphQL::ResultCache.cache
+      end
+
+      def logger
+        ::GraphQL::ResultCache.logger
+      end
+
+      def expires_in
+        ::GraphQL::ResultCache.expires_in
+      end
+    end
+  end
+end

data/lib/graphql/result_cache/field.rb

@@ -0,0 +1,16 @@
+module GraphQL
+  module ResultCache
+    class Field < ::GraphQL::Schema::Field
+      def initialize(*args, result_cache: nil, **kwargs, &block)
+        @result_cache_config = result_cache
+        super(*args, **kwargs, &block)
+      end
+
+      def to_graphql
+        field_defn = super # Returns a GraphQL::Field
+        field_defn.metadata[:result_cache] = @result_cache_config
+        field_defn
+      end
+    end
+  end
+end

data/lib/graphql/result_cache/field_instrument.rb

@@ -0,0 +1,36 @@
+require 'graphql/result_cache/condition'
+require 'graphql/result_cache/context_config'
+require 'graphql/result_cache/key'
+
+module GraphQL
+  module ResultCache
+    class FieldInstrument
+      def instrument _type, field
+        return field unless field.metadata[:result_cache]
+
+        cached_resolve_proc = cached_resolve(field)
+        field.redefine do
+          resolve(cached_resolve_proc)
+          # for cacheable field, change type to be nullable
+          type(field.type.of_type) if field.type.non_null?
+        end
+      end
+
+      private
+
+      def cached_resolve field
+        old_resolve_proc = field.resolve_proc
+        cache_config = field.metadata[:result_cache]
+        cache_config = {} unless cache_config.is_a?(Hash)
+        lambda do |obj, args, ctx|
+          if Condition.new(cache_config, obj: obj, args: args, ctx: ctx).true?
+            ctx[:result_cache] ||= ContextConfig.new
+            cache_key = Key.new(obj: obj, args: args, ctx: ctx, key: cache_config[:key])
+            cached = ctx[:result_cache].add context: ctx, key: cache_key.to_s
+          end
+          old_resolve_proc.call(obj, args, ctx) unless cached
+        end
+      end
+    end
+  end
+end

data/lib/graphql/result_cache/key.rb

@@ -0,0 +1,59 @@
+module GraphQL
+  module ResultCache
+    class Key
+      def initialize obj:, args:, ctx:, key: nil
+        @obj = obj
+        @args = args
+        @ctx = ctx
+        @key = key
+      end
+
+      def to_s
+        @to_s ||= [
+            ::GraphQL::ResultCache.namespace,
+            path_clause,
+            args_clause,
+            object_clause,
+            client_hash_clause
+        ].flatten.compact.join(':')
+      end
+
+      private
+
+      def path_clause
+        @ctx.path.join('/')
+      end
+
+      def args_clause
+        @args.to_h.to_a.flatten
+      end
+
+      def object_clause
+        case @key
+          when Symbol
+            @obj.public_send(@key)
+          when Proc
+            @key.call(@obj, @args, @ctx)
+          when NilClass
+            guess_id
+          else
+            @key
+        end
+      end
+
+      def client_hash_clause
+        clause = ::GraphQL::ResultCache.client_hash
+        clause.is_a?(Proc) ? clause.call : clause
+      end
+
+      def guess_id
+        object = @obj.object
+        return unless object
+        return object.cache_key if object.respond_to?(:cache_key)
+        return object.id if object.respond_to?(:id)
+        object.object_id
+      end
+
+    end
+  end
+end

data/lib/graphql/result_cache/rails.rb

@@ -0,0 +1,15 @@
+module GraphQL
+  module ResultCache
+    if defined?(::Rails)
+      # Railtie integration used to default {GraphQL::ResultCache.cache}
+      # and {GraphQL::ResultCache.logger} when in a Rails environment.
+      class Rails < ::Rails::Engine
+        config.after_initialize do
+          # default values for cache and logger in Rails if not set already
+          GraphQL::ResultCache.cache  = ::Rails.cache unless GraphQL::ResultCache.cache
+          GraphQL::ResultCache.logger = ::Rails.logger unless GraphQL::ResultCache.logger
+        end
+      end
+    end
+  end
+end

data/lib/graphql/result_cache/result.rb

@@ -0,0 +1,32 @@
+module GraphQL
+  module ResultCache
+    class Result
+      extend Forwardable
+
+      attr_reader :value
+
+      def_delegators :@value, :to_json, :as_json
+
+      def initialize query_result
+        @_result = query_result
+        @value = process_with_result_cache
+      end
+
+      private
+
+      def process_with_result_cache
+        return process_each(@_result) unless @_result.is_a?(Array)
+        @_result.map { |result| process_each(result) }
+      end
+
+      def process_each result
+        result_cache_config = result.query.context[:result_cache]
+        blank?(result_cache_config) ? result : result_cache_config.process(result)
+      end
+
+      def blank? obj
+        obj.respond_to?(:empty?) ? !!obj.empty? : !obj
+      end
+    end
+  end
+end

data/lib/graphql/result_cache/version.rb

@@ -0,0 +1,5 @@
+module GraphQL
+  module ResultCache
+    VERSION = '0.1.1'
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: graphql-result_cache
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ying Fu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-17 00:00:00.000000000 Z
+dependencies:
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: A result caching plugin for graphql-ruby
+email:
+- saharaying@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-result_cache.gemspec
+- lib/graphql/result_cache.rb
+- lib/graphql/result_cache/condition.rb
+- lib/graphql/result_cache/context_config.rb
+- lib/graphql/result_cache/field.rb
+- lib/graphql/result_cache/field_instrument.rb
+- lib/graphql/result_cache/key.rb
+- lib/graphql/result_cache/rails.rb
+- lib/graphql/result_cache/result.rb
+- lib/graphql/result_cache/version.rb
+homepage: https://github.com/saharaying/graphql-result_cache
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: A result caching plugin for graphql-ruby
+test_files: []