2019-11-20 21:06:38 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
|
|
|
require 'spec_helper'
|
|
|
|
require 'sidekiq/testing'
|
|
|
|
|
2020-06-24 18:09:03 +00:00
|
|
|
RSpec.describe Gitlab::SidekiqMiddleware do
|
2020-05-15 09:07:59 +00:00
|
|
|
before do
|
|
|
|
stub_const('TestWorker', Class.new)
|
2019-11-20 21:06:38 +00:00
|
|
|
|
2020-05-15 09:07:59 +00:00
|
|
|
TestWorker.class_eval do
|
|
|
|
include Sidekiq::Worker
|
2020-05-19 12:08:21 +00:00
|
|
|
include ApplicationWorker
|
2020-05-15 09:07:59 +00:00
|
|
|
|
|
|
|
def perform(_arg)
|
|
|
|
Gitlab::SafeRequestStore['gitaly_call_actual'] = 1
|
2020-05-21 00:08:06 +00:00
|
|
|
Gitlab::SafeRequestStore[:gitaly_query_time] = 5
|
2020-05-15 09:07:59 +00:00
|
|
|
end
|
2019-11-20 21:06:38 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
around do |example|
|
|
|
|
Sidekiq::Testing.inline! { example.run }
|
|
|
|
end
|
|
|
|
|
|
|
|
let(:worker_class) { TestWorker }
|
|
|
|
let(:job_args) { [0.01] }
|
|
|
|
|
|
|
|
# The test sets up a new server middleware stack, ensuring that the
|
|
|
|
# appropriate middlewares, as passed into server_configurator,
|
|
|
|
# are invoked.
|
|
|
|
# Additionally the test ensure that each middleware is
|
|
|
|
# 1) not failing
|
|
|
|
# 2) yielding exactly once
|
|
|
|
describe '.server_configurator' do
|
2019-12-16 03:07:29 +00:00
|
|
|
around do |example|
|
2020-04-21 15:21:10 +00:00
|
|
|
with_sidekiq_server_middleware do |chain|
|
|
|
|
described_class.server_configurator(
|
|
|
|
metrics: metrics,
|
|
|
|
arguments_logger: arguments_logger,
|
2020-04-24 12:10:16 +00:00
|
|
|
memory_killer: memory_killer
|
2020-04-21 15:21:10 +00:00
|
|
|
).call(chain)
|
|
|
|
|
|
|
|
example.run
|
|
|
|
end
|
2019-12-16 03:07:29 +00:00
|
|
|
end
|
|
|
|
|
2019-11-20 21:06:38 +00:00
|
|
|
let(:middleware_expected_args) { [a_kind_of(worker_class), hash_including({ 'args' => job_args }), anything] }
|
|
|
|
let(:all_sidekiq_middlewares) do
|
|
|
|
[
|
|
|
|
Gitlab::SidekiqMiddleware::Monitor,
|
|
|
|
Gitlab::SidekiqMiddleware::BatchLoader,
|
2020-01-03 15:08:33 +00:00
|
|
|
Labkit::Middleware::Sidekiq::Server,
|
2019-11-20 21:06:38 +00:00
|
|
|
Gitlab::SidekiqMiddleware::InstrumentationLogger,
|
2020-08-04 15:09:27 +00:00
|
|
|
Gitlab::SidekiqVersioning::Middleware,
|
2019-11-20 21:06:38 +00:00
|
|
|
Gitlab::SidekiqStatus::ServerMiddleware,
|
2020-01-16 18:08:46 +00:00
|
|
|
Gitlab::SidekiqMiddleware::ServerMetrics,
|
2019-11-20 21:06:38 +00:00
|
|
|
Gitlab::SidekiqMiddleware::ArgumentsLogger,
|
|
|
|
Gitlab::SidekiqMiddleware::MemoryKiller,
|
2020-01-24 12:09:01 +00:00
|
|
|
Gitlab::SidekiqMiddleware::RequestStoreMiddleware,
|
2020-05-19 12:08:21 +00:00
|
|
|
Gitlab::SidekiqMiddleware::ExtraDoneLogMetadata,
|
2020-02-05 18:09:06 +00:00
|
|
|
Gitlab::SidekiqMiddleware::WorkerContext::Server,
|
2020-02-27 18:09:21 +00:00
|
|
|
Gitlab::SidekiqMiddleware::AdminMode::Server,
|
|
|
|
Gitlab::SidekiqMiddleware::DuplicateJobs::Server
|
2019-11-20 21:06:38 +00:00
|
|
|
]
|
|
|
|
end
|
2020-08-11 03:11:00 +00:00
|
|
|
|
2019-11-20 21:06:38 +00:00
|
|
|
let(:enabled_sidekiq_middlewares) { all_sidekiq_middlewares - disabled_sidekiq_middlewares }
|
|
|
|
|
2020-04-21 15:21:10 +00:00
|
|
|
shared_examples "a server middleware chain" do
|
|
|
|
it "passes through the right server middlewares" do
|
|
|
|
enabled_sidekiq_middlewares.each do |middleware|
|
|
|
|
expect_any_instance_of(middleware).to receive(:call).with(*middleware_expected_args).once.and_call_original
|
|
|
|
end
|
|
|
|
|
|
|
|
disabled_sidekiq_middlewares.each do |middleware|
|
|
|
|
expect_any_instance_of(middleware).not_to receive(:call)
|
|
|
|
end
|
2019-11-20 21:06:38 +00:00
|
|
|
|
2020-04-21 15:21:10 +00:00
|
|
|
worker_class.perform_async(*job_args)
|
2019-11-20 21:06:38 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2020-08-04 15:09:27 +00:00
|
|
|
shared_examples "a server middleware chain for mailer" do
|
|
|
|
let(:worker_class) { ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper }
|
|
|
|
let(:job_args) do
|
|
|
|
[
|
|
|
|
{
|
|
|
|
"job_class" => "ActionMailer::MailDeliveryJob",
|
|
|
|
"job_id" => "a180b47c-3fd6-41b8-81e9-34da61c3400e",
|
|
|
|
"provider_job_id" => nil,
|
|
|
|
"queue_name" => "mailers",
|
|
|
|
"priority" => nil,
|
|
|
|
"arguments" => [
|
|
|
|
"Notify",
|
|
|
|
"test_email",
|
|
|
|
"deliver_now",
|
|
|
|
{
|
|
|
|
"args" => [
|
|
|
|
"test@example.com",
|
|
|
|
"subject",
|
|
|
|
"body"
|
|
|
|
],
|
2021-01-07 18:10:38 +00:00
|
|
|
ActiveJob::Arguments.const_get('RUBY2_KEYWORDS_KEY', false) => ["args"]
|
2020-08-04 15:09:27 +00:00
|
|
|
}
|
|
|
|
],
|
|
|
|
"executions" => 0,
|
|
|
|
"exception_executions" => {},
|
|
|
|
"locale" => "en",
|
|
|
|
"timezone" => "UTC",
|
|
|
|
"enqueued_at" => "2020-07-27T07:43:31Z"
|
|
|
|
}
|
|
|
|
]
|
|
|
|
end
|
|
|
|
|
|
|
|
it_behaves_like "a server middleware chain"
|
|
|
|
end
|
|
|
|
|
2019-11-20 21:06:38 +00:00
|
|
|
context "all optional middlewares off" do
|
|
|
|
let(:metrics) { false }
|
|
|
|
let(:arguments_logger) { false }
|
|
|
|
let(:memory_killer) { false }
|
|
|
|
let(:disabled_sidekiq_middlewares) do
|
|
|
|
[
|
2020-01-16 18:08:46 +00:00
|
|
|
Gitlab::SidekiqMiddleware::ServerMetrics,
|
2019-11-20 21:06:38 +00:00
|
|
|
Gitlab::SidekiqMiddleware::ArgumentsLogger,
|
2020-04-24 12:10:16 +00:00
|
|
|
Gitlab::SidekiqMiddleware::MemoryKiller
|
2019-11-20 21:06:38 +00:00
|
|
|
]
|
|
|
|
end
|
|
|
|
|
2020-04-21 15:21:10 +00:00
|
|
|
it_behaves_like "a server middleware chain"
|
2020-08-04 15:09:27 +00:00
|
|
|
it_behaves_like "a server middleware chain for mailer"
|
2019-11-20 21:06:38 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
context "all optional middlewares on" do
|
|
|
|
let(:metrics) { true }
|
|
|
|
let(:arguments_logger) { true }
|
|
|
|
let(:memory_killer) { true }
|
|
|
|
let(:disabled_sidekiq_middlewares) { [] }
|
|
|
|
|
2020-04-21 15:21:10 +00:00
|
|
|
it_behaves_like "a server middleware chain"
|
2020-08-04 15:09:27 +00:00
|
|
|
it_behaves_like "a server middleware chain for mailer"
|
2020-03-17 00:09:12 +00:00
|
|
|
|
|
|
|
context "server metrics" do
|
|
|
|
let(:gitaly_histogram) { double(:gitaly_histogram) }
|
|
|
|
|
|
|
|
before do
|
|
|
|
allow(Gitlab::Metrics).to receive(:histogram).and_call_original
|
|
|
|
|
|
|
|
allow(Gitlab::Metrics).to receive(:histogram)
|
|
|
|
.with(:sidekiq_jobs_gitaly_seconds, anything, anything, anything)
|
|
|
|
.and_return(gitaly_histogram)
|
|
|
|
end
|
|
|
|
|
|
|
|
it "records correct Gitaly duration" do
|
|
|
|
expect(gitaly_histogram).to receive(:observe).with(anything, 5.0)
|
|
|
|
|
|
|
|
worker_class.perform_async(*job_args)
|
|
|
|
end
|
|
|
|
end
|
2019-11-20 21:06:38 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# The test sets up a new client middleware stack. The test ensures
|
|
|
|
# that each middleware is:
|
|
|
|
# 1) not failing
|
|
|
|
# 2) yielding exactly once
|
|
|
|
describe '.client_configurator' do
|
|
|
|
let(:chain) { Sidekiq::Middleware::Chain.new }
|
|
|
|
let(:job) { { 'args' => job_args } }
|
|
|
|
let(:queue) { 'default' }
|
|
|
|
let(:redis_pool) { Sidekiq.redis_pool }
|
|
|
|
let(:middleware_expected_args) { [worker_class_arg, job, queue, redis_pool] }
|
2020-01-31 09:08:53 +00:00
|
|
|
let(:expected_middlewares) do
|
|
|
|
[
|
2020-04-06 12:10:44 +00:00
|
|
|
::Gitlab::SidekiqMiddleware::WorkerContext::Client,
|
|
|
|
::Labkit::Middleware::Sidekiq::Client,
|
|
|
|
::Gitlab::SidekiqMiddleware::DuplicateJobs::Client,
|
|
|
|
::Gitlab::SidekiqStatus::ClientMiddleware,
|
|
|
|
::Gitlab::SidekiqMiddleware::AdminMode::Client,
|
2021-02-25 12:11:01 +00:00
|
|
|
::Gitlab::SidekiqMiddleware::SizeLimiter::Client,
|
2020-04-06 12:10:44 +00:00
|
|
|
::Gitlab::SidekiqMiddleware::ClientMetrics
|
2020-01-31 09:08:53 +00:00
|
|
|
]
|
|
|
|
end
|
2019-11-20 21:06:38 +00:00
|
|
|
|
|
|
|
before do
|
|
|
|
described_class.client_configurator.call(chain)
|
|
|
|
end
|
|
|
|
|
|
|
|
shared_examples "a client middleware chain" do
|
|
|
|
# Its possible that a middleware could accidentally omit a yield call
|
|
|
|
# this will prevent the full middleware chain from being executed.
|
|
|
|
# This test ensures that this does not happen
|
|
|
|
it "invokes the chain" do
|
2020-01-31 09:08:53 +00:00
|
|
|
expected_middlewares do |middleware|
|
|
|
|
expect_any_instance_of(middleware).to receive(:call).with(*middleware_expected_args).once.ordered.and_call_original
|
|
|
|
end
|
2019-11-20 21:06:38 +00:00
|
|
|
|
|
|
|
expect { |b| chain.invoke(worker_class_arg, job, queue, redis_pool, &b) }.to yield_control.once
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# Sidekiq documentation states that the worker class could be a string
|
|
|
|
# or a class reference. We should test for both
|
|
|
|
context "handles string worker_class values" do
|
|
|
|
let(:worker_class_arg) { worker_class.to_s }
|
|
|
|
|
|
|
|
it_behaves_like "a client middleware chain"
|
|
|
|
end
|
|
|
|
|
|
|
|
context "handles string worker_class values" do
|
|
|
|
let(:worker_class_arg) { worker_class }
|
|
|
|
|
|
|
|
it_behaves_like "a client middleware chain"
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|