Add GraphQL filters for issuables (state, labels, time fields)56492-implement-new-arguments-state-closed_before-and-closed_after-for-issuesresolver-in-graphql

Signed-off-by: Rémy Coutable <remy@rymai.me>

13 files changed, 161 insertions, 14 deletions

diff --git a/app/graphql/resolvers/issues_resolver.rb b/app/graphql/resolvers/issues_resolver.rb
index 95e66fb3b7c..baac67c16cc 100644
--- a/app/graphql/resolvers/issues_resolver.rb
+++ b/app/graphql/resolvers/issues_resolver.rb
@@ -7,7 +7,30 @@ module Resolvers
     argument :iids, [GraphQL::ID_TYPE],
               required: false,
               description: 'The list of IIDs of issues, e.g., [1, 2]'
-
+    argument :state, Types::IssuableStateEnum,
+              required: false,
+              description: "Current state of Issue"
+    argument :label_name, GraphQL::STRING_TYPE.to_list_type,
+              required: false,
+              description: "Labels applied to the Issue"
+    argument :created_before, Types::TimeType,
+              required: false,
+              description: "Issues created before this date"
+    argument :created_after, Types::TimeType,
+              required: false,
+              description: "Issues created after this date"
+    argument :updated_before, Types::TimeType,
+              required: false,
+              description: "Issues updated before this date"
+    argument :updated_after, Types::TimeType,
+              required: false,
+              description: "Issues updated after this date"
+    argument :closed_before, Types::TimeType,
+              required: false,
+              description: "Issues closed before this date"
+    argument :closed_after, Types::TimeType,
+              required: false,
+              description: "Issues closed after this date"
     argument :search, GraphQL::STRING_TYPE,
               required: false
     argument :sort, Types::Sort,
diff --git a/app/graphql/types/issuable_state_enum.rb b/app/graphql/types/issuable_state_enum.rb
new file mode 100644
index 00000000000..f2f6d6c6cab
--- /dev/null
+++ b/app/graphql/types/issuable_state_enum.rb
@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Types
+  class IssuableStateEnum < BaseEnum
+    graphql_name 'IssuableState'
+    description 'State of a GitLab issue or merge request'
+
+    value 'opened'
+    value 'closed'
+    value 'locked'
+  end
+end
diff --git a/app/graphql/types/issue_state_enum.rb b/app/graphql/types/issue_state_enum.rb
new file mode 100644
index 00000000000..6521407fc9d
--- /dev/null
+++ b/app/graphql/types/issue_state_enum.rb
@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Types
+  class IssueStateEnum < IssuableStateEnum
+    graphql_name 'IssueState'
+    description 'State of a GitLab issue'
+  end
+end
diff --git a/app/graphql/types/issue_type.rb b/app/graphql/types/issue_type.rb
index a8f2f7914a8..87f6b1f8278 100644
--- a/app/graphql/types/issue_type.rb
+++ b/app/graphql/types/issue_type.rb
@@ -11,7 +11,7 @@ module Types
     field :iid, GraphQL::ID_TYPE, null: false
     field :title, GraphQL::STRING_TYPE, null: false
     field :description, GraphQL::STRING_TYPE, null: true
-    field :state, GraphQL::STRING_TYPE, null: false
+    field :state, IssueStateEnum, null: false
 
     field :author, Types::UserType,
           null: false,
diff --git a/app/graphql/types/merge_request_state_enum.rb b/app/graphql/types/merge_request_state_enum.rb
new file mode 100644
index 00000000000..92f52726ab3
--- /dev/null
+++ b/app/graphql/types/merge_request_state_enum.rb
@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Types
+  class MergeRequestStateEnum < IssuableStateEnum
+    graphql_name 'MergeRequestState'
+    description 'State of a GitLab merge request'
+
+    value 'merged'
+  end
+end
diff --git a/app/graphql/types/merge_request_type.rb b/app/graphql/types/merge_request_type.rb
index fb740b6fb1c..dbdbbb25287 100644
--- a/app/graphql/types/merge_request_type.rb
+++ b/app/graphql/types/merge_request_type.rb
@@ -12,7 +12,7 @@ module Types
     field :iid, GraphQL::ID_TYPE, null: false
     field :title, GraphQL::STRING_TYPE, null: false
     field :description, GraphQL::STRING_TYPE, null: true
-    field :state, GraphQL::STRING_TYPE, null: true
+    field :state, MergeRequestStateEnum, null: false
     field :created_at, Types::TimeType, null: false
     field :updated_at, Types::TimeType, null: false
     field :source_project, Types::ProjectType, null: true
diff --git a/changelogs/unreleased/56492-implement-new-arguments-state-closed_before-and-closed_after-for-issuesresolver-in-graphql.yml b/changelogs/unreleased/56492-implement-new-arguments-state-closed_before-and-closed_after-for-issuesresolver-in-graphql.yml
new file mode 100644
index 00000000000..9b7aed82d49
--- /dev/null
+++ b/changelogs/unreleased/56492-implement-new-arguments-state-closed_before-and-closed_after-for-issuesresolver-in-graphql.yml
@@ -0,0 +1,5 @@
+---
+title: "Implement new arguments `state`, `closed_before` and `closed_after` for `IssuesResolver` in GraphQL"
+merge_request: 24910
+author:
+type: changed
diff --git a/doc/api/README.md b/doc/api/README.md
index 692f63a400c..f9bc35b7a44 100644
--- a/doc/api/README.md
+++ b/doc/api/README.md
@@ -93,7 +93,7 @@ Endpoints are available for:
 ## Road to GraphQL
 
 Going forward, we will start on moving to
-[GraphQL](http://graphql.org/learn/best-practices/) and deprecate the use of
+[GraphQL](graphql/index.md) and deprecate the use of
 controller-specific endpoints. GraphQL has a number of benefits:
 
 1. We avoid having to maintain two different APIs.
diff --git a/spec/graphql/resolvers/issues_resolver_spec.rb b/spec/graphql/resolvers/issues_resolver_spec.rb
index 1a54ab540fc..31842aa5016 100644
--- a/spec/graphql/resolvers/issues_resolver_spec.rb
+++ b/spec/graphql/resolvers/issues_resolver_spec.rb
@@ -5,16 +5,63 @@ describe Resolvers::IssuesResolver do
 
   let(:current_user) { create(:user) }
   set(:project) { create(:project) }
-  set(:issue) { create(:issue, project: project) }
-  set(:issue2) { create(:issue, project: project, title: 'foo') }
+  set(:issue1) { create(:issue, project: project, state: :opened, created_at: 3.hours.ago, updated_at: 3.hours.ago) }
+  set(:issue2) { create(:issue, project: project, state: :closed, title: 'foo', created_at: 1.hour.ago, updated_at: 1.hour.ago, closed_at: 1.hour.ago) }
+  set(:label1) { create(:label, project: project) }
+  set(:label2) { create(:label, project: project) }
 
   before do
     project.add_developer(current_user)
+    create(:label_link, label: label1, target: issue1)
+    create(:label_link, label: label1, target: issue2)
+    create(:label_link, label: label2, target: issue2)
   end
 
   describe '#resolve' do
     it 'finds all issues' do
-      expect(resolve_issues).to contain_exactly(issue, issue2)
+      expect(resolve_issues).to contain_exactly(issue1, issue2)
+    end
+
+    it 'filters by state' do
+      expect(resolve_issues(state: 'opened')).to contain_exactly(issue1)
+      expect(resolve_issues(state: 'closed')).to contain_exactly(issue2)
+    end
+
+    it 'filters by labels' do
+      expect(resolve_issues(label_name: [label1.title])).to contain_exactly(issue1, issue2)
+      expect(resolve_issues(label_name: [label1.title, label2.title])).to contain_exactly(issue2)
+    end
+
+    describe 'filters by created_at' do
+      it 'filters by created_before' do
+        expect(resolve_issues(created_before: 2.hours.ago)).to contain_exactly(issue1)
+      end
+
+      it 'filters by created_after' do
+        expect(resolve_issues(created_after: 2.hours.ago)).to contain_exactly(issue2)
+      end
+    end
+
+    describe 'filters by updated_at' do
+      it 'filters by updated_before' do
+        expect(resolve_issues(updated_before: 2.hours.ago)).to contain_exactly(issue1)
+      end
+
+      it 'filters by updated_after' do
+        expect(resolve_issues(updated_after: 2.hours.ago)).to contain_exactly(issue2)
+      end
+    end
+
+    describe 'filters by closed_at' do
+      let!(:issue3) { create(:issue, project: project, state: :closed, title: 'foo', closed_at: 3.hours.ago) }
+
+      it 'filters by closed_before' do
+        expect(resolve_issues(closed_before: 2.hours.ago)).to contain_exactly(issue3)
+      end
+
+      it 'filters by closed_after' do
+        expect(resolve_issues(closed_after: 2.hours.ago)).to contain_exactly(issue2)
+      end
     end
 
     it 'searches issues' do
@@ -22,7 +69,7 @@ describe Resolvers::IssuesResolver do
     end
 
     it 'sort issues' do
-      expect(resolve_issues(sort: 'created_desc')).to eq [issue2, issue]
+      expect(resolve_issues(sort: 'created_desc')).to eq [issue2, issue1]
     end
 
     it 'returns issues user can see' do
@@ -30,27 +77,27 @@ describe Resolvers::IssuesResolver do
 
       create(:issue, confidential: true)
 
-      expect(resolve_issues).to contain_exactly(issue, issue2)
+      expect(resolve_issues).to contain_exactly(issue1, issue2)
     end
 
     it 'finds a specific issue with iids' do
-      expect(resolve_issues(iids: issue.iid)).to contain_exactly(issue)
+      expect(resolve_issues(iids: issue1.iid)).to contain_exactly(issue1)
     end
 
     it 'finds multiple issues with iids' do
-      expect(resolve_issues(iids: [issue.iid, issue2.iid]))
-        .to contain_exactly(issue, issue2)
+      expect(resolve_issues(iids: [issue1.iid, issue2.iid]))
+        .to contain_exactly(issue1, issue2)
     end
 
     it 'finds only the issues within the project we are looking at' do
       another_project = create(:project)
-      iids = [issue, issue2].map(&:iid)
+      iids = [issue1, issue2].map(&:iid)
 
       iids.each do |iid|
         create(:issue, project: another_project, iid: iid)
       end
 
-      expect(resolve_issues(iids: iids)).to contain_exactly(issue, issue2)
+      expect(resolve_issues(iids: iids)).to contain_exactly(issue1, issue2)
     end
   end
 
diff --git a/spec/graphql/types/issuable_state_enum_spec.rb b/spec/graphql/types/issuable_state_enum_spec.rb
new file mode 100644
index 00000000000..65a80fa4176
--- /dev/null
+++ b/spec/graphql/types/issuable_state_enum_spec.rb
@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe GitlabSchema.types['IssuableState'] do
+  it { expect(described_class.graphql_name).to eq('IssuableState') }
+
+  it_behaves_like 'issuable state'
+end
diff --git a/spec/graphql/types/issue_state_enum_spec.rb b/spec/graphql/types/issue_state_enum_spec.rb
new file mode 100644
index 00000000000..de19e6fc505
--- /dev/null
+++ b/spec/graphql/types/issue_state_enum_spec.rb
@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe GitlabSchema.types['IssueState'] do
+  it { expect(described_class.graphql_name).to eq('IssueState') }
+
+  it_behaves_like 'issuable state'
+end
diff --git a/spec/graphql/types/merge_request_state_enum_spec.rb b/spec/graphql/types/merge_request_state_enum_spec.rb
new file mode 100644
index 00000000000..f4241377344
--- /dev/null
+++ b/spec/graphql/types/merge_request_state_enum_spec.rb
@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe GitlabSchema.types['MergeRequestState'] do
+  it { expect(described_class.graphql_name).to eq('MergeRequestState') }
+
+  it_behaves_like 'issuable state'
+
+  it 'exposes all the existing merge request states' do
+    actual_states = Hash[described_class.values.map { |_, v| [v.name, v.value] }]
+    expected_states = %w[opened closed locked merged].map { |s| [s, s] }.to_h
+
+    expect(actual_states['merged']).to eq(expected_states['merged'])
+  end
+end
diff --git a/spec/support/shared_examples/graphql/issuable_state_shared_examples.rb b/spec/support/shared_examples/graphql/issuable_state_shared_examples.rb
new file mode 100644
index 00000000000..5f115b892ba
--- /dev/null
+++ b/spec/support/shared_examples/graphql/issuable_state_shared_examples.rb
@@ -0,0 +1,8 @@
+RSpec.shared_examples 'issuable state' do
+  it 'exposes all the existing issuable states' do
+    actual_states = Hash[described_class.values.map { |_, v| [v.name, v.value] }]
+    expected_states = %w[opened closed locked].map { |s| [s, s] }.to_h
+
+    expect(actual_states).to include(expected_states)
+  end
+end