Set current project/group in WebHookWorker context

Currently this isn't always reliably detected, depending on how the
worker is triggered.

By setting this explicitly we always see the related project and
namespace in Kibana, and also the subscription plan in EE.

This also sets the `related_class` field to the webhook type, which
is useful for troubleshooting purposes.

app/models/hooks/project_hook.rb

@@ -39,6 +39,11 @@ class ProjectHook < WebHook
   def rate_limit
     project.actual_limits.limit_for(:web_hook_calls)
   end
+
+  override :application_context
+  def application_context
+    super.merge(project: project)
+  end
 end
 
 ProjectHook.prepend_mod_with('ProjectHook')

app/models/hooks/web_hook.rb

@@ -80,6 +80,11 @@ class WebHook < ApplicationRecord
     nil
   end
 
+  # Custom attributes to be included in the worker context.
+  def application_context
+    { related_class: type }
+  end
+
   private
 
   def web_hooks_disable_failed?

app/services/web_hook_service.rb

@@ -94,9 +94,11 @@ class WebHookService
     if rate_limited?(hook)
       log_rate_limit(hook)
     else
+      Gitlab::ApplicationContext.with_context(hook.application_context) do
         WebHookWorker.perform_async(hook.id, data, hook_name)
       end
     end
+  end
 
   private
 

ee/app/models/hooks/group_hook.rb

@@ -42,4 +42,9 @@ class GroupHook < WebHook
   def rate_limit
     group.actual_limits.limit_for(:web_hook_calls)
   end
+
+  override :application_context
+  def application_context
+    super.merge(namespace: group)
+  end
 end

ee/spec/models/hooks/group_hook_spec.rb

@@ -29,4 +29,15 @@ RSpec.describe GroupHook do
       expect(hook_ultimate.rate_limit).to be(500)
     end
   end
+
+  describe '#application_context' do
+    let_it_be(:hook) { build(:group_hook) }
+
+    it 'includes the type and group' do
+      expect(hook.application_context).to eq(
+        related_class: 'GroupHook',
+        namespace: hook.group
+      )
+    end
+  end
 end

ee/spec/services/web_hook_service_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe WebHookService do
+  let_it_be(:project) { create(:project) }
+  let_it_be_with_reload(:project_hook) { create(:project_hook, project: project) }
+
+  let(:service_instance) { described_class.new(project_hook, {}, :push_hooks) }
+
+  describe '#async_execute' do
+    context 'when hook has custom context attributes' do
+      it 'includes the subscription plan in the worker context' do
+        expect(WebHookWorker).to receive(:perform_async) do
+          expect(Gitlab::ApplicationContext.current).to include(
+            'meta.subscription_plan' => 'default'
+          )
+        end
+
+        service_instance.async_execute
+      end
+
+      context 'when the rate-limiting feature flag is disabled' do
+        before do
+          stub_feature_flags(web_hooks_rate_limit: false)
+        end
+
+        it 'does not include the subscription plan in the worker context' do
+          expect(WebHookWorker).to receive(:perform_async) do
+            expect(Gitlab::ApplicationContext.current).not_to include('meta.subscription_plan')
+          end
+
+          service_instance.async_execute
+        end
+      end
+    end
+  end
+end

spec/models/hooks/project_hook_spec.rb

@@ -39,4 +39,15 @@ RSpec.describe ProjectHook do
       expect(hook.rate_limit).to be(100)
     end
   end
+
+  describe '#application_context' do
+    let_it_be(:hook) { build(:project_hook) }
+
+    it 'includes the type and project' do
+      expect(hook.application_context).to include(
+        related_class: 'ProjectHook',
+        project: hook.project
+      )
+    end
+  end
 end

spec/models/hooks/service_hook_spec.rb

@@ -30,4 +30,14 @@ RSpec.describe ServiceHook do
       expect(hook.rate_limit).to be_nil
     end
   end
+
+  describe '#application_context' do
+    let(:hook) { build(:service_hook) }
+
+    it 'includes the type' do
+      expect(hook.application_context).to eq(
+        related_class: 'ServiceHook'
+      )
+    end
+  end
 end

spec/models/hooks/system_hook_spec.rb

@@ -177,4 +177,14 @@ RSpec.describe SystemHook do
       expect(hook.rate_limit).to be_nil
     end
   end
+
+  describe '#application_context' do
+    let(:hook) { build(:system_hook) }
+
+    it 'includes the type' do
+      expect(hook.application_context).to eq(
+        related_class: 'SystemHook'
+      )
+    end
+  end
 end

spec/services/web_hook_service_spec.rb

@@ -430,5 +430,19 @@ RSpec.describe WebHookService do
         end
       end
     end
+
+    context 'when hook has custom context attributes' do
+      it 'includes the attributes in the worker context' do
+        expect(WebHookWorker).to receive(:perform_async) do
+          expect(Gitlab::ApplicationContext.current).to include(
+            'meta.project' => project_hook.project.full_path,
+            'meta.root_namespace' => project.root_ancestor.path,
+            'meta.related_class' => 'ProjectHook'
+          )
+        end
+
+        service_instance.async_execute
+      end
+    end
   end
 end