Merge branch '198439-expose-pending-todo-in-graphql' into 'master'

GraphQL: Expose current user todos for todoables

See merge request gitlab-org/gitlab!40555

app/graphql/types/current_user_todos.rb

+# frozen_string_literal: true
+
+# Interface to expose todos for the current_user on the `object`
+module Types
+  module CurrentUserTodos
+    include BaseInterface
+
+    field_class Types::BaseField
+
+    field :current_user_todos, Types::TodoType.connection_type,
+          description: 'Todos for the current user',
+          null: false do
+            argument :state, Types::TodoStateEnum,
+                     description: 'State of the todos',
+                     required: false
+          end
+
+    def current_user_todos(state: nil)
+      state ||= %i(done pending) # TodosFinder treats a `nil` state param as `pending`
+
+      TodosFinder.new(current_user, state: state, type: object.class.name, target_id: object.id).execute
+    end
+  end
+end

app/graphql/types/design_management/design_type.rb

@@ -12,6 +12,7 @@ module Types
 
       implements(Types::Notes::NoteableType)
       implements(Types::DesignManagement::DesignFields)
+      implements(Types::CurrentUserTodos)
 
       field :versions,
             Types::DesignManagement::VersionType.connection_type,

app/graphql/types/issue_type.rb

@@ -7,6 +7,7 @@ module Types
     connection_type_class(Types::CountableConnectionType)
 
     implements(Types::Notes::NoteableType)
+    implements(Types::CurrentUserTodos)
 
     authorize :read_issue
 

app/graphql/types/merge_request_type.rb

@@ -7,6 +7,7 @@ module Types
     connection_type_class(Types::CountableConnectionType)
 
     implements(Types::Notes::NoteableType)
+    implements(Types::CurrentUserTodos)
 
     authorize :read_merge_request
 

app/graphql/types/todo_type.rb

@@ -26,7 +26,7 @@ module Types
           resolve: -> (todo, args, context) { Gitlab::Graphql::Loaders::BatchModelLoader.new(Group, todo.group_id).find }
 
     field :author, Types::UserType,
-          description: 'The owner of this todo',
+          description: 'The author of this todo',
           null: false,
           resolve: -> (todo, args, context) { Gitlab::Graphql::Loaders::BatchModelLoader.new(User, todo.author_id).find }
 

changelogs/unreleased/198439-expose-pending-todo-in-graphql.yml

+---
+title: Expose the todos of the current user on relevant objects in GraphQL
+merge_request: 40555
+author:
+type: added

doc/api/graphql/reference/gitlab_schema.graphql

@@ -2944,6 +2944,38 @@ type CreateSnippetPayload {
   snippet: Snippet
 }
 
+interface CurrentUserTodos {
+  """
+  Todos for the current user
+  """
+  currentUserTodos(
+    """
+    Returns the elements in the list that come after the specified cursor.
+    """
+    after: String
+
+    """
+    Returns the elements in the list that come before the specified cursor.
+    """
+    before: String
+
+    """
+    Returns the first _n_ elements from the list.
+    """
+    first: Int
+
+    """
+    Returns the last _n_ elements from the list.
+    """
+    last: Int
+
+    """
+    State of the todos
+    """
+    state: TodoStateEnum
+  ): TodoConnection!
+}
+
 """
 Autogenerated input type of DastOnDemandScanCreate
 """
@@ -3501,7 +3533,37 @@ type DeleteJobsResponse {
 """
 A single design
 """
-type Design implements DesignFields & Noteable {
+type Design implements CurrentUserTodos & DesignFields & Noteable {
+  """
+  Todos for the current user
+  """
+  currentUserTodos(
+    """
+    Returns the elements in the list that come after the specified cursor.
+    """
+    after: String
+
+    """
+    Returns the elements in the list that come before the specified cursor.
+    """
+    before: String
+
+    """
+    Returns the first _n_ elements from the list.
+    """
+    first: Int
+
+    """
+    Returns the last _n_ elements from the list.
+    """
+    last: Int
+
+    """
+    State of the todos
+    """
+    state: TodoStateEnum
+  ): TodoConnection!
+
   """
   The diff refs for this design
   """
@@ -4896,7 +4958,7 @@ type EnvironmentEdge {
 """
 Represents an epic.
 """
-type Epic implements Noteable {
+type Epic implements CurrentUserTodos & Noteable {
   """
   Author of the epic
   """
@@ -4999,6 +5061,36 @@ type Epic implements Noteable {
   """
   createdAt: Time
 
+  """
+  Todos for the current user
+  """
+  currentUserTodos(
+    """
+    Returns the elements in the list that come after the specified cursor.
+    """
+    after: String
+
+    """
+    Returns the elements in the list that come before the specified cursor.
+    """
+    before: String
+
+    """
+    Returns the first _n_ elements from the list.
+    """
+    first: Int
+
+    """
+    Returns the last _n_ elements from the list.
+    """
+    last: Int
+
+    """
+    State of the todos
+    """
+    state: TodoStateEnum
+  ): TodoConnection!
+
   """
   Number of open and closed descendant epics and issues
   """
@@ -5438,7 +5530,7 @@ type EpicHealthStatus {
 """
 Relationship between an epic and an issue
 """
-type EpicIssue implements Noteable {
+type EpicIssue implements CurrentUserTodos & Noteable {
   """
   Alert associated to this issue
   """
@@ -5494,6 +5586,36 @@ type EpicIssue implements Noteable {
   """
   createdAt: Time!
 
+  """
+  Todos for the current user
+  """
+  currentUserTodos(
+    """
+    Returns the elements in the list that come after the specified cursor.
+    """
+    after: String
+
+    """
+    Returns the elements in the list that come before the specified cursor.
+    """
+    before: String
+
+    """
+    Returns the first _n_ elements from the list.
+    """
+    first: Int
+
+    """
+    Returns the last _n_ elements from the list.
+    """
+    last: Int
+
+    """
+    State of the todos
+    """
+    state: TodoStateEnum
+  ): TodoConnection!
+
   """
   Description of the issue
   """
@@ -7328,7 +7450,7 @@ enum IssuableState {
   opened
 }
 
-type Issue implements Noteable {
+type Issue implements CurrentUserTodos & Noteable {
   """
   Alert associated to this issue
   """
@@ -7384,6 +7506,36 @@ type Issue implements Noteable {
   """
   createdAt: Time!
 
+  """
+  Todos for the current user
+  """
+  currentUserTodos(
+    """
+    Returns the elements in the list that come after the specified cursor.
+    """
+    after: String
+
+    """
+    Returns the elements in the list that come before the specified cursor.
+    """
+    before: String
+
+    """
+    Returns the first _n_ elements from the list.
+    """
+    first: Int
+
+    """
+    Returns the last _n_ elements from the list.
+    """
+    last: Int
+
+    """
+    State of the todos
+    """
+    state: TodoStateEnum
+  ): TodoConnection!
+
   """
   Description of the issue
   """
@@ -8964,7 +9116,7 @@ type MemberInterfaceEdge {
   node: MemberInterface
 }
 
-type MergeRequest implements Noteable {
+type MergeRequest implements CurrentUserTodos & Noteable {
   """
   Indicates if members of the target project can push to the fork
   """
@@ -9040,6 +9192,36 @@ type MergeRequest implements Noteable {
   """
   createdAt: Time!
 
+  """
+  Todos for the current user
+  """
+  currentUserTodos(
+    """
+    Returns the elements in the list that come after the specified cursor.
+    """
+    after: String
+
+    """
+    Returns the elements in the list that come before the specified cursor.
+    """
+    before: String
+
+    """
+    Returns the first _n_ elements from the list.
+    """
+    first: Int
+
+    """
+    Returns the last _n_ elements from the list.
+    """
+    last: Int
+
+    """
+    State of the todos
+    """
+    state: TodoStateEnum
+  ): TodoConnection!
+
   """
   Default merge commit message of the merge request
   """
@@ -16234,7 +16416,7 @@ type Todo {
   action: TodoActionEnum!
 
   """
-  The owner of this todo
+  The author of this todo
   """
   author: User!
 

doc/api/graphql/reference/index.md

@@ -2374,7 +2374,7 @@ Representing a todo entry
 | Name  | Type  | Description |
 | ---   |  ---- | ----------  |
 | `action` | TodoActionEnum! | Action of the todo |
-| `author` | User! | The owner of this todo |
+| `author` | User! | The author of this todo |
 | `body` | String! | Body of the todo |
 | `createdAt` | Time! | Timestamp this todo was created |
 | `group` | Group | Group this todo is associated with |

ee/app/graphql/types/epic_type.rb

@@ -14,6 +14,7 @@ module Types
     present_using EpicPresenter
 
     implements(Types::Notes::NoteableType)
+    implements(Types::CurrentUserTodos)
 
     field :id, GraphQL::ID_TYPE, null: false,
           description: 'ID of the epic'

ee/spec/graphql/types/epic_type_spec.rb

@@ -12,9 +12,12 @@ RSpec.describe GitlabSchema.types['Epic'] do
       web_path web_url relation_path reference issues user_permissions
       notes discussions relative_position subscribed participants
       descendant_counts descendant_weight_sum upvotes downvotes health_status
+      current_user_todos
     ]
   end
 
+  it { expect(described_class.interfaces).to include(Types::CurrentUserTodos) }
+
   it { expect(described_class).to expose_permissions_using(Types::PermissionTypes::Epic) }
 
   it { expect(described_class.graphql_name).to eq('Epic') }

spec/graphql/types/current_user_todos_type_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe GitlabSchema.types['CurrentUserTodos'] do
+  specify { expect(described_class.graphql_name).to eq('CurrentUserTodos') }
+
+  specify { expect(described_class).to have_graphql_fields(:current_user_todos).only }
+end

spec/graphql/types/design_management/design_type_spec.rb

@@ -3,8 +3,10 @@
 require 'spec_helper'
 
 RSpec.describe GitlabSchema.types['Design'] do
+  specify { expect(described_class.interfaces).to include(Types::CurrentUserTodos) }
+
   it_behaves_like 'a GraphQL type with design fields' do
-    let(:extra_design_fields) { %i[notes discussions versions] }
+    let(:extra_design_fields) { %i[notes current_user_todos discussions versions] }
     let_it_be(:design) { create(:design, :with_versions) }
     let(:object_id) { GitlabSchema.id_from_object(design) }
     let_it_be(:object_id_b) { GitlabSchema.id_from_object(create(:design, :with_versions)) }

spec/graphql/types/issue_type_spec.rb

@@ -11,11 +11,13 @@ RSpec.describe GitlabSchema.types['Issue'] do
 
   specify { expect(described_class.interfaces).to include(Types::Notes::NoteableType) }
 
+  specify { expect(described_class.interfaces).to include(Types::CurrentUserTodos) }
+
   it 'has specific fields' do
     fields = %i[id iid title description state reference author assignees participants labels milestone due_date
                 confidential discussion_locked upvotes downvotes user_notes_count web_path web_url relative_position
                 subscribed time_estimate total_time_spent closed_at created_at updated_at task_completion_status
-                designs design_collection alert_management_alert severity]
+                designs design_collection alert_management_alert severity current_user_todos]
 
     fields.each do |field_name|
       expect(described_class).to have_graphql_field(field_name)

spec/graphql/types/merge_request_type_spec.rb

@@ -9,6 +9,8 @@ RSpec.describe GitlabSchema.types['MergeRequest'] do
 
   specify { expect(described_class.interfaces).to include(Types::Notes::NoteableType) }
 
+  specify { expect(described_class.interfaces).to include(Types::CurrentUserTodos) }
+
   it 'has the expected fields' do
     expected_fields = %w[
       notes discussions user_permissions id iid title title_html description
@@ -24,7 +26,7 @@ RSpec.describe GitlabSchema.types['MergeRequest'] do
       source_branch_exists target_branch_exists
       upvotes downvotes head_pipeline pipelines task_completion_status
       milestone assignees participants subscribed labels discussion_locked time_estimate
-      total_time_spent reference author merged_at commit_count
+      total_time_spent reference author merged_at commit_count current_user_todos
     ]
 
     if Gitlab.ee?

spec/requests/api/graphql/current_user_todos_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'A Todoable that implements the CurrentUserTodos interface' do
+  include GraphqlHelpers
+
+  let_it_be(:current_user) { create(:user) }
+  let_it_be(:project) { create(:project, :public) }
+  let_it_be(:todoable) { create(:issue, project: project) }
+  let_it_be(:done_todo) { create(:todo, state: :done, target: todoable, user: current_user) }
+  let_it_be(:pending_todo) { create(:todo, state: :pending, target: todoable, user: current_user) }
+  let(:state) { 'null' }
+
+  let(:todoable_response) do
+    graphql_data_at(:project, :issue, :currentUserTodos, :nodes)
+  end
+
+  let(:query) do
+    <<~GQL
+      {
+        project(fullPath: "#{project.full_path}") {
+          issue(iid: "#{todoable.iid}") {
+            currentUserTodos(state: #{state}) {
+              nodes {
+                #{all_graphql_fields_for('Todo', max_depth: 1)}
+              }
+            }
+          }
+        }
+      }
+    GQL
+  end
+
+  it 'returns todos of the current user' do
+    post_graphql(query, current_user: current_user)
+
+    expect(todoable_response).to contain_exactly(
+      a_hash_including('id' => global_id_of(done_todo)),
+      a_hash_including('id' => global_id_of(pending_todo))
+    )
+  end
+
+  it 'does not return todos of another user', :aggregate_failures do
+    post_graphql(query, current_user: create(:user))
+
+    expect(response).to have_gitlab_http_status(:success)
+    expect(todoable_response).to be_empty
+  end
+
+  it 'does not error when there is no logged in user', :aggregate_failures do
+    post_graphql(query)
+
+    expect(response).to have_gitlab_http_status(:success)
+    expect(todoable_response).to be_empty
+  end
+
+  context 'when `state` argument is `pending`' do
+    let(:state) { 'pending' }
+
+    it 'returns just the pending todo' do
+      post_graphql(query, current_user: current_user)
+
+      expect(todoable_response).to contain_exactly(
+        a_hash_including('id' => global_id_of(pending_todo))
+      )
+    end
+  end
+
+  context 'when `state` argument is `done`' do
+    let(:state) { 'done' }
+
+    it 'returns just the done todo' do
+      post_graphql(query, current_user: current_user)
+
+      expect(todoable_response).to contain_exactly(
+        a_hash_including('id' => global_id_of(done_todo))
+      )
+    end
+  end
+end