Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(dashboard): copy permalink to dashboard chart #19772

Merged
merged 3 commits into from
Apr 19, 2022
Merged

fix(dashboard): copy permalink to dashboard chart #19772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4bd59d8
fix(dashboard): copy permalink to dashboard chart
villebro Apr 19, 2022
783d590
lint
villebro Apr 19, 2022
c4862e2
address comments
villebro Apr 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions superset-frontend/src/components/URLShortLinkButton/index.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ class URLShortLinkButton extends React.Component {
if (this.props.dashboardId) {
getFilterValue(this.props.dashboardId, nativeFiltersKey)
.then(filterState =>
getDashboardPermalink(
String(this.props.dashboardId),
getDashboardPermalink({
dashboardId: this.props.dashboardId,
filterState,
this.props.anchorLinkId,
)
hash: this.props.anchorLinkId,
})
.then(this.onShortUrlSuccess)
.catch(this.props.addDangerToast),
)
Expand Down
6 changes: 4 additions & 2 deletions superset-frontend/src/dashboard/components/SliceHeaderControls/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,8 @@ class SliceHeaderControls extends React.PureComponent<

render() {
const {
componentId,
dashboardId,
slice,
isFullSize,
cachedDttm = [],
Expand All @@ -221,7 +223,6 @@ class SliceHeaderControls extends React.PureComponent<
addDangerToast = () => {},
supersetCanShare = false,
isCached = [],
formData,
} = this.props;
const crossFilterItems = getChartMetadataRegistry().items;
const isTable = slice.viz_type === 'table';
Expand Down Expand Up @@ -310,13 +311,14 @@ class SliceHeaderControls extends React.PureComponent<

{supersetCanShare && (
<ShareMenuItems
dashboardId={dashboardId}
dashboardComponentId={componentId}
copyMenuItemTitle={t('Copy permalink to clipboard')}
emailMenuItemTitle={t('Share permalink by email')}
emailSubject={t('Superset chart')}
emailBody={t('Check out this chart: ')}
addSuccessToast={addSuccessToast}
addDangerToast={addDangerToast}
formData={formData}
/>
)}

Expand Down
28 changes: 11 additions & 17 deletions superset-frontend/src/dashboard/components/menu/ShareMenuItems/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,10 @@
*/
import React from 'react';
import copyTextToClipboard from 'src/utils/copy';
import { t, logging, QueryFormData } from '@superset-ui/core';
import { t, logging } from '@superset-ui/core';
import { Menu } from 'src/components/Menu';
import {
getChartPermalink,
getDashboardPermalink,
getUrlParam,
} from 'src/utils/urlUtils';
import { RESERVED_DASHBOARD_URL_PARAMS, URL_PARAMS } from 'src/constants';
import { getDashboardPermalink, getUrlParam } from 'src/utils/urlUtils';
import { URL_PARAMS } from 'src/constants';
import { getFilterValue } from 'src/dashboard/components/nativeFilters/FilterBar/keyValue';

interface ShareMenuItemProps {
Expand All @@ -36,8 +32,8 @@ interface ShareMenuItemProps {
emailBody: string;
addDangerToast: Function;
addSuccessToast: Function;
dashboardId?: string;
formData?: Pick<QueryFormData, 'slice_id' | 'datasource'>;
dashboardId: string | number;
dashboardComponentId?: string;
}

const ShareMenuItems = (props: ShareMenuItemProps) => {
Expand All @@ -49,23 +45,21 @@ const ShareMenuItems = (props: ShareMenuItemProps) => {
addDangerToast,
addSuccessToast,
dashboardId,
formData,
dashboardComponentId,
...rest
} = props;

async function generateUrl() {
// chart
if (formData) {
// we need to remove reserved dashboard url params
return getChartPermalink(formData, RESERVED_DASHBOARD_URL_PARAMS);
}
// dashboard
const nativeFiltersKey = getUrlParam(URL_PARAMS.nativeFiltersKey);
let filterState = {};
if (nativeFiltersKey && dashboardId) {
filterState = await getFilterValue(dashboardId, nativeFiltersKey);
}
return getDashboardPermalink(String(dashboardId), filterState);
return getDashboardPermalink({
dashboardId,
filterState,
hash: dashboardComponentId,
});
}

async function onCopyLink() {
Expand Down
14 changes: 9 additions & 5 deletions superset-frontend/src/utils/urlUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,11 +154,15 @@ export function getChartPermalink(
});
}

export function getDashboardPermalink(
dashboardId: string,
filterState: JsonObject,
hash?: string,
) {
export function getDashboardPermalink({
dashboardId,
filterState,
hash, // the anchor part of the link which corresponds to the tab/chart id
}: {
dashboardId: string | number;
filterState: JsonObject;
hash?: string;
}) {
// only encode filter box state if non-empty
return getPermalink(`/api/v1/dashboard/${dashboardId}/permalink`, {
filterState,
Expand Down