|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +require "spec_helper" |
| 4 | +require "sidekiq" |
| 5 | +require "active_job" |
| 6 | +require "singed/sidekiq" |
| 7 | +require_relative "../support/sidekiq" |
| 8 | + |
| 9 | +RSpec.describe Singed::Sidekiq::ServerMiddleware, sidekiq: true do |
| 10 | + subject { job_class.set(job_modifiers).perform_async(*job_args) } |
| 11 | + |
| 12 | + let(:job_class) { SidekiqPlainJob } |
| 13 | + let(:job_args) { [] } |
| 14 | + let(:job_modifiers) { {} } |
| 15 | + |
| 16 | + before do |
| 17 | + allow_any_instance_of(described_class).to receive(:flamegraph) { |*, &block| block.call } |
| 18 | + allow_any_instance_of(job_class).to receive(:perform).and_call_original |
| 19 | + end |
| 20 | + |
| 21 | + context "with plain Sidekiq jobs" do |
| 22 | + it "doesn't capture flamegraph by default" do |
| 23 | + expect_any_instance_of(described_class).not_to receive(:flamegraph) |
| 24 | + expect_any_instance_of(job_class).to receive(:perform) |
| 25 | + subject |
| 26 | + end |
| 27 | + |
| 28 | + context "when x-singed payload is true" do |
| 29 | + let(:job_modifiers) { {"x-singed" => true} } |
| 30 | + |
| 31 | + it "wraps execution in flamegraph when x-singed is true" do |
| 32 | + expect_any_instance_of(described_class).to receive(:flamegraph) |
| 33 | + expect_any_instance_of(job_class).to receive(:perform) |
| 34 | + subject |
| 35 | + end |
| 36 | + end |
| 37 | + end |
| 38 | + |
| 39 | + context "with class-level capture_flamegraph?" do |
| 40 | + let(:job_class) { SidekiqFlamegraphJob } |
| 41 | + |
| 42 | + it "doesn't capture when capture_flamegraph? returns false" do |
| 43 | + expect_any_instance_of(described_class).not_to receive(:flamegraph) |
| 44 | + expect_any_instance_of(job_class).to receive(:perform) |
| 45 | + subject |
| 46 | + end |
| 47 | + |
| 48 | + context "when payload satisfies capture_flamegraph?" do |
| 49 | + let(:job_modifiers) { {"x-flamegraph" => true} } |
| 50 | + |
| 51 | + it "wraps execution in flamegraph when capture_flamegraph? returns true" do |
| 52 | + expect_any_instance_of(described_class).to receive(:flamegraph) |
| 53 | + expect_any_instance_of(job_class).to receive(:perform) |
| 54 | + subject |
| 55 | + end |
| 56 | + end |
| 57 | + end |
| 58 | + |
| 59 | + context "when SINGED_MIDDLEWARE_ALWAYS_CAPTURE env var is set" do |
| 60 | + around do |example| |
| 61 | + original = ENV["SINGED_MIDDLEWARE_ALWAYS_CAPTURE"] |
| 62 | + example.run |
| 63 | + ensure |
| 64 | + if original.nil? |
| 65 | + ENV.delete("SINGED_MIDDLEWARE_ALWAYS_CAPTURE") |
| 66 | + else |
| 67 | + ENV["SINGED_MIDDLEWARE_ALWAYS_CAPTURE"] = original |
| 68 | + end |
| 69 | + end |
| 70 | + |
| 71 | + context "when SINGED_MIDDLEWARE_ALWAYS_CAPTURE=true" do |
| 72 | + before { ENV["SINGED_MIDDLEWARE_ALWAYS_CAPTURE"] = "true" } |
| 73 | + |
| 74 | + it "wraps execution in flamegraph" do |
| 75 | + expect_any_instance_of(described_class).to receive(:flamegraph) |
| 76 | + expect_any_instance_of(job_class).to receive(:perform) |
| 77 | + subject |
| 78 | + end |
| 79 | + end |
| 80 | + |
| 81 | + context "when SINGED_MIDDLEWARE_ALWAYS_CAPTURE is false" do |
| 82 | + before { ENV["SINGED_MIDDLEWARE_ALWAYS_CAPTURE"] = "false" } |
| 83 | + |
| 84 | + it "doesn't capture flamegraph" do |
| 85 | + expect_any_instance_of(described_class).not_to receive(:flamegraph) |
| 86 | + expect_any_instance_of(job_class).to receive(:perform) |
| 87 | + subject |
| 88 | + end |
| 89 | + end |
| 90 | + end |
| 91 | + |
| 92 | + context "with ActiveJob jobs" do |
| 93 | + subject { job_class.set(job_modifiers).perform_later(*job_args) } |
| 94 | + |
| 95 | + context "with plain ActiveJob" do |
| 96 | + let(:job_class) { ActiveJobPlainJob } |
| 97 | + |
| 98 | + it "doesn't capture flamegraph by default" do |
| 99 | + expect_any_instance_of(described_class).not_to receive(:flamegraph) |
| 100 | + expect_any_instance_of(job_class).to receive(:perform) |
| 101 | + subject |
| 102 | + end |
| 103 | + |
| 104 | + context "with ActiveJob class where capture_flamegraph? is true" do |
| 105 | + let(:job_class) { ActiveJobFlamegraphJob } |
| 106 | + |
| 107 | + it "wraps execution in flamegraph when capture_flamegraph? returns true" do |
| 108 | + expect_any_instance_of(described_class).to receive(:flamegraph) |
| 109 | + expect_any_instance_of(job_class).to receive(:perform) |
| 110 | + subject |
| 111 | + end |
| 112 | + end |
| 113 | + |
| 114 | + context "with ActiveJob class where capture_flamegraph? is false" do |
| 115 | + let(:job_class) { ActiveJobNoFlamegraphJob } |
| 116 | + |
| 117 | + it "doesn't capture when capture_flamegraph? returns false" do |
| 118 | + expect_any_instance_of(described_class).not_to receive(:flamegraph) |
| 119 | + expect_any_instance_of(job_class).to receive(:perform) |
| 120 | + subject |
| 121 | + end |
| 122 | + end |
| 123 | + |
| 124 | + context "when SINGED_MIDDLEWARE_ALWAYS_CAPTURE env var is set" do |
| 125 | + around do |example| |
| 126 | + original = ENV["SINGED_MIDDLEWARE_ALWAYS_CAPTURE"] |
| 127 | + example.run |
| 128 | + ensure |
| 129 | + if original.nil? |
| 130 | + ENV.delete("SINGED_MIDDLEWARE_ALWAYS_CAPTURE") |
| 131 | + else |
| 132 | + ENV["SINGED_MIDDLEWARE_ALWAYS_CAPTURE"] = original |
| 133 | + end |
| 134 | + end |
| 135 | + |
| 136 | + context "when SINGED_MIDDLEWARE_ALWAYS_CAPTURE=true" do |
| 137 | + before { ENV["SINGED_MIDDLEWARE_ALWAYS_CAPTURE"] = "true" } |
| 138 | + |
| 139 | + it "wraps execution in flamegraph" do |
| 140 | + expect_any_instance_of(described_class).to receive(:flamegraph) |
| 141 | + expect_any_instance_of(job_class).to receive(:perform) |
| 142 | + subject |
| 143 | + end |
| 144 | + end |
| 145 | + |
| 146 | + context "when SINGED_MIDDLEWARE_ALWAYS_CAPTURE is false" do |
| 147 | + before { ENV["SINGED_MIDDLEWARE_ALWAYS_CAPTURE"] = "false" } |
| 148 | + |
| 149 | + it "doesn't capture flamegraph" do |
| 150 | + expect_any_instance_of(described_class).not_to receive(:flamegraph) |
| 151 | + expect_any_instance_of(job_class).to receive(:perform) |
| 152 | + subject |
| 153 | + end |
| 154 | + end |
| 155 | + end |
| 156 | + end |
| 157 | + end |
| 158 | +end |
0 commit comments