You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by mi...@apache.org on 2026/10/12 22:17:57 UTC
(superset) branch master updated: fix(explore): honor chart edit permissions for titles (#45146)
This is an automated email from the ASF dual-hosted git repository.
aminghadersohi pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git
The following commit(s) were added to refs/heads/master by this push:
new 60c66fe8d50 fix(explore): honor chart edit permissions for titles (#45146)
60c66fe8d50 is described below
commit 60c66fe8d502d4debfebf1cbc4c05c446f116c62
Author: Mike Bridge <mi...@preset.io>
AuthorDate: Mon Oct 12 16:17:50 2026 -0600
fix(explore): honor chart edit permissions for titles (#45146)
---
docs/docs/using-superset/exploring-data.mdx | 4 +
.../ExploreChartHeader/ExploreChartHeader.test.tsx | 160 +++++++++++++++++++++
.../components/ExploreChartHeader/index.tsx | 37 +++--
.../src/explore/components/SaveModal.test.tsx | 55 +++++++
.../src/explore/components/SaveModal.tsx | 15 +-
.../src/explore/reducers/exploreReducer.test.ts | 26 ++++
.../src/explore/reducers/exploreReducer.ts | 15 +-
superset-frontend/src/types/Chart.ts | 1 +
8 files changed, 292 insertions(+), 21 deletions(-)
diff --git a/docs/docs/using-superset/exploring-data.mdx b/docs/docs/using-superset/exploring-data.mdx
index d69fe2745dd..9b37ab58d74 100644
--- a/docs/docs/using-superset/exploring-data.mdx
+++ b/docs/docs/using-superset/exploring-data.mdx
@@ -128,6 +128,10 @@ To save the visualization, click on **Save** in the top left of the screen. In t
- Select **Add To Dashboard** and enter
Tutorial Dashboard. Finally, select **Save & Go To Dashboard**.
+For an existing chart, chart editors (including extra editors and administrators)
+with Chart write permission can edit its title in Explore and save the change.
+Externally managed charts and version previews keep the title read-only.
+
<img src={useBaseUrl('/img/tutorial/save_tutorial_table.png')} />
### Dashboard Basics
diff --git a/superset-frontend/src/explore/components/ExploreChartHeader/ExploreChartHeader.test.tsx b/superset-frontend/src/explore/components/ExploreChartHeader/ExploreChartHeader.test.tsx
index beb5f788043..964857c57f0 100644
--- a/superset-frontend/src/explore/components/ExploreChartHeader/ExploreChartHeader.test.tsx
+++ b/superset-frontend/src/explore/components/ExploreChartHeader/ExploreChartHeader.test.tsx
@@ -39,6 +39,8 @@ import {
import { toChartStateHistoryState } from 'src/explore/exploreUtils/exploreHistory';
import { useUnsavedChangesPrompt } from 'src/hooks/useUnsavedChangesPrompt';
import ExploreHeader, { ExploreChartHeaderProps } from '.';
+import * as bootstrapData from 'src/utils/getBootstrapData';
+import { UserRoles } from 'src/types/bootstrapTypes';
import fs from 'fs';
import path from 'path';
@@ -180,6 +182,164 @@ describe('ExploreChartHeader', () => {
});
});
+ test.each<{
+ name: string;
+ roles: UserRoles;
+ editors: number[];
+ extraEditors: number[];
+ granted: boolean;
+ canOverwrite?: boolean;
+ managed?: boolean;
+ preview?: boolean;
+ newChart?: boolean;
+ canWrite?: boolean;
+ }>([
+ {
+ name: 'admin',
+ roles: { Admin: [] },
+ editors: [],
+ extraEditors: [],
+ granted: true,
+ },
+ {
+ name: 'extra editor',
+ roles: { Gamma: [] },
+ editors: [],
+ extraEditors: [7],
+ granted: true,
+ },
+ {
+ name: 'read-only extra editor',
+ roles: { Gamma: [] },
+ editors: [],
+ extraEditors: [7],
+ canWrite: false,
+ granted: false,
+ },
+ {
+ name: 'unrecoverable malformed editor IDs',
+ roles: { Gamma: [] },
+ editors: JSON.parse('[null]'),
+ extraEditors: [],
+ granted: false,
+ },
+ {
+ name: 'valid extra editor with malformed editors',
+ roles: { Gamma: [] },
+ editors: JSON.parse('[null, "invalid", {}]'),
+ extraEditors: [7],
+ granted: true,
+ },
+ {
+ name: 'owner subject',
+ roles: { Gamma: [] },
+ editors: [8],
+ extraEditors: [],
+ granted: true,
+ },
+ {
+ name: 'unrelated viewer',
+ roles: { Gamma: [] },
+ editors: [99],
+ extraEditors: [98],
+ granted: false,
+ },
+ {
+ name: 'store grant',
+ roles: { Gamma: [] },
+ editors: [],
+ extraEditors: [],
+ canOverwrite: true,
+ granted: true,
+ },
+ {
+ name: 'managed admin',
+ roles: { Admin: [] },
+ editors: [],
+ extraEditors: [],
+ managed: true,
+ canOverwrite: true,
+ granted: false,
+ },
+ {
+ name: 'admin preview',
+ roles: { Admin: [] },
+ editors: [],
+ extraEditors: [],
+ preview: true,
+ granted: false,
+ },
+ {
+ name: 'new chart',
+ roles: { Gamma: [] },
+ editors: [],
+ extraEditors: [],
+ newChart: true,
+ canWrite: false,
+ granted: true,
+ },
+ ])(
+ 'chart title editability for $name',
+ async ({
+ roles,
+ editors,
+ extraEditors,
+ granted,
+ canOverwrite = false,
+ managed = false,
+ preview = false,
+ newChart = false,
+ canWrite = true,
+ }) => {
+ const bootstrap = bootstrapData.default();
+ const bootstrapSpy = jest
+ .spyOn(bootstrapData, 'default')
+ .mockReturnValue({
+ ...bootstrap,
+ common: { ...bootstrap.common, user_subjects: [7, 8] },
+ });
+ const props = createProps({
+ canOverwrite,
+ user: { userId: 1, username: 'viewer', permissions: {}, roles },
+ });
+ props.slice = newChart
+ ? null
+ : {
+ ...props.slice!,
+ editors,
+ extra_editors: extraEditors,
+ is_managed_externally: managed,
+ };
+ try {
+ render(<ExploreHeader {...props} />, {
+ useRedux: true,
+ initialState: {
+ explore: { can_add: canWrite },
+ versionHistory: {
+ entityType: 'chart',
+ preview: preview ? { versionUuid: 'old-version' } : null,
+ },
+ },
+ });
+ const title = screen.getByRole('textbox', { name: 'Chart title' });
+ if (granted) {
+ expect(title).toBeEnabled();
+ await userEvent.clear(title);
+ await userEvent.type(title, 'Renamed chart');
+ await userEvent.tab();
+ expect(props.actions.updateChartTitle).toHaveBeenCalledWith(
+ 'Renamed chart',
+ );
+ } else {
+ expect(title).toBeDisabled();
+ expect(props.actions.updateChartTitle).not.toHaveBeenCalled();
+ }
+ } finally {
+ bootstrapSpy.mockRestore();
+ }
+ },
+ );
+
test('Cancelling changes to the properties should reset previous properties', async () => {
const props = createProps();
render(<ExploreHeader {...props} />, {
diff --git a/superset-frontend/src/explore/components/ExploreChartHeader/index.tsx b/superset-frontend/src/explore/components/ExploreChartHeader/index.tsx
index 4cd3a4ceab1..78b73224c45 100644
--- a/superset-frontend/src/explore/components/ExploreChartHeader/index.tsx
+++ b/superset-frontend/src/explore/components/ExploreChartHeader/index.tsx
@@ -56,8 +56,8 @@ import { Tag } from 'src/components/Tag';
import { ChartState, ExplorePageInitialData } from 'src/explore/types';
import { Slice } from 'src/types/Chart';
import { ReportObject } from 'src/features/reports/types';
-import { User } from 'src/types/bootstrapTypes';
-import getBootstrapData from 'src/utils/getBootstrapData';
+import { User, isUserWithPermissionsAndRoles } from 'src/types/bootstrapTypes';
+import { canOverwriteSlice } from 'src/explore/exploreUtils/canOverwriteSlice';
import { selectIsChartVersionPreviewActive } from 'src/features/versionHistory/reducer';
import { useExploreAdditionalActionsMenu } from '../useExploreAdditionalActionsMenu';
import { useExploreMetadataBar } from './useExploreMetadataBar';
@@ -111,7 +111,7 @@ const additionalItemsStyles = (theme: SupersetTheme) => css`
const ExploreChartHeader: FC<ExploreChartHeaderProps> = ({
dashboardId,
colorScheme: dashboardColorScheme,
- slice,
+ slice: rawSlice,
actions,
formData,
ownState,
@@ -125,6 +125,21 @@ const ExploreChartHeader: FC<ExploreChartHeaderProps> = ({
metadata,
isSaveModalVisible,
}) => {
+ const slice = useMemo(
+ () =>
+ rawSlice
+ ? {
+ ...rawSlice,
+ editors: rawSlice.editors?.filter(Number.isInteger),
+ extra_editors: rawSlice.extra_editors?.filter(Number.isInteger),
+ }
+ : rawSlice,
+ [rawSlice],
+ );
+ const canWriteChart = useSelector<
+ { explore?: { can_add?: boolean } },
+ boolean
+ >(state => state.explore?.can_add ?? false);
const dispatch = useDispatch();
const isVersionPreviewActive = useSelector(selectIsChartVersionPreviewActive);
const { latestQueryFormData, sliceFormData } = chart;
@@ -291,19 +306,18 @@ const ExploreChartHeader: FC<ExploreChartHeaderProps> = ({
}
}, [showUnsavedChangesModal, shouldForceCloseModal]);
- const userSubjects = useMemo(
- () => new Set(getBootstrapData()?.common?.user_subjects ?? []),
- [],
- );
-
const editableTitleProps = useMemo(
() => ({
title: sliceName ?? '',
canEdit:
!isVersionPreviewActive &&
(!slice ||
- canOverwrite ||
- Boolean(slice?.editors?.some(editor => userSubjects.has(editor)))),
+ (canWriteChart &&
+ canOverwriteSlice({
+ slice,
+ user: isUserWithPermissionsAndRoles(user) ? user : undefined,
+ canOverwrite,
+ }))),
onSave: actions.updateChartTitle,
placeholder: t('Add the name of the chart'),
label: t('Chart title'),
@@ -311,10 +325,11 @@ const ExploreChartHeader: FC<ExploreChartHeaderProps> = ({
[
actions.updateChartTitle,
canOverwrite,
+ canWriteChart,
isVersionPreviewActive,
slice,
sliceName,
- userSubjects,
+ user,
],
);
diff --git a/superset-frontend/src/explore/components/SaveModal.test.tsx b/superset-frontend/src/explore/components/SaveModal.test.tsx
index b2f8018f584..5ca8964bc12 100644
--- a/superset-frontend/src/explore/components/SaveModal.test.tsx
+++ b/superset-frontend/src/explore/components/SaveModal.test.tsx
@@ -104,6 +104,7 @@ const initialState = {
isVisible: true,
},
explore: {
+ can_add: true,
datasource: {},
slice: {
slice_id: 1,
@@ -907,3 +908,57 @@ test('addChartToDashboard handles empty position_json', async () => {
mockNanoid.mockRestore();
}
});
+
+test.each([
+ {
+ name: 'explicit editor',
+ editors: [{ id: 1 }],
+ extraEditors: [],
+ canWrite: false,
+ },
+ {
+ name: 'explicit editor',
+ editors: [{ id: 1 }],
+ extraEditors: [],
+ canWrite: true,
+ },
+ { name: 'extra editor', editors: [], extraEditors: [1], canWrite: false },
+ { name: 'extra editor', editors: [], extraEditors: [1], canWrite: true },
+])(
+ '$name overwrite requires Chart write permission ($canWrite)',
+ ({ editors, extraEditors, canWrite }) => {
+ const { getByRole, getByText } = setup(
+ {},
+ mockStore({
+ ...initialState,
+ explore: {
+ ...initialState.explore,
+ can_add: canWrite,
+ can_overwrite: false,
+ slice: {
+ ...initialState.explore.slice,
+ editors,
+ extra_editors: extraEditors,
+ },
+ },
+ user: {
+ userId: 1,
+ username: 'Gamma',
+ roles: { Gamma: [] },
+ permissions: {},
+ },
+ }),
+ );
+ const overwrite = getByRole('radio', { name: 'Save (Overwrite)' });
+ if (canWrite) {
+ expect(overwrite).toBeEnabled();
+ expect(overwrite).toBeChecked();
+ } else {
+ expect(overwrite).toBeDisabled();
+ expect(getByRole('radio', { name: 'Save as...' })).toBeChecked();
+ expect(
+ getByText('You do not have permission to edit this chart'),
+ ).toBeInTheDocument();
+ }
+ },
+);
diff --git a/superset-frontend/src/explore/components/SaveModal.tsx b/superset-frontend/src/explore/components/SaveModal.tsx
index a2d71321445..48aa398abd5 100755
--- a/superset-frontend/src/explore/components/SaveModal.tsx
+++ b/superset-frontend/src/explore/components/SaveModal.tsx
@@ -194,6 +194,7 @@ interface SaveModalProps {
sliceName?: string;
slice?: Record<string, any>;
can_overwrite?: boolean;
+ can_add?: boolean;
datasource?: Record<string, any>;
dashboardId: '' | number | null;
isVisible: boolean;
@@ -216,6 +217,7 @@ const SaveModal = ({
sliceName = '',
slice,
can_overwrite,
+ can_add,
datasource,
dashboardId: dashboardIdProp,
isVisible,
@@ -227,8 +229,9 @@ const SaveModal = ({
const canOverwriteSlice = useCallback(
(): boolean =>
+ Boolean(can_add) &&
canOverwriteSliceFor({ slice, user, canOverwrite: can_overwrite }),
- [can_overwrite, slice, user],
+ [can_add, can_overwrite, slice, user],
);
const [newSliceName, setNewSliceName] = useState<string | undefined>(
@@ -747,9 +750,11 @@ const SaveModal = ({
? t(
"This chart is managed externally and can't be overwritten in Superset.",
)
- : t(
- 'Must be a chart editor to overwrite this chart. Save as a new chart instead.',
- )}
+ : !can_add
+ ? t('You do not have permission to edit this chart')
+ : t(
+ 'Must be a chart editor to overwrite this chart. Save as a new chart instead.',
+ )}
</Typography.Text>
</div>
)}
@@ -918,6 +923,7 @@ interface StateProps {
datasource: any;
slice: any;
can_overwrite: boolean;
+ can_add: boolean;
user: UserWithPermissionsAndRoles;
dashboards: any;
alert: any;
@@ -934,6 +940,7 @@ function mapStateToProps({
datasource: explore.datasource,
slice: explore.slice,
can_overwrite: explore.can_overwrite,
+ can_add: explore.can_add,
user,
dashboards: saveModal.dashboards,
alert: saveModal.saveModalAlert,
diff --git a/superset-frontend/src/explore/reducers/exploreReducer.test.ts b/superset-frontend/src/explore/reducers/exploreReducer.test.ts
index 49f0cd23408..af3f94f4503 100644
--- a/superset-frontend/src/explore/reducers/exploreReducer.test.ts
+++ b/superset-frontend/src/explore/reducers/exploreReducer.test.ts
@@ -39,11 +39,21 @@ import {
import tableControlPanel from '../../../plugins/plugin-chart-table/src/controlPanel';
import exploreReducer, { ExploreState } from './exploreReducer';
import {
+ SLICE_UPDATED,
setCompatibility,
setControlValue,
setStashFormData,
} from '../actions/exploreActions';
import { CompatibilityResult } from '../types';
+import { canOverwriteSlice } from '../exploreUtils/canOverwriteSlice';
+
+jest.mock('src/utils/getBootstrapData', () =>
+ jest
+ .requireActual<typeof import('spec/helpers/mockBootstrapData')>(
+ 'spec/helpers/mockBootstrapData',
+ )
+ .mockUserSubjectsBootstrapData([8]),
+);
test('reset hiddenFormData on SET_STASH_FORM_DATA', () => {
const initialState: ExploreState = {
@@ -501,3 +511,19 @@ test('SET_FIELD_VALUE refreshes semantic ordering choices and removes stale sort
]);
expect(afterChange.form_data.order_by_cols).toEqual(['["song_name",true]']);
});
+
+test.each([
+ { name: 'API subject', editors: [{ id: 8, label: 'Alice' }] },
+ { name: 'select option', editors: [{ value: 8, label: 'Alice' }] },
+ { name: 'subject ID', editors: [8] },
+])('properties save preserves $name editorship in Redux', ({ editors }) => {
+ const state: ExploreState = { form_data: {} as QueryFormData, controls: {} };
+ const action = {
+ type: SLICE_UPDATED,
+ slice: { slice_name: 'Renamed', editors },
+ } as Parameters<typeof exploreReducer>[1];
+ const updated = exploreReducer(state, action);
+ expect(canOverwriteSlice({ slice: updated.slice })).toBe(true);
+ expect(updated.slice?.editors).toEqual([8]);
+ expect(updated.sliceName).toBe('Renamed');
+});
diff --git a/superset-frontend/src/explore/reducers/exploreReducer.ts b/superset-frontend/src/explore/reducers/exploreReducer.ts
index c66df67cd8a..8cfbc5e7e7f 100644
--- a/superset-frontend/src/explore/reducers/exploreReducer.ts
+++ b/superset-frontend/src/explore/reducers/exploreReducer.ts
@@ -155,9 +155,11 @@ interface SetStashFormDataAction {
isHidden: boolean;
}
-// Editor can be either a number (subject ID) or an object with value/label
-// This handles both Slice format (number[]) and select control format ({value, label}[])
-type EditorItem = number | { value: number; label: string };
+// Editors arrive as subject IDs, select options, or API subject responses.
+type EditorItem =
+ | number
+ | { value: number; label: string }
+ | { id: number; label: string };
interface SliceUpdatedAction {
type: typeof actions.SLICE_UPDATED;
@@ -642,9 +644,10 @@ export default function exploreReducer(
},
[actions.SLICE_UPDATED]() {
const typedAction = action as SliceUpdatedAction;
- // Handle editors that can be either number[] or Array<{value, label}>
- const getEditorId = (editor: EditorItem): number =>
- typeof editor === 'number' ? editor : editor.value;
+ const getEditorId = (editor: EditorItem): number => {
+ if (typeof editor === 'number') return editor;
+ return 'value' in editor ? editor.value : editor.id;
+ };
const getEditorLabel = (editor: EditorItem): string | null =>
typeof editor === 'number' ? null : editor.label;
return {
diff --git a/superset-frontend/src/types/Chart.ts b/superset-frontend/src/types/Chart.ts
index 7e768d37a2a..315a8527e59 100644
--- a/superset-frontend/src/types/Chart.ts
+++ b/superset-frontend/src/types/Chart.ts
@@ -87,6 +87,7 @@ export type Slice = {
query_context?: object;
is_managed_externally: boolean;
editors?: number[];
+ extra_editors?: number[];
viewers?: number[];
datasource?: string;
datasource_id?: number;