4dfe26cd8b
Prior to this MR there were two GitHub related importers: * Github::Import: the main importer used for GitHub projects * Gitlab::GithubImport: importer that's somewhat confusingly used for importing Gitea projects (apparently they have a compatible API) This MR renames the Gitea importer to Gitlab::LegacyGithubImport and introduces a new GitHub importer in the Gitlab::GithubImport namespace. This new GitHub importer uses Sidekiq for importing multiple resources in parallel, though it also has the ability to import data sequentially should this be necessary. The new code is spread across the following directories: * lib/gitlab/github_import: this directory contains most of the importer code such as the classes used for importing resources. * app/workers/gitlab/github_import: this directory contains the Sidekiq workers, most of which simply use the code from the directory above. * app/workers/concerns/gitlab/github_import: this directory provides a few modules that are included in every GitHub importer worker. == Stages The import work is divided into separate stages, with each stage importing a specific set of data. Stages will schedule the work that needs to be performed, followed by scheduling a job for the "AdvanceStageWorker" worker. This worker will periodically check if all work is completed and schedule the next stage if this is the case. If work is not yet completed this worker will reschedule itself. Using this approach we don't have to block threads by calling `sleep()`, as doing so for large projects could block the thread from doing any work for many hours. == Retrying Work Workers will reschedule themselves whenever necessary. For example, hitting the GitHub API's rate limit will result in jobs rescheduling themselves. These jobs are not processed until the rate limit has been reset. == User Lookups Part of the importing process involves looking up user details in the GitHub API so we can map them to GitLab users. The old importer used an in-memory cache, but this obviously doesn't work when the work is spread across different threads. The new importer uses a Redis cache and makes sure we only perform API/database calls if absolutely necessary. Frequently used keys are refreshed, and lookup misses are also cached; removing the need for performing API/database calls if we know we don't have the data we're looking for. == Performance & Models The new importer in various places uses raw INSERT statements (as generated by `Gitlab::Database.bulk_insert`) instead of using Rails models. This allows us to bypass any validations and callbacks, drastically reducing the number of SQL queries and Gitaly RPC calls necessary to import projects. To ensure the code produces valid data the corresponding tests check if the produced rows are valid according to the model validation rules.
117 lines
3.2 KiB
Ruby
117 lines
3.2 KiB
Ruby
require 'spec_helper'
|
|
|
|
describe Gitlab::GithubImport::Caching, :clean_gitlab_redis_cache do
|
|
describe '.read' do
|
|
it 'reads a value from the cache' do
|
|
described_class.write('foo', 'bar')
|
|
|
|
expect(described_class.read('foo')).to eq('bar')
|
|
end
|
|
|
|
it 'returns nil if the cache key does not exist' do
|
|
expect(described_class.read('foo')).to be_nil
|
|
end
|
|
|
|
it 'refreshes the cache key if a value is present' do
|
|
described_class.write('foo', 'bar')
|
|
|
|
redis = double(:redis)
|
|
|
|
expect(redis).to receive(:get).with(/foo/).and_return('bar')
|
|
expect(redis).to receive(:expire).with(/foo/, described_class::TIMEOUT)
|
|
expect(Gitlab::Redis::Cache).to receive(:with).twice.and_yield(redis)
|
|
|
|
described_class.read('foo')
|
|
end
|
|
|
|
it 'does not refresh the cache key if a value is empty' do
|
|
described_class.write('foo', nil)
|
|
|
|
redis = double(:redis)
|
|
|
|
expect(redis).to receive(:get).with(/foo/).and_return('')
|
|
expect(redis).not_to receive(:expire)
|
|
expect(Gitlab::Redis::Cache).to receive(:with).and_yield(redis)
|
|
|
|
described_class.read('foo')
|
|
end
|
|
end
|
|
|
|
describe '.read_integer' do
|
|
it 'returns an Integer' do
|
|
described_class.write('foo', '10')
|
|
|
|
expect(described_class.read_integer('foo')).to eq(10)
|
|
end
|
|
|
|
it 'returns nil if no value was found' do
|
|
expect(described_class.read_integer('foo')).to be_nil
|
|
end
|
|
end
|
|
|
|
describe '.write' do
|
|
it 'writes a value to the cache and returns the written value' do
|
|
expect(described_class.write('foo', 10)).to eq(10)
|
|
expect(described_class.read('foo')).to eq('10')
|
|
end
|
|
end
|
|
|
|
describe '.set_add' do
|
|
it 'adds a value to a set' do
|
|
described_class.set_add('foo', 10)
|
|
described_class.set_add('foo', 10)
|
|
|
|
key = described_class.cache_key_for('foo')
|
|
values = Gitlab::Redis::Cache.with { |r| r.smembers(key) }
|
|
|
|
expect(values).to eq(['10'])
|
|
end
|
|
end
|
|
|
|
describe '.set_includes?' do
|
|
it 'returns false when the key does not exist' do
|
|
expect(described_class.set_includes?('foo', 10)).to eq(false)
|
|
end
|
|
|
|
it 'returns false when the value is not present in the set' do
|
|
described_class.set_add('foo', 10)
|
|
|
|
expect(described_class.set_includes?('foo', 20)).to eq(false)
|
|
end
|
|
|
|
it 'returns true when the set includes the given value' do
|
|
described_class.set_add('foo', 10)
|
|
|
|
expect(described_class.set_includes?('foo', 10)).to eq(true)
|
|
end
|
|
end
|
|
|
|
describe '.write_multiple' do
|
|
it 'sets multiple keys' do
|
|
mapping = { 'foo' => 10, 'bar' => 20 }
|
|
|
|
described_class.write_multiple(mapping)
|
|
|
|
mapping.each do |key, value|
|
|
full_key = described_class.cache_key_for(key)
|
|
found = Gitlab::Redis::Cache.with { |r| r.get(full_key) }
|
|
|
|
expect(found).to eq(value.to_s)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe '.expire' do
|
|
it 'sets the expiration time of a key' do
|
|
timeout = 1.hour.to_i
|
|
|
|
described_class.write('foo', 'bar', timeout: 2.hours.to_i)
|
|
described_class.expire('foo', timeout)
|
|
|
|
key = described_class.cache_key_for('foo')
|
|
found_ttl = Gitlab::Redis::Cache.with { |r| r.ttl(key) }
|
|
|
|
expect(found_ttl).to be <= timeout
|
|
end
|
|
end
|
|
end
|