debian-mirror-gitlab/app/assets/javascripts/pipelines/components/dag/dag.vue

240 lines
6.4 KiB
Vue
Raw Normal View History

2020-06-23 00:09:42 +05:30
<script>
2020-07-28 23:09:34 +05:30
import { GlAlert, GlButton, GlEmptyState, GlLink, GlSprintf } from '@gitlab/ui';
import { isEmpty } from 'lodash';
2020-06-23 00:09:42 +05:30
import axios from '~/lib/utils/axios_utils';
import { __ } from '~/locale';
import DagGraph from './dag_graph.vue';
2020-07-28 23:09:34 +05:30
import DagAnnotations from './dag_annotations.vue';
import {
DEFAULT,
PARSE_FAILURE,
LOAD_FAILURE,
UNSUPPORTED_DATA,
ADD_NOTE,
REMOVE_NOTE,
REPLACE_NOTES,
} from './constants';
2020-06-23 00:09:42 +05:30
import { parseData } from './parsing_utils';
export default {
// eslint-disable-next-line @gitlab/require-i18n-strings
name: 'Dag',
components: {
2020-07-28 23:09:34 +05:30
DagAnnotations,
2020-06-23 00:09:42 +05:30
DagGraph,
GlAlert,
GlLink,
GlSprintf,
2020-07-28 23:09:34 +05:30
GlEmptyState,
GlButton,
2020-06-23 00:09:42 +05:30
},
props: {
graphUrl: {
type: String,
required: false,
default: '',
},
2020-07-28 23:09:34 +05:30
emptySvgPath: {
type: String,
required: true,
default: '',
},
dagDocPath: {
type: String,
required: true,
default: '',
},
2020-06-23 00:09:42 +05:30
},
data() {
return {
2020-07-28 23:09:34 +05:30
annotationsMap: {},
2020-06-23 00:09:42 +05:30
failureType: null,
graphData: null,
2020-07-28 23:09:34 +05:30
showFailureAlert: false,
showBetaInfo: true,
hasNoDependentJobs: false,
2020-06-23 00:09:42 +05:30
};
},
errorTexts: {
[LOAD_FAILURE]: __('We are currently unable to fetch data for this graph.'),
[PARSE_FAILURE]: __('There was an error parsing the data for this graph.'),
2020-07-28 23:09:34 +05:30
[UNSUPPORTED_DATA]: __('DAG visualization requires at least 3 dependent jobs.'),
2020-06-23 00:09:42 +05:30
[DEFAULT]: __('An unknown error occurred while loading this graph.'),
},
2020-07-28 23:09:34 +05:30
emptyStateTexts: {
title: __('Start using Directed Acyclic Graphs (DAG)'),
firstDescription: __(
"This pipeline does not use the %{codeStart}needs%{codeEnd} keyword and can't be represented as a directed acyclic graph.",
),
secondDescription: __(
'Using %{codeStart}needs%{codeEnd} allows jobs to run before their stage is reached, as soon as their individual dependencies are met, which speeds up your pipelines.',
),
button: __('Learn more about job dependencies'),
},
2020-06-23 00:09:42 +05:30
computed: {
betaMessage() {
return __(
'This feature is currently in beta. We invite you to %{linkStart}give feedback%{linkEnd}.',
);
},
failure() {
switch (this.failureType) {
case LOAD_FAILURE:
return {
text: this.$options.errorTexts[LOAD_FAILURE],
variant: 'danger',
};
case PARSE_FAILURE:
return {
text: this.$options.errorTexts[PARSE_FAILURE],
variant: 'danger',
};
case UNSUPPORTED_DATA:
return {
text: this.$options.errorTexts[UNSUPPORTED_DATA],
variant: 'info',
};
default:
return {
text: this.$options.errorTexts[DEFAULT],
vatiant: 'danger',
};
}
},
2020-07-28 23:09:34 +05:30
shouldDisplayAnnotations() {
return !isEmpty(this.annotationsMap);
},
2020-06-23 00:09:42 +05:30
shouldDisplayGraph() {
return Boolean(!this.showFailureAlert && this.graphData);
},
},
mounted() {
const { processGraphData, reportFailure } = this;
if (!this.graphUrl) {
reportFailure();
return;
}
axios
.get(this.graphUrl)
.then(response => {
processGraphData(response.data);
})
.catch(() => reportFailure(LOAD_FAILURE));
},
methods: {
2020-07-28 23:09:34 +05:30
addAnnotationToMap({ uid, source, target }) {
this.$set(this.annotationsMap, uid, { source, target });
},
2020-06-23 00:09:42 +05:30
processGraphData(data) {
let parsed;
try {
parsed = parseData(data.stages);
} catch {
this.reportFailure(PARSE_FAILURE);
return;
}
2020-07-28 23:09:34 +05:30
if (parsed.links.length === 1) {
2020-06-23 00:09:42 +05:30
this.reportFailure(UNSUPPORTED_DATA);
return;
}
2020-07-28 23:09:34 +05:30
// If there are no links, we don't report failure
// as it simply means the user does not use job dependencies
if (parsed.links.length === 0) {
this.hasNoDependentJobs = true;
return;
}
2020-06-23 00:09:42 +05:30
this.graphData = parsed;
},
hideAlert() {
this.showFailureAlert = false;
},
hideBetaInfo() {
this.showBetaInfo = false;
},
2020-07-28 23:09:34 +05:30
removeAnnotationFromMap({ uid }) {
this.$delete(this.annotationsMap, uid);
},
2020-06-23 00:09:42 +05:30
reportFailure(type) {
this.showFailureAlert = true;
this.failureType = type;
},
2020-07-28 23:09:34 +05:30
updateAnnotation({ type, data }) {
switch (type) {
case ADD_NOTE:
this.addAnnotationToMap(data);
break;
case REMOVE_NOTE:
this.removeAnnotationFromMap(data);
break;
case REPLACE_NOTES:
this.annotationsMap = data;
break;
default:
break;
}
},
2020-06-23 00:09:42 +05:30
},
};
</script>
<template>
<div>
<gl-alert v-if="showFailureAlert" :variant="failure.variant" @dismiss="hideAlert">
{{ failure.text }}
</gl-alert>
<gl-alert v-if="showBetaInfo" @dismiss="hideBetaInfo">
<gl-sprintf :message="betaMessage">
<template #link="{ content }">
<gl-link href="https://gitlab.com/gitlab-org/gitlab/-/issues/220368" target="_blank">
{{ content }}
</gl-link>
</template>
</gl-sprintf>
</gl-alert>
2020-07-28 23:09:34 +05:30
<div class="gl-relative">
<dag-annotations v-if="shouldDisplayAnnotations" :annotations="annotationsMap" />
<dag-graph
v-if="shouldDisplayGraph"
:graph-data="graphData"
@onFailure="reportFailure"
@update-annotation="updateAnnotation"
/>
<gl-empty-state
v-else-if="hasNoDependentJobs"
:svg-path="emptySvgPath"
:title="$options.emptyStateTexts.title"
>
<template #description>
<div class="gl-text-left">
<p>
<gl-sprintf :message="$options.emptyStateTexts.firstDescription">
<template #code="{ content }">
<code>{{ content }}</code>
</template>
</gl-sprintf>
</p>
<p>
<gl-sprintf :message="$options.emptyStateTexts.secondDescription">
<template #code="{ content }">
<code>{{ content }}</code>
</template>
</gl-sprintf>
</p>
</div>
</template>
<template #actions>
<gl-button :href="dagDocPath" target="__blank" variant="success">
{{ $options.emptyStateTexts.button }}
</gl-button>
</template>
</gl-empty-state>
</div>
2020-06-23 00:09:42 +05:30
</div>
</template>