Skip to content

Commit cb91b9b

Browse files
authored
Rename workflow-summary-tab to workflow-summary (#994)
* Move summary tab and update imports * update component names
1 parent c4ae483 commit cb91b9b

21 files changed

+59
-60
lines changed

src/views/workflow-history/workflow-history-event-details-json/__tests__/workflow-history-event-details-json.test.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { render } from '@/test-utils/rtl';
44

55
import losslessJsonStringify from '@/utils/lossless-json-stringify';
66

7-
import WorkflowSummaryTabJsonView from '../workflow-history-event-details-json';
7+
import WorkflowHistoryEventDetailsJson from '../workflow-history-event-details-json';
88

99
jest.mock('@/components/copy-text-button/copy-text-button', () =>
1010
jest.fn(({ textToCopy }) => <div>Copy Button: {textToCopy}</div>)
@@ -22,15 +22,15 @@ describe('WorkflowHistoryEventDetailsJson', () => {
2222

2323
it('renders correctly with initial props', () => {
2424
const { getByText } = render(
25-
<WorkflowSummaryTabJsonView entryValue={losslessInputJson} />
25+
<WorkflowHistoryEventDetailsJson entryValue={losslessInputJson} />
2626
);
2727

2828
expect(getByText('PrettyJson Mock')).toBeInTheDocument();
2929
});
3030

3131
it('renders copy text button and pass the correct text', () => {
3232
const { getByText } = render(
33-
<WorkflowSummaryTabJsonView entryValue={losslessInputJson} />
33+
<WorkflowHistoryEventDetailsJson entryValue={losslessInputJson} />
3434
);
3535

3636
const copyButton = getByText(/Copy Button/);

src/views/workflow-page/config/workflow-page-tabs.config.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import WorkflowDiagnostics from '@/views/workflow-diagnostics/workflow-diagnosti
1111
import WorkflowHistoryWrapper from '@/views/workflow-history/workflow-history-wrapper/workflow-history-wrapper';
1212
import WorkflowQueries from '@/views/workflow-queries/workflow-queries';
1313
import WorkflowStackTrace from '@/views/workflow-stack-trace/workflow-stack-trace';
14-
import WorkflowSummaryTab from '@/views/workflow-summary-tab/workflow-summary-tab';
14+
import WorkflowSummary from '@/views/workflow-summary/workflow-summary';
1515

1616
import getWorkflowPageErrorConfig from '../helpers/get-workflow-page-error-config';
1717
import WorkflowPageDiagnosticsBadge from '../workflow-page-diagnostics-badge/workflow-page-diagnostics-badge';
@@ -24,7 +24,7 @@ const workflowPageTabsConfig: WorkflowPageTabsConfig<
2424
summary: {
2525
title: 'Summary',
2626
artwork: MdListAlt,
27-
content: WorkflowSummaryTab,
27+
content: WorkflowSummary,
2828
getErrorConfig: (err) =>
2929
getWorkflowPageErrorConfig(
3030
err,

src/views/workflow-summary-tab/__tests__/workflow-summary-tab.test.tsx renamed to src/views/workflow-summary/__tests__/workflow-summary.test.tsx

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,22 @@ import { type GetWorkflowExecutionHistoryResponse } from '@/__generated__/proto-
77
import { startWorkflowExecutionEvent } from '@/views/workflow-history/__fixtures__/workflow-history-single-events';
88
import { type WorkflowPageTabContentProps } from '@/views/workflow-page/workflow-page-tab-content/workflow-page-tab-content.types';
99

10-
import WorkflowSummaryTab from '../workflow-summary-tab';
10+
import WorkflowSummary from '../workflow-summary';
1111

12-
jest.mock('../workflow-summary-tab-details/workflow-summary-tab-details', () =>
13-
jest.fn(() => <div>MockWorkflowSummaryTabDetails</div>)
12+
jest.mock('../workflow-summary-details/workflow-summary-details', () =>
13+
jest.fn(() => <div>MockWorkflowSummaryDetails</div>)
1414
);
1515

16-
jest.mock(
17-
'../workflow-summary-tab-json-view/workflow-summary-tab-json-view',
18-
() => jest.fn(() => <div>MockWorkflowSummaryTabJsonView</div>)
16+
jest.mock('../workflow-summary-json-view/workflow-summary-json-view', () =>
17+
jest.fn(() => <div>MockWorkflowSummaryJsonView</div>)
1918
);
2019

2120
jest.mock(
22-
'../workflow-summary-tab-diagnostics-banner/workflow-summary-tab-diagnostics-banner',
23-
() => jest.fn(() => <div>MockWorkflowSummaryTabDiagnosticsBanner</div>)
21+
'../workflow-summary-diagnostics-banner/workflow-summary-diagnostics-banner',
22+
() => jest.fn(() => <div>MockWorkflowSummaryDiagnosticsBanner</div>)
2423
);
2524

26-
describe('WorkflowSummaryTab', () => {
25+
describe('WorkflowSummary', () => {
2726
beforeEach(() => {
2827
jest.clearAllMocks();
2928
});
@@ -39,7 +38,7 @@ describe('WorkflowSummaryTab', () => {
3938
it('should render tab deatils, JSON view, and diagnostics banner', async () => {
4039
render(
4140
<Suspense>
42-
<WorkflowSummaryTab params={params} />
41+
<WorkflowSummary params={params} />
4342
</Suspense>,
4443
{
4544
endpointsMocks: [
@@ -70,13 +69,13 @@ describe('WorkflowSummaryTab', () => {
7069
}
7170
);
7271
expect(
73-
await screen.findByText('MockWorkflowSummaryTabDetails')
72+
await screen.findByText('MockWorkflowSummaryDetails')
7473
).toBeInTheDocument();
7574
expect(
76-
await screen.findByText('MockWorkflowSummaryTabJsonView')
75+
await screen.findByText('MockWorkflowSummaryJsonView')
7776
).toBeInTheDocument();
7877
expect(
79-
await screen.findByText('MockWorkflowSummaryTabDiagnosticsBanner')
78+
await screen.findByText('MockWorkflowSummaryDiagnosticsBanner')
8079
).toBeInTheDocument();
8180
});
8281
});

src/views/workflow-summary-tab/config/workflow-summary-tab-details.config.ts renamed to src/views/workflow-summary/config/workflow-summary-details.config.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ import WorkflowStatusTag from '@/views/shared/workflow-status-tag/workflow-statu
66
import getWorkflowStatusTagProps from '@/views/workflow-page/helpers/get-workflow-status-tag-props';
77

88
import WorkflowEventDetailsExecutionLink from '../../shared/workflow-event-details-execution-link/workflow-event-details-execution-link';
9-
import { type WorkflowSummaryTabDetailsConfig } from '../workflow-summary-tab-details/workflow-summary-tab-details.types';
9+
import { type WorkflowSummaryDetailsConfig } from '../workflow-summary-details/workflow-summary-details.types';
1010

11-
const workflowSummaryTabDetailsConfig: WorkflowSummaryTabDetailsConfig[] = [
11+
const workflowSummaryDetailsConfig: WorkflowSummaryDetailsConfig[] = [
1212
{
1313
key: 'status',
1414
getLabel: () => 'Status',
@@ -146,4 +146,4 @@ const workflowSummaryTabDetailsConfig: WorkflowSummaryTabDetailsConfig[] = [
146146
},
147147
];
148148

149-
export default workflowSummaryTabDetailsConfig;
149+
export default workflowSummaryDetailsConfig;
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ import {
1010
startWorkflowExecutionEvent,
1111
} from '@/views/workflow-history/__fixtures__/workflow-history-single-events';
1212

13-
import WorkflowSummaryTabDetails from '../workflow-summary-tab-details';
13+
import WorkflowSummaryDetails from '../workflow-summary-details';
1414
import {
15-
type WorkflowSummaryTabDetailsConfig,
15+
type WorkflowSummaryDetailsConfig,
1616
type Props,
17-
} from '../workflow-summary-tab-details.types';
17+
} from '../workflow-summary-details.types';
1818

1919
jest.mock(
20-
'../../config/workflow-summary-tab-details.config',
20+
'../../config/workflow-summary-details.config',
2121
() =>
2222
[
2323
{
@@ -37,7 +37,7 @@ jest.mock(
3737
getLabel: () => 'Hidden Label 3',
3838
valueComponent: () => <span>Hidden Value 3</span>,
3939
},
40-
] satisfies WorkflowSummaryTabDetailsConfig[]
40+
] satisfies WorkflowSummaryDetailsConfig[]
4141
);
4242

4343
const params: Props['decodedPageUrlParams'] = {
@@ -56,7 +56,7 @@ const mockWorkflowDetails: DescribeWorkflowResponse = {
5656
workflowExecutionInfo: null,
5757
};
5858

59-
describe('WorkflowSummaryTabDetails', () => {
59+
describe('WorkflowSummaryDetails', () => {
6060
// TODO @assem.hafez enhance typing for formattedFirstHistoryEvent
6161
//@ts-expect-error - TS is complaining about the type of formattedFirstHistoryEvent
6262
const formattedFirstHistoryEvent: FormattedHistoryEventForType<'WorkflowExecutionStarted'> =
@@ -66,7 +66,7 @@ describe('WorkflowSummaryTabDetails', () => {
6666
);
6767
it('should render workflow type name from firstHistoryEvent', () => {
6868
render(
69-
<WorkflowSummaryTabDetails
69+
<WorkflowSummaryDetails
7070
firstHistoryEvent={startWorkflowExecutionEvent}
7171
closeHistoryEvent={completeWorkflowExecutionEvent}
7272
formattedFirstHistoryEvent={formattedFirstHistoryEvent}
@@ -82,7 +82,7 @@ describe('WorkflowSummaryTabDetails', () => {
8282

8383
it('should render all detail rows that are not hidden', () => {
8484
render(
85-
<WorkflowSummaryTabDetails
85+
<WorkflowSummaryDetails
8686
firstHistoryEvent={startWorkflowExecutionEvent}
8787
closeHistoryEvent={completeWorkflowExecutionEvent}
8888
formattedFirstHistoryEvent={formattedFirstHistoryEvent}
@@ -100,7 +100,7 @@ describe('WorkflowSummaryTabDetails', () => {
100100

101101
it('should not render detail rows that are hidden', () => {
102102
render(
103-
<WorkflowSummaryTabDetails
103+
<WorkflowSummaryDetails
104104
firstHistoryEvent={startWorkflowExecutionEvent}
105105
closeHistoryEvent={completeWorkflowExecutionEvent}
106106
formattedFirstHistoryEvent={formattedFirstHistoryEvent}
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ import { LabelMedium } from 'baseui/typography';
55

66
import useStyletronClasses from '@/hooks/use-styletron-classes';
77

8-
import workflowSummaryTabDetailsConfig from '../config/workflow-summary-tab-details.config';
8+
import workflowSummaryDetailsConfig from '../config/workflow-summary-details.config';
99

10-
import { cssStyles } from './workflow-summary-tab-details.styles';
11-
import { type Props } from './workflow-summary-tab-details.types';
10+
import { cssStyles } from './workflow-summary-details.styles';
11+
import { type Props } from './workflow-summary-details.types';
1212

13-
export default function WorkflowSummaryTabDetails({
13+
export default function WorkflowSummaryDetails({
1414
firstHistoryEvent,
1515
closeHistoryEvent,
1616
formattedFirstHistoryEvent,
@@ -32,7 +32,7 @@ export default function WorkflowSummaryTabDetails({
3232
</LabelMedium>
3333
</div>
3434
<div>
35-
{workflowSummaryTabDetailsConfig
35+
{workflowSummaryDetailsConfig
3636
.filter(
3737
(c) =>
3838
!c.hide ||
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ export type Props = {
1717
decodedPageUrlParams: WorkflowPageTabContentProps['params'];
1818
};
1919

20-
export type WorkflowSummaryTabDetailsComponent =
20+
export type WorkflowSummaryDetailsComponent =
2121
| keyof JSX.IntrinsicElements
2222
| React.JSXElementConstructor<any>;
2323

24-
export type WorkflowSummaryTabDetailsConfig = {
24+
export type WorkflowSummaryDetailsConfig = {
2525
key: string;
2626
getLabel: () => string;
2727
valueComponent: React.ComponentType<{

0 commit comments

Comments
 (0)