appsignal 3.13.1-java → 4.0.0.beta.1-java

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.13.1"
+  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/heartbeat"
 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::Heartbeat
     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,36 +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
-      when :Heartbeat
-        unless @heartbeat_constant_deprecation_warning_emitted
-          callers = caller
-          Appsignal::Utils::StdoutAndLoggerMessage.warning \
-            "The constant Appsignal::Heartbeat has been deprecated. " \
-              "Please update the constant name to Appsignal::CheckIn::Cron " \
-              "in the following file and elsewhere to remove this message.\n#{callers.first}"
-          @heartbeat_constant_deprecation_warning_emitted = true
-        end
-        Appsignal::CheckIn::Cron
-      else
-        super
-      end
-    end
   end
 end
 
 require "appsignal/loaders"
+require "appsignal/sample_data"
 require "appsignal/environment"
 require "appsignal/system"
 require "appsignal/utils"

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/check_in_spec.rb

@@ -1,173 +1,6 @@
-describe Appsignal::Heartbeat do
-  let(:err_stream) { std_stream }
-
-  after do
-    Appsignal.instance_variable_set(:@heartbeat_constant_deprecation_warning_emitted, false)
-  end
-
-  it "returns the Cron constant calling the Heartbeat constant" do
-    silence { expect(Appsignal::Heartbeat).to be(Appsignal::CheckIn::Cron) }
-  end
-
-  it "prints a deprecation warning to STDERR" do
-    capture_std_streams(std_stream, err_stream) do
-      expect(Appsignal::Heartbeat).to be(Appsignal::CheckIn::Cron)
-    end
-
-    expect(err_stream.read)
-      .to include("appsignal WARNING: The constant Appsignal::Heartbeat has been deprecated.")
-  end
-
-  it "does not print a deprecation warning to STDERR more than once" do
-    capture_std_streams(std_stream, err_stream) do
-      expect(Appsignal::Heartbeat).to be(Appsignal::CheckIn::Cron)
-    end
-
-    expect(err_stream.read)
-      .to include("appsignal WARNING: The constant Appsignal::Heartbeat has been deprecated.")
-
-    err_stream.truncate(0)
-
-    capture_std_streams(std_stream, err_stream) do
-      expect(Appsignal::Heartbeat).to be(Appsignal::CheckIn::Cron)
-    end
-
-    expect(err_stream.read)
-      .not_to include("appsignal WARNING: The constant Appsignal::Heartbeat has been deprecated.")
-  end
-
-  it "logs a warning" do
-    logs =
-      capture_logs do
-        silence do
-          expect(Appsignal::Heartbeat).to be(Appsignal::CheckIn::Cron)
-        end
-      end
-
-    expect(logs).to contains_log(
-      :warn,
-      "The constant Appsignal::Heartbeat has been deprecated."
-    )
-  end
-
-  it "does not log a warning more than once" do
-    logs =
-      capture_logs do
-        silence do
-          expect(Appsignal::Heartbeat).to be(Appsignal::CheckIn::Cron)
-        end
-      end
-
-    expect(logs).to contains_log(
-      :warn,
-      "The constant Appsignal::Heartbeat has been deprecated."
-    )
-
-    logs =
-      capture_logs do
-        silence do
-          expect(Appsignal::Heartbeat).to be(Appsignal::CheckIn::Cron)
-        end
-      end
-
-    expect(logs).not_to contains_log(
-      :warn,
-      "The constant Appsignal::Heartbeat has been deprecated."
-    )
-  end
-end
-
-describe "Appsignal.heartbeat" do
-  let(:err_stream) { std_stream }
-
-  before do
-    Appsignal.instance_variable_set(:@heartbeat_helper_deprecation_warning_emitted, false)
-  end
-
-  it "should forward the call to Appsignal::CheckIn.cron" do
-    expect(Appsignal::CheckIn).to receive(:cron).with("heartbeat-name")
-    expect do
-      Appsignal.heartbeat("heartbeat-name")
-    end.not_to raise_error
-
-    block = proc { 42 }
-    expect(Appsignal::CheckIn).to receive(:cron).with("heartbeat-name") do |&given_block|
-      expect(given_block).to be(block)
-    end.and_return("output")
-    expect(Appsignal.heartbeat("heartbeat-name", &block)).to eq("output")
-  end
-
-  it "prints a deprecation warning to STDERR" do
-    capture_std_streams(std_stream, err_stream) do
-      Appsignal.heartbeat("heartbeat-name")
-    end
-
-    expect(err_stream.read)
-      .to include("appsignal WARNING: The helper Appsignal.heartbeat has been deprecated.")
-  end
-
-  it "does not print a deprecation warning to STDERR more than once" do
-    capture_std_streams(std_stream, err_stream) do
-      Appsignal.heartbeat("heartbeat-name")
-    end
-
-    expect(err_stream.read)
-      .to include("appsignal WARNING: The helper Appsignal.heartbeat has been deprecated.")
-
-    err_stream.truncate(0)
-
-    capture_std_streams(std_stream, err_stream) do
-      Appsignal.heartbeat("heartbeat-name")
-    end
-
-    expect(err_stream.read)
-      .not_to include("appsignal WARNING: The helper Appsignal.heartbeat has been deprecated.")
-  end
-
-  it "logs a warning" do
-    logs =
-      capture_logs do
-        silence do
-          Appsignal.heartbeat("heartbeat-name")
-        end
-      end
-
-    expect(logs).to contains_log(
-      :warn,
-      "The helper Appsignal.heartbeat has been deprecated."
-    )
-  end
-
-  it "does not log a warning more than once" do
-    logs =
-      capture_logs do
-        silence do
-          Appsignal.heartbeat("heartbeat-name")
-        end
-      end
-
-    expect(logs).to contains_log(
-      :warn,
-      "The helper Appsignal.heartbeat has been deprecated."
-    )
-
-    logs =
-      capture_logs do
-        silence do
-          Appsignal.heartbeat("heartbeat-name")
-        end
-      end
-
-    expect(logs).not_to contains_log(
-      :warn,
-      "The helper Appsignal.heartbeat has been deprecated."
-    )
-  end
-end
-
 describe Appsignal::CheckIn::Cron do
   let(:config) { project_fixture_config }
-  let(:cron_checkin) { described_class.new(:name => "cron-checkin-name") }
+  let(:cron_checkin) { described_class.new(:identifier => "cron-checkin-name") }
   let(:transmitter) { Appsignal::Transmitter.new("http://cron_checkins/", config) }
 
   before(:each) do
@@ -300,43 +133,4 @@ describe Appsignal::CheckIn::Cron do
       end
     end
   end
-
-  describe "#initialize" do
-    describe "when initialised with deprecated heartbeat keyword names" do
-      let(:err_stream) { std_stream }
-
-      after do
-        described_class.instance_variable_set(:@initializer_deprecation_warning_emitted, false)
-      end
-
-      it "can be initialised" do
-        cron_checkin = described_class.new(:name => "cron-checkin-name")
-        expect(cron_checkin.identifier).to eq("cron-checkin-name")
-      end
-
-      it "logs a deprecation warning" do
-        capture_std_streams(std_stream, err_stream) do
-          expect(described_class.new(:name => "cron-checkin-name"))
-            .to be_a(Appsignal::CheckIn::Cron)
-        end
-
-        expect(err_stream.read)
-          .to include(
-            "appsignal WARNING: Passing a `name` keyword argument to " \
-              "`Appsignal::CheckIn::Cron.new` is deprecated."
-          )
-      end
-    end
-
-    it "can be initialised with cron check-in keyword names" do
-      cron_checkin = described_class.new(:identifier => "cron-checkin-name")
-      expect(cron_checkin.identifier).to eq("cron-checkin-name")
-    end
-
-    it "raises an error when no identifier is given" do
-      expect do
-        described_class.new
-      end.to raise_error(ArgumentError, "missing keyword: :identifier")
-    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