Commit deab0569 authored by Miguel Rincon's avatar Miguel Rincon

Implement mini graph pipeline to use gl-dropdown

In the original implementation of the stages in mini pipelines the
dropdown to show jobs in a stage use jQuery to handle event.

This change aims to replace this implementation with the component
gl-dropdown from gitlab-ui.
parent 2b5f958e
...@@ -11,11 +11,11 @@ ...@@ -11,11 +11,11 @@
* 3. Merge request widget * 3. Merge request widget
* 4. Commit widget * 4. Commit widget
*/ */
import $ from 'jquery'; import $ from 'jquery';
import { GlLoadingIcon, GlTooltipDirective, GlIcon } from '@gitlab/ui'; import { GlDropdown, GlLoadingIcon, GlTooltipDirective, GlIcon } from '@gitlab/ui';
import { __ } from '~/locale'; import { __ } from '~/locale';
import { deprecatedCreateFlash as Flash } from '~/flash'; import { deprecatedCreateFlash as Flash } from '~/flash';
import glFeatureFlagsMixin from '~/vue_shared/mixins/gl_feature_flags_mixin';
import axios from '~/lib/utils/axios_utils'; import axios from '~/lib/utils/axios_utils';
import eventHub from '../../event_hub'; import eventHub from '../../event_hub';
import JobItem from '../graph/job_item.vue'; import JobItem from '../graph/job_item.vue';
...@@ -24,14 +24,14 @@ import { PIPELINES_TABLE } from '../../constants'; ...@@ -24,14 +24,14 @@ import { PIPELINES_TABLE } from '../../constants';
export default { export default {
components: { components: {
GlIcon, GlIcon,
JobItem,
GlLoadingIcon, GlLoadingIcon,
GlDropdown,
JobItem,
}, },
directives: { directives: {
GlTooltip: GlTooltipDirective, GlTooltip: GlTooltipDirective,
}, },
mixins: [glFeatureFlagsMixin()],
props: { props: {
stage: { stage: {
type: Object, type: Object,
...@@ -50,30 +50,25 @@ export default { ...@@ -50,30 +50,25 @@ export default {
default: '', default: '',
}, },
}, },
data() { data() {
return { return {
isLoading: false, isLoading: false,
dropdownContent: '', dropdownContent: '',
}; };
}, },
computed: { computed: {
dropdownClass() { isCiMiniPipelineGlDropdown() {
return this.dropdownContent.length > 0 // Feature flag ci_mini_pipeline_gl_dropdown
? 'js-builds-dropdown-container' // See more at https://gitlab.com/gitlab-org/gitlab/-/issues/300400
: 'js-builds-dropdown-loading'; return this.glFeatures?.ciMiniPipelineGlDropdown;
}, },
triggerButtonClass() { triggerButtonClass() {
return `ci-status-icon-${this.stage.status.group}`; return `ci-status-icon-${this.stage.status.group}`;
}, },
borderlessIcon() { borderlessIcon() {
return `${this.stage.status.icon}_borderless`; return `${this.stage.status.icon}_borderless`;
}, },
}, },
watch: { watch: {
updateDropdown() { updateDropdown() {
if (this.updateDropdown && this.isDropdownOpen() && !this.isLoading) { if (this.updateDropdown && this.isDropdownOpen() && !this.isLoading) {
...@@ -81,14 +76,17 @@ export default { ...@@ -81,14 +76,17 @@ export default {
} }
}, },
}, },
updated() { updated() {
if (this.dropdownContent.length > 0) { if (!this.isCiMiniPipelineGlDropdown && this.dropdownContent.length > 0) {
this.stopDropdownClickPropagation(); this.stopDropdownClickPropagation();
} }
}, },
methods: { methods: {
onShowDropdown() {
eventHub.$emit('clickedDropdown');
this.isLoading = true;
this.fetchJobs();
},
onClickStage() { onClickStage() {
if (!this.isDropdownOpen()) { if (!this.isDropdownOpen()) {
eventHub.$emit('clickedDropdown'); eventHub.$emit('clickedDropdown');
...@@ -96,7 +94,6 @@ export default { ...@@ -96,7 +94,6 @@ export default {
this.fetchJobs(); this.fetchJobs();
} }
}, },
fetchJobs() { fetchJobs() {
axios axios
.get(this.stage.dropdown_path) .get(this.stage.dropdown_path)
...@@ -105,13 +102,16 @@ export default { ...@@ -105,13 +102,16 @@ export default {
this.isLoading = false; this.isLoading = false;
}) })
.catch(() => { .catch(() => {
this.closeDropdown(); if (this.isCiMiniPipelineGlDropdown) {
this.$refs.stageGlDropdown.hide();
} else {
this.closeDropdown();
}
this.isLoading = false; this.isLoading = false;
Flash(__('Something went wrong on our end.')); Flash(__('Something went wrong on our end.'));
}); });
}, },
/** /**
* When the user right clicks or cmd/ctrl + click in the job name * When the user right clicks or cmd/ctrl + click in the job name
* the dropdown should not be closed and the link should open in another tab, * the dropdown should not be closed and the link should open in another tab,
...@@ -119,6 +119,8 @@ export default { ...@@ -119,6 +119,8 @@ export default {
* *
* Since this component is rendered multiple times per page we need to guarantee we only * Since this component is rendered multiple times per page we need to guarantee we only
* target the click event of this component. * target the click event of this component.
*
* Note: This should be removed once ci_mini_pipeline_gl_dropdown FF is removed as true.
*/ */
stopDropdownClickPropagation() { stopDropdownClickPropagation() {
$( $(
...@@ -128,23 +130,24 @@ export default { ...@@ -128,23 +130,24 @@ export default {
e.stopPropagation(); e.stopPropagation();
}); });
}, },
closeDropdown() { closeDropdown() {
if (this.isDropdownOpen()) { if (this.isDropdownOpen()) {
$(this.$refs.dropdown).dropdown('toggle'); $(this.$refs.dropdown).dropdown('toggle');
} }
}, },
isDropdownOpen() { isDropdownOpen() {
return this.$el.classList.contains('show'); return this.$el.classList.contains('show');
}, },
pipelineActionRequestComplete() { pipelineActionRequestComplete() {
if (this.type === PIPELINES_TABLE) { if (this.type === PIPELINES_TABLE) {
// warn the table to update // warn the table to update
eventHub.$emit('refreshPipelinesTable'); eventHub.$emit('refreshPipelinesTable');
return;
}
// close the dropdown in mr widget
if (this.isCiMiniPipelineGlDropdown) {
this.$refs.stageGlDropdown.hide();
} else { } else {
// close the dropdown in mr widget
$(this.$refs.dropdown).dropdown('toggle'); $(this.$refs.dropdown).dropdown('toggle');
} }
}, },
...@@ -154,32 +157,33 @@ export default { ...@@ -154,32 +157,33 @@ export default {
<template> <template>
<div class="dropdown"> <div class="dropdown">
<button <gl-dropdown
id="stageDropdown" v-if="isCiMiniPipelineGlDropdown"
ref="dropdown" ref="stageGlDropdown"
v-gl-tooltip.hover v-gl-tooltip.hover
:class="triggerButtonClass"
:title="stage.title" :title="stage.title"
class="mini-pipeline-graph-dropdown-toggle" variant="link"
data-testid="mini-pipeline-graph-dropdown-toggle" :lazy="true"
data-toggle="dropdown" :popper-opts="{ placement: 'bottom' }"
data-display="static" :toggle-class="[
type="button" 'mini-pipeline-graph-gl-dropdown-toggle',
aria-haspopup="true" 'js-builds-dropdown-button',
aria-expanded="false" triggerButtonClass,
@click="onClickStage" ]"
> menu-class="mini-pipeline-graph-dropdown-menu"
<span :aria-label="stage.title" aria-hidden="true" class="gl-pointer-events-none"> @show="onShowDropdown"
<gl-icon :name="borderlessIcon" />
</span>
</button>
<div
class="dropdown-menu mini-pipeline-graph-dropdown-menu js-builds-dropdown-container"
aria-labelledby="stageDropdown"
> >
<template #button-content>
<span class="gl-pointer-events-none">
<gl-icon :name="borderlessIcon" />
</span>
</template>
<gl-loading-icon v-if="isLoading" /> <gl-loading-icon v-if="isLoading" />
<ul v-else class="js-builds-dropdown-list scrollable-menu"> <ul
v-else
class="js-builds-dropdown-list scrollable-menu"
data-testid="mini-pipeline-graph-dropdown-menu-list"
>
<li v-for="job in dropdownContent" :key="job.id"> <li v-for="job in dropdownContent" :key="job.id">
<job-item <job-item
:dropdown-length="dropdownContent.length" :dropdown-length="dropdownContent.length"
...@@ -189,6 +193,45 @@ export default { ...@@ -189,6 +193,45 @@ export default {
/> />
</li> </li>
</ul> </ul>
</div> </gl-dropdown>
<template v-else>
<button
id="stageDropdown"
ref="dropdown"
v-gl-tooltip.hover
:class="triggerButtonClass"
:title="stage.title"
class="mini-pipeline-graph-dropdown-toggle"
data-testid="mini-pipeline-graph-dropdown-toggle"
data-toggle="dropdown"
data-display="static"
type="button"
aria-haspopup="true"
aria-expanded="false"
@click="onClickStage"
>
<span :aria-label="stage.title" aria-hidden="true" class="gl-pointer-events-none">
<gl-icon :name="borderlessIcon" />
</span>
</button>
<div
class="dropdown-menu mini-pipeline-graph-dropdown-menu js-builds-dropdown-container"
aria-labelledby="stageDropdown"
>
<gl-loading-icon v-if="isLoading" />
<ul v-else class="js-builds-dropdown-list scrollable-menu">
<li v-for="job in dropdownContent" :key="job.id">
<job-item
:dropdown-length="dropdownContent.length"
:job="job"
css-class-job-name="mini-pipeline-graph-dropdown-item"
@pipelineActionRequestComplete="pipelineActionRequestComplete"
/>
</li>
</ul>
</div>
</template>
</div> </div>
</template> </template>
...@@ -67,7 +67,8 @@ ...@@ -67,7 +67,8 @@
// Mini Pipelines // Mini Pipelines
.stage-cell { .stage-cell {
.mini-pipeline-graph-dropdown-toggle { .mini-pipeline-graph-dropdown-toggle,
.mini-pipeline-graph-gl-dropdown-toggle {
svg { svg {
height: $ci-action-icon-size; height: $ci-action-icon-size;
width: $ci-action-icon-size; width: $ci-action-icon-size;
...@@ -138,7 +139,13 @@ ...@@ -138,7 +139,13 @@
} }
// Dropdown button in mini pipeline graph // Dropdown button in mini pipeline graph
button.mini-pipeline-graph-dropdown-toggle { button.mini-pipeline-graph-dropdown-toggle,
// As the `mini-pipeline-item` mixin specificity is lower
// than the toggle of dropdown with 'variant="link"' we add
// classes ".gl-button.btn-link" to make it more specific.
// Once FF ci_mini_pipeline_gl_dropdown is removed, the `mini-pipeline-item`
// itself could increase its specificity to simplify this selector
button.gl-button.btn-link.mini-pipeline-graph-gl-dropdown-toggle {
@include mini-pipeline-item(); @include mini-pipeline-item();
} }
......
...@@ -18,6 +18,9 @@ class Projects::CommitController < Projects::ApplicationController ...@@ -18,6 +18,9 @@ class Projects::CommitController < Projects::ApplicationController
before_action :define_commit_vars, only: [:show, :diff_for_path, :diff_files, :pipelines, :merge_requests] before_action :define_commit_vars, only: [:show, :diff_for_path, :diff_files, :pipelines, :merge_requests]
before_action :define_note_vars, only: [:show, :diff_for_path, :diff_files] before_action :define_note_vars, only: [:show, :diff_for_path, :diff_files]
before_action :authorize_edit_tree!, only: [:revert, :cherry_pick] before_action :authorize_edit_tree!, only: [:revert, :cherry_pick]
before_action only: [:pipelines] do
push_frontend_feature_flag(:ci_mini_pipeline_gl_dropdown, @project, type: :development, default_enabled: :yaml)
end
BRANCH_SEARCH_LIMIT = 1000 BRANCH_SEARCH_LIMIT = 1000
......
...@@ -45,6 +45,7 @@ class Projects::MergeRequestsController < Projects::MergeRequests::ApplicationCo ...@@ -45,6 +45,7 @@ class Projects::MergeRequestsController < Projects::MergeRequests::ApplicationCo
push_frontend_feature_flag(:suggestions_custom_commit, @project) push_frontend_feature_flag(:suggestions_custom_commit, @project)
push_frontend_feature_flag(:local_file_reviews, default_enabled: :yaml) push_frontend_feature_flag(:local_file_reviews, default_enabled: :yaml)
push_frontend_feature_flag(:paginated_notes, @project, default_enabled: :yaml) push_frontend_feature_flag(:paginated_notes, @project, default_enabled: :yaml)
push_frontend_feature_flag(:ci_mini_pipeline_gl_dropdown, @project, type: :development, default_enabled: :yaml)
record_experiment_user(:invite_members_version_a) record_experiment_user(:invite_members_version_a)
record_experiment_user(:invite_members_version_b) record_experiment_user(:invite_members_version_b)
......
...@@ -16,6 +16,7 @@ class Projects::PipelinesController < Projects::ApplicationController ...@@ -16,6 +16,7 @@ class Projects::PipelinesController < Projects::ApplicationController
push_frontend_feature_flag(:new_pipeline_form, project, default_enabled: true) push_frontend_feature_flag(:new_pipeline_form, project, default_enabled: true)
push_frontend_feature_flag(:graphql_pipeline_details, project, type: :development, default_enabled: :yaml) push_frontend_feature_flag(:graphql_pipeline_details, project, type: :development, default_enabled: :yaml)
push_frontend_feature_flag(:graphql_pipeline_details_users, current_user, type: :development, default_enabled: :yaml) push_frontend_feature_flag(:graphql_pipeline_details_users, current_user, type: :development, default_enabled: :yaml)
push_frontend_feature_flag(:ci_mini_pipeline_gl_dropdown, project, type: :development, default_enabled: :yaml)
end end
before_action :ensure_pipeline, only: [:show] before_action :ensure_pipeline, only: [:show]
before_action :push_experiment_to_gon, only: :index, if: :html_request? before_action :push_experiment_to_gon, only: :index, if: :html_request?
......
---
name: ci_mini_pipeline_gl_dropdown
introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/52821
rollout_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/300400
milestone: '13.9'
type: development
group: group::continuous integration
default_enabled: false
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment