appsignal 3.9.2 → 3.9.3

data/build_matrix.yml

@@ -1,158 +1,81 @@
-semaphore: # Default `.semaphore/semaphore.yml` contents
-  version: v1.0
-  name: AppSignal Ruby Build and Tests
+github:
+  name: Ruby gem CI
+  "on":
+    push:
+      branches:
+        - "main"
+        - "develop"
+    pull_request:
+      types:
+        - opened
+        - reopened
+        - synchronize
 
-  agent:
-    machine:
-      type: e1-standard-2
-      os_image: ubuntu2004
+  concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: ${{ !contains(github.ref, 'main')}}
 
-  # Cancel all running and queued workflows before this one
-  auto_cancel:
-    running:
-      # Ignore main AND develop branch as we want it to build all workflows
-      when: "branch != 'main' AND branch != 'develop'"
+  jobs:
+    lint-git:
+      name: "Git linter (Lintje)"
+      runs-on: ubuntu-latest
+      steps:
+        - uses: actions/checkout@v4
+          with:
+            fetch-depth: 0 # Fetch depth is required
+        - name: "Run Git linter"
+          uses: lintje/action@v0.11
 
-  global_job_config:
-    env_vars:
-      - name: RUNNING_IN_CI
-        value: "true"
-      - name: _BUNDLER_CACHE
-        value: "v3"
-      - name: _GEMS_CACHE
-        value: "v3"
-    prologue:
-      commands:
-        - checkout
-        - rm -f $HOME/.rbenv/plugins/rbenv-gem-rehash/etc/rbenv.d/exec/~gem-rehash.bash
-        - |
-          if [ -n "$RUBY_VERSION" ]; then
-            if ! (sem-version ruby "$RUBY_VERSION"); then
-              ruby_key="rbenv-ruby-$RUBY_VERSION"
-              echo "Attempting to build Ruby $RUBY_VERSION from source"
-              git -C "$HOME/.rbenv/plugins/ruby-build" pull
-              cache restore "$ruby_key"
-              sem-version ruby "$RUBY_VERSION"
-              if ! cache has_key "$ruby_key"; then
-                cache store "$ruby_key" "$HOME/.rbenv/versions/$RUBY_VERSION"
-              fi
-            fi
-            ./support/check_versions
-          else
-            echo Skipping Ruby install
-          fi
+    lint-style:
+      name: "Ruby style linter (RuboCop)"
+      runs-on: ubuntu-latest
+      steps:
+        - uses: actions/checkout@v4
+        - uses: ruby/setup-ruby@v1
+          with:
+            ruby-version: "3.3"
+            bundler-cache: true
+        - name: "Run RuboCop"
+          run: bundle exec rubocop
 
-  blocks:
-    - name: Validation
-      dependencies: []
-      task:
-        prologue:
-          commands:
-            - cache restore $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec)
-            - cache restore $_GEMS_CACHE-gems-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec)
-            - ./support/bundler_wrapper install --jobs=3 --retry=3
-        jobs:
-        - name: Validate CI setup
-          env_vars:
-            - name: RUBY_VERSION
-              value: 3.2.2
-            - name: GEMSET
-              value: no_dependencies
-            - name: BUNDLE_GEMFILE
-              value: Gemfile
-          commands:
-            - ./support/bundler_wrapper exec rake build_matrix:semaphore:validate
-        epilogue:
-          on_pass:
-            commands:
-              - cache store $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec) .bundle
-              - cache store $_GEMS_CACHE-gems-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec) $HOME/.gem
-    - name: Ruby linters
-      dependencies: []
-      task:
-        prologue:
-          commands:
-            - cache restore $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec)
-            - cache restore $_GEMS_CACHE-gems-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec)
-            - ./support/bundler_wrapper install --jobs=3 --retry=3
-        jobs:
-        - name: RuboCop
-          env_vars:
-            - name: RUBY_VERSION
-              value: 3.2.2
-            - name: GEMSET
-              value: no_dependencies
-            - name: BUNDLE_GEMFILE
-              value: Gemfile
-          commands:
-            - ./support/bundler_wrapper exec rubocop
-        epilogue:
-          on_pass:
-            commands:
-              - cache store $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec) .bundle
-              - cache store $_GEMS_CACHE-gems-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec) $HOME/.gem
-    - name: Other linters
-      dependencies: []
-      task:
-        jobs:
-        - name: Git Lint (Lintje)
-          commands:
-            - script/lint_git
-    - name: Integration tests
-      dependencies:
-      - Validation
-      task:
-        prologue:
-          commands:
-            - cache restore $_BUNDLER_CACHE-bundler-$RUBY_VERSION-diagnose-$(checksum Gemfile)
-            - cache restore $_GEMS_CACHE-gems-$RUBY_VERSION-diagnose-$(checksum Gemfile)
-            - ./support/bundler_wrapper install --jobs=3 --retry=3
-            - ./support/bundler_wrapper exec rake extension:install
-            - "[ -e ext/install.report ] && cat ext/install.report || echo 'No ext/install.report file found'"
-            - "[ -f ext/mkmf.log ] && cat ext/mkmf.log || echo 'No ext/mkmf.log file found'"
-            - git submodule init
-            - git submodule update
-        jobs:
-        - name: Diagnose
-          env_vars:
-            - name: RUBY_VERSION
-              value: 3.0.2
-            - name: LANGUAGE
-              value: ruby
-          commands:
-            - spec/integration/diagnose/bin/test
-        epilogue:
-          on_pass:
-            commands:
-              - cache store $_BUNDLER_CACHE-bundler-$RUBY_VERSION-diagnose-$(checksum Gemfile) .bundle
-              - cache store $_GEMS_CACHE-gems-$RUBY_VERSION-diagnose-$(checksum Gemfile) $HOME/.gem
+    validation:
+      name: "Validation of CI"
+      runs-on: ubuntu-latest
+      steps:
+        - uses: actions/checkout@v4
+        - uses: ruby/setup-ruby@v1
+          with:
+            ruby-version: "3.3"
+            bundler-cache: true
+        - run: rake build_matrix:github:validate
 
-matrix:
-  env_vars: # Shared for all jobs in the build matrix
-    - name: BUNDLE_PATH
-      value: "../.bundle/"
-    - name: RAILS_ENV
-      value: "test"
-    - name: JRUBY_OPTS
-      value: ""
-    - name: COV
-      value: "1"
-  prologue: # Shared for all jobs in the build matrix
-    commands:
-      - cache restore $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec)
-      - cache restore $_GEMS_CACHE-gems-$RUBY_VERSION-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec)
-      - ./support/install_deps
-      - bundle config set clean 'true'
-      - ./support/bundler_wrapper install --jobs=3 --retry=3
-  epilogue: # Shared for all jobs in the build matrix
-    on_pass:
-      commands:
-        - cache store $_BUNDLER_CACHE-bundler-$RUBY_VERSION-$GEMSET-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec) .bundle
-        - cache store $_GEMS_CACHE-gems-$RUBY_VERSION-$(checksum $BUNDLE_GEMFILE)-$(checksum appsignal.gemspec) $HOME/.gem
+    integration_tests:
+      name: "Diagnose integration tests"
+      runs-on: ubuntu-latest
+      steps:
+        - uses: actions/checkout@v4
+          with:
+            submodules: true
+        - uses: ruby/setup-ruby@v1
+          with:
+            ruby-version: "3.3"
+            bundler-cache: true
+        - name: "Install gem extension"
+          run: rake extension:install
+        - name: "Bundle install"
+          run: bundle install
+          working-directory: "spec/integration/diagnose"
+        - name: "Run diagnose integration tests"
+          run: bundle exec rspec
+          working-directory: "spec/integration/diagnose"
+          env:
+            LANGUAGE: ruby
 
-  defaults:
-    rubygems: "latest"
-    bundler: "latest"
+matrix:
+  env: # Shared for all jobs in the build matrix
+    RAILS_ENV: "test"
+    JRUBY_OPTS: ""
+    COV: "1"
 
   gemsets: # By default all gems are tested
     none:
@@ -165,11 +88,11 @@ matrix:
       - "rails-7.1"
 
   ruby:
-    - ruby: "2.7.8"
-    - ruby: "3.0.5"
-    - ruby: "3.1.3"
-    - ruby: "3.2.1"
     - ruby: "3.3.1"
+    - ruby: "3.2.1"
+    - ruby: "3.1.3"
+    - ruby: "3.0.5"
+    - ruby: "2.7.8"
     - ruby: "jruby-9.4.1.0"
       gems: "minimal"
   gems:
@@ -179,69 +102,76 @@ matrix:
     - gem: "dry-monitor"
       only:
         ruby:
-          - "3.0.5"
-          - "3.1.3"
-          - "3.2.1"
           - "3.3.1"
+          - "3.2.1"
+          - "3.1.3"
+          - "3.0.5"
     - gem: "grape"
-    - gem: "hanami"
+    - gem: "hanami-2.0"
       only:
         ruby:
-          - "3.0.5"
-          - "3.1.3"
+          - "3.3.1"
           - "3.2.1"
+          - "3.1.3"
+          - "3.0.5"
+    - gem: "hanami-2.1"
+      only:
+        ruby:
           - "3.3.1"
+          - "3.2.1"
+          - "3.1.3"
+          - "3.0.5"
     - gem: "http5"
     - gem: "padrino"
     - gem: "psych-3"
       only:
         ruby:
-          - "2.7.8"
-          - "3.0.5"
-          - "3.1.3"
-          - "3.2.1"
           - "3.3.1"
+          - "3.2.1"
+          - "3.1.3"
+          - "3.0.5"
+          - "2.7.8"
     - gem: "psych-4"
       only:
         ruby:
-          - "2.7.8"
-          - "3.0.5"
-          - "3.1.3"
-          - "3.2.1"
           - "3.3.1"
+          - "3.2.1"
+          - "3.1.3"
+          - "3.0.5"
+          - "2.7.8"
     - gem: "que"
     - gem: "que_beta"
     - gem: "rails-6.0"
       only:
         ruby:
-          - "2.7.8"
           - "3.0.5"
+          - "2.7.8"
           - "jruby-9.4.1.0"
     - gem: "rails-6.1"
       only:
         ruby:
-          - "2.7.8"
-          - "3.0.5"
-          - "3.1.3"
-          - "3.2.1"
           - "3.3.1"
+          - "3.2.1"
+          - "3.1.3"
+          - "3.0.5"
+          - "2.7.8"
           - "jruby-9.4.1.0"
     - gem: "rails-7.0"
       only:
         ruby:
-          - "2.7.8"
-          - "3.0.5"
-          - "3.1.3"
-          - "3.2.1"
           - "3.3.1"
+          - "3.2.1"
+          - "3.1.3"
+          - "3.0.5"
+          - "2.7.8"
           - "jruby-9.4.1.0"
     - gem: "rails-7.1"
       only:
         ruby:
-          - "3.0.5"
-          - "3.1.3"
-          - "3.2.1"
           - "3.3.1"
+          - "3.2.1"
+          - "3.1.3"
+          - "3.0.5"
           - "jruby-9.4.1.0"
     - gem: "sequel"
     - gem: "sinatra"

data/ext/base.rb

@@ -8,7 +8,7 @@ require "json"
 require "rubygems/package"
 require File.expand_path("../lib/appsignal/version.rb", __dir__)
 require File.expand_path("../lib/appsignal/system.rb", __dir__)
-require_relative "./agent"
+require_relative "agent"
 
 EXT_PATH = File.expand_path(__dir__).freeze
 

data/gemfiles/hanami-2.1.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem "hanami", "~> 2.1.0"
+gem "hanami-router", "~> 2.1.0"
+gem "hanami-controller", "~> 2.1.0"
+
+gemspec :path => '../'

data/lib/appsignal/cli/diagnose.rb

@@ -200,7 +200,7 @@ module Appsignal
             initial_config
           )
           Appsignal.config.write_to_environment
-          Appsignal.start_logger
+          Appsignal._start_logger
           Appsignal.internal_logger.info("Starting AppSignal diagnose")
         end
 

data/lib/appsignal/config.rb

@@ -233,7 +233,7 @@ module Appsignal
     #   variables config.
     # @param logger [Logger] The logger to use for the AppSignal gem. This is
     #   used by the configuration class only. Default:
-    #   {Appsignal.internal_logger}. See also {Appsignal.start_logger}.
+    #   {Appsignal.internal_logger}. See also {Appsignal.start}.
     # @param config_file [String] Custom config file location. Default
     #   `config/appsignal.yml`.
     #

data/lib/appsignal/demo.rb

@@ -29,7 +29,6 @@ module Appsignal
       #   - returns `false` if Appsignal is not active.
       def transmit
         Appsignal.start
-        Appsignal.start_logger
         return false unless Appsignal.active?
 
         create_example_error_request

data/lib/appsignal/environment.rb

@@ -3,6 +3,8 @@
 module Appsignal
   # @api private
   class Environment
+    ERROR_ON_YIELD = :APPSIGNAL_ERROR_ON_YIELD
+
     # Add environment metadata.
     #
     # The key and value of the environment metadata must be a String, even if
@@ -46,9 +48,11 @@ module Appsignal
           Appsignal.internal_logger.error \
             "Unable to report on environment metadata #{key.inspect}:\n" \
               "#{e.class}: #{e}"
-          return
+          ERROR_ON_YIELD
         end
 
+      return if yielded_value == ERROR_ON_YIELD
+
       value =
         case yielded_value
         when TrueClass, FalseClass

data/lib/appsignal/extension/jruby.rb

@@ -9,7 +9,7 @@ module Appsignal
     # Only loaded if the system is detected as JRuby.
     #
     # @api private
-    module Jruby # rubocop:disable Metrics/ModuleLength
+    module Jruby
       extend FFI::Library
 
       # JRuby extension String helpers.

data/lib/appsignal/helpers/instrumentation.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Helpers
-    module Instrumentation # rubocop:disable Metrics/ModuleLength
+    module Instrumentation
       include Appsignal::Utils::StdoutAndLoggerMessage
 
       # Creates an AppSignal transaction for the given block.

data/lib/appsignal/integrations/grape.rb

@@ -1,55 +1,27 @@
 # frozen_string_literal: true
 
+require "appsignal"
+require "appsignal/rack/grape_middleware"
+
+Appsignal.internal_logger.debug("Loading Grape integration")
+
 module Appsignal
-  # @todo Move to sub-namespace
   # @api private
   module Grape
-    class Middleware < ::Grape::Middleware::Base
-      def call(env)
-        if Appsignal.active?
-          call_with_appsignal_monitoring(env)
-        else
-          app.call(env)
-        end
-      end
-
-      def call_with_appsignal_monitoring(env)
-        request     = ::Rack::Request.new(env)
-        transaction = Appsignal::Transaction.create(
-          SecureRandom.uuid,
-          Appsignal::Transaction::HTTP_REQUEST,
-          request
-        )
-        begin
-          app.call(env)
-        rescue Exception => error # rubocop:disable Lint/RescueException
-          # Do not set error if "grape.skip_appsignal_error" is set to `true`.
-          transaction.set_error(error) unless env["grape.skip_appsignal_error"]
-          raise error
-        ensure
-          request_method = request.request_method.to_s.upcase
-          path = request.path # Path without namespaces
-          endpoint = env["api.endpoint"]
-
-          if endpoint&.options
-            options = endpoint.options
-            request_method = options[:method].first.to_s.upcase
-            klass = options[:for]
-            namespace = endpoint.namespace
-            namespace = "" if namespace == "/"
-
-            path = options[:path].first.to_s
-            path = "/#{path}" if path[0] != "/"
-            path = "#{namespace}#{path}"
-
-            transaction.set_action_if_nil("#{request_method}::#{klass}##{path}")
-          end
-
-          transaction.set_http_or_background_queue_start
-          transaction.set_metadata("path", path)
-          transaction.set_metadata("method", request_method)
-          Appsignal::Transaction.complete_current!
-        end
+    # Alias constants that have moved with a warning message that points to the
+    # place to update the reference.
+    def self.const_missing(name)
+      case name
+      when :Middleware
+        callers = caller
+        Appsignal::Utils::StdoutAndLoggerMessage.warning \
+          "The constant Appsignal::Grape::Middleware has been deprecated. " \
+            "Please update the constant name to " \
+            "Appsignal::Rack::GrapeMiddleware in the following file to " \
+            "remove this message.\n#{callers.first}"
+        Appsignal::Rack::GrapeMiddleware
+      else
+        super
       end
     end
   end

data/lib/appsignal/integrations/hanami.rb

@@ -11,13 +11,14 @@ module Appsignal
         Appsignal.internal_logger.debug("Loading Hanami integration")
 
         hanami_app_config = ::Hanami.app.config
-        Appsignal.config = Appsignal::Config.new(
-          hanami_app_config.root || Dir.pwd,
-          hanami_app_config.env
-        )
 
-        Appsignal.start_logger
-        Appsignal.start
+        unless Appsignal.active?
+          Appsignal.config = Appsignal::Config.new(
+            hanami_app_config.root || Dir.pwd,
+            hanami_app_config.env
+          )
+          Appsignal.start
+        end
 
         return unless Appsignal.active?
 
@@ -44,4 +45,4 @@ module Appsignal
   end
 end
 
-Appsignal::Integrations::HanamiPlugin.init
+Appsignal::Integrations::HanamiPlugin.init unless Appsignal.testing?

data/lib/appsignal/integrations/padrino.rb

@@ -12,63 +12,66 @@ module Appsignal
         root = Padrino.mounted_root
         Appsignal.config = Appsignal::Config.new(root, Padrino.env)
 
-        Appsignal.start_logger
         Appsignal.start
       end
     end
   end
 end
 
-module Appsignal::Integrations::PadrinoIntegration
-  def route!(base = settings, pass_block = nil)
-    return super if !Appsignal.active? || env["sinatra.static_file"]
+module Appsignal
+  module Integrations
+    module PadrinoIntegration
+      def route!(base = settings, pass_block = nil)
+        return super if !Appsignal.active? || env["sinatra.static_file"]
 
-    transaction = Appsignal::Transaction.create(
-      SecureRandom.uuid,
-      Appsignal::Transaction::HTTP_REQUEST,
-      request
-    )
-    begin
-      Appsignal.instrument("process_action.padrino") do
-        super
+        transaction = Appsignal::Transaction.create(
+          SecureRandom.uuid,
+          Appsignal::Transaction::HTTP_REQUEST,
+          request
+        )
+        begin
+          Appsignal.instrument("process_action.padrino") do
+            super
+          end
+        rescue Exception => error # rubocop:disable Lint/RescueException
+          transaction.set_error(error)
+          raise error
+        ensure
+          transaction.set_action_if_nil(get_payload_action(request))
+          transaction.set_metadata("path", request.path)
+          transaction.set_metadata("method", request.request_method)
+          transaction.set_http_or_background_queue_start
+          Appsignal::Transaction.complete_current!
+        end
       end
-    rescue Exception => error # rubocop:disable Lint/RescueException
-      transaction.set_error(error)
-      raise error
-    ensure
-      transaction.set_action_if_nil(get_payload_action(request))
-      transaction.set_metadata("path", request.path)
-      transaction.set_metadata("method", request.request_method)
-      transaction.set_http_or_background_queue_start
-      Appsignal::Transaction.complete_current!
-    end
-  end
 
-  private
+      private
 
-  def get_payload_action(request)
-    # Short-circut is there's no request object to obtain information from
-    return settings.name.to_s unless request
+      def get_payload_action(request)
+        # Short-circut is there's no request object to obtain information from
+        return settings.name.to_s unless request
 
-    # Newer versions expose the action / controller on the request class.
-    # Newer versions also still expose a route_obj so we must prioritize the
-    # action/fullpath methods.
-    # The `request.action` and `request.controller` values are `nil` when a
-    # endpoint is not found, `""` if not specified by the user.
-    controller_name = request.controller if request.respond_to?(:controller)
-    action_name = request.action if request.respond_to?(:action)
-    action_name ||= ""
+        # Newer versions expose the action / controller on the request class.
+        # Newer versions also still expose a route_obj so we must prioritize the
+        # action/fullpath methods.
+        # The `request.action` and `request.controller` values are `nil` when a
+        # endpoint is not found, `""` if not specified by the user.
+        controller_name = request.controller if request.respond_to?(:controller)
+        action_name = request.action if request.respond_to?(:action)
+        action_name ||= ""
 
-    return "#{settings.name}:#{controller_name}##{action_name}" unless action_name.empty?
+        return "#{settings.name}:#{controller_name}##{action_name}" unless action_name.empty?
 
-    # Older versions of Padrino work with a route object
-    if request.respond_to?(:route_obj) && request.route_obj
-      return "#{settings.name}:#{request.route_obj.original_path}"
-    end
+        # Older versions of Padrino work with a route object
+        if request.respond_to?(:route_obj) && request.route_obj
+          return "#{settings.name}:#{request.route_obj.original_path}"
+        end
 
-    # Fall back to the application name if we haven't found an action name in
-    # any previous methods.
-    "#{settings.name}#unknown"
+        # Fall back to the application name if we haven't found an action name in
+        # any previous methods.
+        "#{settings.name}#unknown"
+      end
+    end
   end
 end
 

data/lib/appsignal/integrations/railtie.rb

@@ -26,9 +26,6 @@ module Appsignal
           :log_path => Rails.root.join("log")
         )
 
-        # Start logger
-        Appsignal.start_logger
-
         app.middleware.insert(
           0,
           ::Rack::Events,

data/lib/appsignal/integrations/sinatra.rb

@@ -12,7 +12,6 @@ unless Appsignal.active?
     app_settings.environment
   )
 
-  Appsignal.start_logger
   Appsignal.start
 end