graphql-fragment_cache 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 515ec358aecf867ce2d2ec5ac82003d802dc6c31d6402d62593a626ac5bad81e
-  data.tar.gz: 8b1b3d82c0fb808a2cd826c710047635ba141895843ff7b804a301848d266ff5
+  metadata.gz: 7335be135632f708b99b20d71dc28b4711e0899c68a042f0b29950f560eeb543
+  data.tar.gz: 30674b1fff64a0457d5de9e690b8b219545702a68eaeab186f000b0f64733e34
 SHA512:
-  metadata.gz: 2c2dd089bf31f6d2491fc7d904d8ca356a2dfbc2cace258fe1e3b49c18dc59a64805a1cb96655bfb23eacc62ed027198365491759005b232354a2ee8ed41e605
-  data.tar.gz: 92309ef8b7ee62a5fd85007a88be932874f996d12ee08a1e81530d90fa3138dc631f90ad6a6f41c3952338001e10cefbeb1691bcea7891ba9b2f4027543e659d
+  metadata.gz: 1a4e4a3bcaf2ef3d51e3bd3cd399474e6e1b655ab8ad7583d79157db20f4fc466bc2d6f99796a4025c62a0249ef77d3471798f868e4a63a5948ff8ecb9d4f3ae
+  data.tar.gz: 9dec0c5bb94b0b08c09854098ac2bd8ae6cbfb8ebc005925b43b862e84b1a4542d168b2e3cb2ae13b69beca39ccfe403df322f59b0239d79c055a29375214fdc

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 ## master
 
+## 1.2.0 (2020-10-26)
+
+- [PR#37](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/37) Try to use `cache_key_with_version` or `cache_key` with Rails CacheKeyBuilder ([@bbugh][])
+
+## 1.1.0 (2020-10-26)
+
+- [PR#38](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/38) Support caching from other places than field or resolver  ([@DmitryTsepelev][])
+
+## 1.0.5 (2020-10-13)
+
+- [PR#35](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/35) Prefer using `#write_multi` on cache store when possible ([@DmitryTsepelev][])
+
+## 1.0.4 (2020-10-12)
+
+- [PR#34](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/34) Avoid unneded default calculation in CacheKeyBuilder ([@DmitryTsepelev][])
+- [PR#31](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/31) Do not patch Connection#wrap in graphql >= 1.10.5 ([@DmitryTsepelev][])
+
+## 1.0.3 (2020-08-31)
+
+- [PR#29](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/29) Cache result JSON instead of connection objects ([@DmitryTsepelev][])
+
 ## 1.0.2 (2020-08-19)
 
 - [PR#28](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/28) Support #keys method for GraphQL::FragmentCache::MemoryStore instance ([@reabiliti][])
@@ -52,3 +73,4 @@
 [@palkan]: https://github.com/palkan
 [@ssnickolay]: https://github.com/ssnickolay
 [@reabiliti]: https://github.com/reabiliti
+[@bbugh]: https://github.com/bbugh

data/README.md

@@ -38,6 +38,14 @@ class BaseType < GraphQL::Schema::Object
 end
 ```
 
+If you're using [resolvers](https://graphql-ruby.org/fields/resolvers.html) — include the module into the base resolver as well:
+
+```ruby
+class Resolvers::BaseResolver < GraphQL::Schema::Resolver
+  include GraphQL::FragmentCache::ObjectHelpers
+end
+```
+
 Now you can add `cache_fragment:` option to your fields to turn caching on:
 
 ```ruby
@@ -47,7 +55,7 @@ class PostType < BaseObject
 end
 ```
 
-Alternatively, you can use `cache_fragment` method inside resolvers:
+Alternatively, you can use `cache_fragment` method inside resolver methods:
 
 ```ruby
 class QueryType < BaseObject
@@ -252,7 +260,7 @@ Rails.application.configure do |config|
 end
 ```
 
-⚠️ Cache store must implement `#read(key)`, `#write(key, value, **options)` and `#exist?(key)` methods.
+⚠️ Cache store must implement `#read(key)`, `#exist?(key)` and `#write_multi(hash, **options)` or `#write(key, value, **options)` methods.
 
 The gem provides only in-memory store out-of-the-box (`GraphQL::FragmentCache::MemoryStore`). It's used by default.
 
@@ -275,6 +283,47 @@ class QueryType < BaseObject
 end
 ```
 
+## How to use `#cache_fragment` in extensions (and other places where context is not available)
+
+If you want to call `#cache_fragment` from places other that fields or resolvers, you'll need to pass `context` explicitly and turn on `raw_value` support. For instance, let's take a look at this extension:
+
+```ruby
+class Types::QueryType < Types::BaseObject
+  class CurrentMomentExtension < GraphQL::Schema::FieldExtension
+    # turning on cache_fragment support
+    include GraphQL::FragmentCache::ObjectHelpers
+
+    def resolve(object:, arguments:, context:)
+      # context is passed explicitly
+      cache_fragment(context: context) do
+        result = yield(object, arguments)
+        "#{result} (at #{Time.now})"
+      end
+    end
+  end
+
+  field :event, String, null: false, extensions: [CurrentMomentExtension]
+
+  def event
+    "something happened"
+  end
+end
+```
+
+With this approach you can use `#cache_fragment` in any place you have an access to the `context`. When context is not available, the error `cannot find context, please pass it explicitly` will be thrown.
+
+## Limitations
+
+Caching does not work for Union types, because of the `Lookahead` implementation: it requires the exact type to be passed to the `selection` method (you can find the [discussion](https://github.com/rmosolgo/graphql-ruby/pull/3007) here). This method is used for cache key building, and I haven't found a workaround yet ([PR in progress](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/30)). If you get `Failed to look ahead the field` error — please pass `query_cache_key` explicitly:
+
+```ruby
+field :cached_avatar_url, String, null: false
+
+def cached_avatar_url
+  cache_fragment(query_cache_key: "post_avatar_url(#{object.id})") { object.avatar_url }
+end
+```
+
 ## Credits
 
 Based on the original [gist](https://gist.github.com/palkan/faad9f6ff1db16fcdb1c071ec50e4190) by [@palkan](https://github.com/palkan) and [@ssnickolay](https://github.com/ssnickolay).

data/lib/.rbnext/2.3/graphql/fragment_cache/memory_store.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+using RubyNext
+
+module GraphQL
+  module FragmentCache
+    # Memory adapter for storing cached fragments
+    class MemoryStore
+      using RubyNext
+
+      class Entry < Struct.new(:value, :expires_at, keyword_init: true)
+        def expired?
+          expires_at && expires_at < Time.now
+        end
+      end
+
+      attr_reader :default_expires_in
+
+      def initialize(expires_in: nil, **other)
+        raise ArgumentError, "Unsupported options: #{other.keys.join(",")}" unless other.empty?
+
+        @default_expires_in = expires_in
+        @storage = {}
+      end
+
+      def keys
+        storage.keys
+      end
+
+      def exist?(key)
+        storage.key?(key)
+      end
+
+      def read(key)
+        key = key.to_s
+        ((!storage[key].nil?) || nil) && storage[key].then do |entry|
+  if entry.expired?
+    delete(key)
+    next
+  end
+  entry.value
+end
+      end
+
+      def write(key, value, expires_in: default_expires_in, **options)
+        key = key.to_s
+        @storage[key] = Entry.new(value: value, expires_at: expires_in ? Time.now + expires_in : nil)
+      end
+
+      def delete(key)
+        key = key.to_s
+        storage.delete(key)
+      end
+
+      def clear
+        storage.clear
+      end
+
+      private
+
+      attr_reader :storage
+    end
+  end
+end

data/lib/.rbnext/2.7/graphql/fragment_cache/cache_key_builder.rb

@@ -121,11 +121,11 @@ module GraphQL
       private
 
       def schema_cache_key
-        @options.fetch(:schema_cache_key, schema.schema_cache_key)
+        @options.fetch(:schema_cache_key) { schema.schema_cache_key }
       end
 
       def query_cache_key
-        @options.fetch(:query_cache_key, "#{path_cache_key}[#{selections_cache_key}]")
+        @options.fetch(:query_cache_key) { "#{path_cache_key}[#{selections_cache_key}]" }
       end
 
       def selections_cache_key

data/lib/graphql/fragment_cache.rb

@@ -6,6 +6,8 @@ require "graphql/fragment_cache/ext/context_fragments"
 require "graphql/fragment_cache/ext/graphql_cache_key"
 require "graphql/fragment_cache/object"
 
+require "graphql/fragment_cache/connections/patch"
+
 require "graphql/fragment_cache/schema/patch"
 require "graphql/fragment_cache/schema/tracer"
 require "graphql/fragment_cache/schema/instrumentation"
@@ -26,6 +28,8 @@ module GraphQL
         schema_defn.tracer(Schema::Tracer)
         schema_defn.instrument(:query, Schema::Instrumentation)
         schema_defn.extend(Schema::Patch)
+
+        GraphQL::Pagination::Connections.prepend(Connections::Patch)
       end
 
       def cache_store=(store)

data/lib/graphql/fragment_cache/cache_key_builder.rb

@@ -121,11 +121,11 @@ module GraphQL
       private
 
       def schema_cache_key
-        @options.fetch(:schema_cache_key, schema.schema_cache_key)
+        @options.fetch(:schema_cache_key) { schema.schema_cache_key }
       end
 
       def query_cache_key
-        @options.fetch(:query_cache_key, "#{path_cache_key}[#{selections_cache_key}]")
+        @options.fetch(:query_cache_key) { "#{path_cache_key}[#{selections_cache_key}]" }
       end
 
       def selections_cache_key

data/lib/graphql/fragment_cache/cacher.rb

@@ -10,7 +10,26 @@ module GraphQL
         def call(query)
           return unless query.context.fragments?
 
-          query.context.fragments.each(&:persist)
+          if FragmentCache.cache_store.respond_to?(:write_multi)
+            batched_persist(query)
+          else
+            persist(query)
+          end
+        end
+
+        private
+
+        def batched_persist(query)
+          query.context.fragments.group_by(&:options).each do |options, group|
+            hash = group.map { |fragment| [fragment.cache_key, fragment.value] }.to_h
+            FragmentCache.cache_store.write_multi(hash, **options)
+          end
+        end
+
+        def persist(query)
+          query.context.fragments.each do |fragment|
+            FragmentCache.cache_store.write(fragment.cache_key, fragment.value, **fragment.options)
+          end
         end
       end
     end

data/lib/graphql/fragment_cache/connections/patch.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module FragmentCache
+    module Connections
+      # Patches GraphQL::Pagination::Connections to support raw values
+      module Patch
+        if Gem::Dependency.new("graphql", "< 1.11.0").match?("graphql", GraphQL::VERSION)
+          def wrap(field, object, arguments, context, *options)
+            raw_value?(object) ? object : super
+          end
+        elsif Gem::Dependency.new("graphql", "< 1.11.5").match?("graphql", GraphQL::VERSION)
+          def wrap(field, parent, items, arguments, context, *options)
+            raw_value?(items) ? items : super
+          end
+        end
+
+        private
+
+        def raw_value?(value)
+          GraphQL::Execution::Interpreter::RawValue === value
+        end
+      end
+    end
+  end
+end

data/lib/graphql/fragment_cache/fragment.rb

@@ -8,8 +8,6 @@ module GraphQL
     class Fragment
       attr_reader :options, :path, :context
 
-      attr_accessor :resolved_value
-
       def initialize(context, **options)
         @context = context
         @options = options
@@ -24,25 +22,18 @@ module GraphQL
         end
       end
 
-      def persist
-        # Connections are not available from the runtime object, so
-        # we rely on Schema::Tracer to save it for us
-        value = resolved_value || resolve_from_runtime
-        FragmentCache.cache_store.write(cache_key, value, **options)
-      end
-
-      private
-
       def cache_key
         @cache_key ||= CacheKeyBuilder.call(path: path, query: context.query, **options)
       end
 
-      def interpreter_context
-        context.namespace(:interpreter)
+      def value
+        final_value.dig(*path)
       end
 
-      def resolve_from_runtime
-        final_value.dig(*path)
+      private
+
+      def interpreter_context
+        context.namespace(:interpreter)
       end
 
       def final_value

data/lib/graphql/fragment_cache/object_helpers.rb

@@ -10,41 +10,33 @@ module GraphQL
     module ObjectHelpers
       extend Forwardable
 
-      NO_OBJECT = Object.new
+      def self.included(base)
+        return if base < GraphQL::Execution::Interpreter::HandlesRawValue
+
+        base.include(GraphQL::Execution::Interpreter::HandlesRawValue)
+      end
 
-      def_delegator :field, :connection?
+      NO_OBJECT = Object.new
 
       def cache_fragment(object_to_cache = NO_OBJECT, **options, &block)
         raise ArgumentError, "Block or argument must be provided" unless block_given? || object_to_cache != NO_OBJECT
 
         options[:object] = object_to_cache if object_to_cache != NO_OBJECT
 
-        fragment = Fragment.new(context, options)
+        context_to_use = options.delete(:context)
+        context_to_use = context if context_to_use.nil? && respond_to?(:context)
+        raise ArgumentError, "cannot find context, please pass it explicitly" unless context_to_use
+
+        fragment = Fragment.new(context_to_use, options)
 
         if (cached = fragment.read)
-          return nil if cached == Fragment::NIL_IN_CACHE
-          return restore_cached_value(cached)
+          return cached == Fragment::NIL_IN_CACHE ? nil : raw_value(cached)
         end
 
         (block_given? ? block.call : object_to_cache).tap do |resolved_value|
-          context.fragments << fragment
+          context_to_use.fragments << fragment
         end
       end
-
-      private
-
-      def restore_cached_value(cached)
-        # If we return connection object from resolver, Interpreter stops processing it
-        connection? ? cached : raw_value(cached)
-      end
-
-      def field
-        interpreter_context[:current_field]
-      end
-
-      def interpreter_context
-        @interpreter_context ||= context.namespace(:interpreter)
-      end
     end
   end
 end

data/lib/graphql/fragment_cache/rails/cache_key_builder.rb

@@ -6,6 +6,8 @@ module GraphQL
     class CacheKeyBuilder
       def object_key(obj)
         return obj.graphql_cache_key if obj.respond_to?(:graphql_cache_key)
+        return obj.cache_key_with_version if obj.respond_to?(:cache_key_with_version)
+        return obj.cache_key if obj.respond_to?(:cache_key)
         return obj.map { |item| object_key(item) }.join("/") if obj.is_a?(Array)
         return object_key(obj.to_a) if obj.respond_to?(:to_a)
 

data/lib/graphql/fragment_cache/schema/tracer.rb

@@ -10,18 +10,15 @@ module GraphQL
         class << self
           def trace(key, data)
             yield.tap do |resolved_value|
-              next unless connection_to_cache?(key, data)
+              next unless connection_field?(key, data)
 
-              # We need to attach connection object to fragment and save it later
-              context = data[:query].context
-              verify_connections!(context)
-              cache_connection(resolved_value, context)
+              verify_connections!(data[:query].context)
             end
           end
 
           private
 
-          def connection_to_cache?(key, data)
+          def connection_field?(key, data)
             key == "execute_field" && data[:field].connection?
           end
 
@@ -31,12 +28,6 @@ module GraphQL
             raise StandardError,
               "GraphQL::Pagination::Connections should be enabled for connection caching"
           end
-
-          def cache_connection(resolved_value, context)
-            current_path = context.namespace(:interpreter)[:current_path]
-            fragment = context.fragments.find { |fragment| fragment.path == current_path }
-            fragment.resolved_value = resolved_value if fragment
-          end
         end
       end
     end

data/lib/graphql/fragment_cache/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module FragmentCache
-    VERSION = "1.0.2"
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-fragment_cache
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-19 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
@@ -128,28 +128,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: ruby-next-parser
+  name: unparser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.8.0.7
+        version: 0.4.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.8.0.7
+        version: 0.4.9
 description: Fragment cache for graphql-ruby
 email:
 - dmitry.a.tsepelev@gmail.com
@@ -162,12 +162,14 @@ files:
 - README.md
 - bin/console
 - bin/setup
+- lib/.rbnext/2.3/graphql/fragment_cache/memory_store.rb
 - lib/.rbnext/2.7/graphql/fragment_cache/cache_key_builder.rb
 - lib/.rbnext/2.7/graphql/fragment_cache/ext/graphql_cache_key.rb
 - lib/graphql-fragment_cache.rb
 - lib/graphql/fragment_cache.rb
 - lib/graphql/fragment_cache/cache_key_builder.rb
 - lib/graphql/fragment_cache/cacher.rb
+- lib/graphql/fragment_cache/connections/patch.rb
 - lib/graphql/fragment_cache/ext/context_fragments.rb
 - lib/graphql/fragment_cache/ext/graphql_cache_key.rb
 - lib/graphql/fragment_cache/field_extension.rb