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: display labels on execution detail page #882

Merged
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
@@ -0,0 +1,37 @@
import React from 'react';
import Chip from '@mui/material/Chip';
import makeStyles from '@mui/styles/makeStyles';

type ValuesType = {[p: string]: string};
interface Props {
values: ValuesType;
}

const useStyles = makeStyles({
chipContainer: {
display: 'flex',
flexWrap: 'wrap',
width: '100%',
maxWidth: '420px'
},
chip: {
margin: '2px 2px 2px 0',
},
});


export const ExecutionLabels: React.FC<Props> = ({values}) => {
const classes = useStyles();
return (
<div className={classes.chipContainer}>
{Object.entries(values).map(([key, value]) => (
<Chip
color='info'
key={key}
label={value ? `${key}: ${value}` : key}
className={classes.chip}
/>
))}
</div>
);
};
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import { ExecutionContext } from '../contexts';
import { ExpandableExecutionError } from '../Tables/ExpandableExecutionError';
import { ExecutionMetadataLabels } from './constants';
import { ExecutionMetadataExtra } from './ExecutionMetadataExtra';
import { ExecutionLabels } from './ExecutionLabels';

const StyledContainer = styled('div')(({ theme }) => {
return {
Expand Down Expand Up @@ -69,6 +70,7 @@ export const ExecutionMetadata: React.FC<{}> = () => {
const startedAt = execution?.closure?.startedAt;
const workflowId = execution?.closure?.workflowId;

const { labels } = execution.spec;
const {
referenceExecution,
systemMetadata ,
Expand Down Expand Up @@ -118,9 +120,19 @@ export const ExecutionMetadata: React.FC<{}> = () => {
<RouterLink
className={commonStyles.primaryLinks}
to={Routes.ExecutionDetails.makeUrl(parentNodeExecution.executionId)}
>
>
{parentNodeExecution.executionId.name}
</RouterLink>
),
});
}

if (labels != null && labels.values != null) {
details.push({
label: ExecutionMetadataLabels.labels,
value: (
Object.entries(labels.values).length > 0 ?
<ExecutionLabels values={labels.values} /> : dashedValueString
)
})
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ export enum ExecutionMetadataLabels {
interruptible = 'Interruptible override',
overwriteCache = 'Overwrite cached outputs',
parent = 'Parent',
labels = 'Labels',
}

export const tabs = {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
import React from 'react';
import { render, screen } from '@testing-library/react';
import '@testing-library/jest-dom';
import { ExecutionLabels } from '../ExecutionLabels';

jest.mock('@mui/material/Chip', () => (props: any) => (
<div data-testid="chip" {...props}>{props.label}</div>
));

describe('ExecutionLabels', () => {
it('renders chips with key-value pairs correctly', () => {
const values = {
'random/uuid': 'f8b9ff18-4811-4bcc-aefd-4f4ec4de469d',
'bar': 'baz',
'foo': '',
};

render(<ExecutionLabels values={values} />);

expect(screen.getByText('random/uuid: f8b9ff18-4811-4bcc-aefd-4f4ec4de469d')).toBeInTheDocument();
expect(screen.getByText('bar: baz')).toBeInTheDocument();
expect(screen.getByText('foo')).toBeInTheDocument();
});

it('applies correct styles to chip container', () => {
const values = {
'key': 'value',
};

const { container } = render(<ExecutionLabels values={values} />);
const chipContainer = container.firstChild;

expect(chipContainer).toHaveStyle('display: flex');
expect(chipContainer).toHaveStyle('flex-wrap: wrap');
expect(chipContainer).toHaveStyle('width: 100%');
expect(chipContainer).toHaveStyle('max-width: 420px');
});

it('renders correct number of chips', () => {
const values = {
'key1': 'value1',
'key2': 'value2',
'key3': 'value3',
};

render(<ExecutionLabels values={values} />);

const chips = screen.getAllByTestId('chip');
expect(chips.length).toBe(3);
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ const interruptibleTestId = `metadata-${ExecutionMetadataLabels.interruptible}`;
const overwriteCacheTestId = `metadata-${ExecutionMetadataLabels.overwriteCache}`;
const relatedToTestId = `metadata-${ExecutionMetadataLabels.relatedTo}`;
const parentNodeExecutionTestId = `metadata-${ExecutionMetadataLabels.parent}`
const labelsTestId = `metadata-${ExecutionMetadataLabels.labels}`;

jest.mock('../../../../models/Launch/api', () => ({
getLaunchPlan: jest.fn(() => Promise.resolve({ spec: {} })),
Expand Down Expand Up @@ -118,4 +119,9 @@ describe('ExecutionMetadata', () => {
const { getByTestId } = renderMetadata();
expect(getByTestId(parentNodeExecutionTestId)).toHaveTextContent('name');
})

it('shows labels if spec has them', () => {
const { getByTestId } = renderMetadata();
expect(getByTestId(labelsTestId)).toHaveTextContent("key: value");
})
});
5 changes: 5 additions & 0 deletions packages/oss-console/src/models/__mocks__/executionsData.ts
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,11 @@ export const createMockExecutionSpec: () => ExecutionSpec = () => ({
launchPlan: { ...MOCK_LAUNCH_PLAN_ID },
notifications: { notifications: [] },
metadata: generateExecutionMetadata(),
labels: {
values: {
"key": "value"
}
}
});

export const createMockExecution: (id?: string | number) => Execution = (id = 1) => {
Expand Down
Loading