You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by va...@apache.org on 2025/07/25 14:26:44 UTC
(superset) branch feat/d2d-in-embedded created (now 5382fd696c)
This is an automated email from the ASF dual-hosted git repository.
vavila pushed a change to branch feat/d2d-in-embedded
in repository https://gitbox.apache.org/repos/asf/superset.git
at 5382fd696c feat: Enable drilling in embedded
This branch includes the following new commits:
new 5382fd696c feat: Enable drilling in embedded
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(superset) 01/01: feat: Enable drilling in embedded
Posted by va...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
vavila pushed a commit to branch feat/d2d-in-embedded
in repository https://gitbox.apache.org/repos/asf/superset.git
commit 5382fd696c4acc80d748ef4e27bfb0731a9537d6
Author: Vitor Avila <vi...@preset.io>
AuthorDate: Fri Jul 25 11:24:18 2025 -0300
feat: Enable drilling in embedded
---
.../superset-ui-core/src/utils/featureFlags.ts | 1 +
.../Chart/ChartContextMenu/ChartContextMenu.tsx | 89 ++++-
.../Chart/DrillBy/DrillByMenuItems.test.tsx | 57 ++-
.../components/Chart/DrillBy/DrillByMenuItems.tsx | 92 +----
.../components/Chart/DrillBy/DrillByModal.test.tsx | 81 ++++
.../src/components/Chart/DrillBy/DrillByModal.tsx | 47 ++-
.../Chart/DrillDetail/DrillDetailMenuItems.tsx | 3 +
.../Chart/DrillDetail/DrillDetailModal.tsx | 9 +-
.../Chart/DrillDetail/DrillDetailPane.tsx | 15 +-
.../DatasetMetadataBar.skipped-stories.tsx | 18 +-
.../metadataBar/useDatasetMetadataBar.test.tsx | 67 +---
.../datasets/metadataBar/useDatasetMetadataBar.tsx | 53 +--
superset/config.py | 6 +-
superset/datasets/api.py | 95 ++++-
superset/datasets/schemas.py | 62 ++-
superset/security/manager.py | 52 ++-
superset/views/datasource/views.py | 9 +-
tests/integration_tests/charts/data/api_tests.py | 74 ++++
tests/integration_tests/datasets/api_tests.py | 432 +++++++++++++++++++--
tests/integration_tests/datasource_tests.py | 38 ++
20 files changed, 1033 insertions(+), 267 deletions(-)
diff --git a/superset-frontend/packages/superset-ui-core/src/utils/featureFlags.ts b/superset-frontend/packages/superset-ui-core/src/utils/featureFlags.ts
index 99738722e9..de26f08f50 100644
--- a/superset-frontend/packages/superset-ui-core/src/utils/featureFlags.ts
+++ b/superset-frontend/packages/superset-ui-core/src/utils/featureFlags.ts
@@ -40,6 +40,7 @@ export enum FeatureFlag {
EmbeddableCharts = 'EMBEDDABLE_CHARTS',
EmbeddedSuperset = 'EMBEDDED_SUPERSET',
EnableAdvancedDataTypes = 'ENABLE_ADVANCED_DATA_TYPES',
+ DrillingInEmbedded = 'DRILLING_IN_EMBEDDED',
/** @deprecated */
EnableJavascriptControls = 'ENABLE_JAVASCRIPT_CONTROLS',
EnableTemplateProcessing = 'ENABLE_TEMPLATE_PROCESSING',
diff --git a/superset-frontend/src/components/Chart/ChartContextMenu/ChartContextMenu.tsx b/superset-frontend/src/components/Chart/ChartContextMenu/ChartContextMenu.tsx
index bda9c13a83..8615aedacd 100644
--- a/superset-frontend/src/components/Chart/ChartContextMenu/ChartContextMenu.tsx
+++ b/superset-frontend/src/components/Chart/ChartContextMenu/ChartContextMenu.tsx
@@ -22,6 +22,7 @@ import {
ReactNode,
RefObject,
useCallback,
+ useEffect,
useImperativeHandle,
useState,
} from 'react';
@@ -35,7 +36,9 @@ import {
ensureIsArray,
FeatureFlag,
getChartMetadataRegistry,
+ getExtensionsRegistry,
isFeatureEnabled,
+ logging,
QueryFormData,
t,
useTheme,
@@ -48,6 +51,11 @@ import { updateDataMask } from 'src/dataMask/actions';
import DrillByModal from 'src/components/Chart/DrillBy/DrillByModal';
import { useVerboseMap } from 'src/hooks/apiResources/datasets';
import { Dataset } from 'src/components/Chart/types';
+import {
+ cachedSupersetGet,
+ supersetGetCache,
+} from 'src/utils/cachedSupersetGet';
+import { isEmbedded } from 'src/dashboard/util/isEmbedded';
import { DrillDetailMenuItems } from '../DrillDetail';
import { getMenuAdjustedY } from '../utils';
import { MenuItemTooltip } from '../DisabledMenuItemTooltip';
@@ -99,6 +107,9 @@ const ChartContextMenu = (
const crossFiltersEnabled = useSelector<RootState, boolean>(
({ dashboardInfo }) => dashboardInfo.crossFiltersEnabled,
);
+ const dashboardId = useSelector<RootState, number>(
+ ({ dashboardInfo }) => dashboardInfo.id,
+ );
const [openKeys, setOpenKeys] = useState<Key[]>([]);
const [modalFilters, setFilters] = useState<BinaryQueryObjectFilterClause[]>(
@@ -121,14 +132,18 @@ const ChartContextMenu = (
const [drillByColumn, setDrillByColumn] = useState<Column>();
const [showDrillByModal, setShowDrillByModal] = useState(false);
const [dataset, setDataset] = useState<Dataset>();
+ const [isLoadingDataset, setIsLoadingDataset] = useState(false);
const verboseMap = useVerboseMap(dataset);
- const handleDrillBy = useCallback((column: Column, dataset: Dataset) => {
+ const handleDrillBy = useCallback((column: Column) => {
setDrillByColumn(column);
- setDataset(dataset); // Save dataset when drilling
setShowDrillByModal(true);
}, []);
+ const loadDrillByOptions = getExtensionsRegistry().get(
+ 'load.drillby.options',
+ );
+
const handleCloseDrillByModal = useCallback(() => {
setShowDrillByModal(false);
}, []);
@@ -138,12 +153,73 @@ const ChartContextMenu = (
const showDrillToDetail =
isFeatureEnabled(FeatureFlag.DrillToDetail) &&
canDrillToDetail &&
- isDisplayed(ContextMenuItem.DrillToDetail);
+ (!isEmbedded() ||
+ (isEmbedded() && isFeatureEnabled(FeatureFlag.DrillingInEmbedded)));
+ isDisplayed(ContextMenuItem.DrillToDetail);
const showDrillBy =
isFeatureEnabled(FeatureFlag.DrillBy) &&
canDrillBy &&
- isDisplayed(ContextMenuItem.DrillBy);
+ (!isEmbedded() ||
+ (isEmbedded() && isFeatureEnabled(FeatureFlag.DrillingInEmbedded)));
+ isDisplayed(ContextMenuItem.DrillBy);
+
+ useEffect(() => {
+ async function fetchDataset() {
+ if (!visible || dataset || (!showDrillBy && !showDrillToDetail)) return;
+
+ const datasetId = Number(formData.datasource.split('__')[0]);
+ try {
+ setIsLoadingDataset(true);
+ let response;
+
+ if (loadDrillByOptions) {
+ response = await loadDrillByOptions(datasetId, formData);
+ } else {
+ const endpoint = `/api/v1/dataset/${datasetId}/drill_info/?q=(dashboard_id:${dashboardId})`;
+ response = await cachedSupersetGet({ endpoint });
+ }
+
+ const { json } = response;
+ const { result } = json;
+
+ // Filter columns for drill-by if needed
+ if (showDrillBy && result.columns) {
+ const filteredColumns = ensureIsArray(result.columns).filter(
+ column =>
+ // If using extensions, also filter by column.groupby since extensions might not do this
+ (!loadDrillByOptions || column.groupby) &&
+ !ensureIsArray(
+ formData[filters?.drillBy?.groupbyFieldName ?? ''],
+ ).includes(column.column_name) &&
+ column.column_name !== formData.x_axis &&
+ ensureIsArray(additionalConfig?.drillBy?.excludedColumns)?.every(
+ excludedCol => excludedCol.column_name !== column.column_name,
+ ),
+ );
+ result.columns = filteredColumns;
+ }
+
+ setDataset(result);
+ } catch (error) {
+ logging.error('Failed to load dataset:', error);
+ supersetGetCache.delete(`/api/v1/dataset/${datasetId}/drill_info/`);
+ } finally {
+ setIsLoadingDataset(false);
+ }
+ }
+
+ fetchDataset();
+ }, [
+ visible,
+ showDrillBy,
+ showDrillToDetail,
+ formData.datasource,
+ dataset,
+ filters?.drillBy,
+ additionalConfig?.drillBy?.excludedColumns,
+ loadDrillByOptions,
+ ]);
const showCrossFilters = isDisplayed(ContextMenuItem.CrossFilter);
@@ -248,6 +324,8 @@ const ChartContextMenu = (
onSelection={onSelection}
submenuIndex={showCrossFilters ? 2 : 1}
setShowModal={setDrillModalIsOpen}
+ dataset={dataset}
+ isLoadingDataset={isLoadingDataset}
{...(additionalConfig?.drillToDetail || {})}
/>,
);
@@ -270,6 +348,8 @@ const ChartContextMenu = (
open={openKeys.includes('drill-by-submenu')}
key="drill-by-submenu"
onDrillBy={handleDrillBy}
+ dataset={dataset}
+ isLoadingDataset={isLoadingDataset}
{...(additionalConfig?.drillBy || {})}
/>,
);
@@ -351,6 +431,7 @@ const ChartContextMenu = (
onHideModal={() => {
setDrillModalIsOpen(false);
}}
+ dataset={dataset}
/>
)}
{showDrillByModal && drillByColumn && dataset && filters?.drillBy && (
diff --git a/superset-frontend/src/components/Chart/DrillBy/DrillByMenuItems.test.tsx b/superset-frontend/src/components/Chart/DrillBy/DrillByMenuItems.test.tsx
index fd838f0108..2785d738d2 100644
--- a/superset-frontend/src/components/Chart/DrillBy/DrillByMenuItems.test.tsx
+++ b/superset-frontend/src/components/Chart/DrillBy/DrillByMenuItems.test.tsx
@@ -36,9 +36,6 @@ import { DrillByMenuItems, DrillByMenuItemsProps } from './DrillByMenuItems';
/* eslint jest/expect-expect: ["warn", { "assertFunctionNames": ["expect*"] }] */
-const DATASET_ENDPOINT = 'glob:*/api/v1/dataset/7*';
-const CHART_DATA_ENDPOINT = 'glob:*/api/v1/chart/data*';
-const FORM_DATA_KEY_ENDPOINT = 'glob:*/api/v1/explore/form_data';
const { form_data: defaultFormData } = chartQueries[sliceId];
jest.mock('lodash/debounce', () => (fn: Function & { debounce: Function }) => {
@@ -61,6 +58,18 @@ const defaultColumns = [
{ column_name: 'col11', groupby: true },
];
+const mockDataset = {
+ id: 7,
+ table_name: 'test_table',
+ columns: defaultColumns,
+ changed_on_humanized: '1 day ago',
+ created_on_humanized: '2 days ago',
+ description: 'Test dataset',
+ owners: [],
+ changed_by: { first_name: 'Test', last_name: 'User' },
+ created_by: { first_name: 'Test', last_name: 'User' },
+};
+
const defaultFilters = [
{
col: 'filter_col',
@@ -72,6 +81,7 @@ const defaultFilters = [
const renderMenu = ({
formData = defaultFormData,
drillByConfig = { filters: defaultFilters, groupbyFieldName: 'groupby' },
+ dataset = mockDataset,
...rest
}: Partial<DrillByMenuItemsProps>) =>
render(
@@ -79,6 +89,7 @@ const renderMenu = ({
<DrillByMenuItems
formData={formData ?? defaultFormData}
drillByConfig={drillByConfig}
+ dataset={dataset}
open
{...rest}
/>
@@ -151,20 +162,16 @@ test('render enabled menu item for supported chart, no filters', async () => {
});
test('render disabled menu item for supported chart, no columns', async () => {
- fetchMock.get(DATASET_ENDPOINT, { result: { columns: [] } });
- renderMenu({});
- await waitFor(() => fetchMock.called(DATASET_ENDPOINT));
+ const emptyDataset = { ...mockDataset, columns: [] };
+ renderMenu({ dataset: emptyDataset });
await expectDrillByEnabled();
screen.getByText('No columns found');
});
test('render menu item with submenu without searchbox', async () => {
const slicedColumns = defaultColumns.slice(0, 9);
- fetchMock.get(DATASET_ENDPOINT, {
- result: { columns: slicedColumns },
- });
- renderMenu({});
- await waitFor(() => fetchMock.called(DATASET_ENDPOINT));
+ const datasetWithSlicedColumns = { ...mockDataset, columns: slicedColumns };
+ renderMenu({ dataset: datasetWithSlicedColumns });
await expectDrillByEnabled();
slicedColumns.forEach(column => {
expect(screen.getByText(column.column_name)).toBeInTheDocument();
@@ -176,11 +183,7 @@ test('render menu item with submenu without searchbox', async () => {
jest.setTimeout(20000);
test('render menu item with submenu and searchbox', async () => {
- fetchMock.get(DATASET_ENDPOINT, {
- result: { columns: defaultColumns },
- });
- renderMenu({});
- await waitFor(() => fetchMock.called(DATASET_ENDPOINT));
+ renderMenu({ dataset: mockDataset });
await expectDrillByEnabled();
// Wait for all columns to be visible
@@ -221,18 +224,21 @@ test('render menu item with submenu and searchbox', async () => {
});
test('Do not display excluded column in the menu', async () => {
- fetchMock.get(DATASET_ENDPOINT, {
- result: { columns: defaultColumns },
- });
-
const excludedColNames = ['col3', 'col5'];
+ const filteredColumns = defaultColumns.filter(
+ col => !excludedColNames.includes(col.column_name),
+ );
+ const datasetWithFilteredColumns = {
+ ...mockDataset,
+ columns: filteredColumns,
+ };
renderMenu({
+ dataset: datasetWithFilteredColumns,
excludedColumns: excludedColNames.map(colName => ({
column_name: colName,
})),
});
- await waitFor(() => fetchMock.called(DATASET_ENDPOINT));
await expectDrillByEnabled();
// Wait for menu items to be loaded
@@ -253,19 +259,12 @@ test('Do not display excluded column in the menu', async () => {
});
test('When menu item is clicked, call onSelection with clicked column and drill by filters', async () => {
- fetchMock
- .get(DATASET_ENDPOINT, {
- result: { columns: defaultColumns },
- })
- .post(FORM_DATA_KEY_ENDPOINT, {})
- .post(CHART_DATA_ENDPOINT, {});
-
const onSelectionMock = jest.fn();
renderMenu({
+ dataset: mockDataset,
onSelection: onSelectionMock,
});
- await waitFor(() => fetchMock.called(DATASET_ENDPOINT));
await expectDrillByEnabled();
// Wait for col1 to be visible before clicking
diff --git a/superset-frontend/src/components/Chart/DrillBy/DrillByMenuItems.tsx b/superset-frontend/src/components/Chart/DrillBy/DrillByMenuItems.tsx
index c0ffc795e2..0d8344972b 100644
--- a/superset-frontend/src/components/Chart/DrillBy/DrillByMenuItems.tsx
+++ b/superset-frontend/src/components/Chart/DrillBy/DrillByMenuItems.tsx
@@ -32,25 +32,16 @@ import {
Behavior,
Column,
ContextMenuFilters,
- JsonResponse,
css,
ensureIsArray,
getChartMetadataRegistry,
- getExtensionsRegistry,
- logging,
t,
useTheme,
} from '@superset-ui/core';
import { Constants, Input, Loading } from '@superset-ui/core/components';
-import rison from 'rison';
import { debounce } from 'lodash';
import { FixedSizeList as List } from 'react-window';
import { Icons } from '@superset-ui/core/components/Icons';
-import { useToasts } from 'src/components/MessageToasts/withToasts';
-import {
- cachedSupersetGet,
- supersetGetCache,
-} from 'src/utils/cachedSupersetGet';
import { InputRef } from 'antd';
import { MenuItemTooltip } from '../DisabledMenuItemTooltip';
import { getSubmenuYOffset } from '../utils';
@@ -72,27 +63,10 @@ export interface DrillByMenuItemsProps {
excludedColumns?: Column[];
open: boolean;
onDrillBy?: (column: Column, dataset: Dataset) => void;
+ dataset?: Dataset;
+ isLoadingDataset?: boolean;
}
-const loadDrillByOptions = getExtensionsRegistry().get('load.drillby.options');
-
-const queryString = rison.encode({
- columns: [
- 'table_name',
- 'owners.first_name',
- 'owners.last_name',
- 'created_by.first_name',
- 'created_by.last_name',
- 'created_on_humanized',
- 'changed_by.first_name',
- 'changed_by.last_name',
- 'changed_on_humanized',
- 'columns.column_name',
- 'columns.verbose_name',
- 'columns.groupby',
- ],
-});
-
export const DrillByMenuItems = ({
drillByConfig,
formData,
@@ -104,18 +78,16 @@ export const DrillByMenuItems = ({
openNewModal = true,
open,
onDrillBy,
+ dataset,
+ isLoadingDataset = false,
...rest
}: DrillByMenuItemsProps) => {
const theme = useTheme();
- const { addDangerToast } = useToasts();
- const [isLoadingColumns, setIsLoadingColumns] = useState(true);
const [searchInput, setSearchInput] = useState('');
const [debouncedSearchInput, setDebouncedSearchInput] = useState('');
- const [dataset, setDataset] = useState<Dataset>();
- const [columns, setColumns] = useState<Column[]>([]);
const ref = useRef<InputRef>(null);
- const showSearch =
- loadDrillByOptions || columns.length > SHOW_COLUMNS_SEARCH_THRESHOLD;
+ const columns = dataset ? ensureIsArray(dataset.columns) : [];
+ const showSearch = columns.length > SHOW_COLUMNS_SEARCH_THRESHOLD;
const handleSelection = useCallback(
(event, column) => {
@@ -148,56 +120,6 @@ export const DrillByMenuItems = ({
[formData.viz_type],
);
- useEffect(() => {
- async function loadOptions() {
- const datasetId = Number(formData.datasource.split('__')[0]);
- try {
- setIsLoadingColumns(true);
- let response: JsonResponse;
- if (loadDrillByOptions) {
- response = await loadDrillByOptions(datasetId, formData);
- } else {
- response = await cachedSupersetGet({
- endpoint: `/api/v1/dataset/${datasetId}?q=${queryString}`,
- });
- }
- const { json } = response;
- const { result } = json;
- setDataset(result);
- setColumns(
- ensureIsArray(result.columns)
- .filter(column => column.groupby)
- .filter(
- column =>
- !ensureIsArray(
- formData[drillByConfig?.groupbyFieldName ?? ''],
- ).includes(column.column_name) &&
- column.column_name !== formData.x_axis &&
- ensureIsArray(excludedColumns)?.every(
- excludedCol => excludedCol.column_name !== column.column_name,
- ),
- ),
- );
- } catch (error) {
- logging.error(error);
- supersetGetCache.delete(`/api/v1/dataset/${datasetId}`);
- addDangerToast(t('Failed to load dimensions for drill by'));
- } finally {
- setIsLoadingColumns(false);
- }
- }
- if (handlesDimensionContextMenu && hasDrillBy) {
- loadOptions();
- }
- }, [
- addDangerToast,
- drillByConfig?.groupbyFieldName,
- excludedColumns,
- formData,
- handlesDimensionContextMenu,
- hasDrillBy,
- ]);
-
const debouncedSetSearchInput = useMemo(
() =>
debounce((value: string) => {
@@ -314,7 +236,7 @@ export const DrillByMenuItems = ({
value={searchInput}
/>
)}
- {isLoadingColumns ? (
+ {isLoadingDataset ? (
<div
css={css`
padding: ${theme.sizeUnit * 3}px 0;
diff --git a/superset-frontend/src/components/Chart/DrillBy/DrillByModal.test.tsx b/superset-frontend/src/components/Chart/DrillBy/DrillByModal.test.tsx
index dfeaa88b9e..697c2a62dd 100644
--- a/superset-frontend/src/components/Chart/DrillBy/DrillByModal.test.tsx
+++ b/superset-frontend/src/components/Chart/DrillBy/DrillByModal.test.tsx
@@ -32,6 +32,11 @@ import mockState from 'spec/fixtures/mockState';
import { DashboardPageIdContext } from 'src/dashboard/containers/DashboardPage';
import DrillByModal, { DrillByModalProps } from './DrillByModal';
+// Mock the isEmbedded function
+jest.mock('src/dashboard/util/isEmbedded', () => ({
+ isEmbedded: jest.fn(() => false),
+}));
+
const CHART_DATA_ENDPOINT = 'glob:*/api/v1/chart/data*';
const FORM_DATA_KEY_ENDPOINT = 'glob:*/api/v1/explore/form_data';
@@ -270,3 +275,79 @@ test('should render "Edit chart" enabled with can_explore permission', async ()
);
expect(screen.getByRole('button', { name: 'Edit chart' })).toBeEnabled();
});
+
+describe('Embedded mode behavior', () => {
+ // eslint-disable-next-line global-require, @typescript-eslint/no-var-requires
+ const { isEmbedded } = require('src/dashboard/util/isEmbedded');
+
+ beforeEach(() => {
+ (isEmbedded as jest.Mock).mockClear();
+ });
+
+ afterEach(() => {
+ (isEmbedded as jest.Mock).mockReturnValue(false);
+ });
+
+ test('should not render "Edit chart" button in embedded mode', async () => {
+ (isEmbedded as jest.Mock).mockReturnValue(true);
+
+ await renderModal();
+
+ expect(
+ screen.queryByRole('button', { name: 'Edit chart' }),
+ ).not.toBeInTheDocument();
+ const footerCloseButton = screen.getByTestId('close-drill-by-modal');
+ expect(footerCloseButton).toHaveTextContent('Close');
+ });
+
+ test('should not call postFormData API in embedded mode', async () => {
+ (isEmbedded as jest.Mock).mockReturnValue(true);
+
+ await renderModal({
+ column: { column_name: 'name' },
+ drillByConfig: {
+ filters: [{ col: 'gender', op: '==', val: 'boy' }],
+ groupbyFieldName: 'groupby',
+ },
+ });
+
+ await waitFor(() => fetchMock.called(CHART_DATA_ENDPOINT));
+
+ expect(fetchMock.called(FORM_DATA_KEY_ENDPOINT)).toBe(false);
+ });
+
+ test('should render "Edit chart" button in non-embedded mode', async () => {
+ (isEmbedded as jest.Mock).mockReturnValue(false);
+
+ await renderModal();
+
+ expect(
+ screen.getByRole('button', { name: 'Edit chart' }),
+ ).toBeInTheDocument();
+ });
+
+ test('should call postFormData API in non-embedded mode', async () => {
+ (isEmbedded as jest.Mock).mockReturnValue(false);
+
+ await renderModal({
+ column: { column_name: 'name' },
+ drillByConfig: {
+ filters: [{ col: 'gender', op: '==', val: 'boy' }],
+ groupbyFieldName: 'groupby',
+ },
+ });
+
+ await waitFor(() => fetchMock.called(CHART_DATA_ENDPOINT));
+
+ await waitFor(() => {
+ expect(fetchMock.called(FORM_DATA_KEY_ENDPOINT)).toBe(true);
+ });
+
+ expect(
+ await screen.findByRole('link', { name: 'Edit chart' }),
+ ).toHaveAttribute(
+ 'href',
+ '/explore/?form_data_key=123&dashboard_page_id=1',
+ );
+ });
+});
diff --git a/superset-frontend/src/components/Chart/DrillBy/DrillByModal.tsx b/superset-frontend/src/components/Chart/DrillBy/DrillByModal.tsx
index 302e39e409..f118d34c7d 100644
--- a/superset-frontend/src/components/Chart/DrillBy/DrillByModal.tsx
+++ b/superset-frontend/src/components/Chart/DrillBy/DrillByModal.tsx
@@ -56,6 +56,7 @@ import {
} from 'src/logger/LogUtils';
import { findPermission } from 'src/utils/findPermission';
import { getQuerySettings } from 'src/explore/exploreUtils';
+import { isEmbedded } from 'src/dashboard/util/isEmbedded';
import { Dataset, DrillByType } from '../types';
import DrillByChart from './DrillByChart';
import { ContextMenuItem } from '../ChartContextMenu/ChartContextMenu';
@@ -93,6 +94,8 @@ const ModalFooter = ({ formData, closeModal }: ModalFooterProps) => {
const [datasource_id, datasource_type] = formData.datasource.split('__');
useEffect(() => {
+ // short circuit if the user is embedded as explore is not available
+ if (isEmbedded()) return;
postFormData(Number(datasource_id), datasource_type, formData, 0)
.then(key => {
setUrl(
@@ -113,28 +116,30 @@ const ModalFooter = ({ formData, closeModal }: ModalFooterProps) => {
return (
<>
- <Button
- buttonStyle="secondary"
- buttonSize="small"
- onClick={onEditChartClick}
- disabled={isEditDisabled}
- tooltip={
- isEditDisabled
- ? t('You do not have sufficient permissions to edit the chart')
- : undefined
- }
- >
- <Link
- css={css`
- &:hover {
- text-decoration: none;
- }
- `}
- to={url}
+ {!isEmbedded() && (
+ <Button
+ buttonStyle="secondary"
+ buttonSize="small"
+ onClick={onEditChartClick}
+ disabled={isEditDisabled}
+ tooltip={
+ isEditDisabled
+ ? t('You do not have sufficient permissions to edit the chart')
+ : undefined
+ }
>
- {t('Edit chart')}
- </Link>
- </Button>
+ <Link
+ css={css`
+ &:hover {
+ text-decoration: none;
+ }
+ `}
+ to={url}
+ >
+ {t('Edit chart')}
+ </Link>
+ </Button>
+ )}
<Button
buttonStyle="primary"
diff --git a/superset-frontend/src/components/Chart/DrillDetail/DrillDetailMenuItems.tsx b/superset-frontend/src/components/Chart/DrillDetail/DrillDetailMenuItems.tsx
index 6fef045cea..69d9d20cfa 100644
--- a/superset-frontend/src/components/Chart/DrillDetail/DrillDetailMenuItems.tsx
+++ b/superset-frontend/src/components/Chart/DrillDetail/DrillDetailMenuItems.tsx
@@ -42,6 +42,7 @@ import { RootState } from 'src/dashboard/types';
import { getSubmenuYOffset } from '../utils';
import { MenuItemTooltip } from '../DisabledMenuItemTooltip';
import { MenuItemWithTruncation } from '../MenuItemWithTruncation';
+import { Dataset } from '../types';
const DRILL_TO_DETAIL = t('Drill to detail');
const DRILL_TO_DETAIL_BY = t('Drill to detail by');
@@ -113,6 +114,8 @@ export type DrillDetailMenuItemsProps = {
setShowModal: (show: boolean) => void;
key?: string;
forceSubmenuRender?: boolean;
+ dataset?: Dataset;
+ isLoadingDataset?: boolean;
};
const DrillDetailMenuItems = ({
diff --git a/superset-frontend/src/components/Chart/DrillDetail/DrillDetailModal.tsx b/superset-frontend/src/components/Chart/DrillDetail/DrillDetailModal.tsx
index 9da3acd771..71736e79d1 100644
--- a/superset-frontend/src/components/Chart/DrillDetail/DrillDetailModal.tsx
+++ b/superset-frontend/src/components/Chart/DrillDetail/DrillDetailModal.tsx
@@ -32,6 +32,7 @@ import { DashboardPageIdContext } from 'src/dashboard/containers/DashboardPage';
import { Slice } from 'src/types/Chart';
import { RootState } from 'src/dashboard/types';
import { findPermission } from 'src/utils/findPermission';
+import { Dataset } from '../types';
import DrillDetailPane from './DrillDetailPane';
interface ModalFooterProps {
@@ -83,6 +84,7 @@ interface DrillDetailModalProps {
initialFilters: BinaryQueryObjectFilterClause[];
showModal: boolean;
onHideModal: () => void;
+ dataset?: Dataset;
}
export default function DrillDetailModal({
@@ -91,6 +93,7 @@ export default function DrillDetailModal({
initialFilters,
showModal,
onHideModal,
+ dataset,
}: DrillDetailModalProps) {
const theme = useTheme();
const history = useHistory();
@@ -141,7 +144,11 @@ export default function DrillDetailModal({
destroyOnHidden
maskClosable={false}
>
- <DrillDetailPane formData={formData} initialFilters={initialFilters} />
+ <DrillDetailPane
+ formData={formData}
+ initialFilters={initialFilters}
+ dataset={dataset}
+ />
</Modal>
);
}
diff --git a/superset-frontend/src/components/Chart/DrillDetail/DrillDetailPane.tsx b/superset-frontend/src/components/Chart/DrillDetail/DrillDetailPane.tsx
index 62b82f03e2..f6dd0ecaee 100644
--- a/superset-frontend/src/components/Chart/DrillDetail/DrillDetailPane.tsx
+++ b/superset-frontend/src/components/Chart/DrillDetail/DrillDetailPane.tsx
@@ -47,8 +47,8 @@ import Table, {
TableSize,
} from '@superset-ui/core/components/Table';
import HeaderWithRadioGroup from '@superset-ui/core/components/Table/header-renderers/HeaderWithRadioGroup';
-import { ResourceStatus } from 'src/hooks/apiResources/apiResources';
import { useDatasetMetadataBar } from 'src/features/datasets/metadataBar/useDatasetMetadataBar';
+import { Dataset } from '../types';
import TableControls from './DrillDetailTableControls';
import { getDrillPayload } from './utils';
import { ResultsPage } from './types';
@@ -79,9 +79,11 @@ enum TimeFormatting {
export default function DrillDetailPane({
formData,
initialFilters,
+ dataset,
}: {
formData: QueryFormData;
initialFilters: BinaryQueryObjectFilterClause[];
+ dataset?: Dataset;
}) {
const theme = useTheme();
const [pageIndex, setPageIndex] = useState(0);
@@ -107,9 +109,10 @@ export default function DrillDetailPane({
[formData.datasource],
);
- const { metadataBar, status: metadataBarStatus } = useDatasetMetadataBar({
- datasetId: datasourceId,
+ const { metadataBar: metadataBarComponent } = useDatasetMetadataBar({
+ dataset,
});
+
// Get page of results
const resultsPage = useMemo(() => {
const nextResultsPage = resultsPages.get(pageIndex);
@@ -268,9 +271,7 @@ export default function DrillDetailPane({
resultsPages,
]);
- const bootstrapping =
- (!responseError && !resultsPages.size) ||
- metadataBarStatus === ResourceStatus.Loading;
+ const bootstrapping = !responseError && !resultsPages.size;
const allowHTML = formData.allow_render_html ?? true;
@@ -318,7 +319,7 @@ export default function DrillDetailPane({
return (
<>
- {!bootstrapping && metadataBar}
+ {!bootstrapping && metadataBarComponent}
{!bootstrapping && (
<TableControls
filters={filters}
diff --git a/superset-frontend/src/features/datasets/metadataBar/DatasetMetadataBar.skipped-stories.tsx b/superset-frontend/src/features/datasets/metadataBar/DatasetMetadataBar.skipped-stories.tsx
index 3e0c87fdb8..cc63b64a0c 100644
--- a/superset-frontend/src/features/datasets/metadataBar/DatasetMetadataBar.skipped-stories.tsx
+++ b/superset-frontend/src/features/datasets/metadataBar/DatasetMetadataBar.skipped-stories.tsx
@@ -52,7 +52,23 @@ export default {
export const DatasetSpecific = () => {
SupersetClient.reset();
SupersetClient.configure({ csrfToken: '1234' }).init();
- const { metadataBar } = useDatasetMetadataBar({ datasetId: 1 });
+
+ const mockDataset = {
+ changed_on: '2023-01-26T12:06:58.733316',
+ changed_on_humanized: 'a month ago',
+ changed_by: { first_name: 'Han', last_name: 'Solo' },
+ created_by: { first_name: 'Luke', last_name: 'Skywalker' },
+ created_on: '2023-01-26T12:06:54.965034',
+ created_on_humanized: 'a month ago',
+ table_name: `This is dataset's name`,
+ owners: [
+ { first_name: 'John', last_name: 'Doe' },
+ { first_name: 'Luke', last_name: 'Skywalker' },
+ ],
+ description: 'This is a dataset description',
+ };
+
+ const { metadataBar } = useDatasetMetadataBar({ dataset: mockDataset });
const { width, height, ref } = useResizeDetector();
// eslint-disable-next-line no-param-reassign
return (
diff --git a/superset-frontend/src/features/datasets/metadataBar/useDatasetMetadataBar.test.tsx b/superset-frontend/src/features/datasets/metadataBar/useDatasetMetadataBar.test.tsx
index c5c2d55f15..7f700657c3 100644
--- a/superset-frontend/src/features/datasets/metadataBar/useDatasetMetadataBar.test.tsx
+++ b/superset-frontend/src/features/datasets/metadataBar/useDatasetMetadataBar.test.tsx
@@ -43,35 +43,7 @@ afterEach(() => {
supersetGetCache.clear();
});
-test('renders dataset metadata bar from request', async () => {
- fetchMock.get('glob:*/api/v1/dataset/1', {
- result: MOCK_DATASET,
- });
-
- const { result, waitForValueToChange } = renderHook(
- () => useDatasetMetadataBar({ datasetId: 1 }),
- {
- wrapper: createWrapper(),
- },
- );
- expect(result.current.status).toEqual('loading');
- await waitForValueToChange(() => result.current.status);
- expect(result.current.status).toEqual('complete');
-
- expect(fetchMock.called()).toBeTruthy();
- const { findByText, findAllByRole } = render(result.current.metadataBar);
- expect(await findByText(`This is dataset's name`)).toBeVisible();
- expect(await findByText('This is a dataset description')).toBeVisible();
- expect(await findByText('Luke Skywalker')).toBeVisible();
- expect(await findByText('a month ago')).toBeVisible();
- expect(await findAllByRole('img')).toHaveLength(4);
-});
-
-test('renders dataset metadata bar without request', async () => {
- fetchMock.get('glob:*/api/v1/dataset/1', {
- result: {},
- });
-
+test('renders dataset metadata bar with dataset prop', async () => {
const { result } = renderHook(
() => useDatasetMetadataBar({ dataset: MOCK_DATASET }),
{
@@ -79,10 +51,8 @@ test('renders dataset metadata bar without request', async () => {
},
);
- expect(result.current.status).toEqual('complete');
-
- expect(fetchMock.called()).toBeFalsy();
- const { findByText, findAllByRole } = render(result.current.metadataBar);
+ expect(result.current.metadataBar).not.toBeNull();
+ const { findByText, findAllByRole } = render(result.current.metadataBar!);
expect(await findByText(`This is dataset's name`)).toBeVisible();
expect(await findByText('This is a dataset description')).toBeVisible();
expect(await findByText('Luke Skywalker')).toBeVisible();
@@ -90,30 +60,27 @@ test('renders dataset metadata bar without request', async () => {
expect(await findAllByRole('img')).toHaveLength(4);
});
-test('renders dataset metadata bar without description and owners', async () => {
- fetchMock.get('glob:*/api/v1/dataset/1', {
- result: {
- changed_on: '2023-01-26T12:06:58.733316',
- changed_on_humanized: 'a month ago',
- created_on: '2023-01-26T12:06:54.965034',
- created_on_humanized: 'a month ago',
- table_name: `This is dataset's name`,
- },
- });
+test('renders dataset metadata bar with minimal dataset', async () => {
+ const minimalDataset = {
+ changed_on: '2023-01-26T12:06:58.733316',
+ changed_on_humanized: 'a month ago',
+ created_on: '2023-01-26T12:06:54.965034',
+ created_on_humanized: 'a month ago',
+ table_name: `This is dataset's name`,
+ description: undefined,
+ owners: [],
+ } as any;
- const { result, waitForValueToChange } = renderHook(
- () => useDatasetMetadataBar({ datasetId: 1 }),
+ const { result } = renderHook(
+ () => useDatasetMetadataBar({ dataset: minimalDataset }),
{
wrapper: createWrapper(),
},
);
- expect(result.current.status).toEqual('loading');
- await waitForValueToChange(() => result.current.status);
- expect(result.current.status).toEqual('complete');
- expect(fetchMock.called()).toBeTruthy();
+ expect(result.current.metadataBar).not.toBeNull();
const { findByText, queryByText, findAllByRole } = render(
- result.current.metadataBar,
+ result.current.metadataBar!,
);
expect(await findByText(`This is dataset's name`)).toBeVisible();
expect(queryByText('This is a dataset description')).not.toBeInTheDocument();
diff --git a/superset-frontend/src/features/datasets/metadataBar/useDatasetMetadataBar.tsx b/superset-frontend/src/features/datasets/metadataBar/useDatasetMetadataBar.tsx
index fee37c57a2..0faa24c971 100644
--- a/superset-frontend/src/features/datasets/metadataBar/useDatasetMetadataBar.tsx
+++ b/superset-frontend/src/features/datasets/metadataBar/useDatasetMetadataBar.tsx
@@ -16,49 +16,31 @@
* specific language governing permissions and limitations
* under the License.
*/
-import { useEffect, useMemo, useState } from 'react';
+import { useMemo } from 'react';
import { css, t, useTheme } from '@superset-ui/core';
-import { Alert } from '@superset-ui/core/components';
import { Dataset } from 'src/components/Chart/types';
import MetadataBar from '@superset-ui/core/components/MetadataBar';
import {
ContentType,
MetadataType,
} from '@superset-ui/core/components/MetadataBar/ContentType';
-import { ResourceStatus } from 'src/hooks/apiResources/apiResources';
-import { cachedSupersetGet } from 'src/utils/cachedSupersetGet';
+import { isEmbedded } from 'src/dashboard/util/isEmbedded';
+
+export interface UseDatasetMetadataBarProps {
+ dataset?: Dataset;
+}
-export type UseDatasetMetadataBarProps =
- | { datasetId?: undefined; dataset: Dataset }
- | { datasetId: number | string; dataset?: undefined };
export const useDatasetMetadataBar = ({
- dataset: datasetProps,
- datasetId,
-}: UseDatasetMetadataBarProps) => {
+ dataset,
+}: UseDatasetMetadataBarProps): { metadataBar: React.ReactElement | null } => {
const theme = useTheme();
- const [result, setResult] = useState<Dataset>();
- const [status, setStatus] = useState<ResourceStatus>(
- datasetProps ? ResourceStatus.Complete : ResourceStatus.Loading,
- );
-
- useEffect(() => {
- if (!datasetProps && datasetId) {
- cachedSupersetGet({
- endpoint: `/api/v1/dataset/${datasetId}`,
- })
- .then(({ json: { result } }) => {
- setResult(result);
- setStatus(ResourceStatus.Complete);
- })
- .catch(() => {
- setStatus(ResourceStatus.Error);
- });
- }
- }, [datasetId, datasetProps]);
const metadataBar = useMemo(() => {
+ // Short-circuit for embedded users - they don't need metadata bar
+ if (isEmbedded()) {
+ return null;
+ }
const items: ContentType[] = [];
- const dataset = datasetProps || result;
if (dataset) {
const {
changed_on_humanized,
@@ -110,21 +92,14 @@ export const useDatasetMetadataBar = ({
margin-bottom: ${theme.sizeUnit * 4}px;
`}
>
- {status === ResourceStatus.Complete && (
+ {items.length > 0 && (
<MetadataBar items={items} tooltipPlacement="bottom" />
)}
- {status === ResourceStatus.Error && (
- <Alert
- type="error"
- message={t('There was an error loading the dataset metadata')}
- />
- )}
</div>
);
- }, [datasetProps, result, status, theme.sizeUnit]);
+ }, [dataset, theme.sizeUnit]);
return {
metadataBar,
- status,
};
};
diff --git a/superset/config.py b/superset/config.py
index 9d6f8244ec..d432aff29a 100644
--- a/superset/config.py
+++ b/superset/config.py
@@ -279,10 +279,11 @@ WTF_CSRF_ENABLED = True
# Add endpoints that need to be exempt from CSRF protection
WTF_CSRF_EXEMPT_LIST = [
- "superset.views.core.log",
- "superset.views.core.explore_json",
"superset.charts.data.api.data",
"superset.dashboards.api.cache_dashboard_screenshot",
+ "superset.views.core.explore_json",
+ "superset.views.core.log",
+ "superset.views.datasource.views.samples",
]
# Whether to run the web server in debug mode or not
@@ -530,6 +531,7 @@ DEFAULT_FEATURE_FLAGS: dict[str, bool] = {
# This feature flag is stil in beta and is not recommended for production use.
"GLOBAL_ASYNC_QUERIES": False,
"EMBEDDED_SUPERSET": False,
+ "DRILLING_IN_EMBEDDED": False,
# Enables Alerts and reports new implementation
"ALERT_REPORTS": False,
"ALERT_REPORT_TABS": False,
diff --git a/superset/datasets/api.py b/superset/datasets/api.py
index 098e0f6828..f7ce03e2a5 100644
--- a/superset/datasets/api.py
+++ b/superset/datasets/api.py
@@ -35,7 +35,7 @@ from flask_babel import ngettext
from jinja2.exceptions import TemplateSyntaxError
from marshmallow import ValidationError
-from superset import event_logger, is_feature_enabled
+from superset import event_logger, is_feature_enabled, security_manager
from superset.commands.dataset.create import CreateDatasetCommand
from superset.commands.dataset.delete import DeleteDatasetCommand
from superset.commands.dataset.duplicate import DuplicateDatasetCommand
@@ -58,17 +58,20 @@ from superset.commands.importers.exceptions import NoValidFilesFoundError
from superset.commands.importers.v1.utils import get_contents_from_bundle
from superset.connectors.sqla.models import SqlaTable
from superset.constants import MODEL_API_RW_METHOD_PERMISSION_MAP, RouteMethod
+from superset.daos.dashboard import DashboardDAO
from superset.daos.dataset import DatasetDAO
from superset.databases.filters import DatabaseFilter
from superset.datasets.filters import DatasetCertifiedFilter, DatasetIsNullOrEmptyFilter
from superset.datasets.schemas import (
DatasetCacheWarmUpRequestSchema,
DatasetCacheWarmUpResponseSchema,
+ DatasetDrillInfo,
DatasetDuplicateSchema,
DatasetPostSchema,
DatasetPutSchema,
DatasetRelatedObjectsResponse,
get_delete_ids_schema,
+ get_drill_info_schema,
get_export_ids_schema,
GetOrCreateDatasetSchema,
openapi_spec_methods_override,
@@ -110,6 +113,7 @@ class DatasetRestApi(BaseSupersetModelRestApi):
"duplicate",
"get_or_create_dataset",
"warm_up_cache",
+ "get_drill_info",
}
list_columns = [
"id",
@@ -1174,6 +1178,95 @@ class DatasetRestApi(BaseSupersetModelRestApi):
return self.response_400(message=str(ex))
return self.response(200, **response)
+ @expose("/<int:pk>/drill_info/", methods=("GET",))
+ @protect()
+ @rison(get_drill_info_schema)
+ @safe
+ @statsd_metrics
+ def get_drill_info(self, pk: int, **kwargs: Any) -> Response:
+ """Get dataset drill info.
+ ---
+ get:
+ summary: Get dataset drill info
+ parameters:
+ - in: path
+ schema:
+ type: integer
+ name: pk
+ description: The dataset ID
+ responses:
+ 200:
+ description: Dataset drill info
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ result:
+ type: object
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 404:
+ $ref: '#/components/responses/404'
+ 422:
+ $ref: '#/components/responses/422'
+ 500:
+ $ref: '#/components/responses/500'
+ """
+ dashboard_id = kwargs["rison"].get("dashboard_id")
+ embedded_user = security_manager.is_guest_user()
+ embedded_drilling_enabled = is_feature_enabled("DRILLING_IN_EMBEDDED")
+ # Short circuit embedded access if disabled
+ if embedded_user and not embedded_drilling_enabled:
+ return self.response_403()
+
+ drill_info_select_columns = [
+ "id",
+ "table_name",
+ "owners.first_name",
+ "owners.last_name",
+ "created_by.first_name",
+ "created_by.last_name",
+ "created_on_humanized",
+ "changed_by.first_name",
+ "changed_by.last_name",
+ "changed_on_humanized",
+ "columns.column_name",
+ "columns.verbose_name",
+ "columns.groupby",
+ ]
+ # First try with regular access
+ dataset: SqlaTable | None = self.datamodel.get(
+ pk,
+ self._base_filters,
+ drill_info_select_columns,
+ self.show_outer_default_load,
+ )
+ if not dataset and dashboard_id:
+ # Lazy load the dashboard and dataset for RBAC/embedded access check
+ dashboard = DashboardDAO.find_by_id(dashboard_id, skip_base_filter=True)
+ dataset_ = DatasetDAO.find_by_id(pk, skip_base_filter=True)
+ if not dashboard or not dataset_:
+ return self.response_404()
+ if security_manager.can_drill_dataset_via_dashboard_access(
+ dataset_,
+ dashboard,
+ ):
+ # Load dataset again skipping base filters
+ # We don't use `dataset_` to avoid lazy loading columns
+ dataset = self.datamodel.get(
+ pk,
+ None,
+ drill_info_select_columns,
+ self.show_outer_default_load,
+ )
+ if not dataset:
+ return self.response_404()
+ dataset_schema = DatasetDrillInfo()
+ return self.response(200, result=dataset_schema.dump(dataset))
+
@staticmethod
def render_dataset_fields(
data: dict[str, Any], processor: BaseTemplateProcessor
diff --git a/superset/datasets/schemas.py b/superset/datasets/schemas.py
index aba2283ef2..7406efefd5 100644
--- a/superset/datasets/schemas.py
+++ b/superset/datasets/schemas.py
@@ -19,14 +19,29 @@ from typing import Any
from dateutil.parser import isoparse
from flask_babel import lazy_gettext as _
-from marshmallow import fields, pre_load, Schema, validates_schema, ValidationError
+from marshmallow import (
+ fields,
+ post_dump,
+ pre_load,
+ Schema,
+ validates_schema,
+ ValidationError,
+)
from marshmallow.validate import Length, OneOf
+from superset import security_manager
+from superset.connectors.sqla.models import SqlaTable
from superset.exceptions import SupersetMarshmallowValidationError
from superset.utils import json
get_delete_ids_schema = {"type": "array", "items": {"type": "integer"}}
get_export_ids_schema = {"type": "array", "items": {"type": "integer"}}
+get_drill_info_schema = {
+ "type": "object",
+ "properties": {
+ "dashboard_id": {"type": "integer"},
+ },
+}
openapi_spec_methods_override = {
"get_list": {
@@ -373,3 +388,48 @@ class DatasetCacheWarmUpResponseSchema(Schema):
"description": "A list of each chart's warmup status and errors if any"
},
)
+
+
+class DatasetColumnDrillInfo(Schema):
+ column_name = fields.String(required=True)
+ verbose_name = fields.String(required=False)
+
+
+class UserSchema(Schema):
+ first_name = fields.String()
+ last_name = fields.String()
+
+
+class DatasetDrillInfo(Schema):
+ id = fields.Integer()
+ columns = fields.List(fields.Nested(DatasetColumnDrillInfo))
+ table_name = fields.String()
+ owners = fields.List(fields.Nested(UserSchema))
+ created_by = fields.Nested(UserSchema)
+ created_on_humanized = fields.String()
+ changed_by = fields.Nested(UserSchema)
+ changed_on_humanized = fields.String()
+
+ # pylint: disable=unused-argument
+ @post_dump(pass_original=True)
+ def post_dump(
+ self, serialized: dict[str, Any], obj: SqlaTable, **kwargs: Any
+ ) -> dict[str, Any]:
+ """
+ Clear API response to avoid exposing sensitive information for embedded users,
+ and filter columns to only include those with groupby=True for drill operations.
+ """
+ dimensions = {
+ col.column_name
+ for col in getattr(obj, "columns", [])
+ if getattr(col, "groupby", False)
+ }
+ serialized["columns"] = [
+ col
+ for col in serialized.get("columns", [])
+ if col["column_name"] in dimensions
+ ]
+
+ if security_manager.is_guest_user():
+ return {"id": serialized["id"], "columns": serialized["columns"]}
+ return serialized
diff --git a/superset/security/manager.py b/superset/security/manager.py
index 884152b195..d75f048faa 100644
--- a/superset/security/manager.py
+++ b/superset/security/manager.py
@@ -565,6 +565,30 @@ class SupersetSecurityManager( # pylint: disable=too-many-public-methods
return True
+ def can_drill_dataset_via_dashboard_access(
+ self, dataset: "BaseDatasource", dashboard: "Dashboard"
+ ) -> bool:
+ """
+ Return True if an embedded user or DASHBOARD_RBAC user can drill a dataset.
+ """
+ from superset import is_feature_enabled
+
+ if (
+ self.can_access_dashboard(dashboard)
+ and dataset.id in {dataset.id for dataset in dashboard.datasources}
+ and (
+ (not self.is_guest_user() and is_feature_enabled("DASHBOARD_RBAC"))
+ or (
+ self.is_guest_user()
+ and is_feature_enabled("EMBEDDED_SUPERSET")
+ and is_feature_enabled("DRILLING_IN_EMBEDDED")
+ )
+ )
+ ):
+ return True
+
+ return False
+
def can_access_dashboard(self, dashboard: "Dashboard") -> bool:
"""
Return True if the user can access the specified dashboard, False otherwise.
@@ -2228,7 +2252,7 @@ class SupersetSecurityManager( # pylint: disable=too-many-public-methods
"""
# pylint: disable=import-outside-toplevel
from superset import is_feature_enabled
- from superset.connectors.sqla.models import SqlaTable
+ from superset.connectors.sqla.models import SqlaTable, TableColumn
from superset.models.dashboard import Dashboard
from superset.models.slice import Slice
from superset.models.sql_lab import Query
@@ -2396,6 +2420,32 @@ class SupersetSecurityManager( # pylint: disable=too-many-public-methods
and slc in dashboard_.slices
and slc.datasource == datasource
)
+ or (
+ # D2D
+ form_data.get("type") != "NATIVE_FILTER"
+ and form_data.get("slice_id") == 0
+ and (chart_id := form_data.get("chart_id"))
+ and (
+ slc := self.get_session.query(Slice)
+ .filter(Slice.id == chart_id)
+ .one_or_none()
+ )
+ and slc in dashboard_.slices
+ and slc.datasource == datasource
+ and (dimensions := form_data.get("groupby"))
+ and (
+ drillable_columns := {
+ row[0]
+ for row in self.get_session.query(
+ TableColumn.column_name
+ )
+ .filter(TableColumn.table_id == datasource.id)
+ .filter(TableColumn.groupby)
+ .all()
+ }
+ )
+ and set(dimensions).issubset(drillable_columns)
+ )
)
and self.can_access_dashboard(dashboard_)
)
diff --git a/superset/views/datasource/views.py b/superset/views/datasource/views.py
index c06080c6fe..c56b25ba9e 100644
--- a/superset/views/datasource/views.py
+++ b/superset/views/datasource/views.py
@@ -25,7 +25,7 @@ from flask_babel import _
from marshmallow import ValidationError
from sqlalchemy.exc import NoResultFound, NoSuchTableError
-from superset import db, event_logger, security_manager
+from superset import db, event_logger, feature_flag_manager, security_manager
from superset.commands.dataset.exceptions import (
DatasetForbiddenError,
DatasetNotFoundError,
@@ -194,6 +194,13 @@ class Datasource(BaseSupersetView):
@api
@handle_api_exception
def samples(self) -> FlaskResponse:
+ if (
+ security_manager.is_guest_user()
+ and not feature_flag_manager.is_feature_enabled("DRILLING_IN_EMBEDDED")
+ ):
+ return json_error_response(
+ _("Drill by is not available for embedded users"), status=403
+ )
try:
params = SamplesRequestSchema().load(request.args)
payload = SamplesPayloadSchema().load(request.json)
diff --git a/tests/integration_tests/charts/data/api_tests.py b/tests/integration_tests/charts/data/api_tests.py
index cd95f743a6..3ad56fb5f5 100644
--- a/tests/integration_tests/charts/data/api_tests.py
+++ b/tests/integration_tests/charts/data/api_tests.py
@@ -980,6 +980,80 @@ class TestPostChartDataApi(BaseTestChartDataApi):
assert "name" in result["query"]
assert list(result["data"][0].keys()) == ["name", "num divide by 10"]
+ @pytest.mark.usefixtures("load_birth_names_dashboard_with_slices")
+ def test_drill_by_allowed_column_regular_user(self):
+ """
+ Chart data API: Test that regular user can drill by column with
+ isDimension set to True
+ """
+ self.query_context_payload["queries"][0]["columns"] = ["name"]
+ rv = self.post_assert_metric(CHART_DATA_URI, self.query_context_payload, "data")
+ assert rv.status_code == 200
+
+ @pytest.mark.usefixtures("load_birth_names_dashboard_with_slices")
+ def test_drill_by_disallowed_column_regular_user(self):
+ """
+ Chart data API: Test that regular user can't drill by column with
+ isDimension set to False
+ """
+ self.query_context_payload["queries"][0]["columns"] = ["num_girls"]
+ rv = self.post_assert_metric(CHART_DATA_URI, self.query_context_payload, "data")
+ assert rv.status_code == 403
+
+ @pytest.mark.usefixtures("load_birth_names_dashboard_with_slices")
+ @mock.patch("superset.security.manager.SupersetSecurityManager.has_guest_access")
+ @mock.patch("superset.security.manager.SupersetSecurityManager.is_guest_user")
+ @with_feature_flags(D2D_IN_EMBEDDED=False)
+ def test_embedded_user_drill_by_disabled_ff(
+ self, mock_is_guest_user, mock_has_guest_access
+ ):
+ """
+ Chart data API: Test that embedded user cannot drill when
+ DRILLING_IN_EMBEDDED FF is disabled
+ """
+ g.user.rls = []
+ mock_has_guest_access.return_value = True
+ mock_is_guest_user.return_value = True
+ self.query_context_payload["queries"][0]["columns"] = ["name"]
+ rv = self.post_assert_metric(CHART_DATA_URI, self.query_context_payload, "data")
+ assert rv.status_code == 403
+
+ @pytest.mark.usefixtures("load_birth_names_dashboard_with_slices")
+ @mock.patch("superset.security.manager.SupersetSecurityManager.has_guest_access")
+ @mock.patch("superset.security.manager.SupersetSecurityManager.is_guest_user")
+ @with_feature_flags(D2D_IN_EMBEDDED=True)
+ def test_embedded_user_drill_by_enabled_ff_allowed_column(
+ self, mock_is_guest_user, mock_has_guest_access
+ ):
+ """
+ Chart data API: Test that embedded user can drill by column with
+ isDimension set to True when DRILLING_IN_EMBEDDED FF is enabled
+ """
+ g.user.rls = []
+ mock_has_guest_access.return_value = True
+ mock_is_guest_user.return_value = True
+ self.query_context_payload["queries"][0]["columns"] = ["name"]
+ rv = self.post_assert_metric(CHART_DATA_URI, self.query_context_payload, "data")
+ assert rv.status_code == 200
+
+ @pytest.mark.usefixtures("load_birth_names_dashboard_with_slices")
+ @mock.patch("superset.security.manager.SupersetSecurityManager.has_guest_access")
+ @mock.patch("superset.security.manager.SupersetSecurityManager.is_guest_user")
+ @with_feature_flags(D2D_IN_EMBEDDED=True)
+ def test_embedded_user_drill_by_enabled_ff_disallowed_column(
+ self, mock_is_guest_user, mock_has_guest_access
+ ):
+ """
+ Chart data API: Test that embedded user can't drill by column with
+ isDimension set to False and DRILLING_IN_EMBEDDED FF is enabled
+ """
+ g.user.rls = []
+ mock_has_guest_access.return_value = True
+ mock_is_guest_user.return_value = True
+ self.query_context_payload["queries"][0]["columns"] = ["num_girls"]
+ rv = self.post_assert_metric(CHART_DATA_URI, self.query_context_payload, "data")
+ assert rv.status_code == 403
+
@pytest.mark.chart_data_flow
class TestGetChartDataApi(BaseTestChartDataApi):
diff --git a/tests/integration_tests/datasets/api_tests.py b/tests/integration_tests/datasets/api_tests.py
index 2906a6612e..efa7b5bc6d 100644
--- a/tests/integration_tests/datasets/api_tests.py
+++ b/tests/integration_tests/datasets/api_tests.py
@@ -85,16 +85,21 @@ class TestDatasetApi(SupersetTestCase):
def insert_dataset(
table_name: str,
owners: list[int],
- database: Database,
+ database: Database | None = None,
sql: str | None = None,
schema: str | None = None,
catalog: str | None = None,
fetch_metadata: bool = True,
+ columns: list[TableColumn] | None = None,
+ metrics: list[SqlMetric] | None = None,
+ extra: str | None = None,
) -> SqlaTable:
obj_owners = list() # noqa: C408
for owner in owners:
user = db.session.query(security_manager.user_model).get(owner)
obj_owners.append(user)
+ database = database or get_example_database()
+ schema = schema or get_example_default_schema()
table = SqlaTable(
table_name=table_name,
schema=schema,
@@ -102,13 +107,36 @@ class TestDatasetApi(SupersetTestCase):
database=database,
sql=sql,
catalog=catalog,
+ extra=extra,
)
+ if columns:
+ table.columns = columns
+ if metrics:
+ table.metrics = metrics
db.session.add(table)
db.session.commit()
if fetch_metadata:
table.fetch_metadata()
return table
+ @staticmethod
+ def insert_chart(
+ chart_title: str,
+ dataset_id: int,
+ viz_type: str = "bar",
+ params: str = "{}",
+ ) -> Slice:
+ chart = Slice(
+ slice_name=chart_title,
+ datasource_id=dataset_id,
+ datasource_type="table",
+ viz_type=viz_type,
+ params=params,
+ )
+ db.session.add(chart)
+ db.session.commit()
+ return chart
+
def insert_default_dataset(self):
return self.insert_dataset(
"ab_permission", [self.get_user("admin").id], get_main_database()
@@ -179,6 +207,24 @@ class TestDatasetApi(SupersetTestCase):
db.session.delete(dataset)
db.session.commit()
+ @pytest.fixture
+ def gamma_role_with_drill_perm(self):
+ """
+ Add `can_get_drill_info` permission to Gamma role.
+
+ We're using the Gamma role for these tests to simulate the embedded role.
+ """
+ with self.create_app().app_context():
+ drill_info_perm = security_manager.add_permission_view_menu(
+ "can_get_drill_info", "Dataset"
+ )
+ gamma_role = security_manager.find_role("Gamma")
+ security_manager.add_permission_role(gamma_role, drill_info_perm)
+
+ yield gamma_role
+
+ security_manager.del_permission_role(gamma_role, drill_info_perm)
+
@staticmethod
def get_energy_usage_dataset():
example_db = get_example_database()
@@ -422,12 +468,11 @@ class TestDatasetApi(SupersetTestCase):
"""
Dataset API: Test get dataset with the render parameter.
"""
- database = get_example_database()
- dataset = SqlaTable(
+ dataset = self.insert_dataset(
table_name="test_sql_table_with_jinja",
- database=database,
- schema=get_example_default_schema(),
- main_dttm_col="default_dttm",
+ owners=[],
+ sql="SELECT {{ current_user_id() }} as my_user_id",
+ fetch_metadata=False,
columns=[
TableColumn(
column_name="my_user_id",
@@ -447,10 +492,7 @@ class TestDatasetApi(SupersetTestCase):
expression="{{ url_param('multiplier') }} * 1.4",
)
],
- sql="SELECT {{ current_user_id() }} as my_user_id",
)
- db.session.add(dataset)
- db.session.commit()
self.login(ADMIN_USERNAME)
admin = self.get_user(ADMIN_USERNAME)
@@ -494,12 +536,11 @@ class TestDatasetApi(SupersetTestCase):
Dataset API: Test get dataset with the render parameter
when rendering raises an exception.
"""
- database = get_example_database()
- dataset = SqlaTable(
+ dataset = self.insert_dataset(
table_name="test_sql_table_with_incorrect_jinja",
- database=database,
- schema=get_example_default_schema(),
- main_dttm_col="default_dttm",
+ owners=[],
+ sql="SELECT {{ current_user_id() } as my_user_id",
+ fetch_metadata=False,
columns=[
TableColumn(
column_name="my_user_id",
@@ -519,10 +560,7 @@ class TestDatasetApi(SupersetTestCase):
expression="{{ url_param('multiplier') } * 1.4",
)
],
- sql="SELECT {{ current_user_id() } as my_user_id",
)
- db.session.add(dataset)
- db.session.commit()
self.login(ADMIN_USERNAME)
@@ -680,6 +718,7 @@ class TestDatasetApi(SupersetTestCase):
"can_duplicate",
"can_get_or_create_dataset",
"can_warm_up_cache",
+ "can_get_drill_info",
}
def test_create_dataset_item(self):
@@ -2717,17 +2756,12 @@ class TestDatasetApi(SupersetTestCase):
"""
Dataset API: Test custom dataset_is_certified filter
"""
-
- table_w_certification = SqlaTable(
+ table_w_certification = self.insert_dataset(
table_name="foo",
- schema=None,
owners=[],
- database=get_main_database(),
- sql=None,
+ fetch_metadata=False,
extra='{"certification": 1}',
)
- db.session.add(table_w_certification)
- db.session.commit()
arguments = {
"filters": [{"col": "id", "opr": "dataset_is_certified", "value": True}]
@@ -3000,3 +3034,353 @@ class TestDatasetApi(SupersetTestCase):
assert data == {
"message": "The provided table was not found in the provided database"
}
+
+ def test_get_drill_info_admin_user(self):
+ """
+ Dataset API: Test drill_info endpoint returns metadata for admin users, even
+ without a dashboard param.
+ """
+ self.login(ADMIN_USERNAME)
+ dataset = self.insert_dataset(
+ table_name="test_drill_dataset",
+ owners=[],
+ columns=[
+ TableColumn(
+ column_name="category",
+ type="VARCHAR(255)",
+ verbose_name="Category Column",
+ groupby=True,
+ ),
+ TableColumn(
+ column_name="region",
+ type="VARCHAR(255)",
+ groupby=True,
+ ),
+ TableColumn(
+ column_name="value",
+ type="VARCHAR(255)",
+ groupby=False,
+ ),
+ TableColumn(
+ column_name="description",
+ type="VARCHAR(255)",
+ groupby=False,
+ ),
+ ],
+ fetch_metadata=False,
+ )
+
+ # Test the drill_info endpoint
+ uri = f"api/v1/dataset/{dataset.id}/drill_info/"
+ rv = self.get_assert_metric(uri, "get_drill_info")
+ assert rv.status_code == 200
+
+ data = json.loads(rv.data.decode("utf-8"))
+ result = data["result"]
+
+ # Verify admin gets full dataset metadata
+ assert "created_by" in result
+ assert "created_on_humanized" in result
+ assert "changed_by" in result
+ assert "changed_on_humanized" in result
+ assert result["id"] == dataset.id
+ assert result["table_name"] == "test_drill_dataset"
+ assert result["owners"] == []
+ assert len(result["columns"]) == 2
+ assert result["columns"] == [
+ {"column_name": "category", "verbose_name": "Category Column"},
+ {"column_name": "region", "verbose_name": None},
+ ]
+
+ self.items_to_delete = [dataset]
+
+ def test_get_drill_info_dataset_not_found(self):
+ """
+ Dataset API: Test drill_info endpoint returns 404 for non-existent dataset
+ """
+ self.login(ADMIN_USERNAME)
+ uri = "api/v1/dataset/99999/drill_info/"
+ rv = self.client.get(uri)
+
+ assert rv.status_code == 404
+
+ @pytest.mark.usefixtures("gamma_role_with_drill_perm")
+ @patch("superset.security.manager.SupersetSecurityManager.has_guest_access")
+ @patch("superset.security.manager.SupersetSecurityManager.is_guest_user")
+ @with_feature_flags(EMBEDDED_SUPERSET=True, DRILLING_IN_EMBEDDED=False)
+ def test_get_drill_info_embedded_user_feature_disabled(
+ self, mock_is_guest_user, mock_has_guest_access
+ ):
+ """
+ Dataset API: Test drill_info endpoint returns 403 for embedded users when
+ FF is disabled.
+ """
+ # Log the user as Gamma but mock ``is_guest_user``
+ self.login(GAMMA_USERNAME)
+ mock_is_guest_user.return_value = True
+ mock_has_guest_access.return_value = True
+
+ dataset = self.insert_dataset(table_name="foo", owners=[], fetch_metadata=False)
+ uri = f"api/v1/dataset/{dataset.id}/drill_info/"
+ rv = self.client.get(uri)
+
+ assert rv.status_code == 403
+
+ self.items_to_delete = [dataset]
+
+ @pytest.mark.usefixtures("gamma_role_with_drill_perm")
+ @patch("superset.security.manager.SupersetSecurityManager.has_guest_access")
+ @patch("superset.security.manager.SupersetSecurityManager.is_guest_user")
+ @with_feature_flags(EMBEDDED_SUPERSET=True, DRILLING_IN_EMBEDDED=True)
+ def test_get_drill_info_embedded_user_with_dashboard_id(
+ self, mock_is_guest_user, mock_has_guest_access
+ ):
+ """
+ Dataset API: Test drill_info endpoint with dashboard ID parameter for
+ embedded users.
+ """
+ # Log the user as Gamma but mock ``is_guest_user``
+ self.login(GAMMA_USERNAME)
+ mock_is_guest_user.return_value = True
+ mock_has_guest_access.return_value = True
+
+ dataset = self.insert_dataset(
+ table_name="test_embedded_dataset",
+ owners=[],
+ columns=[
+ TableColumn(
+ column_name="category",
+ type="VARCHAR(255)",
+ verbose_name="Category Column",
+ groupby=True,
+ ),
+ TableColumn(
+ column_name="region",
+ type="VARCHAR(255)",
+ groupby=True,
+ ),
+ ],
+ fetch_metadata=False,
+ )
+
+ chart = self.insert_chart("Test Embedded Chart", dataset.id)
+ dashboard = self.insert_dashboard(
+ "Embedded Test Dashboard", "embedded-test-dashboard", [], slices=[chart]
+ )
+
+ uri = f"api/v1/dataset/{dataset.id}/drill_info/?q=(dashboard_id:{dashboard.id})"
+ rv = self.client.get(uri)
+
+ assert rv.status_code == 200
+ data = json.loads(rv.data.decode("utf-8"))
+ result = data["result"]
+ assert result == {
+ "id": dataset.id,
+ "columns": [
+ {"column_name": "category", "verbose_name": "Category Column"},
+ {"column_name": "region", "verbose_name": None},
+ ],
+ }
+
+ self.items_to_delete = [dataset, dashboard, chart]
+
+ @pytest.mark.usefixtures("gamma_role_with_drill_perm")
+ @patch("superset.security.manager.SupersetSecurityManager.has_guest_access")
+ @patch("superset.security.manager.SupersetSecurityManager.is_guest_user")
+ @with_feature_flags(EMBEDDED_SUPERSET=True, DRILLING_IN_EMBEDDED=True)
+ def test_get_drill_info_embedded_user_without_dashboard_parameter(
+ self, mock_is_guest_user, mock_has_guest_access
+ ):
+ """
+ Dataset API: Test drill_info endpoint without dashboard ID parameter
+ for embedded users.
+ """
+ # Log the user as Gamma but mock ``is_guest_user``
+ self.login(GAMMA_USERNAME)
+ mock_is_guest_user.return_value = True
+ mock_has_guest_access.return_value = True
+
+ dataset = self.insert_dataset(
+ table_name="test_no_dashboard_param",
+ owners=[],
+ columns=[
+ TableColumn(
+ column_name="category",
+ type="VARCHAR(255)",
+ groupby=True,
+ ),
+ ],
+ fetch_metadata=False,
+ )
+
+ uri = f"api/v1/dataset/{dataset.id}/drill_info/"
+ rv = self.client.get(uri)
+
+ assert rv.status_code == 404
+
+ self.items_to_delete = [dataset]
+
+ @pytest.mark.usefixtures("gamma_role_with_drill_perm")
+ @patch("superset.security.manager.SupersetSecurityManager.has_guest_access")
+ @patch("superset.security.manager.SupersetSecurityManager.is_guest_user")
+ @with_feature_flags(EMBEDDED_SUPERSET=True, DRILLING_IN_EMBEDDED=True)
+ def test_get_drill_info_embedded_user_dashboard_without_dataset(
+ self, mock_is_guest_user, mock_has_guest_access
+ ):
+ """
+ Dataset API: Test drill_info with dashboard ID that user has access to but
+ does not contain the dataset.
+ """
+ # Log the user as Gamma but mock ``is_guest_user``
+ self.login(GAMMA_USERNAME)
+ mock_is_guest_user.return_value = True
+ mock_has_guest_access.return_value = True
+
+ dataset = self.insert_dataset(
+ table_name="test_d2d_table",
+ owners=[],
+ columns=[
+ TableColumn(
+ column_name="category",
+ type="VARCHAR(255)",
+ groupby=True,
+ ),
+ ],
+ fetch_metadata=False,
+ )
+ dashboard_dataset = self.insert_dataset(
+ table_name="test_dashboard_dataset",
+ owners=[],
+ fetch_metadata=False,
+ )
+ chart = self.insert_chart("Dashboard Chart", dashboard_dataset.id)
+ dashboard = self.insert_dashboard(
+ "Dashboard Without Test Dataset",
+ "dashboard-without-test-dataset",
+ [],
+ slices=[chart],
+ )
+
+ uri = f"api/v1/dataset/{dataset.id}/drill_info/?q=(dashboard_id:{dashboard.id})"
+ rv = self.client.get(uri)
+
+ assert rv.status_code == 404
+
+ self.items_to_delete = [dataset, dashboard_dataset, dashboard, chart]
+
+ @pytest.mark.usefixtures("gamma_role_with_drill_perm")
+ @with_feature_flags(DASHBOARD_RBAC=True)
+ def test_get_drill_info_dashboard_rbac_access_granted(self):
+ """
+ Dataset API: Test drill_info with dashboard parameter when user has access
+ via the DASHBOARD_RBAC FF.
+ """
+ self.login(GAMMA_USERNAME)
+ gamma_role = security_manager.find_role("Gamma")
+
+ dataset = self.insert_dataset(
+ table_name="test_rbac_dataset",
+ owners=[],
+ columns=[
+ TableColumn(
+ column_name="restricted_column",
+ type="VARCHAR(255)",
+ verbose_name="Restricted Column",
+ groupby=True,
+ ),
+ ],
+ fetch_metadata=False,
+ )
+ chart = self.insert_chart("Test RBAC Chart", dataset.id)
+ dashboard = self.insert_dashboard(
+ "RBAC Test Dashboard",
+ "rbac-test-dashboard",
+ [],
+ roles=[gamma_role.id],
+ slices=[chart],
+ published=True,
+ )
+
+ uri = f"api/v1/dataset/{dataset.id}/drill_info/?q=(dashboard_id:{dashboard.id})"
+ rv = self.client.get(uri)
+
+ assert rv.status_code == 200
+ data = json.loads(rv.data.decode("utf-8"))
+ result = data["result"]
+
+ assert "created_by" in result
+ assert "created_on_humanized" in result
+ assert "changed_by" in result
+ assert "changed_on_humanized" in result
+ assert result["id"] == dataset.id
+ assert result["table_name"] == "test_rbac_dataset"
+ assert len(result["columns"]) == 1
+ assert result["columns"][0]["column_name"] == "restricted_column"
+
+ self.items_to_delete = [dashboard, chart, dataset]
+
+ @pytest.mark.usefixtures("gamma_role_with_drill_perm")
+ @with_feature_flags(DASHBOARD_RBAC=True)
+ def test_get_drill_info_dashboard_rbac_access_denied(self):
+ """
+ Dataset API: Test drill_info with dashboard parameter when user has
+ no access via the DASHBOARD_RBAC FF.
+ """
+ self.login(GAMMA_USERNAME)
+
+ dataset = self.insert_dataset(
+ table_name="test_rbac_dataset_denied",
+ owners=[],
+ columns=[
+ TableColumn(
+ column_name="restricted_column",
+ type="VARCHAR(255)",
+ groupby=True,
+ ),
+ ],
+ fetch_metadata=False,
+ )
+ chart = self.insert_chart("Test RBAC Chart second", dataset.id)
+ dashboard = self.insert_dashboard(
+ "RBAC Test Dashboard 2",
+ "rbac-test-dashboard-2",
+ [],
+ slices=[chart],
+ published=True,
+ )
+
+ uri = f"api/v1/dataset/{dataset.id}/drill_info/?q=(dashboard_id:{dashboard.id})"
+ rv = self.client.get(uri)
+
+ assert rv.status_code == 404
+
+ self.items_to_delete = [dashboard, chart, dataset]
+
+ @pytest.mark.usefixtures("gamma_role_with_drill_perm")
+ @with_feature_flags(DASHBOARD_RBAC=True)
+ def test_get_drill_info_dashboard_rbac_no_dashboard_id(self):
+ """
+ Dataset API: Test drill_info without dashboard ID parameter falls back
+ to regular access control.
+ """
+ self.login(GAMMA_USERNAME)
+
+ dataset = self.insert_dataset(
+ table_name="test_no_dashboard_id",
+ owners=[],
+ columns=[
+ TableColumn(
+ column_name="restricted_column",
+ type="VARCHAR(255)",
+ groupby=True,
+ ),
+ ],
+ fetch_metadata=False,
+ )
+
+ uri = f"api/v1/dataset/{dataset.id}/drill_info/"
+ rv = self.client.get(uri)
+
+ assert rv.status_code == 404
+
+ self.items_to_delete = [dataset]
diff --git a/tests/integration_tests/datasource_tests.py b/tests/integration_tests/datasource_tests.py
index 21162ca52d..ddd07809b3 100644
--- a/tests/integration_tests/datasource_tests.py
+++ b/tests/integration_tests/datasource_tests.py
@@ -515,6 +515,44 @@ class TestDatasource(SupersetTestCase):
resp = self.get_json_resp("/datasource/get/druid/500000/", raise_on_error=False)
assert resp.get("error") == "'druid' is not a valid DatasourceType"
+ @pytest.mark.usefixtures("load_birth_names_dashboard_with_slices")
+ @mock.patch("superset.security.manager.SupersetSecurityManager.is_guest_user")
+ @with_feature_flags(DRILLING_IN_EMBEDDED=False)
+ def test_samples_endpoint_embedded_user_ff_disabled(self, mock_is_guest_user):
+ """
+ Embedded user cannot access the /samples view when the DRILLING_IN_EMBEDDED
+ FF is disabled.
+ """
+ # log as admin to bypass endpoint perm check
+ self.login(ADMIN_USERNAME)
+ mock_is_guest_user.return_value = True
+ tbl = self.get_table(name="birth_names")
+ uri = f"/datasource/samples?datasource_id={tbl.id}&datasource_type=table"
+ resp = self.client.post(uri, json={})
+ assert resp.status_code == 403
+
+ @pytest.mark.usefixtures("load_birth_names_dashboard_with_slices")
+ @mock.patch(
+ "superset.security.manager.SupersetSecurityManager.get_guest_rls_filters"
+ )
+ @mock.patch("superset.security.manager.SupersetSecurityManager.is_guest_user")
+ @with_feature_flags(DRILLING_IN_EMBEDDED=True)
+ def test_samples_endpoint_embedded_user_ff_enabled(
+ self, mock_is_guest_user, mock_rls
+ ):
+ """
+ Embedded user can access the /samples view when the DRILLING_IN_EMBEDDED
+ FF is enabled.
+ """
+ # log as admin to bypass endpoint perm check
+ self.login(ADMIN_USERNAME)
+ mock_is_guest_user.return_value = True
+ mock_rls.return_value = []
+ tbl = self.get_table(name="birth_names")
+ uri = f"/datasource/samples?datasource_id={tbl.id}&datasource_type=table"
+ resp = self.client.post(uri, json={})
+ assert resp.status_code == 200
+
def test_get_samples(test_client, login_as_admin, virtual_dataset):
"""