feat: Flow for tables that already have a dataset #22136
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,12 +17,14 @@ | |
| * under the License. | ||
| */ | ||
| import React from 'react'; | ||
| import { t, styled, useTheme } from '@superset-ui/core'; | ||
| import Icons from 'src/components/Icons'; | ||
| import Alert from 'src/components/Alert'; | ||
| import Table, { ColumnsType, TableSize } from 'src/components/Table'; | ||
| import { alphabeticalSort } from 'src/components/Table/sorters'; | ||
| // @ts-ignore | ||
| import LOADING_GIF from 'src/assets/images/loading.gif'; | ||
| import { DatasetObject } from 'src/views/CRUD/data/dataset/AddDataset/types'; | ||
| import { ITableColumn } from './types'; | ||
| import MessageContent from './MessageContent'; | ||
|
|
||
|
|
@@ -53,43 +55,56 @@ const HALF = 0.5; | |
| const MARGIN_MULTIPLIER = 3; | ||
|
|
||
| const StyledHeader = styled.div<StyledHeaderProps>` | ||
| ${({ theme }) => ` | ||
| position: ${(props: StyledHeaderProps) => props.position}; | ||
| margin: ${theme.gridUnit * (MARGIN_MULTIPLIER + 1)}px | ||
| ${theme.gridUnit * MARGIN_MULTIPLIER}px | ||
| ${theme.gridUnit * MARGIN_MULTIPLIER}px | ||
| ${theme.gridUnit * (MARGIN_MULTIPLIER + 3)}px; | ||
| font-size: ${theme.gridUnit * 6}px; | ||
| font-weight: ${theme.typography.weights.medium}; | ||
| padding-bottom: ${theme.gridUnit * MARGIN_MULTIPLIER}px; | ||
|
|
||
| white-space: nowrap; | ||
| overflow: hidden; | ||
| text-overflow: ellipsis; | ||
|
|
||
| .anticon:first-of-type { | ||
| margin-right: ${theme.gridUnit * (MARGIN_MULTIPLIER + 1)}px; | ||
| } | ||
|
|
||
| .anticon:nth-of-type(2) { | ||
| margin-left: ${theme.gridUnit * (MARGIN_MULTIPLIER + 1)}px; | ||
| `} | ||
| `; | ||
|
|
||
| const StyledTitle = styled.div` | ||
| ${({ theme }) => ` | ||
| margin-left: ${theme.gridUnit * (MARGIN_MULTIPLIER + 3)}px; | ||
| margin-bottom: ${theme.gridUnit * MARGIN_MULTIPLIER}px; | ||
| font-weight: ${theme.typography.weights.bold}; | ||
| `} | ||
| `; | ||
|
|
||
| const LoaderContainer = styled.div` | ||
| ${({ theme }) => ` | ||
| padding: ${theme.gridUnit * 8}px | ||
| ${theme.gridUnit * 6}px; | ||
| box-sizing: border-box; | ||
| display: flex; | ||
| align-items: center; | ||
| justify-content: center; | ||
| height: 100%; | ||
| position: absolute; | ||
| top: 0; | ||
| bottom: 0; | ||
| left: 0; | ||
| right: 0; | ||
| `} | ||
| `; | ||
|
|
||
| const StyledLoader = styled.div` | ||
| ${({ theme }) => ` | ||
| max-width: 50%; | ||
| width: ${LOADER_WIDTH}px; | ||
|
|
||
|
|
@@ -100,19 +115,23 @@ const StyledLoader = styled.div` | |
|
|
||
| div { | ||
| width: 100%; | ||
| margin-top: ${theme.gridUnit * MARGIN_MULTIPLIER}px; | ||
| text-align: center; | ||
| font-weight: ${theme.typography.weights.normal}; | ||
| font-size: ${theme.typography.sizes.l}px; | ||
| color: ${theme.colors.grayscale.light1}; | ||
| } | ||
| `} | ||
| `; | ||
|
|
||
| const TableContainer = styled.div` | ||
| ${({ theme }) => ` | ||
| position: relative; | ||
| margin: ${theme.gridUnit * MARGIN_MULTIPLIER}px; | ||
| margin-left: ${theme.gridUnit * (MARGIN_MULTIPLIER + 3)}px; | ||
| overflow: scroll; | ||
| height: calc(100% - ${theme.gridUnit * 36}px); | ||
| `} | ||
| `; | ||
|
|
||
| const StyledTable = styled(Table)` | ||
|
|
@@ -123,6 +142,26 @@ const StyledTable = styled(Table)` | |
| right: 0; | ||
| `; | ||
|
|
||
| const StyledAlert = styled(Alert)` | ||
| ${({ theme }) => ` | ||
| border: 1px solid ${theme.colors.info.base}; | ||
| padding: ${theme.gridUnit * 4}px; | ||
| margin: ${theme.gridUnit * 6}px ${theme.gridUnit * 6}px | ||
| ${theme.gridUnit * 8}px; | ||
| .view-dataset-button { | ||
| position: absolute; | ||
| top: ${theme.gridUnit * 4}px; | ||
| right: ${theme.gridUnit * 4}px; | ||
| font-weight: ${theme.typography.weights.normal}; | ||
|
|
||
| &:hover { | ||
| color: ${theme.colors.secondary.dark3}; | ||
| text-decoration: underline; | ||
| } | ||
| } | ||
| `} | ||
| `; | ||
|
|
||
| export const REFRESHING = t('Refreshing columns'); | ||
| export const COLUMN_TITLE = t('Table columns'); | ||
| export const ALT_LOADING = t('Loading'); | ||
|
|
@@ -168,68 +207,116 @@ export interface IDatasetPanelProps { | |
| * Boolean indicating if the component is in a loading state | ||
| */ | ||
| loading: boolean; | ||
| datasets?: DatasetObject[] | undefined; | ||
|
There was a problem hiding this comment. nit: I kind of want this to have a better name, maybe existingDatasets? or something along those lines. There was a problem hiding this comment. I was going off of what @eschutho suggested in this review comment. I'm not really settled on the best name here but I'd be fine changing it, would like to hear what Elizabeth thinks of There was a problem hiding this comment. Makes sense! Does this need to be a list or can it be boolean? From my, limited, understanding of this feature you're seeing if there already is a dataset linked, so we don't need to be passing in a list of datasets, we could just check to see if there is an associated one. There was a problem hiding this comment. We need the whole object so we can cross-reference the list of table names with the table names in the list of datasets here: And when it's passed into |
||
| } | ||
|
|
||
| const EXISTING_DATASET_DESCRIPTION = t( | ||
| 'This table already has a dataset associated with it. You can only associate one dataset with a table.\n', | ||
| ); | ||
| const VIEW_DATASET = t('View Dataset'); | ||
|
|
||
| const renderExistingDatasetAlert = (dataset?: DatasetObject) => ( | ||
| <StyledAlert | ||
| closable={false} | ||
| type="info" | ||
| showIcon | ||
| message={t('This table already has a dataset')} | ||
| description={ | ||
| <> | ||
| {EXISTING_DATASET_DESCRIPTION} | ||
| <span | ||
| role="button" | ||
| onClick={() => { | ||
| window.open( | ||
| dataset?.explore_url, | ||
| '_blank', | ||
| 'noreferrer noopener popup=false', | ||
| ); | ||
| }} | ||
| tabIndex={0} | ||
| className="view-dataset-button" | ||
| > | ||
| {VIEW_DATASET} | ||
| </span> | ||
| </> | ||
| } | ||
| /> | ||
| ); | ||
|
|
||
| const DatasetPanel = ({ | ||
| tableName, | ||
| columnList, | ||
| loading, | ||
| hasError, | ||
| datasets, | ||
| }: IDatasetPanelProps) => { | ||
| const theme = useTheme(); | ||
| const hasColumns = columnList?.length > 0 ?? false; | ||
| const datasetNames = datasets?.map(dataset => dataset.table_name); | ||
|
|
||
| let component; | ||
| let loader; | ||
| if (loading) { | ||
| loader = ( | ||
| <LoaderContainer> | ||
| <StyledLoader> | ||
| <img alt={ALT_LOADING} src={LOADING_GIF} /> | ||
| <div>{REFRESHING}</div> | ||
| </StyledLoader> | ||
| </LoaderContainer> | ||
| ); | ||
| } | ||
| if (!loading) { | ||
| if (!loading && tableName && hasColumns && !hasError) { | ||
| component = ( | ||
| <> | ||
| <StyledTitle>{COLUMN_TITLE}</StyledTitle> | ||
| <TableContainer> | ||
| <StyledTable | ||
| loading={loading} | ||
| size={TableSize.SMALL} | ||
| columns={tableColumnDefinition} | ||
| data={columnList} | ||
| pageSizeOptions={pageSizeOptions} | ||
| defaultPageSize={10} | ||
| /> | ||
| </TableContainer> | ||
| </> | ||
| ); | ||
| } else { | ||
| component = ( | ||
| <MessageContent | ||
| hasColumns={hasColumns} | ||
| hasError={hasError} | ||
| tableName={tableName} | ||
| /> | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| return ( | ||
| <> | ||
| {tableName && ( | ||
| <> | ||
| {datasetNames?.includes(tableName) && | ||
| renderExistingDatasetAlert( | ||
| datasets?.find(dataset => dataset.table_name === tableName), | ||
| )} | ||
| <StyledHeader | ||
| position={ | ||
| !loading && hasColumns ? EPosition.RELATIVE : EPosition.ABSOLUTE | ||
| } | ||
| title={tableName || ''} | ||
| > | ||
| {tableName && ( | ||
| <Icons.Table iconColor={theme.colors.grayscale.base} /> | ||
| )} | ||
| {tableName} | ||
| </StyledHeader> | ||
| </> | ||
| )} | ||
| {component} | ||
| {loader} | ||
| </> | ||
| ); | ||
| }; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Related to coment on line 20, we shuld repelase use of supertThem with:
const StyledAlert = styled(Alert)( ({ theme }) =>and replace all the
supersetThemewiththemefor example:
`border: 1px solid ${theme.colors.info.base};
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FIxed in
this commit.