Skip to content
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.

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

feat: generic marshmallow error component #25303

Merged
merged 6 commits into from
Oct 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ describe('DatasourceModal', () => {
it('saves on confirm', async () => {
const callsP = fetchMock.post(SAVE_ENDPOINT, SAVE_PAYLOAD);
fetchMock.put(SAVE_DATASOURCE_ENDPOINT, {});
fetchMock.get(GET_DATASOURCE_ENDPOINT, {});
fetchMock.get(GET_DATASOURCE_ENDPOINT, { result: {} });
act(() => {
wrapper
.find('button[data-test="datasource-modal-save"]')
Expand Down
19 changes: 15 additions & 4 deletions superset-frontend/src/components/Datasource/DatasourceModal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,11 @@

import Modal from 'src/components/Modal';
import AsyncEsmComponent from 'src/components/AsyncEsmComponent';
import { getClientErrorObject } from 'src/utils/getClientErrorObject';
import {
genericSupersetError,
SupersetError,
} from 'src/components/ErrorMessage/types';
import ErrorMessageWithStackTrace from 'src/components/ErrorMessage/ErrorMessageWithStackTrace';
import withToasts from 'src/components/MessageToasts/withToasts';
import { useSelector } from 'react-redux';

Expand Down Expand Up @@ -203,11 +207,18 @@
})
.catch(response => {
setIsSaving(false);
getClientErrorObject(response).then(({ error }) => {
response.json().then((errorJson: { errors: SupersetError[] }) => {

Check warning on line 210 in superset-frontend/src/components/Datasource/DatasourceModal.tsx

View check run for this annotation

Codecov / codecov/patch

superset-frontend/src/components/Datasource/DatasourceModal.tsx#L210

Added line #L210 was not covered by tests
modal.error({
title: t('Error'),
content: error || t('An error has occurred'),
title: t('Error saving dataset'),
okButtonProps: { danger: true, className: 'btn-danger' },
content: (
<ErrorMessageWithStackTrace
error={
errorJson?.errors?.[0] || genericSupersetError(errorJson)
}
source="crud"
/>
),
});
});
});
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
/**
* 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 React from 'react';
import { render, screen, fireEvent } from '@testing-library/react';
import '@testing-library/jest-dom/extend-expect';
import { ThemeProvider, supersetTheme } from '@superset-ui/core';
import { ErrorLevel, ErrorTypeEnum } from 'src/components/ErrorMessage/types';
import MarshmallowErrorMessage from './MarshmallowErrorMessage';

describe('MarshmallowErrorMessage', () => {
const mockError = {
extra: {
messages: {
name: ["can't be blank"],
age: {
inner: ['is too low'],
},
},
payload: {
name: '',
age: {
inner: 10,
},
},
issue_codes: [],
},
message: 'Validation failed',
error_type: ErrorTypeEnum.MARSHMALLOW_ERROR,
level: 'error' as ErrorLevel,
};

test('renders without crashing', () => {
render(
<ThemeProvider theme={supersetTheme}>
<MarshmallowErrorMessage error={mockError} />
</ThemeProvider>,
);
expect(screen.getByText('Validation failed')).toBeInTheDocument();
});

test('renders the provided subtitle', () => {
render(
<ThemeProvider theme={supersetTheme}>
<MarshmallowErrorMessage error={mockError} subtitle="Error Alert" />
</ThemeProvider>,
);
expect(screen.getByText('Error Alert')).toBeInTheDocument();
});

test('renders extracted invalid values', () => {
render(
<ThemeProvider theme={supersetTheme}>
<MarshmallowErrorMessage error={mockError} />
</ThemeProvider>,
);
expect(screen.getByText("can't be blank:")).toBeInTheDocument();
expect(screen.getByText('is too low: 10')).toBeInTheDocument();
});

test('renders the JSONTree when details are expanded', () => {
render(
<ThemeProvider theme={supersetTheme}>
<MarshmallowErrorMessage error={mockError} />
</ThemeProvider>,
);
fireEvent.click(screen.getByText('Details'));
expect(screen.getByText('"can\'t be blank"')).toBeInTheDocument();
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
/**
* 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 React from 'react';
import { JSONTree } from 'react-json-tree';
import { css, styled, SupersetTheme, t } from '@superset-ui/core';

import { useJsonTreeTheme } from 'src/hooks/useJsonTreeTheme';
import Collapse from 'src/components/Collapse';
import { ErrorMessageComponentProps } from './types';

interface MarshmallowErrorExtra {
messages: object;
payload: object;
issue_codes: {
code: number;
message: string;
}[];
}

const StyledUl = styled.ul`
padding-left: ${({ theme }) => theme.gridUnit * 5}px;
padding-top: ${({ theme }) => theme.gridUnit * 4}px;
`;

const collapseStyle = (theme: SupersetTheme) => css`
.ant-collapse-arrow {
left: 0px !important;
}
.ant-collapse-header {
padding-left: ${theme.gridUnit * 4}px !important;
}
.ant-collapse-content-box {
padding: 0px !important;
betodealmeida marked this conversation as resolved.
Show resolved Hide resolved
}
`;

const extractInvalidValues = (messages: object, payload: object): string[] => {
const invalidValues: string[] = [];

const recursiveExtract = (messages: object, payload: object) => {
Object.keys(messages).forEach(key => {
const value = payload[key];
const message = messages[key];

if (Array.isArray(message)) {
message.forEach(errorMessage => {
invalidValues.push(`${errorMessage}: ${value}`);
});
} else {
recursiveExtract(message, value);
}
});
};
recursiveExtract(messages, payload);
return invalidValues;
};

export default function MarshmallowErrorMessage({
betodealmeida marked this conversation as resolved.
Show resolved Hide resolved
error,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
source = 'crud',
subtitle,
}: ErrorMessageComponentProps<MarshmallowErrorExtra>) {
const jsonTreeTheme = useJsonTreeTheme();
const { extra, message } = error;

return (
<div>
{subtitle && <h4>{subtitle}</h4>}

{message}

<StyledUl>
{extractInvalidValues(extra.messages, extra.payload).map(
(value, index) => (
<li key={index}>{value}</li>
),
)}
</StyledUl>

<Collapse ghost css={collapseStyle}>
<Collapse.Panel header={t('Details')} key="details" css={collapseStyle}>
<JSONTree
data={extra.messages}
shouldExpandNode={() => true}
betodealmeida marked this conversation as resolved.
Show resolved Hide resolved
hideRoot
theme={jsonTreeTheme}
/>
</Collapse.Panel>
</Collapse>
</div>
);
}
12 changes: 11 additions & 1 deletion superset-frontend/src/components/ErrorMessage/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ export const ErrorTypeEnum = {
// API errors
INVALID_PAYLOAD_FORMAT_ERROR: 'INVALID_PAYLOAD_FORMAT_ERROR',
INVALID_PAYLOAD_SCHEMA_ERROR: 'INVALID_PAYLOAD_SCHEMA_ERROR',
MARSHMALLOW_ERROR: 'MARSHMALLOW_ERROR',
} as const;

type ValueOf<T> = T[keyof T];
Expand All @@ -88,7 +89,7 @@ export type ErrorType = ValueOf<typeof ErrorTypeEnum>;
// Keep in sync with superset/views/errors.py
export type ErrorLevel = 'info' | 'warning' | 'error';

export type ErrorSource = 'dashboard' | 'explore' | 'sqllab';
export type ErrorSource = 'dashboard' | 'explore' | 'sqllab' | 'crud';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

crud doesn't seem like a domain source like others here. Is there a better name for this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I couldn't think of a better name. The CRUD is one of the main domains, just not a fancy one. :-P


export type SupersetError<ExtraType = Record<string, any> | null> = {
error_type: ErrorType;
Expand All @@ -106,3 +107,12 @@ export type ErrorMessageComponentProps<ExtraType = Record<string, any> | null> =

export type ErrorMessageComponent =
React.ComponentType<ErrorMessageComponentProps>;

/* Generic error to be returned when the backend returns an error response that is not
* SIP-41 compliant. */
export const genericSupersetError = (extra: object) => ({
error_type: ErrorTypeEnum.GENERIC_BACKEND_ERROR,
extra,
level: 'error' as ErrorLevel,
message: 'An error occurred',
});
31 changes: 3 additions & 28 deletions superset-frontend/src/components/FilterableTable/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ import {
t,
safeHtmlSpan,
styled,
useTheme,
} from '@superset-ui/core';
import { useDebounceValue } from 'src/hooks/useDebounceValue';
import { useJsonTreeTheme } from 'src/hooks/useJsonTreeTheme';
import Button from '../Button';
import CopyToClipboard from '../CopyToClipboard';
import ModalTrigger from '../ModalTrigger';
Expand Down Expand Up @@ -183,32 +183,7 @@ const FilterableTable = ({
return complexColumns[columnKey] ? truncated : content;
};

const theme = useTheme();
const [jsonTreeTheme, setJsonTreeTheme] = useState<Record<string, string>>();

const getJsonTreeTheme = () => {
if (!jsonTreeTheme) {
setJsonTreeTheme({
base00: theme.colors.grayscale.dark2,
base01: theme.colors.grayscale.dark1,
base02: theme.colors.grayscale.base,
base03: theme.colors.grayscale.light1,
base04: theme.colors.grayscale.light2,
base05: theme.colors.grayscale.light3,
base06: theme.colors.grayscale.light4,
base07: theme.colors.grayscale.light5,
base08: theme.colors.error.base,
base09: theme.colors.error.light1,
base0A: theme.colors.error.light2,
base0B: theme.colors.success.base,
base0C: theme.colors.primary.light1,
base0D: theme.colors.primary.base,
base0E: theme.colors.primary.dark1,
base0F: theme.colors.error.dark1,
});
}
return jsonTreeTheme;
};
const jsonTreeTheme = useJsonTreeTheme();

const getWidthsForColumns = () => {
const PADDING = 50; // accounts for cell padding and width of sorting icon
Expand Down Expand Up @@ -293,7 +268,7 @@ const FilterableTable = ({
modalBody={
<JSONTree
data={jsonObject}
theme={getJsonTreeTheme()}
theme={jsonTreeTheme}
valueRenderer={renderBigIntStrToNumber}
/>
}
Expand Down
41 changes: 41 additions & 0 deletions superset-frontend/src/hooks/useJsonTreeTheme.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
/**
* 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 { useTheme } from '@superset-ui/core';

export const useJsonTreeTheme = () => {
const theme = useTheme();
return {
base00: theme.colors.grayscale.dark2,
base01: theme.colors.grayscale.dark1,
base02: theme.colors.grayscale.base,
base03: theme.colors.grayscale.light1,
base04: theme.colors.grayscale.light2,
base05: theme.colors.grayscale.light3,
base06: theme.colors.grayscale.light4,
base07: theme.colors.grayscale.light5,
base08: theme.colors.error.base,
base09: theme.colors.error.light1,
base0A: theme.colors.error.light2,
base0B: theme.colors.success.base,
base0C: theme.colors.primary.light1,
base0D: theme.colors.primary.base,
base0E: theme.colors.primary.dark1,
base0F: theme.colors.error.dark1,
};
};
5 changes: 5 additions & 0 deletions superset-frontend/src/setup/setupErrorMessages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import { ErrorTypeEnum } from 'src/components/ErrorMessage/types';
import TimeoutErrorMessage from 'src/components/ErrorMessage/TimeoutErrorMessage';
import DatabaseErrorMessage from 'src/components/ErrorMessage/DatabaseErrorMessage';
import MarshmallowErrorMessage from 'src/components/ErrorMessage/MarshmallowErrorMessage';
import ParameterErrorMessage from 'src/components/ErrorMessage/ParameterErrorMessage';
import DatasetNotFoundErrorMessage from 'src/components/ErrorMessage/DatasetNotFoundErrorMessage';

Expand Down Expand Up @@ -144,5 +145,9 @@
ErrorTypeEnum.FAILED_FETCHING_DATASOURCE_INFO_ERROR,
DatasetNotFoundErrorMessage,
);
errorMessageComponentRegistry.registerValue(

Check warning on line 148 in superset-frontend/src/setup/setupErrorMessages.ts

View check run for this annotation

Codecov / codecov/patch

superset-frontend/src/setup/setupErrorMessages.ts#L148

Added line #L148 was not covered by tests
ErrorTypeEnum.MARSHMALLOW_ERROR,
MarshmallowErrorMessage,
);
setupErrorMessagesExtra();
}
1 change: 0 additions & 1 deletion superset/datasets/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,6 @@ def post(self) -> Response:

@expose("/<pk>", methods=("PUT",))
@protect()
@safe
betodealmeida marked this conversation as resolved.
Show resolved Hide resolved
@statsd_metrics
@event_logger.log_this_with_context(
action=lambda self, *args, **kwargs: f"{self.__class__.__name__}.put",
betodealmeida marked this conversation as resolved.
Show resolved Hide resolved
Expand Down
Loading
Loading