2021-06-02 09:09:46 +00:00
|
|
|
import { unescape } from 'lodash';
|
|
|
|
import { sanitize } from '~/lib/dompurify';
|
|
|
|
import { roundToNearestHalf, convertObjectPropsToCamelCase } from '~/lib/utils/common_utils';
|
|
|
|
import { parseSeconds } from '~/lib/utils/datetime_utility';
|
2021-06-11 15:09:58 +00:00
|
|
|
import { s__, sprintf } from '../locale';
|
2021-04-21 09:09:15 +00:00
|
|
|
import DEFAULT_EVENT_OBJECTS from './default_event_objects';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* These `decorate` methods will be removed when me migrate to the
|
|
|
|
* new table layout https://gitlab.com/gitlab-org/gitlab/-/issues/326704
|
|
|
|
*/
|
|
|
|
const mapToEvent = (event, stage) => {
|
|
|
|
return convertObjectPropsToCamelCase(
|
|
|
|
{
|
|
|
|
...DEFAULT_EVENT_OBJECTS[stage.slug],
|
|
|
|
...event,
|
|
|
|
},
|
|
|
|
{ deep: true },
|
|
|
|
);
|
|
|
|
};
|
|
|
|
|
|
|
|
export const decorateEvents = (events, stage) => events.map((event) => mapToEvent(event, stage));
|
|
|
|
|
|
|
|
const mapToSummary = ({ value, ...rest }) => ({ ...rest, value: value || '-' });
|
2021-06-11 15:09:58 +00:00
|
|
|
const mapToMedians = ({ name: id, value }) => ({ id, value });
|
2021-04-21 09:09:15 +00:00
|
|
|
|
|
|
|
export const decorateData = (data = {}) => {
|
2021-06-11 15:09:58 +00:00
|
|
|
const { stats: stages, summary } = data;
|
2021-04-21 09:09:15 +00:00
|
|
|
return {
|
|
|
|
summary: summary?.map((item) => mapToSummary(item)) || [],
|
2021-06-02 09:09:46 +00:00
|
|
|
medians: stages?.map((item) => mapToMedians(item)) || [],
|
2021-04-21 09:09:15 +00:00
|
|
|
};
|
|
|
|
};
|
2021-06-02 09:09:46 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Takes the stages and median data, combined with the selected stage, to build an
|
|
|
|
* array which is formatted to proivde the data required for the path navigation.
|
|
|
|
*
|
|
|
|
* @param {Array} stages - The stages available to the group / project
|
|
|
|
* @param {Object} medians - The median values for the stages available to the group / project
|
|
|
|
* @param {Object} stageCounts - The total item count for the stages available
|
|
|
|
* @param {Object} selectedStage - The currently selected stage
|
|
|
|
* @returns {Array} An array of stages formatted with data required for the path navigation
|
|
|
|
*/
|
|
|
|
export const transformStagesForPathNavigation = ({
|
|
|
|
stages,
|
|
|
|
medians,
|
|
|
|
stageCounts = {},
|
|
|
|
selectedStage,
|
|
|
|
}) => {
|
|
|
|
const formattedStages = stages.map((stage) => {
|
|
|
|
return {
|
|
|
|
metric: medians[stage?.id],
|
|
|
|
selected: stage?.id === selectedStage?.id, // Also could null === null cause an issue here?
|
|
|
|
stageCount: stageCounts && stageCounts[stage?.id],
|
|
|
|
icon: null,
|
|
|
|
...stage,
|
|
|
|
};
|
|
|
|
});
|
|
|
|
|
|
|
|
return formattedStages;
|
|
|
|
};
|
|
|
|
|
|
|
|
export const timeSummaryForPathNavigation = ({ seconds, hours, days, minutes, weeks, months }) => {
|
|
|
|
if (months) {
|
|
|
|
return sprintf(s__('ValueStreamAnalytics|%{value}M'), {
|
|
|
|
value: roundToNearestHalf(months),
|
|
|
|
});
|
|
|
|
} else if (weeks) {
|
|
|
|
return sprintf(s__('ValueStreamAnalytics|%{value}w'), {
|
|
|
|
value: roundToNearestHalf(weeks),
|
|
|
|
});
|
|
|
|
} else if (days) {
|
|
|
|
return sprintf(s__('ValueStreamAnalytics|%{value}d'), {
|
|
|
|
value: roundToNearestHalf(days),
|
|
|
|
});
|
|
|
|
} else if (hours) {
|
|
|
|
return sprintf(s__('ValueStreamAnalytics|%{value}h'), { value: hours });
|
|
|
|
} else if (minutes) {
|
|
|
|
return sprintf(s__('ValueStreamAnalytics|%{value}m'), { value: minutes });
|
|
|
|
} else if (seconds) {
|
|
|
|
return unescape(sanitize(s__('ValueStreamAnalytics|<1m'), { ALLOWED_TAGS: [] }));
|
|
|
|
}
|
|
|
|
return '-';
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Takes a raw median value in seconds and converts it to a string representation
|
|
|
|
* ie. converts 172800 => 2d (2 days)
|
|
|
|
*
|
|
|
|
* @param {Number} Median - The number of seconds for the median calculation
|
|
|
|
* @returns {String} String representation ie 2w
|
|
|
|
*/
|
|
|
|
export const medianTimeToParsedSeconds = (value) =>
|
|
|
|
timeSummaryForPathNavigation({
|
|
|
|
...parseSeconds(value, { daysPerWeek: 7, hoursPerDay: 24 }),
|
|
|
|
seconds: value,
|
|
|
|
});
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Takes the raw median value arrays and converts them into a useful object
|
|
|
|
* containing the string for display in the path navigation
|
|
|
|
* ie. converts [{ id: 'test', value: 172800 }] => { 'test': '2d' }
|
|
|
|
*
|
|
|
|
* @param {Array} Medians - Array of stage median objects, each contains a `id`, `value` and `error`
|
|
|
|
* @returns {Object} Returns key value pair with the stage name and its display median value
|
|
|
|
*/
|
|
|
|
export const formatMedianValues = (medians = []) =>
|
|
|
|
medians.reduce((acc, { id, value = 0 }) => {
|
|
|
|
return {
|
|
|
|
...acc,
|
|
|
|
[id]: value ? medianTimeToParsedSeconds(value) : '-',
|
|
|
|
};
|
|
|
|
}, {});
|
|
|
|
|
|
|
|
export const filterStagesByHiddenStatus = (stages = [], isHidden = true) =>
|
|
|
|
stages.filter(({ hidden = false }) => hidden === isHidden);
|