graphql-persisted_queries 1.8.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f87195c0081c6206d4c47361e560fb3f112cbdbca6dd1135cf2e4c7716cb75c9
-  data.tar.gz: fe8df08ab03552a446258ff1dc68e27cb9eb810fa2e20dfa853c208a4e6676f9
+  metadata.gz: eef23367af0ca5ac44fc10cbdd454f693c98e7e8783f0571f43a261a0e06c93f
+  data.tar.gz: 5338fcbb68762525ca474d4720c4f785e5f6d521d5b28bc524a187ed40553313
 SHA512:
-  metadata.gz: 9a1d306f63ee7491d018c1716c76674effec8b55a3190244ad5843789a018297ad250e7264ee133cec26b32ada813fe28c9861133fc67e4e973bcd3312b8a810
-  data.tar.gz: 1cf61a5492364b85bee8a9f7d59293ba3ce5d36ae2c406f47ab6ce8aba4dc25f5a86dcd848cb1e863c4e27a693056fac49668ba2b7aa093ba26c21118ade6f89
+  metadata.gz: d8a78da34ce4706d08de137178f3f81426b590ee13568f4b7c3a8f8c6d788caf7c77a32b7ea5d12bb0ca0c139077d7a42a1192f5a4f4c07867e3634341314e7f
+  data.tar.gz: b02bafae180e3996349bc259d464b40d30e2ef02f078d39fb3bf4cd445cdee5152fa7c80910ba326128f4bc9d40a242895fd611c6b186eba516920bb31cf5344

data/.github/workflows/rspec.yml

@@ -18,20 +18,22 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.7, '3.0', 3.1, 3.2, 3.3]
+        ruby: [3.1, 3.2, 3.3, 3.4]
         gemfile: [
-          "gemfiles/graphql_1_12_0.gemfile",
-          "gemfiles/graphql_1_12_4.gemfile",
-          "gemfiles/graphql_1_13_7.gemfile",
-          "gemfiles/graphql_1_13_16.gemfile",
           "gemfiles/graphql_2_1_0.gemfile",
           "gemfiles/graphql_2_2_5.gemfile",
-          "gemfiles/graphql_master.gemfile"
+          "gemfiles/graphql_2_3_11.gemfile",
+          "gemfiles/graphql_master.gemfile",
         ]
+        exclude:
+          - ruby: "3.1"
+            gemfile: gemfiles/graphql_2_3_11.gemfile
+          - ruby: "3.1"
+            gemfile: gemfiles/graphql_master.gemfile
 
     steps:
     - uses: actions/checkout@v2
-    - uses: actions/cache@v2
+    - uses: actions/cache@v4
       with:
         path: /home/runner/bundle
         key: bundle-${{ matrix.ruby }}-${{ matrix.gemfile }}-${{ hashFiles(matrix.gemfile) }}-${{ hashFiles('**/*.gemspec') }}

data/.github/workflows/rubocop.yml

@@ -17,5 +17,5 @@ jobs:
         ruby-version: 2.7
     - name: Lint Ruby code with RuboCop
       run: |
-        bundle install --gemfile gemfiles/graphql_1_12_0.gemfile --jobs 4 --retry 3
-        bundle exec --gemfile gemfiles/graphql_1_12_0.gemfile rubocop
+        bundle install --gemfile gemfiles/graphql_2_0_0.gemfile --jobs 4 --retry 3
+        bundle exec --gemfile gemfiles/graphql_2_0_0.gemfile rubocop

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,6 +1,16 @@
 # Change log
 
-## master
+## 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)
+Deprecate old ruby and gql versions ([@DmitryTsepelev][])
+- [PR#78](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/pull/78)
+Migrate CompiledQueries instrumentation to tracer ([@DmitryTsepelev][])
 
 ## 1.8.1 (2024-06-01)
 
@@ -129,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

@@ -12,6 +12,8 @@ Used in production by:
 - Toptal
 - _Want to be here? Let me know_ 🙂
 
+You can support my open–source work [here](https://boosty.to/dmitry_tsepelev).
+
 ## Getting started
 
 First of all, install and configure [apollo's persisted queries](https://www.apollographql.com/docs/react/api/link/persisted-queries/) on the front–end side:
@@ -90,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/gemfiles/{graphql_1_12_0.gemfile → graphql_2_3_11.gemfile}

@@ -1,5 +1,5 @@
 source "https://rubygems.org"
 
-gem "graphql", "~> 1.12.0"
+gem "graphql", "~> 2.3.11"
 
 gemspec path: "../"

data/graphql-persisted_queries.gemspec

@@ -22,12 +22,14 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.7"
 
-  spec.add_dependency "graphql", ">= 1.12"
+  spec.add_dependency "graphql", ">= 2.0"
+  spec.add_dependency "base64"
 
   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,6 +8,8 @@ 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" # rubocop:disable Style/ClassEqualityComparison
+
             return unless query.context[:extensions]
 
             query.try_load_document!
@@ -19,6 +21,22 @@ module GraphQL
 
           def after_query(*); end
         end
+
+        # Instrumentations were deprecated in 2.2.5, this is a module to migrate to new interface
+        module Tracer
+          def execute_query(query:)
+            GraphQL::PersistedQueries::CompiledQueries::Instrumentation.before_query(query)
+            super
+          end
+
+          def execute_multiplex(multiplex:)
+            multiplex.queries.each do |query|
+              GraphQL::PersistedQueries::CompiledQueries::Instrumentation.before_query(query)
+            end
+
+            super
+          end
+        end
       end
     end
   end

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/schema_patch.rb

@@ -26,8 +26,7 @@ module GraphQL
 
         def configure_compiled_queries(schema)
           if graphql_ruby_after_2_2_5?
-            schema.trace_with(GraphQL::Tracing::LegacyHooksTrace)
-            schema.instance_exec { own_instrumenters[:query] << CompiledQueries::Instrumentation }
+            schema.trace_with(GraphQL::PersistedQueries::CompiledQueries::Instrumentation::Tracer)
           else
             schema.instrument :query, CompiledQueries::Instrumentation
           end
@@ -78,7 +77,10 @@ module GraphQL
       end
 
       def verify_http_method=(verify)
-        query_analyzer(prepare_analyzer) if verify
+        return unless verify
+
+        require "graphql/persisted_queries/analyzers/http_method_ast_analyzer"
+        query_analyzer(Analyzers::HttpMethodAstAnalyzer)
       end
 
       def persisted_queries_tracing_enabled?
@@ -94,18 +96,6 @@ module GraphQL
           persisted_query_store.tracers = tracers if persisted_queries_tracing_enabled?
         end
       end
-
-      private
-
-      def prepare_analyzer
-        if using_ast_analysis?
-          require "graphql/persisted_queries/analyzers/http_method_ast_analyzer"
-          Analyzers::HttpMethodAstAnalyzer
-        else
-          require "graphql/persisted_queries/analyzers/http_method_analyzer"
-          Analyzers::HttpMethodAnalyzer.new
-        end
-      end
     end
   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.1"
+    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.1
+  version: 2.0.0
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-01 00:00:00.000000000 Z
+date: 2025-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -56,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
@@ -108,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
@@ -119,6 +147,7 @@ files:
 - ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -137,13 +166,10 @@ files:
 - docs/http_cache.md
 - docs/skip_query_preprocessing.md
 - docs/tracing.md
-- gemfiles/graphql_1_12_0.gemfile
-- gemfiles/graphql_1_12_4.gemfile
-- gemfiles/graphql_1_13_16.gemfile
-- gemfiles/graphql_1_13_7.gemfile
 - gemfiles/graphql_2_0_0.gemfile
 - gemfiles/graphql_2_1_0.gemfile
 - gemfiles/graphql_2_2_5.gemfile
+- gemfiles/graphql_2_3_11.gemfile
 - gemfiles/graphql_master.gemfile
 - graphql-persisted_queries.gemspec
 - lib/graphql/persisted_queries.rb
@@ -192,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Persisted queries for graphql-ruby

data/gemfiles/graphql_1_12_4.gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gem "graphql", "~> 1.12.4"
-
-gemspec path: "../"

data/gemfiles/graphql_1_13_16.gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gem "graphql", "~> 1.13.16"
-
-gemspec path: "../"

data/gemfiles/graphql_1_13_7.gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gem "graphql", "~> 1.13.7"
-
-gemspec path: "../"