forked from apache/superset
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: generic marshmallow error component (apache#25303)
- Loading branch information
1 parent
e746b69
commit 2445f3e
Showing
13 changed files
with
376 additions
and
35 deletions.
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
86 changes: 86 additions & 0 deletions
86
superset-frontend/src/components/ErrorMessage/MarshmallowErrorMessage.test.tsx
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 |
|---|---|---|
| @@ -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(); | ||
| }); | ||
| }); |
109 changes: 109 additions & 0 deletions
109
superset-frontend/src/components/ErrorMessage/MarshmallowErrorMessage.tsx
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 |
|---|---|---|
| @@ -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; | ||
| } | ||
| `; | ||
|
|
||
| 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({ | ||
| 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} | ||
| hideRoot | ||
| theme={jsonTreeTheme} | ||
| /> | ||
| </Collapse.Panel> | ||
| </Collapse> | ||
| </div> | ||
| ); | ||
| } |
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
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 |
|---|---|---|
| @@ -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, | ||
| }; | ||
| }; |
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
Oops, something went wrong.