From 2f44722caad2a11d4cd8ec798d88a02fe792f255 Mon Sep 17 00:00:00 2001
From: Kassio Borges <kborges@gitlab.com>
Date: Mon, 3 Mar 2025 22:40:01 +0000
Subject: [PATCH] Permit filter work item widgets by type on GraphQL
Currently, every time we load a work item and select any widget data we
load all the widgets related to that work item, even if we don't want to
use all every widget related to the WorkItem.
To avoid that, we're introducing two possible ways to filter the widgets
of a work item:
- types_except: where we list widget types that we don't want on the
result. This might be useful on places where we want all the Widgets
except one or two, like on the main WorkItem UI, where we load the
notes widget after loading the whole work item.
- types_in: where we list only the widget types desired on the result.
This might be useful as the secong query on the main WorkItem UI,
where we want to load just the notes for the WorkItem, or on WorkItems
lists where we usually just want to list a small set of widgets.
Related to: https://gitlab.com/gitlab-org/gitlab/-/issues/521310
Changelog: changed
---
app/graphql/types/work_item_type.rb | 14 +++-
app/models/work_item.rb | 31 ++++++---
app/models/work_items/widget_definition.rb | 4 ++
doc/api/graphql/reference/_index.md | 14 +++-
spec/models/work_item_spec.rb | 73 +++++++++++++++++++--
spec/requests/api/graphql/work_item_spec.rb | 58 ++++++++++++++++
6 files changed, 179 insertions(+), 15 deletions(-)
diff --git a/app/graphql/types/work_item_type.rb b/app/graphql/types/work_item_type.rb
index 56fa53355fd77..c19ece80cdff1 100644
--- a/app/graphql/types/work_item_type.rb
+++ b/app/graphql/types/work_item_type.rb
@@ -60,7 +60,19 @@ class WorkItemType < BaseObject
field :widgets,
[Types::WorkItems::WidgetInterface],
null: true,
- description: 'Collection of widgets that belong to the work item.'
+ description: 'Collection of widgets that belong to the work item.' do
+ argument :except_types, [::Types::WorkItems::WidgetTypeEnum],
+ required: false,
+ default_value: nil,
+ description: 'Except widgets of the given types.'
+ argument :only_types, [::Types::WorkItems::WidgetTypeEnum],
+ required: false,
+ default_value: nil,
+ description: 'Only widgets of the given types.'
+
+ validates mutually_exclusive: %i[except_types only_types]
+ end
+
field :work_item_type, Types::WorkItems::TypeType, null: false,
description: 'Type assigned to the work item.'
diff --git a/app/models/work_item.rb b/app/models/work_item.rb
index 4b1d3bc75d877..4a5d6d56e4a40 100644
--- a/app/models/work_item.rb
+++ b/app/models/work_item.rb
@@ -146,10 +146,17 @@ def todoable_target_type_name
%w[Issue WorkItem]
end
- def widgets
- strong_memoize(:widgets) do
- work_item_type.widgets(resource_parent).map do |widget_definition|
- widget_definition.widget_class.new(self, widget_definition: widget_definition)
+ def widgets(except_types: [], only_types: nil)
+ raise ArgumentError, 'Only one filter is allowed' if only_types.present? && except_types.present?
+
+ strong_memoize_with(:widgets, only_types, except_types) do
+ except_types = Array.wrap(except_types)
+
+ widget_definitions.keys.filter_map do |type|
+ next if except_types.include?(type)
+ next if only_types&.exclude?(type)
+
+ get_widget(type)
end
end
end
@@ -157,13 +164,21 @@ def widgets
# Returns widget object if available
# type parameter can be a symbol, for example, `:description`.
def get_widget(type)
- widgets.find do |widget|
- widget.instance_of?(WorkItems::Widgets.const_get(type.to_s.camelize, false))
+ strong_memoize_with(type) do
+ break unless widget_definitions.key?(type.to_sym)
+
+ widget_definitions[type].build_widget(self)
end
- rescue NameError
- nil
end
+ def widget_definitions
+ work_item_type
+ .widgets(resource_parent)
+ .index_by(&:widget_type)
+ .symbolize_keys
+ end
+ strong_memoize_attr :widget_definitions
+
def ancestors
hierarchy.ancestors(hierarchy_order: :asc)
end
diff --git a/app/models/work_items/widget_definition.rb b/app/models/work_items/widget_definition.rb
index fa2c602a3c7a6..a48afd23ce13d 100644
--- a/app/models/work_items/widget_definition.rb
+++ b/app/models/work_items/widget_definition.rb
@@ -69,5 +69,9 @@ def widget_class
rescue NameError
nil
end
+
+ def build_widget(work_item)
+ widget_class.new(work_item, widget_definition: self)
+ end
end
end
diff --git a/doc/api/graphql/reference/_index.md b/doc/api/graphql/reference/_index.md
index 440387b58293b..d6b0931382b71 100644
--- a/doc/api/graphql/reference/_index.md
+++ b/doc/api/graphql/reference/_index.md
@@ -39458,7 +39458,6 @@ four standard [pagination arguments](#pagination-arguments):
| <a id="workitemuserdiscussionscount"></a>`userDiscussionsCount` | [`Int!`](#int) | Number of user discussions in the work item. |
| <a id="workitemuserpermissions"></a>`userPermissions` | [`WorkItemPermissions!`](#workitempermissions) | Permissions for the current user on the resource. |
| <a id="workitemweburl"></a>`webUrl` | [`String`](#string) | URL of this object. |
-| <a id="workitemwidgets"></a>`widgets` | [`[WorkItemWidget!]`](#workitemwidget) | Collection of widgets that belong to the work item. |
| <a id="workitemworkitemtype"></a>`workItemType` | [`WorkItemType!`](#workitemtype) | Type assigned to the work item. |
#### Fields with arguments
@@ -39475,6 +39474,19 @@ Returns [`String!`](#string).
| ---- | ---- | ----------- |
| <a id="workitemreferencefull"></a>`full` | [`Boolean`](#boolean) | Boolean option specifying whether the reference should be returned in full. |
+##### `WorkItem.widgets`
+
+Collection of widgets that belong to the work item.
+
+Returns [`[WorkItemWidget!]`](#workitemwidget).
+
+###### Arguments
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| <a id="workitemwidgetsexcepttypes"></a>`exceptTypes` | [`[WorkItemWidgetType!]`](#workitemwidgettype) | Except widgets of the given types. |
+| <a id="workitemwidgetsonlytypes"></a>`onlyTypes` | [`[WorkItemWidgetType!]`](#workitemwidgettype) | Only widgets of the given types. |
+
### `WorkItemClosingMergeRequest`
#### Fields
diff --git a/spec/models/work_item_spec.rb b/spec/models/work_item_spec.rb
index 70b11f5c07cca..049aea5b5aa1a 100644
--- a/spec/models/work_item_spec.rb
+++ b/spec/models/work_item_spec.rb
@@ -187,16 +187,79 @@
end
describe '#widgets' do
- subject { build(:work_item).widgets }
+ subject(:work_item) { build(:work_item) }
it 'returns instances of supported widgets' do
- is_expected.to include(
+ expect(work_item.widgets).to match_array([
+ instance_of(WorkItems::Widgets::Assignees),
+ instance_of(WorkItems::Widgets::AwardEmoji),
+ instance_of(WorkItems::Widgets::CrmContacts),
+ instance_of(WorkItems::Widgets::CurrentUserTodos),
instance_of(WorkItems::Widgets::Description),
+ instance_of(WorkItems::Widgets::Designs),
+ instance_of(WorkItems::Widgets::Development),
+ instance_of(WorkItems::Widgets::EmailParticipants),
+ instance_of(WorkItems::Widgets::ErrorTracking),
instance_of(WorkItems::Widgets::Hierarchy),
instance_of(WorkItems::Widgets::Labels),
- instance_of(WorkItems::Widgets::Assignees),
- instance_of(WorkItems::Widgets::StartAndDueDate)
- )
+ instance_of(WorkItems::Widgets::LinkedItems),
+ instance_of(WorkItems::Widgets::Milestone),
+ instance_of(WorkItems::Widgets::Notes),
+ instance_of(WorkItems::Widgets::Notifications),
+ instance_of(WorkItems::Widgets::Participants),
+ instance_of(WorkItems::Widgets::StartAndDueDate),
+ instance_of(WorkItems::Widgets::TimeTracking)
+ ])
+ end
+
+ context 'when filters are given' do
+ context 'when both only_types and except_types are given' do
+ it 'raises an error' do
+ expect { work_item.widgets(only_types: [true], except_types: [true]) }
+ .to raise_error(ArgumentError, 'Only one filter is allowed')
+ end
+ end
+
+ context 'when filtering by only_types' do
+ it 'only returns widgets on the given list' do
+ expect(work_item.widgets(only_types: [:milestone, :description])).to match_array([
+ instance_of(WorkItems::Widgets::Milestone),
+ instance_of(WorkItems::Widgets::Description)
+ ])
+ end
+ end
+
+ context 'when passing explicitly nil to except_types' do
+ it 'only returns widgets on the given list' do
+ expect(work_item.widgets(only_types: [:milestone, :description], except_types: nil)).to match_array([
+ instance_of(WorkItems::Widgets::Milestone),
+ instance_of(WorkItems::Widgets::Description)
+ ])
+ end
+ end
+
+ context 'when filtering by except_types' do
+ it 'only returns widgets on the given list' do
+ expect(work_item.widgets(except_types: [:milestone, :description])).to match_array([
+ instance_of(WorkItems::Widgets::Assignees),
+ instance_of(WorkItems::Widgets::AwardEmoji),
+ instance_of(WorkItems::Widgets::CrmContacts),
+ instance_of(WorkItems::Widgets::CurrentUserTodos),
+ instance_of(WorkItems::Widgets::Designs),
+ instance_of(WorkItems::Widgets::Development),
+ instance_of(WorkItems::Widgets::EmailParticipants),
+ instance_of(WorkItems::Widgets::ErrorTracking),
+ instance_of(WorkItems::Widgets::Hierarchy),
+ instance_of(WorkItems::Widgets::Labels),
+ instance_of(WorkItems::Widgets::LinkedItems),
+ instance_of(WorkItems::Widgets::Notes),
+ instance_of(WorkItems::Widgets::Notifications),
+ instance_of(WorkItems::Widgets::Participants),
+ instance_of(WorkItems::Widgets::StartAndDueDate),
+ instance_of(WorkItems::Widgets::TimeTracking)
+ ])
+ end
+ end
end
end
diff --git a/spec/requests/api/graphql/work_item_spec.rb b/spec/requests/api/graphql/work_item_spec.rb
index 1600da2d2afb8..473fe4d070716 100644
--- a/spec/requests/api/graphql/work_item_spec.rb
+++ b/spec/requests/api/graphql/work_item_spec.rb
@@ -791,6 +791,64 @@ def pagination_results_data(nodes)
)
end
end
+
+ context 'when filtering' do
+ context 'when selecting widgets' do
+ let(:work_item_fields) do
+ <<~GRAPHQL
+ id
+ widgets(onlyTypes: [DESCRIPTION]) {
+ type
+ }
+ GRAPHQL
+ end
+
+ it 'only returns selected widgets' do
+ expect(work_item_data).to include(
+ 'id' => work_item.to_gid.to_s,
+ 'widgets' => [{
+ 'type' => 'DESCRIPTION'
+ }]
+ )
+ end
+ end
+
+ context 'when excluding widgets' do
+ let(:work_item_fields) do
+ <<~GRAPHQL
+ id
+ widgets(exceptTypes: [DESCRIPTION]) {
+ type
+ }
+ GRAPHQL
+ end
+
+ it 'does not return excluded widgets' do
+ expect(work_item_data).to include(
+ 'id' => work_item.to_gid.to_s,
+ 'widgets' => [
+ { "type" => "ASSIGNEES" },
+ { "type" => "AWARD_EMOJI" },
+ { "type" => "CRM_CONTACTS" },
+ { "type" => "CURRENT_USER_TODOS" },
+ { "type" => "DESIGNS" },
+ { "type" => "DEVELOPMENT" },
+ { "type" => "EMAIL_PARTICIPANTS" },
+ { "type" => "ERROR_TRACKING" },
+ { "type" => "HIERARCHY" },
+ { "type" => "LABELS" },
+ { "type" => "LINKED_ITEMS" },
+ { "type" => "MILESTONE" },
+ { "type" => "NOTES" },
+ { "type" => "NOTIFICATIONS" },
+ { "type" => "PARTICIPANTS" },
+ { "type" => "START_AND_DUE_DATE" },
+ { "type" => "TIME_TRACKING" }
+ ]
+ )
+ end
+ end
+ end
end
describe 'notes widget' do
--
GitLab