7.8 KiB
| status | creation-date | authors | coach | approvers | owning-stage | participating-stages | ||
|---|---|---|---|---|---|---|---|---|
| accepted | 2022-09-28 |
|
@ayufan |
|
~devops::plan |
Work Items
This document is a work-in-progress. Some aspects are not documented, though we expect to add them in the future.
Summary
Work Items is a new architecture created to support the various types of built and planned entities throughout the product, such as issues, requirements, and incidents. It will make these types easy to extend and customize while sharing the same core functionality.
Terminology
We use the following terms to describe components and properties of the Work items architecture.
Work Item
Base type for issue, requirement, test case, incident and task (this list is planned to extend in the future). Different work items have the same set of base properties but their widgets list is different.
Work Item types
A set of predefined types for different categories of work items. Currently, the available types are:
- Issue
- Incident
- Test case
- Requirement
- Task
Work Item properties
Every Work Item type has the following common properties:
id- a unique Work Item global identifier;iid- internal ID of the Work Item, relative to the parent workspace (currently workspace can only be a project)- Work Item type;
- properties related to Work Item modification time:
createdAt,updatedAt,closedAt; - title string;
- Work Item confidentiality state;
- Work Item state (can be open or closed);
- lock version, incremented each time the work item is updated;
- permissions for the current user on the resource
- a list of Work Item widgets
Work Item widgets
All Work Item types share the same pool of predefined widgets and are customized by which widgets are active on a specific type. The list of widgets for any certain Work Item type is currently predefined and is not customizable. However, in the future we plan to allow users to create new Work Item types and define a set of widgets for them.
Work Item widget types (updating)
| widget type | feature flag | |
|---|---|---|
| assignees | ||
| description | ||
| hierarchy | ||
| iteration | ||
| milestone | ||
| labels | ||
| start and due date | ||
| status* | ||
| weight | ||
| notes | work_items_mvc |
* status is not currently a widget, but a part of the root work item, similar to title
Work item relationships
Work items can be related to other work items in a number of different ways:
- Parent: A direct ancestor to the current work item, whose completion relies on completing this work item.
- Child: A direct descendant of the current work item, which contributes to this work item's completion.
- Blocked by: A work item preventing the completion of the current work item.
- Blocks: A work item whose completion is blocked by the current work item.
- Related: A work item that is relevant to the subject of the current work item, but does not directly contribute to or block the completion of this work item.
Hierarchy
Parent-child relationships form the basis of hierarchy in work items. Each work item type has a defined set of types that can be parents or children of that type.
As types expand, and parent items have their own parent items, the hierarchy capability can grow exponentially.
Pajamas documents how to display hierarchies depending on context.
Work Item view
The new frontend view that renders Work Items of any type using global Work Item id as an identifier.
Task
Task is a special Work Item type. Tasks can be added to issues as child items and can be displayed in the modal on the issue view.
Feature flags
Since this is a large project with numerous moving parts, feature flags are being used to track promotions of available widgets. The table below shows the different feature flags that are being used, and the audience that they are available to.
| feature flag name | audience |
|---|---|
work_items |
defaulted to on |
work_items_mvc |
gitlab-org, gitlab-com |
work_items_mvc_2 |
gitlab-org/plan-stage |
Motivation
Work Items main goal is to enhance the planning toolset to become the most popular collaboration tool for knowledge workers in any industry.
- Puts all like-items (issues, incidents, epics, test cases etc.) on a standard platform to simplify maintenance and increase consistency in experience
- Enables first-class support of common planning concepts to lower complexity and allow users to plan without learning GitLab-specific nuances.
Goals
Scalability
Currently, different entities like issues, epics, merge requests etc share many similar features but these features are implemented separately for every entity type. This makes implementing new features or refactoring existing ones problematic: for example, if we plan to add new feature to issues and incidents, we would need to implement it separately on issue and incident types respectively. With work items, any new feature is implemented via widgets for all existing types which makes the architecture more scalable.
Flexibility
With existing implementation, we have a rigid structure for issuables, merge requests, epics etc. This structure is defined on both backend and frontend, so any change requires a coordinated effort. Also, it would be very hard to make this structure customizable for the user without introducing a set of flags to enable/disable any existing feature. Work Item architecture allows frontend to display Work Item widgets in a flexible way: whatever is present in Work Item widgets, will be rendered on the page. This allows us to make changes fast and makes the structure way more flexible. For example, if we want to stop displaying labels on the Incident page, we remove labels widget from Incident Work Item type on the backend. Also, in the future this will allow users to define the set of widgets they want to see on custom Work Item types.
A consistent experience
As much as we try to have consistent behavior for similar features on different entities, we still have differences in the implementation. For example, updating labels on merge request via GraphQL API can be done with dedicated setMergeRequestLabels mutation, while for the issue we call more coarse-grained updateIssue. This provides inconsistent experience for both frontend and external API users. As a result, epics, issues, requirements, and others all have similar but just subtle enough differences in common interactions that the user needs to hold a complicated mental model of how they each behave.
Work Item architecture is designed with making all the features for all the types consistent, implemented as Work Item widgets.
High-level architecture problems to solve
- how can we bypass groups and projects consolidation to migrate epics to Work Item type;
- dealing with parent-child relationships for certain Work Item types: epic > issue > task, and to the same Work Item types: issue > issue.
- implementing custom Work Item types and custom widgets