Rewrite the GitHub importer from scratch

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.

5 files changed, 318 insertions, 0 deletions

diff --git a/spec/workers/concerns/gitlab/github_import/notify_upon_death_spec.rb b/spec/workers/concerns/gitlab/github_import/notify_upon_death_spec.rb
new file mode 100644
index 00000000000..4b9aa9a7ef8
--- /dev/null
+++ b/spec/workers/concerns/gitlab/github_import/notify_upon_death_spec.rb
@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Gitlab::GithubImport::NotifyUponDeath do
+  let(:worker_class) do
+    Class.new do
+      include Sidekiq::Worker
+      include Gitlab::GithubImport::NotifyUponDeath
+    end
+  end
+
+  describe '.sidekiq_retries_exhausted' do
+    it 'notifies the JobWaiter when 3 arguments are given and the last is a String' do
+      job = { 'args' => [12, {}, '123abc'], 'jid' => '123' }
+
+      expect(Gitlab::JobWaiter)
+        .to receive(:notify)
+        .with('123abc', '123')
+
+      worker_class.sidekiq_retries_exhausted_block.call(job)
+    end
+
+    it 'does not notify the JobWaiter when only 2 arguments are given' do
+      job = { 'args' => [12, {}], 'jid' => '123' }
+
+      expect(Gitlab::JobWaiter)
+        .not_to receive(:notify)
+
+      worker_class.sidekiq_retries_exhausted_block.call(job)
+    end
+
+    it 'does not notify the JobWaiter when only 1 argument is given' do
+      job = { 'args' => [12], 'jid' => '123' }
+
+      expect(Gitlab::JobWaiter)
+        .not_to receive(:notify)
+
+      worker_class.sidekiq_retries_exhausted_block.call(job)
+    end
+
+    it 'does not notify the JobWaiter when the last argument is not a String' do
+      job = { 'args' => [12, {}, 40], 'jid' => '123' }
+
+      expect(Gitlab::JobWaiter)
+        .not_to receive(:notify)
+
+      worker_class.sidekiq_retries_exhausted_block.call(job)
+    end
+  end
+end
diff --git a/spec/workers/concerns/gitlab/github_import/object_importer_spec.rb b/spec/workers/concerns/gitlab/github_import/object_importer_spec.rb
new file mode 100644
index 00000000000..3ccf06f2d7d
--- /dev/null
+++ b/spec/workers/concerns/gitlab/github_import/object_importer_spec.rb
@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Gitlab::GithubImport::ObjectImporter do
+  let(:worker) do
+    Class.new do
+      include(Gitlab::GithubImport::ObjectImporter)
+
+      def counter_name
+        :dummy_counter
+      end
+
+      def counter_description
+        'This is a counter'
+      end
+    end.new
+  end
+
+  describe '#import' do
+    it 'imports the object' do
+      representation_class = double(:representation_class)
+      importer_class = double(:importer_class)
+      importer_instance = double(:importer_instance)
+      representation = double(:representation)
+      project = double(:project, path_with_namespace: 'foo/bar')
+      client = double(:client)
+
+      expect(worker)
+        .to receive(:representation_class)
+        .and_return(representation_class)
+
+      expect(worker)
+        .to receive(:importer_class)
+        .and_return(importer_class)
+
+      expect(representation_class)
+        .to receive(:from_json_hash)
+        .with(an_instance_of(Hash))
+        .and_return(representation)
+
+      expect(importer_class)
+        .to receive(:new)
+        .with(representation, project, client)
+        .and_return(importer_instance)
+
+      expect(importer_instance)
+        .to receive(:execute)
+
+      expect(worker.counter)
+        .to receive(:increment)
+        .with(project: 'foo/bar')
+        .and_call_original
+
+      worker.import(project, client, { 'number' => 10 })
+    end
+  end
+
+  describe '#counter' do
+    it 'returns a Prometheus counter' do
+      expect(worker)
+        .to receive(:counter_name)
+        .and_call_original
+
+      expect(worker)
+        .to receive(:counter_description)
+        .and_call_original
+
+      worker.counter
+    end
+  end
+end
diff --git a/spec/workers/concerns/gitlab/github_import/queue_spec.rb b/spec/workers/concerns/gitlab/github_import/queue_spec.rb
new file mode 100644
index 00000000000..321ae3fe978
--- /dev/null
+++ b/spec/workers/concerns/gitlab/github_import/queue_spec.rb
@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Gitlab::GithubImport::Queue do
+  it 'sets the Sidekiq options for the worker' do
+    worker = Class.new do
+      include Sidekiq::Worker
+      include Gitlab::GithubImport::Queue
+    end
+
+    expect(worker.sidekiq_options['queue']).to eq('github_importer')
+  end
+end
diff --git a/spec/workers/concerns/gitlab/github_import/rescheduling_methods_spec.rb b/spec/workers/concerns/gitlab/github_import/rescheduling_methods_spec.rb
new file mode 100644
index 00000000000..8de4059c4ae
--- /dev/null
+++ b/spec/workers/concerns/gitlab/github_import/rescheduling_methods_spec.rb
@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe Gitlab::GithubImport::ReschedulingMethods do
+  let(:worker) do
+    Class.new { include(Gitlab::GithubImport::ReschedulingMethods) }.new
+  end
+
+  describe '#perform' do
+    context 'with a non-existing project' do
+      it 'does not perform any work' do
+        expect(worker)
+          .not_to receive(:try_import)
+
+        worker.perform(-1, {})
+      end
+
+      it 'notifies any waiters so they do not wait forever' do
+        expect(worker)
+          .to receive(:notify_waiter)
+          .with('123')
+
+        worker.perform(-1, {}, '123')
+      end
+    end
+
+    context 'with an existing project' do
+      let(:project) { create(:project) }
+
+      it 'notifies any waiters upon successfully importing the data' do
+        expect(worker)
+          .to receive(:try_import)
+          .with(
+            an_instance_of(Project),
+            an_instance_of(Gitlab::GithubImport::Client),
+            { 'number' => 2 }
+          )
+          .and_return(true)
+
+        expect(worker)
+          .to receive(:notify_waiter).with('123')
+
+        worker.perform(project.id, { 'number' => 2 }, '123')
+      end
+
+      it 'reschedules itself if the data could not be imported' do
+        expect(worker)
+          .to receive(:try_import)
+          .with(
+            an_instance_of(Project),
+            an_instance_of(Gitlab::GithubImport::Client),
+            { 'number' => 2 }
+          )
+          .and_return(false)
+
+        expect(worker)
+          .not_to receive(:notify_waiter)
+
+        expect_any_instance_of(Gitlab::GithubImport::Client)
+          .to receive(:rate_limit_resets_in)
+          .and_return(14)
+
+        expect(worker.class)
+          .to receive(:perform_in)
+          .with(14, project.id, { 'number' => 2 }, '123')
+
+        worker.perform(project.id, { 'number' => 2 }, '123')
+      end
+    end
+  end
+
+  describe '#try_import' do
+    it 'returns true when the import succeeds' do
+      expect(worker)
+        .to receive(:import)
+        .with(10, 20)
+
+      expect(worker.try_import(10, 20)).to eq(true)
+    end
+
+    it 'returns false when the import fails due to hitting the GitHub API rate limit' do
+      expect(worker)
+        .to receive(:import)
+        .with(10, 20)
+        .and_raise(Gitlab::GithubImport::RateLimitError)
+
+      expect(worker.try_import(10, 20)).to eq(false)
+    end
+  end
+
+  describe '#notify_waiter' do
+    it 'notifies the waiter if a waiter key is specified' do
+      expect(worker)
+        .to receive(:jid)
+        .and_return('abc123')
+
+      expect(Gitlab::JobWaiter)
+        .to receive(:notify)
+        .with('123', 'abc123')
+
+      worker.notify_waiter('123')
+    end
+
+    it 'does not notify any waiters if no waiter key is specified' do
+      expect(Gitlab::JobWaiter)
+        .not_to receive(:notify)
+
+      worker.notify_waiter(nil)
+    end
+  end
+end
diff --git a/spec/workers/concerns/gitlab/github_import/stage_methods_spec.rb b/spec/workers/concerns/gitlab/github_import/stage_methods_spec.rb
new file mode 100644
index 00000000000..241e8a2b6d3
--- /dev/null
+++ b/spec/workers/concerns/gitlab/github_import/stage_methods_spec.rb
@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Gitlab::GithubImport::StageMethods do
+  let(:project) { create(:project) }
+  let(:worker) do
+    Class.new { include(Gitlab::GithubImport::StageMethods) }.new
+  end
+
+  describe '#perform' do
+    it 'returns if no project could be found' do
+      expect(worker).not_to receive(:try_import)
+
+      worker.perform(-1)
+    end
+
+    it 'imports the data when the project exists' do
+      allow(worker)
+        .to receive(:find_project)
+        .with(project.id)
+        .and_return(project)
+
+      expect(worker)
+        .to receive(:try_import)
+        .with(
+          an_instance_of(Gitlab::GithubImport::Client),
+          an_instance_of(Project)
+        )
+
+      worker.perform(project.id)
+    end
+  end
+
+  describe '#try_import' do
+    it 'imports the project' do
+      client = double(:client)
+
+      expect(worker)
+        .to receive(:import)
+        .with(client, project)
+
+      worker.try_import(client, project)
+    end
+
+    it 'reschedules the worker if RateLimitError was raised' do
+      client = double(:client, rate_limit_resets_in: 10)
+
+      expect(worker)
+        .to receive(:import)
+        .with(client, project)
+        .and_raise(Gitlab::GithubImport::RateLimitError)
+
+      expect(worker.class)
+        .to receive(:perform_in)
+        .with(10, project.id)
+
+      worker.try_import(client, project)
+    end
+  end
+
+  describe '#find_project' do
+    it 'returns a Project for an existing ID' do
+      project.update_column(:import_status, 'started')
+
+      expect(worker.find_project(project.id)).to eq(project)
+    end
+
+    it 'returns nil for a project that failed importing' do
+      project.update_column(:import_status, 'failed')
+
+      expect(worker.find_project(project.id)).to be_nil
+    end
+
+    it 'returns nil for a non-existing project ID' do
+      expect(worker.find_project(-1)).to be_nil
+    end
+  end
+end