graphql-hive 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdf8bbcc4676ce4b0cebd4c2deb071fe065cda4d325e9c1cafb4b6781dfb2651
-  data.tar.gz: 5eee4c6d212c8b5461ac20fb68ccb35236e3e2f31c446faad1dd8e99980e6e71
+  metadata.gz: 1fa33a96e20e7429e87a7a1a3d7dea4d42a826c7aa58275234f1765bb2d990dc
+  data.tar.gz: a6366ab15aa1b76609406a01430eb71877d8f634a3e587a6a75bf5416c21fccb
 SHA512:
-  metadata.gz: 640103e353f961efe91e91ce005089670fa7ac1df9bbec11f78b1a8e51a2b9528977519e9281e91e8a6778309d8033ac3d043fdcc93aad375a58a8aee2d9bbbc
-  data.tar.gz: b8ffc2808008d65f1295b8ff4c2c3198f051808e2bd4b53cc3919d895782d124c29ad0a763079e9a34095a7e9cdbf3bcde7048da39fa0210c83863fb7fbdf882
+  metadata.gz: d798387a6a48648f5ef8a07c30e27aeb645327f5c334ff85684f3268cb12e99ab53131c6c8f72d9f24e0a62800271984c80006813a185de7a570411c3988b881
+  data.tar.gz: 262294726fdc7e9e22ab7079c04e143b34ab9334b47fc80797828b3aff9c5dab45b848c39c5e29122f40801cdc9b9310e00e554ce1eb3e1da9f38e3422a63254

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.6.4"
+  ".": "0.6.5"
 }

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.6.5](https://github.com/wealthsimple-community/graphql-ruby-hive/compare/v0.6.4...v0.6.5) (2026-09-15)
+
+
+### Features
+
+* support processVariables ([#14](https://github.com/wealthsimple-community/graphql-ruby-hive/issues/14)) ([94cc38f](https://github.com/wealthsimple-community/graphql-ruby-hive/commit/94cc38f9e379c5aa7dd85e40d46f8add17a9fb57))
+
 ## [0.6.4](https://github.com/wealthsimple-community/graphql-ruby-hive/compare/v0.6.3...v0.6.4) (2026-08-17)
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    graphql-hive (0.6.4)
+    graphql-hive (0.6.5)
       graphql (>= 2.4.12, < 3)
 
 GEM

data/README.md

@@ -179,6 +179,10 @@ class MySchema < GraphQL::Schema
       queue_size: 1000,
       # Report usage to Hive.
       collect_usage: true,
+      # Inspect actual variable payloads to report only the input fields and enum values
+      # a client actually provided, rather than every field that could theoretically be
+      # used. See the `process_variables` section below for details and trade-offs.
+      process_variables: false,
       # Usage sampling configurations.
       collect_usage_sampling: {
         # % of operations recorded.
@@ -225,3 +229,9 @@ See default options for the optional parameters [here](https://github.com/wealth
 > `queue_size` is the size of the queue used to send operations to the buffer before sampling.
 > Adjust these values according to your application's memory constraints and throughput.
 > High throughput applications will need a larger `queue_size`.
+
+## `process_variables`
+
+By default, when an input object or enum is passed through a `$variable`, every field of that input type (or every value of that enum) is reported as used — the conservative assumption. Setting `process_variables: true` reports only the coordinates a client actually populated, using both the plain form (`InputType.field`) and a `!`-suffixed form (`InputType.field!`). Hive uses the `!` form to power granular, per-input-field [conditional breaking-change](https://the-guild.dev/graphql/hive/docs/management/targets#conditional-breaking-changes) decisions.
+
+Only schema coordinates derived from the payload structure are sent — never the variable values themselves.

data/lib/graphql-hive/analyzer.rb

@@ -4,9 +4,11 @@ module GraphQL
   class Hive < GraphQL::Tracing::PlatformTracing
     # Fetch all users fields, input objects and enums
     class Analyzer < GraphQL::Analysis::AST::Analyzer
-      def initialize(query_or_multiplex)
-        super
+      def initialize(query_or_multiplex, options = {})
+        super(query_or_multiplex)
         @used_fields = Set.new
+        @process_variables = options.fetch(:process_variables, false)
+        @provided_variables = (@process_variables && query_or_multiplex.respond_to?(:provided_variables)) ? (query_or_multiplex.provided_variables || {}) : {}
       end
 
       def on_enter_field(node, _parent, visitor)
@@ -29,9 +31,9 @@ module GraphQL
         end
 
         if arg_type.kind.input_object?
-          collect_input_object_fields(node, arg_type)
+          collect_input_object_fields(node, arg_type, visitor.argument_definition.type)
         elsif arg_type.kind.enum?
-          collect_enum_values(node, arg_type)
+          collect_enum_values(node, arg_type, visitor.argument_definition.type)
         end
       end
 
@@ -43,11 +45,15 @@ module GraphQL
 
       private
 
-      def collect_input_object_fields(node, input_type)
+      def collect_input_object_fields(node, input_type, full_type)
         case node.value
         when GraphQL::Language::Nodes::VariableIdentifier
-          input_type.all_argument_definitions.map(&:graphql_name).each do |n|
-            @used_fields.add(make_id(input_type.graphql_name, n))
+          if @process_variables
+            walk_variable_value(full_type, @provided_variables[node.value.name])
+          else
+            input_type.all_argument_definitions.map(&:graphql_name).each do |n|
+              @used_fields.add(make_id(input_type.graphql_name, n))
+            end
           end
         when Array
           node.value.flat_map(&:arguments).map(&:name).each do |n|
@@ -60,11 +66,15 @@ module GraphQL
         end
       end
 
-      def collect_enum_values(node, enum_type)
+      def collect_enum_values(node, enum_type, full_type)
         case node.value
         when GraphQL::Language::Nodes::VariableIdentifier
-          enum_type.values.values.map(&:graphql_name).each do |n|
-            @used_fields.add(make_id(enum_type.graphql_name, n))
+          if @process_variables
+            walk_variable_value(full_type, @provided_variables[node.value.name])
+          else
+            enum_type.values.values.map(&:graphql_name).each do |n|
+              @used_fields.add(make_id(enum_type.graphql_name, n))
+            end
           end
         when Array
           node.value.map(&:name).each do |n|
@@ -75,6 +85,48 @@ module GraphQL
         end
       end
 
+      # Recursively walk a variable's runtime value, marking only the schema
+      # coordinates that were actually provided. Mirrors the JS client's
+      # processVariables behavior, including the `!` suffix for input object
+      # fields that received a non-null value.
+      def walk_variable_value(type, value)
+        return if value.nil?
+
+        t = type
+        t = t.of_type while t.non_null?
+
+        if t.list?
+          return unless value.is_a?(Array)
+          inner = t.of_type
+          value.each { |item| walk_variable_value(inner, item) }
+          return
+        end
+
+        if t.kind.input_object?
+          walk_input_object(t, value)
+        elsif t.kind.enum?
+          @used_fields.add(make_id(t.graphql_name, value.to_s))
+        end
+      end
+
+      def walk_input_object(input_type, value)
+        return unless value.is_a?(Hash)
+
+        arg_defs = input_type.all_argument_definitions.each_with_object({}) { |a, h| h[a.graphql_name] = a }
+
+        value.each do |field_name, field_value|
+          key = field_name.to_s
+          arg = arg_defs[key]
+          next unless arg
+
+          coord = make_id(input_type.graphql_name, key)
+          @used_fields.add(coord)
+          @used_fields.add("#{coord}!") unless field_value.nil?
+
+          walk_variable_value(arg.type, field_value)
+        end
+      end
+
       def make_id(*tokens)
         tokens.join(".")
       end

data/lib/graphql-hive/usage_reporter.rb

@@ -105,7 +105,7 @@ module GraphQL
         fields = Set.new
 
         queries.each do |query|
-          analyzer = GraphQL::Hive::Analyzer.new(query)
+          analyzer = GraphQL::Hive::Analyzer.new(query, process_variables: @options[:process_variables])
           visitor = GraphQL::Analysis::AST::Visitor.new(
             query: query,
             analyzers: [analyzer],
@@ -139,8 +139,16 @@ module GraphQL
           operation_record[:metadata] = {client: @options[:client_info].call(context)} if @options[:client_info]
         end
 
+        # Union with any existing fields for this key. Operations that share a document
+        # but differ in variables produce the same operation_map_key (MD5 of the printed
+        # operation body, which does not include variable values) but can produce
+        # different coord sets under process_variables. Overwriting would drop the
+        # earlier op's coord evidence for this batch.
+        existing_fields = report[:map][operation_map_key]&.fetch(:fields, nil)
+        merged_fields = existing_fields ? (Set.new(existing_fields) | fields) : fields
+
         report[:map][operation_map_key] = {
-          fields: fields.to_a,
+          fields: merged_fields.to_a,
           operationName: operation_name,
           operation: operation
         }

data/lib/graphql-hive/version.rb

@@ -2,6 +2,6 @@
 
 module Graphql
   module Hive
-    VERSION = "0.6.4"
+    VERSION = "0.6.5"
   end
 end

data/lib/graphql-hive.rb

@@ -42,7 +42,8 @@ module GraphQL
       collect_usage_sampling: 1.0,
       target: nil,
       log_request_details: false,
-      warn_on_hive_errors: false
+      warn_on_hive_errors: false,
+      process_variables: false
     }.freeze
 
     self.platform_keys = {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphql-hive
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Charly Poly