debian-mirror-gitlab/spec/lib/gitlab/instrumentation/redis_spec.rb

# frozen_string_literal: true

require 'spec_helper'
require 'support/helpers/rails_helpers'

RSpec.describe Gitlab::Instrumentation::Redis do
  def stub_storages(method, value)
    described_class::STORAGES.each do |storage|
      allow(storage).to receive(method) { value }
    end
  end

  shared_examples 'aggregation of redis storage data' do |method|
    describe "#{method} sum" do
      it "sums data from all Redis storages" do
        amount = 0.3

        stub_storages(method, amount)

        expect(described_class.public_send(method)).to eq(described_class::STORAGES.size * amount)
      end
    end
  end

  it_behaves_like 'aggregation of redis storage data', :get_request_count
  it_behaves_like 'aggregation of redis storage data', :get_cross_slot_request_count
  it_behaves_like 'aggregation of redis storage data', :get_allowed_cross_slot_request_count
  it_behaves_like 'aggregation of redis storage data', :query_time
  it_behaves_like 'aggregation of redis storage data', :read_bytes
  it_behaves_like 'aggregation of redis storage data', :write_bytes

  describe '.payload', :request_store do
    before do
      # If this is the first spec in a spec run that uses Redis, there
      # will be an extra SELECT command to choose the right database. We
      # don't want to make the spec less precise, so we force that to
      # happen (if needed) first, then clear the counts.
      Gitlab::Redis::Cache.with { |redis| redis.info }
      RequestStore.clear!

      stub_rails_env('staging') # to avoid raising CrossSlotError
      Gitlab::Redis::Cache.with { |redis| redis.mset('cache-test', 321, 'cache-test-2', 321) }
      Gitlab::Instrumentation::RedisClusterValidator.allow_cross_slot_commands do
        Gitlab::Redis::Cache.with { |redis| redis.mget('cache-test', 'cache-test-2') }
      end
      Gitlab::Redis::SharedState.with { |redis| redis.set('shared-state-test', 123) }
    end

    it 'returns payload filtering out zeroed values' do
      expected_payload = {
        # Aggregated results
        redis_calls: 3,
        redis_cross_slot_calls: 1,
        redis_allowed_cross_slot_calls: 1,
        redis_duration_s: be >= 0,
        redis_read_bytes: be >= 0,
        redis_write_bytes: be >= 0,

        # Cache results
        redis_cache_calls: 2,
        redis_cache_cross_slot_calls: 1,
        redis_cache_allowed_cross_slot_calls: 1,
        redis_cache_duration_s: be >= 0,
        redis_cache_read_bytes: be >= 0,
        redis_cache_write_bytes: be >= 0,

        # Shared state results
        redis_shared_state_calls: 1,
        redis_shared_state_duration_s: be >= 0,
        redis_shared_state_read_bytes: be >= 0,
        redis_shared_state_write_bytes: be >= 0
      }

      expect(described_class.payload).to include(expected_payload)
      expect(described_class.payload.keys).to match_array(expected_payload.keys)
    end
  end

  describe '.detail_store' do
    it 'returns a flat array of detail stores with the storage name added to each item' do
      details_row = { cmd: 'GET foo', duration: 1 }

      stub_storages(:detail_store, [details_row])

      expected_detail_stores = Gitlab::Redis::ALL_CLASSES.map(&:store_name)
                                 .map { |store_name| details_row.merge(storage: store_name) }
      expected_detail_stores << details_row.merge(storage: 'ActionCable')
      expect(described_class.detail_store).to contain_exactly(*expected_detail_stores)
    end
  end
end