graphql-persisted_queries 1.7.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 430993c73790f83784c3e048a8fa0a4032f2fa5809b725265b5600b6ca8b5a01
-  data.tar.gz: 10aaa0422835323129d2e771f9bcfa68c4b8d24563ff7b8fb0f341b29dc92dd4
+  metadata.gz: f87195c0081c6206d4c47361e560fb3f112cbdbca6dd1135cf2e4c7716cb75c9
+  data.tar.gz: fe8df08ab03552a446258ff1dc68e27cb9eb810fa2e20dfa853c208a4e6676f9
 SHA512:
-  metadata.gz: c8cf0e07efa3c4a2ea92af6014333c3adc08f1471357b3cc31f1d93779e5af3920e7c71b308bff62f34366211fd5912baadd9780cc2978c9b4185582524f9181
-  data.tar.gz: f001860c11580ae570e25875f548a167ec878d87545befb39b7ee13a58385e2d2fda86a0919745030b915fed8bd84b3cc6200462c467b320e823cb43a9785047
+  metadata.gz: 9a1d306f63ee7491d018c1716c76674effec8b55a3190244ad5843789a018297ad250e7264ee133cec26b32ada813fe28c9861133fc67e4e973bcd3312b8a810
+  data.tar.gz: 1cf61a5492364b85bee8a9f7d59293ba3ce5d36ae2c406f47ab6ce8aba4dc25f5a86dcd848cb1e863c4e27a693056fac49668ba2b7aa093ba26c21118ade6f89

data/.github/workflows/rspec.yml

@@ -18,13 +18,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.7, '3.0', 3.1]
+        ruby: [2.7, '3.0', 3.1, 3.2, 3.3]
         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_0_0.gemfile",
+          "gemfiles/graphql_2_1_0.gemfile",
+          "gemfiles/graphql_2_2_5.gemfile",
           "gemfiles/graphql_master.gemfile"
         ]
 

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## master
 
+## 1.8.1 (2024-06-01)
+
+- [PR#77](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/pull/77)
+Fix serialization of Document (broken by [this change](https://github.com/rmosolgo/graphql-ruby/commit/7de7a1f98d4299abc1fb7deb5ca0ed2190867ab6)) ([@DmitryTsepelev][])
+
+## 1.8.0 (2024-03-31)
+
+- [PR#73](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/pull/73)
+Use trace_with instead of instrument for modern versions of graphql ([@DmitryTsepelev][])
+
 ## 1.7.0 (2023-02-02)
 
 - [PR#62](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/pull/62)

data/README.md

@@ -86,6 +86,8 @@ Since our queries are slim now, we can switch back to HTTP GET, you can find a [
 
 [persisted-queries-link](https://www.apollographql.com/docs/react/api/link/persisted-queries/) uses _SHA256_ for building hashes by default. Check out this [guide](docs/hash.md) if you want to override this behavior.
 
+It is possible to skip some parts of the query lifecycle for cases when query is persisted - read more [here](docs/skip_query_preprocessing.md).
+
 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).
 
 > 📖 Read more about the gem internals: [Persisted queries in GraphQL:

data/docs/skip_query_preprocessing.md

@@ -0,0 +1,17 @@
+# Skipping some preprocessing steps
+
+It does not make much sense to revalidate persisted query—we did it earlier, so it can be disabled in the `#execute` call:
+
+```ruby
+GraphqlSchema.execute(
+  params[:query],
+  variables: ensure_hash(params[:variables]),
+  context: {
+    extensions: ensure_hash(params[:extensions])
+  },
+  operation_name: params[:operationName],
+  validate: params[:query].present?
+)
+```
+
+Moreover, some analyzers can be disabled as well: in order to do that just pass the same check `params[:query].present?` to the context and then add early exit to your analyzers based on this flag.

data/gemfiles/graphql_2_1_0.gemfile

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

data/gemfiles/graphql_2_2_5.gemfile

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

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

@@ -7,6 +7,28 @@ module GraphQL
       class Resolver
         include GraphQL::PersistedQueries::ResolverHelpers
 
+        # Patch to support custom serialization
+        class GraphQL::Language::Parser # rubocop:disable Style/ClassAndModuleChildren
+          SEP = "|"
+
+          def _dump(*)
+            [
+              @graphql_str,
+              JSON.generate("filename": @filename, "max_tokens": @max_tokens, "document": @document)
+            ].join(SEP)
+          end
+
+          def self._load(args)
+            graphql_str, raw_kwargs = args.split(SEP)
+
+            new(graphql_str,
+                filename: raw_kwargs["filename"],
+                max_tokens: raw_kwargs["max_tokens"]).tap do |parser|
+              parser.instance_variable_set(:@document, raw_kwargs["document"])
+            end
+          end
+        end
+
         def initialize(schema, extensions)
           @schema = schema
           @extensions = extensions

data/lib/graphql/persisted_queries/schema_patch.rb

@@ -15,12 +15,31 @@ module GraphQL
           schema.singleton_class.prepend(SchemaPatch)
 
           if compiled_queries
-            schema.instrument :query, CompiledQueries::Instrumentation
+            configure_compiled_queries(schema)
           else
             schema.singleton_class.class_eval { alias_method :multiplex_original, :multiplex }
             schema.singleton_class.prepend(MultiplexPatch)
           end
         end
+
+        private
+
+        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 }
+          else
+            schema.instrument :query, CompiledQueries::Instrumentation
+          end
+        end
+
+        def graphql_ruby_after_2_2_5?
+          check_graphql_version "> 2.2.5"
+        end
+
+        def check_graphql_version(predicate)
+          Gem::Dependency.new("graphql", predicate).match?("graphql", GraphQL::VERSION)
+        end
       end
 
       # Patches GraphQL::Schema to override multiplex (not needed for compiled queries)

data/lib/graphql/persisted_queries/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module PersistedQueries
-    VERSION = "1.7.0"
+    VERSION = "1.8.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-persisted_queries
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.1
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-02 00:00:00.000000000 Z
+date: 2024-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -135,12 +135,15 @@ files:
 - docs/error_handling.md
 - docs/hash.md
 - 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_master.gemfile
 - graphql-persisted_queries.gemspec
 - lib/graphql/persisted_queries.rb
@@ -189,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Persisted queries for graphql-ruby