Merge branch 'cngo-update-work-items-naming' into 'master'

Update work item variable names

See merge request !141773



Merged-by: Paulina Sedlak-Jakubowska <psedlak-jakubowska@gitlab.com>
Approved-by: Paulina Sedlak-Jakubowska <psedlak-jakubowska@gitlab.com>
Approved-by: Bojan Marjanovic <bmarjanovic@gitlab.com>
Approved-by: Ross Byrne <robyrne@gitlab.com>
Approved-by: Alex Buijs <abuijs@gitlab.com>
Co-authored-by: Coung Ngo <cngo@gitlab.com>

app/assets/javascripts/issues/show/components/description.vue

@@ -20,7 +20,7 @@ import {
   sprintfWorkItem,
   I18N_WORK_ITEM_ERROR_CREATING,
   I18N_WORK_ITEM_ERROR_DELETING,
-  TASK_TYPE_NAME,
+  WORK_ITEM_TYPE_VALUE_TASK,
 } from '~/work_items/constants';
 import { renderGFM } from '~/behaviors/markdown/render_gfm';
 import eventHub from '../event_hub';
@@ -129,7 +129,7 @@ export default {
   },
   computed: {
     taskWorkItemTypeId() {
-      return this.workItemTypes.find((type) => type.name === TASK_TYPE_NAME)?.id;
+      return this.workItemTypes.find((type) => type.name === WORK_ITEM_TYPE_VALUE_TASK)?.id;
     },
     issueGid() {
       return this.issueId ? convertToGraphQLId(TYPENAME_WORK_ITEM, this.issueId) : null;

app/assets/javascripts/work_items/components/notes/work_item_comment_form.vue

@@ -4,7 +4,11 @@ import { helpPagePath } from '~/helpers/help_page_helper';
 import { s__, __ } from '~/locale';
 import Tracking from '~/tracking';
 import { capitalizeFirstCharacter } from '~/lib/utils/text_utility';
-import { STATE_OPEN, TRACKING_CATEGORY_SHOW, TASK_TYPE_NAME } from '~/work_items/constants';
+import {
+  STATE_OPEN,
+  TRACKING_CATEGORY_SHOW,
+  WORK_ITEM_TYPE_VALUE_TASK,
+} from '~/work_items/constants';
 import { getDraft, clearDraft, updateDraft } from '~/lib/utils/autosave';
 import { confirmAction } from '~/lib/utils/confirm_via_gl_modal/confirm_via_gl_modal';
 import MarkdownEditor from '~/vue_shared/components/markdown/markdown_editor.vue';
@@ -127,10 +131,12 @@ export default {
       return this.isNoteInternal ? this.$options.i18n.addInternalNote : this.commentButtonText;
     },
     workItemDocPath() {
-      return this.workItemType === TASK_TYPE_NAME ? 'user/tasks.html' : 'user/okrs.html';
+      return this.workItemType === WORK_ITEM_TYPE_VALUE_TASK ? 'user/tasks.html' : 'user/okrs.html';
     },
     workItemDocAnchor() {
-      return this.workItemType === TASK_TYPE_NAME ? 'confidential-tasks' : 'confidential-okrs';
+      return this.workItemType === WORK_ITEM_TYPE_VALUE_TASK
+        ? 'confidential-tasks'
+        : 'confidential-okrs';
     },
     getWorkItemData() {
       return {

app/assets/javascripts/work_items/components/notes/work_item_comment_locked.vue

@@ -2,7 +2,7 @@
 import { GlLink, GlIcon } from '@gitlab/ui';
 import { __, sprintf } from '~/locale';
 import { helpPagePath } from '~/helpers/help_page_helper';
-import { TASK_TYPE_NAME } from '~/work_items/constants';
+import { WORK_ITEM_TYPE_VALUE_TASK } from '~/work_items/constants';
 
 export default {
   components: {
@@ -13,7 +13,7 @@ export default {
     workItemType: {
       required: false,
       type: String,
-      default: TASK_TYPE_NAME,
+      default: WORK_ITEM_TYPE_VALUE_TASK,
     },
     isProjectArchived: {
       required: false,

app/assets/javascripts/work_items/components/shared/work_item_link_child_contents.vue

@@ -6,7 +6,6 @@ import RichTimestampTooltip from '~/vue_shared/components/rich_timestamp_tooltip
 import WorkItemLinkChildMetadata from 'ee_else_ce/work_items/components/shared/work_item_link_child_metadata.vue';
 import {
   STATE_OPEN,
-  TASK_TYPE_NAME,
   WIDGET_TYPE_PROGRESS,
   WIDGET_TYPE_HIERARCHY,
   WIDGET_TYPE_HEALTH_STATUS,
@@ -14,6 +13,7 @@ import {
   WIDGET_TYPE_ASSIGNEES,
   WIDGET_TYPE_LABELS,
   WORK_ITEM_NAME_TO_ICON_MAP,
+  WORK_ITEM_TYPE_VALUE_TASK,
 } from '../../constants';
 
 export default {
@@ -79,7 +79,7 @@ export default {
       return this.childItem.state === STATE_OPEN;
     },
     iconName() {
-      if (this.childItemType === TASK_TYPE_NAME && !this.showTaskIcon) {
+      if (this.childItemType === WORK_ITEM_TYPE_VALUE_TASK && !this.showTaskIcon) {
         return this.isChildItemOpen ? 'issue-open-m' : 'issue-close';
       }
       return WORK_ITEM_NAME_TO_ICON_MAP[this.childItemType];
@@ -88,7 +88,7 @@ export default {
       return this.childItem.workItemType.name;
     },
     iconClass() {
-      if (this.childItemType === TASK_TYPE_NAME && !this.showTaskIcon) {
+      if (this.childItemType === WORK_ITEM_TYPE_VALUE_TASK && !this.showTaskIcon) {
         return this.isChildItemOpen ? 'gl-text-green-500' : 'gl-text-blue-500';
       }
       return '';

app/assets/javascripts/work_items/components/work_item_links/work_item_link_child.vue

@@ -8,10 +8,10 @@ import { createAlert } from '~/alert';
 import updateWorkItemMutation from '../../graphql/update_work_item.mutation.graphql';
 import {
   STATE_OPEN,
-  TASK_TYPE_NAME,
-  WORK_ITEM_TYPE_VALUE_OBJECTIVE,
   WIDGET_TYPE_HIERARCHY,
   WORK_ITEM_NAME_TO_ICON_MAP,
+  WORK_ITEM_TYPE_VALUE_OBJECTIVE,
+  WORK_ITEM_TYPE_VALUE_TASK,
 } from '../../constants';
 import getWorkItemTreeQuery from '../../graphql/work_item_tree.query.graphql';
 import WorkItemLinkChildContents from '../shared/work_item_link_child_contents.vue';
@@ -76,13 +76,13 @@ export default {
       return this.childItem.workItemType.name;
     },
     iconName() {
-      if (this.childItemType === TASK_TYPE_NAME) {
+      if (this.childItemType === WORK_ITEM_TYPE_VALUE_TASK) {
         return this.isItemOpen ? 'issue-open-m' : 'issue-close';
       }
       return WORK_ITEM_NAME_TO_ICON_MAP[this.childItemType];
     },
     iconClass() {
-      if (this.childItemType === TASK_TYPE_NAME) {
+      if (this.childItemType === WORK_ITEM_TYPE_VALUE_TASK) {
         return this.isItemOpen ? 'gl-text-green-500' : 'gl-text-blue-500';
       }
       return '';

app/assets/javascripts/work_items/constants.js

@@ -10,8 +10,6 @@ export const STATE_EVENT_CLOSE = 'CLOSE';
 
 export const TRACKING_CATEGORY_SHOW = 'workItems:show';
 
-export const TASK_TYPE_NAME = 'Task';
-
 export const WIDGET_TYPE_ASSIGNEES = 'ASSIGNEES';
 export const WIDGET_TYPE_DESCRIPTION = 'DESCRIPTION';
 export const WIDGET_TYPE_AWARD_EMOJI = 'AWARD_EMOJI';
@@ -46,9 +44,6 @@ export const WORK_ITEM_TYPE_VALUE_REQUIREMENTS = 'Requirements';
 export const WORK_ITEM_TYPE_VALUE_KEY_RESULT = 'Key Result';
 export const WORK_ITEM_TYPE_VALUE_OBJECTIVE = 'Objective';
 
-export const NAMESPACE_GROUP = 'group';
-export const NAMESPACE_PROJECT = 'project';
-
 export const WORK_ITEM_TITLE_MAX_LENGTH = 255;
 
 export const i18n = {

app/helpers/work_items_helper.rb

 # frozen_string_literal: true
 
 module WorkItemsHelper
-  def work_items_index_data(resource_parent)
+  def work_items_show_data(resource_parent)
     {
       full_path: resource_parent.full_path,
       issues_list_path:

app/views/groups/work_items/show.html.haml

@@ -4,4 +4,4 @@
 - @gfm_form = true
 - @noteable_type = 'WorkItem'
 
-#js-work-items{ data: work_items_index_data(@group).merge(iid: request.params['iid']) }
+#js-work-items{ data: work_items_show_data(@group).merge(iid: request.params['iid']) }

app/views/projects/issues/_work_item_links.html.haml

 .js-work-item-links-root{ data: { issuable_id: @issue.id,
   issuable_iid: @issue.iid,
   full_path: @project.full_path,
-  wi: work_items_index_data(@project),
+  wi: work_items_show_data(@project),
   register_path: new_user_registration_path(redirect_to_referer: 'yes'),
   sign_in_path: new_session_path(:user, redirect_to_referer: 'yes') } }

app/views/projects/work_items/show.html.haml

@@ -4,4 +4,4 @@
 - @gfm_form = true
 - @noteable_type = 'WorkItem'
 
-#js-work-items{ data: work_items_index_data(@project) }
+#js-work-items{ data: work_items_show_data(@project) }

ee/app/helpers/ee/work_items_helper.rb

@@ -4,8 +4,8 @@ module EE
   module WorkItemsHelper
     extend ::Gitlab::Utils::Override
 
-    override :work_items_index_data
-    def work_items_index_data(resource_parent)
+    override :work_items_show_data
+    def work_items_show_data(resource_parent)
       super.merge(
         has_issue_weights_feature: resource_parent.licensed_feature_available?(:issue_weights).to_s,
         has_okrs_feature: resource_parent.licensed_feature_available?(:okrs).to_s,

ee/spec/helpers/ee/work_items_helper_spec.rb

@@ -3,8 +3,8 @@
 require "spec_helper"
 
 RSpec.describe EE::WorkItemsHelper, feature_category: :team_planning do
-  describe '#work_items_index_data' do
-    subject(:work_items_index_data) { helper.work_items_index_data(project) }
+  describe '#work_items_show_data' do
+    subject(:work_items_show_data) { helper.work_items_show_data(project) }
 
     before do
       stub_licensed_features(
@@ -21,7 +21,7 @@
       let(:feature_available) { true }
 
       it 'returns true for the features' do
-        expect(work_items_index_data).to include(
+        expect(work_items_show_data).to include(
           {
             has_issuable_health_status_feature: "true",
             has_issue_weights_feature: "true",
@@ -36,7 +36,7 @@
       let(:feature_available) { false }
 
       it 'returns false for the features' do
-        expect(work_items_index_data).to include(
+        expect(work_items_show_data).to include(
           {
             has_issuable_health_status_feature: "false",
             has_issue_weights_feature: "false",

spec/frontend/work_items/components/work_item_assignees_spec.js

@@ -14,9 +14,9 @@ import updateWorkItemMutation from '~/work_items/graphql/update_work_item.mutati
 import WorkItemAssignees from '~/work_items/components/work_item_assignees.vue';
 import {
   i18n,
-  TASK_TYPE_NAME,
-  TRACKING_CATEGORY_SHOW,
   DEFAULT_PAGE_SIZE_ASSIGNEES,
+  TRACKING_CATEGORY_SHOW,
+  WORK_ITEM_TYPE_VALUE_TASK,
 } from '~/work_items/constants';
 import {
   projectMembersResponseWithCurrentUser,
@@ -97,7 +97,7 @@ describe('WorkItemAssignees component', () => {
         fullPath: 'test-project-path',
         workItemId,
         allowsMultipleAssignees,
-        workItemType: TASK_TYPE_NAME,
+        workItemType: WORK_ITEM_TYPE_VALUE_TASK,
         canUpdate,
         canInviteMembers,
       },

spec/frontend/work_items/components/work_item_links/work_item_link_child_spec.js

@@ -13,8 +13,8 @@ import WorkItemTreeChildren from '~/work_items/components/work_item_links/work_i
 import WorkItemLinkChildContents from '~/work_items/components/shared/work_item_link_child_contents.vue';
 import {
   WIDGET_TYPE_HIERARCHY,
-  TASK_TYPE_NAME,
   WORK_ITEM_TYPE_VALUE_OBJECTIVE,
+  WORK_ITEM_TYPE_VALUE_TASK,
 } from '~/work_items/constants';
 
 import {
@@ -47,7 +47,7 @@ describe('WorkItemLinkChild', () => {
     canUpdate = true,
     issuableGid = WORK_ITEM_ID,
     childItem = workItemTask,
-    workItemType = TASK_TYPE_NAME,
+    workItemType = WORK_ITEM_TYPE_VALUE_TASK,
     apolloProvider = null,
   } = {}) => {
     getWorkItemTreeQueryHandler = jest.fn().mockResolvedValue(workItemHierarchyTreeResponse);

spec/helpers/work_items_helper_spec.rb

@@ -3,13 +3,13 @@
 require "spec_helper"
 
 RSpec.describe WorkItemsHelper, feature_category: :team_planning do
-  describe '#work_items_index_data' do
-    subject(:work_items_index_data) { helper.work_items_index_data(project) }
+  describe '#work_items_show_data' do
+    subject(:work_items_show_data) { helper.work_items_show_data(project) }
 
     let_it_be(:project) { build(:project) }
 
     it 'returns the expected data properties' do
-      expect(work_items_index_data).to include(
+      expect(work_items_show_data).to include(
         {
           full_path: project.full_path,
           issues_list_path: project_issues_path(project),