0395c47193
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.
202 lines
4.8 KiB
Ruby
202 lines
4.8 KiB
Ruby
require 'spec_helper'
|
|
|
|
describe PushEvent do
|
|
let(:payload) { PushEventPayload.new }
|
|
|
|
let(:event) do
|
|
event = described_class.new
|
|
|
|
allow(event).to receive(:push_event_payload).and_return(payload)
|
|
|
|
event
|
|
end
|
|
|
|
describe '.sti_name' do
|
|
it 'returns Event::PUSHED' do
|
|
expect(described_class.sti_name).to eq(Event::PUSHED)
|
|
end
|
|
end
|
|
|
|
describe '#push?' do
|
|
it 'returns true' do
|
|
expect(event).to be_push
|
|
end
|
|
end
|
|
|
|
describe '#push_with_commits?' do
|
|
it 'returns true when both the first and last commit are present' do
|
|
allow(event).to receive(:commit_from).and_return('123')
|
|
allow(event).to receive(:commit_to).and_return('456')
|
|
|
|
expect(event).to be_push_with_commits
|
|
end
|
|
|
|
it 'returns false when the first commit is missing' do
|
|
allow(event).to receive(:commit_to).and_return('456')
|
|
|
|
expect(event).not_to be_push_with_commits
|
|
end
|
|
|
|
it 'returns false when the last commit is missing' do
|
|
allow(event).to receive(:commit_from).and_return('123')
|
|
|
|
expect(event).not_to be_push_with_commits
|
|
end
|
|
end
|
|
|
|
describe '#tag?' do
|
|
it 'returns true when pushing to a tag' do
|
|
allow(payload).to receive(:tag?).and_return(true)
|
|
|
|
expect(event).to be_tag
|
|
end
|
|
|
|
it 'returns false when pushing to a branch' do
|
|
allow(payload).to receive(:tag?).and_return(false)
|
|
|
|
expect(event).not_to be_tag
|
|
end
|
|
end
|
|
|
|
describe '#branch?' do
|
|
it 'returns true when pushing to a branch' do
|
|
allow(payload).to receive(:branch?).and_return(true)
|
|
|
|
expect(event).to be_branch
|
|
end
|
|
|
|
it 'returns false when pushing to a tag' do
|
|
allow(payload).to receive(:branch?).and_return(false)
|
|
|
|
expect(event).not_to be_branch
|
|
end
|
|
end
|
|
|
|
describe '#valid_push?' do
|
|
it 'returns true if a ref exists' do
|
|
allow(payload).to receive(:ref).and_return('master')
|
|
|
|
expect(event).to be_valid_push
|
|
end
|
|
|
|
it 'returns false when no ref is present' do
|
|
expect(event).not_to be_valid_push
|
|
end
|
|
end
|
|
|
|
describe '#new_ref?' do
|
|
it 'returns true when pushing a new ref' do
|
|
allow(payload).to receive(:created?).and_return(true)
|
|
|
|
expect(event).to be_new_ref
|
|
end
|
|
|
|
it 'returns false when pushing to an existing ref' do
|
|
allow(payload).to receive(:created?).and_return(false)
|
|
|
|
expect(event).not_to be_new_ref
|
|
end
|
|
end
|
|
|
|
describe '#rm_ref?' do
|
|
it 'returns true when removing an existing ref' do
|
|
allow(payload).to receive(:removed?).and_return(true)
|
|
|
|
expect(event).to be_rm_ref
|
|
end
|
|
|
|
it 'returns false when pushing to an existing ref' do
|
|
allow(payload).to receive(:removed?).and_return(false)
|
|
|
|
expect(event).not_to be_rm_ref
|
|
end
|
|
end
|
|
|
|
describe '#commit_from' do
|
|
it 'returns the first commit SHA' do
|
|
allow(payload).to receive(:commit_from).and_return('123')
|
|
|
|
expect(event.commit_from).to eq('123')
|
|
end
|
|
end
|
|
|
|
describe '#commit_to' do
|
|
it 'returns the last commit SHA' do
|
|
allow(payload).to receive(:commit_to).and_return('123')
|
|
|
|
expect(event.commit_to).to eq('123')
|
|
end
|
|
end
|
|
|
|
describe '#ref_name' do
|
|
it 'returns the name of the ref' do
|
|
allow(payload).to receive(:ref).and_return('master')
|
|
|
|
expect(event.ref_name).to eq('master')
|
|
end
|
|
end
|
|
|
|
describe '#ref_type' do
|
|
it 'returns the type of the ref' do
|
|
allow(payload).to receive(:ref_type).and_return('branch')
|
|
|
|
expect(event.ref_type).to eq('branch')
|
|
end
|
|
end
|
|
|
|
describe '#branch_name' do
|
|
it 'returns the name of the branch' do
|
|
allow(payload).to receive(:ref).and_return('master')
|
|
|
|
expect(event.branch_name).to eq('master')
|
|
end
|
|
end
|
|
|
|
describe '#tag_name' do
|
|
it 'returns the name of the tag' do
|
|
allow(payload).to receive(:ref).and_return('1.2')
|
|
|
|
expect(event.tag_name).to eq('1.2')
|
|
end
|
|
end
|
|
|
|
describe '#commit_title' do
|
|
it 'returns the commit message' do
|
|
allow(payload).to receive(:commit_title).and_return('foo')
|
|
|
|
expect(event.commit_title).to eq('foo')
|
|
end
|
|
end
|
|
|
|
describe '#commit_id' do
|
|
it 'returns the SHA of the last commit if present' do
|
|
allow(event).to receive(:commit_to).and_return('123')
|
|
|
|
expect(event.commit_id).to eq('123')
|
|
end
|
|
|
|
it 'returns the SHA of the first commit if the last commit is not present' do
|
|
allow(event).to receive(:commit_to).and_return(nil)
|
|
allow(event).to receive(:commit_from).and_return('123')
|
|
|
|
expect(event.commit_id).to eq('123')
|
|
end
|
|
end
|
|
|
|
describe '#commits_count' do
|
|
it 'returns the number of commits' do
|
|
allow(payload).to receive(:commit_count).and_return(1)
|
|
|
|
expect(event.commits_count).to eq(1)
|
|
end
|
|
end
|
|
|
|
describe '#validate_push_action' do
|
|
it 'adds an error when the action is not PUSHED' do
|
|
event.action = Event::CREATED
|
|
event.validate_push_action
|
|
|
|
expect(event.errors.count).to eq(1)
|
|
end
|
|
end
|
|
end
|