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

compactMode: add collapsible functionality + reog job card layout #687

Merged
merged 7 commits into from
Feb 27, 2024
Merged
Show file tree
Hide file tree
Changes from 6 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
1 change: 1 addition & 0 deletions packages/ui/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
"@babel/runtime": "^7.17.9",
"@pmmmwh/react-refresh-webpack-plugin": "^0.5.5",
"@radix-ui/react-alert-dialog": "^1.0.4",
"@radix-ui/react-collapsible": "^1.0.3",
"@radix-ui/react-dialog": "^1.0.4",
"@radix-ui/react-dropdown-menu": "^2.0.5",
"@radix-ui/react-switch": "^1.0.3",
Expand Down
84 changes: 36 additions & 48 deletions packages/ui/src/components/Highlight/Highlight.tsx
Original file line number Diff line number Diff line change
@@ -1,58 +1,46 @@
import cn from 'clsx';
import React from 'react';
import React, { useEffect, useState } from 'react';
import { asyncHighlight } from '../../utils/highlight/highlight';
import s from './Highlight.module.css';
import { Button } from '../Button/Button';
import { CopyIcon } from '../Icons/Copy';

interface HighlightProps {
language: 'json' | 'stacktrace';
children: string | null;
text: string;
}

export class Highlight extends React.Component<HighlightProps> {
private codeRef = React.createRef<HTMLPreElement>();

public shouldComponentUpdate(nextProps: Readonly<HighlightProps>) {
return (
nextProps.language !== this.props.language ||
(Array.isArray(this.props.children)
? this.props.children.some(
(item: any) => !([] as any).concat(nextProps.children).includes(item)
)
: nextProps.children !== this.props.children)
);
}

public componentDidMount() {
return this.highlightCode();
}

public componentDidUpdate() {
return this.highlightCode();
}

public render() {
const { language } = this.props;
return (
<div className={s.codeContainerWrapper}>
<pre ref={this.codeRef}>
<code className={cn('hljs', language)} />
</pre>
<Button
onClick={() => navigator.clipboard.writeText(this.props.children ?? '')}
className={s.copyBtn}
>
<CopyIcon />
</Button>
</div>
);
}

private async highlightCode() {
const node = this.codeRef.current?.querySelector('code');
if (node) {
node.innerHTML = await asyncHighlight(this.props.children as string, this.props.language);
}
}
}
export const Highlight: React.FC<HighlightProps> = ({ language, text }) => {
Copy link
Owner

Choose a reason for hiding this comment

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

Pls move this refactor to a separate PR 🙏🏽

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sure! lets process this first 👍🏽

const [code, setCode] = useState<string>('');

const textToCode = async () => {
setCode(await asyncHighlight(text as string, language));
};

useEffect(() => {
textToCode();
}, []);

useEffect(() => {
textToCode();
}, [language, text]);

const handleCopyClick = () => {
navigator.clipboard.writeText(text ?? '');
};

return (
<div className={s.codeContainerWrapper}>
<pre>
<code className={cn('hljs', language)} dangerouslySetInnerHTML={{ __html: code }} />
</pre>

<Button
onClick={handleCopyClick}
className={s.copyBtn}
>
<CopyIcon />
</Button>
</div>
);
};
5 changes: 5 additions & 0 deletions packages/ui/src/components/Icons/ArrowUpIcon.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import React from 'react';

export const ArrowUpIcon = () => (
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M241 130.5l194.3 194.3c9.4 9.4 9.4 24.6 0 33.9l-22.7 22.7c-9.4 9.4-24.5 9.4-33.9 0L224 227.5 69.3 381.5c-9.4 9.3-24.5 9.3-33.9 0l-22.7-22.7c-9.4-9.4-9.4-24.6 0-33.9L207 130.5C216.4 121.2 231.6 121.2 241 130.5z"/></svg>
);
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
.tabActions {
list-style: none;
padding: 0;
margin: 1rem 0 2rem;
margin: 1rem 0 0.5rem;
display: flex;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export const DetailsContent = ({ selectedTab, job, actions }: DetailsContentProp
const { t } = useTranslation();
const { collapseJobData, collapseJobOptions, collapseJobError } = useSettingsStore();
const [collapseState, setCollapse] = useState({ data: false, options: false, error: false });
const { stacktrace, data, returnValue, opts, failedReason } = job;
const { stacktrace, data: jobData, returnValue, opts, failedReason } = job;

switch (selectedTab) {
case 'Data':
Expand All @@ -29,15 +29,16 @@ export const DetailsContent = ({ selectedTab, job, actions }: DetailsContentProp
{t('JOB.SHOW_DATA_BTN')} <ArrowDownIcon />
</Button>
) : (
<Highlight language="json">{JSON.stringify({ data, returnValue }, null, 2)}</Highlight>
<Highlight language="json" text={JSON.stringify({ jobData, returnValue }, null, 2)}
/>
);
case 'Options':
return collapseJobOptions && !collapseState.options ? (
<Button onClick={() => setCollapse({ ...collapseState, options: true })}>
{t('JOB.SHOW_OPTIONS_BTN')} <ArrowDownIcon />
</Button>
) : (
<Highlight language="json">{JSON.stringify(opts, null, 2)}</Highlight>
<Highlight language="json" text={JSON.stringify(opts, null, 2)} />
);
case 'Error':
if (stacktrace.length === 0) {
Expand All @@ -49,9 +50,7 @@ export const DetailsContent = ({ selectedTab, job, actions }: DetailsContentProp
{t('JOB.SHOW_ERRORS_BTN')} <ArrowDownIcon />
</Button>
) : (
<Highlight language="stacktrace" key="stacktrace">
{stacktrace.join('\n')}
</Highlight>
<Highlight language="stacktrace" key="stacktrace" text={stacktrace.join('\n')} />
);
case 'Logs':
return <JobLogs actions={actions} job={job} />;
Expand Down
28 changes: 24 additions & 4 deletions packages/ui/src/components/JobCard/JobCard.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,13 @@
box-shadow: 0 1px 1px 0 rgba(60, 75, 100, 0.14), 0 2px 1px -1px rgba(60, 75, 100, 0.12),
0 1px 3px 0 rgba(60, 75, 100, 0.2);
border-radius: 0.25rem;
padding: 1em;
padding: 0.66em;
display: flex;
min-height: 320px;
max-height: 500px;
}

.card + .card {
margin-top: 2rem;
margin-top: 0.75rem;
}

.contentWrapper {
Expand All @@ -21,7 +20,10 @@

.title {
display: flex;
align-items: baseline;
justify-content: space-between;
padding-bottom: 0.5rem;
border-bottom: 1px solid #e2e8f0;
}

.title h4,
Expand All @@ -38,6 +40,19 @@
font-size: 0.694em;
}

.header {
display: flex;
width: 100%;
justify-content: space-between;
align-items: center;
}

.details {
display: flex;
margin-top: 1rem;
width: 100%;
}

.sideInfo {
width: 200px;
padding-right: 2rem;
Expand All @@ -57,6 +72,10 @@
padding-right: 1rem;
}

.collapseBtn {
padding: 0.15rem;
}

.content {
position: relative;
flex: 1;
Expand All @@ -70,5 +89,6 @@
}

.jobLink {
text-decoration: none;
color: #4a5568;
font-size: large;
}
117 changes: 77 additions & 40 deletions packages/ui/src/components/JobCard/JobCard.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ import React from 'react';
import { useTranslation } from 'react-i18next';
import { Link } from 'react-router-dom';
import { Card } from '../Card/Card';
import { ArrowDownIcon } from '../Icons/ArrowDownIcon';
import { useSettingsStore } from '../../hooks/useSettings';
import { ArrowUpIcon } from '../Icons/ArrowUpIcon';
import { Button } from '../Button/Button';
import * as Collapsible from '@radix-ui/react-collapsible';
import { Details } from './Details/Details';
import { JobActions } from './JobActions/JobActions';
import s from './JobCard.module.css';
Expand Down Expand Up @@ -35,49 +40,81 @@ export const JobCard = ({
jobUrl,
}: JobCardProps) => {
const { t } = useTranslation();
const { collapseJob } = useSettingsStore();

const [isOpen, setIsOpen] = React.useState(false);

React.useEffect(() => {
setIsOpen(!jobUrl ? true : !collapseJob)
}), [jobUrl, collapseJob];

const JobTitle = <h4 title={`#${job.id}`}>#{job.id}</h4>

return (
<Card className={s.card}>
<div className={s.sideInfo}>
{jobUrl ? (
<Link className={s.jobLink} to={jobUrl}>
<span title={`#${job.id}`}>#{job.id}</span>
</Link>
) : (
<span title={`#${job.id}`}>#{job.id}</span>
)}
<Timeline job={job} status={status} />
</div>
<div className={s.contentWrapper}>
<div className={s.title}>
<h4>
{job.name}
{job.attempts > 1 && <span>{t('JOB.ATTEMPTS', { attempts: job.attempts })}</span>}
{!!job.opts?.repeat?.count && (
<span>
{t(`JOB.REPEAT${!!job.opts?.repeat?.limit ? '_WITH_LIMIT' : ''}`, {
count: job.opts.repeat.count,
limit: job.opts?.repeat?.limit,
})}
</span>
)}
</h4>
{!readOnlyMode && (
<JobActions status={status} actions={actions} allowRetries={allowRetries} />
)}
</div>
<div className={s.content}>
<Details status={status} job={job} actions={actions} />
{typeof job.progress === 'number' && (
<Progress
percentage={job.progress}
status={
job.isFailed && !greenStatuses.includes(status as any) ? STATUSES.failed : status
}
className={s.progress}
/>
)}
<Collapsible.Root style={{ width: '100%' }} open={isOpen}>
<div className={s.header}>
{jobUrl ? (
<Link className={s.jobLink} to={jobUrl}>
{JobTitle}
</Link>
) : JobTitle}

<Collapsible.Trigger style={{ border: 'none', borderRadius: '5px' }}>
<Button className={s.collapseBtn} onClick={() => setIsOpen(!isOpen)}>
{isOpen ? <ArrowUpIcon/> : <ArrowDownIcon/>}
</Button>
</Collapsible.Trigger>
</div>
</div>

<Collapsible.Content>
<div className={s.details}>
<div className={s.sideInfo}>
<Timeline job={job} status={status} />
</div>

<div className={s.contentWrapper}>
<div className={s.title}>
<h5>
{t('JOB.NAME')}: {job.name}
{job.attempts > 1 && (
<span style={{marginLeft: '0.5rem'}}>
- {t('JOB.ATTEMPTS', { attempts: job.attempts })}
</span>
)}

{!!job.opts?.repeat?.count && (
<span>
{t(`JOB.REPEAT${!!job.opts?.repeat?.limit ? '_WITH_LIMIT' : ''}`, {
count: job.opts.repeat.count,
limit: job.opts?.repeat?.limit,
})}
</span>
)}
</h5>

{!readOnlyMode && (
<JobActions status={status} actions={actions} allowRetries={allowRetries} />
)}
</div>

<div className={s.content}>
<Details status={status} job={job} actions={actions} />

{typeof job.progress === 'number' && (
<Progress
percentage={job.progress}
status={
job.isFailed && !greenStatuses.includes(status as any) ? STATUSES.failed : status
}
className={s.progress}
/>
)}
</div>
</div>
</div>
</Collapsible.Content>
</Collapsible.Root>
</Card>
);
};
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.timeline {
padding: 1.5rem 1rem 1.5rem 0;
padding: 0.25rem 1rem 1rem 0;
margin: 0;
list-style: none;
border: 0;
Expand Down
7 changes: 7 additions & 0 deletions packages/ui/src/components/SettingsModal/SettingsModal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ export const SettingsModal = ({ open, onClose }: SettingsModalProps) => {
jobsPerPage,
confirmQueueActions,
confirmJobActions,
collapseJob,
collapseJobData,
collapseJobOptions,
collapseJobError,
Expand Down Expand Up @@ -81,6 +82,12 @@ export const SettingsModal = ({ open, onClose }: SettingsModalProps) => {
checked={confirmJobActions}
onCheckedChange={(checked) => setSettings({ confirmJobActions: checked })}
/>
<SwitchField
label={t('SETTINGS.COLLAPSE_JOB')}
id="collapse-job"
checked={collapseJob}
onCheckedChange={(checked) => setSettings({ collapseJob: checked })}
/>
<SwitchField
label={t('SETTINGS.COLLAPSE_JOB_DATA')}
id="collapse-job-data"
Expand Down
Loading
Loading