Merge branch '35590-track-container-registry-events-in-api-endpoints' into 'master'

Track container registry events in API endpoints

See merge request gitlab-org/gitlab!19591

lib/api/group_container_repositories.rb

@@ -26,6 +26,8 @@ module API
           user: current_user, subject: user_group
         ).execute
 
+        track_event('list_repositories')
+
         present paginate(repositories), with: Entities::ContainerRegistry::Repository, tags: params[:tags]
       end
     end

lib/api/helpers.rb

@@ -455,6 +455,17 @@ module API
       end
     end
 
+    def track_event(action = action_name, **args)
+      category = args.delete(:category) || self.options[:for].name
+      raise "invalid category" unless category
+
+      ::Gitlab::Tracking.event(category, action.to_s, **args)
+    rescue => error
+      Rails.logger.warn( # rubocop:disable Gitlab/RailsLogger
+        "Tracking event failed for action: #{action}, category: #{category}, message: #{error.message}"
+      )
+    end
+
     protected
 
     def project_finder_params_ce

lib/api/project_container_repositories.rb

@@ -27,6 +27,8 @@ module API
           user: current_user, subject: user_project
         ).execute
 
+        track_event( 'list_repositories')
+
         present paginate(repositories), with: Entities::ContainerRegistry::Repository, tags: params[:tags]
       end
 
@@ -40,6 +42,7 @@ module API
         authorize_admin_container_image!
 
         DeleteContainerRepositoryWorker.perform_async(current_user.id, repository.id)
+        track_event('delete_repository')
 
         status :accepted
       end
@@ -56,6 +59,8 @@ module API
         authorize_read_container_image!
 
         tags = Kaminari.paginate_array(repository.tags)
+        track_event('list_tags')
+
         present paginate(tags), with: Entities::ContainerRegistry::Tag
       end
 
@@ -77,6 +82,8 @@ module API
         CleanupContainerRepositoryWorker.perform_async(current_user.id, repository.id,
           declared_params.except(:repository_id))
 
+        track_event('delete_tag_bulk')
+
         status :accepted
       end
 
@@ -111,6 +118,8 @@ module API
           .execute(repository)
 
         if result[:status] == :success
+          track_event('delete_tag')
+
           status :ok
         else
           status :bad_request

spec/lib/api/helpers_spec.rb

@@ -174,4 +174,18 @@ describe API::Helpers do
       end
     end
   end
+
+  describe '#track_event' do
+    it "creates a gitlab tracking event" do
+      expect(Gitlab::Tracking).to receive(:event).with('foo', 'my_event', {})
+
+      subject.track_event('my_event', category: 'foo')
+    end
+
+    it "logs an exception" do
+      expect(Rails.logger).to receive(:warn).with(/Tracking event failed/)
+
+      subject.track_event('my_event', category: nil)
+    end
+  end
 end

spec/requests/api/group_container_repositories_spec.rb

@@ -44,6 +44,8 @@ describe API::GroupContainerRepositories do
       let(:object) { group }
     end
 
+    it_behaves_like 'a gitlab tracking event', described_class.name, 'list_repositories'
+
     context 'with invalid group id' do
       let(:url) { '/groups/123412341234/registry/repositories' }
 

spec/requests/api/project_container_repositories_spec.rb

@@ -46,6 +46,7 @@ describe API::ProjectContainerRepositories do
 
     it_behaves_like 'rejected container repository access', :guest, :forbidden
     it_behaves_like 'rejected container repository access', :anonymous, :not_found
+    it_behaves_like 'a gitlab tracking event', described_class.name, 'list_repositories'
 
     it_behaves_like 'returns repositories for allowed users', :reporter, 'project' do
       let(:object) { project }
@@ -57,6 +58,7 @@ describe API::ProjectContainerRepositories do
 
     it_behaves_like 'rejected container repository access', :developer, :forbidden
     it_behaves_like 'rejected container repository access', :anonymous, :not_found
+    it_behaves_like 'a gitlab tracking event', described_class.name, 'delete_repository'
 
     context 'for maintainer' do
       let(:api_user) { maintainer }
@@ -85,6 +87,8 @@ describe API::ProjectContainerRepositories do
         stub_container_registry_tags(repository: root_repository.path, tags: %w(rootA latest))
       end
 
+      it_behaves_like 'a gitlab tracking event', described_class.name, 'list_tags'
+
       it 'returns a list of tags' do
         subject
 
@@ -111,6 +115,7 @@ describe API::ProjectContainerRepositories do
 
       it_behaves_like 'rejected container repository access', :developer, :forbidden
       it_behaves_like 'rejected container repository access', :anonymous, :not_found
+      it_behaves_like 'a gitlab tracking event', described_class.name, 'delete_tag_bulk'
     end
 
     context 'for maintainer' do
@@ -222,6 +227,7 @@ describe API::ProjectContainerRepositories do
         it 'properly removes tag' do
           expect(service).to receive(:execute).with(root_repository) { { status: :success } }
           expect(Projects::ContainerRepository::DeleteTagsService).to receive(:new).with(root_repository.project, api_user, tags: %w[rootA]) { service }
+          expect(Gitlab::Tracking).to receive(:event).with(described_class.name, 'delete_tag', {})
 
           subject
 
@@ -237,6 +243,7 @@ describe API::ProjectContainerRepositories do
         it 'properly removes tag' do
           expect(service).to receive(:execute).with(root_repository) { { status: :success } }
           expect(Projects::ContainerRepository::DeleteTagsService).to receive(:new).with(root_repository.project, api_user, tags: %w[rootA]) { service }
+          expect(Gitlab::Tracking).to receive(:event).with(described_class.name, 'delete_tag', {})
 
           subject
 

spec/support/shared_examples/container_repositories_shared_examples.rb

@@ -56,3 +56,11 @@ shared_examples 'returns repositories for allowed users' do |user_type, scope|
     end
   end
 end
+
+shared_examples 'a gitlab tracking event' do |category, action|
+  it "creates a gitlab tracking event #{action}" do
+    expect(Gitlab::Tracking).to receive(:event).with(category, action, {})
+
+    subject
+  end
+end