eltesla 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d5a5688dc14f783b38a944c3e29088ee53343beab09b3a7dd0a4d59a54eadcc
+  data.tar.gz: 39b89807a086e30b1b0d680975a29a3f657591e82e192b9709fc4c91388d3487
+SHA512:
+  metadata.gz: b263b136234020ac7b6e88b7493131b2f815120409b36b1c6bd51d1d873adae29a4456e05a6e1613150fe4fbbb72d6c9f65e49be6a49e54963673749fe6a3036
+  data.tar.gz: 1b935e5420b4720c16be076184c13a32ba98f597043bc32b9dd4fbecaf74dcd99a9670ba7765354908e86864db976380c038beec17bb346e3ff4bed2f455b91a

data/lib/eltesla/client.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Eltesla
+  # Client for the Eltesla backend
+  class Client
+    if ENV.fetch('ELTESLA_DEBUG', false)
+      PROTOCOL = 'http'
+      DOMAIN = 'localhost:3000'
+      QUEUE_SIZE_THRESHOLD = 1
+      QUEUE_SIZE_LIMIT = 2
+    else
+      PROTOCOL = 'https'
+      DOMAIN = 'eltesla.dev'
+      QUEUE_SIZE_THRESHOLD = 10
+      QUEUE_SIZE_LIMIT = 20
+    end
+    ENDPOINT = URI.parse("#{PROTOCOL}://#{DOMAIN}/metrics")
+
+    class << self
+      attr_writer :queue
+
+      def queue
+        @queue ||= []
+      end
+
+      def send(result)
+        raise "Could not process #{result}" unless result.is_a?(Eltesla::Result)
+
+        queue << result
+        flush! if queue.size >= QUEUE_SIZE_THRESHOLD
+      end
+
+      def flush!
+        return if queue.empty?
+
+        http_post!
+        queue.clear
+      rescue StandardError => e
+        warn "[Eltesla] Could not send payload: #{e.message}"
+        if queue.size > QUEUE_SIZE_LIMIT
+          warn("[Eltesla] Dropping #{queue.size - QUEUE_SIZE_LIMIT} results from the queue")
+          self.queue = queue[-QUEUE_SIZE_LIMIT..]
+        end
+      end
+
+      private
+
+      def http_post!
+        http = Net::HTTP.new(ENDPOINT.host, ENDPOINT.port)
+        request = Net::HTTP::Post.new(
+          ENDPOINT.request_uri,
+          { 'Content-Type': 'application/json' }
+        )
+        request.body = { results: queue }.to_json
+
+        http.request(request).value
+      end
+    end
+  end
+end
+
+# rubocop:disable Style/GlobalVars
+$eltesla_exit_callback ||= at_exit { Eltesla::Client.flush! }
+# rubocop:enable Style/GlobalVars
+

data/lib/eltesla/experiment.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'scientist/experiment'
+require 'eltesla/result'
+
+module Eltesla
+  # Github scientist experiment implementation for Eltesla
+  class Experiment
+    include Scientist::Experiment
+
+    attr_reader :name, :file, :line
+
+    def initialize(name)
+      location_parts = clean_trace(caller).first.split(/:/)
+      @file = location_parts.first
+      @line = location_parts[1].to_i
+      @name = name || location_parts.last[4..-2]
+    end
+
+    def enabled?
+      # FIXME : Add activation policies
+      true
+    end
+
+    def raised(operation, error)
+      # see "In a Scientist callback" below
+      p "Operation '#{operation}' failed with error '#{error.inspect}'"
+      super # will re-raise
+    end
+
+    def publish(result)
+      Eltesla::Client.send(result.to_eltesla)
+    end
+
+    def clean_trace(backtrace)
+      return backtrace unless defined?(Rails.backtrace_cleaner)
+
+      Rails.backtrace_cleaner.clean(backtrace)
+    end
+
+    def self.run(name = nil)
+      raise 'Missing block' unless block_given?
+
+      experiment = Eltesla::Experiment.new(name)
+      yield(experiment)
+      experiment.run
+    end
+  end
+end

data/lib/eltesla/observation.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'scientist'
+
+module Eltesla
+  # rubocop:disable Naming/ConstantName
+  OBSERVATION_ATTRIBUTES = %i[
+    name
+    value
+    duration
+    exception_class
+    exception_message
+    exception_backtrace
+  ].freeze
+
+  Observation =
+    if defined?(Data.define)
+      Data.define(*OBSERVATION_ATTRIBUTES)
+    else
+      Struct.new(*OBSERVATION_ATTRIBUTES, keyword_init: true)
+    end
+
+  Scientist::Observation.define_method(:to_eltesla) do
+    Eltesla::Observation.new(
+      exception_class: exception&.class&.name,
+      exception_message: exception&.message,
+      exception_backtrace: exception&.backtrace,
+      name:,
+      value:,
+      duration:
+    )
+  end
+  # rubocop:enable Naming/ConstantName
+end

data/lib/eltesla/result.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'scientist'
+require_relative 'observation'
+
+module Eltesla
+  # rubocop:disable Naming/ConstantName
+  RESULT_ATTRIBUTES = %i[
+    observations_attributes
+    context
+    matched
+    executed_at
+    experiment_name
+    experiment_file
+    experiment_line
+  ].freeze
+
+  Result =
+    if defined?(Data.define)
+      Data.define(*RESULT_ATTRIBUTES)
+    else
+      Struct.new(*RESULT_ATTRIBUTES, keyword_init: true)
+    end
+
+  Scientist::Result.define_method(:to_eltesla) do
+    Eltesla::Result.new(
+      experiment_name: experiment.name,
+      experiment_file: experiment.file,
+      experiment_line: experiment.line,
+      context: context.empty? ? nil : context,
+      matched: matched?,
+      executed_at: Time.now,
+      observations_attributes: observations.map(&:to_eltesla)
+    )
+  end
+  # rubocop:enable Naming/ConstantName
+end

data/lib/eltesla/version.rb

@@ -0,0 +1,3 @@
+module Eltesla
+  VERSION = '0.0.1'
+end

data/lib/eltesla.rb

@@ -0,0 +1,10 @@
+
+require 'scientist'
+require 'eltesla/observation'
+require 'eltesla/result'
+require 'eltesla/experiment'
+require 'eltesla/client'
+
+module Eltesla
+  warn 'Eltesla is loaded, and rebuilt!'
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: eltesla
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexandre Ignjatovic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: scientist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Client for the Eltesla service, for easier refactoring
+email: alexandre.ignjatovic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/eltesla.rb
+- lib/eltesla/client.rb
+- lib/eltesla/experiment.rb
+- lib/eltesla/observation.rb
+- lib/eltesla/result.rb
+- lib/eltesla/version.rb
+homepage: https://eltes.la
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+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: 'Eltesla: GitHub Scientist as a Service.'
+test_files: []