graphql-hive 0.5.5 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55636339f69a586dda19a600c2c0a3c3670e083364aea42558e3b381d0a77b64
-  data.tar.gz: a6f7f85ddfb29cdb5d1972b2a6ed8d637df307e94bcad085bfe2d9cd5ab238e1
+  metadata.gz: 49d7ea84eecb7ee527720752d5fed3179acfdc56a97abf71e7e009e79c860a00
+  data.tar.gz: 5f69430570fe93bf637be7726fecf57fb396243a177c1705130b0f8b5c4cef6e
 SHA512:
-  metadata.gz: 07f57ac64ef24e78f5f6d0b7a2e26379aadad3a69ea3d3b20551956dc061dcf0cd8112e1b62221edc25785ee824d1de36deb11d6723ec7dc0410971693c0811b
-  data.tar.gz: 0f546b892c6dcf204d25404a986e11682776897bb14ed5e3ed1090b61720e2440e6a3b90760c216a7d6e0c1d4071fc6df5a5f4147738d7c14e8a2a81c86ef5dc
+  metadata.gz: d215ba7482205e18466b32d53f46fd9b2fcc18b3b0e144f5e824f844e856c904ab47d22153250f9529c44a3c3fea1ce4bdbccb548135018f61735e555c3d9825
+  data.tar.gz: b46ea3f3660e53d5c62e0c50b14f101740887d0b8256e4bada10f41cac540de632866bb039a6e9d66a9a3e444ee7684d9a960ea70cfb66a7b92872e29aee8e2a

data/Gemfile.lock

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

data/README.md

@@ -28,6 +28,10 @@
 
 If you are using Hive as a service, please refer to our documentation: https://docs.graphql-hive.com/features/tokens.
 
+### Organization-level tokens
+
+If you are using an organization-level access token (tokens starting with `hvo1/`), you must also provide a `target` parameter to specify which target the usage data should be reported to. See the [organization access tokens documentation](https://the-guild.dev/graphql/hive/docs/migration-guides/organization-access-tokens#usage-data-reporting) for more details.
+
 ## 1. Install the `graphql-hive` gem
 
 ```
@@ -48,6 +52,8 @@ class Schema < GraphQL::Schema
       GraphQL::Hive,
       {
         token: '<YOUR_TOKEN>',
+        # target is only needed if you're using an organization level token
+        target: 'your-org/your-project/production', # or target UUID
         reporting: {
           author: ENV['GITHUB_USER'],
           commit: ENV['GITHUB_COMMIT']
@@ -148,6 +154,9 @@ class MySchema < GraphQL::Schema
     {
       # Token is the only required configuration value.
       token: 'YOUR-REGISTRY-TOKEN',
+      # Target is required when using organization-level tokens (tokens starting with 'hvo1/').
+      # Can be a target slug (e.g., 'org/project/target') or target UUID.
+      target: 'your-org/your-project/production',
       #
       # The following are optional configuration values.
       #
@@ -157,6 +166,10 @@ class MySchema < GraphQL::Schema
       debug: false,
       # A custom logger.
       logger: MyLogger.new,
+      # Log request details at info level (default: false, logs at debug level). Details include request type, request path, and a unique request ID.
+      log_request_details: false,
+      # Log Hive errors (unsuccessful responses and exceptions) as warnings instead of errors (default: false, logs as errors).
+      warn_on_hive_errors: false,
       # 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,

data/lib/graphql-hive/client.rb

@@ -12,28 +12,36 @@ module GraphQL
       end
 
       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",
-            path: path
-          )
+        path = path.to_s
+        if path == "/usage" && @options[:target] && @options[:target] != ""
+          path = "/usage/#{@options[:target]}"
+        end
 
+        scheme = (@options[:port].to_s == "443") ? "https" : "http"
+        endpoint = @options[:endpoint] || "app.graphql-hive.com"
+        uri = URI::HTTP.build(
+          scheme: scheme,
+          host: endpoint,
+          port: @options[:port] || "443",
+          path: path
+        )
         http = setup_http(uri)
         request = build_request(uri, body)
+
+        log_request(request, scheme, endpoint, path)
+
         response = http.request(request)
 
         code = response.code.to_i
         if code >= 400 && code < 500
           error_message = "Unsuccessful response: #{response.code} - #{response.message}"
-          @options[:logger].warn("#{error_message} #{extract_error_details(response)}")
+          log_error("#{error_message} #{extract_error_details(response)}")
         end
 
         @options[:logger].debug(response.inspect)
         @options[:logger].debug(response.body.inspect)
       rescue => e
-        @options[:logger].fatal("Failed to send data: #{e}")
+        log_error("Failed to send data: #{e}")
       end
 
       def setup_http(uri)
@@ -45,16 +53,27 @@ module GraphQL
 
       def build_request(uri, body)
         request = Net::HTTP::Post.new(uri.request_uri)
-        request["Authorization"] = @options[:token]
+        request["Authorization"] = "Bearer #{@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["X-Request-Id"] = SecureRandom.uuid
         request.body = JSON.generate(body)
         request
       end
 
+      def log_request(request, scheme, endpoint, path)
+        log_message = "#{request.method} #{scheme}://#{endpoint}#{path} request id: #{request["X-Request-Id"]}"
+
+        if @options[:log_request_details]
+          @options[:logger].info(log_message)
+        else
+          @options[:logger].debug(log_message)
+        end
+      end
+
       def extract_error_details(response)
         parsed_body = JSON.parse(response.body)
         return unless parsed_body.is_a?(Hash) && parsed_body["errors"].is_a?(Array)
@@ -62,6 +81,14 @@ module GraphQL
       rescue JSON::ParserError
         "Could not parse response from Hive"
       end
+
+      def log_error(message)
+        if @options[:warn_on_hive_errors]
+          @options[:logger].warn(message)
+        else
+          @options[:logger].error(message)
+        end
+      end
     end
   end
 end

data/lib/graphql-hive/version.rb

@@ -2,6 +2,6 @@
 
 module Graphql
   module Hive
-    VERSION = "0.5.5"
+    VERSION = "0.6.2"
   end
 end

data/lib/graphql-hive.rb

@@ -39,7 +39,10 @@ module GraphQL
       buffer_size: 50,
       queue_size: 1000,
       logger: nil,
-      collect_usage_sampling: 1.0
+      collect_usage_sampling: 1.0,
+      target: nil,
+      log_request_details: false,
+      warn_on_hive_errors: false
     }.freeze
 
     self.platform_keys = {
@@ -141,10 +144,14 @@ module GraphQL
         }
         options[:logger].level = options[:debug] ? Logger::DEBUG : Logger::INFO
       end
-      if !options.include?(:token) && (!options.include?(:enabled) || options.enabled)
+      if !options.include?(:token) && (!options.include?(:enabled) || options[:enabled])
         options[:logger].warn("`token` options is missing")
         options[:enabled] = false
         false
+      elsif options[:token]&.start_with?("hvo1/") && (options[:target].nil? || options[:target] == "")
+        options[:logger].warn("Organization-level token detected but `target` option is missing. Target must be specified for organization-level tokens.")
+        options[:enabled] = false
+        false
       elsif options[:report_schema] &&
           (
             !options.include?(:reporting) ||
@@ -168,18 +175,25 @@ module GraphQL
     def send_report_schema(schema)
       sdl = GraphQL::Schema::Printer.new(schema).print_schema
 
+      input = {
+        sdl: sdl,
+        author: @options[:reporting][:author],
+        commit: @options[:reporting][:commit],
+        service: @options[:reporting][:service_name],
+        url: @options[:reporting][:service_url],
+        force: true
+      }
+
+      # Add target for organization-level tokens
+      if @options[:target]
+        input[:target] = @options[:target]
+      end
+
       body = {
         query: REPORT_SCHEMA_MUTATION,
         operationName: "schemaPublish",
         variables: {
-          input: {
-            sdl: sdl,
-            author: @options[:reporting][:author],
-            commit: @options[:reporting][:commit],
-            service: @options[:reporting][:service_name],
-            url: @options[:reporting][:service_url],
-            force: true
-          }
+          input: input
         }
       }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-hive
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.2
 platform: ruby
 authors:
 - Charly POLY
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-14 00:00:00.000000000 Z
+date: 2025-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: '"GraphQL Hive integration for `graphql-ruby`"'