summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/contributions_calendar_spec.rb
blob: 8a9ab736d46448c48a9f2ed13cccdf9160e76cdc (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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::ContributionsCalendar do
  let(:contributor) { create(:user) }
  let(:user) { create(:user) }
  let(:travel_time) { nil }

  let(:private_project) do
    create(:project, :private) do |project|
      create(:project_member, user: contributor, project: project)
    end
  end

  let(:public_project) do
    create(:project, :public, :repository) do |project|
      create(:project_member, user: contributor, project: project)
    end
  end

  let(:feature_project) do
    create(:project, :public, :issues_private) do |project|
      create(:project_member, user: contributor, project: project).project
    end
  end

  let(:today) { Time.now.utc.to_date }
  let(:yesterday) { today - 1.day }
  let(:tomorrow)  { today + 1.day }
  let(:last_week) { today - 7.days }
  let(:last_year) { today - 1.year }

  before do
    travel_to travel_time || Time.now.utc.end_of_day
  end

  after do
    travel_back
  end

  def calendar(current_user = nil)
    described_class.new(contributor, current_user)
  end

  def create_event(project, day, hour = 0, action = :created, target_symbol = :issue)
    @targets ||= {}
    @targets[project] ||= create(target_symbol, project: project, author: contributor)

    Event.create!(
      project: project,
      action: action,
      target_type: @targets[project].class.name,
      target_id: @targets[project].id,
      author: contributor,
      created_at: DateTime.new(day.year, day.month, day.day, hour)
    )
  end

  describe '#activity_dates' do
    it "returns a hash of date => count" do
      create_event(public_project, last_week)
      create_event(public_project, last_week)
      create_event(public_project, today)

      expect(calendar.activity_dates).to eq(last_week => 2, today => 1)
    end

    context "when the user has opted-in for private contributions" do
      before do
        contributor.update_column(:include_private_contributions, true)
      end

      it "shows private and public events to all users" do
        create_event(private_project, today)
        create_event(public_project, today)

        expect(calendar.activity_dates[today]).to eq(2)
        expect(calendar(user).activity_dates[today]).to eq(2)
        expect(calendar(contributor).activity_dates[today]).to eq(2)
      end

      # tests for bug https://gitlab.com/gitlab-org/gitlab/-/merge_requests/74826
      it "still counts correct with feature access levels set to private" do
        create_event(private_project, today)

        private_project.project_feature.update_attribute(:issues_access_level, ProjectFeature::PRIVATE)
        private_project.project_feature.update_attribute(:repository_access_level, ProjectFeature::PRIVATE)
        private_project.project_feature.update_attribute(:merge_requests_access_level, ProjectFeature::PRIVATE)

        expect(calendar.activity_dates[today]).to eq(1)
        expect(calendar(user).activity_dates[today]).to eq(1)
        expect(calendar(contributor).activity_dates[today]).to eq(1)
      end

      it "does not fail if there are no contributed projects" do
        expect(calendar.activity_dates[today]).to eq(nil)
      end
    end

    it "counts the diff notes on merge request" do
      create_event(public_project, today, 0, :commented, :diff_note_on_merge_request)

      expect(calendar(contributor).activity_dates[today]).to eq(1)
    end

    it "counts the discussions on merge requests and issues" do
      create_event(public_project, today, 0, :commented, :discussion_note_on_merge_request)
      create_event(public_project, today, 2, :commented, :discussion_note_on_issue)

      expect(calendar(contributor).activity_dates[today]).to eq(2)
    end

    context "when events fall under different dates depending on the system time zone" do
      before do
        create_event(public_project, today, 1)
        create_event(public_project, today, 4)
        create_event(public_project, today, 10)
        create_event(public_project, today, 16)
        create_event(public_project, today, 23)
      end

      it "renders correct event counts within the UTC timezone" do
        Time.use_zone('UTC') do
          expect(calendar.activity_dates).to eq(today => 5)
        end
      end

      it "renders correct event counts within the Sydney timezone" do
        Time.use_zone('Sydney') do
          expect(calendar.activity_dates).to eq(today => 3, tomorrow => 2)
        end
      end

      it "renders correct event counts within the US Central timezone" do
        Time.use_zone('Central Time (US & Canada)') do
          expect(calendar.activity_dates).to eq(yesterday => 2, today => 3)
        end
      end
    end

    context "when events fall under different dates depending on the contributor's time zone" do
      before do
        create_event(public_project, today, 1)
        create_event(public_project, today, 4)
        create_event(public_project, today, 10)
        create_event(public_project, today, 16)
        create_event(public_project, today, 23)
        create_event(public_project, tomorrow, 1)
      end

      it "renders correct event counts within the UTC timezone" do
        Time.use_zone('UTC') do
          contributor.timezone = 'UTC'
          expect(calendar.activity_dates).to eq(today => 5)
        end
      end

      it "renders correct event counts within the Sydney timezone" do
        Time.use_zone('UTC') do
          contributor.timezone = 'Sydney'
          expect(calendar.activity_dates).to eq(today => 3, tomorrow => 3)
        end
      end

      it "renders correct event counts within the US Central timezone" do
        Time.use_zone('UTC') do
          contributor.timezone = 'Central Time (US & Canada)'
          expect(calendar.activity_dates).to eq(yesterday => 2, today => 4)
        end
      end
    end
  end

  describe '#events_by_date' do
    it "returns all events for a given date" do
      e1 = create_event(public_project, today)
      e2 = create_event(public_project, today)
      create_event(public_project, last_week)

      expect(calendar.events_by_date(today)).to contain_exactly(e1, e2)
    end

    it "only shows private events to authorized users" do
      e1 = create_event(public_project, today)
      e2 = create_event(private_project, today)
      e3 = create_event(feature_project, today)
      create_event(public_project, last_week)

      expect(calendar.events_by_date(today)).to contain_exactly(e1, e3)
      expect(calendar(contributor).events_by_date(today)).to contain_exactly(e1, e2, e3)
    end

    it "includes diff notes on merge request" do
      e1 = create_event(public_project, today, 0, :commented, :diff_note_on_merge_request)

      expect(calendar.events_by_date(today)).to contain_exactly(e1)
    end

    context 'when the user cannot read cross project' do
      before do
        allow(Ability).to receive(:allowed?).and_call_original
        expect(Ability).to receive(:allowed?).with(user, :read_cross_project) { false }
      end

      it 'does not return any events' do
        create_event(public_project, today)

        expect(calendar(user).events_by_date(today)).to be_empty
      end
    end
  end

  describe '#starting_year' do
    let(:travel_time) { Time.find_zone('UTC').local(2020, 12, 31, 19, 0, 0) }

    context "when the contributor's timezone is not set" do
      it "is the start of last year in the system timezone" do
        expect(calendar.starting_year).to eq(2019)
      end
    end

    context "when the contributor's timezone is set to Sydney" do
      let(:contributor) { create(:user, { timezone: 'Sydney' }) }

      it "is the start of last year in Sydney" do
        expect(calendar.starting_year).to eq(2020)
      end
    end
  end

  describe '#starting_month' do
    let(:travel_time) { Time.find_zone('UTC').local(2020, 12, 31, 19, 0, 0) }

    context "when the contributor's timezone is not set" do
      it "is the start of this month in the system timezone" do
        expect(calendar.starting_month).to eq(12)
      end
    end

    context "when the contributor's timezone is set to Sydney" do
      let(:contributor) { create(:user, { timezone: 'Sydney' }) }

      it "is the start of this month in Sydney" do
        expect(calendar.starting_month).to eq(1)
      end
    end
  end
end