graphql-hive 0.4.2 → 0.5.1

data/lib/graphql-hive/sampling/basic_sampler.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'graphql-hive/sampling/sampling_context'
+require "graphql-hive/sampling/sampling_context"
 
 module GraphQL
   class Hive

data/lib/graphql-hive/sampling/dynamic_sampler.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'graphql-hive/sampling/sampling_context'
+require "graphql-hive/sampling/sampling_context"
 
 module GraphQL
   class Hive

data/lib/graphql-hive/sampling/sampling_context.rb

@@ -16,7 +16,7 @@ module GraphQL
         def get_sample_context(operation)
           _, queries, results, = operation
 
-          operation_name = queries.map(&:operations).map(&:keys).flatten.compact.join(', ')
+          operation_name = queries.map(&:operations).map(&:keys).flatten.compact.join(", ")
 
           parsed_definitions = []
           queries.each do |query|

data/lib/graphql-hive/usage_reporter.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'digest'
-require 'graphql-hive/analyzer'
-require 'graphql-hive/printer'
+require "digest"
+require "graphql-hive/analyzer"
+require "graphql-hive/printer"
 
 module GraphQL
   class Hive < GraphQL::Tracing::PlatformTracing
@@ -16,20 +16,19 @@ module GraphQL
 
       def initialize(options, client)
         @@instance = self
-
         @options = options
         @client = client
-
         @options_mutex = Mutex.new
-        @queue = Queue.new
-
         @sampler = Sampler.new(options[:collect_usage_sampling], options[:logger]) # NOTE: logs for deprecated field
+        @queue = Thread::SizedQueue.new(options[:queue_size])
 
         start_thread
       end
 
       def add_operation(operation)
-        @queue.push(operation)
+        @queue.push(operation, true)
+      rescue ThreadError
+        @options[:logger].error("SizedQueue is full, discarding operation. Size: #{@queue.size}, Max: #{@queue.max}")
       end
 
       def on_exit
@@ -45,30 +44,35 @@ module GraphQL
 
       def start_thread
         if @thread&.alive?
-          @options[:logger].warn('Tried to start operations flushing thread but it was already alive')
+          @options[:logger].warn("Tried to start operations flushing thread but it was already alive")
           return
         end
 
         @thread = Thread.new do
           buffer = []
           while (operation = @queue.pop(false))
-            @options[:logger].debug("processing operation from queue: #{operation}")
-            buffer << operation if @sampler.sample?(operation)
-
-            @options_mutex.synchronize do
-              if buffer.size >= @options[:buffer_size]
-                @options[:logger].debug('buffer is full, sending!')
-                process_operations(buffer)
-                buffer = []
+            begin
+              @options[:logger].debug("processing operation from queue: #{operation}")
+              buffer << operation if @sampler.sample?(operation)
+
+              @options_mutex.synchronize do
+                if buffer.size >= @options[:buffer_size]
+                  @options[:logger].debug("buffer is full, sending!")
+                  process_operations(buffer)
+                  buffer = []
+                end
               end
+            rescue => e
+              buffer = []
+              @options[:logger].error(e)
             end
           end
 
           unless buffer.empty?
-            @options[:logger].debug('shuting down with buffer, sending!')
+            @options[:logger].debug("shuting down with buffer, sending!")
             process_operations(buffer)
           end
-        rescue StandardError => e
+        rescue => e
           # ensure configured logger receives exception as well in setups where STDERR might not be
           # monitored.
           @options[:logger].error(e)
@@ -88,7 +92,7 @@ module GraphQL
 
         @options[:logger].debug("sending report: #{report}")
 
-        @client.send('/usage', report, :usage)
+        @client.send(:"/usage", report, :usage)
       end
 
       def add_operation_to_report(report, operation)
@@ -96,8 +100,8 @@ module GraphQL
 
         errors = errors_from_results(results)
 
-        operation_name = queries.map(&:operations).map(&:keys).flatten.compact.join(', ')
-        operation = ''
+        operation_name = queries.map(&:operations).map(&:keys).flatten.compact.join(", ")
+        operation = ""
         fields = Set.new
 
         queries.each do |query|
@@ -131,7 +135,7 @@ module GraphQL
 
         if results[0]
           context = results[0].query.context
-          operation_record[:metadata] = { client: @options[:client_info].call(context) } if @options[:client_info]
+          operation_record[:metadata] = {client: @options[:client_info].call(context)} if @options[:client_info]
         end
 
         report[:map][operation_map_key] = {
@@ -144,9 +148,9 @@ module GraphQL
       end
 
       def errors_from_results(results)
-        acc = { errorsTotal: 0 }
+        acc = {errorsTotal: 0}
         results.each do |result|
-          errors = result.to_h.fetch('errors', [])
+          errors = result.to_h.fetch("errors", [])
           errors.each do
             acc[:errorsTotal] += 1
           end

data/lib/graphql-hive/version.rb

@@ -2,6 +2,6 @@
 
 module Graphql
   module Hive
-    VERSION = '0.4.2'
+    VERSION = "0.5.1"
   end
 end

data/lib/graphql-hive.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-require 'logger'
-require 'securerandom'
+require "logger"
+require "securerandom"
 
-require 'graphql-hive/version'
-require 'graphql-hive/usage_reporter'
-require 'graphql-hive/client'
+require "graphql-hive/version"
+require "graphql-hive/usage_reporter"
+require "graphql-hive/client"
 
-require 'graphql-hive/sampler'
-require 'graphql-hive/sampling/basic_sampler'
-require 'graphql-hive/sampling/dynamic_sampler'
+require "graphql-hive/sampler"
+require "graphql-hive/sampling/basic_sampler"
+require "graphql-hive/sampling/dynamic_sampler"
+require "graphql"
 
 module GraphQL
   # GraphQL Hive usage collector and schema reporter
@@ -31,24 +32,25 @@ module GraphQL
     DEFAULT_OPTIONS = {
       enabled: true,
       debug: false,
-      port: '443',
+      port: "443",
       collect_usage: true,
       read_operations: true,
       report_schema: true,
       buffer_size: 50,
+      queue_size: 1000,
       logger: nil,
       collect_usage_sampling: 1.0
     }.freeze
 
     self.platform_keys = {
-      'lex' => 'lex',
-      'parse' => 'parse',
-      'validate' => 'validate',
-      'analyze_query' => 'analyze_query',
-      'analyze_multiplex' => 'analyze_multiplex',
-      'execute_multiplex' => 'execute_multiplex',
-      'execute_query' => 'execute_query',
-      'execute_query_lazy' => 'execute_query_lazy'
+      "lex" => "lex",
+      "parse" => "parse",
+      "validate" => "validate",
+      "analyze_query" => "analyze_query",
+      "analyze_multiplex" => "analyze_multiplex",
+      "execute_multiplex" => "execute_multiplex",
+      "execute_query" => "execute_query",
+      "execute_query_lazy" => "execute_query_lazy"
     }
 
     def initialize(options = {})
@@ -84,7 +86,7 @@ module GraphQL
     def platform_trace(platform_key, _key, data)
       return yield unless @options[:enabled] && @options[:collect_usage]
 
-      if platform_key == 'execute_multiplex'
+      if platform_key == "execute_multiplex"
         if data[:multiplex]
           queries = data[:multiplex].queries
           timestamp = (Time.now.utc.to_f * 1000).to_i
@@ -134,25 +136,26 @@ module GraphQL
         options[:logger] = Logger.new($stderr)
         original_formatter = Logger::Formatter.new
         options[:logger].formatter = proc { |severity, datetime, progname, msg|
-          original_formatter.call(severity, datetime, progname, "[hive] #{msg.dump}")
+          msg = msg.respond_to?(:dump) ? msg.dump : msg
+          original_formatter.call(severity, datetime, progname, "[hive] #{msg}")
         }
         options[:logger].level = options[:debug] ? Logger::DEBUG : Logger::INFO
       end
       if !options.include?(:token) && (!options.include?(:enabled) || options.enabled)
-        options[:logger].warn('`token` options is missing')
+        options[:logger].warn("`token` options is missing")
         options[:enabled] = false
         false
       elsif options[:report_schema] &&
+          (
+            !options.include?(:reporting) ||
             (
-              !options.include?(:reporting) ||
-              (
-                options.include?(:reporting) && (
-                  !options[:reporting].include?(:author) || !options[:reporting].include?(:commit)
-                )
+              options.include?(:reporting) && (
+                !options[:reporting].include?(:author) || !options[:reporting].include?(:commit)
               )
             )
+          )
 
-        options[:logger].warn('`reporting.author` and `reporting.commit` options are required')
+        options[:logger].warn("`reporting.author` and `reporting.commit` options are required")
         false
       end
       true
@@ -167,7 +170,7 @@ module GraphQL
 
       body = {
         query: REPORT_SCHEMA_MUTATION,
-        operationName: 'schemaPublish',
+        operationName: "schemaPublish",
         variables: {
           input: {
             sdl: sdl,
@@ -180,7 +183,7 @@ module GraphQL
         }
       }
 
-      @client.send('/registry', body, :'report-schema')
+      @client.send(:"/registry", body, :"report-schema")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-hive
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.1
 platform: ruby
 authors:
 - Charly POLY
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-04 00:00:00.000000000 Z
+date: 2024-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -30,62 +30,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
 description: '"Monitor operations, inspect your queries and publish your GraphQL schema
   with GraphQL Hive"'
 email:
@@ -94,11 +38,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/benchmark.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -106,21 +50,7 @@ files:
 - RELEASING.md
 - Rakefile
 - cover.png
-- examples/simple-api/Gemfile
-- examples/simple-api/Gemfile.lock
-- examples/simple-api/app.rb
-- examples/simple-api/config.ru
-- examples/simple-api/schema.rb
 - graphql-hive.gemspec
-- k6/graphql-api/Gemfile
-- k6/graphql-api/Gemfile.lock
-- k6/graphql-api/app.rb
-- k6/graphql-api/config.ru
-- k6/graphql-api/schema.rb
-- k6/k6.js
-- k6/package.json
-- k6/usage-api.js
-- k6/yarn.lock
 - lib/graphql-hive.rb
 - lib/graphql-hive/analyzer.rb
 - lib/graphql-hive/client.rb

data/.github/workflows/benchmark.yml

@@ -1,67 +0,0 @@
-name: Benchmark
-on:
-  pull_request:
-    branches:
-      - master
-
-jobs:
-  benchmarks:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v4
-
-      - name: Use Node
-        uses: actions/setup-node@v4
-        with:
-          node-version: 22
-          cache: 'yarn'
-          cache-dependency-path: 'k6/yarn.lock'
-
-      - name: Use Ruby
-        uses: ruby/setup-ruby@2a9a743e19810b9f3c38060637daf594dbd7b37f
-        with:
-          working-directory: ./k6/graphql-api
-          ruby-version: '3.3'
-          bundler-cache: true
-
-      - name: Start GraphQL API with hive enabled
-        working-directory: ./k6/graphql-api
-        run: |
-          bundle
-          bundle exec puma -t 0:1 -p 9292 &
-          npx wait-on http://localhost:9292 --timeout 5s
-        env:
-          HIVE_ENABLED: 'true'
-
-      - name: Start GraphQL API with hive disabled
-        working-directory: ./k6/graphql-api
-        run: |
-          bundle
-          bundle exec puma -t 0:1 -p 9291 &
-          npx wait-on http://localhost:9291 --timeout 5s
-        env:
-          HIVE_ENABLED: 'false'
-
-      - name: Start Fake Usage API
-        working-directory: ./k6/
-        run: |
-          yarn
-          node usage-api.js &
-          npx wait-on http://localhost:8888 --timeout 5s
-
-      - name: Install k6
-        working-directory: ./k6
-        env:
-          K6_RELEASE_ARTIFACT_URL:
-            https://github.com/grafana/k6/releases/download/v0.37.0/k6-v0.37.0-linux-amd64.tar.gz
-        run: curl "${K6_RELEASE_ARTIFACT_URL}" -L | tar xvz --strip-components 1
-
-      - name: Run Benchmark
-        working-directory: ./k6
-        run: |
-          ./k6 \
-            -e GITHUB_PR=${{ github.event.number }} \
-            -e GITHUB_SHA=${{ github.sha }} \
-            -e GITHUB_TOKEN=${{secrets.GH_PA_TOKEN}} \
-            run k6.js

data/examples/simple-api/Gemfile

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'graphql'
-gem 'graphql-hive', path: '../../'
-gem 'puma'
-gem 'rack-contrib'
-gem 'sinatra'
-gem 'sinatra-contrib'

data/examples/simple-api/Gemfile.lock

@@ -1,48 +0,0 @@
-PATH
-  remote: ../..
-  specs:
-    graphql-hive (0.3.3)
-      graphql (~> 2.0.9)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    graphql (2.0.9)
-    multi_json (1.15.0)
-    mustermann (1.1.1)
-      ruby2_keywords (~> 0.0.1)
-    nio4r (2.5.8)
-    puma (5.6.4)
-      nio4r (~> 2.0)
-    rack (2.2.3.1)
-    rack-contrib (2.3.0)
-      rack (~> 2.0)
-    rack-protection (2.2.0)
-      rack
-    ruby2_keywords (0.0.5)
-    sinatra (2.2.0)
-      mustermann (~> 1.0)
-      rack (~> 2.2)
-      rack-protection (= 2.2.0)
-      tilt (~> 2.0)
-    sinatra-contrib (2.2.0)
-      multi_json
-      mustermann (~> 1.0)
-      rack-protection (= 2.2.0)
-      sinatra (= 2.2.0)
-      tilt (~> 2.0)
-    tilt (2.0.10)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  graphql
-  graphql-hive!
-  puma
-  rack-contrib
-  sinatra
-  sinatra-contrib
-
-BUNDLED WITH
-   2.5.15

data/examples/simple-api/app.rb

@@ -1,31 +0,0 @@
-require 'sinatra'
-require 'sinatra/json'
-require 'rack/contrib'
-
-require_relative 'schema'
-
-# Test query:
-#
-# query GetPost($input: [PostInput!]!) {
-#   post(input: $input, test: TEST1) {
-#     title
-#     myId: id
-#   }
-# }
-
-class DemoApp < Sinatra::Base
-  use Rack::JSONBodyParser
-
-  post '/graphql' do
-    result = Schema.execute(
-      params['query'],
-      variables: params[:variables],
-      operation_name: params[:operationName],
-      context: {
-        client_name: 'GraphQL Client',
-        client_version: '1.0'
-      }
-    )
-    json result
-  end
-end

data/examples/simple-api/config.ru

@@ -1,2 +0,0 @@
-require './app'
-run DemoApp

data/examples/simple-api/schema.rb

@@ -1,52 +0,0 @@
-require 'graphql'
-require 'graphql-hive'
-
-module Types
-  class PostType < GraphQL::Schema::Object
-    description 'A blog post'
-    field :id, ID, null: false
-    field :title, String, null: false
-    # fields should be queried in camel-case (this will be `truncatedPreview`)
-    field :truncated_preview, String, null: false
-  end
-end
-
-class Types::PostInput < GraphQL::Schema::InputObject
-  description 'Query Post arguments'
-  argument :id, ID, required: true
-end
-
-class Types::TestEnum < GraphQL::Schema::Enum
-  value 'TEST1'
-  value 'TEST2'
-  value 'TEST3'
-end
-
-class QueryType < GraphQL::Schema::Object
-  description 'The query root of this schema'
-
-  # First describe the field signature:
-  field :post, Types::PostType, 'Find a post by ID' do
-    argument :input, [Types::PostInput]
-    argument :test, Types::TestEnum
-  end
-
-  # Then provide an implementation:
-  def post(input:, test:)
-    { id: 1, title: 'GraphQL Hive with `graphql-ruby`',
-      truncated_preview: 'Monitor operations, inspect your queries and publish your GraphQL schema with GraphQL Hive' }
-  end
-end
-
-class Schema < GraphQL::Schema
-  query QueryType
-
-  use(
-    GraphQL::Hive,
-    buffer_size: 2,
-    token: 'YOUR_TOKEN',
-    debug: true,
-    reporting: { author: 'Charly Poly', commit: '109bb1e748bae21bdfe663c0ffc7e830' },
-    client_info: proc { |context|{ name: context[:client_name], version: context[:client_version] }}
-  )
-end

data/k6/graphql-api/Gemfile

@@ -1,9 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'graphql', '~> 2'
-gem 'graphql-hive', path: '../../'
-gem 'puma', '~> 6'
-gem 'racc'
-gem 'rack-contrib', '~> 2'
-gem 'sinatra', '~> 2'
-gem 'sinatra-contrib'

data/k6/graphql-api/Gemfile.lock

@@ -1,52 +0,0 @@
-PATH
-  remote: ../..
-  specs:
-    graphql-hive (0.4.2)
-      graphql (>= 2.3, < 3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    base64 (0.2.0)
-    graphql (2.3.7)
-      base64
-    multi_json (1.15.0)
-    mustermann (2.0.2)
-      ruby2_keywords (~> 0.0.1)
-    nio4r (2.7.3)
-    puma (6.4.2)
-      nio4r (~> 2.0)
-    racc (1.8.0)
-    rack (2.2.9)
-    rack-contrib (2.5.0)
-      rack (< 4)
-    rack-protection (2.2.4)
-      rack
-    ruby2_keywords (0.0.5)
-    sinatra (2.2.4)
-      mustermann (~> 2.0)
-      rack (~> 2.2)
-      rack-protection (= 2.2.4)
-      tilt (~> 2.0)
-    sinatra-contrib (2.2.4)
-      multi_json
-      mustermann (~> 2.0)
-      rack-protection (= 2.2.4)
-      sinatra (= 2.2.4)
-      tilt (~> 2.0)
-    tilt (2.4.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  graphql (~> 2)
-  graphql-hive!
-  puma (~> 6)
-  racc
-  rack-contrib (~> 2)
-  sinatra (~> 2)
-  sinatra-contrib
-
-BUNDLED WITH
-   2.5.15