stellate 0.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e0373037e16a2f147c83f1083499e75f740ec4e92e426ca4382d9855227b1eb
-  data.tar.gz: a1e8ecf717260acb276e5ae32d7997f823830278b48c24f487ab552aed75a77d
+  metadata.gz: 809048748b55d20deecab44e78b8bcb941f4cfd641c841d8757aef749483c8fc
+  data.tar.gz: a6c0540e65c193d0782d5360ac1024fcf8a44a11d81c45072bafc8875058ea30
 SHA512:
-  metadata.gz: 6060f2aa4eed8b6d52f0494496cb9a16bd5471cc88b0c04b1f6d230439071cee1ad228950aaaf819e70755624e74062f19d216b8d3c1a535493a3318808ede28
-  data.tar.gz: 77328738460721879b96ca8fdcd1a45defe31501e6bbaac4e442f31723107d5daae16b46f99feeb8ca47488b9e578d9e72c8019139e4aac26f8514f5a9dc4e3b
+  metadata.gz: 12df26863fbdfe982e1ad5a764504307b7d681d605bc014f248e5aeac273a5b936e54698f99129b738f682182563681ee5331939ec29b55154f570029de94cec
+  data.tar.gz: d6239d0fcabdab1736ec238ea7a0de6faf567251c584e3198ccb4585a805aef3df22a756345fec9a1f2c6f36a70afd342e9994b4fca1117c05fa924837196851

data/lib/stellate.rb

@@ -4,7 +4,7 @@ require 'uri'
 require 'net/http'
 
 module Stellate
-  VERSION = '0.0.3'
+  VERSION = '1.1.0'
 
   # Extend your GraphQL::Schema with this module to enable easy Stellate
   # Metrics Logging.
@@ -18,10 +18,16 @@ module Stellate
     # arguments as `GraphQL::Schema.execute()`, and also the following:
     # - `headers` (`ActionDispatch::Http::Headers`): The HTTP headers from the
     #   incoming request
+    # - `callback` (`Method`): If passed, this will be called with a lambda as
+    #   argument. Calling the passed lambda will log the request to Stellate
+    #   via HTTP. This is useful if you want to move this request into a non-
+    #   blocking process (e.g. using Sidekiq) rather than the default behavior
+    #   of performing a blocking HTTP request which can increase overall
+    #   response times of your API.
     def execute_with_logging(query_str = nil, **kwargs)
       starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
-      result = execute(query_str, **kwargs.except(:service_name, :token, :headers))
+      result = execute(query_str, **kwargs.except(:headers, :callback))
 
       ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       elapsed = (ending - starting) * 1000
@@ -48,14 +54,14 @@ module Stellate
 
       response = result.to_json
       payload = {
-        "operation": query_str,
-        "variableHash": create_blake3_hash(kwargs[:variables].to_json),
-        "method": kwargs[:method].is_a?(String) ? kwargs[:method] : 'POST',
-        "elapsed": elapsed.round,
-        "responseSize": response.length,
-        "responseHash": create_blake3_hash(response),
-        "statusCode": 200,
-        "operationName": kwargs[:operation_name]
+        'operation' => query_str,
+        'variableHash' => create_blake3_hash(kwargs[:variables].to_json),
+        'method' => kwargs[:method].is_a?(String) ? kwargs[:method] : 'POST',
+        'elapsed' => elapsed.round,
+        'responseSize' => response.length,
+        'responseHash' => create_blake3_hash(response),
+        'statusCode' => 200,
+        'operationName' => kwargs[:operation_name]
       }
 
       errors = result['errors']
@@ -65,22 +71,31 @@ module Stellate
         forwarded_for = headers['X-Forwarded-For']
         ips = forwarded_for.is_a?(String) ? forwarded_for.split(',') : []
 
-        payload[:id] = ips[0] || headers['True-Client-Ip'] || headers['X-Real-Ip']
-        payload[:userAgent] = headers['User-Agent']
-        payload[:referer] = headers['referer']
+        payload['ip'] = ips[0] || headers['True-Client-Ip'] || headers['X-Real-Ip']
+        payload['userAgent'] = headers['User-Agent']
+        payload['referer'] = headers['referer']
+        payload['graphqlClientName'] = headers['x-graphql-client-name']
+        payload['graphqlClientVersion'] = headers['x-graphql-client-version']
       end
 
-      # TODO: make this an async request to avoid blocking the response
-      begin
-        res = Net::HTTP.post(
-          URI("https://#{@stellate_service_name}.stellate.sh/log"),
-          payload.to_json,
+      stellate_request = {
+        'url' => "https://#{@stellate_service_name}.stellate.sh/log",
+        'headers' => {
           'Content-Type' => 'application/json',
           'Stellate-Logging-Token' => @stellate_token
-        )
-        puts "Failed to log metrics to Stellate: #{res.body}" if res.code.to_i >= 300
-      rescue StandardError => e
-        puts "Failed to log metrics to Stellate: #{e}"
+        },
+        'body' => payload.to_json
+      }
+
+      callback = kwargs[:callback]
+      # The former check handles methods, the latter handles lambdas
+      if callback.is_a?(Method) || callback.respond_to?(:call)
+        callback.call(stellate_request)
+      # This handles symbols that contain methods
+      elsif callback.is_a?(Symbol) && method(callback).is_a?(Method)
+        method(callback).call(stellate_request)
+      else
+        run_stellate_request(stellate_request)
       end
 
       result
@@ -98,7 +113,15 @@ module Stellate
   # Use this plugin in your GraphQL::Schema to automatically sync your GraphQL
   # schema with your Stellate service.
   class SchemaSyncing
-    def self.use(schema)
+    # The first argument is the GraphQLSchema class that this plugin is used
+    # on. It accepts the following names arguments:
+    # - `callback` (`Method`): If passed, this will be called with a lambda as
+    #   argument. Calling the passed lambda will sync the schema to Stellate
+    #   via HTTP. This is useful if you want to move this request into a non-
+    #   blocking process (e.g. using Sidekiq) rather than the default behavior
+    #   of performing a blocking HTTP request which can increase overall
+    #   response times of your API.
+    def self.use(schema, **kwargs)
       unless schema.stellate_service_name.is_a?(String)
         puts 'Missing service name in order to sync schema to Stellate'
         return
@@ -111,20 +134,44 @@ module Stellate
 
       introspection = JSON.parse(schema.to_json)['data']
 
-      # TODO: make this an async request to avoid blocking the request
-      begin
-        res = Net::HTTP.post(
-          URI("https://#{schema.stellate_service_name}.stellate.sh/schema"),
-          { schema: introspection }.to_json,
+      stellate_request = {
+        'url' => "https://#{schema.stellate_service_name}.stellate.sh/schema",
+        'headers' => {
           'Content-Type' => 'application/json',
           'Stellate-Schema-Token' => schema.stellate_token
-        )
-        puts "Failed to sync schema to Stellate: #{res.body}" if res.code.to_i >= 300
-      rescue StandardError => e
-        puts "Failed to sync schema to Stellate: #{e}"
+        },
+        'body' => { schema: introspection }.to_json
+      }
+
+      callback = kwargs[:callback]
+      # The former check handles methods, the latter handles lambdas
+      if callback.is_a?(Method) || callback.respond_to?(:call)
+        callback.call(stellate_request)
+      # This handles symbols that contain methods
+      elsif callback.is_a?(Symbol) && method(callback).is_a?(Method)
+        method(callback).call(stellate_request)
+      else
+        run_stellate_request(stellate_request)
       end
     end
   end
+
+  def self.run_stellate_request(stellate_request)
+    url = URI.parse(stellate_request['url'])
+
+    http = Net::HTTP.new(url.host, url.port)
+    http.use_ssl = true
+
+    req = Net::HTTP::Post.new(url)
+    stellate_request['headers'].each do |key, value|
+      req[key] = value
+    end
+    req.body = stellate_request['body']
+    res = http.request(req)
+    puts "HTTP request to Stellate failed: #{res.body}" if res.code.to_i >= 300
+  rescue StandardError => e
+    puts "HTTP request to Stellate failed: #{e}"
+  end
 end
 
 def create_blake3_hash(str)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stellate
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Stellate
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-14 00:00:00.000000000 Z
+date: 2024-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http