graphql-persisted_queries 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6f0c75f1f94ba226e78445f322fc335e500a8b043c5ad0639339504b34d3c33
-  data.tar.gz: c5066d90aafb265e937c1e8de6c781874dcd8a3edff964ef4375537f5e33dbd3
+  metadata.gz: 7a8319ef6ac9b60ce31f69b86163c9c77f700b2d663da6ab10018b76c96ebc2f
+  data.tar.gz: b197af199c9699cda0a7c3c5491d2f22b110b77f61a7632a1982ca3acbc49292
 SHA512:
-  metadata.gz: f7d34c82f9ba6fbca43bf4b2d209c4c762f1dd96e26bab8d8942241c1c3447c4b3412a7235b61742638294ae4083e67ac7b872258cfa09cd416abdde80111ebd
-  data.tar.gz: 205dade68e5c6a087cd38e3632fe21010f01c0bec57857737d0328685a74a66e42ddb9907ebdbf806fe8b1aa3d3c992600a3da8309516b9817fdd2b6a9d38703
+  metadata.gz: 2f6f9f3d32aad7d89b263f60701c30f06cba0bb43934fa18360e70ef979c1bdf1f28050859b92788040a600e8d803d850f753383d700243dbdea0b59973bcaf5
+  data.tar.gz: 5505e5d9b983b8dc2a510dd17fe417eee561bc337da0deb203030b6f0889732ea46b5d76dc9694d5129ddc7538f43467040dcbe907651863b6a26d3c9888a2b3

data/.github/workflows/rspec.yml

@@ -20,11 +20,10 @@ jobs:
       matrix:
         ruby: [2.6, 2.7, 3.0]
         gemfile: [
-          "gemfiles/graphql_1_10.gemfile",
-          "gemfiles/graphql_1_11.gemfile",
           "gemfiles/graphql_1_12_0.gemfile",
           "gemfiles/graphql_1_12_4.gemfile",
           "gemfiles/graphql_1_13_7.gemfile",
+          "gemfiles/graphql_2_0_0.gemfile",
           "gemfiles/graphql_master.gemfile"
         ]
 

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_10.gemfile --jobs 4 --retry 3
-        bundle exec --gemfile gemfiles/graphql_1_10.gemfile rubocop
+        bundle install --gemfile gemfiles/graphql_1_12_0.gemfile --jobs 4 --retry 3
+        bundle exec --gemfile gemfiles/graphql_1_12_0.gemfile rubocop

data/.gitignore

@@ -7,3 +7,5 @@
 /spec/reports/
 /tmp/
 Gemfile.lock
+
+.ruby-version

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## master
 
+## 1.6.0 (2022-10-10)
+
+- [PR#57](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/pull/57) Refactor code to use instrumentation instead of a monkey patch, deprecate graphql-ruby 1.10 and 1.11 ([@DmitryTsepelev][])
+
+## 1.5.1 (2022-09-28)
+
+- [PR#56](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/pull/56) Support graphql-ruby 2.0.14 ([@DmitryTsepelev][])
+
 ## 1.5.0 (2022-02-10)
 
 - [PR#53](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/pull/53) Support graphql-ruby 2.0.0 ([@DmitryTsepelev][])

data/gemfiles/{graphql_1_10.gemfile → graphql_2_0_0.gemfile}

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

data/graphql-persisted_queries.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.6"
 
-  spec.add_dependency "graphql", ">= 1.10"
+  spec.add_dependency "graphql", ">= 1.12"
 
   spec.add_development_dependency "rspec", "~> 3.9"
   spec.add_development_dependency "rake", ">= 10.0"

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module GraphQL
+  module PersistedQueries
+    module CompiledQueries
+      # Instrumentation to support compiled queries
+      module Instrumentation
+        class << self
+          # Actions to perform before the query resolution
+          def before_query(query)
+            return unless query.context[:extensions]
+
+            resolver = resolver_for(query)
+            if (document = resolver.fetch)
+              query.fulfill_document(document)
+            else
+              query.not_loaded_document!
+            end
+
+            return if document || query.query_string
+
+            query.persisted_query_not_found!
+            query.context.errors << GraphQL::ExecutionError.new(NotFound::MESSAGE)
+          end
+
+          def after_query(*); end
+
+          private
+
+          def resolver_for(query)
+            CompiledQueries::Resolver.new(query.schema, query.context[:extensions])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -21,7 +21,7 @@ module GraphQL
 
         def add_not_found_error(query)
           query.context.errors.clear
-          query.context.errors << GraphQL::ExecutionError.new("PersistedQueryNotFound")
+          query.context.errors << GraphQL::ExecutionError.new(NotFound::MESSAGE)
           GraphQL::Execution::Multiplex::NO_OPERATION
         end
       end

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

@@ -5,6 +5,18 @@ module GraphQL
     module CompiledQueries
       # Patches GraphQL::Query to support compiled queries
       module QueryPatch
+        def fulfill_document(document)
+          @document = document
+        end
+
+        def not_loaded_document!
+          @not_loaded_document = true
+        end
+
+        def persisted_query_not_found!
+          @persisted_query_not_found = true
+        end
+
         def persisted_query_not_found?
           @persisted_query_not_found
         end
@@ -12,13 +24,12 @@ module GraphQL
         def prepare_ast
           return super unless @context[:extensions]
 
-          @document = resolver.fetch
-          not_loaded_document = @document.nil?
-
-          @persisted_query_not_found = not_loaded_document && query_string.nil?
-
           super.tap do
-            resolver.persist(query_string, @document) if not_loaded_document && query_string
+            if @context.errors.any?(&method(:not_found_error?))
+              @context.errors.select!(&method(:not_found_error?))
+            end
+
+            resolver.persist(query_string, @document) if @not_loaded_document && query_string
           end
         end
 
@@ -27,6 +38,10 @@ module GraphQL
         def resolver
           @resolver ||= Resolver.new(@schema, @context[:extensions])
         end
+
+        def not_found_error?(error)
+          error.message == GraphQL::PersistedQueries::NotFound::MESSAGE
+        end
       end
     end
   end

data/lib/graphql/persisted_queries/errors.rb

@@ -4,8 +4,10 @@ module GraphQL
   module PersistedQueries
     # Raised when persisted query is not found in the storage
     class NotFound < StandardError
+      MESSAGE = "PersistedQueryNotFound"
+
       def message
-        "PersistedQueryNotFound"
+        MESSAGE
       end
     end
 

data/lib/graphql/persisted_queries/schema_patch.rb

@@ -3,6 +3,7 @@
 require "graphql/persisted_queries/hash_generator_builder"
 require "graphql/persisted_queries/resolver"
 require "graphql/persisted_queries/multiplex_resolver"
+require "graphql/persisted_queries/compiled_queries/instrumentation"
 require "graphql/persisted_queries/analyzers/http_method_validator"
 
 module GraphQL
@@ -13,10 +14,12 @@ module GraphQL
         def patch(schema, compiled_queries)
           schema.singleton_class.prepend(SchemaPatch)
 
-          return if compiled_queries
-
-          schema.singleton_class.class_eval { alias_method :multiplex_original, :multiplex }
-          schema.singleton_class.prepend(MultiplexPatch)
+          if compiled_queries
+            schema.instrument :query, CompiledQueries::Instrumentation
+          else
+            schema.singleton_class.class_eval { alias_method :multiplex_original, :multiplex }
+            schema.singleton_class.prepend(MultiplexPatch)
+          end
         end
       end
 

data/lib/graphql/persisted_queries/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module PersistedQueries
-    VERSION = "1.5.0"
+    VERSION = "1.6.0"
   end
 end

data/lib/graphql/persisted_queries.rb

@@ -42,9 +42,11 @@ module GraphQL
         raise ArgumentError, "compiled_queries are not supported for graphql-ruby < 1.12.0"
       end
 
-      GraphQL::Execution::Multiplex.singleton_class.prepend(
-        GraphQL::PersistedQueries::CompiledQueries::MultiplexPatch
-      )
+      if Gem::Dependency.new("graphql", "< 2.0.14").match?("graphql", GraphQL::VERSION)
+        GraphQL::Execution::Multiplex.singleton_class.prepend(
+          GraphQL::PersistedQueries::CompiledQueries::MultiplexPatch
+        )
+      end
 
       GraphQL::Query.prepend(GraphQL::PersistedQueries::CompiledQueries::QueryPatch)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-persisted_queries
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - DmitryTsepelev
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-10 00:00:00.000000000 Z
+date: 2022-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -136,11 +136,10 @@ files:
 - docs/hash.md
 - docs/http_cache.md
 - docs/tracing.md
-- gemfiles/graphql_1_10.gemfile
-- gemfiles/graphql_1_11.gemfile
 - gemfiles/graphql_1_12_0.gemfile
 - gemfiles/graphql_1_12_4.gemfile
 - gemfiles/graphql_1_13_7.gemfile
+- gemfiles/graphql_2_0_0.gemfile
 - gemfiles/graphql_master.gemfile
 - graphql-persisted_queries.gemspec
 - lib/graphql/persisted_queries.rb
@@ -148,6 +147,7 @@ files:
 - lib/graphql/persisted_queries/analyzers/http_method_ast_analyzer.rb
 - lib/graphql/persisted_queries/analyzers/http_method_validator.rb
 - lib/graphql/persisted_queries/builder_helpers.rb
+- lib/graphql/persisted_queries/compiled_queries/instrumentation.rb
 - lib/graphql/persisted_queries/compiled_queries/multiplex_patch.rb
 - lib/graphql/persisted_queries/compiled_queries/query_patch.rb
 - lib/graphql/persisted_queries/compiled_queries/resolver.rb
@@ -173,7 +173,7 @@ homepage: https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -188,8 +188,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Persisted queries for graphql-ruby
 test_files: []

data/gemfiles/graphql_1_11.gemfile

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