appsignal 3.12.5 → 3.13.0

data/spec/lib/appsignal_spec.rb

@@ -125,6 +125,28 @@ describe Appsignal do
         expect(Appsignal.config[:push_api_key]).to eq("key")
       end
 
+      it "loads a new config if the path is not the same" do
+        Appsignal._config = Appsignal::Config.new(
+          "/some/path",
+          :my_env,
+          :name => "Some name",
+          :push_api_key => "Some key",
+          :ignore_actions => ["My action"]
+        )
+
+        Appsignal.configure(:my_env, :root_path => project_fixture_path) do |config|
+          expect(config.ignore_actions).to be_empty
+          config.active = true
+          config.name = "My app"
+          config.push_api_key = "key"
+        end
+        expect(Appsignal.config.valid?).to be(true)
+        expect(Appsignal.config.env).to eq("my_env")
+        expect(Appsignal.config[:active]).to be(true)
+        expect(Appsignal.config[:name]).to eq("My app")
+        expect(Appsignal.config[:push_api_key]).to eq("key")
+      end
+
       it "calls configure if not started yet" do
         Appsignal.configure(:my_env) do |config|
           config.active = false
@@ -165,6 +187,16 @@ describe Appsignal do
         expect(Appsignal.config.env).to eq("env_arg")
       end
 
+      it "uses the given root path to read the config file" do
+        Appsignal.configure(:test, :root_path => project_fixture_path)
+
+        Appsignal.start
+        expect(Appsignal.config.env).to eq("test")
+        expect(Appsignal.config[:push_api_key]).to eq("abc")
+        # Ensure it loads from the config file in the given path
+        expect(Appsignal.config.file_config).to_not be_empty
+      end
+
       it "loads the config without a block being given" do
         Dir.chdir project_fixture_path do
           Appsignal.configure(:test)
@@ -172,6 +204,8 @@ describe Appsignal do
 
         expect(Appsignal.config.env).to eq("test")
         expect(Appsignal.config[:push_api_key]).to eq("abc")
+        # Ensure it loads from the config file in the current working directory
+        expect(Appsignal.config.file_config).to_not be_empty
       end
 
       it "allows customization of config in the block" do
@@ -1571,6 +1605,24 @@ describe Appsignal do
     describe ".listen_for_error" do
       around { |example| keep_transactions { example.run } }
 
+      it "prints and logs a deprecation warning" do
+        err_stream = std_stream
+        logs =
+          capture_logs do
+            capture_std_streams(std_stream, err_stream) do
+              Appsignal.listen_for_error do
+                # Do nothing
+              end
+            end
+          end
+        expect(err_stream.read)
+          .to include("appsignal WARNING: The `Appsignal.listen_for_error` helper is deprecated.")
+        expect(logs).to contains_log(
+          :warn,
+          "The `Appsignal.listen_for_error` helper is deprecated."
+        )
+      end
+
       it "records the error and re-raise it" do
         expect do
           expect do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.12.5
+  version: 3.13.0
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-01 00:00:00.000000000 Z
+date: 2024-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -186,6 +186,8 @@ files:
 - lib/appsignal.rb
 - lib/appsignal/auth_check.rb
 - lib/appsignal/capistrano.rb
+- lib/appsignal/check_in.rb
+- lib/appsignal/check_in/cron.rb
 - lib/appsignal/cli.rb
 - lib/appsignal/cli/demo.rb
 - lib/appsignal/cli/diagnose.rb
@@ -209,8 +211,7 @@ files:
 - lib/appsignal/extension.rb
 - lib/appsignal/extension/jruby.rb
 - lib/appsignal/garbage_collection.rb
-- lib/appsignal/heartbeat.rb
-- lib/appsignal/helpers/heartbeats.rb
+- lib/appsignal/helpers/heartbeat.rb
 - lib/appsignal/helpers/instrumentation.rb
 - lib/appsignal/helpers/metrics.rb
 - lib/appsignal/hooks.rb
@@ -312,6 +313,7 @@ files:
 - spec/lib/appsignal/auth_check_spec.rb
 - spec/lib/appsignal/capistrano2_spec.rb
 - spec/lib/appsignal/capistrano3_spec.rb
+- spec/lib/appsignal/check_in_spec.rb
 - spec/lib/appsignal/cli/demo_spec.rb
 - spec/lib/appsignal/cli/diagnose/paths_spec.rb
 - spec/lib/appsignal/cli/diagnose/utils_spec.rb
@@ -336,7 +338,6 @@ files:
 - spec/lib/appsignal/extension_install_failure_spec.rb
 - spec/lib/appsignal/extension_spec.rb
 - spec/lib/appsignal/garbage_collection_spec.rb
-- spec/lib/appsignal/heartbeat_spec.rb
 - spec/lib/appsignal/hooks/action_cable_spec.rb
 - spec/lib/appsignal/hooks/action_mailer_spec.rb
 - spec/lib/appsignal/hooks/active_support_notifications/finish_with_state_shared_examples.rb

data/lib/appsignal/heartbeat.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module Appsignal
-  class Heartbeat
-    class << self
-      # @api private
-      def transmitter
-        @transmitter ||= Appsignal::Transmitter.new(
-          "#{Appsignal.config[:logging_endpoint]}/heartbeats/json"
-        )
-      end
-    end
-
-    attr_reader :name, :id
-
-    def initialize(name:)
-      @name = name
-      @id = SecureRandom.hex(8)
-    end
-
-    def start
-      transmit_event("start")
-    end
-
-    def finish
-      transmit_event("finish")
-    end
-
-    private
-
-    def event(kind)
-      {
-        :name => name,
-        :id => @id,
-        :kind => kind,
-        :timestamp => Time.now.utc.to_i
-      }
-    end
-
-    def transmit_event(kind)
-      unless Appsignal.active?
-        Appsignal.internal_logger.debug("AppSignal not active, not transmitting heartbeat event")
-        return
-      end
-
-      response = self.class.transmitter.transmit(event(kind))
-
-      if response.code.to_i >= 200 && response.code.to_i < 300
-        Appsignal.internal_logger.debug("Transmitted heartbeat `#{name}` (#{id}) #{kind} event")
-      else
-        Appsignal.internal_logger.error(
-          "Failed to transmit heartbeat event: status code was #{response.code}"
-        )
-      end
-    rescue => e
-      Appsignal.internal_logger.error("Failed to transmit heartbeat event: #{e}")
-    end
-  end
-end

data/lib/appsignal/helpers/heartbeats.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module Appsignal
-  module Helpers
-    module Heartbeats
-      # Track heartbeats
-      #
-      # Track the execution of certain processes by sending a hearbeat.
-      #
-      # To track the duration of a piece of code, pass a block to {.heartbeat}
-      # to report both when the process starts, and when it finishes.
-      #
-      # If an exception is raised within the block, the finish event will not
-      # be reported, triggering a notification about the missing heartbeat. The
-      # exception will bubble outside of the heartbeat block.
-      #
-      # @example Send a heartbeat
-      #   Appsignal.heartbeat("send_invoices")
-      #
-      # @example Send a heartbeat with duration
-      #   Appsignal.heartbeat("send_invoices") do
-      #     # your code
-      #   end
-      #
-      # @param name [String] name of the heartbeat to report.
-      # @yield the block to monitor.
-      # @return [void]
-      # @since 3.7.0
-      # @see https://docs.appsignal.com/heartbeats
-      def heartbeat(name)
-        heartbeat = Appsignal::Heartbeat.new(:name => name)
-        output = nil
-
-        if block_given?
-          heartbeat.start
-          output = yield
-        end
-
-        heartbeat.finish
-        output
-      end
-    end
-  end
-end

data/spec/lib/appsignal/heartbeat_spec.rb

@@ -1,127 +0,0 @@
-describe Appsignal::Heartbeat do
-  let(:config) { project_fixture_config }
-  let(:heartbeat) { described_class.new(:name => "heartbeat-name") }
-  let(:transmitter) { Appsignal::Transmitter.new("http://heartbeats/", config) }
-
-  before(:each) do
-    allow(Appsignal).to receive(:active?).and_return(true)
-    config.logger = Logger.new(StringIO.new)
-    allow(Appsignal::Heartbeat).to receive(:transmitter).and_return(transmitter)
-  end
-
-  describe "when Appsignal is not active" do
-    it "should not transmit any events" do
-      allow(Appsignal).to receive(:active?).and_return(false)
-      expect(transmitter).not_to receive(:transmit)
-
-      heartbeat.start
-      heartbeat.finish
-    end
-  end
-
-  describe "#start" do
-    it "should send a heartbeat start" do
-      expect(transmitter).to receive(:transmit).with(hash_including(
-        :name => "heartbeat-name",
-        :kind => "start"
-      )).and_return(Net::HTTPResponse.new(nil, "200", nil))
-
-      expect(Appsignal.internal_logger).to receive(:debug).with(
-        "Transmitted heartbeat `heartbeat-name` (#{heartbeat.id}) start event"
-      )
-      expect(Appsignal.internal_logger).not_to receive(:error)
-
-      heartbeat.start
-    end
-
-    it "should log an error if it fails" do
-      expect(transmitter).to receive(:transmit).with(hash_including(
-        :name => "heartbeat-name",
-        :kind => "start"
-      )).and_return(Net::HTTPResponse.new(nil, "499", nil))
-
-      expect(Appsignal.internal_logger).not_to receive(:debug)
-      expect(Appsignal.internal_logger).to receive(:error).with(
-        "Failed to transmit heartbeat event: status code was 499"
-      )
-
-      heartbeat.start
-    end
-  end
-
-  describe "#finish" do
-    it "should send a heartbeat finish" do
-      expect(transmitter).to receive(:transmit).with(hash_including(
-        :name => "heartbeat-name",
-        :kind => "finish"
-      )).and_return(Net::HTTPResponse.new(nil, "200", nil))
-
-      expect(Appsignal.internal_logger).to receive(:debug).with(
-        "Transmitted heartbeat `heartbeat-name` (#{heartbeat.id}) finish event"
-      )
-      expect(Appsignal.internal_logger).not_to receive(:error)
-
-      heartbeat.finish
-    end
-
-    it "should log an error if it fails" do
-      expect(transmitter).to receive(:transmit).with(hash_including(
-        :name => "heartbeat-name",
-        :kind => "finish"
-      )).and_return(Net::HTTPResponse.new(nil, "499", nil))
-
-      expect(Appsignal.internal_logger).not_to receive(:debug)
-      expect(Appsignal.internal_logger).to receive(:error).with(
-        "Failed to transmit heartbeat event: status code was 499"
-      )
-
-      heartbeat.finish
-    end
-  end
-
-  describe ".heartbeat" do
-    describe "when a block is given" do
-      it "should send a heartbeat start and finish and return the block output" do
-        expect(transmitter).to receive(:transmit).with(hash_including(
-          :kind => "start",
-          :name => "heartbeat-with-block"
-        )).and_return(nil)
-
-        expect(transmitter).to receive(:transmit).with(hash_including(
-          :kind => "finish",
-          :name => "heartbeat-with-block"
-        )).and_return(nil)
-
-        output = Appsignal.heartbeat("heartbeat-with-block") { "output" }
-        expect(output).to eq("output")
-      end
-
-      it "should not send a heartbeat finish event when an error is raised" do
-        expect(transmitter).to receive(:transmit).with(hash_including(
-          :kind => "start",
-          :name => "heartbeat-with-block"
-        )).and_return(nil)
-
-        expect(transmitter).not_to receive(:transmit).with(hash_including(
-          :kind => "finish",
-          :name => "heartbeat-with-block"
-        ))
-
-        expect do
-          Appsignal.heartbeat("heartbeat-with-block") { raise "error" }
-        end.to raise_error(RuntimeError, "error")
-      end
-    end
-
-    describe "when no block is given" do
-      it "should only send a heartbeat finish event" do
-        expect(transmitter).to receive(:transmit).with(hash_including(
-          :kind => "finish",
-          :name => "heartbeat-without-block"
-        )).and_return(nil)
-
-        Appsignal.heartbeat("heartbeat-without-block")
-      end
-    end
-  end
-end