Merge branch 'extract-notify-upon-death-module' into 'master'

Extract notify upon death module

See merge request gitlab-org/gitlab!26725

app/workers/concerns/gitlab/github_import/notify_upon_death.rb

-# frozen_string_literal: true
-
-module Gitlab
-  module GithubImport
-    # NotifyUponDeath can be included into a GitHub worker class if it should
-    # notify any JobWaiter instances upon being moved to the Sidekiq dead queue.
-    #
-    # Note that this will only notify the waiter upon graceful termination, a
-    # SIGKILL will still result in the waiter _not_ being notified.
-    #
-    # Workers including this module must have jobs passed where the last
-    # argument is the key to notify, as a String.
-    module NotifyUponDeath
-      extend ActiveSupport::Concern
-
-      included do
-        # If a job is being exhausted we still want to notify the
-        # AdvanceStageWorker. This prevents the entire import from getting stuck
-        # just because 1 job threw too many errors.
-        sidekiq_retries_exhausted do |job|
-          args = job['args']
-          jid = job['jid']
-
-          if args.length == 3 && (key = args.last) && key.is_a?(String)
-            JobWaiter.notify(key, jid)
-          end
-        end
-      end
-    end
-  end
-end

app/workers/concerns/gitlab/github_import/object_importer.rb

@@ -11,7 +11,7 @@ module Gitlab
         include ApplicationWorker
         include GithubImport::Queue
         include ReschedulingMethods
-        include NotifyUponDeath
+        include Gitlab::NotifyUponDeath
 
         feature_category :importers
         worker_has_external_dependencies!

app/workers/concerns/gitlab/notify_upon_death.rb

+# frozen_string_literal: true
+
+module Gitlab
+  # NotifyUponDeath can be included into a worker class if it should
+  # notify any JobWaiter instances upon being moved to the Sidekiq dead queue.
+  #
+  # Note that this will only notify the waiter upon graceful termination, a
+  # SIGKILL will still result in the waiter _not_ being notified.
+  #
+  # Workers including this module must have jobs passed where the last
+  # argument is the key to notify, as a String.
+  module NotifyUponDeath
+    extend ActiveSupport::Concern
+
+    included do
+      # If a job is being exhausted we still want to notify the
+      # Gitlab::Import::AdvanceStageWorker. This prevents the entire import from getting stuck
+      # just because 1 job threw too many errors.
+      sidekiq_retries_exhausted do |job|
+        args = job['args']
+        jid = job['jid']
+
+        if args.length == 3 && (key = args.last) && key.is_a?(String)
+          JobWaiter.notify(key, jid)
+        end
+      end
+    end
+  end
+end

spec/workers/concerns/gitlab/github_import/notify_upon_death_spec.rb → spec/workers/concerns/gitlab/notify_upon_death_spec.rb

@@ -2,11 +2,11 @@
 
 require 'spec_helper'
 
-describe Gitlab::GithubImport::NotifyUponDeath do
+describe Gitlab::NotifyUponDeath do
   let(:worker_class) do
     Class.new do
       include Sidekiq::Worker
-      include Gitlab::GithubImport::NotifyUponDeath
+      include Gitlab::NotifyUponDeath
     end
   end