graphql-persisted_queries 1.8.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74e2464a2988d654dffdc3f52efc8fbd3ecb86cc11980fb3000a5dcf30577287
-  data.tar.gz: d65ffe6edc09ef61039e7f671aa2105f015ab3c49aa1df906a980f641b061aac
+  metadata.gz: eef23367af0ca5ac44fc10cbdd454f693c98e7e8783f0571f43a261a0e06c93f
+  data.tar.gz: 5338fcbb68762525ca474d4720c4f785e5f6d521d5b28bc524a187ed40553313
 SHA512:
-  metadata.gz: 9b919241a30472097a837e9a4f4ccaf60d0b6aee05e54244da678939d74845cd790c9b089535031cc178a62ecf84fffbf6a99c07dadac9f115b441d318f6281a
-  data.tar.gz: 6d3e37e77fc7ba9c0859af116d6e18a7bfdd4a11a6bf5326b301d320857d485a96a4acd3261fc460f0aaf935ff8069d55e071c93d5cd05afa71c3f921036a146
+  metadata.gz: d8a78da34ce4706d08de137178f3f81426b590ee13568f4b7c3a8f8c6d788caf7c77a32b7ea5d12bb0ca0c139077d7a42a1192f5a4f4c07867e3634341314e7f
+  data.tar.gz: b02bafae180e3996349bc259d464b40d30e2ef02f078d39fb3bf4cd445cdee5152fa7c80910ba326128f4bc9d40a242895fd611c6b186eba516920bb31cf5344

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
   TargetRubyVersion: 2.6
   Include:
@@ -15,7 +17,7 @@ AllCops:
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 100
 
 Metrics/BlockLength:
@@ -24,3 +26,10 @@ Metrics/BlockLength:
 
 Style/NumericLiterals:
   Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - spec/**/*

data/.rubocop_todo.yml

@@ -0,0 +1,17 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-06-23 08:24:05 UTC using RuboCop version 1.77.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 5
+# Configuration parameters: AllowedParentClasses.
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/graphql/persisted_queries/store_adapters/memcached_store_adapter.rb'
+    - 'lib/graphql/persisted_queries/store_adapters/memory_store_adapter.rb'
+    - 'lib/graphql/persisted_queries/store_adapters/redis_store_adapter.rb'
+    - 'lib/graphql/persisted_queries/store_adapters/redis_with_local_cache_store_adapter.rb'
+    - 'spec/graphql/persisted_queries/store_adapters/base_store_adapter_spec.rb'

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## 2.0.0 (2025-06-28)
+
+- [PR#87](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/pull/87)
+[[BREAKING](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/pull/87#issuecomment-3008620281)] Add option to skip query marshalling for in-memory storage ([@viralpraxis][])
+
 ## 1.8.2 (2025-06-12)
 
 - [PR#79](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/pull/79)
@@ -134,3 +139,4 @@ Handle situations when prepare_ast happens before instrumentation ([@DmitryTsepe
 [@rbviz]: https://github.com/rbviz
 [@louim]: https://github.com/louim
 [@mpospelov]: https://github.com/mpospelov
+[@viralpraxis]: https://github.com/viralpraxis

data/README.md

@@ -92,6 +92,8 @@ It is possible to skip some parts of the query lifecycle for cases when query is
 
 An experimental tracing feature can be enabled by setting `tracing: true` when configuring the plugin. Read more about this feature in the [Tracing guide](docs/tracing.md).
 
+You can skip marshalling for queries stored in memory by passing the `marshal_inmemory_queries: false` option. This only affects the `memory` and `redis_with_local_cache` stores.
+
 > 📖 Read more about the gem internals: [Persisted queries in GraphQL:
 Slim down Apollo requests to your Ruby application](https://evilmartians.com/chronicles/persisted-queries-in-graphql-slim-down-apollo-requests-to-your-ruby-application)
 

data/benchmark/compiled_queries.rb

@@ -17,6 +17,12 @@ class GraphqlSchema < GraphQL::Schema
   query QueryType
 end
 
+class GraphqlSchemaWithoutMarshalling < GraphQL::Schema
+  use GraphQL::PersistedQueries, compiled_queries: true, marshal_inmemory_queries: false
+
+  query QueryType
+end
+
 GraphqlSchema.to_definition
 
 puts
@@ -32,10 +38,15 @@ Benchmark.bm(28) do |x|
       context = { extensions: { "persistedQuery" => { "sha256Hash" => sha256 } } }
       # warmup
       GraphqlSchema.execute(query, context: context)
+      GraphqlSchemaWithoutMarshalling.execute(query, context: context)
 
-      x.report("#{field_count} fields#{" (nested)" if with_nested}") do
+      x.report("#{field_count} fields#{' (nested)' if with_nested} (marshalled)") do
         GraphqlSchema.execute(query, context: context)
       end
+
+      x.report("#{field_count} fields#{' (nested)' if with_nested}") do
+        GraphqlSchemaWithoutMarshalling.execute(query, context: context)
+      end
     end
   end
 end

data/graphql-persisted_queries.gemspec

@@ -27,8 +27,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rspec", "~> 3.9"
   spec.add_development_dependency "rake", ">= 10.0"
-  spec.add_development_dependency "rubocop", "0.75"
+  spec.add_development_dependency "rubocop", "~> 1.77.0"
   spec.add_development_dependency "redis"
   spec.add_development_dependency "dalli"
   spec.add_development_dependency "connection_pool"
+  spec.add_development_dependency "benchmark"
 end

data/lib/graphql/persisted_queries/compiled_queries/instrumentation.rb

@@ -8,7 +8,7 @@ module GraphQL
         class << self
           # Actions to perform before the query resolution
           def before_query(query)
-            query = query.query if query.class.name == "GraphQL::Query::Partial"
+            query = query.query if query.class.name == "GraphQL::Query::Partial" # rubocop:disable Style/ClassEqualityComparison
 
             return unless query.context[:extensions]
 

data/lib/graphql/persisted_queries/compiled_queries/query_patch.rb

@@ -13,6 +13,7 @@ module GraphQL
           @persisted_query_not_found
         end
 
+        # rubocop:disable Metrics/CyclomaticComplexity
         def prepare_ast
           return super if @context[:extensions].nil? || @document
 
@@ -27,6 +28,7 @@ module GraphQL
               resolver.persist(query_string, @document)
             end
           end
+          # rubocop:enable Metrics/CyclomaticComplexity
         end
 
         def try_load_document!

data/lib/graphql/persisted_queries/compiled_queries/resolver.rb

@@ -38,8 +38,7 @@ module GraphQL
           return if hash.nil?
 
           with_error_handling do
-            compiled_query = @schema.persisted_query_store.fetch_query(hash, compiled_query: true)
-            Marshal.load(compiled_query) if compiled_query # rubocop:disable Security/MarshalLoad
+            @schema.persisted_query_store.fetch_query(hash, compiled_query: true)
           end
         end
 
@@ -50,7 +49,7 @@ module GraphQL
 
           with_error_handling do
             @schema.persisted_query_store.save_query(
-              hash, Marshal.dump(compiled_query), compiled_query: true
+              hash, compiled_query, compiled_query: true
             )
           end
         end

data/lib/graphql/persisted_queries/store_adapters/base_store_adapter.rb

@@ -24,7 +24,9 @@ module GraphQL
 
         def save_query(hash, query, compiled_query: false)
           key = build_key(hash, compiled_query)
-          trace("save_query", adapter: @name) { save(key, query) }
+          trace("save_query", adapter: @name) do
+            query.tap { save(key, query) }
+          end
         end
 
         def fetch(_hash)
@@ -44,6 +46,14 @@ module GraphQL
           end
         end
 
+        def serialize(query)
+          Marshal.dump(query)
+        end
+
+        def deserialize(serialized_query)
+          Marshal.load(serialized_query) if serialized_query # rubocop:disable Security/MarshalLoad
+        end
+
         private
 
         def build_key(hash, compiled_query)

data/lib/graphql/persisted_queries/store_adapters/memcached_store_adapter.rb

@@ -18,11 +18,11 @@ module GraphQL
         end
 
         def fetch(hash)
-          @dalli_proc.call { |dalli| dalli.get(key_for(hash)) }
+          @dalli_proc.call { |dalli| deserialize(dalli.get(key_for(hash))) }
         end
 
         def save(hash, query)
-          @dalli_proc.call { |dalli| dalli.set(key_for(hash), query, @expiration) }
+          @dalli_proc.call { |dalli| dalli.set(key_for(hash), serialize(query), @expiration) }
         end
 
         private

data/lib/graphql/persisted_queries/store_adapters/memory_store_adapter.rb

@@ -5,17 +5,36 @@ module GraphQL
     module StoreAdapters
       # Memory adapter for storing persisted queries
       class MemoryStoreAdapter < BaseStoreAdapter
-        def initialize(**_options)
+        def initialize(**options)
           @storage = {}
           @name = :memory
+          @marshal_inmemory_queries = options.fetch(:marshal_inmemory_queries, true)
         end
 
         def fetch(hash)
-          @storage[hash]
+          deserialize(@storage[hash])
         end
 
         def save(hash, query)
-          @storage[hash] = query
+          @storage[hash] = serialize(query)
+        end
+
+        def serialize(query)
+          if @marshal_inmemory_queries
+            super(query)
+          else
+            query
+          end
+        end
+
+        def deserialize(serialized_query)
+          return unless serialized_query
+
+          if @marshal_inmemory_queries
+            super(serialized_query)
+          else
+            serialized_query
+          end
         end
       end
     end

data/lib/graphql/persisted_queries/store_adapters/redis_store_adapter.rb

@@ -18,11 +18,13 @@ module GraphQL
         end
 
         def fetch(hash)
-          @redis_proc.call { |redis| redis.get(key_for(hash)) }
+          @redis_proc.call do |redis|
+            deserialize(redis.get(key_for(hash)))
+          end
         end
 
         def save(hash, query)
-          @redis_proc.call { |redis| redis.set(key_for(hash), query, ex: @expiration) }
+          @redis_proc.call { |redis| redis.set(key_for(hash), serialize(query), ex: @expiration) }
         end
 
         private
@@ -32,8 +34,6 @@ module GraphQL
         end
 
         # rubocop: disable Metrics/MethodLength
-        # rubocop: disable Metrics/CyclomaticComplexity
-        # rubocop: disable Metrics/PerceivedComplexity
         def build_redis_proc(redis_client)
           if redis_client.is_a?(Hash)
             build_redis_proc(RedisClientBuilder.new(**redis_client).build)
@@ -48,8 +48,6 @@ module GraphQL
           end
         end
         # rubocop: enable Metrics/MethodLength
-        # rubocop: enable Metrics/CyclomaticComplexity
-        # rubocop: enable Metrics/PerceivedComplexity
       end
     end
   end

data/lib/graphql/persisted_queries/store_adapters/redis_with_local_cache_store_adapter.rb

@@ -8,8 +8,9 @@ module GraphQL
         DEFAULT_REDIS_ADAPTER_CLASS = RedisStoreAdapter
         DEFAULT_MEMORY_ADAPTER_CLASS = MemoryStoreAdapter
 
+        # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
         def initialize(redis_client: {}, expiration: nil, namespace: nil, redis_adapter_class: nil,
-                       memory_adapter_class: nil)
+                       memory_adapter_class: nil, marshal_inmemory_queries: true)
           redis_adapter_class ||= DEFAULT_REDIS_ADAPTER_CLASS
           memory_adapter_class ||= DEFAULT_MEMORY_ADAPTER_CLASS
 
@@ -18,9 +19,13 @@ module GraphQL
             expiration: expiration,
             namespace: namespace
           )
-          @memory_adapter = memory_adapter_class.new
+          @marshal_inmemory_queries = marshal_inmemory_queries
+          @memory_adapter = memory_adapter_class.new(
+            marshal_inmemory_queries: marshal_inmemory_queries
+          )
           @name = :redis_with_local_cache
         end
+        # rubocop:enable Metrics/ParameterLists, Metrics/MethodLength
 
         def fetch(hash)
           result = @memory_adapter.fetch(hash)

data/lib/graphql/persisted_queries/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module PersistedQueries
-    VERSION = "1.8.2"
+    VERSION = "2.0.0"
   end
 end

data/lib/graphql/persisted_queries.rb

@@ -15,7 +15,7 @@ require "graphql/persisted_queries/compiled_queries/query_patch"
 module GraphQL
   # Plugin definition
   module PersistedQueries
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def self.use(schema_defn, **options)
       schema = schema_defn.is_a?(Class) ? schema_defn : schema_defn.target
 
@@ -35,7 +35,7 @@ module GraphQL
       store = options.delete(:store) || :memory
       schema.configure_persisted_query_store(store, **options)
     end
-    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     def self.configure_compiled_queries
       if Gem::Dependency.new("graphql", "< 1.12.0").match?("graphql", GraphQL::VERSION)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-persisted_queries
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 2.0.0
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-12 00:00:00.000000000 Z
+date: 2025-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -70,16 +70,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.75'
+        version: 1.77.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.75'
+        version: 1.77.0
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  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'
 description: Persisted queries for graphql-ruby
 email:
 - dmitry.a.tsepelev@gmail.com
@@ -133,6 +147,7 @@ files:
 - ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt