appsignal 2.5.3.alpha.1 → 2.5.3.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18e46cb221b16ec43eb3b45158ae8849dfbe0728
-  data.tar.gz: 63537221d5bbcec71aa6c9f096b732b8586d7033
+  metadata.gz: 8f00d44575997733185b772ca7194b3faf1b632b
+  data.tar.gz: f9047550c4e3a53d176136daf55c9648705dced0
 SHA512:
-  metadata.gz: 9f5fa1663e8fbf61b7e4f91501ff54dff521d567d0264a23c53d535580f25c423a7552829dcfa51a823bce599b143661f5f9a52ade22a12419c2a628f3e7d8dc
-  data.tar.gz: cfd6a663991702d6cade925af2f0b1d0ee7778bdd9e96511c68493ea44ba143a5e9f8e07fdac1186c748240f5877eb2fda37a60919429885ad25774525570ff0
+  metadata.gz: 7e9ac0366e2f2f7a1aec95ac17cf02c56a825abda1a28ad4783832b848ad13616caac9d6bb79561a3f0dbd9572824866b8f76107f26cec2aa3443f63fb2716c0
+  data.tar.gz: f21c211c3bd6ced23fe5941c66668b8103bb223d6e63b39825792c17605818389d6baef1353659e705cc332c004e0a3c736c0fe8b4d6de371ad8e198edc0c278

data/lib/appsignal/hooks/sidekiq.rb

@@ -86,37 +86,95 @@ module Appsignal
 
       # Based on: https://github.com/mperham/sidekiq/blob/63ee43353bd3b753beb0233f64865e658abeb1c3/lib/sidekiq/api.rb#L316-L334
       def parse_action_name(job)
-        args = job["args"]
-        case job["class"]
+        args = job.fetch("args", [])
+        job_class = job["class"]
+        case job_class
         when "Sidekiq::Extensions::DelayedModel"
-          safe_load(job["args"][0], job["class"]) do |target, method, _|
+          safe_load(args[0], job_class) do |target, method, _|
             "#{target.class}##{method}"
           end
         when /\ASidekiq::Extensions::Delayed/
-          safe_load(job["args"][0], job["class"]) do |target, method, _|
+          safe_load(args[0], job_class) do |target, method, _|
             "#{target}.#{method}"
           end
         when "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"
-          job_class = job["wrapped"] || args[0]
-          case job_class
-          when "ActionMailer::DeliveryJob"
-            # MailerClass#mailer_method
-            args[0]["arguments"][0..1].join("#")
-          when String
-            job_class
+          wrapped_job = job["wrapped"]
+          if wrapped_job
+            parse_active_job_action_name_from_wrapped job
           else
-            Appsignal.logger.debug \
-              "Unable to determine an action name from Sidekiq payload: #{job}"
-            UNKNOWN_ACTION_NAME
+            parse_active_job_action_name_from_arguments job
           end
         else
-          job["class"]
+          job_class
+        end
+      end
+
+      # Return the ActiveJob wrapped job name.
+      #
+      # Returns "unknown" if no acceptable job class name could be found.
+      #
+      # @example Payload with "wrapped" value
+      #   {
+      #     "class" => "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper",
+      #     "wrapped" => "MyWrappedJob",
+      #     # ...
+      #   }
+      def parse_active_job_action_name_from_wrapped(job)
+        job_class = job["wrapped"]
+        case job_class
+        when "ActionMailer::DeliveryJob"
+          extract_action_mailer_name job["args"]
+        when String
+          job_class
+        else
+          unknown_action_name_for job
         end
       end
 
+      # Return the ActiveJob job name based on the job's arguments.
+      #
+      # Returns "unknown" if no acceptable job class name could be found.
+      #
+      # @example Payload without "wrapped" value
+      #   {
+      #     "class" => "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper",
+      #     "args" => [{
+      #       "job_class" => "MyWrappedJob",
+      #       # ...
+      #     }]
+      #     # ...
+      #   }
+      def parse_active_job_action_name_from_arguments(job)
+        args = job.fetch("args", [])
+        first_arg = args[0]
+        if first_arg == "ActionMailer::DeliveryJob"
+          extract_action_mailer_name args
+        elsif active_job_payload?(first_arg)
+          first_arg["job_class"]
+        else
+          unknown_action_name_for job
+        end
+      end
+
+      # Checks if the first argument in the job payload is an ActiveJob payload.
+      def active_job_payload?(arg)
+        arg.is_a?(Hash) && arg["job_class"].is_a?(String)
+      end
+
+      def unknown_action_name_for(job)
+        Appsignal.logger.debug \
+          "Unable to determine an action name from Sidekiq payload: #{job}"
+        UNKNOWN_ACTION_NAME
+      end
+
+      def extract_action_mailer_name(args)
+        # Returns in format: MailerClass#mailer_method
+        args[0]["arguments"][0..1].join("#")
+      end
+
       # Based on: https://github.com/mperham/sidekiq/blob/63ee43353bd3b753beb0233f64865e658abeb1c3/lib/sidekiq/api.rb#L336-L358
       def parse_arguments(job)
-        args = job["args"]
+        args = job.fetch("args", [])
         case job["class"]
         when /\ASidekiq::Extensions::Delayed/
           safe_load(args[0], args) do |_, _, arg|
@@ -124,8 +182,14 @@ module Appsignal
           end
         when "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"
           is_wrapped = job["wrapped"]
-          job_args = is_wrapped ? args[0]["arguments"] : []
-          if (is_wrapped || args[0]) == "ActionMailer::DeliveryJob"
+          first_arg = args[0]
+          job_args =
+            if is_wrapped || active_job_payload?(first_arg)
+              first_arg["arguments"]
+            else
+              []
+            end
+          if (is_wrapped || first_arg) == "ActionMailer::DeliveryJob"
             # Remove MailerClass, mailer_method and "deliver_now"
             job_args.drop(3)
           else

data/lib/appsignal/version.rb

@@ -1,3 +1,3 @@
 module Appsignal
-  VERSION = "2.5.3.alpha.1".freeze
+  VERSION = "2.5.3.alpha.2".freeze
 end

data/spec/lib/appsignal/hooks/sidekiq_spec.rb

@@ -323,59 +323,110 @@ describe Appsignal::Hooks::SidekiqPlugin, :with_yaml_parse_error => false do
           {
             "class" => "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper",
             "queue" => "default",
-            "args" => [{
-              "job_class" => "ActiveMailerTestJob",
-              "job_id" => "23e79d48-6966-40d0-b2d4-f7938463a263",
-              "queue_name" => "default",
-              "arguments" => [
-                "MailerClass", "mailer_method", "deliver_now",
-                "foo", { "foo" => "Foo", "bar" => "Bar", "baz" => { 1 => :bar } }
-              ]
-            }],
+            "args" => [first_argument],
             "retry" => true,
             "jid" => "efb140489485999d32b5504c",
             "created_at" => Time.parse("2001-01-01 10:00:00UTC").to_f,
             "enqueued_at" => Time.parse("2001-01-01 10:00:00UTC").to_f
           }
         end
+        before { perform_job }
 
-        it "sets the action name to unknown and without sample data" do
-          perform_job
+        context "when the first argument is not a Hash object" do
+          let(:first_argument) { "foo" }
 
-          transaction_hash = transaction.to_h
-          expect(transaction_hash).to include(
-            "id" => kind_of(String),
-            "action" => "unknown",
-            "error" => nil,
-            "namespace" => namespace,
-            "metadata" => {
-              "queue" => "default"
-            },
-            "sample_data" => {
-              "environment" => {},
-              "params" => [],
-              "tags" => {}
-            }
-          )
-          # TODO: Not available in transaction.to_h yet.
-          # https://github.com/appsignal/appsignal-agent/issues/293
-          expect(transaction.request.env).to eq(
-            :queue_start => Time.parse("2001-01-01 10:00:00UTC").to_f
-          )
-          expect_transaction_to_have_sidekiq_event(transaction_hash)
+          include_examples "unknown job action name"
         end
 
-        it "logs a debug message" do
-          perform_job
+        context "when the first argument is a Hash object not containing a job payload" do
+          let(:first_argument) { { "foo" => "bar" } }
 
-          expect(log_contents(log)).to contains_log(
-            :debug, "Unable to determine an action name from Sidekiq payload: #{item}"
-          )
+          include_examples "unknown job action name"
+
+          context "when the argument contains an invalid job_class value" do
+            let(:first_argument) { { "job_class" => :foo } }
+
+            include_examples "unknown job action name"
+          end
+        end
+
+        context "when the first argument is a Hash object containing a job payload" do
+          let(:first_argument) do
+            {
+              "job_class" => "ActiveMailerTestJob",
+              "job_id" => "23e79d48-6966-40d0-b2d4-f7938463a263",
+              "queue_name" => "default",
+              "arguments" => [
+                "foo", { "foo" => "Foo", "bar" => "Bar", "baz" => { 1 => :bar } }
+              ]
+            }
+          end
+
+          it "sets the action name to the job class in the first argument" do
+            transaction_hash = transaction.to_h
+            expect(transaction_hash).to include(
+              "action" => "ActiveMailerTestJob#perform"
+            )
+          end
+
+          it "stores the job metadata on the transaction" do
+            transaction_hash = transaction.to_h
+            expect(transaction_hash).to include(
+              "id" => kind_of(String),
+              "error" => nil,
+              "namespace" => namespace,
+              "metadata" => {
+                "queue" => "default"
+              },
+              "sample_data" => {
+                "environment" => {},
+                "params" => [
+                  "foo",
+                  {
+                    "foo" => "Foo",
+                    "bar" => "Bar",
+                    "baz" => { "1" => "bar" }
+                  }
+                ],
+                "tags" => {}
+              }
+            )
+          end
+
+          it "does not log a debug message" do
+            expect(log_contents(log)).to_not contains_log(
+              :debug, "Unable to determine an action name from Sidekiq payload"
+            )
+          end
         end
       end
     end
   end
 
+  shared_examples "unknown job action name" do
+    it "sets the action name to unknown" do
+      transaction_hash = transaction.to_h
+      expect(transaction_hash).to include("action" => "unknown")
+    end
+
+    it "stores no sample data" do
+      transaction_hash = transaction.to_h
+      expect(transaction_hash).to include(
+        "sample_data" => {
+          "environment" => {},
+          "params" => [],
+          "tags" => {}
+        }
+      )
+    end
+
+    it "logs a debug message" do
+      expect(log_contents(log)).to contains_log(
+        :debug, "Unable to determine an action name from Sidekiq payload: #{item}"
+      )
+    end
+  end
+
   context "with an error" do
     let(:error) { ExampleException }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.5.3.alpha.1
+  version: 2.5.3.alpha.2
 platform: ruby
 authors:
 - Robert Beekman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-23 00:00:00.000000000 Z
+date: 2018-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack