Compare commits

...

2 Commits

Author SHA1 Message Date
7833b1dbce Enhance NewDocumentJob Component with Job Update Handling and Progress Display
Some checks reported errors
farmcontrol/farmcontrol-ui/pipeline/head Something is wrong with the build of this commit
- Integrated ProgressDisplay component to manage job deployment progress within the NewDocumentJob component.
- Added subscription to object updates for real-time job status tracking, improving user feedback during document processing.
- Refactored state management to handle job updates and deployment actions more effectively, enhancing overall functionality and user experience.
2026-08-22 14:02:29 +01:00
8035c2ba59 Refactor AppUpdateProgress and TemplatePreview to Use ProgressDisplay Component
- Replaced HProgress and ElipsisText with the new ProgressDisplay component in AppUpdateProgress for improved code clarity and reusability.
- Updated TemplatePreview to utilize ProgressDisplay for rendering download progress, enhancing consistency across components.
- Introduced ProgressDisplay component to encapsulate progress rendering logic, allowing for customizable label positioning and styling.
2026-08-22 13:37:36 +01:00
4 changed files with 309 additions and 178 deletions

View File

@ -5,8 +5,7 @@ import { Button, Flex, Modal, Typography, theme, Divider } from 'antd'
import CloudIcon from '../../../Icons/CloudIcon' import CloudIcon from '../../../Icons/CloudIcon'
import HostIcon from '../../../Icons/HostIcon' import HostIcon from '../../../Icons/HostIcon'
import ReloadIcon from '../../../Icons/ReloadIcon' import ReloadIcon from '../../../Icons/ReloadIcon'
import HProgress from '../../common/HProgress' import ProgressDisplay from '../../common/ProgressDisplay'
import ElipsisText from '../../common/ElipsisText'
import CheckCircleIcon from '../../../Icons/CheckCircleIcon' import CheckCircleIcon from '../../../Icons/CheckCircleIcon'
import XMarkCircleIcon from '../../../Icons/XMarkCircleIcon' import XMarkCircleIcon from '../../../Icons/XMarkCircleIcon'
@ -136,19 +135,16 @@ const UpdateStage = ({ stage, status, percent, detail }) => {
<Flex align='start' gap='24px' style={{ flex: 1, minWidth: 0 }}> <Flex align='start' gap='24px' style={{ flex: 1, minWidth: 0 }}>
<Text style={{ flexShrink: 0 }}>{config.labels[status]}</Text> <Text style={{ flexShrink: 0 }}>{config.labels[status]}</Text>
{showProgress && ( {showProgress && (
<Flex vertical gap={2} style={{ flex: 1, minWidth: 0 }}> <ProgressDisplay
<HProgress labelPosition='bottom'
labelType='secondary'
percent={resolvedPercent} percent={resolvedPercent}
status={getProgressStatus(status)} status={getProgressStatus(status)}
showInfo={typeof resolvedPercent === 'number'} showInfo={typeof resolvedPercent === 'number'}
style={{ flex: 1, margin: 0 }} style={{ flex: 1 }}
/> >
{detail && (
<ElipsisText type='secondary' style={{ minWidth: 0 }}>
{detail} {detail}
</ElipsisText> </ProgressDisplay>
)}
</Flex>
)} )}
</Flex> </Flex>
</Flex> </Flex>

View File

@ -3,14 +3,72 @@ import ObjectInfo from '../../common/ObjectInfo'
import NewObjectForm from '../../common/NewObjectForm' import NewObjectForm from '../../common/NewObjectForm'
import WizardView from '../../common/WizardView' import WizardView from '../../common/WizardView'
import TemplatePreview from '../../common/TemplatePreview' import TemplatePreview from '../../common/TemplatePreview'
import ProgressDisplay from '../../common/ProgressDisplay'
import { ApiServerContext } from '../../context/ApiServerContext' import { ApiServerContext } from '../../context/ApiServerContext'
import { useContext, useRef, useState } from 'react' import { useCallback, useContext, useEffect, useRef, useState } from 'react'
import { Modal } from 'antd'
import dayjs from 'dayjs' import dayjs from 'dayjs'
const NewDocumentJob = ({ onOk, defaultValues = {} }) => { const NewDocumentJob = ({ onOk, defaultValues = {} }) => {
const { sendObjectAction, downloadTemplate, formatFileName } = const {
useContext(ApiServerContext) sendObjectAction,
downloadTemplate,
formatFileName,
subscribeToObjectUpdates,
connected
} = useContext(ApiServerContext)
const [downloading, setDownloading] = useState(false) const [downloading, setDownloading] = useState(false)
const [deployingJob, setDeployingJob] = useState(null)
const onOkRef = useRef(onOk)
const pendingJobRef = useRef(null)
const deploySentRef = useRef(false)
const sendObjectActionRef = useRef(sendObjectAction)
onOkRef.current = onOk
sendObjectActionRef.current = sendObjectAction
const deployingJobId = deployingJob?._id
? String(deployingJob._id).toLowerCase()
: null
const handleJobUpdate = useCallback((updatedJob) => {
setDeployingJob((prev) => (prev ? { ...prev, ...updatedJob } : updatedJob))
}, [])
useEffect(() => {
if (!deployingJobId || connected != true) {
return
}
const unsubscribe = subscribeToObjectUpdates(
deployingJobId,
'documentJob',
handleJobUpdate
)
if (!deploySentRef.current && pendingJobRef.current) {
deploySentRef.current = true
sendObjectActionRef.current(
pendingJobRef.current.documentPrinter._id,
'documentPrinter',
{
type: 'deploy',
data: pendingJobRef.current
}
)
}
return () => {
if (unsubscribe) unsubscribe()
}
}, [deployingJobId, connected, subscribeToObjectUpdates, handleJobUpdate])
useEffect(() => {
const stateType = deployingJob?.state?.type
if (stateType === 'queued' || stateType === 'error') {
onOkRef.current?.()
}
}, [deployingJob?.state?.type])
// Capture initial default values so later prop changes don't re-initialize the form // Capture initial default values so later prop changes don't re-initialize the form
const defaultValuesRef = useRef({ const defaultValuesRef = useRef({
@ -20,6 +78,7 @@ const NewDocumentJob = ({ onOk, defaultValues = {} }) => {
}) })
return ( return (
<>
<NewObjectForm <NewObjectForm
type={'documentJob'} type={'documentJob'}
defaultValues={defaultValuesRef.current} defaultValues={defaultValuesRef.current}
@ -72,19 +131,16 @@ const NewDocumentJob = ({ onOk, defaultValues = {} }) => {
} }
onSubmit={async () => { onSubmit={async () => {
const newDocumentJob = await handleSubmit() const newDocumentJob = await handleSubmit()
if (newDocumentJob) { if (!newDocumentJob?._id) {
await sendObjectAction( return
newDocumentJob.documentPrinter._id,
'documentPrinter',
{
type: 'deploy',
data: newDocumentJob
}
)
if (onOk) {
onOk()
}
} }
pendingJobRef.current = newDocumentJob
deploySentRef.current = false
setDeployingJob({
...newDocumentJob,
state: { type: 'deploying', progress: 0 }
})
}} }}
actions={[ actions={[
{ {
@ -168,6 +224,29 @@ const NewDocumentJob = ({ onOk, defaultValues = {} }) => {
) )
}} }}
</NewObjectForm> </NewObjectForm>
<Modal
open={Boolean(deployingJob)}
footer={null}
closable={false}
maskClosable={false}
centered
destroyOnHidden={true}
zIndex={2000}
width={320}
getContainer={() => document.body}
>
<ProgressDisplay
percent={Math.round(
(Number(deployingJob?.state?.progress) || 0) * 100
)}
status={
deployingJob?.state?.type === 'error' ? 'exception' : 'active'
}
>
Please wait...
</ProgressDisplay>
</Modal>
</>
) )
} }

View File

@ -0,0 +1,61 @@
import PropTypes from 'prop-types'
import { Flex } from 'antd'
import HProgress from './HProgress'
import ElipsisText from './ElipsisText'
const ProgressDisplay = ({
children,
labelPosition = 'top',
labelType,
percent,
status,
showInfo,
style
}) => {
const label = children ? (
<ElipsisText type={labelType} style={{ width: '100%', minWidth: 0 }}>
{children}
</ElipsisText>
) : null
const progress = (
<HProgress
percent={percent}
status={status}
showInfo={showInfo}
style={{ flex: 1, margin: 0 }}
/>
)
return (
<Flex
vertical
gap={labelPosition === 'bottom' ? 2 : 10}
style={{ width: '100%', minWidth: 0, ...style }}
>
{labelPosition === 'bottom' ? (
<>
{progress}
{label}
</>
) : (
<>
{label}
{progress}
</>
)}
</Flex>
)
}
ProgressDisplay.propTypes = {
children: PropTypes.node,
labelPosition: PropTypes.oneOf(['top', 'bottom']),
labelType: PropTypes.oneOf(['secondary']),
percent: PropTypes.number,
status: PropTypes.oneOf(['normal', 'exception', 'active', 'success']),
showInfo: PropTypes.bool,
style: PropTypes.object
}
export default ProgressDisplay

View File

@ -7,7 +7,7 @@ import {
useCallback useCallback
} from 'react' } from 'react'
import PropTypes from 'prop-types' import PropTypes from 'prop-types'
import { Flex, Button, Input, Select, Typography, Card } from 'antd' import { Flex, Button, Input, Select, Card } from 'antd'
import PlusIcon from '../../Icons/PlusIcon.jsx' import PlusIcon from '../../Icons/PlusIcon.jsx'
import MinusIcon from '../../Icons/MinusIcon.jsx' import MinusIcon from '../../Icons/MinusIcon.jsx'
import InfoCircleIcon from '../../Icons/InfoCircleIcon.jsx' import InfoCircleIcon from '../../Icons/InfoCircleIcon.jsx'
@ -17,9 +17,7 @@ import ObjectProperty from '../common/ObjectProperty.jsx'
import PDFViewer from './PDFViewer.jsx' import PDFViewer from './PDFViewer.jsx'
import ScrollBox from './ScrollBox.jsx' import ScrollBox from './ScrollBox.jsx'
import { ApiServerContext } from '../context/ApiServerContext.jsx' import { ApiServerContext } from '../context/ApiServerContext.jsx'
import HProgress from './HProgress.jsx' import ProgressDisplay from './ProgressDisplay.jsx'
const { Text } = Typography
const noop = () => {} const noop = () => {}
@ -224,7 +222,7 @@ const TemplatePreview = ({
stopRenderProgressListener() stopRenderProgressListener()
setPDFBlob(null) setPDFBlob(null)
setReloadLoading(true) setReloadLoading(true)
setDownloadProgress({ progress: 0, message: 'Starting render' }) setDownloadProgress({ progress: 0, message: 'Starting render...' })
const startDownload = async () => { const startDownload = async () => {
try { try {
@ -590,17 +588,14 @@ const TemplatePreview = ({
}} }}
styles={{ body: { padding: 18 } }} styles={{ body: { padding: 18 } }}
> >
<Flex vertical gap={10} style={{ width: '100%' }}> <ProgressDisplay
<Text ellipsis style={{ width: '100%', minWidth: 0 }}>
{downloadProgress.message || 'Rendering...'}
</Text>
<HProgress
percent={Math.round( percent={Math.round(
(Number(downloadProgress.progress) || 0) * 100 (Number(downloadProgress.progress) || 0) * 100
)} )}
status='active' status='active'
/> >
</Flex> {downloadProgress.message || 'Rendering...'}
</ProgressDisplay>
</Card> </Card>
</Flex> </Flex>
) : null} ) : null}