graphql-fragment_cache 1.0.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fd575d2efddb52ef6d0f878b40823baae40cedec5aa683ba5f6a1b39b98bffe
-  data.tar.gz: eba1c06d3650d395575bd96927f831fc206f797b47afa9ebfcfff9adbf2ecf1d
+  metadata.gz: 8454e3e398cc31081e2b17fb4a9b9e971cfbd1da05bce06149e419bb0e6b6b36
+  data.tar.gz: f654d30606764307daad38b45921533edba92fa2cd95a75556488985bd78a590
 SHA512:
-  metadata.gz: 5fe016ab01f8b8076b1cc6680f8a09ad9bf1ab9d7f5c798a308465fd0d6d80dd6da24ef5855aa35660d9b8cce0529ab59cb6a45b7b971c58d4f8a9e761b80ff9
-  data.tar.gz: 0430b991c22524be88e3741f700d5c02ac65186f4cf40e7f06440b737c345bba8e44748a9e8d6ef1293356e21ee7560595b5e1563c28da7bb5f88008f7174360
+  metadata.gz: 3a573a48cfe5b5d1beebd665c09b8adc4fe7d7a4bb08b29cc923c2434d921c0e9eb2c46b317d4d44367e46d0afafd2a686a0186cfb68f50459eaad2707f3da72
+  data.tar.gz: 2db445bfbf4ef1cd56d715e586a6c0b748695e022ac55d94bc8bd52171221902fa562426c8a53cadb2e7d0ee7667dd866f27106fb3901247932e1b1a2e3320b6

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 ## master
 
+## 1.3.0 (2020-11-25)
+
+- [PR#39](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/39) Implement `path_cache_key` option ([@DmitryTsepelev][])
+
+## 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][])
@@ -56,3 +77,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
@@ -107,7 +115,7 @@ query_cache_key = Digest::SHA1.hexdigest("#{path_cache_key}#{selections_cache_ke
 cache_key = "#{schema_cache_key}/#{query_cache_key}"
 ```
 
-You can override `schema_cache_key` or `query_cache_key` by passing parameters to the `cache_fragment` calls:
+You can override `schema_cache_key`, `query_cache_key` or `path_cache_key` by passing parameters to the `cache_fragment` calls:
 
 ```ruby
 class QueryType < BaseObject
@@ -121,6 +129,8 @@ class QueryType < BaseObject
 end
 ```
 
+Overriding `path_cache_key` might be helpful when you resolve the same object nested in multiple places (e.g., `Post` and `Comment` both have `author`), but want to make sure cache will be invalidated when selection set is different.
+
 Same for the option:
 
 ```ruby
@@ -252,7 +262,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 +285,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
@@ -141,20 +141,22 @@ module GraphQL
       end
 
       def path_cache_key
-        lookahead = query.lookahead
+        @options.fetch(:path_cache_key) do
+          lookahead = query.lookahead
 
-        path.map { |field_name|
-          # Handle cached fields inside collections:
-          next field_name if field_name.is_a?(Integer)
+          path.map { |field_name|
+            # Handle cached fields inside collections:
+            next field_name if field_name.is_a?(Integer)
 
-          lookahead = lookahead.selection_with_alias(field_name)
-          raise "Failed to look ahead the field: #{field_name}" if lookahead.is_a?(::GraphQL::Execution::Lookahead::NullLookahead)
+            lookahead = lookahead.selection_with_alias(field_name)
+            raise "Failed to look ahead the field: #{field_name}" if lookahead.is_a?(::GraphQL::Execution::Lookahead::NullLookahead)
 
-          next lookahead.field.name if lookahead.arguments.empty?
+            next lookahead.field.name if lookahead.arguments.empty?
 
-          args = lookahead.arguments.map { |_1, _2| "#{_1}:#{traverse_argument(_2)}" }.sort.join(",")
-          "#{lookahead.field.name}(#{args})"
-        }.join("/")
+            args = lookahead.arguments.map { |_1, _2| "#{_1}:#{traverse_argument(_2)}" }.sort.join(",")
+            "#{lookahead.field.name}(#{args})"
+          }.join("/")
+        end
       end
 
       def traverse_argument(argument)

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
@@ -141,20 +141,22 @@ module GraphQL
       end
 
       def path_cache_key
-        lookahead = query.lookahead
+        @options.fetch(:path_cache_key) do
+          lookahead = query.lookahead
 
-        path.map { |field_name|
-          # Handle cached fields inside collections:
-          next field_name if field_name.is_a?(Integer)
+          path.map { |field_name|
+            # Handle cached fields inside collections:
+            next field_name if field_name.is_a?(Integer)
 
-          lookahead = lookahead.selection_with_alias(field_name)
-          raise "Failed to look ahead the field: #{field_name}" if lookahead.is_a?(::GraphQL::Execution::Lookahead::NullLookahead)
+            lookahead = lookahead.selection_with_alias(field_name)
+            raise "Failed to look ahead the field: #{field_name}" if lookahead.is_a?(::GraphQL::Execution::Lookahead::NullLookahead)
 
-          next lookahead.field.name if lookahead.arguments.empty?
+            next lookahead.field.name if lookahead.arguments.empty?
 
-          args = lookahead.arguments.map { "#{_1}:#{traverse_argument(_2)}" }.sort.join(",")
-          "#{lookahead.field.name}(#{args})"
-        }.join("/")
+            args = lookahead.arguments.map { "#{_1}:#{traverse_argument(_2)}" }.sort.join(",")
+            "#{lookahead.field.name}(#{args})"
+          }.join("/")
+        end
       end
 
       def traverse_argument(argument)

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

@@ -5,14 +5,14 @@ module GraphQL
     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, parent, items, arguments, context, *options)
-            raw_value?(items) ? items : super
-          end
-        else
+        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

data/lib/graphql/fragment_cache/fragment.rb

@@ -22,17 +22,16 @@ module GraphQL
         end
       end
 
-      def persist
-        value = final_value.dig(*path)
-        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 value
+        final_value.dig(*path)
+      end
+
+      private
+
       def interpreter_context
         context.namespace(:interpreter)
       end

data/lib/graphql/fragment_cache/object_helpers.rb

@@ -10,35 +10,33 @@ module GraphQL
     module ObjectHelpers
       extend Forwardable
 
-      NO_OBJECT = Object.new
+      def self.included(base)
+        return if base < GraphQL::Execution::Interpreter::HandlesRawValue
 
-      def_delegator :field, :connection?
+        base.include(GraphQL::Execution::Interpreter::HandlesRawValue)
+      end
+
+      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 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 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/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module FragmentCache
-    VERSION = "1.0.3"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-fragment_cache
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.3.0
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-31 00:00:00.000000000 Z
+date: 2020-11-25 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,6 +162,7 @@ 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