summaryrefslogtreecommitdiff
path: root/spec/services/metrics/dashboard/transient_embed_service_spec.rb
blob: 53ea83c33d685ce69fbf2ae5d30df6c1ff804645 (plain)
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
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Metrics::Dashboard::TransientEmbedService, :use_clean_rails_memory_store_caching do
  let_it_be(:project) { build(:project) }
  let_it_be(:user) { create(:user) }
  let_it_be(:environment) { create(:environment, project: project) }

  before do
    project.add_maintainer(user) if user
  end

  describe '.valid_params?' do
    let(:params) { { embedded: 'true', embed_json: '{}' } }

    subject { described_class.valid_params?(params) }

    it { is_expected.to be_truthy }

    context 'missing embedded' do
      let(:params) { { embed_json: '{}' } }

      it { is_expected.to be_falsey }
    end

    context 'not embedded' do
      let(:params) { { embedded: 'false', embed_json: '{}' } }

      it { is_expected.to be_falsey }
    end

    context 'missing embed_json' do
      let(:params) { { embedded: 'true' } }

      it { is_expected.to be_falsey }
    end
  end

  describe '#get_dashboard' do
    let(:embed_json) { get_embed_json }
    let(:service_params) { [project, user, { environment: environment, embedded: 'true', embed_json: embed_json }] }
    let(:service_call) { described_class.new(*service_params).get_dashboard }

    it_behaves_like 'valid embedded dashboard service response'
    it_behaves_like 'raises error for users with insufficient permissions'

    it 'caches the unprocessed dashboard for subsequent calls' do
      expect_any_instance_of(described_class)
        .to receive(:get_raw_dashboard)
        .once
        .and_call_original

      described_class.new(*service_params).get_dashboard
      described_class.new(*service_params).get_dashboard
    end

    it 'caches unique requests separately' do
      alt_embed_json = get_embed_json('area-chart')
      alt_service_params = [project, user, { environment: environment, embedded: 'true', embed_json: alt_embed_json }]

      embed = described_class.new(*service_params).get_dashboard
      alt_embed = described_class.new(*alt_service_params).get_dashboard

      expect(embed).not_to eq(alt_embed)
      expect(get_type_for_embed(embed)).to eq('line-graph')
      expect(get_type_for_embed(alt_embed)).to eq('area-chart')
    end

    context 'when embed_json cannot be parsed as json' do
      let(:embed_json) { '' }

      it_behaves_like 'misconfigured dashboard service response', :unprocessable_entity
    end

    private

    def get_embed_json(type = 'line-graph')
      {
        panel_groups: [{
         panels: [{
           type: type,
           title: 'title',
           y_label: 'y_label',
           metrics: [{
             query_range: 'up',
             label: 'y_label'
           }]
         }]
        }]
      }.to_json
    end

    def get_type_for_embed(embed)
      embed[:dashboard][:panel_groups][0][:panels][0][:type]
    end
  end
end