-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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(ui): Add support for structured reporting of warnings and failures in the UI ingestion flow (ingest uplift 2/2) #10790
Merged
jjoyce0510
merged 8 commits into
datahub-project:master
from
jjoyce0510:jj--refactor-post-ingestion-run-steps
Jul 1, 2024
Merged
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
c247887
Adding base components for rendering warnings and errors in ingestion
0125213
Linting etc
73c6e3c
Merge remote-tracking branch 'acryl/jj--refactor-post-ingestion-run-s…
9697bb7
Pause
7564088
revert env
9a6f2a7
Merge remote-tracking branch 'acryl/jj--refactor-post-ingestion-run-s…
d715376
Update datahub-web-react/src/app/shared/ShowMoreSection.tsx
jjoyce0510 224c630
Adding better linting
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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
44 changes: 44 additions & 0 deletions
44
datahub-web-react/src/app/ingest/source/executions/reporting/StructuredReport.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,44 @@ | ||
import React from 'react'; | ||
import styled from 'styled-components'; | ||
import { CloseCircleOutlined, ExclamationCircleOutlined, InfoCircleOutlined } from '@ant-design/icons'; | ||
|
||
import { StructuredReportItemLevel, StructuredReport as StructuredReportType } from '../../types'; | ||
import { StructuredReportItemList } from './StructuredReportItemList'; | ||
import { REDESIGN_COLORS } from '../../../../entity/shared/constants'; | ||
|
||
const Container = styled.div` | ||
display: flex; | ||
flex-direction: column; | ||
gap: 12px; | ||
`; | ||
|
||
const ERROR_COLOR = '#F5222D'; | ||
const WARNING_COLOR = '#FA8C16'; | ||
const INFO_COLOR = REDESIGN_COLORS.BLUE; | ||
|
||
interface Props { | ||
report: StructuredReportType; | ||
} | ||
|
||
export function StructuredReport({ report }: Props) { | ||
if (!report.items.length) { | ||
return null; | ||
} | ||
|
||
const warnings = report.items.filter((item) => item.level === StructuredReportItemLevel.WARN); | ||
const errors = report.items.filter((item) => item.level === StructuredReportItemLevel.ERROR); | ||
const infos = report.items.filter((item) => item.level === StructuredReportItemLevel.INFO); | ||
return ( | ||
<Container> | ||
{errors.length ? ( | ||
<StructuredReportItemList items={errors} color={ERROR_COLOR} icon={CloseCircleOutlined} /> | ||
) : null} | ||
{warnings.length ? ( | ||
<StructuredReportItemList items={warnings} color={WARNING_COLOR} icon={ExclamationCircleOutlined} /> | ||
) : null} | ||
{infos.length ? ( | ||
<StructuredReportItemList items={infos} color={INFO_COLOR} icon={InfoCircleOutlined} /> | ||
) : null} | ||
</Container> | ||
); | ||
} |
81 changes: 81 additions & 0 deletions
81
datahub-web-react/src/app/ingest/source/executions/reporting/StructuredReportItem.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,81 @@ | ||
import React from 'react'; | ||
import styled from 'styled-components'; | ||
import { Collapse } from 'antd'; | ||
|
||
import { StructuredReportItem as StructuredReportItemType } from '../../types'; | ||
import { ANTD_GRAY } from '../../../../entity/shared/constants'; | ||
import { applyOpacity } from '../../../../shared/styleUtils'; | ||
import { StructuredReportItemContext } from './StructuredReportItemContext'; | ||
|
||
const StyledCollapse = styled(Collapse)<{ color: string }>` | ||
background-color: ${(props) => applyOpacity(props.color, 8)}; | ||
border: 1px solid ${(props) => applyOpacity(props.color, 20)}; | ||
display: flex; | ||
|
||
&& { | ||
.ant-collapse-header { | ||
display: flex; | ||
align-items: center; | ||
} | ||
|
||
.ant-collapse-item { | ||
border: none; | ||
width: 100%; | ||
} | ||
} | ||
`; | ||
|
||
const Item = styled.div` | ||
display: flex; | ||
align-items: center; | ||
justify-content: start; | ||
gap: 4px; | ||
`; | ||
|
||
const Content = styled.div` | ||
border-radius: 8px; | ||
`; | ||
|
||
const Text = styled.div` | ||
display: flex; | ||
flex-direction: column; | ||
`; | ||
|
||
const Type = styled.div` | ||
font-weight: bold; | ||
font-size: 14px; | ||
`; | ||
|
||
const Message = styled.div` | ||
color: ${ANTD_GRAY[8]}; | ||
`; | ||
|
||
interface Props { | ||
item: StructuredReportItemType; | ||
color: string; | ||
icon?: React.ComponentType<any>; | ||
} | ||
|
||
export function StructuredReportItem({ item, color, icon }: Props) { | ||
const Icon = icon; | ||
return ( | ||
<StyledCollapse color={color}> | ||
<Collapse.Panel | ||
header={ | ||
<Item> | ||
{Icon ? <Icon style={{ fontSize: 16, color, marginRight: 12 }} /> : null} | ||
<Text> | ||
<Type>{item.title}</Type> | ||
<Message>{item.message}</Message> | ||
</Text> | ||
</Item> | ||
} | ||
key="0" | ||
> | ||
<Content> | ||
<StructuredReportItemContext item={item} /> | ||
</Content> | ||
</Collapse.Panel> | ||
</StyledCollapse> | ||
); | ||
} |
43 changes: 43 additions & 0 deletions
43
datahub-web-react/src/app/ingest/source/executions/reporting/StructuredReportItemContext.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,43 @@ | ||
import React from 'react'; | ||
import styled from 'styled-components'; | ||
import { Tooltip } from 'antd'; | ||
|
||
import { StructuredReportItem as StructuredReportItemType } from '../../types'; | ||
import { ANTD_GRAY } from '../../../../entity/shared/constants'; | ||
|
||
const Container = styled.div` | ||
display: flex; | ||
flex-direction: column; | ||
gap: 8px; | ||
margin-left: 12px; | ||
`; | ||
|
||
const Title = styled.div` | ||
font-size: 14px; | ||
font-weight: bold; | ||
`; | ||
|
||
const Item = styled.div` | ||
padding: 6px; | ||
font-size: 12px; | ||
border-radius: 2px; | ||
background-color: ${ANTD_GRAY[3]}; | ||
color: ${ANTD_GRAY[8]}; | ||
`; | ||
|
||
interface Props { | ||
item: StructuredReportItemType; | ||
} | ||
|
||
export function StructuredReportItemContext({ item }: Props) { | ||
return ( | ||
<Container> | ||
<Tooltip showArrow={false} title="Additional context about the source of the issue" placement="left"> | ||
<Title>Context</Title> | ||
</Tooltip> | ||
{item.context.length | ||
? item.context.map((contextItem) => <Item>{contextItem}</Item>) | ||
: 'No additional context found.'} | ||
</Container> | ||
); | ||
jjoyce0510 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} |
42 changes: 42 additions & 0 deletions
42
datahub-web-react/src/app/ingest/source/executions/reporting/StructuredReportItemList.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,42 @@ | ||
import React, { useState } from 'react'; | ||
import styled from 'styled-components'; | ||
import { StructuredReportItem as StructuredReportItemType } from '../../types'; | ||
import { StructuredReportItem } from './StructuredReportItem'; | ||
import { ShowMoreSection } from '../../../../shared/ShowMoreSection'; | ||
|
||
const ItemList = styled.div` | ||
display: flex; | ||
flex-direction: column; | ||
gap: 12px; | ||
`; | ||
|
||
interface Props { | ||
items: StructuredReportItemType[]; | ||
color: string; | ||
icon?: React.ComponentType<any>; | ||
pageSize?: number; | ||
} | ||
|
||
export function StructuredReportItemList({ items, color, icon, pageSize = 3 }: Props) { | ||
const [visibleCount, setVisibleCount] = useState(pageSize); | ||
const visibleItems = items.slice(0, visibleCount); | ||
const totalCount = items.length; | ||
|
||
return ( | ||
<> | ||
<ItemList> | ||
{visibleItems.map((item) => ( | ||
<StructuredReportItem item={item} color={color} icon={icon} key={item.rawType} /> | ||
))} | ||
</ItemList> | ||
{totalCount > visibleCount ? ( | ||
<ShowMoreSection | ||
totalCount={totalCount} | ||
visibleCount={visibleCount} | ||
setVisibleCount={setVisibleCount} | ||
pageSize={pageSize} | ||
/> | ||
) : null} | ||
</> | ||
); | ||
} |
Oops, something went wrong.
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.
Tip
Codebase Verification
Add test cases for
getIngestionSourceStatus
.The function
getIngestionSourceStatus
is used in multiple places in the codebase, but there are no test cases found for it. To ensure reliability and maintainability, please add comprehensive test cases for this function.getIngestionSourceStatus
:datahub-web-react/src/app/ingest/source/IngestionSourceTable.tsx
datahub-web-react/src/app/ingest/source/executions/IngestionExecutionTable.tsx
datahub-web-react/src/app/ingest/source/executions/ExecutionRequestDetailsModal.tsx
datahub-web-react/src/app/ingest/source/utils.ts
Analysis chain
Refactor to use
getIngestionSourceStatus
for status determination.The change centralizes the logic for determining the status of ingestion sources, which is a good practice for maintainability. Ensure that the
getIngestionSourceStatus
function is thoroughly tested to handle all possible statuses correctly.Also applies to: 115-115
Scripts executed
The following scripts were executed for the analysis:
Script:
Length of output: 82
Script:
Length of output: 1107