Skip to content

feat: Edit columns in new dataset editor #19120

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
cccs-Dustin wants to merge 8 commits into from
Closed

feat: Edit columns in new dataset editor #19120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0455722
Added new feature flag, all that is left to do is add and test unit t…
cccs-Dustin Mar 10, 2022
8b47568
Modifications made by the pre-commit hook
cccs-Dustin Mar 10, 2022
eb1ebad
Added in the outline of the unit tests that need to be created
cccs-Dustin Mar 10, 2022
cea45aa
Added logging for debugging purposes
cccs-Dustin Mar 10, 2022
5774a87
Finalized the unit tests for this new feature flag
cccs-Dustin Mar 10, 2022
fe1f5b8
Merge branch 'apache:master' into edit_columns_in_new_dataset_editor
cccs-Dustin Mar 11, 2022
d9f0914
Fixed issues that were causing the CI tests to fail
cccs-Dustin Mar 11, 2022
fb7446b
Merge branch 'edit_columns_in_new_dataset_editor' of github.com:Cyber…
cccs-Dustin Mar 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions RESOURCES/FEATURE_FLAGS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ These features are considered **unfinished** and should only be used on developm
- DASHBOARD_CACHE
- DASHBOARD_NATIVE_FILTERS_SET
- DISABLE_DATASET_SOURCE_EDIT
- ENABLE_EDIT_COLUMN_TYPE
- ENABLE_EXPLORE_JSON_CSRF_PROTECTION
- KV_STORE
- PRESTO_EXPAND_DATA
Expand Down
1 change: 1 addition & 0 deletions superset-frontend/packages/superset-ui-core/src/utils/featureFlags.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ export enum FeatureFlag {
DISABLE_LEGACY_DATASOURCE_EDITOR = 'DISABLE_LEGACY_DATASOURCE_EDITOR',
ENABLE_REACT_CRUD_VIEWS = 'ENABLE_REACT_CRUD_VIEWS',
DISABLE_DATASET_SOURCE_EDIT = 'DISABLE_DATASET_SOURCE_EDIT',
ENABLE_EDIT_COLUMN_TYPE = 'ENABLE_EDIT_COLUMN_TYPE',
DISPLAY_MARKDOWN_HTML = 'DISPLAY_MARKDOWN_HTML',
ESCAPE_MARKDOWN_HTML = 'ESCAPE_MARKDOWN_HTML',
DASHBOARD_NATIVE_FILTERS = 'DASHBOARD_NATIVE_FILTERS',
Expand Down
4 changes: 4 additions & 0 deletions superset-frontend/src/components/Datasource/DatasourceEditor.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,7 @@ function ColumnCollectionTable({
label={t('Data type')}
control={
<Select
data-test="column-data-type-select"
ariaLabel={t('Data type')}
options={DATA_TYPES}
name="type"
Expand Down Expand Up @@ -1272,6 +1273,9 @@ class DatasourceEditor extends React.PureComponent {
this.setColumns({ databaseColumns })
}
onDatasourceChange={this.onDatasourceChange}
allowEditDataType={isFeatureEnabled(
FeatureFlag.ENABLE_EDIT_COLUMN_TYPE,
)}
/>
{this.state.metadataLoading && <Loading />}
</StyledColumnsTabWrapper>
Expand Down
115 changes: 88 additions & 27 deletions superset-frontend/src/components/Datasource/DatasourceEditor.test.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,33 +68,6 @@ describe('DatasourceEditor', () => {
}, 0);
}));

// to add, remove and modify columns accordingly
it('can modify columns', async () => {
const columnsTab = screen.getByTestId('collection-tab-Columns');
userEvent.click(columnsTab);

const getToggles = screen.getAllByRole('button', {
name: /toggle expand/i,
});
userEvent.click(getToggles[0]);
const getTextboxes = screen.getAllByRole('textbox');
expect(getTextboxes.length).toEqual(5);

const inputLabel = screen.getByPlaceholderText('Label');
const inputDescription = screen.getByPlaceholderText('Description');
const inputDtmFormat = screen.getByPlaceholderText('%Y/%m/%d');
const inputCertifiedBy = screen.getByPlaceholderText('Certified by');
const inputCertDetails = screen.getByPlaceholderText(
'Certification details',
);

userEvent.type(await inputLabel, 'test_lable');
userEvent.type(await inputDescription, 'test');
userEvent.type(await inputDtmFormat, 'test');
userEvent.type(await inputCertifiedBy, 'test');
userEvent.type(await inputCertDetails, 'test');
});

it('can delete columns', async () => {
const columnsTab = screen.getByTestId('collection-tab-Columns');
userEvent.click(columnsTab);
Expand Down Expand Up @@ -140,6 +113,94 @@ describe('DatasourceEditor', () => {
expect(screen.getByText(/template parameters/i)).toBeInTheDocument();
});

describe('disable edit column data type', () => {
beforeAll(() => {
isFeatureEnabledMock = jest
.spyOn(featureFlags, 'isFeatureEnabled')
.mockImplementation(() => false);
});

afterAll(() => {
isFeatureEnabledMock.mockRestore();
});

// to add, remove and modify columns accordingly
it('can modify columns except data type when feature flag is disabled', async () => {
const columnsTab = screen.getByTestId('collection-tab-Columns');
userEvent.click(columnsTab);

const getToggles = screen.getAllByRole('button', {
name: /toggle expand/i,
});

userEvent.click(getToggles[0]);
const getTextboxes = screen.getAllByRole('textbox');
expect(getTextboxes.length).toEqual(5);
expect(
screen.queryByTestId('column-data-type-select'),
).not.toBeInTheDocument();

const inputLabel = screen.getByPlaceholderText('Label');
const inputDescription = screen.getByPlaceholderText('Description');
const inputDtmFormat = screen.getByPlaceholderText('%Y/%m/%d');
const inputCertifiedBy = screen.getByPlaceholderText('Certified by');
const inputCertDetails = screen.getByPlaceholderText(
'Certification details',
);

userEvent.type(await inputLabel, 'test_lable');
userEvent.type(await inputDescription, 'test');
userEvent.type(await inputDtmFormat, 'test');
userEvent.type(await inputCertifiedBy, 'test');
userEvent.type(await inputCertDetails, 'test');
});
});

describe('enable edit column data type', () => {
beforeAll(() => {
isFeatureEnabledMock = jest
.spyOn(featureFlags, 'isFeatureEnabled')
.mockImplementation(() => true);
});

afterAll(() => {
isFeatureEnabledMock.mockRestore();
});

// to add, remove and modify columns accordingly
it('can modify columns including data type when feature flag enabled', async () => {
const columnsTab = screen.getByTestId('collection-tab-Columns');
userEvent.click(columnsTab);

const getToggles = screen.getAllByRole('button', {
name: /toggle expand/i,
});

userEvent.click(getToggles[0]);
const getTextboxes = screen.getAllByRole('textbox');
expect(getTextboxes.length).toEqual(5);
expect(
screen.queryByTestId('column-data-type-select'),
).toBeInTheDocument();

const inputLabel = screen.getByPlaceholderText('Label');
const inputDescription = screen.getByPlaceholderText('Description');
const inputDataType = screen.getByTestId('column-data-type-select');
const inputDtmFormat = screen.getByPlaceholderText('%Y/%m/%d');
const inputCertifiedBy = screen.getByPlaceholderText('Certified by');
const inputCertDetails = screen.getByPlaceholderText(
'Certification details',
);

userEvent.type(await inputLabel, 'test_lable');
userEvent.type(await inputDescription, 'test');
userEvent.type(await inputDataType, 'test');
userEvent.type(await inputDtmFormat, 'test');
userEvent.type(await inputCertifiedBy, 'test');
userEvent.type(await inputCertDetails, 'test');
});
});

describe('enable edit Source tab', () => {
beforeAll(() => {
isFeatureEnabledMock = jest
Expand Down
2 changes: 2 additions & 0 deletions superset/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,8 @@ def _try_json_readsha(filepath: str, length: int) -> Optional[str]:
# Experimental feature introducing a client (browser) cache
"CLIENT_CACHE": False,
"DISABLE_DATASET_SOURCE_EDIT": False,
# Allow users to modify column data types in new dataset editor
"ENABLE_EDIT_COLUMN_TYPE": False,
# When using a recent version of Druid that supports JOINs turn this on
"DRUID_JOINS": False,
"DYNAMIC_PLUGINS": False,
Expand Down
1 change: 1 addition & 0 deletions superset/views/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@
"SUPERSET_DASHBOARD_PERIODICAL_REFRESH_LIMIT",
"SUPERSET_DASHBOARD_PERIODICAL_REFRESH_WARNING_MESSAGE",
"DISABLE_DATASET_SOURCE_EDIT",
"ENABLE_EDIT_COLUMN_TYPE",
"DRUID_IS_ACTIVE",
"ENABLE_JAVASCRIPT_CONTROLS",
"DEFAULT_SQLLAB_LIMIT",
Expand Down