graphql-hive 0.4.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2df4ea1405ff374b1d534b4b771e95a6e28765d0befce95492b482d675c0905
-  data.tar.gz: 305c9e57226ea9943fb8f14d1b6b85a757455b2be8ccead3ade9d6c4c2bdf2b5
+  metadata.gz: 4176f281928e52d551ae77d96f837f449e32ecc4636d9f3c160c6c36121cef43
+  data.tar.gz: 71b3d0d1740cd707321c4970ad608fd73cae893561a6aa51b6ef288c2a955fc0
 SHA512:
-  metadata.gz: 66216491e6445d6e3abe05689a820fe881da34048f2f676970e81e24ae5fea21300d1f0c1924d53e0a5925cfc4b715338cee4a8f913cef888538c9ad6855ef72
-  data.tar.gz: f56b6f52dd900b2073fb229364a6cb9ab3d74f482ea7ae81e90be906d6912c195a7b6de08c91ac987c2029ae3abbe84951a561615b1152f1e9441bb92fce3b21
+  metadata.gz: 5dd8fe627ef820bb26b8c20a3eb5fb9946bd87b4d3c36cff52c508f02aca17645ebc105314ada908b2dd926b176134e8e83d6c86b891849b5cf3c98d86db1ad0
+  data.tar.gz: b66d19f472e1e0034ae4eb42ab7f1ec14814216a6e7e71660aaaec4948c9b85287f947595043a41d9b31f7308cf9039af2978ef4af59f5edc2ed822410d890f8

data/.github/workflows/ci.yml

@@ -8,33 +8,26 @@ on:
       - master
 
 jobs:
-  rubocop:
+  standard:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-
-    - uses: ruby/setup-ruby@2a9a743e19810b9f3c38060637daf594dbd7b37f
-      with:
-        ruby-version: '3.3'
-        bundler-cache: true
-
-    - run: bundle exec rake rubocop
-      
+      - name: Standard Ruby
+        uses: standardrb/standard-ruby-action@v1
   test:
     strategy:
       fail-fast: false
       matrix:
         ruby-version:
-          - '3.1'
-          - '3.2'
-          - '3.3'
+          - "3.1"
+          - "3.2"
+          - "3.3"
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - uses: ruby/setup-ruby@2a9a743e19810b9f3c38060637daf594dbd7b37f
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true
+      - uses: ruby/setup-ruby@2a9a743e19810b9f3c38060637daf594dbd7b37f
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
 
-    - run: bundle exec rake spec
+      - run: bundle exec rake spec

data/.gitignore

@@ -11,3 +11,9 @@
 .rspec_status
 *.gem
 k6/node_modules/
+
+# IDEs
+.idea
+
+# k6
+node_modules

data/.rubocop.yml

@@ -1,41 +1,10 @@
-AllCops:
-  TargetRubyVersion: 2.6
-  NewCops: enable
-  Exclude:
-    - 'examples/**/*'
-    - 'k6/**/*'
-    - 'gemfiles/**/*'
-    - 'tmp/**/*'
-    - 'vendor/**/*'
-
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*'
-
-Layout/LineLength:
-  Exclude:
-    - 'spec/**/*'
-
-Naming/FileName:
-  Enabled: false
-
-Style/ClassVars:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Gemspec/DevelopmentDependencies:
-  EnforcedStyle: 'gemspec'
+require:
+  - standard
+  - standard-custom
+  - standard-performance
+  - rubocop-performance
+
+inherit_gem:
+  standard: config/base.yml
+  standard-custom: config/base.yml
+  standard-performance: config/base.yml

data/.ruby-version

@@ -0,0 +1 @@
+3.3.5

data/Gemfile

@@ -1,8 +1,20 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in graphql-hive.gemspec
 gemspec
+
+group :development do
+  gem "bundler", "~> 2"
+  gem "debug", ">= 1.0.0"
+  gem "rack-test", "~> 2"
+  gem "rake", "~> 13"
+  gem "rspec", "~> 3"
+  gem "sinatra", "~> 2"
+  gem "standardrb", "~> 1"
+  gem "vcr", "~> 6"
+  gem "webmock", "~> 3"
+end

data/Gemfile.lock

@@ -1,29 +1,57 @@
 PATH
   remote: .
   specs:
-    graphql-hive (0.4.2)
+    graphql-hive (0.5.1)
       graphql (>= 2.3, < 3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
     base64 (0.2.0)
+    bigdecimal (3.1.8)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    debug (1.9.2)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
     diff-lcs (1.5.1)
     graphql (2.3.7)
       base64
+    hashdiff (1.1.1)
+    io-console (0.7.2)
+    irb (1.14.1)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
-    parallel (1.25.1)
-    parser (3.3.3.0)
+    lint_roller (1.1.0)
+    mustermann (2.0.2)
+      ruby2_keywords (~> 0.0.1)
+    parallel (1.26.3)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
-    racc (1.8.0)
+    psych (5.1.2)
+      stringio
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rack (2.2.10)
+    rack-protection (2.2.4)
+      rack
+    rack-test (2.1.0)
+      rack (>= 1.3)
     rainbow (3.1.1)
     rake (13.2.1)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
     regexp_parser (2.9.2)
-    rexml (3.3.1)
-      strscan
+    reline (0.5.10)
+      io-console (~> 0.5)
+    rexml (3.3.8)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -37,22 +65,52 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.64.1)
+    rubocop (1.65.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
+      regexp_parser (>= 2.4, < 3.0)
       rexml (>= 3.2.5, < 4.0)
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
+    rubocop-ast (1.32.3)
       parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
     ruby-progressbar (1.13.0)
-    strscan (3.1.0)
-    unicode-display_width (2.5.0)
+    ruby2_keywords (0.0.5)
+    sinatra (2.2.4)
+      mustermann (~> 2.0)
+      rack (~> 2.2)
+      rack-protection (= 2.2.4)
+      tilt (~> 2.0)
+    standard (1.40.1)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.65.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.4)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.4.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.21.0)
+    standardrb (1.0.1)
+      standard
+    stringio (3.1.1)
+    tilt (2.4.0)
+    unicode-display_width (2.6.0)
+    vcr (6.3.1)
+      base64
+    webmock (3.24.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   arm64-darwin-23
@@ -60,10 +118,15 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2)
+  debug (>= 1.0.0)
   graphql-hive!
+  rack-test (~> 2)
   rake (~> 13)
   rspec (~> 3)
-  rubocop (~> 1)
+  sinatra (~> 2)
+  standardrb (~> 1)
+  vcr (~> 6)
+  webmock (~> 3)
 
 BUNDLED WITH
    2.5.15

data/README.md

@@ -1,4 +1,4 @@
-# GraphQL Hive: `graphql-ruby` integration 
+# GraphQL Hive: `graphql-ruby` integration
 [![CI Suite](https://github.com/charlypoly/graphql-ruby-hive/actions/workflows/ci.yml/badge.svg)](https://github.com/charlypoly/graphql-ruby-hive/actions)
 [![Gem Version](https://badge.fury.io/rb/graphql-hive.svg)](https://rubygems.org/gems/graphql-hive)
 
@@ -146,39 +146,53 @@ class MySchema < GraphQL::Schema
   use(
     GraphQL::Hive,
     {
-      # mandatory
-      token: 'YOUR-TOKEN',
-
-      # optional
-      enabled: true, # enable/disable Hive Client
-      debug: false, # verbose logs
+      # Token is the only required configuration value.
+      token: 'YOUR-REGISTRY-TOKEN',
+      #
+      # The following are optional configuration values.
+      #
+      # Enable/disable Hive Client.
+      enabled: true,
+      # Verbose logs.
+      debug: false,
+      # A custom logger.
       logger: MyLogger.new,
+      # Endpoint and port of the Hive API. Change this if you are using a self-hosted Hive instance.
       endpoint: 'app.graphql-hive.com',
-      port: 80, 
-      buffer_size: 50, # forward the operations data to Hive every 50 requests
-
-      collect_usage: true, # report usage to Hive
+      port: 80,
+      # Number of operations sent to Hive in a batch (AFTER sampling).
+      buffer_size: 50,
+      # Size of the queue used to send operations to the buffer before sampling.
+      queue_size: 1000,
+      # Report usage to Hive.
+      collect_usage: true,
+      # Usage sampling configurations.
       collect_usage_sampling: {
-        # optional members of `collect_usage_sampling`  
-        sample_rate: 0.5, # % of operations reported
-        sampler: proc { |context| context.operation_name.includes?('someQuery') 1 : 0.5 }, # assign custom sampling rates (overrides `sampling rate`)
-        at_least_once: true, # sample every distinct operation at least once
-        key_generator: proc { |context| context.operation_name } # assign custom keys to distinguish between distinct operations
-      }
-
-      report_schema: true,  # publish schema to Hive
-      # mandatory if `report_schema: true`
-      reporting: { 
-        # mandatory members of `reporting`
+        # % of operations recorded.
+        sample_rate: 0.5,
+        # Custom sampler to assign custom sampling rates.
+        sampler: proc { |context| context.operation_name.includes?('someQuery') 1 : 0.5 },
+        # Sample every distinct operation at least once.
+        at_least_once: true,
+        # Assign custom keys to distinguish between distinct operations.
+        key_generator: proc { |context| context.operation_name }
+      },
+      # Publish schema to Hive.
+      report_schema: true,
+      # Mandatory if `report_schema: true`.
+      reporting: {
+        # Mandatory members of `reporting`.
         author: 'Author of the latest change',
         commit: 'git sha or any identifier',
-        # optional members of `reporting  
+        # Optional members of `reporting`.
         service_name: '',
         service_url: '',
       },
 
-       # pass an optional proc to client_info to help identify the client (ex: Apollo web app) that performed the query
-      client_info: proc { |context| { name: context.client_name, version: context.client_version } }
+      # Pass an optional proc to client_info to help identify the client (ex: Apollo web app) that performed the query.
+      client_info: proc { |context|
+        { name: context.client_name, version: context.client_version }
+      }
     }
   )
 
@@ -187,16 +201,14 @@ class MySchema < GraphQL::Schema
 end
 ```
 
-See default options for the optional parameters [here](https://github.com/charlypoly/graphql-ruby-hive/blob/01407d8fed80912a7006fee503bf2967fa20a79c/lib/graphql-hive.rb#L53).
+See default options for the optional parameters [here](https://github.com/rperryng/graphql-ruby-hive/blob/master/lib/graphql-hive.rb#L31-L41).
 
 <br/>
 
-**A note on `buffer_size` and performances**
-
-The `graphql-hive` usage reporter, responsible for sending the operations data to Hive, is running in a separate `Thread` to avoid any significant impact on your GraphQL API performances.
-
-The performance overhead (with the default `buffer_size` option) is around 1% and [is constantly evaluated for new PR](https://github.com/charlypoly/graphql-ruby-hive/actions/workflows/benchmark.yml).
-
-If your GraphQL API has a high RPM, we encourage you to increase the `buffer_size` value.
-
-However, please note that a higher `buffer_size` value will introduce some peak of increase in memory consumption.
+> [!Important]
+> `buffer_size` and `queue_size` will affect memory consumption.
+>
+> `buffer_size` is the number of operations sent to Hive in a batch after operations have been sampled.
+> `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`.

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-require 'rubocop/rake_task'
+require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
 task(default: %i[spec rubocop])

data/graphql-hive.gemspec

@@ -1,33 +1,28 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'graphql-hive/version'
+require "graphql-hive/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'graphql-hive'
-  spec.version       = Graphql::Hive::VERSION
-  spec.authors       = ['Charly POLY']
-  spec.email         = ['cpoly55@gmail.com']
+  spec.name = "graphql-hive"
+  spec.version = Graphql::Hive::VERSION
+  spec.authors = ["Charly POLY"]
+  spec.email = ["cpoly55@gmail.com"]
 
-  spec.summary       = '"GraphQL Hive integration for `graphql-ruby`"'
-  spec.description   = '"Monitor operations, inspect your queries and publish your GraphQL schema with GraphQL Hive"'
-  spec.homepage      = 'https://docs.graphql-hive.com/specs/integrations'
-  spec.license       = 'MIT'
+  spec.summary = '"GraphQL Hive integration for `graphql-ruby`"'
+  spec.description = '"Monitor operations, inspect your queries and publish your GraphQL schema with GraphQL Hive"'
+  spec.homepage = "https://docs.graphql-hive.com/specs/integrations"
+  spec.license = "MIT"
 
-  spec.metadata      = { 'rubygems_mfa_required' => 'true' }
+  spec.metadata = {"rubygems_mfa_required" => "true"}
 
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
-  spec.require_paths = ['lib']
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+  spec.require_paths = ["lib"]
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
 
-  spec.add_dependency 'graphql', '>= 2.3', '< 3'
-
-  spec.add_development_dependency 'bundler', '~> 2'
-  spec.add_development_dependency 'rake', '~> 13'
-  spec.add_development_dependency 'rspec', '~> 3'
-  spec.add_development_dependency 'rubocop', '~> 1'
+  spec.add_dependency "graphql", ">= 2.3", "< 3"
 end

data/lib/graphql-hive/analyzer.rb

@@ -73,7 +73,7 @@ module GraphQL
       end
 
       def make_id(*tokens)
-        tokens.join('.')
+        tokens.join(".")
       end
     end
   end

data/lib/graphql-hive/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'net/http'
-require 'uri'
+require "net/http"
+require "uri"
 
 module GraphQL
   class Hive < GraphQL::Tracing::PlatformTracing
@@ -14,9 +14,9 @@ module GraphQL
       def send(path, body, _log_type)
         uri =
           URI::HTTP.build(
-            scheme: @options[:port].to_s == '443' ? 'https' : 'http',
-            host: @options[:endpoint] || 'app.graphql-hive.com',
-            port: @options[:port] || '443',
+            scheme: (@options[:port].to_s == "443") ? "https" : "http",
+            host: @options[:endpoint] || "app.graphql-hive.com",
+            port: @options[:port] || "443",
             path: path
           )
 
@@ -26,25 +26,25 @@ module GraphQL
 
         @options[:logger].debug(response.inspect)
         @options[:logger].debug(response.body.inspect)
-      rescue StandardError => e
+      rescue => e
         @options[:logger].fatal("Failed to send data: #{e}")
       end
 
       def setup_http(uri)
         http = ::Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = @options[:port].to_s == '443'
+        http.use_ssl = @options[:port].to_s == "443"
         http.read_timeout = 2
         http
       end
 
       def build_request(uri, body)
         request = Net::HTTP::Post.new(uri.request_uri)
-        request['Authorization'] = @options[:token]
-        request['X-Usage-API-Version'] = '2'
-        request['content-type'] = 'application/json'
-        request['User-Agent'] = "Hive@#{Graphql::Hive::VERSION}"
-        request['graphql-client-name'] = 'Hive Ruby Client'
-        request['graphql-client-version'] = Graphql::Hive::VERSION
+        request["Authorization"] = @options[:token]
+        request["X-Usage-API-Version"] = "2"
+        request["content-type"] = "application/json"
+        request["User-Agent"] = "Hive@#{Graphql::Hive::VERSION}"
+        request["graphql-client-name"] = "Hive Ruby Client"
+        request["graphql-client-version"] = Graphql::Hive::VERSION
         request.body = JSON.generate(body)
         request
       end

data/lib/graphql-hive/printer.rb

@@ -10,12 +10,12 @@ module GraphQL
         @out.append(str)
       end
 
-      def print_node(node, indent: '')
+      def print_node(node, indent: "")
         case node
         when Float, Integer
-          print_string '0'
+          print_string "0"
         when String
-          print_string ''
+          print_string ""
         else
           super
         end
@@ -23,16 +23,16 @@ module GraphQL
 
       # from GraphQL::Language::Printer with sort_by name
       # ignores aliases
-      def print_field(field, indent: '')
+      def print_field(field, indent: "")
         print_string(indent)
         print_string(field.name)
         if field.arguments.any?
-          print_string('(')
+          print_string("(")
           field.arguments.sort_by(&:name).each_with_index do |a, i|
             print_argument(a)
-            print_string(', ') if i < field.arguments.size - 1
+            print_string(", ") if i < field.arguments.size - 1
           end
-          print_string(')')
+          print_string(")")
         end
         print_directives(field.directives)
         print_selections(field.selections, indent: indent)
@@ -43,7 +43,7 @@ module GraphQL
       end
 
       # from GraphQL::Language::Printer with sort_by name
-      def print_selections(selections, indent: '')
+      def print_selections(selections, indent: "")
         sorted_nodes = selections.sort_by do |s|
           next s.name if s.respond_to?(:name)
           next s.type.name if s.respond_to?(:type)
@@ -55,35 +55,35 @@ module GraphQL
 
       # from GraphQL::Language::Printer with sort_by name
       def print_directive(directive)
-        print_string('@')
+        print_string("@")
         print_string(directive.name)
 
         return if directive.arguments.blank?
 
-        print_string('(')
+        print_string("(")
         directive.arguments.sort_by(&:name).each_with_index do |a, i|
           print_argument(a)
-          print_string(', ') if i < directive.arguments.size - 1
+          print_string(", ") if i < directive.arguments.size - 1
         end
-        print_string(')')
+        print_string(")")
       end
 
       # from GraphQL::Language::Printer with sort_by name
-      def print_operation_definition(operation_definition, indent: '')
+      def print_operation_definition(operation_definition, indent: "")
         print_string(indent)
         print_string(operation_definition.operation_type)
         if operation_definition.name
-          print_string(' ')
+          print_string(" ")
           print_string(operation_definition.name)
         end
 
         if operation_definition.variables.any?
-          print_string('(')
+          print_string("(")
           operation_definition.variables.sort_by(&:name).each_with_index do |v, i|
             print_variable_definition(v)
-            print_string(', ') if i < operation_definition.variables.size - 1
+            print_string(", ") if i < operation_definition.variables.size - 1
           end
-          print_string(')')
+          print_string(")")
         end
 
         print_directives(operation_definition.directives)

data/lib/graphql-hive/sampler.rb

@@ -8,28 +8,28 @@ module GraphQL
         # backwards compatibility with old `collect_usage_sampling` field
         if sampling_options.is_a?(Numeric)
           logger&.warn(
-            '`collect_usage_sampling` is deprecated for fixed sampling rates, ' \
-            'use `collect_usage_sampling: { sample_rate: XX }` instead'
+            "`collect_usage_sampling` is deprecated for fixed sampling rates, " \
+            "use `collect_usage_sampling: { sample_rate: XX }` instead"
           )
           passed_sampling_rate = sampling_options
-          sampling_options = { sample_rate: passed_sampling_rate }
+          sampling_options = {sample_rate: passed_sampling_rate}
         end
 
         sampling_options ||= {}
 
         @sampler = if sampling_options[:sampler]
-                     Sampling::DynamicSampler.new(
-                       sampling_options[:sampler],
-                       sampling_options[:at_least_once],
-                       sampling_options[:key_generator]
-                     )
-                   else
-                     Sampling::BasicSampler.new(
-                       sampling_options[:sample_rate],
-                       sampling_options[:at_least_once],
-                       sampling_options[:key_generator]
-                     )
-                   end
+          Sampling::DynamicSampler.new(
+            sampling_options[:sampler],
+            sampling_options[:at_least_once],
+            sampling_options[:key_generator]
+          )
+        else
+          Sampling::BasicSampler.new(
+            sampling_options[:sample_rate],
+            sampling_options[:at_least_once],
+            sampling_options[:key_generator]
+          )
+        end
       end
 
       def sample?(operation)