speedshop-cloudwatch/test/active_job_test.rb at bb0fa41b3475570b3690887a493a24d092786a4b · speedshop/speedshop-cloudwatch · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# frozen_string_literal: true

require "test_helper"

begin
  require "active_job"
rescue LoadError
  return
end

ActiveJob::Base.queue_adapter = :test
ActiveJob::Base.logger = Logger.new(nil)

class TestJob < ActiveJob::Base
  include Speedshop::Cloudwatch::ActiveJob

  queue_as :default

  def perform(arg)
    arg
  end
end

class ActiveJobTest < SpeedshopCloudwatchTest
  def setup
    super
    Speedshop::Cloudwatch.config.namespaces[:active_job] = "ActiveJob"
    ActiveJob::Base.queue_adapter.enqueued_jobs.clear
    ActiveJob::Base.queue_adapter.performed_jobs.clear
  end

  def test_active_job_module_is_defined
    assert defined?(Speedshop::Cloudwatch::ActiveJob)
  end

  def test_active_job_has_included_method
    assert_respond_to Speedshop::Cloudwatch::ActiveJob, :included
  end

  def test_reports_queue_time_when_job_executes
    job = TestJob.new("test_arg")
    job.enqueued_at = Time.now.to_f - 2.5

    reported_kwargs = nil

    reporter = Speedshop::Cloudwatch.reporter
    reporter.stub :report, ->(**kwargs) {
      reported_kwargs = kwargs
    } do
      job.perform_now
    end

    assert_equal :QueueLatency, reported_kwargs[:metric]
    assert_operator reported_kwargs[:value], :>=, 2.5
    assert_equal 2, reported_kwargs[:dimensions].size
    assert_equal "TestJob", reported_kwargs[:dimensions][:JobClass]
    assert_equal "default", reported_kwargs[:dimensions][:QueueName]
  end

  def test_does_not_report_when_enqueued_at_is_nil
    job = TestJob.new("test_arg")
    job.enqueued_at = nil

    report_called = false
    reporter = Speedshop::Cloudwatch.reporter
    reporter.stub :report, ->(*) { report_called = true } do
      job.perform_now
    end

    refute report_called
  end

  def test_job_executes_successfully_even_if_reporting_fails
    job = TestJob.new("test_arg")
    job.enqueued_at = Time.now.to_f - 1.0

    reporter = Speedshop::Cloudwatch.reporter
    reporter.stub :report, ->(*) { raise "CloudWatch error" } do
      result = job.perform_now
      assert_equal "test_arg", result
    end
  end

  def test_uses_configured_namespace
    Speedshop::Cloudwatch.configure do |config|
      config.namespaces[:active_job] = "MyApp/Jobs"
    end

    job = TestJob.new("test_arg")
    job.enqueued_at = Time.now.to_f - 1.0

    reported_kwargs = nil
    reporter = Speedshop::Cloudwatch.reporter
    reporter.stub :report, ->(**kwargs) {
      reported_kwargs = kwargs
    } do
      job.perform_now
    end

    assert_equal :QueueLatency, reported_kwargs[:metric]
  end

  def test_respects_active_job_metrics_whitelist
    Speedshop::Cloudwatch.configure do |config|
      config.metrics[:active_job] = []
    end

    job = TestJob.new("test_arg")
    job.enqueued_at = Time.now.to_f - 1.0

    reporter = Speedshop::Cloudwatch.reporter
    queue = reporter.queue
    initial_size = queue.size

    job.perform_now

    assert_equal initial_size, queue.size
  end

  def test_logs_error_when_collection_fails
    error_logged = false
    logger = Object.new
    logger.define_singleton_method(:error) { |msg| error_logged = true if msg.include?("Failed to collect ActiveJob metrics") }
    logger.define_singleton_method(:debug) { |msg| }
    logger.define_singleton_method(:info) { |msg| }

    Speedshop::Cloudwatch.configure do |config|
      config.logger = logger
    end

    job = TestJob.new("test_arg")
    job.stub :enqueued_at, -> { raise "boom" } do
      result = job.perform_now
      assert_equal "test_arg", result
    end

    assert error_logged, "Expected error to be logged"
  end
end