infield 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f31b7037fa451372f99dbdd746e5732f5c377150f57aa12fe2b9864812fdfff
-  data.tar.gz: 95b3da1a0ba4f633deaa8161b05105d92d90e309201c7feb3d87fd05507eeae7
+  metadata.gz: 26abdd8a8407a04b1627a2e4df94c3e2ecca434334dfadd6b776b876f8fe1fac
+  data.tar.gz: 868a9bb4fcedec09f7296a6f1ab2e34c409d151c9d33ff4542ef498064c5b1d7
 SHA512:
-  metadata.gz: 91baa2990a521179d6c90f9e532a212fcb7029cc6bddf7115c086462f18022ddcc69e8d427c3da01d2057e3967328978db7640f9d87c1f44340e7d8819191597
-  data.tar.gz: 47df1183a08550649198745bfb0e1fea88493b61f31d025e52106e9aceed1f1acb9c043417a3eda50850b15c7e18c74c94b5d43dccbd49dc389a11136dc59638
+  metadata.gz: cf41bdccf63f87eaf3feb2e947a9e00ea51c33f37d0ef0e76260395035ecf9d488e21f3fa7966cced8eda3aec453cab664299df6a55a69ac6130571be744ab3f
+  data.tar.gz: 91a721071942764b19342fd80e53281b24f03a3fa77cd01580d98aa75eff7da18b5a4b6d0844ad885b5e506133c6f3493ead8a49a1dd47700b7cdb7db4d1b47a

data/.ruby-version

@@ -1 +1 @@
-3.2.3
+3.2.3

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -1,3 +1,40 @@
 # Infield
 
-This gem handles reporting deprecation warnings to Infield.
+This gem handles reporting deprecation warnings to Infield from a Rails app.
+
+## Setup
+
+You'll need an API key and repo environment ID to use this gem. Get your API key from https://app.infield.ai/settings/api_key and your environment ID from the environments configuration page.
+
+Add the gem to your gemfile:
+
+    gem 'infield', require: false
+
+Then in `config/application.rb`:
+
+    if ENV['INFIELD_API_KEY']
+      require 'infield'
+      Infield.run(api_key: ENV['INFIELD_API_KEY'],
+                  repo_environment_id: ENV['INFIELD_REPO_ENVIRONMENT_ID')
+    end
+
+And in any environment you want to profile from:
+
+    config.active_support.deprecation = :notify
+
+## Configuration options
+
+The infield gem batches requests and sends them asyncronously. You can configure the following options to `Infield.run` (defaults shown here):
+
+    Infield.run(
+        api_key: key, # required
+        repo_environment_id: id, # required
+        sleep_interval: 5, # seconds, # how long to sleep between processing events
+        batch_size: 10, # how many events to batch in one API request to Infield
+        queue_limit: 30 # If more than this number of events come in in sleep_interval, any over are dropped
+    )
+
+## Test environment notes
+
+If you enable this gem in test and use another gem to block all web
+calls in your test environment, make sure to allow access to `app.infield.ai`.

data/lib/infield/deprecation_warning.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require 'thread'
-require 'json'
-require 'net/http'
-
 module Infield
   # Takes in new deprecation warnings and sends them to the Infield API
   # in batches
@@ -22,9 +18,10 @@ module Infield
       ].freeze
 
       class << self
-        attr_reader :queue
+        attr_reader :queue, :thread
 
         def enqueue(message)
+          @queue ||= Queue.new
           return if @queue.size >= @queue_limit
           @queue << message
         end
@@ -37,7 +34,7 @@ module Infield
           @queue_limit = queue_limit
           @batch_size = batch_size # send up to 20 messages to API at once
 
-          Thread.new do
+          @thread = Thread.new do
             loop do
               sleep(@sleep_interval)
               next if @queue.empty?

data/lib/infield/heartbeat.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+require 'debug'
+
+module Infield
+  module Heartbeat
+    module Runner
+      class << self
+        attr_reader :thread
+
+        def run(interval: 60)
+          @thread = Thread.new do
+            loop do
+              if DeprecationWarning::Runner.thread&.alive?
+                send_heartbeat
+              else
+                stop
+                break
+              end
+              sleep(interval)
+            end
+          end
+        end
+
+        def stop
+          @thread&.kill
+        end
+
+        private
+
+        def send_heartbeat
+          uri = URI.parse(Infield.infield_api_url)
+          Net::HTTP.start(uri.host, uri.port, use_ssl: (uri.scheme == 'https')) do |http|
+            http.post('/api/heartbeats',
+                    {
+                      repo_environment_id: Infield.repo_environment_id,
+                      environment: Infield.environment,
+                    }.to_json,
+                    {
+                      'Content-Type' => 'application/json',
+                      'Authorization' => "bearer #{Infield.api_key}"
+                    })
+          end
+        rescue *DeprecationWarning::Runner::HTTP_ERRORS => e
+        end
+      end
+    end
+  end
+end

data/lib/infield/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Infield
-  VERSION = '0.1.7'
+  VERSION = '0.2.0'
 end

data/lib/infield.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require 'thread'
+require 'json'
+require 'net/http'
+
 require_relative 'infield/version'
 
 # require_relative 'infield/core_ext'
@@ -9,11 +13,12 @@ module Infield
   Error = Class.new(StandardError)
 
   autoload :DeprecationWarning, "#{__dir__}/infield/deprecation_warning.rb"
+  autoload :Heartbeat, "#{__dir__}/infield/heartbeat.rb"
 
   class << self
     attr_accessor :api_key, :repo_environment_id, :environment, :infield_api_url
 
-    def run(api_key: nil, repo_environment_id: nil, environment: nil, sleep_interval: 5, batch_size: 10, queue_limit: 30)
+    def run(api_key: nil, repo_environment_id: nil, environment: nil, sleep_interval: 5, batch_size: 10, queue_limit: 30, heartbeat_interval: 600)
       @api_key = api_key || ENV['INFIELD_API_KEY']
       @repo_environment_id = repo_environment_id
       @infield_api_url = ENV['INFIELD_API_URL'] || 'https://app.infield.ai'
@@ -21,7 +26,16 @@ module Infield
       raise 'repo_environment_id is required' unless @repo_environment_id
 
       @environment = environment || defined?(Rails) ? Rails.env : nil
+
+      # Start the deprecation warning processor
       DeprecationWarning::Runner.run(sleep_interval: sleep_interval, batch_size: batch_size, queue_limit: queue_limit)
+
+      # Start the heartbeat
+      Heartbeat::Runner.run(interval: heartbeat_interval)
+    end
+
+    def shutdown
+      Heartbeat::Runner.stop
     end
   end
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: infield
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Infield
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-16 00:00:00.000000000 Z
-dependencies: []
+date: 2024-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - support@infield.ai
@@ -21,6 +49,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
+- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -28,6 +57,7 @@ files:
 - lib/infield.rb
 - lib/infield/core_ext.rb
 - lib/infield/deprecation_warning.rb
+- lib/infield/heartbeat.rb
 - lib/infield/rails.rb
 - lib/infield/version.rb
 homepage: