hubburu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4294b581d969d8d728290533d3b5e155560aa25f453cc756b49b703332431cf6
+  data.tar.gz: 1a372e3399431a3c73595369dc1518f2ca563afa37258bfef11a0541a63dcd52
+SHA512:
+  metadata.gz: 3744e70c6f024bde95444aa1d84ae09b19b898e2398538881c6371f1c511d787dee271423e7349e0dd7f3baec1c9d0e2ff5ed4d34ab72f67f290c0f6551853be
+  data.tar.gz: 7c98bd76709c2c9d0ae5fd4691cea745bd18cafd53b13221166f04f9520bc00340aa3136aac60c6f327861d9a1515d539e44c1a3d83e4fbae5c0acbf9c730085

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-06-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at fredrikkadolfsson@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hubburu.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    hubburu (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (1.30.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  hubburu!
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Fredrik Adolfsson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+[![Gem Version](https://badge.fury.io/rb/hubburu.svg)](https://rubygems.org/gems/hubburu)
+
+# GraphQL Ruby Hubburu Plugin
+
+A tracer for integrating Hubburu with GraphQL Ruby
+
+## Installation
+
+Install by adding it to your Gemfile, then bundling.
+
+```
+# Gemfile
+gem 'hubburu'
+```
+
+## Usage
+
+These are the integration points you need to make to integrate with Hubburu.
+
+1. Add your API key
+2. Upload schema SDL to Hubburu
+3. Send operation reports to Hubburu
+
+### Adding Your API Key
+
+Register for Hubburu, and you will be able to access your API Key from there. The recommended way is to add it to your environment variables. You can also add it manually to the Hubburu SDK calls.
+
+### Upload schema
+
+Either you can upload your schema on server startup. This is an OK way to do it but not suitable for all environments. If you want to manually send it (such as in a CI/CD pipeline), you can do so like this:
+
+```ruby
+namespace :hubburu do
+  desc "register new schema version with hubburu"
+  task register: :environment do
+    api_key = ENV["HUBBURU_API_KEY"]
+    environment = ENV["HUBBURU_ENVIRONMENT"] || "default"
+
+    response = Hubburu.push_hubburu_schema(YOUR_SCHEMA, api_key, environment)
+    response_code = response.code.to_i
+
+    unless response_code >= 200 && response_code < 300
+      raise "Failed to upload schema to Hubburu (status #{response_code})"
+    end
+  end
+end
+```
+
+### Send operation reports
+
+This is done by adding the Hubburu tracer to the GraphQL schema.
+
+```ruby
+require "hubburu"
+
+class AppSchema < GraphQL::Schema
+  ...
+
+  use(Hubburu, request_id_context_key: :request_id)
+
+  use(Hubburu,
+    request_id_context_key: :request_id,
+    queue_method: ->(path, body, headers) { YOUR_ASYNCHRONOUS_WORKER_METHOD(path, body, headers) })
+
+  ...
+end
+
+```
+
+`request_id_context_key` & `queue_method` are optional. Omitting `queue_method` will send Hubburu reports immediate. Adding an asynchronous worker will allow you to configure queueing of the report sendouts. Example of a Sidekiq worker:
+
+```ruby
+class HubburuUploadWorker
+  include Sidekiq::Worker
+  sidekiq_options queue: :low
+
+  def perform(url, body, headers)
+    Faraday.post(url, body, headers)
+  end
+end
+```
+
+## Development & Testing
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+This plugin is being developed and tested in another repository. You are welcome to send bug reports either as an issue on Github or to [hello@hubburu.com](mailto:hello@hubburu.com).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/hubburu/tracer.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+module Hubburu
+  class Tracer
+    MAX_ERROR_BYTES = 1_000
+
+    def initialize(
+      schema,
+      api_key: Hubburu.api_key,
+      environment: Hubburu.environment,
+      push_schema_on_startup: false,
+      request_id_context_key: nil,
+      should_send: nil
+    )
+      @api_key = api_key
+      @environment = environment
+      @request_id_context_key = request_id_context_key
+      @schema_sha = sha256(GraphQL::Schema::Printer.print_schema(schema))
+      @should_send = should_send
+      @headers = {
+        "X-Api-Key" => @api_key,
+        "Content-Type" => "application/json"
+      }
+
+      @query_signature = query_signature || proc do |query|
+        query.query_string
+      end
+
+      Hubburu.push_hubburu_schema(schema, @api_key, @environment) if push_schema_on_startup
+    end
+
+    attr_reader :query_signature
+
+    def trace(key, data)
+      case key
+      when "validate"
+        result = yield
+
+        query = data.fetch(:query)
+        query.context.namespace(self.class).merge!(
+          requestId: query.context[@request_id_context_key],
+          operationName: query.operation_name,
+          gzippedOperationBody: Hubburu.gzip(query_signature.call(query)),
+          schemaHash: @schema_sha,
+          errors: result.to_h.fetch(:errors).map { |e| { message: e.message } },
+          environment: @environment,
+          start_time_nanos: nanos_now,
+          clientName: query.context[:client_name],
+          clientVersion: query.context[:client_version],
+          meta: {}
+        )
+      when "execute_query"
+        begin
+          result = yield
+        rescue StandardError => e
+          query = data.fetch(:query)
+          report = query.context.namespace(self.class)
+          begin
+            report[:errors].push(message: e.respond_to?(:message) ? "[#{e.class.name}] #{e.message}" : e.class.name,
+                                 details: e.backtrace.take(10).join('\n\n'))
+          rescue StandardError => e
+            warn "HUBBURU_FORMAT_ERROR #{e}"
+          end
+          send(report, query)
+          raise e
+        end
+      when "execute_query_lazy"
+        begin
+          result = yield
+        rescue StandardError => e
+          query = data.fetch(:query)
+          report = query.context.namespace(self.class)
+          begin
+            report[:errors].push(message: e.respond_to?(:message) ? "[#{e.class.name}] #{e.message}" : e.class.name,
+                                 details: e.backtrace.take(10).join('\n\n'))
+          rescue StandardError => e
+            warn "HUBBURU_FORMAT_ERROR #{e}"
+          end
+          send(report, query)
+          raise e
+        end
+
+        query = data.fetch(:query)
+        report = query.context.namespace(self.class)
+        if query.static_errors.present?
+          begin
+            query.static_errors.each do |static_error|
+              report[:errors].push(message: static_error.message,
+                                   details: static_error.respond_to?(:path) ? static_error.path : nil)
+            end
+          rescue StandardError => e
+            warn "HUBBURU_FORMAT_ERROR #{e}"
+          end
+        end
+        send(report, query)
+      else
+        result = yield
+      end
+
+      result
+    end
+
+    def send(report, query)
+      begin
+        return if @should_send && !@should_send.call(report)
+      rescue StandardError => e
+        warn "hubburu should_send lambda raised error #{e}"
+      end
+
+      post_processing_start = nanos_now
+
+      if report[:start_time_nanos]
+        report[:totalMs] = to_report_ms(nanos_now - report[:start_time_nanos])
+        report.delete(:start_time_nanos)
+      end
+      report[:createdAt] = Time.now.utc.iso8601
+      errors = report[:errors]
+      if errors.empty?
+        report.delete(:errors)
+      else
+        report[:errors] = Hubburu.gzip(errors.to_json)
+      end
+
+      errors_too_large = !(report[:errors] && report[:errors].bytesize > MAX_ERROR_BYTES).nil?
+
+      if errors_too_large
+        report[:errors] = Hubburu.gzip(errors.take(5).to_json)
+        report[:meta][:errorsTooLarge] = errors.size
+      end
+
+      report[:enums] = {}
+      context = query.context
+      schema = context.schema
+      begin
+        query.selected_operation.variables.each do |ast_variable|
+          variable_name = ast_variable.name
+          variable_type = schema.type_from_ast(ast_variable.type, context: context)
+          provided_value = query.provided_variables[variable_name]
+
+          case variable_type.kind.name
+          when "NON_NULL", "LIST", "INPUT_OBJECT"
+            trace_type_enums(variable_type, provided_value, report[:enums])
+          when "ENUM"
+            type_name = variable_type.to_type_signature
+
+            report[:enums][type_name] ||= []
+            report[:enums][type_name] |= [provided_value]
+          end
+        end
+      rescue StandardError => e
+        warn "HUBBURU_ENUM_ERROR #{e}"
+      end
+
+      report[:meta][:postProcessingTime] = to_report_ms(nanos_now - post_processing_start)
+
+      trace = report.to_json
+
+      Hubburu.send("/operation", trace, @headers) if @api_key
+    rescue StandardError => e
+      warn "HUBBURU_SEND_ERROR #{e}"
+    end
+
+    private
+
+    def trace_type_enums(type, provided_value, enums)
+      case type.kind.name
+      when "NON_NULL"
+        trace_type_enums(type.of_type, provided_value, enums)
+      when "LIST"
+        provided_value.each do |value|
+          trace_type_enums(type.of_type, value, enums)
+        end
+      when "INPUT_OBJECT"
+        type.arguments.each do |argument_name, argument_value|
+          next unless provided_value[argument_name]
+
+          trace_type_enums(argument_value.type, provided_value[argument_name], enums)
+        end
+      when "ENUM"
+        type_name = type.to_type_signature
+
+        enums[type_name] ||= []
+        enums[type_name] |= [provided_value]
+      end
+    end
+
+    def to_report_ms(nanos)
+      (nanos / 10_000) / 100.0
+    end
+
+    def nanos_now
+      Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
+    end
+
+    def sha256(data)
+      Digest::SHA256.hexdigest(data)
+    end
+  end
+end

data/lib/hubburu/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Hubburu
+  VERSION = "0.1.0"
+end

data/lib/hubburu.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative "hubburu/tracer"
+require_relative "hubburu/version"
+
+module Hubburu
+  def self.use(schema, options = {})
+    @queue_method = options[:queue_method]
+    options.delete(:queue_method)
+
+    schema.tracer(Hubburu::Tracer.new(schema, **options))
+  end
+
+  def self.push_hubburu_schema(schema, api_key = Hubburu.api_key, environment = Hubburu.environment)
+    unless api_key
+      warn "HUBBURU_SEND_ERROR missing api_key"
+      return
+    end
+
+    Hubburu.send(
+      "/schema",
+      {
+        sdl: Hubburu.gzip(GraphQL::Schema::Printer.print_schema(schema)),
+        environment: environment
+      }.to_json,
+      {
+        "X-Api-Key" => api_key,
+        "Content-Type" => "application/json"
+      }
+    )
+  end
+
+  def self.api_key
+    @api_key ||= ENV["HUBBURU_API_KEY"]
+  end
+
+  def self.report_url
+    @report_url ||= ENV["HUBBURU_REPORT_URL"] || "https://report.hubburu.com"
+  end
+
+  def self.environment
+    @environment ||= ENV["HUBBURU_ENVIRONMENT"] || "default"
+  end
+
+  def self.gzip(data)
+    output = StringIO.new
+    gz = Zlib::GzipWriter.new(output)
+    gz.write(data)
+    gz.close
+    Base64.encode64(output.string)
+  end
+
+  def self.send(path, body, headers)
+    if @queue_method
+      @queue_method.call(
+        Hubburu.report_url + path,
+        body,
+        headers
+      )
+    else
+      Net::HTTP.post(
+        URI(Hubburu.report_url + path),
+        body,
+        headers
+      )
+    end
+  end
+end

data/sig/hubburu.rbs

@@ -0,0 +1,4 @@
+module Hubburu
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: hubburu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hello@hubburu.com
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-26 00:00:00.000000000 Z
+dependencies: []
+description: A tracer for integrating Hubburu with GraphQL Ruby
+email:
+- hello@hubburu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/hubburu.rb
+- lib/hubburu/tracer.rb
+- lib/hubburu/version.rb
+- sig/hubburu.rbs
+homepage: https://www.hubburu.com/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.hubburu.com/
+  source_code_uri: https://github.com/hubburu/ruby-plugin
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: A tracer for integrating Hubburu with GraphQL Ruby
+test_files: []