gitlab-org--gitlab-foss/spec/features/calendar_spec.rb

200 lines
5.5 KiB
Ruby
Raw Normal View History

require 'spec_helper'
2018-07-05 02:32:05 -04:00
describe 'Contributions Calendar', :js do
let(:user) { create(:user) }
let(:contributed_project) { create(:project, :public, :repository) }
let(:issue_note) { create(:note, project: contributed_project) }
# Ex/ Sunday Jan 1, 2016
date_format = '%A %b %-d, %Y'
issue_title = 'Bug in old browser'
issue_params = { title: issue_title }
def get_cell_color_selector(contributions)
activity_colors = ["#ededed", "rgb(172, 213, 242)", "rgb(127, 168, 201)", "rgb(82, 123, 160)", "rgb(37, 78, 119)"]
# We currently don't actually test the cases with contributions >= 20
activity_colors_index =
if contributions > 0 && contributions < 10
1
elsif contributions >= 10 && contributions < 20
2
elsif contributions >= 20 && contributions < 30
3
elsif contributions >= 30
4
else
0
end
".user-contrib-cell[fill='#{activity_colors[activity_colors_index]}']"
end
def get_cell_date_selector(contributions, date)
contribution_text =
if contributions.zero?
'No contributions'
else
"#{contributions} #{'contribution'.pluralize(contributions)}"
end
"#{get_cell_color_selector(contributions)}[data-original-title='#{contribution_text}<br />#{date}']"
end
def push_code_contribution
Migrate events into a new format This commit migrates events data in such a way that push events are stored much more efficiently. This is done by creating a shadow table called "events_for_migration", and a table called "push_event_payloads" which is used for storing push data of push events. The background migration in this commit will copy events from the "events" table into the "events_for_migration" table, push events in will also have a row created in "push_event_payloads". This approach allows us to reclaim space in the next release by simply swapping the "events" and "events_for_migration" tables, then dropping the old events (now "events_for_migration") table. The new table structure is also optimised for storage space, and does not include the unused "title" column nor the "data" column (since this data is moved to "push_event_payloads"). == Newly Created Events Newly created events are inserted into both "events" and "events_for_migration", both using the exact same primary key value. The table "push_event_payloads" in turn has a foreign key to the _shadow_ table. This removes the need for recreating and validating the foreign key after swapping the tables. Since the shadow table also has a foreign key to "projects.id" we also don't have to worry about orphaned rows. This approach however does require some additional storage as we're duplicating a portion of the events data for at least 1 release. The exact amount is hard to estimate, but for GitLab.com this is expected to be between 10 and 20 GB at most. The background migration in this commit deliberately does _not_ update the "events" table as doing so would put a lot of pressure on PostgreSQL's auto vacuuming system. == Supporting Both Old And New Events Application code has also been adjusted to support push events using both the old and new data formats. This is done by creating a PushEvent class which extends the regular Event class. Using Rails' Single Table Inheritance system we can ensure the right class is used for the right data, which in this case is based on the value of `events.action`. To support displaying old and new data at the same time the PushEvent class re-defines a few methods of the Event class, falling back to their original implementations for push events in the old format. Once all existing events have been migrated the various push event related methods can be removed from the Event model, and the calls to `super` can be removed from the methods in the PushEvent model. The UI and event atom feed have also been slightly changed to better handle this new setup, fortunately only a few changes were necessary to make this work. == API Changes The API only displays push data of events in the new format. Supporting both formats in the API is a bit more difficult compared to the UI. Since the old push data was not really well documented (apart from one example that used an incorrect "action" nmae) I decided that supporting both was not worth the effort, especially since events will be migrated in a few days _and_ new events are created in the correct format.
2017-07-10 11:43:57 -04:00
event = create(:push_event, project: contributed_project, author: user)
create(:push_event_payload,
event: event,
commit_from: '11f9ac0a48b62cef25eedede4c1819964f08d5ce',
commit_to: '1cf19a015df3523caf0a1f9d40c98a267d6a2fc2',
commit_count: 3,
ref: 'master')
end
def note_comment_contribution
note_comment_params = {
project: contributed_project,
action: Event::COMMENTED,
target: issue_note,
author_id: user.id
}
Event.create(note_comment_params)
end
def selected_day_activities(visible: true)
find('.user-calendar-activities', visible: visible).text
end
before do
sign_in user
end
describe 'calendar day selection' do
before do
visit user.username
wait_for_requests
end
it 'displays calendar' do
expect(page).to have_css('.js-contrib-calendar')
end
describe 'select calendar day' do
let(:cells) { page.all('.user-contrib-cell') }
before do
cells[0].click
wait_for_requests
@first_day_activities = selected_day_activities
end
it 'displays calendar day activities' do
expect(selected_day_activities).not_to be_empty
end
describe 'select another calendar day' do
before do
cells[1].click
wait_for_requests
end
it 'displays different calendar day activities' do
expect(selected_day_activities).not_to eq(@first_day_activities)
end
end
describe 'deselect calendar day' do
before do
cells[0].click
wait_for_requests
end
it 'hides calendar day activities' do
expect(selected_day_activities(visible: false)).to be_empty
end
end
end
end
describe 'calendar daily activities' do
shared_context 'visit user page' do
before do
visit user.username
wait_for_requests
end
end
shared_examples 'a day with activity' do |contribution_count:|
include_context 'visit user page'
it 'displays calendar activity square color for 1 contribution' do
expect(page).to have_selector(get_cell_color_selector(contribution_count), count: 1)
end
it 'displays calendar activity square on the correct date' do
today = Date.today.strftime(date_format)
expect(page).to have_selector(get_cell_date_selector(contribution_count, today), count: 1)
end
end
describe '1 issue creation calendar activity' do
before do
Issues::CreateService.new(contributed_project, user, issue_params).execute
end
it_behaves_like 'a day with activity', contribution_count: 1
describe 'issue title is shown on activity page' do
include_context 'visit user page'
it 'displays calendar activity log' do
expect(find('.content_list .event-note')).to have_content issue_title
end
end
end
describe '1 comment calendar activity' do
before do
note_comment_contribution
end
it_behaves_like 'a day with activity', contribution_count: 1
end
describe '10 calendar activities' do
before do
10.times { push_code_contribution }
end
it_behaves_like 'a day with activity', contribution_count: 10
end
describe 'calendar activity on two days' do
before do
push_code_contribution
Timecop.freeze(Date.yesterday) do
Issues::CreateService.new(contributed_project, user, issue_params).execute
end
end
include_context 'visit user page'
it 'displays calendar activity squares for both days' do
expect(page).to have_selector(get_cell_color_selector(1), count: 2)
end
it 'displays calendar activity square for yesterday' do
yesterday = Date.yesterday.strftime(date_format)
expect(page).to have_selector(get_cell_date_selector(1, yesterday), count: 1)
end
it 'displays calendar activity square for today' do
today = Date.today.strftime(date_format)
expect(page).to have_selector(get_cell_date_selector(1, today), count: 1)
end
end
end
end