infield 0.1.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2740909fa23076f115a2b77efeb50beaf0e41d94b87ea19499fb0542066a3cdb
-  data.tar.gz: 03bcbc9f9041698357e7d761dcc1a186345ad3029a95a9b367bd13271dc2aba2
+  metadata.gz: 325524018c44e26d8fe8513f38604197def031b5582285f63c7c928b8c8d4b84
+  data.tar.gz: 3b04d9d84e329c69c0c5b3bb822253943f9d0ba12a5ce3d78721b25e12657d87
 SHA512:
-  metadata.gz: 8185fe69d7d489ea72b2d62c4a0487dc5385be714b71a1c21ccd2b4c9f5a01ba6d6e99cc5ca3fc12648816b8e9dc15d0550c6170515a8cf406daef0c410f06bf
-  data.tar.gz: 4f208e424bed118a16b949a54a42222bcc72f01d11352484d9d32ef783ae04c9d18ddcd9094e52a5e1863a0a53eab6e4b15fa8bda74a38cd7bf82f3cbb840a06
+  metadata.gz: f9179b0602fe9f755169b59af4a0e1ff10a62de52ac0c1cafaa96ac4653badd9a771b3cd3be5c73c35c12ddaf121a066c702c68b390d2ca123b687b8195bfee7
+  data.tar.gz: 0624c57b8417151e01dfdb1de57a10ab2b69656e565443f31ad848c584fcd4bb2a894dea8b3a661c38000ecf38ef9878c0922d95f13e2c663b2d840b336106c7

data/.ruby-version

@@ -1 +1 @@
-2.7.8
+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. You can find these at https://app.infield.ai/deprecations after signing up.
+
+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/core_ext.rb

@@ -10,5 +10,24 @@ module Infield
     end
   end
 
-  Kernel.prepend(Core)
+  module InfieldWarningCapture
+    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.0")
+      # Ruby 3.0+ supports warn(msg, category: nil, **kwargs)
+      def warn(msg, category: nil, **kwargs)
+        super
+
+        Infield::DeprecationWarning.log(msg, callstack: caller_locations, validated: true) if category == :deprecated
+      end
+    else
+      # Ruby < 3.0 only provides a single argument to warn
+      def warn(msg)
+        super
+
+        Infield::DeprecationWarning.log(msg, callstack: caller_locations, validated: false)
+      end
+    end
+  end
+
+  Kernel.extend(Core)
+  Warning.extend(InfieldWarningCapture)
 end

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,7 +18,7 @@ module Infield
       ].freeze
 
       class << self
-        attr_reader :queue
+        attr_reader :queue, :thread
 
         def enqueue(message)
           @queue ||= Queue.new
@@ -38,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,47 @@
+# frozen_string_literal: true
+
+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.8'
+  VERSION = '0.3.0'
 end

data/lib/infield.rb

@@ -1,27 +1,41 @@
 # frozen_string_literal: true
 
+require 'thread'
+require 'json'
+require 'net/http'
+
 require_relative 'infield/version'
 
-# require_relative 'infield/core_ext'
+require_relative 'infield/core_ext'
 require_relative 'infield/rails' if defined?(Rails)
 
 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'
       raise 'API key is required' unless @api_key
       raise 'repo_environment_id is required' unless @repo_environment_id
 
-      @environment = environment || defined?(Rails) ? Rails.env : nil
+      @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.8
+  version: 0.3.0
 platform: ruby
 authors:
 - Infield
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-08 00:00:00.000000000 Z
-dependencies: []
+date: 2025-01-09 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:
@@ -49,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Send deprecation warnings to Infield