stellate 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da10403f9f3b492a01b3235917a2f2b22d47f3bf76069814bbc71058f9ba5215
+  data.tar.gz: c35711a3b7d8190b33ab12d94430943aef000de2d1aa4a37ca0213e1e542195e
+SHA512:
+  metadata.gz: 5e3d1fda26252c534a53384a6bb7cf614a30fb4805d07da6b0999a5ff1a9b2e7f3ca63b31f0c38d1a4235806154d0c3c9ac9bb2cee3e2a1147511444a5d658f2
+  data.tar.gz: a44b57f67ab67cff8f6f88f181449eccd4666de3c9344352b075a74c38bc2ce71ec5b0a6909106560abb441d6765b2c338f79167c2d13c8242d7ea5fe1666600

data/lib/stellate.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'net/http'
+
+module Stellate
+  VERSION = '0.0.1'
+
+  # Extend your GraphQL::Schema with this module to enable easy Stellate
+  # Metrics Logging.
+  #
+  # Add `extend Stellate::MetricsLogging` within your schema class. This will
+  # add the class method `execute_with_logging`. Then replace the call to
+  # `MySchema.execute()` with `MySchema.execute_with_logging()`.
+  module MetricsLogging
+    # Executes a given GraphQL query on the schema and logs details about the
+    # request and execution to Stellate. This function accepts the same
+    # arguments as `GraphQL::Schema.execute()`, and also the following:
+    # - `headers` (`ActionDispatch::Http::Headers`): The HTTP headers from the
+    #   incoming request
+    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))
+
+      ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      elapsed = (ending - starting) * 1000
+
+      unless @stellate_service_name.is_a?(String)
+        puts 'Missing service name in order to log metrics to Stellate'
+        return result
+      end
+
+      unless @stellate_token.is_a?(String)
+        puts 'Missing token in order to log metrics to Stellate'
+        return result
+      end
+
+      unless query_str.is_a?(String)
+        puts 'Cannot log metrics to Stellate without a query string'
+        return result
+      end
+
+      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,
+        "responseSize": response.length,
+        "responseHash": create_blake3_hash(response),
+        "statusCode": 200,
+        "operationName": kwargs[:operation_name]
+      }
+
+      errors = result['errors']
+      payload[:errors] = errors if errors.is_a?(Array)
+
+      headers = kwargs[:headers]
+      if headers.is_a?(ActionDispatch::Http::Headers)
+        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']
+
+      end
+
+      # TODO: make this an async request to avoid blocking the response
+      begin
+        Net::HTTP.post(
+          URI("https://#{@stellate_service_name}.stellate.sh/log"),
+          payload.to_json,
+          'Content-Type' => 'application/json',
+          'Stellate-Logging-Token' => @stellate_token
+        )
+      rescue StandardError => e
+        puts "Failed to log metrics to Stellate: #{e}"
+      end
+
+      result
+    end
+
+    def stellate_service_name
+      @stellate_service_name
+    end
+
+    def stellate_token
+      @stellate_token
+    end
+  end
+
+  # Use this plugin in your GraphQL::Schema to automatically sync your GraphQL
+  # schema with your Stellate service.
+  class SchemaSyncing
+    def self.use(schema)
+      unless schema.stellate_service_name.is_a?(String)
+        puts 'Missing service name in order to sync schema to Stellate'
+        return
+      end
+
+      unless schema.stellate_token.is_a?(String)
+        puts 'Missing token in order to log metrics to Stellate'
+        return
+      end
+
+      introspection = JSON.parse(schema.to_json)['data']
+
+      # TODO: make this an async request to avoid blocking the request
+      begin
+        Net::HTTP.post(
+          URI("https://#{schema.stellate_service_name}.stellate.sh/schema"),
+          { schema: introspection }.to_json,
+          'Content-Type' => 'application/json',
+          'Stellate-Schema-Token' => schema.stellate_token
+        )
+      rescue StandardError => e
+        puts "Failed to sync schema to Stellate: #{e}"
+      end
+    end
+  end
+end
+
+def create_blake3_hash(str)
+  val = 0
+
+  return val if str.empty?
+
+  str.each_byte do |code|
+    val = (val << 5) - val + code
+    val &= 0xffffffff # Int32
+  end
+
+  val >> 0 # uInt32
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: stellate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stellate
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+description: Add Stellate Metrics Logging and Schema Syncing to your GraphQL Ruby
+  API with a few lines of code
+email: eng@stellate.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/stellate.rb
+homepage: https://rubygems.org/gems/stellate
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/StellateHQ/stellate-graphql-ruby/issues
+  homepage_uri: https://rubygems.org/gems/stellate
+  source_code_uri: https://github.com/StellateHQ/stellate-graphql-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: Integrate Stellate with your GraphQL Ruby API
+test_files: []