Merge branch 'add-vulnerability-work-item-widget' into 'master'

Add WorkItemWidgetVulnerabilities with related vulnerabilities

See merge request https://gitlab.com/gitlab-org/gitlab/-/merge_requests/183548



Merged-by: Lorenz van Herwaarden <lvanherwaarden@gitlab.com>
Approved-by: Gregory Havenga <11164960-ghavenga@users.noreply.gitlab.com>
Approved-by: Alexandru Croitor <acroitor@gitlab.com>
Reviewed-by: Alexandru Croitor <acroitor@gitlab.com>

app/assets/javascripts/graphql_shared/possible_types.json

@@ -298,6 +298,7 @@
     "WorkItemWidgetTestReports",
     "WorkItemWidgetTimeTracking",
     "WorkItemWidgetVerificationStatus",
+    "WorkItemWidgetVulnerabilities",
     "WorkItemWidgetWeight"
   ],
   "WorkItemWidgetDefinition": [

app/models/work_items/widget_definition.rb

@@ -45,7 +45,8 @@ class WidgetDefinition < ApplicationRecord
       custom_status: 26,
       linked_resources: 27,
       custom_fields: 28, # EE-only
-      error_tracking: 29
+      error_tracking: 29,
+      vulnerabilities: 30 # EE-only
     }
 
     attribute :widget_options, ::Gitlab::Database::Type::IndifferentJsonb.new

db/migrate/20250305122633_add_vulnerabilities_widget_to_work_item_types.rb

+# frozen_string_literal: true
+
+class AddVulnerabilitiesWidgetToWorkItemTypes < Gitlab::Database::Migration[2.2]
+  include Gitlab::Database::MigrationHelpers::WorkItems::Widgets
+
+  restrict_gitlab_migration gitlab_schema: :gitlab_main
+  disable_ddl_transaction!
+  milestone '17.10'
+
+  WORK_ITEM_TYPE_ENUM_VALUES = [0] # issue
+
+  WIDGETS = [
+    {
+      name: 'Vulnerabilities',
+      widget_type: 30
+    }
+  ]
+
+  def up
+    add_widget_definitions(type_enum_values: WORK_ITEM_TYPE_ENUM_VALUES, widgets: WIDGETS)
+  end
+
+  def down
+    remove_widget_definitions(type_enum_values: WORK_ITEM_TYPE_ENUM_VALUES, widgets: WIDGETS)
+  end
+end

db/schema_migrations/20250305122633

+99672a385440dbf7119382fc9b722e6fb400ab743a1c5daeaa42e4af93837691
\ No newline at end of file

doc/api/graphql/reference/_index.md

@@ -40374,6 +40374,17 @@ Represents a verification status widget.
 | <a id="workitemwidgetverificationstatustype"></a>`type` | [`WorkItemWidgetType`](#workitemwidgettype) | Widget type. |
 | <a id="workitemwidgetverificationstatusverificationstatus"></a>`verificationStatus` {{< icon name="warning-solid" >}} | [`String`](#string) | **Introduced** in GitLab 15.5. **Status**: Experiment. Verification status of the work item. |
+### `WorkItemWidgetVulnerabilities`
+
+Represents a vulnerabilities widget.
+
+#### Fields
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| <a id="workitemwidgetvulnerabilitiesrelatedvulnerabilities"></a>`relatedVulnerabilities` {{< icon name="warning-solid" >}} | [`VulnerabilityConnection`](#vulnerabilityconnection) | **Introduced** in GitLab 17.10. **Status**: Experiment. Related vulnerabilities of the work item. |
+| <a id="workitemwidgetvulnerabilitiestype"></a>`type` | [`WorkItemWidgetType`](#workitemwidgettype) | Widget type. |
+
 ### `WorkItemWidgetWeight`
 Represents a weight widget.
@@ -44283,6 +44294,7 @@ Type of a work item widget.
 | <a id="workitemwidgettypetest_reports"></a>`TEST_REPORTS` | Test Reports widget. |
 | <a id="workitemwidgettypetime_tracking"></a>`TIME_TRACKING` | Time Tracking widget. |
 | <a id="workitemwidgettypeverification_status"></a>`VERIFICATION_STATUS` | Verification Status widget. |
+| <a id="workitemwidgettypevulnerabilities"></a>`VULNERABILITIES` | Vulnerabilities widget. |
 | <a id="workitemwidgettypeweight"></a>`WEIGHT` | Weight widget. |
 ### `WorkspaceVariableInputType`
@@ -46690,6 +46702,7 @@ Implementations:
 - [`WorkItemWidgetTestReports`](#workitemwidgettestreports)
 - [`WorkItemWidgetTimeTracking`](#workitemwidgettimetracking)
 - [`WorkItemWidgetVerificationStatus`](#workitemwidgetverificationstatus)
+- [`WorkItemWidgetVulnerabilities`](#workitemwidgetvulnerabilities)
 - [`WorkItemWidgetWeight`](#workitemwidgetweight)
 ##### Fields

ee/app/graphql/ee/types/work_items/widget_interface.rb

@@ -25,7 +25,8 @@ def type_mappings
             ::WorkItems::Widgets::RequirementLegacy => ::Types::WorkItems::Widgets::RequirementLegacyType,
             ::WorkItems::Widgets::TestReports => ::Types::WorkItems::Widgets::TestReportsType,
             ::WorkItems::Widgets::Color => ::Types::WorkItems::Widgets::ColorType,
-            ::WorkItems::Widgets::CustomFields => ::Types::WorkItems::Widgets::CustomFieldsType
+            ::WorkItems::Widgets::CustomFields => ::Types::WorkItems::Widgets::CustomFieldsType,
+            ::WorkItems::Widgets::Vulnerabilities => ::Types::WorkItems::Widgets::VulnerabilitiesType
           }.freeze
 
           orphan_types(*type_mappings.values)

ee/app/graphql/types/work_items/widgets/vulnerabilities_type.rb

+# frozen_string_literal: true
+
+module Types
+  module WorkItems
+    module Widgets
+      # rubocop:disable Graphql/AuthorizeTypes -- Disabling widget level authorization
+      class VulnerabilitiesType < BaseObject
+        graphql_name 'WorkItemWidgetVulnerabilities'
+        description 'Represents a vulnerabilities widget'
+
+        implements ::Types::WorkItems::WidgetInterface
+
+        field :related_vulnerabilities, ::Types::VulnerabilityType.connection_type,
+          null: true,
+          description: 'Related vulnerabilities of the work item.',
+          experiment: { milestone: '17.10' }
+      end
+      # rubocop:enable Graphql/AuthorizeTypes
+    end
+  end
+end

ee/app/models/ee/work_items/type.rb

@@ -18,7 +18,8 @@ module Type
         issuable_health_status: ::WorkItems::Widgets::HealthStatus,
         okrs: ::WorkItems::Widgets::Progress,
         epic_colors: ::WorkItems::Widgets::Color,
-        custom_fields: ::WorkItems::Widgets::CustomFields
+        custom_fields: ::WorkItems::Widgets::CustomFields,
+        security_dashboard: ::WorkItems::Widgets::Vulnerabilities
       }.freeze
 
       LICENSED_TYPES = { epic: :epics, objective: :okrs, key_result: :okrs, requirement: :requirements }.freeze

ee/app/models/work_items/widgets/vulnerabilities.rb

+# frozen_string_literal: true
+
+module WorkItems
+  module Widgets
+    class Vulnerabilities < Base
+      delegate :related_vulnerabilities, to: :work_item
+    end
+  end
+end

ee/app/services/work_items/data_sync/widgets/vulnerabilities.rb

+# frozen_string_literal: true
+
+module WorkItems
+  module DataSync
+    module Widgets
+      class Vulnerabilities < Base
+        def after_save_commit
+          # copy Vulnerabilities
+        end
+
+        def post_move_cleanup
+          # do it
+        end
+      end
+    end
+  end
+end

ee/spec/graphql/types/work_items/widget_interface_spec.rb

@@ -14,6 +14,7 @@
     WorkItems::Widgets::Color              | Types::WorkItems::Widgets::ColorType
     WorkItems::Widgets::RequirementLegacy  | Types::WorkItems::Widgets::RequirementLegacyType
     WorkItems::Widgets::TestReports        | Types::WorkItems::Widgets::TestReportsType
+    WorkItems::Widgets::Vulnerabilities    | Types::WorkItems::Widgets::VulnerabilitiesType
   end
 
   with_them do

ee/spec/graphql/types/work_items/widgets/vulnerabilities_type_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Types::WorkItems::Widgets::VulnerabilitiesType, feature_category: :vulnerability_management do
+  let(:fields) do
+    %i[type related_vulnerabilities]
+  end
+
+  specify { expect(described_class.graphql_name).to eq('WorkItemWidgetVulnerabilities') }
+
+  specify { expect(described_class).to have_graphql_fields(fields) }
+end

ee/spec/models/ee/work_items/widget_definition_spec.rb

@@ -35,7 +35,8 @@
         ::WorkItems::Widgets::EmailParticipants,
         ::WorkItems::Widgets::CustomStatus,
         ::WorkItems::Widgets::CustomFields,
-        ::WorkItems::Widgets::ErrorTracking
+        ::WorkItems::Widgets::ErrorTracking,
+        ::WorkItems::Widgets::Vulnerabilities
       )
     end
 

ee/spec/models/work_items/widgets/vulnerabilities_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe WorkItems::Widgets::Vulnerabilities, feature_category: :vulnerability_management do
+  let_it_be(:work_item) { create(:work_item, :issue) }
+
+  describe '#related_vulnerabilities' do
+    subject { described_class.new(work_item).related_vulnerabilities }
+
+    it { is_expected.to eq(work_item.related_vulnerabilities) }
+  end
+end

lib/gitlab/database_importers/work_items/base_type_importer.rb

@@ -32,7 +32,8 @@ module BaseTypeImporter
           email_participants: 'Email participants',
           custom_status: 'Custom status',
           custom_fields: 'Custom fields',
-          error_tracking: 'Error tracking'
+          error_tracking: 'Error tracking',
+          vulnerabilities: 'Vulnerabilities'
         }.freeze
 
         WIDGETS_FOR_TYPE = {
@@ -58,6 +59,7 @@ module BaseTypeImporter
             :participants,
             :start_and_due_date,
             :time_tracking,
+            :vulnerabilities,
             [:weight, { editable: true, rollup: false }]
           ],
           incident: [

spec/migrations/20250305122633_add_vulnerabilities_widget_to_work_item_types_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+require_migration!
+
+RSpec.describe AddVulnerabilitiesWidgetToWorkItemTypes, :migration, feature_category: :vulnerability_management do
+  it_behaves_like 'migration that adds widgets to a work item type'
+end

spec/models/work_items/widget_definition_spec.rb

@@ -36,7 +36,8 @@
         ::WorkItems::Widgets::RequirementLegacy,
         ::WorkItems::Widgets::TestReports,
         ::WorkItems::Widgets::Color,
-        ::WorkItems::Widgets::CustomFields
+        ::WorkItems::Widgets::CustomFields,
+        ::WorkItems::Widgets::Vulnerabilities
       ]
     end