Commit c6feb790 authored by Jose Vargas's avatar Jose Vargas Committed by Dhiraj Bodicherla

Ensure shared links use variables

This makes all of the links generated
by the monitoring dashboard use the variables
when the links are used in the embedded metrics
feature

t
parent f5e79f65
...@@ -39,6 +39,7 @@ import { ...@@ -39,6 +39,7 @@ import {
timeRangeFromUrl, timeRangeFromUrl,
panelToUrl, panelToUrl,
expandedPanelPayloadFromUrl, expandedPanelPayloadFromUrl,
convertVariablesForURL,
} from '../utils'; } from '../utils';
import { metricStates } from '../constants'; import { metricStates } from '../constants';
import { defaultTimeRange, timeRanges } from '~/vue_shared/constants'; import { defaultTimeRange, timeRanges } from '~/vue_shared/constants';
...@@ -272,7 +273,7 @@ export default { ...@@ -272,7 +273,7 @@ export default {
handler({ group, panel }) { handler({ group, panel }) {
const dashboardPath = this.currentDashboard || this.selectedDashboard?.path; const dashboardPath = this.currentDashboard || this.selectedDashboard?.path;
updateHistory({ updateHistory({
url: panelToUrl(dashboardPath, group, panel), url: panelToUrl(dashboardPath, convertVariablesForURL(this.promVariables), group, panel),
title: document.title, title: document.title,
}); });
}, },
...@@ -343,7 +344,7 @@ export default { ...@@ -343,7 +344,7 @@ export default {
}, },
generatePanelUrl(groupKey, panel) { generatePanelUrl(groupKey, panel) {
const dashboardPath = this.currentDashboard || this.selectedDashboard?.path; const dashboardPath = this.currentDashboard || this.selectedDashboard?.path;
return panelToUrl(dashboardPath, groupKey, panel); return panelToUrl(dashboardPath, convertVariablesForURL(this.promVariables), groupKey, panel);
}, },
hideAddMetricModal() { hideAddMetricModal() {
this.$refs.addMetricModal.hide(); this.$refs.addMetricModal.hide();
......
...@@ -17,7 +17,7 @@ import { VARIABLE_PREFIX } from './constants'; ...@@ -17,7 +17,7 @@ import { VARIABLE_PREFIX } from './constants';
* This will be removed once we add support for free text variables * This will be removed once we add support for free text variables
* via the dashboard yaml files in https://gitlab.com/gitlab-org/gitlab/-/issues/215689 * via the dashboard yaml files in https://gitlab.com/gitlab-org/gitlab/-/issues/215689
*/ */
export const dashboardParams = ['dashboard', 'group', 'title', 'y_label']; export const dashboardParams = ['dashboard', 'group', 'title', 'y_label', 'embedded'];
/** /**
* This method is used to validate if the graph data format for a chart component * This method is used to validate if the graph data format for a chart component
...@@ -262,14 +262,22 @@ export const expandedPanelPayloadFromUrl = (dashboard, search = window.location. ...@@ -262,14 +262,22 @@ export const expandedPanelPayloadFromUrl = (dashboard, search = window.location.
* If no group/panel is set, the dashboard URL is returned. * If no group/panel is set, the dashboard URL is returned.
* *
* @param {?String} dashboard - Dashboard path, used as identifier for a dashboard * @param {?String} dashboard - Dashboard path, used as identifier for a dashboard
* @param {?Object} promVariables - Custom variables that came from the URL
* @param {?String} group - Group Identifier * @param {?String} group - Group Identifier
* @param {?Object} panel - Panel object from the dashboard * @param {?Object} panel - Panel object from the dashboard
* @param {?String} url - Base URL including current search params * @param {?String} url - Base URL including current search params
* @returns Dashboard URL which expands a panel (chart) * @returns Dashboard URL which expands a panel (chart)
*/ */
export const panelToUrl = (dashboard = null, group, panel, url = window.location.href) => { export const panelToUrl = (
dashboard = null,
promVariables,
group,
panel,
url = window.location.href,
) => {
const params = { const params = {
dashboard, dashboard,
...promVariables,
}; };
if (group && panel) { if (group && panel) {
......
---
title: Ensure links generated by the copy link feature contain variables
merge_request: 31636
author:
type: changed
...@@ -315,24 +315,31 @@ describe('monitoring/utils', () => { ...@@ -315,24 +315,31 @@ describe('monitoring/utils', () => {
const getUrlParams = url => urlUtils.queryToObject(url.split('?')[1]); const getUrlParams = url => urlUtils.queryToObject(url.split('?')[1]);
it('returns URL for a panel when query parameters are given', () => { it('returns URL for a panel when query parameters are given', () => {
const params = getUrlParams(panelToUrl(dashboard, panelGroup.group, panel)); const params = getUrlParams(panelToUrl(dashboard, {}, panelGroup.group, panel));
expect(params).toEqual({ expect(params).toEqual(
expect.objectContaining({
dashboard, dashboard,
group: panelGroup.group, group: panelGroup.group,
title: panel.title, title: panel.title,
y_label: panel.y_label, y_label: panel.y_label,
}); }),
);
}); });
it('returns a dashboard only URL if group is missing', () => { it('returns a dashboard only URL if group is missing', () => {
const params = getUrlParams(panelToUrl(dashboard, null, panel)); const params = getUrlParams(panelToUrl(dashboard, {}, null, panel));
expect(params).toEqual({ dashboard: 'metrics.yml' }); expect(params).toEqual(expect.objectContaining({ dashboard: 'metrics.yml' }));
}); });
it('returns a dashboard only URL if panel is missing', () => { it('returns a dashboard only URL if panel is missing', () => {
const params = getUrlParams(panelToUrl(dashboard, panelGroup.group, null)); const params = getUrlParams(panelToUrl(dashboard, {}, panelGroup.group, null));
expect(params).toEqual({ dashboard: 'metrics.yml' }); expect(params).toEqual(expect.objectContaining({ dashboard: 'metrics.yml' }));
});
it('returns URL for a panel when query paramters are given including custom variables', () => {
const params = getUrlParams(panelToUrl(dashboard, { pod: 'pod' }, panelGroup.group, null));
expect(params).toEqual(expect.objectContaining({ dashboard: 'metrics.yml', pod: 'pod' }));
}); });
}); });
......
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