graphql-fragment_cache 0.1.5 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69226c4789fd364bcd6bf0991ebd358c39a32fee383a8ce7445418d0af46eb04
-  data.tar.gz: d7a1901dd86a3311f60a02153422044c055ffd46b0297026ab9f434eca1667dd
+  metadata.gz: 515ec358aecf867ce2d2ec5ac82003d802dc6c31d6402d62593a626ac5bad81e
+  data.tar.gz: 8b1b3d82c0fb808a2cd826c710047635ba141895843ff7b804a301848d266ff5
 SHA512:
-  metadata.gz: 5a22448276b2618d0f85c67aa371fa20828ac24f3f943779d748214214a85d0a55c129b31928e96b904e6e1c8734f4cf5ef32bcb2debf38b9208bfea7fefc29f
-  data.tar.gz: 17033312f4e5c89c3a135da2c2e12b2980fc5b5582ce22b3089ae1e3b7c0e95de44ca1e19f42cb0a236b6fcd7b6ff9630bb300ee1592d9ec4cf6a759f7e82839
+  metadata.gz: 2c2dd089bf31f6d2491fc7d904d8ca356a2dfbc2cace258fe1e3b49c18dc59a64805a1cb96655bfb23eacc62ed027198365491759005b232354a2ee8ed41e605
+  data.tar.gz: 92309ef8b7ee62a5fd85007a88be932874f996d12ee08a1e81530d90fa3138dc631f90ad6a6f41c3952338001e10cefbeb1691bcea7891ba9b2f4027543e659d

data/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 ## master
 
+## 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][])
+
+## 1.0.1 (2020-06-17)
+
+- [PR#25](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/25) Support fragments with aliases for CacheKeyBuilder ([@DmitryTsepelev][])
+
+## 1.0.0 (2020-06-13)
+
+- [PR#24](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/24) Add nil caching. **BREAKING CHANGE**: custom cache stores must also implement `#exist?(key)` method ([@DmitryTsepelev][])
+
+## 0.1.7 (2020-06-02)
+
+- [PR#23](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/23) Avoid extra queries after restoring connection from cache ([@DmitryTsepelev][])
+
+## 0.1.6 (2020-05-30)
+
+- [PR#22](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/22) Properly cache entites inside collections ([@DmitryTsepelev][])
+
 ## 0.1.5 (2020-04-28)
 
 - [PR#19](https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache/pull/19) Add connections support ([@DmitryTsepelev][])
@@ -31,3 +51,4 @@
 [@DmitryTsepelev]: https://github.com/DmitryTsepelev
 [@palkan]: https://github.com/palkan
 [@ssnickolay]: https://github.com/ssnickolay
+[@reabiliti]: https://github.com/reabiliti

data/README.md

@@ -252,7 +252,7 @@ Rails.application.configure do |config|
 end
 ```
 
-⚠️ Cache store must implement `#read(key)` and `#write(key, value, **options)` methods.
+⚠️ Cache store must implement `#read(key)`, `#write(key, value, **options)` and `#exist?(key)` methods.
 
 The gem provides only in-memory store out-of-the-box (`GraphQL::FragmentCache::MemoryStore`). It's used by default.
 

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

@@ -76,7 +76,13 @@ module GraphQL
 
         def lookup_alias_node(nodes, name)
           return if nodes.empty?
+
           nodes.find do |node|
+            if node.is_a?(GraphQL::Language::Nodes::FragmentSpread)
+              node = @query.fragments[node.name]
+              raise("Invariant: Can't look ahead to nonexistent fragment #{node.name} (found: #{@query.fragments.keys})") unless node
+            end
+
             return node if node.alias?(name)
             child = lookup_alias_node(node.children, name)
             return child if child
@@ -124,7 +130,12 @@ module GraphQL
 
       def selections_cache_key
         current_root =
-          path.reduce(query.lookahead) { |lkhd, name| lkhd.selection_with_alias(name) }
+          path.reduce(query.lookahead) { |lkhd, field_name|
+            # Handle cached fields inside collections:
+            next lkhd if field_name.is_a?(Integer)
+
+            lkhd.selection_with_alias(field_name)
+          }
 
         current_root.selections.to_selections_key
       end
@@ -133,6 +144,9 @@ module GraphQL
         lookahead = query.lookahead
 
         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)
 

data/lib/graphql-fragment_cache.rb

@@ -1,6 +1,6 @@
 require "ruby-next"
 
 require "ruby-next/language/setup"
-RubyNext::Language.setup_gem_load_path
+RubyNext::Language.setup_gem_load_path(transpile: true)
 
 require "graphql/fragment_cache"

data/lib/graphql/fragment_cache.rb

@@ -4,10 +4,11 @@ require "graphql"
 
 require "graphql/fragment_cache/ext/context_fragments"
 require "graphql/fragment_cache/ext/graphql_cache_key"
-
-require "graphql/fragment_cache/schema_patch"
 require "graphql/fragment_cache/object"
-require "graphql/fragment_cache/instrumentation"
+
+require "graphql/fragment_cache/schema/patch"
+require "graphql/fragment_cache/schema/tracer"
+require "graphql/fragment_cache/schema/instrumentation"
 
 require "graphql/fragment_cache/memory_store"
 
@@ -22,8 +23,9 @@ module GraphQL
       def use(schema_defn, options = {})
         verify_interpreter!(schema_defn)
 
-        schema_defn.instrument(:query, Instrumentation)
-        schema_defn.extend(SchemaPatch)
+        schema_defn.tracer(Schema::Tracer)
+        schema_defn.instrument(:query, Schema::Instrumentation)
+        schema_defn.extend(Schema::Patch)
       end
 
       def cache_store=(store)

data/lib/graphql/fragment_cache/cache_key_builder.rb

@@ -76,7 +76,13 @@ module GraphQL
 
         def lookup_alias_node(nodes, name)
           return if nodes.empty?
+
           nodes.find do |node|
+            if node.is_a?(GraphQL::Language::Nodes::FragmentSpread)
+              node = @query.fragments[node.name]
+              raise("Invariant: Can't look ahead to nonexistent fragment #{node.name} (found: #{@query.fragments.keys})") unless node
+            end
+
             return node if node.alias?(name)
             child = lookup_alias_node(node.children, name)
             return child if child
@@ -124,7 +130,12 @@ module GraphQL
 
       def selections_cache_key
         current_root =
-          path.reduce(query.lookahead) { |lkhd, name| lkhd.selection_with_alias(name) }
+          path.reduce(query.lookahead) { |lkhd, field_name|
+            # Handle cached fields inside collections:
+            next lkhd if field_name.is_a?(Integer)
+
+            lkhd.selection_with_alias(field_name)
+          }
 
         current_root.selections.to_selections_key
       end
@@ -133,6 +144,9 @@ module GraphQL
         lookahead = query.lookahead
 
         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)
 

data/lib/graphql/fragment_cache/cacher.rb

@@ -10,9 +10,7 @@ module GraphQL
         def call(query)
           return unless query.context.fragments?
 
-          final_value = query.context.namespace(:interpreter)[:runtime].final_value
-
-          query.context.fragments.each { _1.persist(final_value) }
+          query.context.fragments.each(&:persist)
         end
       end
     end

data/lib/graphql/fragment_cache/fragment.rb

@@ -6,22 +6,28 @@ module GraphQL
   module FragmentCache
     # Represents a single fragment to cache
     class Fragment
-      attr_reader :options, :path, :context, :raw_connection
+      attr_reader :options, :path, :context
 
-      attr_writer :raw_connection
+      attr_accessor :resolved_value
 
       def initialize(context, **options)
         @context = context
         @options = options
-        @path = context.namespace(:interpreter)[:current_path]
+        @path = interpreter_context[:current_path]
       end
 
+      NIL_IN_CACHE = Object.new
+
       def read
-        FragmentCache.cache_store.read(cache_key)
+        FragmentCache.cache_store.read(cache_key).tap do |cached|
+          return NIL_IN_CACHE if cached.nil? && FragmentCache.cache_store.exist?(cache_key)
+        end
       end
 
-      def persist(final_value)
-        value = raw_connection || resolve(final_value)
+      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
 
@@ -31,9 +37,17 @@ module GraphQL
         @cache_key ||= CacheKeyBuilder.call(path: path, query: context.query, **options)
       end
 
-      def resolve(final_value)
+      def interpreter_context
+        context.namespace(:interpreter)
+      end
+
+      def resolve_from_runtime
         final_value.dig(*path)
       end
+
+      def final_value
+        @final_value ||= interpreter_context[:runtime].final_value
+      end
     end
   end
 end

data/lib/graphql/fragment_cache/memory_store.rb

@@ -23,6 +23,14 @@ module GraphQL
         @storage = {}
       end
 
+      def keys
+        storage.keys
+      end
+
+      def exist?(key)
+        storage.key?(key)
+      end
+
       def read(key)
         key = key.to_s
         storage[key]&.then do |entry|

data/lib/graphql/fragment_cache/object_helpers.rb

@@ -6,8 +6,6 @@ module GraphQL
   module FragmentCache
     using Ext
 
-    RawConnection = Struct.new(:items, :nodes, :paged_nodes_offset, :has_previous_page, :has_next_page)
-
     # Adds #cache_fragment method
     module ObjectHelpers
       extend Forwardable
@@ -24,39 +22,20 @@ module GraphQL
         fragment = Fragment.new(context, options)
 
         if (cached = fragment.read)
+          return nil if cached == Fragment::NIL_IN_CACHE
           return restore_cached_value(cached)
         end
 
         (block_given? ? block.call : object_to_cache).tap do |resolved_value|
-          cache_value(resolved_value, fragment)
+          context.fragments << fragment
         end
       end
 
       private
 
       def restore_cached_value(cached)
-        connection? ? restore_cached_connection(cached) : raw_value(cached)
-      end
-
-      def cache_value(resolved_value, fragment)
-        if connection?
-          unless context.schema.new_connections?
-            raise StandardError,
-              "GraphQL::Pagination::Connections should be enabled for connection caching"
-          end
-
-          connection = wrap_connection(resolved_value)
-
-          fragment.raw_connection = RawConnection.new(
-            connection.items,
-            connection.nodes,
-            connection.instance_variable_get(:@paged_nodes_offset),
-            connection.has_previous_page,
-            connection.has_next_page
-          )
-        end
-
-        context.fragments << fragment
+        # If we return connection object from resolver, Interpreter stops processing it
+        connection? ? cached : raw_value(cached)
       end
 
       def field
@@ -66,19 +45,6 @@ module GraphQL
       def interpreter_context
         @interpreter_context ||= context.namespace(:interpreter)
       end
-
-      def restore_cached_connection(raw_connection)
-        wrap_connection(raw_connection.items).tap do |connection|
-          connection.instance_variable_set(:@nodes, raw_connection.nodes)
-          connection.instance_variable_set(:@paged_nodes_offset, raw_connection.paged_nodes_offset)
-          connection.instance_variable_set(:@has_previous_page, raw_connection.has_previous_page)
-          connection.instance_variable_set(:@has_next_page, raw_connection.has_next_page)
-        end
-      end
-
-      def wrap_connection(object)
-        context.schema.connections.wrap(field, object, interpreter_context[:current_arguments], context)
-      end
     end
   end
 end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "graphql/fragment_cache/cacher"
+
+module GraphQL
+  module FragmentCache
+    module Schema
+      # Adds hook for saving cached values after query is resolved
+      module Instrumentation
+        module_function
+
+        def before_query(query)
+        end
+
+        def after_query(query)
+          return unless query.valid?
+
+          Cacher.call(query)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "digest/sha1"
+
+module GraphQL
+  module FragmentCache
+    module Schema
+      # Patches GraphQL::Schema to support fragment cache
+      module Patch
+        def schema_cache_key
+          @schema_cache_key ||= Digest::SHA1.hexdigest(to_definition)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module GraphQL
+  # Plugin definition
+  module FragmentCache
+    module Schema
+      class Tracer
+        using Ext
+
+        class << self
+          def trace(key, data)
+            yield.tap do |resolved_value|
+              next unless connection_to_cache?(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)
+            end
+          end
+
+          private
+
+          def connection_to_cache?(key, data)
+            key == "execute_field" && data[:field].connection?
+          end
+
+          def verify_connections!(context)
+            return if context.schema.new_connections?
+
+            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
+  end
+end

data/lib/graphql/fragment_cache/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-fragment_cache
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 1.0.2
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.10.8
 - !ruby/object:Gem::Dependency
-  name: ruby-next-core
+  name: ruby-next
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: ruby-next-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.8.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.8.0.7
 description: Fragment cache for graphql-ruby
 email:
 - dmitry.a.tsepelev@gmail.com
@@ -149,7 +163,6 @@ files:
 - bin/console
 - bin/setup
 - lib/.rbnext/2.7/graphql/fragment_cache/cache_key_builder.rb
-- lib/.rbnext/2.7/graphql/fragment_cache/cacher.rb
 - lib/.rbnext/2.7/graphql/fragment_cache/ext/graphql_cache_key.rb
 - lib/graphql-fragment_cache.rb
 - lib/graphql/fragment_cache.rb
@@ -159,13 +172,14 @@ files:
 - lib/graphql/fragment_cache/ext/graphql_cache_key.rb
 - lib/graphql/fragment_cache/field_extension.rb
 - lib/graphql/fragment_cache/fragment.rb
-- lib/graphql/fragment_cache/instrumentation.rb
 - lib/graphql/fragment_cache/memory_store.rb
 - lib/graphql/fragment_cache/object.rb
 - lib/graphql/fragment_cache/object_helpers.rb
 - lib/graphql/fragment_cache/rails/cache_key_builder.rb
 - lib/graphql/fragment_cache/railtie.rb
-- lib/graphql/fragment_cache/schema_patch.rb
+- lib/graphql/fragment_cache/schema/instrumentation.rb
+- lib/graphql/fragment_cache/schema/patch.rb
+- lib/graphql/fragment_cache/schema/tracer.rb
 - lib/graphql/fragment_cache/version.rb
 homepage: https://github.com/DmitryTsepelev/graphql-ruby-fragment_cache
 licenses:

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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module GraphQL
-  module FragmentCache
-    using Ext
-
-    # Saves resolved fragment values to cache store
-    module Cacher
-      class << self
-        def call(query)
-          return unless query.context.fragments?
-
-          final_value = query.context.namespace(:interpreter)[:runtime].final_value
-
-          query.context.fragments.each { |_1| _1.persist(final_value) }
-        end
-      end
-    end
-  end
-end

data/lib/graphql/fragment_cache/instrumentation.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require "graphql/fragment_cache/cacher"
-
-module GraphQL
-  module FragmentCache
-    # Adds hook for saving cached values after query is resolved
-    module Instrumentation
-      module_function
-
-      def before_query(query)
-      end
-
-      def after_query(query)
-        return unless query.valid?
-
-        Cacher.call(query)
-      end
-    end
-  end
-end

data/lib/graphql/fragment_cache/schema_patch.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require "digest/sha1"
-
-module GraphQL
-  module FragmentCache
-    # Patches GraphQL::Schema to support fragment cache
-    module SchemaPatch
-      def schema_cache_key
-        @schema_cache_key ||= Digest::SHA1.hexdigest(to_definition)
-      end
-    end
-  end
-end