diff options
Diffstat (limited to 'spec/lib/gitlab/usage/metrics/aggregates/sources')
3 files changed, 164 insertions, 20 deletions
diff --git a/spec/lib/gitlab/usage/metrics/aggregates/sources/calculations/intersection_spec.rb b/spec/lib/gitlab/usage/metrics/aggregates/sources/calculations/intersection_spec.rb new file mode 100644 index 00000000000..41cb445155e --- /dev/null +++ b/spec/lib/gitlab/usage/metrics/aggregates/sources/calculations/intersection_spec.rb @@ -0,0 +1,89 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe Gitlab::Usage::Metrics::Aggregates::Sources::Calculations::Intersection do + let_it_be(:recorded_at) { Time.current.to_i } + let_it_be(:start_date) { 4.weeks.ago.to_date } + let_it_be(:end_date) { Date.current } + + shared_examples 'aggregated_metrics_data with source' do + context 'with AND operator' do + let(:params) { { start_date: start_date, end_date: end_date, recorded_at: recorded_at } } + + context 'with even number of metrics' do + it 'calculates intersection correctly', :aggregate_failures do + # gmau_1 data is as follow + # |A| => 4 + expect(source).to receive(:calculate_metrics_union).with(params.merge(metric_names: 'event3')).and_return(4) + # |B| => 6 + expect(source).to receive(:calculate_metrics_union).with(params.merge(metric_names: 'event5')).and_return(6) + # |A + B| => 8 + expect(source).to receive(:calculate_metrics_union).with(params.merge(metric_names: %w[event3 event5])).and_return(8) + # Exclusion inclusion principle formula to calculate intersection of 2 sets + # |A & B| = (|A| + |B|) - |A + B| => (4 + 6) - 8 => 2 + expect(source.calculate_metrics_intersections(metric_names: %w[event3 event5], start_date: start_date, end_date: end_date, recorded_at: recorded_at)).to eq(2) + end + end + + context 'with odd number of metrics' do + it 'calculates intersection correctly', :aggregate_failures do + # gmau_2 data is as follow: + # |A| => 2 + expect(source).to receive(:calculate_metrics_union).with(params.merge(metric_names: 'event1')).and_return(2) + # |B| => 3 + expect(source).to receive(:calculate_metrics_union).with(params.merge(metric_names: 'event2')).and_return(3) + # |C| => 5 + expect(source).to receive(:calculate_metrics_union).with(params.merge(metric_names: 'event3')).and_return(5) + + # |A + B| => 4 therefore |A & B| = (|A| + |B|) - |A + B| => 2 + 3 - 4 => 1 + expect(source).to receive(:calculate_metrics_union).with(params.merge(metric_names: %w[event1 event2])).and_return(4) + # |A + C| => 6 therefore |A & C| = (|A| + |C|) - |A + C| => 2 + 5 - 6 => 1 + expect(source).to receive(:calculate_metrics_union).with(params.merge(metric_names: %w[event1 event3])).and_return(6) + # |B + C| => 7 therefore |B & C| = (|B| + |C|) - |B + C| => 3 + 5 - 7 => 1 + expect(source).to receive(:calculate_metrics_union).with(params.merge(metric_names: %w[event2 event3])).and_return(7) + # |A + B + C| => 8 + expect(source).to receive(:calculate_metrics_union).with(params.merge(metric_names: %w[event1 event2 event3])).and_return(8) + # Exclusion inclusion principle formula to calculate intersection of 3 sets + # |A & B & C| = (|A & B| + |A & C| + |B & C|) - (|A| + |B| + |C|) + |A + B + C| + # (1 + 1 + 1) - (2 + 3 + 5) + 8 => 1 + expect(source.calculate_metrics_intersections(metric_names: %w[event1 event2 event3], start_date: start_date, end_date: end_date, recorded_at: recorded_at)).to eq(1) + end + end + end + end + + describe '.aggregated_metrics_data' do + let(:source) do + Class.new do + extend Gitlab::Usage::Metrics::Aggregates::Sources::Calculations::Intersection + end + end + + it 'caches intermediate operations', :aggregate_failures do + events = %w[event1 event2 event3 event5] + + params = { start_date: start_date, end_date: end_date, recorded_at: recorded_at } + + events.each do |event| + expect(source).to receive(:calculate_metrics_union) + .with(params.merge(metric_names: event)) + .once + .and_return(0) + end + + 2.upto(4) do |subset_size| + events.combination(subset_size).each do |events| + expect(source).to receive(:calculate_metrics_union) + .with(params.merge(metric_names: events)) + .once + .and_return(0) + end + end + + expect(source.calculate_metrics_intersections(metric_names: events, start_date: start_date, end_date: end_date, recorded_at: recorded_at)).to eq(0) + end + + it_behaves_like 'aggregated_metrics_data with source' + end +end diff --git a/spec/lib/gitlab/usage/metrics/aggregates/sources/postgres_hll_spec.rb b/spec/lib/gitlab/usage/metrics/aggregates/sources/postgres_hll_spec.rb index db878828cd6..1ae4c9414dd 100644 --- a/spec/lib/gitlab/usage/metrics/aggregates/sources/postgres_hll_spec.rb +++ b/spec/lib/gitlab/usage/metrics/aggregates/sources/postgres_hll_spec.rb @@ -12,11 +12,7 @@ RSpec.describe Gitlab::Usage::Metrics::Aggregates::Sources::PostgresHll, :clean_ let(:metric_2) { 'metric_2' } let(:metric_names) { [metric_1, metric_2] } - describe '.calculate_events_union' do - subject(:calculate_metrics_union) do - described_class.calculate_metrics_union(metric_names: metric_names, start_date: start_date, end_date: end_date, recorded_at: recorded_at) - end - + describe 'metric calculations' do before do [ { @@ -36,23 +32,55 @@ RSpec.describe Gitlab::Usage::Metrics::Aggregates::Sources::PostgresHll, :clean_ end end - it 'returns the number of unique events in the union of all metrics' do - expect(calculate_metrics_union.round(2)).to eq(3.12) - end + describe '.calculate_events_union' do + subject(:calculate_metrics_union) do + described_class.calculate_metrics_union(metric_names: metric_names, start_date: start_date, end_date: end_date, recorded_at: recorded_at) + end + + it 'returns the number of unique events in the union of all metrics' do + expect(calculate_metrics_union.round(2)).to eq(3.12) + end + + context 'when there is no aggregated data saved' do + let(:metric_names) { [metric_1, 'i do not have any records'] } + + it 'raises error when union data is missing' do + expect { calculate_metrics_union }.to raise_error Gitlab::Usage::Metrics::Aggregates::Sources::UnionNotAvailable + end + end - context 'when there is no aggregated data saved' do - let(:metric_names) { [metric_1, 'i do not have any records'] } + context 'when there is only one metric defined as aggregated' do + let(:metric_names) { [metric_1] } - it 'raises error when union data is missing' do - expect { calculate_metrics_union }.to raise_error Gitlab::Usage::Metrics::Aggregates::Sources::UnionNotAvailable + it 'returns the number of unique events for that metric' do + expect(calculate_metrics_union.round(2)).to eq(2.08) + end end end - context 'when there is only one metric defined as aggregated' do - let(:metric_names) { [metric_1] } + describe '.calculate_metrics_intersections' do + subject(:calculate_metrics_intersections) do + described_class.calculate_metrics_intersections(metric_names: metric_names, start_date: start_date, end_date: end_date, recorded_at: recorded_at) + end + + it 'returns the number of common events in the intersection of all metrics' do + expect(calculate_metrics_intersections.round(2)).to eq(1.04) + end + + context 'when there is no aggregated data saved' do + let(:metric_names) { [metric_1, 'i do not have any records'] } - it 'returns the number of unique events for that metric' do - expect(calculate_metrics_union.round(2)).to eq(2.08) + it 'raises error when union data is missing' do + expect { calculate_metrics_intersections }.to raise_error Gitlab::Usage::Metrics::Aggregates::Sources::UnionNotAvailable + end + end + + context 'when there is only one metric defined in aggregate' do + let(:metric_names) { [metric_1] } + + it 'returns the number of common/unique events for the intersection of that metric' do + expect(calculate_metrics_intersections.round(2)).to eq(2.08) + end end end end diff --git a/spec/lib/gitlab/usage/metrics/aggregates/sources/redis_hll_spec.rb b/spec/lib/gitlab/usage/metrics/aggregates/sources/redis_hll_spec.rb index af2de5ea343..83b155b41b1 100644 --- a/spec/lib/gitlab/usage/metrics/aggregates/sources/redis_hll_spec.rb +++ b/spec/lib/gitlab/usage/metrics/aggregates/sources/redis_hll_spec.rb @@ -3,11 +3,12 @@ require 'spec_helper' RSpec.describe Gitlab::Usage::Metrics::Aggregates::Sources::RedisHll do - describe '.calculate_events_union' do - let(:event_names) { %w[event_a event_b] } - let(:start_date) { 7.days.ago } - let(:end_date) { Date.current } + let_it_be(:event_names) { %w[event_a event_b] } + let_it_be(:start_date) { 7.days.ago } + let_it_be(:end_date) { Date.current } + let_it_be(:recorded_at) { Time.current } + describe '.calculate_events_union' do subject(:calculate_metrics_union) do described_class.calculate_metrics_union(metric_names: event_names, start_date: start_date, end_date: end_date, recorded_at: nil) end @@ -26,4 +27,30 @@ RSpec.describe Gitlab::Usage::Metrics::Aggregates::Sources::RedisHll do expect { calculate_metrics_union }.to raise_error Gitlab::Usage::Metrics::Aggregates::Sources::UnionNotAvailable end end + + describe '.calculate_metrics_intersections' do + subject(:calculate_metrics_intersections) do + described_class.calculate_metrics_intersections(metric_names: event_names, start_date: start_date, end_date: end_date, recorded_at: recorded_at) + end + + it 'uses values returned by union to compute the intersection' do + event_names.each do |event| + expect(Gitlab::Usage::Metrics::Aggregates::Sources::RedisHll).to receive(:calculate_metrics_union) + .with(metric_names: event, start_date: start_date, end_date: end_date, recorded_at: recorded_at) + .and_return(5) + end + + expect(Gitlab::Usage::Metrics::Aggregates::Sources::RedisHll).to receive(:calculate_metrics_union) + .with(metric_names: event_names, start_date: start_date, end_date: end_date, recorded_at: recorded_at) + .and_return(2) + + expect(calculate_metrics_intersections).to eq(8) + end + + it 'raises error if union is < 0' do + allow(Gitlab::Usage::Metrics::Aggregates::Sources::RedisHll).to receive(:calculate_metrics_union).and_raise(Gitlab::Usage::Metrics::Aggregates::Sources::UnionNotAvailable) + + expect { calculate_metrics_intersections }.to raise_error(Gitlab::Usage::Metrics::Aggregates::Sources::UnionNotAvailable) + end + end end |