You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by jl...@apache.org on 2026/04/10 04:06:40 UTC
(superset) 01/01: feat(dashboard): add ShareDashboardModal with invite flow and correct button capitalization
This is an automated email from the ASF dual-hosted git repository.
jli pushed a commit to branch sc-83062-share-dashboard-modal-fixes
in repository https://gitbox.apache.org/repos/asf/superset.git
commit ed2a2f2afa875c76a729b1cbf82696dc74233f9c
Author: sadpandajoe <jc...@gmail.com>
AuthorDate: Fri Apr 10 04:06:26 2026 +0000
feat(dashboard): add ShareDashboardModal with invite flow and correct button capitalization
- Add ShareDashboardModal component with 'Copy link', 'Cancel', 'Share' button text
- Add isUserTeamAdmin() utility so team admins (not just workspace admins) can access the invite flow
- Wire modal into dashboard Header with showingShareModal state and show/hide callbacks
- Add ShareDashboardModal menu item ('Share dashboard...') to header actions dropdown
- Add ShareDashboardModal key to MenuKeys enum
- Add tests covering button capitalization, admin/team-admin invite visibility, and clipboard copy
Closes sc-83062
Co-Authored-By: Claude Sonnet 4.6 <no...@anthropic.com>
---
.../src/dashboard/components/Header/index.tsx | 23 ++
.../src/dashboard/components/Header/types.ts | 1 +
.../Header/useHeaderActionsDropdownMenu.tsx | 16 +-
.../ShareDashboardModal.test.tsx | 154 +++++++++++
.../components/ShareDashboardModal/index.tsx | 294 +++++++++++++++++++++
superset-frontend/src/dashboard/types.ts | 1 +
.../src/dashboard/util/permissionUtils.ts | 9 +
7 files changed, 497 insertions(+), 1 deletion(-)
diff --git a/superset-frontend/src/dashboard/components/Header/index.tsx b/superset-frontend/src/dashboard/components/Header/index.tsx
index 522a22f1eca..84c405b8418 100644
--- a/superset-frontend/src/dashboard/components/Header/index.tsx
+++ b/superset-frontend/src/dashboard/components/Header/index.tsx
@@ -62,6 +62,7 @@ import {
import { PageHeaderWithActions } from '@superset-ui/core/components/PageHeaderWithActions';
import { useUnsavedChangesPrompt } from 'src/hooks/useUnsavedChangesPrompt';
import DashboardEmbedModal from '../EmbeddedModal';
+import ShareDashboardModal from '../ShareDashboardModal';
import OverwriteConfirm from '../OverwriteConfirm';
import {
addDangerToast,
@@ -230,6 +231,7 @@ const Header = (): JSX.Element => {
const [showingRefreshModal, setShowingRefreshModal] = useState(false);
const [showingEmbedModal, setShowingEmbedModal] = useState(false);
const [showingReportModal, setShowingReportModal] = useState(false);
+ const [showingShareModal, setShowingShareModal] = useState(false);
const [currentReportDeleting, setCurrentReportDeleting] =
useState<AlertObject | null>(null);
const dashboardInfo = useSelector(
@@ -531,6 +533,14 @@ const Header = (): JSX.Element => {
setShowingEmbedModal(false);
}, []);
+ const showShareModal = useCallback(() => {
+ setShowingShareModal(true);
+ }, []);
+
+ const hideShareModal = useCallback(() => {
+ setShowingShareModal(false);
+ }, []);
+
const showReportModal = useCallback(() => {
setShowingReportModal(true);
}, []);
@@ -815,6 +825,7 @@ const Header = (): JSX.Element => {
showReportModal,
showPropertiesModal,
showRefreshModal,
+ showShareModal,
setCurrentReportDeleting,
manageEmbedded: showEmbedModal,
lastModifiedTime: actualLastModifiedTime,
@@ -901,6 +912,18 @@ const Header = (): JSX.Element => {
dashboardId={String(dashboardInfo.id)}
/>
)}
+
+ {userCanShare && (
+ <ShareDashboardModal
+ show={showingShareModal}
+ onHide={hideShareModal}
+ dashboardId={dashboardInfo.id}
+ dashboardTitle={dashboardTitle ?? ''}
+ addSuccessToast={boundActionCreators.addSuccessToast}
+ addDangerToast={boundActionCreators.addDangerToast}
+ user={user}
+ />
+ )}
<Global
styles={css`
.ant-menu-vertical {
diff --git a/superset-frontend/src/dashboard/components/Header/types.ts b/superset-frontend/src/dashboard/components/Header/types.ts
index d5fee210d37..d2081fd871d 100644
--- a/superset-frontend/src/dashboard/components/Header/types.ts
+++ b/superset-frontend/src/dashboard/components/Header/types.ts
@@ -49,6 +49,7 @@ export interface HeaderDropdownProps {
shouldPersistRefreshFrequency: boolean;
showPropertiesModal: () => void;
showRefreshModal: () => void;
+ showShareModal: () => void;
userCanEdit: boolean | undefined;
userCanSave: boolean | undefined;
userCanShare: boolean | undefined;
diff --git a/superset-frontend/src/dashboard/components/Header/useHeaderActionsDropdownMenu.tsx b/superset-frontend/src/dashboard/components/Header/useHeaderActionsDropdownMenu.tsx
index 7c648458024..d62831781aa 100644
--- a/superset-frontend/src/dashboard/components/Header/useHeaderActionsDropdownMenu.tsx
+++ b/superset-frontend/src/dashboard/components/Header/useHeaderActionsDropdownMenu.tsx
@@ -62,6 +62,7 @@ export const useHeaderActionsMenu = ({
showPropertiesModal,
showRefreshModal,
showReportModal,
+ showShareModal,
manageEmbedded,
dashboardTitle,
logEvent,
@@ -111,6 +112,9 @@ export const useHeaderActionsMenu = ({
case MenuKeys.ManageEmbedded:
manageEmbedded();
break;
+ case MenuKeys.ShareDashboardModal:
+ showShareModal();
+ break;
default:
break;
}
@@ -121,6 +125,7 @@ export const useHeaderActionsMenu = ({
addSuccessToast,
showPropertiesModal,
showRefreshModal,
+ showShareModal,
manageEmbedded,
history,
],
@@ -266,11 +271,20 @@ export const useHeaderActionsMenu = ({
// Download submenu
menuItems.push(downloadMenuItem);
- // Share submenu
+ // Share submenu (permalink copy/email)
if (userCanShare) {
menuItems.push(shareMenuItems);
}
+ // Share dashboard modal (invite flow)
+ if (userCanShare) {
+ menuItems.push({
+ key: MenuKeys.ShareDashboardModal,
+ label: t('Share dashboard...'),
+ disabled: isLoading,
+ });
+ }
+
// Embed dashboard
if (!editMode && userCanCurate) {
menuItems.push({
diff --git a/superset-frontend/src/dashboard/components/ShareDashboardModal/ShareDashboardModal.test.tsx b/superset-frontend/src/dashboard/components/ShareDashboardModal/ShareDashboardModal.test.tsx
new file mode 100644
index 00000000000..5c346e133eb
--- /dev/null
+++ b/superset-frontend/src/dashboard/components/ShareDashboardModal/ShareDashboardModal.test.tsx
@@ -0,0 +1,154 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import {
+ render,
+ screen,
+ userEvent,
+ waitFor,
+} from 'spec/helpers/testing-library';
+import * as copyTextToClipboard from 'src/utils/copy';
+import * as urlUtils from 'src/utils/urlUtils';
+import { UserWithPermissionsAndRoles } from 'src/types/bootstrapTypes';
+import ShareDashboardModal from '.';
+
+jest.mock('src/utils/copy', () => ({
+ __esModule: true,
+ default: jest.fn().mockResolvedValue(undefined),
+}));
+
+jest.mock('src/utils/urlUtils', () => ({
+ ...jest.requireActual<any>('src/utils/urlUtils'),
+ getDashboardPermalink: jest
+ .fn()
+ .mockResolvedValue({ url: 'http://localhost/superset/dashboard/p/abc/' }),
+}));
+
+const mockOnHide = jest.fn();
+const mockAddSuccessToast = jest.fn();
+const mockAddDangerToast = jest.fn();
+
+const baseProps = {
+ dashboardId: 1,
+ dashboardTitle: 'Test Dashboard',
+ show: true,
+ onHide: mockOnHide,
+ addSuccessToast: mockAddSuccessToast,
+ addDangerToast: mockAddDangerToast,
+};
+
+const makeUser = (roleNames: string[]): UserWithPermissionsAndRoles => ({
+ userId: 1,
+ username: 'testuser',
+ firstName: 'Test',
+ lastName: 'User',
+ isActive: true,
+ email: 'test@example.com',
+ roles: Object.fromEntries(roleNames.map(name => [name, []])),
+ permissions: {},
+});
+
+const reduxState = {
+ dataMask: {},
+ dashboardState: {
+ activeTabs: [],
+ chartStates: {},
+ },
+ sliceEntities: { slices: {} },
+};
+
+const setup = (extraProps = {}) =>
+ render(<ShareDashboardModal {...baseProps} {...extraProps} />, {
+ useRedux: true,
+ initialState: reduxState,
+ });
+
+beforeEach(() => {
+ jest.clearAllMocks();
+});
+
+test('renders Cancel and Share buttons with correct capitalization', async () => {
+ setup();
+ expect(
+ await screen.findByRole('button', { name: 'Cancel' }),
+ ).toBeInTheDocument();
+ expect(screen.getByRole('button', { name: 'Share' })).toBeInTheDocument();
+});
+
+test('renders Copy link button with correct capitalization', async () => {
+ setup();
+ expect(
+ await screen.findByRole('button', { name: 'Copy link' }),
+ ).toBeInTheDocument();
+});
+
+test('does not render invite section for regular users', async () => {
+ setup({ user: makeUser(['Alpha']) });
+ await screen.findByRole('button', { name: 'Copy link' });
+ expect(
+ screen.queryByTestId('share-dashboard-email-input'),
+ ).not.toBeInTheDocument();
+ expect(screen.queryByText('Invite people')).not.toBeInTheDocument();
+});
+
+test('renders invite section for workspace admins (Admin role)', async () => {
+ setup({ user: makeUser(['Admin']) });
+ expect(
+ await screen.findByTestId('share-dashboard-email-input'),
+ ).toBeInTheDocument();
+ expect(screen.getByText('Invite people')).toBeInTheDocument();
+});
+
+test('renders invite section for team admins (Team Admin role)', async () => {
+ setup({ user: makeUser(['Team Admin']) });
+ expect(
+ await screen.findByTestId('share-dashboard-email-input'),
+ ).toBeInTheDocument();
+ expect(screen.getByText('Invite people')).toBeInTheDocument();
+});
+
+test('Copy link button copies the dashboard URL to clipboard', async () => {
+ setup();
+ const copyBtn = await screen.findByRole('button', { name: 'Copy link' });
+ await userEvent.click(copyBtn);
+ await waitFor(() => {
+ expect(copyTextToClipboard.default).toHaveBeenCalledTimes(1);
+ });
+});
+
+test('Cancel button calls onHide', async () => {
+ setup();
+ const cancelBtn = await screen.findByRole('button', { name: 'Cancel' });
+ await userEvent.click(cancelBtn);
+ expect(mockOnHide).toHaveBeenCalledTimes(1);
+});
+
+test('Share button with no invite emails calls onHide', async () => {
+ setup({ user: makeUser(['Alpha']) });
+ const shareBtn = await screen.findByRole('button', { name: 'Share' });
+ await userEvent.click(shareBtn);
+ expect(mockOnHide).toHaveBeenCalledTimes(1);
+});
+
+test('team admin can add email and trigger invite on Share', async () => {
+ setup({ user: makeUser(['Team Admin']) });
+ const emailInput = await screen.findByTestId('share-dashboard-email-input');
+ await userEvent.type(emailInput, 'invitee@example.com{enter}');
+
+ expect(await screen.findByText('invitee@example.com')).toBeInTheDocument();
+});
diff --git a/superset-frontend/src/dashboard/components/ShareDashboardModal/index.tsx b/superset-frontend/src/dashboard/components/ShareDashboardModal/index.tsx
new file mode 100644
index 00000000000..5b368f3292e
--- /dev/null
+++ b/superset-frontend/src/dashboard/components/ShareDashboardModal/index.tsx
@@ -0,0 +1,294 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { useCallback, useEffect, useMemo, useState } from 'react';
+import { t } from '@apache-superset/core/translation';
+import { styled } from '@apache-superset/core/theme';
+import { SupersetClient, logging } from '@superset-ui/core';
+import { Button, Input, Modal, Space, Tag } from '@superset-ui/core/components';
+import { getDashboardPermalink } from 'src/utils/urlUtils';
+import copyTextToClipboard from 'src/utils/copy';
+import {
+ isUserAdmin,
+ isUserTeamAdmin,
+} from 'src/dashboard/util/permissionUtils';
+import {
+ UserWithPermissionsAndRoles,
+ UndefinedUser,
+} from 'src/types/bootstrapTypes';
+import { useSelector } from 'react-redux';
+import { RootState } from 'src/dashboard/types';
+import { hasStatefulCharts } from 'src/dashboard/util/chartStateConverter';
+import { shallowEqual } from 'react-redux';
+
+export type ShareDashboardModalProps = {
+ dashboardId: number;
+ dashboardTitle: string;
+ show: boolean;
+ onHide: () => void;
+ addSuccessToast: (message: string) => void;
+ addDangerToast: (message: string) => void;
+ user?: UserWithPermissionsAndRoles | UndefinedUser;
+};
+
+const SectionTitle = styled.p`
+ font-weight: ${({ theme }) => theme.typography.weights.bold};
+ margin-bottom: ${({ theme }) => theme.gridUnit * 2}px;
+`;
+
+const LinkRow = styled.div`
+ display: flex;
+ align-items: center;
+ gap: ${({ theme }) => theme.gridUnit * 2}px;
+ margin-bottom: ${({ theme }) => theme.gridUnit * 4}px;
+`;
+
+const LinkInput = styled(Input)`
+ flex: 1;
+ background-color: ${({ theme }) => theme.colors.grayscale.light4};
+`;
+
+const EmailInputRow = styled.div`
+ display: flex;
+ align-items: flex-start;
+ gap: ${({ theme }) => theme.gridUnit * 2}px;
+ margin-bottom: ${({ theme }) => theme.gridUnit * 2}px;
+`;
+
+const EmailTagsContainer = styled.div`
+ display: flex;
+ flex-wrap: wrap;
+ gap: ${({ theme }) => theme.gridUnit}px;
+ margin-bottom: ${({ theme }) => theme.gridUnit * 2}px;
+ min-height: ${({ theme }) => theme.gridUnit * 4}px;
+`;
+
+const HintText = styled.p`
+ color: ${({ theme }) => theme.colors.grayscale.base};
+ font-size: ${({ theme }) => theme.typography.sizes.s}px;
+ margin-bottom: 0;
+`;
+
+const ShareDashboardModal = ({
+ dashboardId,
+ dashboardTitle,
+ show,
+ onHide,
+ addSuccessToast,
+ addDangerToast,
+ user,
+}: ShareDashboardModalProps) => {
+ const [dashboardUrl, setDashboardUrl] = useState('');
+ const [emailInput, setEmailInput] = useState('');
+ const [inviteEmails, setInviteEmails] = useState<string[]>([]);
+ const [isSubmitting, setIsSubmitting] = useState(false);
+
+ const { dataMask, activeTabs, chartStates, sliceEntities } = useSelector(
+ (state: RootState) => ({
+ dataMask: state.dataMask,
+ activeTabs: state.dashboardState.activeTabs,
+ chartStates: state.dashboardState.chartStates,
+ sliceEntities: state.sliceEntities?.slices,
+ }),
+ shallowEqual,
+ );
+
+ const canInviteUsers = useMemo(
+ () => isUserAdmin(user) || isUserTeamAdmin(user),
+ [user],
+ );
+
+ useEffect(() => {
+ if (!show) return;
+
+ const includeChartState =
+ hasStatefulCharts(sliceEntities) &&
+ chartStates &&
+ Object.keys(chartStates).length > 0;
+
+ getDashboardPermalink({
+ dashboardId,
+ dataMask,
+ activeTabs,
+ chartStates: includeChartState ? chartStates : undefined,
+ includeChartState,
+ })
+ .then(result => {
+ if (result?.url) setDashboardUrl(result.url);
+ })
+ .catch(err => {
+ logging.error(err);
+ });
+ }, [show, dashboardId, dataMask, activeTabs, chartStates, sliceEntities]);
+
+ const handleCopyLink = useCallback(async () => {
+ try {
+ await copyTextToClipboard(() => Promise.resolve(dashboardUrl));
+ addSuccessToast(t('Copied to clipboard!'));
+ } catch (error) {
+ logging.error(error);
+ addDangerToast(t('Sorry, something went wrong. Try again later.'));
+ }
+ }, [dashboardUrl, addSuccessToast, addDangerToast]);
+
+ const handleAddEmail = useCallback(() => {
+ const trimmed = emailInput.trim();
+ if (trimmed && !inviteEmails.includes(trimmed)) {
+ setInviteEmails(prev => [...prev, trimmed]);
+ }
+ setEmailInput('');
+ }, [emailInput, inviteEmails]);
+
+ const handleEmailKeyDown = useCallback(
+ (e: React.KeyboardEvent<HTMLInputElement>) => {
+ if (e.key === 'Enter' || e.key === ',') {
+ e.preventDefault();
+ handleAddEmail();
+ }
+ },
+ [handleAddEmail],
+ );
+
+ const handleRemoveEmail = useCallback((email: string) => {
+ setInviteEmails(prev => prev.filter(e => e !== email));
+ }, []);
+
+ const handleShare = useCallback(async () => {
+ if (!canInviteUsers || inviteEmails.length === 0) {
+ onHide();
+ return;
+ }
+
+ setIsSubmitting(true);
+ try {
+ await SupersetClient.post({
+ endpoint: '/api/v1/security/users/invite',
+ jsonPayload: {
+ emails: inviteEmails,
+ dashboard_id: dashboardId,
+ dashboard_url: dashboardUrl,
+ dashboard_title: dashboardTitle,
+ },
+ });
+ addSuccessToast(t('Invitation sent to %s', inviteEmails.join(', ')));
+ onHide();
+ } catch (error) {
+ logging.error(error);
+ addDangerToast(t('Failed to send invitations. Please try again.'));
+ } finally {
+ setIsSubmitting(false);
+ }
+ }, [
+ canInviteUsers,
+ inviteEmails,
+ dashboardId,
+ dashboardUrl,
+ dashboardTitle,
+ addSuccessToast,
+ addDangerToast,
+ onHide,
+ ]);
+
+ const handleHide = useCallback(() => {
+ setEmailInput('');
+ setInviteEmails([]);
+ onHide();
+ }, [onHide]);
+
+ const footer = (
+ <Space>
+ <Button
+ key="cancel"
+ buttonStyle="secondary"
+ onClick={handleHide}
+ data-test="share-dashboard-modal-cancel"
+ >
+ {t('Cancel')}
+ </Button>
+ <Button
+ key="share"
+ buttonStyle="primary"
+ onClick={handleShare}
+ loading={isSubmitting}
+ disabled={canInviteUsers && inviteEmails.length === 0 && !dashboardUrl}
+ data-test="share-dashboard-modal-share"
+ >
+ {t('Share')}
+ </Button>
+ </Space>
+ );
+
+ return (
+ <Modal
+ show={show}
+ onHide={handleHide}
+ title={t('Share dashboard')}
+ footer={footer}
+ data-test="share-dashboard-modal"
+ >
+ <SectionTitle>{t('Dashboard link')}</SectionTitle>
+ <LinkRow>
+ <LinkInput
+ value={dashboardUrl}
+ readOnly
+ data-test="share-dashboard-url-input"
+ />
+ <Button
+ buttonStyle="secondary"
+ onClick={handleCopyLink}
+ disabled={!dashboardUrl}
+ data-test="share-dashboard-copy-link"
+ >
+ {t('Copy link')}
+ </Button>
+ </LinkRow>
+
+ {canInviteUsers && (
+ <>
+ <SectionTitle>{t('Invite people')}</SectionTitle>
+ <EmailTagsContainer data-test="share-dashboard-email-tags">
+ {inviteEmails.map(email => (
+ <Tag
+ key={email}
+ closable
+ onClose={() => handleRemoveEmail(email)}
+ >
+ {email}
+ </Tag>
+ ))}
+ </EmailTagsContainer>
+ <EmailInputRow>
+ <Input
+ value={emailInput}
+ onChange={e => setEmailInput(e.target.value)}
+ onKeyDown={handleEmailKeyDown}
+ onBlur={handleAddEmail}
+ placeholder={t('Enter email address')}
+ data-test="share-dashboard-email-input"
+ />
+ </EmailInputRow>
+ <HintText>
+ {t('Press Enter or comma to add multiple email addresses.')}
+ </HintText>
+ </>
+ )}
+ </Modal>
+ );
+};
+
+export default ShareDashboardModal;
diff --git a/superset-frontend/src/dashboard/types.ts b/superset-frontend/src/dashboard/types.ts
index 2a7056bebab..e005a911365 100644
--- a/superset-frontend/src/dashboard/types.ts
+++ b/superset-frontend/src/dashboard/types.ts
@@ -393,4 +393,5 @@ export enum MenuKeys {
ManageEmailReports = 'manage_email_reports',
ExportPivotXlsx = 'export_pivot_xlsx',
EmbedCode = 'embed_code',
+ ShareDashboardModal = 'share_dashboard_modal',
}
diff --git a/superset-frontend/src/dashboard/util/permissionUtils.ts b/superset-frontend/src/dashboard/util/permissionUtils.ts
index 9db6b40c675..d2d21b3eeb8 100644
--- a/superset-frontend/src/dashboard/util/permissionUtils.ts
+++ b/superset-frontend/src/dashboard/util/permissionUtils.ts
@@ -28,6 +28,7 @@ import { findPermission } from 'src/utils/findPermission';
// this should really be a config value,
// but is hardcoded in backend logic already, so...
const ADMIN_ROLE_NAME = 'admin';
+const TEAM_ADMIN_ROLE_NAME = 'team admin';
export const isUserAdmin = (
user?: UserWithPermissionsAndRoles | UndefinedUser,
@@ -37,6 +38,14 @@ export const isUserAdmin = (
role => role.toLowerCase() === ADMIN_ROLE_NAME,
);
+export const isUserTeamAdmin = (
+ user?: UserWithPermissionsAndRoles | UndefinedUser,
+) =>
+ isUserWithPermissionsAndRoles(user) &&
+ Object.keys(user.roles || {}).some(
+ role => role.toLowerCase() === TEAM_ADMIN_ROLE_NAME,
+ );
+
const isUserDashboardOwner = (
dashboard: Dashboard,
user: UserWithPermissionsAndRoles | UndefinedUser,