graphql-persisted_queries 1.6.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa710e0a1af1fe00953679781bf408f3c78201b67920671f9af36ff57edefcc0
-  data.tar.gz: cc46697bf61938af0d4359fb9b5bf4898f3bc5108b4f562f94d3003a857064a6
+  metadata.gz: 348a66b5ed4c013fe7c41a01a752acdca8ecf2eac99f5365ac7cc11b3a6bcd4d
+  data.tar.gz: 2c15c37b4f4f451d12ab946f86e7df67a393af8d897ec0ec718924520ea5ee7b
 SHA512:
-  metadata.gz: 6028cb87dc1e0c7a78f18f29c7afbff2d2aae46fadbec983d6ebbb217016523a8722f27c993570b914b3fec6cebe0d16ad26e7091844a0e60f4bf0d80217cb11
-  data.tar.gz: a0d0dada8b7f34298a69aed43dd988ce077e010866faf33c8d206375ee0cb2f00afed1f0794753983a5b2b01f266888f7988d77a031f33c6f55d2779abd62e35
+  metadata.gz: d1ec95cdd3be52b3eb1fd91eaabfffcd67642185c214272b512d0320a17e7344554ae996b0af5f43b7e9c6b69e951268ba0a34b7b0ffe850d3f0a3c38eb5d1b9
+  data.tar.gz: 0ed5474fe161e4f4f1dfec4582f258c33217846bd9a1a607969a9f388d56740c55cb97be0f85184f30c90df56908c7dd224eac48fc7a343d83eb9c7615ea7c71

data/.github/workflows/rspec.yml

@@ -18,13 +18,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.6, 2.7, 3.0]
+        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,17 @@
 
 ## 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)
+Fix double hashing of keys in case of redis_with_local_cache_store adapter ([@mpospelov][])
+- [PR#62](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/pull/62) Drop tracers= implementation as it's no longer valid ([@mpospelov][])
+
 ## 1.6.1 (2022-11-17)
 
 - [PR#60](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/pull/60)
@@ -112,3 +123,4 @@ Handle situations when prepare_ast happens before instrumentation ([@DmitryTsepe
 [@ogidow]: https://github.com/ogidow
 [@rbviz]: https://github.com/rbviz
 [@louim]: https://github.com/louim
+[@mpospelov]: https://github.com/mpospelov

data/README.md

@@ -6,6 +6,12 @@
 - 🤝**Clients share cached queries** – it's enough to miss cache only once for each unique query
 - 🎅**Works for clients without persisted query support**
 
+Used in production by:
+
+- [Yammer by Microsoft](https://github.com/DmitryTsepelev/graphql-ruby-persisted_queries/issues/20#issuecomment-587945989)
+- Toptal
+- _Want to be here? Let me know_ 🙂
+
 ## 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:
@@ -80,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/graphql-persisted_queries.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.6"
+  spec.required_ruby_version = ">= 2.7"
 
   spec.add_dependency "graphql", ">= 1.12"
 

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/store_adapters/base_store_adapter.rb

@@ -12,7 +12,8 @@ module GraphQL
           @name = :base
         end
 
-        def fetch_query(hash, compiled_query: false)
+        def fetch_query(hash, options = {})
+          compiled_query = options[:compiled_query] || false
           key = build_key(hash, compiled_query)
 
           fetch(key).tap do |result|
@@ -26,8 +27,6 @@ module GraphQL
           trace("save_query", adapter: @name) { save(key, query) }
         end
 
-        protected
-
         def fetch(_hash)
           raise NotImplementedError
         end

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

@@ -17,8 +17,6 @@ module GraphQL
           @name = :memcached
         end
 
-        protected
-
         def fetch(hash)
           @dalli_proc.call { |dalli| dalli.get(key_for(hash)) }
         end

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

@@ -10,8 +10,6 @@ module GraphQL
           @name = :memory
         end
 
-        protected
-
         def fetch(hash)
           @storage[hash]
         end

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

@@ -17,8 +17,6 @@ module GraphQL
           @name = :redis
         end
 
-        protected
-
         def fetch(hash)
           @redis_proc.call { |redis| redis.get(key_for(hash)) }
         end

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

@@ -22,29 +22,19 @@ module GraphQL
           @name = :redis_with_local_cache
         end
 
-        # We don't need to implement our own traces for this adapter since the
-        # underlying adapters will emit the proper events for us.  However,
-        # since tracers can be defined at any time, we need to pass them through.
-        def tracers=(tracers)
-          @memory_adapter.tracers = tracers
-          @redis_adapter.tracers = tracers
-        end
-
-        protected
-
         def fetch(hash)
-          result = @memory_adapter.fetch_query(hash)
+          result = @memory_adapter.fetch(hash)
           result ||= begin
-            inner_result = @redis_adapter.fetch_query(hash)
-            @memory_adapter.save_query(hash, inner_result) if inner_result
+            inner_result = @redis_adapter.fetch(hash)
+            @memory_adapter.save(hash, inner_result) if inner_result
             inner_result
           end
           result
         end
 
         def save(hash, query)
-          @redis_adapter.save_query(hash, query)
-          @memory_adapter.save_query(hash, query)
+          @redis_adapter.save(hash, query)
+          @memory_adapter.save(hash, query)
         end
 
         private

data/lib/graphql/persisted_queries/version.rb

@@ -2,6 +2,6 @@
 
 module GraphQL
   module PersistedQueries
-    VERSION = "1.6.1"
+    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.6.1
+  version: 1.8.0
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-17 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
@@ -182,14 +185,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Persisted queries for graphql-ruby