Merge branch 'feat/api-project-last-activity' into 'master'

Add last_activity_before and last_activity_after filter to /api/projects endpoint

See merge request gitlab-org/gitlab!28221

app/finders/projects_finder.rb

@@ -21,6 +21,8 @@
 #     non_archived: boolean
 #     archived: 'only' or boolean
 #     min_access_level: integer
+#     last_activity_after: datetime
+#     last_activity_before: datetime
 #
 class ProjectsFinder < UnionFinder
   include CustomAttributesFilter
@@ -73,6 +75,8 @@ class ProjectsFinder < UnionFinder
     collection = by_archived(collection)
     collection = by_custom_attributes(collection)
     collection = by_deleted_status(collection)
+    collection = by_last_activity_after(collection)
+    collection = by_last_activity_before(collection)
     collection
   end
 
@@ -179,6 +183,22 @@ class ProjectsFinder < UnionFinder
     params[:without_deleted].present? ? items.without_deleted : items
   end
 
+  def by_last_activity_after(items)
+    if params[:last_activity_after].present?
+      items.where("last_activity_at > ?", params[:last_activity_after]) # rubocop: disable CodeReuse/ActiveRecord
+    else
+      items
+    end
+  end
+
+  def by_last_activity_before(items)
+    if params[:last_activity_before].present?
+      items.where("last_activity_at < ?", params[:last_activity_before]) # rubocop: disable CodeReuse/ActiveRecord
+    else
+      items
+    end
+  end
+
   def sort(items)
     params[:sort].present? ? items.sort_by_attribute(params[:sort]) : items.projects_order_id_desc
   end

changelogs/unreleased/feat-api-project-last-activity.yml

+---
+title: Add last_activity_before and last_activity_after filter to /api/projects endpoint
+merge_request: 28221
+author: Roger Meier
+type: added

doc/api/projects.md

@@ -41,26 +41,28 @@ GET /projects
 
 | Attribute | Type | Required | Description |
 | --------- | ---- | -------- | ----------- |
-| `archived`                    | boolean | no | Limit by archived status |
-| `visibility`                  | string  | no | Limit by visibility `public`, `internal`, or `private` |
-| `order_by`                    | string  | no | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at` |
-| `sort`                        | string  | no | Return projects sorted in `asc` or `desc` order. Default is `desc` |
-| `search`                      | string  | no | Return list of projects matching the search criteria |
-| `search_namespaces`           | boolean | no | Include ancestor namespaces when matching search criteria. Default is `false` |
-| `simple`                      | boolean | no | Return only limited fields for each project. This is a no-op without authentication as then _only_ simple fields are returned. |
-| `owned`                       | boolean | no | Limit by projects explicitly owned by the current user |
-| `membership`                  | boolean | no | Limit by projects that the current user is a member of |
-| `starred`                     | boolean | no | Limit by projects starred by the current user |
-| `statistics`                  | boolean | no | Include project statistics |
-| `with_custom_attributes`      | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) |
-| `with_issues_enabled`         | boolean | no | Limit by enabled issues feature |
-| `with_merge_requests_enabled` | boolean | no | Limit by enabled merge requests feature |
-| `with_programming_language`   | string  | no | Limit by projects which use the given programming language |
-| `wiki_checksum_failed`        | boolean | no | **(PREMIUM)** Limit projects where the wiki 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_checksum_failed`  | boolean | no | **(PREMIUM)** 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) |
-| `min_access_level`            | integer | no | Limit by current user minimal [access level](members.md) |
-| `id_after`                    | integer | no | Limit results to projects with IDs greater than the specified ID |
-| `id_before`                   | integer | no | Limit results to projects with IDs less than the specified ID |
+| `archived`                    | boolean  | no | Limit by archived status |
+| `visibility`                  | string   | no | Limit by visibility `public`, `internal`, or `private` |
+| `order_by`                    | string   | no | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, or `last_activity_at` fields. Default is `created_at` |
+| `sort`                        | string   | no | Return projects sorted in `asc` or `desc` order. Default is `desc` |
+| `search`                      | string   | no | Return list of projects matching the search criteria |
+| `search_namespaces`           | boolean  | no | Include ancestor namespaces when matching search criteria. Default is `false` |
+| `simple`                      | boolean  | no | Return only limited fields for each project. This is a no-op without authentication as then _only_ simple fields are returned. |
+| `owned`                       | boolean  | no | Limit by projects explicitly owned by the current user |
+| `membership`                  | boolean  | no | Limit by projects that the current user is a member of |
+| `starred`                     | boolean  | no | Limit by projects starred by the current user |
+| `statistics`                  | boolean  | no | Include project statistics |
+| `with_custom_attributes`      | boolean  | no | Include [custom attributes](custom_attributes.md) in response (admins only) |
+| `with_issues_enabled`         | boolean  | no | Limit by enabled issues feature |
+| `with_merge_requests_enabled` | boolean  | no | Limit by enabled merge requests feature |
+| `with_programming_language`   | string   | no | Limit by projects which use the given programming language |
+| `wiki_checksum_failed`        | boolean  | no | **(PREMIUM)** Limit projects where the wiki 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_checksum_failed`  | boolean  | no | **(PREMIUM)** 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) |
+| `min_access_level`            | integer  | no | Limit by current user minimal [access level](members.md) |
+| `id_after`                    | integer  | no | Limit results to projects with IDs greater than the specified ID |
+| `id_before`                   | integer  | no | Limit results to projects with IDs less than the specified ID |
+| `last_activity_after`         | datetime | no | Limit results to projects with last_activity after specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ |
+| `last_activity_before`        | datetime | no | Limit results to projects with last_activity before specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ |
 
 NOTE: **Note:**
 This endpoint supports [keyset pagination](README.md#keyset-based-pagination) for selected `order_by` options.

lib/api/helpers.rb

@@ -505,20 +505,28 @@ module API
 
     protected
 
-    def project_finder_params_ce
-      finder_params = { without_deleted: true }
+    def project_finder_params_visibility_ce
+      finder_params = {}
+      finder_params[:min_access_level] = params[:min_access_level] if params[:min_access_level]
+      finder_params[:visibility_level] = Gitlab::VisibilityLevel.level_value(params[:visibility]) if params[:visibility]
       finder_params[:owned] = true if params[:owned].present?
       finder_params[:non_public] = true if params[:membership].present?
       finder_params[:starred] = true if params[:starred].present?
-      finder_params[:visibility_level] = Gitlab::VisibilityLevel.level_value(params[:visibility]) if params[:visibility]
       finder_params[:archived] = archived_param unless params[:archived].nil?
+      finder_params
+    end
+
+    def project_finder_params_ce
+      finder_params = project_finder_params_visibility_ce
+      finder_params[:without_deleted] = true
       finder_params[:search] = params[:search] if params[:search]
       finder_params[:search_namespaces] = true if params[:search_namespaces].present?
       finder_params[:user] = params.delete(:user) if params[:user]
       finder_params[:custom_attributes] = params[:custom_attributes] if params[:custom_attributes]
-      finder_params[:min_access_level] = params[:min_access_level] if params[:min_access_level]
       finder_params[:id_after] = params[:id_after] if params[:id_after]
       finder_params[:id_before] = params[:id_before] if params[:id_before]
+      finder_params[:last_activity_after] = params[:last_activity_after] if params[:last_activity_after]
+      finder_params[:last_activity_before] = params[:last_activity_before] if params[:last_activity_before]
       finder_params
     end
 

lib/api/projects.rb

@@ -73,6 +73,8 @@ module API
         optional :min_access_level, type: Integer, values: Gitlab::Access.all_values, desc: 'Limit by minimum access level of authenticated user'
         optional :id_after, type: Integer, desc: 'Limit results to projects with IDs greater than the specified ID'
         optional :id_before, type: Integer, desc: 'Limit results to projects with IDs less than the specified ID'
+        optional :last_activity_after, type: DateTime, desc: 'Limit results to projects with last_activity after specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ'
+        optional :last_activity_before, type: DateTime, desc: 'Limit results to projects with last_activity before specified time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ'
 
         use :optional_filter_params_ee
       end

spec/finders/projects_finder_spec.rb

@@ -222,6 +222,28 @@ describe ProjectsFinder, :do_not_mock_admin_mode do
         it { is_expected.to match_array([public_project, internal_project]) }
       end
 
+      describe 'filter by last_activity_after' do
+        let(:params) { { last_activity_after: 60.minutes.ago } }
+
+        before do
+          internal_project.update(last_activity_at: Time.now)
+          public_project.update(last_activity_at: 61.minutes.ago)
+        end
+
+        it { is_expected.to match_array([internal_project]) }
+      end
+
+      describe 'filter by last_activity_before' do
+        let(:params) { { last_activity_before: 60.minutes.ago } }
+
+        before do
+          internal_project.update(last_activity_at: Time.now)
+          public_project.update(last_activity_at: 61.minutes.ago)
+        end
+
+        it { is_expected.to match_array([public_project]) }
+      end
+
       describe 'sorting' do
         let(:params) { { sort: 'name_asc' } }