appsignal 3.12.6 → 4.0.0.beta.1

data/lib/appsignal/utils/rails_helper.rb

@@ -15,6 +15,10 @@ module Appsignal
       def self.application_config_path
         File.expand_path(File.join(Dir.pwd, "config/application.rb"))
       end
+
+      def self.environment_config_path
+        File.expand_path(File.join(Dir.pwd, "config/environment.rb"))
+      end
     end
   end
 end

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "3.12.6"
+  VERSION = "4.0.0.beta.1"
 end

data/lib/appsignal.rb

@@ -6,7 +6,6 @@ require "stringio"
 
 require "appsignal/logger"
 require "appsignal/utils/stdout_and_logger_message"
-require "appsignal/helpers/heartbeats"
 require "appsignal/helpers/instrumentation"
 require "appsignal/helpers/metrics"
 
@@ -18,7 +17,6 @@ require "appsignal/helpers/metrics"
 # {Appsignal::Helpers::Metrics}) for ease of use.
 module Appsignal
   class << self
-    include Helpers::Heartbeats
     include Helpers::Instrumentation
     include Helpers::Metrics
 
@@ -36,26 +34,6 @@ module Appsignal
     # @see Config
     attr_reader :config
 
-    # Set the AppSignal config.
-    #
-    # @deprecated Use {Appsignal.configure} instead.
-    # @param conf [Appsignal::Config]
-    # @return [void]
-    # @see Config
-    def config=(conf)
-      Appsignal::Utils::StdoutAndLoggerMessage.warning \
-        "Configuring AppSignal with `Appsignal.config=` is deprecated. " \
-          "Use `Appsignal.configure { |config| ... }` to configure AppSignal. " \
-          "https://docs.appsignal.com/ruby/configuration.html\n" \
-          "#{caller.first}"
-      @config = conf
-    end
-
-    # @api private
-    def _config=(conf)
-      @config = conf
-    end
-
     # Accessor for toggle if the AppSignal C-extension is loaded.
     #
     # Can be `nil` if extension has not been loaded yet. See
@@ -113,7 +91,17 @@ module Appsignal
     #
     # @return [void]
     # @since 0.7.0
-    def start
+    def start # rubocop:disable Metrics/AbcSize
+      if ENV.fetch("_APPSIGNAL_DIAGNOSE", false)
+        internal_logger.warn("Skipping start in diagnose context")
+        return
+      end
+
+      if started?
+        internal_logger.warn("Ignoring call to Appsignal.start after AppSignal has started")
+        return
+      end
+
       unless extension_loaded?
         internal_logger.info("Not starting AppSignal, extension is not loaded")
         return
@@ -122,6 +110,7 @@ module Appsignal
       internal_logger.debug("Loading AppSignal gem")
 
       @config ||= Config.new(Config.determine_root_path, Config.determine_env)
+      @config.validate
 
       _start_logger
 
@@ -143,6 +132,7 @@ module Appsignal
           Appsignal::Probes.start if config[:enable_minutely_probes]
 
           collect_environment_metadata
+          @config.freeze
         else
           internal_logger.info("Not starting, not active for #{config.env}")
         end
@@ -251,20 +241,15 @@ module Appsignal
         @config = Config.new(
           root_path || Config.determine_root_path,
           Config.determine_env(env),
-          {},
-          Appsignal.internal_logger,
-          nil,
-          false
+          Appsignal.internal_logger
         )
-        config.load_config
       end
 
       config_dsl = Appsignal::Config::ConfigDSL.new(config)
-      if block_given?
-        yield config_dsl
-        config.merge_dsl_options(config_dsl.dsl_options)
-      end
-      config.validate
+      return unless block_given?
+
+      yield config_dsl
+      config.merge_dsl_options(config_dsl.dsl_options)
     end
 
     def forked
@@ -334,18 +319,6 @@ module Appsignal
       end
     end
 
-    # @deprecated Only {.start} has to be called.
-    # @return [void]
-    # @since 0.7.0
-    def start_logger
-      callers = caller
-      Appsignal::Utils::StdoutAndLoggerMessage.warning \
-        "Calling 'Appsignal.start_logger' is deprecated. " \
-          "The logger will be started when calling 'Appsignal.start'. " \
-          "Remove the 'Appsignal.start_logger' call in the following file to " \
-          "remove this message.\n#{callers.first}"
-    end
-
     # Start the AppSignal internal logger.
     #
     # Sets the log level and sets the logger. Uses a file-based logger or the
@@ -449,26 +422,11 @@ module Appsignal
       end
       Appsignal::Environment.report_supported_gems
     end
-
-    # Alias constants that have moved with a warning message that points to the
-    # place to update the reference.
-    def const_missing(name)
-      case name
-      when :Minutely
-        callers = caller
-        Appsignal::Utils::StdoutAndLoggerMessage.warning \
-          "The constant Appsignal::Minutely has been deprecated. " \
-            "Please update the constant name to Appsignal::Probes " \
-            "in the following file to remove this message.\n#{callers.first}"
-        Appsignal::Probes
-      else
-        super
-      end
-    end
   end
 end
 
 require "appsignal/loaders"
+require "appsignal/sample_data"
 require "appsignal/environment"
 require "appsignal/system"
 require "appsignal/utils"
@@ -489,4 +447,4 @@ require "appsignal/integrations/railtie" if defined?(::Rails)
 require "appsignal/transaction"
 require "appsignal/version"
 require "appsignal/transmitter"
-require "appsignal/heartbeat"
+require "appsignal/check_in"

data/spec/lib/appsignal/auth_check_spec.rb

@@ -1,5 +1,5 @@
 describe Appsignal::AuthCheck do
-  let(:config) { project_fixture_config }
+  let(:config) { build_config }
   let(:auth_check) { Appsignal::AuthCheck.new(config) }
   let(:auth_url) do
     query = build_uri_query_string(

data/spec/lib/appsignal/capistrano2_spec.rb

@@ -6,7 +6,7 @@ if DependencyHelper.capistrano2_present?
   describe "Capistrano 2 integration" do
     let(:out_stream) { std_stream }
     let(:output) { out_stream.read }
-    let(:config) { project_fixture_config }
+    let(:config) { build_config }
     let(:capistrano_config) do
       Capistrano::Configuration.new.tap do |c|
         c.set(:rails_env, "production")

data/spec/lib/appsignal/capistrano3_spec.rb

@@ -5,7 +5,9 @@ if DependencyHelper.capistrano3_present?
 
   describe "Capistrano 3 integration" do
     let(:capistrano) { Class.new.extend(Capistrano::DSL) }
-    let(:config) { project_fixture_config }
+    let(:env) { :production }
+    let(:options) { {} }
+    let(:config) { build_config(:env => env, :options => options) }
     let(:out_stream) { std_stream }
     let(:output) { out_stream.read }
     let(:logger) { Logger.new(out_stream) }
@@ -50,7 +52,7 @@ if DependencyHelper.capistrano3_present?
       end
 
       context "config" do
-        let(:env) { "production" }
+        let(:options) { { :name => "AppName" } }
         before do
           capistrano_config.set(
             :appsignal_config,
@@ -58,9 +60,6 @@ if DependencyHelper.capistrano3_present?
             :active => true,
             :push_api_key => "abc"
           )
-          config[:name] = "AppName"
-          config.instance_variable_set(:@env, env)
-          stub_marker_request.to_return(:status => 200)
         end
 
         context "when rack_env is the only env set" do
@@ -71,6 +70,11 @@ if DependencyHelper.capistrano3_present?
           end
 
           it "uses the rack_env as the env" do
+            stub_marker_request(
+              :environment => env.to_s,
+              :name => "AppName",
+              :push_api_key => "abc"
+            ).to_return(:status => 200)
             original_new = Appsignal::Marker.method(:new)
 
             expect(Appsignal::Marker).to receive(:new) do |data, given_config|
@@ -90,6 +94,11 @@ if DependencyHelper.capistrano3_present?
           end
 
           it "prefers the Capistrano stage rather than rails_env and rack_env" do
+            stub_marker_request(
+              :environment => env.to_s,
+              :name => "AppName",
+              :push_api_key => "abc"
+            ).to_return(:status => 200)
             original_new = Appsignal::Marker.method(:new)
 
             expect(Appsignal::Marker).to receive(:new) do |data, given_config|
@@ -104,15 +113,19 @@ if DependencyHelper.capistrano3_present?
         context "when `appsignal_config` is set" do
           before do
             ENV["APPSIGNAL_APP_NAME"] = "EnvName"
-            capistrano_config.set(:appsignal_config, :name => "AppName")
-            config[:name] = "AppName"
+            capistrano_config.set(:appsignal_config, :name => "CapName")
           end
 
           it "overrides the default config with the custom appsignal_config" do
+            stub_marker_request(
+              :environment => env.to_s,
+              :name => "CapName",
+              :push_api_key => "abc"
+            ).to_return(:status => 200)
             original_new = Appsignal::Marker.method(:new)
 
             expect(Appsignal::Marker).to receive(:new) do |data, given_config|
-              expect(given_config[:name]).to eq("AppName")
+              expect(given_config[:name]).to eq("CapName")
               original_new.call(data, given_config)
             end
 
@@ -141,6 +154,11 @@ if DependencyHelper.capistrano3_present?
           end
 
           it "prefers the appsignal_env rather than stage, rails_env and rack_env" do
+            stub_marker_request(
+              :environment => env.to_s,
+              :name => "AppName",
+              :push_api_key => "abc"
+            ).to_return(:status => 200)
             original_new = Appsignal::Marker.method(:new)
 
             expect(Appsignal::Marker).to receive(:new) do |data, given_config|
@@ -156,7 +174,11 @@ if DependencyHelper.capistrano3_present?
       describe "markers" do
         context "when active for this environment" do
           it "transmits marker" do
-            stub_marker_request.to_return(:status => 200)
+            stub_marker_request(
+              :environment => env.to_s,
+              :name => "TestApp",
+              :push_api_key => "abc"
+            ).to_return(:status => 200)
             run
 
             expect(output).to include \
@@ -168,7 +190,14 @@ if DependencyHelper.capistrano3_present?
           context "with overridden revision" do
             before do
               capistrano_config.set(:appsignal_revision, "abc123")
-              stub_marker_request(:revision => "abc123").to_return(:status => 200)
+              stub_marker_request(
+                {
+                  :environment => env.to_s,
+                  :name => "TestApp",
+                  :push_api_key => "abc"
+                },
+                :revision => "abc123"
+              ).to_return(:status => 200)
               run
             end
 
@@ -182,7 +211,14 @@ if DependencyHelper.capistrano3_present?
           context "with overridden deploy user" do
             before do
               capistrano_config.set(:appsignal_user, "robin")
-              stub_marker_request(:user => "robin").to_return(:status => 200)
+              stub_marker_request(
+                {
+                  :environment => env.to_s,
+                  :name => "TestApp",
+                  :push_api_key => "abc"
+                },
+                :user => "robin"
+              ).to_return(:status => 200)
               run
             end
 
@@ -209,7 +245,11 @@ if DependencyHelper.capistrano3_present?
 
           context "with failed request" do
             before do
-              stub_marker_request.to_return(:status => 500)
+              stub_marker_request(
+                :environment => env.to_s,
+                :name => "TestApp",
+                :push_api_key => "abc"
+              ).to_return(:status => 500)
               run
             end
 
@@ -238,7 +278,7 @@ if DependencyHelper.capistrano3_present?
     end
   end
 
-  def stub_marker_request(data = {})
+  def stub_marker_request(config = {}, data = {})
     stub_api_request config, "markers", marker_data.merge(data)
   end
 end

data/spec/lib/appsignal/{heartbeat_spec.rb → check_in_spec.rb}

@@ -1,12 +1,12 @@
-describe Appsignal::Heartbeat do
+describe Appsignal::CheckIn::Cron do
   let(:config) { project_fixture_config }
-  let(:heartbeat) { described_class.new(:name => "heartbeat-name") }
-  let(:transmitter) { Appsignal::Transmitter.new("http://heartbeats/", config) }
+  let(:cron_checkin) { described_class.new(:identifier => "cron-checkin-name") }
+  let(:transmitter) { Appsignal::Transmitter.new("http://cron_checkins/", 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)
+    allow(Appsignal::CheckIn::Cron).to receive(:transmitter).and_return(transmitter)
   end
 
   describe "when Appsignal is not active" do
@@ -14,113 +14,122 @@ describe Appsignal::Heartbeat do
       allow(Appsignal).to receive(:active?).and_return(false)
       expect(transmitter).not_to receive(:transmit)
 
-      heartbeat.start
-      heartbeat.finish
+      cron_checkin.start
+      cron_checkin.finish
     end
   end
 
   describe "#start" do
-    it "should send a heartbeat start" do
+    it "should send a cron check-in start" do
       expect(transmitter).to receive(:transmit).with(hash_including(
-        :name => "heartbeat-name",
-        :kind => "start"
+        :identifier => "cron-checkin-name",
+        :kind => "start",
+        :check_in_type => "cron"
       )).and_return(Net::HTTPResponse.new(nil, "200", nil))
 
       expect(Appsignal.internal_logger).to receive(:debug).with(
-        "Transmitted heartbeat `heartbeat-name` (#{heartbeat.id}) start event"
+        "Transmitted cron check-in `cron-checkin-name` (#{cron_checkin.digest}) start event"
       )
       expect(Appsignal.internal_logger).not_to receive(:error)
 
-      heartbeat.start
+      cron_checkin.start
     end
 
     it "should log an error if it fails" do
       expect(transmitter).to receive(:transmit).with(hash_including(
-        :name => "heartbeat-name",
-        :kind => "start"
+        :identifier => "cron-checkin-name",
+        :kind => "start",
+        :check_in_type => "cron"
       )).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"
+        "Failed to transmit cron check-in start event: status code was 499"
       )
 
-      heartbeat.start
+      cron_checkin.start
     end
   end
 
   describe "#finish" do
-    it "should send a heartbeat finish" do
+    it "should send a cron check-in finish" do
       expect(transmitter).to receive(:transmit).with(hash_including(
-        :name => "heartbeat-name",
-        :kind => "finish"
+        :identifier => "cron-checkin-name",
+        :kind => "finish",
+        :check_in_type => "cron"
       )).and_return(Net::HTTPResponse.new(nil, "200", nil))
 
       expect(Appsignal.internal_logger).to receive(:debug).with(
-        "Transmitted heartbeat `heartbeat-name` (#{heartbeat.id}) finish event"
+        "Transmitted cron check-in `cron-checkin-name` (#{cron_checkin.digest}) finish event"
       )
       expect(Appsignal.internal_logger).not_to receive(:error)
 
-      heartbeat.finish
+      cron_checkin.finish
     end
 
     it "should log an error if it fails" do
       expect(transmitter).to receive(:transmit).with(hash_including(
-        :name => "heartbeat-name",
-        :kind => "finish"
+        :identifier => "cron-checkin-name",
+        :kind => "finish",
+        :check_in_type => "cron"
       )).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"
+        "Failed to transmit cron check-in finish event: status code was 499"
       )
 
-      heartbeat.finish
+      cron_checkin.finish
     end
   end
 
-  describe ".heartbeat" do
+  describe ".cron" do
     describe "when a block is given" do
-      it "should send a heartbeat start and finish and return the block output" do
+      it "should send a cron check-in start and finish and return the block output" do
         expect(transmitter).to receive(:transmit).with(hash_including(
           :kind => "start",
-          :name => "heartbeat-with-block"
+          :identifier => "cron-checkin-with-block",
+          :check_in_type => "cron"
         )).and_return(nil)
 
         expect(transmitter).to receive(:transmit).with(hash_including(
           :kind => "finish",
-          :name => "heartbeat-with-block"
+          :identifier => "cron-checkin-with-block",
+          :check_in_type => "cron"
         )).and_return(nil)
 
-        output = Appsignal.heartbeat("heartbeat-with-block") { "output" }
+        output = Appsignal::CheckIn.cron("cron-checkin-with-block") { "output" }
         expect(output).to eq("output")
       end
 
-      it "should not send a heartbeat finish event when an error is raised" do
+      it "should not send a cron check-in finish event when an error is raised" do
         expect(transmitter).to receive(:transmit).with(hash_including(
           :kind => "start",
-          :name => "heartbeat-with-block"
+          :identifier => "cron-checkin-with-block",
+          :check_in_type => "cron"
         )).and_return(nil)
 
         expect(transmitter).not_to receive(:transmit).with(hash_including(
           :kind => "finish",
-          :name => "heartbeat-with-block"
+          :identifier => "cron-checkin-with-block",
+          :check_in_type => "cron"
         ))
 
         expect do
-          Appsignal.heartbeat("heartbeat-with-block") { raise "error" }
+          Appsignal::CheckIn.cron("cron-checkin-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
+      it "should only send a cron check-in finish event" do
         expect(transmitter).to receive(:transmit).with(hash_including(
           :kind => "finish",
-          :name => "heartbeat-without-block"
+          :identifier => "cron-checkin-without-block",
+          :check_in_type => "cron"
         )).and_return(nil)
 
-        Appsignal.heartbeat("heartbeat-without-block")
+        Appsignal::CheckIn.cron("cron-checkin-without-block")
       end
     end
   end

data/spec/lib/appsignal/cli/demo_spec.rb

@@ -7,12 +7,6 @@ describe Appsignal::CLI::Demo do
   let(:out_stream) { std_stream }
   let(:output) { out_stream.read }
   before(:context) { Appsignal.stop }
-  before do
-    ENV.delete("APPSIGNAL_APP_ENV")
-    ENV.delete("RAILS_ENV")
-    ENV.delete("RACK_ENV")
-    stub_api_request config, "auth"
-  end
 
   def run
     run_within_dir project_fixture_path
@@ -25,8 +19,6 @@ describe Appsignal::CLI::Demo do
   end
 
   context "without configuration" do
-    let(:config) { Appsignal::Config.new("development", tmp_dir) }
-
     it "returns an error" do
       expect { run_within_dir tmp_dir }.to raise_error(SystemExit)
 
@@ -35,32 +27,20 @@ describe Appsignal::CLI::Demo do
   end
 
   context "with configuration" do
-    let(:config) { project_fixture_config }
     before do
       # Ignore sleeps to speed up the test
       allow(Appsignal::Demo).to receive(:sleep)
     end
+    let(:options) { { :environment => "development" } }
 
-    context "without environment" do
-      it "returns an error" do
-        expect { run_within_dir tmp_dir }.to raise_error(SystemExit)
-
-        expect(output).to include("Error: Unable to start the AppSignal agent")
-      end
+    it "calls Appsignal::Demo transmitter" do
+      expect(Appsignal::Demo).to receive(:transmit).and_return(true)
+      run
     end
 
-    context "with environment" do
-      let(:options) { { :environment => "development" } }
-
-      it "calls Appsignal::Demo transmitter" do
-        expect(Appsignal::Demo).to receive(:transmit).and_return(true)
-        run
-      end
-
-      it "outputs message" do
-        run
-        expect(output).to include("Demonstration sample data sent!")
-      end
+    it "outputs message" do
+      run
+      expect(output).to include("Demonstration sample data sent!")
     end
   end
 end