Merge branch '212543-backend-requirements-filtering' into 'master'

Requirements filter by author username or search

See merge request gitlab-org/gitlab!31857

doc/api/graphql/reference/gitlab_schema.graphql

@@ -8309,6 +8309,11 @@ type Project {
     """
     after: String
 
+    """
+    Filter requirements by author username
+    """
+    authorUsername: [String!]
+
     """
     Returns the elements in the list that come before the specified cursor.
     """
@@ -8405,6 +8410,11 @@ type Project {
   Find a single requirement. Available only when feature flag `requirements_management` is enabled.
   """
   requirement(
+    """
+    Filter requirements by author username
+    """
+    authorUsername: [String!]
+
     """
     IID of the requirement, e.g., "1"
     """
@@ -8415,6 +8425,11 @@ type Project {
     """
     iids: [ID!]
 
+    """
+    Filter requirements by title search
+    """
+    search: String
+
     """
     List requirements by sort order
     """
@@ -8465,6 +8480,11 @@ type Project {
     """
     last: Int
 
+    """
+    Filter requirements by title search
+    """
+    search: String
+
     """
     List requirements by sort order
     """
@@ -9609,7 +9629,7 @@ type Repository {
 }
 
 """
-Represents a requirement.
+Represents a requirement
 """
 type Requirement {
   """

doc/api/graphql/reference/gitlab_schema.json

@@ -24398,6 +24398,34 @@
                     "ofType": null
                   },
                   "defaultValue": null
+                },
+                {
+                  "name": "search",
+                  "description": "Filter requirements by title search",
+                  "type": {
+                    "kind": "SCALAR",
+                    "name": "String",
+                    "ofType": null
+                  },
+                  "defaultValue": null
+                },
+                {
+                  "name": "authorUsername",
+                  "description": "Filter requirements by author username",
+                  "type": {
+                    "kind": "LIST",
+                    "name": null,
+                    "ofType": {
+                      "kind": "NON_NULL",
+                      "name": null,
+                      "ofType": {
+                        "kind": "SCALAR",
+                        "name": "String",
+                        "ofType": null
+                      }
+                    }
+                  },
+                  "defaultValue": null
                 }
               ],
               "type": {
@@ -24460,6 +24488,34 @@
                   },
                   "defaultValue": null
                 },
+                {
+                  "name": "search",
+                  "description": "Filter requirements by title search",
+                  "type": {
+                    "kind": "SCALAR",
+                    "name": "String",
+                    "ofType": null
+                  },
+                  "defaultValue": null
+                },
+                {
+                  "name": "authorUsername",
+                  "description": "Filter requirements by author username",
+                  "type": {
+                    "kind": "LIST",
+                    "name": null,
+                    "ofType": {
+                      "kind": "NON_NULL",
+                      "name": null,
+                      "ofType": {
+                        "kind": "SCALAR",
+                        "name": "String",
+                        "ofType": null
+                      }
+                    }
+                  },
+                  "defaultValue": null
+                },
                 {
                   "name": "after",
                   "description": "Returns the elements in the list that come after the specified cursor.",
@@ -28132,7 +28188,7 @@
         {
           "kind": "OBJECT",
           "name": "Requirement",
-          "description": "Represents a requirement.",
+          "description": "Represents a requirement",
           "fields": [
             {
               "name": "author",

doc/api/graphql/reference/index.md

@@ -1356,7 +1356,7 @@ Autogenerated return type of RemoveProjectFromSecurityDashboard
 
 ## Requirement
 
-Represents a requirement.
+Represents a requirement
 
 | Name  | Type  | Description |
 | ---   |  ---- | ----------  |

doc/user/project/requirements/index.md

@@ -73,3 +73,23 @@ You can view the list of archived requirements in the **Archived** tab.
 To reopen an archived requirement, click **Reopen**.
 
 As soon as a requirement is reopened, it no longer appears in the **Archived** tab.
+
+## Search for a requirement from the requirements list page
+
+> - Introduced in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.1.
+
+You can search for a requirement from the list of requirements using filtered search bar (similar to
+that of Issues and Merge Requests) based on following parameters:
+
+- Title
+- Author username
+
+To search, go to the list of requirements and click the field **Search or filter results**.
+It will display a dropdown menu, from which you can add an author. You can also enter plain
+text to search by epic title or description. When done, press <kbd>Enter</kbd> on your
+keyboard to filter the list.
+
+You can also sort requirements list by:
+
+- Created date
+- Last updated

ee/app/finders/requirements_management/requirements_finder.rb

@@ -9,6 +9,8 @@ module RequirementsManagement
     # iids: integer[]
     # state: string[]
     # sort: string
+    # search: string
+    # author_username: string
     def initialize(current_user, params = {})
       @current_user = current_user
       @params = params
@@ -18,6 +20,8 @@ module RequirementsManagement
       items = init_collection
       items = by_state(items)
       items = by_iid(items)
+      items = by_author(items)
+      items = by_search(items)
 
       sort(items)
     end
@@ -44,6 +48,29 @@ module RequirementsManagement
       items.for_state(params[:state])
     end
 
+    def by_author(items)
+      username_param = params[:author_username]
+      return items unless username_param.present?
+
+      authors = get_authors(username_param)
+      return items.none unless authors.present? # author not found
+
+      items.with_author(authors)
+    end
+
+    def get_authors(username_param)
+      # Save a DB hit if the current_user is the only author, or there are none.
+      return current_user if [username_param].flatten == [current_user&.username]
+
+      User.by_username(username_param)
+    end
+
+    def by_search(items)
+      return items unless params[:search].present?
+
+      items.search(params[:search])
+    end
+
     def project
       strong_memoize(:project) do
         ::Project.find_by_id(params[:project_id]) if params[:project_id].present?

ee/app/graphql/resolvers/requirements_management/requirements_resolver.rb

@@ -19,6 +19,14 @@ module Resolvers
                required: false,
                description: 'Filter requirements by state'
 
+      argument :search, GraphQL::STRING_TYPE,
+               required: false,
+               description: 'Filter requirements by title search'
+
+      argument :author_username, [GraphQL::STRING_TYPE],
+               required: false,
+               description: 'Filter requirements by author username'
+
       type Types::RequirementsManagement::RequirementType, null: true
 
       def resolve(**args)

ee/app/graphql/types/requirements_management/requirement_type.rb

@@ -4,7 +4,7 @@ module Types
   module RequirementsManagement
     class RequirementType < BaseObject
       graphql_name 'Requirement'
-      description 'Represents a requirement.'
+      description 'Represents a requirement'
 
       authorize :read_requirement
 

ee/app/models/requirements_management/requirement.rb

@@ -6,6 +6,7 @@ module RequirementsManagement
     include StripAttribute
     include AtomicInternalId
     include Sortable
+    include Gitlab::SQL::Pattern
 
     # the expected name for this table is `requirements_management_requirements`,
     # but to avoid downtime and deployment issues `requirements` is still used
@@ -32,11 +33,25 @@ module RequirementsManagement
 
     scope :for_iid, -> (iid) { where(iid: iid) }
     scope :for_state, -> (state) { where(state: state) }
+    scope :with_author, -> (user) { where(author: user) }
     scope :counts_by_state, -> { group(:state).count }
 
-    def self.simple_sorts
+    class << self
+      # Searches for records with a matching title.
+      #
+      # This method uses ILIKE on PostgreSQL
+      #
+      # query - The search query as a String
+      #
+      # Returns an ActiveRecord::Relation.
+      def search(query)
+        fuzzy_search(query, [:title])
+      end
+
+      def simple_sorts
         super.except('name_asc', 'name_desc')
       end
+    end
 
     # In the next iteration we will support also group-level requirements
     # so it's better to use resource_parent instead of project directly

ee/changelogs/unreleased/212543-backend-requirements-filtering.yml

+---
+title: Add requirements filtering on author username and search by title
+merge_request: 31857
+author:
+type: added

ee/spec/finders/requirements_management/requirements_finder_spec.rb

@@ -4,11 +4,12 @@ require 'spec_helper'
 
 describe RequirementsManagement::RequirementsFinder do
   let_it_be(:project) { create(:project) }
-  let_it_be(:project_user) { create(:user).tap { |u| project.add_developer(u) } }
-  let_it_be(:requirement1) { create(:requirement, project: project, state: 'opened', updated_at: 3.days.ago) }
-  let_it_be(:requirement2) { create(:requirement, project: project, state: 'opened', updated_at: 1.day.ago) }
-  let_it_be(:requirement3) { create(:requirement, project: project, state: 'archived', updated_at: 2.days.ago) }
-  let_it_be(:requirement4) { create(:requirement, state: 'opened') }
+  let_it_be(:project_user) { create(:user, username: 'projectusername').tap { |u| project.add_developer(u) } }
+  let_it_be(:other_user) { create(:user, username: 'otheruser123') }
+  let_it_be(:requirement1) { create(:requirement, project: project, state: 'opened', author: project_user, updated_at: 3.days.ago, title: 'make it better with serverless') }
+  let_it_be(:requirement2) { create(:requirement, project: project, state: 'opened', author: project_user, updated_at: 1.day.ago, title: 'make it not crash') }
+  let_it_be(:requirement3) { create(:requirement, project: project, state: 'archived', author: other_user, updated_at: 2.days.ago, title: 'good with memory') }
+  let_it_be(:requirement4) { create(:requirement, state: 'opened', title: 'mystery requirement') }
 
   subject { described_class.new(project_user, params).execute }
 
@@ -59,6 +60,46 @@ describe RequirementsManagement::RequirementsFinder do
         end
       end
 
+      describe 'filter by author' do
+        using RSpec::Parameterized::TableSyntax
+
+        let(:params) { { project_id: project.id, author_username: author_username } }
+
+        where(:author_username, :filtered_requirements) do
+          'projectusername'                | [:requirement1, :requirement2]
+          'nonexistent_user'               | []
+          nil                              | [:requirement3, :requirement2, :requirement1]
+          %w[projectusername otheruser123] | [:requirement3, :requirement2, :requirement1]
+          %w[nonexistentuser nonsense]     | []
+        end
+
+        with_them do
+          it 'returns the requirements filtered' do
+            expect(subject).to match_array(filtered_requirements.map { |name| public_send(name) })
+          end
+        end
+      end
+
+      describe 'filter by search' do
+        using RSpec::Parameterized::TableSyntax
+
+        let(:params) { { project_id: project.id, search: query } }
+
+        where(:query, :filtered_requirements) do
+          'nonsense'    | []
+          'serverless'  | [:requirement1]
+          'with'        | [:requirement1, :requirement3]
+          nil           | [:requirement3, :requirement2, :requirement1]
+          ""            | [:requirement3, :requirement2, :requirement1]
+        end
+
+        with_them do
+          it 'returns the requirements filtered' do
+            expect(subject).to match_array(filtered_requirements.map { |name| public_send(name) })
+          end
+        end
+      end
+
       describe 'ordering' do
         using RSpec::Parameterized::TableSyntax
 

ee/spec/graphql/resolvers/requirements_management/requirements_resolver_spec.rb

@@ -6,12 +6,14 @@ describe Resolvers::RequirementsManagement::RequirementsResolver do
   include GraphqlHelpers
 
   let_it_be(:current_user) { create(:user) }
+  let_it_be(:other_user) { create(:user) }
+  let_it_be(:third_user) { create(:user) }
+  let_it_be(:project) { create(:project) }
 
   context 'with a project' do
-    let_it_be(:project) { create(:project) }
-    let_it_be(:requirement1) { create(:requirement, project: project, state: :opened, created_at: 5.hours.ago) }
-    let_it_be(:requirement2) { create(:requirement, project: project, state: :archived, created_at: 3.hours.ago) }
-    let_it_be(:requirement3) { create(:requirement, project: project, state: :archived, created_at: 4.hours.ago) }
+    let_it_be(:requirement1) { create(:requirement, project: project, state: :opened, created_at: 5.hours.ago, title: 'it needs to do the thing', author: current_user) }
+    let_it_be(:requirement2) { create(:requirement, project: project, state: :archived, created_at: 3.hours.ago, title: 'it needs to not break', author: other_user) }
+    let_it_be(:requirement3) { create(:requirement, project: project, state: :archived, created_at: 4.hours.ago, title: 'do the kubernetes!', author: third_user) }
 
     before do
       project.add_developer(current_user)
@@ -65,9 +67,105 @@ describe Resolvers::RequirementsManagement::RequirementsResolver do
         expect(resolve_requirements).to be_empty
       end
     end
+
+    context 'with search' do
+      it 'filters requirements by title' do
+        requirements = resolve_requirements(search: 'kubernetes')
+
+        expect(requirements).to match_array([requirement3])
+      end
+    end
+
+    shared_examples 'returns unfiltered' do
+      it 'returns requirements without filtering by author' do
+        expect(subject).to match_array([requirement1, requirement2, requirement3])
+      end
+    end
+
+    shared_examples 'returns no items' do
+      it 'returns requirements without filtering by author' do
+        expect(subject).to be_empty
+      end
+    end
+
+    context 'filtering by author_username' do
+      subject do
+        resolve_requirements(params)
+      end
+
+      context 'single author exists' do
+        let(:params) do
+          { author_username: other_user.username }
+        end
+
+        it 'filters requirements by author' do
+          expect(subject).to match_array([requirement2])
+        end
+      end
+
+      context 'single nonexistent author' do
+        let(:params) do
+          { author_username: "nonsense" }
+        end
+
+        it_behaves_like 'returns no items'
+      end
+
+      context 'multiple nonexistent authors' do
+        let(:params) do
+          { author_username: %w[undefined123 nonsense] }
+        end
+
+        it_behaves_like 'returns no items'
+      end
+
+      context 'single author is not supplied' do
+        let(:params) do
+          {}
+        end
+
+        it_behaves_like 'returns unfiltered'
+      end
+
+      context 'single author is nil' do
+        let(:params) do
+          { author_username: nil }
+        end
+
+        it_behaves_like 'returns unfiltered'
+      end
+
+      context 'an empty array' do
+        let(:params) do
+          { author_username: [] }
+        end
+
+        it_behaves_like 'returns unfiltered'
+      end
+
+      context 'multiple authors' do
+        let(:params) do
+          { author_username: [other_user.username, current_user.username] }
+        end
+
+        it 'filters requirements by author' do
+          expect(subject).to match_array([requirement1, requirement2])
+        end
+      end
+
+      context 'multiple authors, one of whom does not exist' do
+        let(:params) do
+          { author_username: [other_user.username, 'nonsense'] }
+        end
+
+        it 'filters requirements by author' do
+          expect(subject).to match_array([requirement2])
+        end
+      end
     end
 
     def resolve_requirements(args = {}, context = { current_user: current_user })
       resolve(described_class, obj: project, args: args, ctx: context)
     end
+  end
 end

ee/spec/models/requirements_management/requirement_spec.rb

@@ -33,5 +33,48 @@ describe RequirementsManagement::Requirement do
 
       it { is_expected.to contain_exactly(['archived', 1], ['opened', 1]) }
     end
+
+    describe '.with_author' do
+      let_it_be(:other_user) { create(:user) }
+      let_it_be(:my_requirement) { create(:requirement, project: project, author: user) }
+      let_it_be(:other_requirement) { create(:requirement, project: project, author: other_user) }
+
+      context 'with one author' do
+        subject { described_class.with_author(user) }
+
+        it { is_expected.to contain_exactly(my_requirement) }
+      end
+
+      context 'with multiple authors' do
+        subject { described_class.with_author([user, other_user]) }
+
+        it { is_expected.to contain_exactly(my_requirement, other_requirement) }
+      end
+    end
+
+    describe '.search' do
+      let_it_be(:requirement_one) { create(:requirement, project: project, title: "it needs to do the thing") }
+      let_it_be(:requirement_two) { create(:requirement, project: project, title: "it needs to not break") }
+
+      subject { described_class.search(query) }
+
+      context 'with a query that covers both' do
+        let(:query) { 'it needs to' }
+
+        it { is_expected.to contain_exactly(requirement_one, requirement_two) }
+      end
+
+      context 'with a query that covers neither' do
+        let(:query) { 'break often' }
+
+        it { is_expected.to be_empty }
+      end
+
+      context 'with a query that covers one' do
+        let(:query) { 'do the thing' }
+
+        it { is_expected.to contain_exactly(requirement_one) }
+      end
+    end
   end
 end

ee/spec/requests/api/graphql/project/requirements_management/requirements_spec.rb

@@ -63,6 +63,77 @@ describe 'getting a requirement list for a project' do
       end
     end
 
+    describe 'filtering' do
+      let_it_be(:filter_project) { create(:project, :public) }
+      let_it_be(:other_project) { create(:project, :public) }
+      let_it_be(:other_user) { create(:user, username: 'number8wire') }
+      let_it_be(:requirement1) { create(:requirement, project: filter_project, author: current_user, title: 'solve the halting problem') }
+      let_it_be(:requirement2) { create(:requirement, project: filter_project, author: other_user, title: 'something about kubernetes') }
+
+      before do
+        post_graphql(query, current_user: current_user)
+      end
+
+      let(:requirements_data) { graphql_data['project']['requirements']['nodes'] }
+      let(:params) { "" }
+
+      let(:query) do
+        graphql_query_for(
+          'project',
+          { 'fullPath' => filter_project.full_path },
+          <<~REQUIREMENTS
+            requirements#{params} {
+              nodes {
+                id
+              }
+            }
+          REQUIREMENTS
+        )
+      end
+
+      it_behaves_like 'a working graphql query'
+
+      def match_single_result(requirement)
+        expect(requirements_data[0]['id']).to eq requirement.to_global_id.to_s
+      end
+
+      context 'when given single author param' do
+        let(:params) { '(authorUsername: "number8wire")' }
+
+        it 'returns filtered requirements' do
+          expect(graphql_errors).to be_nil
+          match_single_result(requirement2)
+        end
+      end
+
+      context 'when given multiple author param' do
+        let(:params) { '(authorUsername: ["number8wire", "someotheruser"])' }
+
+        it 'returns filtered requirements' do
+          expect(graphql_errors).to be_nil
+          match_single_result(requirement2)
+        end
+      end
+
+      context 'when given search param' do
+        let(:params) { '(search: "halting")' }
+
+        it 'returns filtered requirements' do
+          expect(graphql_errors).to be_nil
+          match_single_result(requirement1)
+        end
+      end
+
+      context 'when given author and search params' do
+        let(:params) { '(search: "kubernetes", authorUsername: "number8wire")' }
+
+        it 'returns filtered requirements' do
+          expect(graphql_errors).to be_nil
+          match_single_result(requirement2)
+        end
+      end
+    end
+
     describe 'sorting and pagination' do
       let(:start_cursor) { graphql_data['project']['requirements']['pageInfo']['startCursor'] }
       let(:end_cursor) { graphql_data['project']['requirements']['pageInfo']['endCursor'] }