Add packages_size to ProjectStatistics API entity

changelogs/unreleased/feat-add-packages_size-to-project-statistics.yml

+---
+title: Add packages_size to ProjectStatistics API entity
+merge_request: 47156
+author: Roger Meier
+type: added

db/migrate/20201117153333_add_index_on_package_size_and_project_id_to_project_statistics.rb

+# frozen_string_literal: true
+
+class AddIndexOnPackageSizeAndProjectIdToProjectStatistics < ActiveRecord::Migration[6.0]
+  include Gitlab::Database::MigrationHelpers
+
+  DOWNTIME = false
+  INDEX_NAME = 'index_project_statistics_on_packages_size_and_project_id'
+
+  disable_ddl_transaction!
+
+  def up
+    add_concurrent_index :project_statistics, [:packages_size, :project_id],
+      name: INDEX_NAME
+  end
+
+  def down
+    remove_concurrent_index_by_name :project_statistics, INDEX_NAME
+  end
+end

db/schema_migrations/20201117153333

+008f3a69d23abbd513336c5a48b2448e470a9413920beeb6a1684d0c6840d6a4
\ No newline at end of file

db/structure.sql

@@ -21779,6 +21779,8 @@ CREATE UNIQUE INDEX index_project_settings_on_push_rule_id ON project_settings U
 
 CREATE INDEX index_project_statistics_on_namespace_id ON project_statistics USING btree (namespace_id);
 
+CREATE INDEX index_project_statistics_on_packages_size_and_project_id ON project_statistics USING btree (packages_size, project_id);
+
 CREATE UNIQUE INDEX index_project_statistics_on_project_id ON project_statistics USING btree (project_id);
 
 CREATE INDEX index_project_statistics_on_repository_size_and_project_id ON project_statistics USING btree (repository_size, project_id);

doc/api/projects.md

@@ -49,7 +49,7 @@ GET /projects
 | `last_activity_before`                     | datetime | **{dotted-circle}** No | Limit results to projects with last_activity before specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ |
 | `membership`                               | boolean  | **{dotted-circle}** No | Limit by projects that the current user is a member of. |
 | `min_access_level`                         | integer  | **{dotted-circle}** No | Limit by current user minimal [access level](members.md#valid-access-levels). |
-| `order_by`                                 | string   | **{dotted-circle}** No | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. `repository_size`, `storage_size`, or `wiki_size` fields are only allowed for admins. Default is `created_at`. |
+| `order_by`                                 | string   | **{dotted-circle}** No | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. `repository_size`, `storage_size`, `packages_size` or `wiki_size` fields are only allowed for admins. Default is `created_at`. |
 | `owned`                                    | boolean  | **{dotted-circle}** No | Limit by projects explicitly owned by the current user. |
 | `repository_checksum_failed` **(PREMIUM)** | boolean  | **{dotted-circle}** No | Limit projects where the repository checksum calculation has failed ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6137) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2). |
 | `repository_storage`                       | string   | **{dotted-circle}** No | Limit results to projects stored on `repository_storage`. _(admins only)_ |

lib/api/entities/project_statistics.rb

@@ -10,6 +10,7 @@ module API
       expose :lfs_objects_size
       expose :build_artifacts_size, as: :job_artifacts_size
       expose :snippets_size
+      expose :packages_size
     end
   end
 end

lib/api/helpers/projects_helpers.rb

@@ -6,7 +6,7 @@ module API
       extend ActiveSupport::Concern
       extend Grape::API::Helpers
 
-      STATISTICS_SORT_PARAMS = %w[storage_size repository_size wiki_size].freeze
+      STATISTICS_SORT_PARAMS = %w[storage_size repository_size wiki_size packages_size].freeze
 
       params :optional_project_params_ce do
         optional :description, type: String, desc: 'The description of the project'

spec/requests/api/projects_spec.rb

@@ -254,7 +254,7 @@ RSpec.describe API::Projects do
 
         statistics = json_response.find { |p| p['id'] == project.id }['statistics']
         expect(statistics).to be_present
-        expect(statistics).to include('commit_count', 'storage_size', 'repository_size', 'wiki_size', 'lfs_objects_size', 'job_artifacts_size', 'snippets_size')
+        expect(statistics).to include('commit_count', 'storage_size', 'repository_size', 'wiki_size', 'lfs_objects_size', 'job_artifacts_size', 'snippets_size', 'packages_size')
       end
 
       it "does not include license by default" do
@@ -619,7 +619,7 @@ RSpec.describe API::Projects do
     end
 
     context 'sorting by project statistics' do
-      %w(repository_size storage_size wiki_size).each do |order_by|
+      %w(repository_size storage_size wiki_size packages_size).each do |order_by|
         context "sorting by #{order_by}" do
           before do
             ProjectStatistics.update_all(order_by => 100)