pt
/
superset
mirror of https://github.com/apache/superset.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

refactor: Unify shared datasources reducers and actions (#20645) 

* refactor: Unify shared datasources reducers and actions

* Removes column_types

* Adjusts hydrateExplore

* Revert "Removes column_types"

This reverts commit 096bbf7826.

* Fixes test
This commit is contained in:
Michael S. Molina 2022-07-13 13:03:36 -03:00 committed by GitHub
parent ec2eb3ddf8
commit 2a705406e1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
20 changed files with 90 additions and 259 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
superset-frontend/packages/superset-ui-chart-controls/src/types.ts
View File

@ -28,6 +28,7 @@ import type {
QueryFormData,
QueryFormMetric,
QueryResponse,
GenericDataType,
} from '@superset-ui/core';
import { sharedControls } from './shared-controls';
import sharedControlComponents from './shared-controls/components';
@ -66,6 +67,7 @@ export interface Dataset {
id: number;
type: DatasourceType;
columns: ColumnMeta[];
column_types?: GenericDataType[];
metrics: Metric[];
column_format: Record<string, string>;
verbose_map: Record<string, string>;
@ -79,6 +81,7 @@ export interface Dataset {
description: string | null;
uid?: string;
owners?: Owner[];
table_name?: string;
}
export interface ControlPanelState {

2
superset-frontend/spec/helpers/reducerIndex.ts
View File

@ -22,7 +22,7 @@ import dashboardInfo from 'src/dashboard/reducers/dashboardInfo';
import dashboardState from 'src/dashboard/reducers/dashboardState';
import dashboardFilters from 'src/dashboard/reducers/dashboardFilters';
import nativeFilters from 'src/dashboard/reducers/nativeFilters';
import datasources from 'src/dashboard/reducers/datasources';
import datasources from 'src/datasource/reducer';
import sliceEntities from 'src/dashboard/reducers/sliceEntities';
import dashboardLayout from 'src/dashboard/reducers/undoableDashboardLayout';
import messageToasts from 'src/components/MessageToasts/reducers';

4
superset-frontend/src/components/Chart/chartReducer.ts
View File

@ -19,7 +19,7 @@
/* eslint camelcase: 0 */
import { t } from '@superset-ui/core';
import { HYDRATE_DASHBOARD } from 'src/dashboard/actions/hydrate';
import { DatasourcesAction } from 'src/dashboard/actions/datasources';
import { DatasourcesActionType } from 'src/datasource/actions';
import { ChartState } from 'src/explore/types';
import { getFormDataFromControls } from 'src/explore/controlUtils';
import { HYDRATE_EXPLORE } from 'src/explore/actions/hydrateExplore';
@ -198,7 +198,7 @@ export default function chartReducer(
if (action.type === HYDRATE_DASHBOARD || action.type === HYDRATE_EXPLORE) {
return { ...action.data.charts };
}
if (action.type === DatasourcesAction.SET_DATASOURCES) {
if (action.type === DatasourcesActionType.SET_DATASOURCES) {
return Object.fromEntries(
Object.entries(charts).map(([chartId, chart]) => [
chartId,

2
superset-frontend/src/dashboard/actions/dashboardState.js
View File

@ -43,13 +43,13 @@ import serializeFilterScopes from 'src/dashboard/util/serializeFilterScopes';
import { getActiveFilters } from 'src/dashboard/util/activeDashboardFilters';
import { safeStringify } from 'src/utils/safeStringify';
import { FeatureFlag, isFeatureEnabled } from 'src/featureFlags';
import { fetchDatasourceMetadata } from 'src/dashboard/util/fetchDatasourceMetadata';
import { UPDATE_COMPONENTS_PARENTS_LIST } from './dashboardLayout';
import {
setChartConfiguration,
dashboardInfoChanged,
SET_CHART_CONFIG_COMPLETE,
} from './dashboardInfo';
import { fetchDatasourceMetadata } from './datasources';
import {
addFilter,
removeFilter,

4
superset-frontend/src/dashboard/components/nativeFilters/FiltersConfigModal/FiltersConfigForm/utils.ts
View File

@ -88,9 +88,7 @@ export const datasetToSelectOption = (
// TODO: add column_types field to Dataset
// We return true if column_types is undefined or empty as a precaution against backend failing to return column_types
export const hasTemporalColumns = (
dataset: Dataset & { column_types: GenericDataType[] },
) => {
export const hasTemporalColumns = (dataset: Dataset) => {
const columnTypes = ensureIsArray(dataset?.column_types);
return (
columnTypes.length === 0 || columnTypes.includes(GenericDataType.TEMPORAL)

4
superset-frontend/src/dashboard/constants.ts
View File

@ -1,6 +1,6 @@
/* eslint-disable import/prefer-default-export */
import { DatasourceType } from '@superset-ui/core';
import { Datasource } from 'src/dashboard/types';
import { Dataset } from '@superset-ui/chart-controls';
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
@ -19,7 +19,7 @@ import { Datasource } from 'src/dashboard/types';
* specific language governing permissions and limitations
* under the License.
*/
export const PLACEHOLDER_DATASOURCE: Datasource = {
export const PLACEHOLDER_DATASOURCE: Dataset = {
id: 0,
type: DatasourceType.Table,
uid: '_placeholder_',

2
superset-frontend/src/dashboard/containers/Dashboard.ts
View File

@ -24,7 +24,7 @@ import {
addSliceToDashboard,
removeSliceFromDashboard,
} from 'src/dashboard/actions/dashboardState';
import { setDatasources } from 'src/dashboard/actions/datasources';
import { setDatasources } from 'src/datasource/actions';
import { triggerQuery } from 'src/components/Chart/chartAction';
import { logEvent } from 'src/logger/actions';

2
superset-frontend/src/dashboard/containers/DashboardPage.tsx
View File

@ -36,7 +36,7 @@ import {
useDashboardDatasets,
} from 'src/hooks/apiResources';
import { hydrateDashboard } from 'src/dashboard/actions/hydrate';
import { setDatasources } from 'src/dashboard/actions/datasources';
import { setDatasources } from 'src/datasource/actions';
import injectCustomCss from 'src/dashboard/util/injectCustomCss';
import setupPlugins from 'src/setup/setupPlugins';
import { UserWithPermissionsAndRoles } from 'src/types/bootstrapTypes';

43
superset-frontend/src/dashboard/reducers/datasources.ts
View File

@ -1,43 +0,0 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import { keyBy } from 'lodash';
import { DatasourcesState } from 'src/dashboard/types';
import {
DatasourcesActionPayload,
DatasourcesAction,
} from '../actions/datasources';
export default function datasourcesReducer(
datasources: DatasourcesState | undefined,
action: DatasourcesActionPayload,
) {
if (action.type === DatasourcesAction.SET_DATASOURCES) {
return {
...datasources,
...keyBy(action.datasources, 'uid'),
};
}
if (action.type === DatasourcesAction.SET_DATASOURCE) {
return {
...datasources,
[action.key]: action.datasource,
};
}
return datasources || {};
}

8
superset-frontend/src/dashboard/types.ts
View File

@ -20,7 +20,6 @@ import {
ChartProps,
DataMaskStateWithId,
ExtraFormData,
GenericDataType,
JsonObject,
NativeFiltersState,
} from '@superset-ui/core';
@ -84,13 +83,8 @@ export type DashboardInfo = {
export type ChartsState = { [key: string]: Chart };
export type Datasource = Dataset & {
uid: string;
column_types: GenericDataType[];
table_name: string;
};
export type DatasourcesState = {
[key: string]: Datasource;
[key: string]: Dataset;
};
/** Root state of redux */

40
superset-frontend/src/dashboard/actions/datasources.ts → superset-frontend/src/dashboard/util/fetchDatasourceMetadata.ts
View File

@ -18,39 +18,9 @@
*/
import { Dispatch } from 'redux';
import { SupersetClient } from '@superset-ui/core';
import { Datasource, RootState } from 'src/dashboard/types';
// update datasources index for Dashboard
export enum DatasourcesAction {
SET_DATASOURCES = 'SET_DATASOURCES',
SET_DATASOURCE = 'SET_DATASOURCE',
}
export type DatasourcesActionPayload =
| {
type: DatasourcesAction.SET_DATASOURCES;
datasources: Datasource[] | null;
}
| {
type: DatasourcesAction.SET_DATASOURCE;
key: Datasource['uid'];
datasource: Datasource;
};
export function setDatasources(datasources: Datasource[] | null) {
return {
type: DatasourcesAction.SET_DATASOURCES,
datasources,
};
}
export function setDatasource(datasource: Datasource, key: string) {
return {
type: DatasourcesAction.SET_DATASOURCE,
key,
datasource,
};
}
import { Dataset } from '@superset-ui/chart-controls';
import { RootState } from 'src/dashboard/types';
import { setDatasource } from 'src/datasource/actions';
export function fetchDatasourceMetadata(key: string) {
return (dispatch: Dispatch, getState: () => RootState) => {
@ -58,11 +28,11 @@ export function fetchDatasourceMetadata(key: string) {
const datasource = datasources[key];
if (datasource) {
return dispatch(setDatasource(datasource, key));
return dispatch(setDatasource(datasource));
}
return SupersetClient.get({
endpoint: `/superset/fetch_datasource_metadata?datasourceKey=${key}`,
}).then(({ json }) => dispatch(setDatasource(json as Datasource, key)));
}).then(({ json }) => dispatch(setDatasource(json as Dataset)));
};
}

51
superset-frontend/src/explore/actions/datasourcesActions.ts → superset-frontend/src/datasource/actions.ts
View File

@ -16,34 +16,39 @@
* specific language governing permissions and limitations
* under the License.
*/
import { Dispatch } from 'redux';
import { Dataset } from '@superset-ui/chart-controls';
import { updateFormDataByDatasource } from './exploreActions';
import { ExplorePageState } from '../types';
export const SET_DATASOURCE = 'SET_DATASOURCE';
export interface SetDatasource {
type: string;
datasource: Dataset;
export enum DatasourcesActionType {
INIT_DATASOURCES = 'INIT_DATASOURCES',
SET_DATASOURCE = 'SET_DATASOURCE',
SET_DATASOURCES = 'SET_DATASOURCES',
}
export type DatasourcesAction =
| {
type: DatasourcesActionType.INIT_DATASOURCES;
datasources: { [key: string]: Dataset };
}
| {
type: DatasourcesActionType.SET_DATASOURCES;
datasources: Dataset[] | null;
}
| {
type: DatasourcesActionType.SET_DATASOURCE;
datasource: Dataset;
};
export function initDatasources(datasources: { [key: string]: Dataset }) {
return { type: DatasourcesActionType.INIT_DATASOURCES, datasources };
}
export function setDatasource(datasource: Dataset) {
return { type: SET_DATASOURCE, datasource };
return { type: DatasourcesActionType.SET_DATASOURCE, datasource };
}
export function changeDatasource(newDatasource: Dataset) {
return function (dispatch: Dispatch, getState: () => ExplorePageState) {
const {
explore: { datasource: prevDatasource },
} = getState();
dispatch(setDatasource(newDatasource));
dispatch(updateFormDataByDatasource(prevDatasource, newDatasource));
export function setDatasources(datasources: Dataset[] | null) {
return {
type: DatasourcesActionType.SET_DATASOURCES,
datasources,
};
}
export const datasourcesActions = {
setDatasource,
changeDatasource,
};
export type AnyDatasourcesAction = SetDatasource;

29
superset-frontend/src/explore/reducers/datasourcesReducer.ts → superset-frontend/src/datasource/reducer.ts
View File

@ -16,27 +16,32 @@
* specific language governing permissions and limitations
* under the License.
*/
import { Dataset } from '@superset-ui/chart-controls';
import { keyBy } from 'lodash';
import { getDatasourceUid } from 'src/utils/getDatasourceUid';
import {
AnyDatasourcesAction,
SET_DATASOURCE,
} from '../actions/datasourcesActions';
import { HYDRATE_EXPLORE, HydrateExplore } from '../actions/hydrateExplore';
DatasourcesAction,
DatasourcesActionType,
} from 'src/datasource/actions';
import { Dataset } from '@superset-ui/chart-controls';
export default function datasourcesReducer(
// TODO: change type to include other datasource types
datasources: { [key: string]: Dataset },
action: AnyDatasourcesAction | HydrateExplore,
datasources: { [key: string]: Dataset } | undefined,
action: DatasourcesAction,
) {
if (action.type === SET_DATASOURCE) {
if (action.type === DatasourcesActionType.INIT_DATASOURCES) {
return { ...action.datasources };
}
if (action.type === DatasourcesActionType.SET_DATASOURCES) {
return {
...datasources,
...keyBy(action.datasources, 'uid'),
};
}
if (action.type === DatasourcesActionType.SET_DATASOURCE) {
return {
...datasources,
[getDatasourceUid(action.datasource)]: action.datasource,
};
}
if (action.type === HYDRATE_EXPLORE) {
return { ...(action as HydrateExplore).data.datasources };
}
return datasources || {};
}

85
superset-frontend/src/explore/actions/datasourcesActions.test.ts
View File

@ -1,85 +0,0 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import { DatasourceType } from '@superset-ui/core';
import {
setDatasource,
changeDatasource,
} from 'src/explore/actions/datasourcesActions';
import datasourcesReducer from '../reducers/datasourcesReducer';
import { updateFormDataByDatasource } from './exploreActions';
const CURRENT_DATASOURCE = {
id: 1,
uid: '1__table',
type: DatasourceType.Table,
columns: [],
metrics: [],
column_format: {},
verbose_map: {},
main_dttm_col: '__timestamp',
// eg. ['["ds", true]', 'ds [asc]']
datasource_name: 'test datasource',
description: null,
};
const NEW_DATASOURCE = {
id: 2,
type: DatasourceType.Table,
columns: [],
metrics: [],
column_format: {},
verbose_map: {},
main_dttm_col: '__timestamp',
// eg. ['["ds", true]', 'ds [asc]']
datasource_name: 'test datasource',
description: null,
};
const defaultDatasourcesReducerState = {
[CURRENT_DATASOURCE.uid]: CURRENT_DATASOURCE,
};
test('sets new datasource', () => {
const newState = datasourcesReducer(
defaultDatasourcesReducerState,
setDatasource(NEW_DATASOURCE),
);
expect(newState).toEqual({
...defaultDatasourcesReducerState,
'2__table': NEW_DATASOURCE,
});
});
test('change datasource action', () => {
const dispatch = jest.fn();
const getState = jest.fn(() => ({
explore: {
datasource: CURRENT_DATASOURCE,
},
}));
// ignore getState type check - we dont need explore.datasource field for this test
// @ts-ignore
changeDatasource(NEW_DATASOURCE)(dispatch, getState);
expect(dispatch).toHaveBeenCalledTimes(2);
expect(dispatch).toHaveBeenNthCalledWith(1, setDatasource(NEW_DATASOURCE));
expect(dispatch).toHaveBeenNthCalledWith(
2,
updateFormDataByDatasource(CURRENT_DATASOURCE, NEW_DATASOURCE),
);
});

13
superset-frontend/src/explore/actions/exploreActions.ts
View File

@ -25,6 +25,8 @@ import {
toastActions,
} from 'src/components/MessageToasts/actions';
import { Slice } from 'src/types/Chart';
import { setDatasource } from 'src/datasource/actions';
import { ExplorePageState } from 'src/explore/types';
const FAVESTAR_BASE_URL = '/superset/favstar/slice';
@ -140,6 +142,16 @@ export function setForceQuery(force: boolean) {
};
}
export function changeDatasource(newDatasource: Dataset) {
return function (dispatch: Dispatch, getState: () => ExplorePageState) {
const {
explore: { datasource: prevDatasource },
} = getState();
dispatch(setDatasource(newDatasource));
dispatch(updateFormDataByDatasource(prevDatasource, newDatasource));
};
}
export const exploreActions = {
...toastActions,
fetchDatasourcesStarted,
@ -153,6 +165,7 @@ export const exploreActions = {
createNewSlice,
sliceUpdated,
setForceQuery,
changeDatasource,
};
export type ExploreActions = typeof exploreActions;

3
superset-frontend/src/explore/actions/hydrateExplore.test.ts
View File

@ -64,9 +64,6 @@ test('creates hydrate action from initial data', () => {
lastRendered: 0,
},
},
datasources: {
'8__table': exploreInitialData.dataset,
},
saveModal: {
dashboards: [],
saveModalAlert: null,

12
superset-frontend/src/explore/actions/hydrateExplore.ts
View File

@ -35,6 +35,7 @@ import { getDatasourceUid } from 'src/utils/getDatasourceUid';
import { getUrlParam } from 'src/utils/urlUtils';
import { URL_PARAMS } from 'src/constants';
import { findPermission } from 'src/utils/findPermission';
import { initDatasources } from 'src/datasource/actions';
export const HYDRATE_EXPLORE = 'HYDRATE_EXPLORE';
export const hydrateExplore =
@ -121,6 +122,13 @@ export const hydrateExplore =
lastRendered: 0,
};
dispatch(
initDatasources({
...datasources,
[getDatasourceUid(initialDatasource)]: initialDatasource,
}),
);
return dispatch({
type: HYDRATE_EXPLORE,
data: {
@ -128,10 +136,6 @@ export const hydrateExplore =
...charts,
[chartKey]: chart,
},
datasources: {
...datasources,
[getDatasourceUid(initialDatasource)]: initialDatasource,
},
saveModal: {
dashboards: [],
saveModalAlert: null,

4
superset-frontend/src/explore/components/ExploreViewContainer/index.jsx
View File

@ -46,11 +46,10 @@ import {
import { getUrlParam } from 'src/utils/urlUtils';
import cx from 'classnames';
import * as chartActions from 'src/components/Chart/chartAction';
import { fetchDatasourceMetadata } from 'src/dashboard/actions/datasources';
import { fetchDatasourceMetadata } from 'src/dashboard/util/fetchDatasourceMetadata';
import { chartPropShape } from 'src/dashboard/util/propShapes';
import { mergeExtraFormData } from 'src/dashboard/components/nativeFilters/utils';
import { postFormData, putFormData } from 'src/explore/exploreUtils/formData';
import { datasourcesActions } from 'src/explore/actions/datasourcesActions';
import { mountExploreUrl } from 'src/explore/exploreUtils';
import { getFormDataFromControls } from 'src/explore/controlUtils';
import * as exploreActions from 'src/explore/actions/exploreActions';
@ -758,7 +757,6 @@ function mapStateToProps(state) {
function mapDispatchToProps(dispatch) {
const actions = {
...exploreActions,
...datasourcesActions,
...saveModalActions,
...chartActions,
...logActions,

5
superset-frontend/src/hooks/apiResources/dashboards.ts
View File

@ -17,7 +17,8 @@
* under the License.
*/
import { Dashboard, Datasource, EmbeddedDashboard } from 'src/dashboard/types';
import { Dashboard, EmbeddedDashboard } from 'src/dashboard/types';
import { Dataset } from '@superset-ui/chart-controls';
import { Chart } from 'src/types/Chart';
import { useApiV1Resource, useTransformedResource } from './apiResources';
@ -42,7 +43,7 @@ export const useDashboardCharts = (idOrSlug: string | number) =>
// important: this endpoint only returns the fields in the dataset
// that are necessary for rendering the given dashboard
export const useDashboardDatasets = (idOrSlug: string | number) =>
useApiV1Resource<Datasource[]>(`/api/v1/dashboard/${idOrSlug}/datasets`);
useApiV1Resource<Dataset[]>(`/api/v1/dashboard/${idOrSlug}/datasets`);
export const useEmbeddedDashboard = (idOrSlug: string | number) =>
useApiV1Resource<EmbeddedDashboard>(`/api/v1/dashboard/${idOrSlug}/embedded`);

33
superset-frontend/src/views/store.ts
View File

@ -27,26 +27,17 @@ import dashboardInfo from 'src/dashboard/reducers/dashboardInfo';
import dashboardState from 'src/dashboard/reducers/dashboardState';
import dashboardFilters from 'src/dashboard/reducers/dashboardFilters';
import nativeFilters from 'src/dashboard/reducers/nativeFilters';
import dashboardDatasources from 'src/dashboard/reducers/datasources';
import datasources from 'src/datasource/reducer';
import sliceEntities from 'src/dashboard/reducers/sliceEntities';
import dashboardLayout from 'src/dashboard/reducers/undoableDashboardLayout';
import logger from 'src/middleware/loggerMiddleware';
import saveModal from 'src/explore/reducers/saveModalReducer';
import explore from 'src/explore/reducers/exploreReducer';
import exploreDatasources from 'src/explore/reducers/datasourcesReducer';
import { DatasourcesState } from 'src/dashboard/types';
import {
DatasourcesActionPayload,
DatasourcesAction,
} from 'src/dashboard/actions/datasources';
import shortid from 'shortid';
import {
BootstrapUser,
UserWithPermissionsAndRoles,
} from 'src/types/bootstrapTypes';
import { AnyDatasourcesAction } from 'src/explore/actions/datasourcesActions';
import { HydrateExplore } from 'src/explore/actions/hydrateExplore';
import { Dataset } from '@superset-ui/chart-controls';
// Some reducers don't do anything, and redux is just used to reference the initial "state".
// This may change later, as the client application takes on more responsibilities.
@ -75,26 +66,6 @@ const userReducer = (
return user;
};
// TODO: This reducer is a combination of the Dashboard and Explore reducers.
// The correct way of handling this is to unify the actions and reducers from both
// modules in shared files. This involves a big refactor to unify the parameter types
// and move files around. We should tackle this in a specific PR.
const CombinedDatasourceReducers = (
datasources: DatasourcesState | undefined | { [key: string]: Dataset },
action: DatasourcesActionPayload | AnyDatasourcesAction | HydrateExplore,
) => {
if (action.type === DatasourcesAction.SET_DATASOURCES) {
return dashboardDatasources(
datasources as DatasourcesState | undefined,
action as DatasourcesActionPayload,
);
}
return exploreDatasources(
datasources as { [key: string]: Dataset },
action as AnyDatasourcesAction | HydrateExplore,
);
};
// exported for tests
export const rootReducer = combineReducers({
messageToasts: messageToastReducer,
@ -102,7 +73,7 @@ export const rootReducer = combineReducers({
user: userReducer,
impressionId: noopReducer(shortid.generate()),
charts,
datasources: CombinedDatasourceReducers,
datasources,
dashboardInfo,
dashboardFilters,
dataMask,