graphql-persisted_queries 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 430993c73790f83784c3e048a8fa0a4032f2fa5809b725265b5600b6ca8b5a01
-  data.tar.gz: 10aaa0422835323129d2e771f9bcfa68c4b8d24563ff7b8fb0f341b29dc92dd4
+  metadata.gz: 348a66b5ed4c013fe7c41a01a752acdca8ecf2eac99f5365ac7cc11b3a6bcd4d
+  data.tar.gz: 2c15c37b4f4f451d12ab946f86e7df67a393af8d897ec0ec718924520ea5ee7b
 SHA512:
-  metadata.gz: c8cf0e07efa3c4a2ea92af6014333c3adc08f1471357b3cc31f1d93779e5af3920e7c71b308bff62f34366211fd5912baadd9780cc2978c9b4185582524f9181
-  data.tar.gz: f001860c11580ae570e25875f548a167ec878d87545befb39b7ee13a58385e2d2fda86a0919745030b915fed8bd84b3cc6200462c467b320e823cb43a9785047
+  metadata.gz: d1ec95cdd3be52b3eb1fd91eaabfffcd67642185c214272b512d0320a17e7344554ae996b0af5f43b7e9c6b69e951268ba0a34b7b0ffe850d3f0a3c38eb5d1b9
+  data.tar.gz: 0ed5474fe161e4f4f1dfec4582f258c33217846bd9a1a607969a9f388d56740c55cb97be0f85184f30c90df56908c7dd224eac48fc7a343d83eb9c7615ea7c71

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,11 @@
 
 ## master
 
+## 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/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.0"
   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.0
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-02 00:00:00.000000000 Z
+date: 2024-03-31 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