Merge branch 'kassio/pages-deployed-event' into 'master'

Add Pages::PageDeployedEvent

See merge request !89160

app/events/pages/page_deployed_event.rb

+# frozen_string_literal: true
+
+module Pages
+  class PageDeployedEvent < ::Gitlab::EventStore::Event
+    def schema
+      {
+        'type' => 'object',
+        'properties' => {
+          'project_id' => { 'type' => 'integer' },
+          'namespace_id' => { 'type' => 'integer' },
+          'root_namespace_id' => { 'type' => 'integer' }
+        },
+        'required' => %w[project_id namespace_id root_namespace_id]
+      }
+    end
+  end
+end

app/services/projects/update_pages_service.rb

@@ -53,6 +53,7 @@ def execute
     def success
       @commit_status.success
       @project.mark_pages_as_deployed
+      publish_deployed_event
       super
     end
 
@@ -203,6 +204,16 @@ def entries_count
     def pages_file_entries_limit
       project.actual_limits.pages_file_entries
     end
+
+    def publish_deployed_event
+      event = ::Pages::PageDeployedEvent.new(data: {
+        project_id: project.id,
+        namespace_id: project.namespace_id,
+        root_namespace_id: project.root_namespace.id
+      })
+
+      Gitlab::EventStore.publish(event)
+    end
   end
 end
 

spec/events/pages/page_deployed_event_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Pages::PageDeployedEvent do
+  where(:data, :valid) do
+    [
+      [{ project_id: 1, namespace_id: 2, root_namespace_id: 3 }, true],
+      [{ project_id: 1 }, false],
+      [{ namespace_id: 1 }, false],
+      [{ project_id: 'foo', namespace_id: 2 }, false],
+      [{ project_id: 1, namespace_id: 'foo' }, false],
+      [{ project_id: [], namespace_id: 2 }, false],
+      [{ project_id: 1, namespace_id: [] }, false],
+      [{ project_id: {}, namespace_id: 2 }, false],
+      [{ project_id: 1, namespace_id: {} }, false],
+      ['foo', false],
+      [123, false],
+      [[], false]
+    ]
+  end
+
+  with_them do
+    it 'validates data' do
+      constructor = -> { described_class.new(data: data) }
+
+      if valid
+        expect { constructor.call }.not_to raise_error
+      else
+        expect { constructor.call }.to raise_error(Gitlab::EventStore::InvalidEvent)
+      end
+    end
+  end
+end

spec/services/projects/update_pages_service_spec.rb

@@ -43,6 +43,16 @@
         expect(project.pages_deployed?).to be_truthy
       end
 
+      it 'publishes a PageDeployedEvent event with project id and namespace id' do
+        expected_data = {
+          project_id: project.id,
+          namespace_id: project.namespace_id,
+          root_namespace_id: project.root_namespace.id
+        }
+
+        expect { subject.execute }.to publish_event(Pages::PageDeployedEvent).with(expected_data)
+      end
+
       it 'creates pages_deployment and saves it in the metadata' do
         expect do
           expect(execute).to eq(:success)