summaryrefslogtreecommitdiff
path: root/app/assets/javascripts/api/analytics_api.js
blob: c7a53288ae479308f95eb59c09257c2a93163f07 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
import axios from '~/lib/utils/axios_utils';
import { joinPaths } from '~/lib/utils/url_utility';
import { buildApiUrl } from './api_utils';

const PROJECT_VSA_METRICS_BASE = '/:request_path/-/analytics/value_stream_analytics';
const PROJECT_VSA_PATH_BASE = '/:request_path/-/analytics/value_stream_analytics/value_streams';
const PROJECT_VSA_STAGES_PATH = `${PROJECT_VSA_PATH_BASE}/:value_stream_id/stages`;
const PROJECT_VSA_STAGE_DATA_PATH = `${PROJECT_VSA_STAGES_PATH}/:stage_id`;

export const METRIC_TYPE_SUMMARY = 'summary';
export const METRIC_TYPE_TIME_SUMMARY = 'time_summary';

const buildProjectMetricsPath = (requestPath) =>
  buildApiUrl(PROJECT_VSA_METRICS_BASE).replace(':request_path', requestPath);

const buildProjectValueStreamPath = (requestPath, valueStreamId = null) => {
  if (valueStreamId) {
    return buildApiUrl(PROJECT_VSA_STAGES_PATH)
      .replace(':request_path', requestPath)
      .replace(':value_stream_id', valueStreamId);
  }
  return buildApiUrl(PROJECT_VSA_PATH_BASE).replace(':request_path', requestPath);
};

const buildValueStreamStageDataPath = ({ requestPath, valueStreamId = null, stageId = null }) =>
  buildApiUrl(PROJECT_VSA_STAGE_DATA_PATH)
    .replace(':request_path', requestPath)
    .replace(':value_stream_id', valueStreamId)
    .replace(':stage_id', stageId);

export const getProjectValueStreams = (requestPath) => {
  const url = buildProjectValueStreamPath(requestPath);
  return axios.get(url);
};

export const getProjectValueStreamStages = (requestPath, valueStreamId) => {
  const url = buildProjectValueStreamPath(requestPath, valueStreamId);
  return axios.get(url);
};

// NOTE: legacy VSA request use a different path
// the `requestPath` provides a full url for the request
export const getProjectValueStreamStageData = ({ requestPath, stageId, params }) =>
  axios.get(joinPaths(requestPath, 'events', stageId), { params });

export const getProjectValueStreamMetrics = (requestPath, params) =>
  axios.get(requestPath, { params });

/**
 * Dedicated project VSA paths
 */

export const getValueStreamStageMedian = ({ requestPath, valueStreamId, stageId }, params = {}) => {
  const stageBase = buildValueStreamStageDataPath({ requestPath, valueStreamId, stageId });
  return axios.get(joinPaths(stageBase, 'median'), { params });
};

export const getValueStreamStageRecords = (
  { requestPath, valueStreamId, stageId },
  params = {},
) => {
  const stageBase = buildValueStreamStageDataPath({ requestPath, valueStreamId, stageId });
  return axios.get(joinPaths(stageBase, 'records'), { params });
};

export const getValueStreamStageCounts = ({ requestPath, valueStreamId, stageId }, params = {}) => {
  const stageBase = buildValueStreamStageDataPath({ requestPath, valueStreamId, stageId });
  return axios.get(joinPaths(stageBase, 'count'), { params });
};

export const getValueStreamMetrics = ({
  endpoint = METRIC_TYPE_SUMMARY,
  requestPath,
  params = {},
}) => {
  const metricBase = buildProjectMetricsPath(requestPath);
  return axios.get(joinPaths(metricBase, endpoint), { params });
};

export const getValueStreamSummaryMetrics = (requestPath, params = {}) => {
  const metricBase = buildProjectMetricsPath(requestPath);
  return axios.get(joinPaths(metricBase, 'summary'), { params });
};