feat(cve): add compare cves feature for 2 images #420
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,7 +28,7 @@ const mockCVEList = { | |
| LowCount: 1, | ||
| MediumCount: 1, | ||
| HighCount: 1, | ||
| CriticalCount: 1 | ||
| }, | ||
| CVEList: [ | ||
| { | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| import React, { useState, useMemo } from 'react'; | ||
|
|
||
| // components | ||
| import { Button, Modal, Typography, Stack, Box } from '@mui/material'; | ||
| import makeStyles from '@mui/styles/makeStyles'; | ||
|
|
||
| import { api, endpoints } from 'api'; | ||
| import { host } from 'host'; | ||
| import ImageSelector from 'components/Tag/Tabs/ImageSelector'; | ||
| import VulnerabilitiyCard from 'components/Shared/VulnerabilityCard'; | ||
| import { isEmpty } from 'lodash'; | ||
| import { mapCVEInfo } from 'utilities/objectModels'; | ||
|
|
||
| const useStyles = makeStyles(() => ({ | ||
| imagesInputBox: { | ||
| padding: '0.5rem', | ||
| marginBottom: '0.5rem' | ||
| }, | ||
| input: { | ||
| color: '#464141', | ||
| '&::placeholder': { | ||
| opacity: '1' | ||
| } | ||
| }, | ||
| searchInputBase: { | ||
| width: '90%', | ||
| paddingLeft: '1rem', | ||
| border: '1px solid black', | ||
| height: 40, | ||
| color: 'rgba(0, 0, 0, 0.6)' | ||
| }, | ||
| compareImagesPopup: { | ||
| position: 'absolute', | ||
| top: '50%', | ||
| left: '50%', | ||
| transform: 'translate(-50%, -50%)', | ||
| backgroundColor: 'white', | ||
| border: '2px solid #000', | ||
| padding: '1rem' | ||
| }, | ||
| compareButton: { | ||
| paddingLeft: '0.5rem' | ||
| } | ||
| })); | ||
|
|
||
| function CompareImages({ name, tag, platform }) { | ||
| const classes = useStyles(); | ||
| const [open, setOpen] = useState(false); | ||
| const [minuend, setMinuend] = useState(''); | ||
| const [subtrahend, setSubtrahend] = useState(''); | ||
| const [cveData, setCVEData] = useState([]); | ||
| const handleOpen = () => setOpen(true); | ||
|
There was a problem hiding this comment. can just inline the handleOpen and handleClose functions if we don't want to add additional logic |
||
| const handleClose = () => setOpen(false); | ||
| const handleMinuendInput = (value) => { | ||
| setMinuend(value); | ||
| }; | ||
| const handleSubtrahendInput = (value) => { | ||
| setSubtrahend(value); | ||
| }; | ||
| const abortController = useMemo(() => new AbortController(), []); | ||
|
|
||
| const imageCVECompare = (minuend, subtrahend) => { | ||
| api | ||
| .get( | ||
| `${host()}${endpoints.cveDiffForImages(minuend, subtrahend, { pageNumber: 1, pageSize: 9 })}`, | ||
| abortController.signal | ||
| ) | ||
| .then((diffResponse) => { | ||
| const cveListData = mapCVEInfo(diffResponse.data.data.CVEDiffListForImages.CVEList); | ||
|
There was a problem hiding this comment. we should have some checks here before passing data to mapCVEInfo, make sure the response actually contains data |
||
| setCVEData(cveListData); | ||
| }) | ||
| .catch((e) => { | ||
| console.error(e); | ||
| }); | ||
| }; | ||
|
|
||
| const getImageRefComponents = (image) => { | ||
| if (image.includes('@')) { | ||
| let components = image.split('@'); | ||
|
|
||
| return [components[0], '', components[1]]; | ||
| } else if (image.includes(':')) { | ||
| let components = image.split(':'); | ||
| return [components[0], components[1], '']; | ||
| } | ||
|
|
||
| return [image, '', '']; | ||
| }; | ||
|
|
||
| const handleCompare = () => { | ||
| let [minuendRepo, minuendTag] = getImageRefComponents(minuend); | ||
|
There was a problem hiding this comment. I don't think this call will achieve what we want. You are only taking the first 2 values returned by the getImageRefComponents call, so in the return-case on line 80, the components[1] value will be lost |
||
| let [subtrahendRepo, subtrahendTag] = getImageRefComponents(subtrahend); | ||
| imageCVECompare({ repo: minuendRepo, tag: minuendTag }, { repo: subtrahendRepo, tag: subtrahendTag }); | ||
| }; | ||
|
|
||
| const renderCVEs = () => { | ||
| return !isEmpty(cveData) ? ( | ||
| cveData.map((cve, index) => { | ||
| return <VulnerabilitiyCard key={index} cve={cve} name={name} platform={platform} expand={true} />; | ||
| }) | ||
| ) : ( | ||
| <></> | ||
| ); | ||
| }; | ||
|
|
||
| return ( | ||
| <div> | ||
| <Button variant="outlined" onClick={handleOpen}> | ||
|
There was a problem hiding this comment. if this component is a modal popup, then control over when the modal is shown should be given to the parent component, meaning: take out the button that opens it, that should be in the parent component |
||
| Compare | ||
| </Button> | ||
| <Modal | ||
| open={open} | ||
| onClose={handleClose} | ||
| aria-labelledby="modal-modal-title" | ||
| aria-describedby="modal-modal-description" | ||
| > | ||
| <Stack direction="column" className={classes.compareImagesPopup}> | ||
| <Typography variant="h6" component="h2"> | ||
| Compare the vulnerabilities of 2 images | ||
| </Typography> | ||
| <Stack direction="row" spacing={2} className={classes.imagesInputBox}> | ||
| <ImageSelector | ||
| setSearchCurrentValue={handleMinuendInput} | ||
| name={name} | ||
| tag={tag} | ||
| // digest={digest} | ||
| // platform={platform} | ||
| /> | ||
| <ImageSelector setSearchCurrentValue={handleSubtrahendInput} name={name} tag={tag} /> | ||
| </Stack> | ||
| <Box className={classes.compareButton}> | ||
| <Button variant="outlined" onClick={handleCompare}> | ||
| Compare | ||
| </Button> | ||
| </Box> | ||
| <Box | ||
| sx={{ | ||
| mb: 2, | ||
| display: 'flex', | ||
| flexDirection: 'column', | ||
| height: 300, | ||
| overflow: 'hidden', | ||
| overflowY: 'scroll' | ||
| // justifyContent="flex-end" # DO NOT USE THIS WITH 'scroll' | ||
| }} | ||
| > | ||
| {renderCVEs()} | ||
| </Box> | ||
| </Stack> | ||
| </Modal> | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| export default CompareImages; | ||
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.
'minuend' and 'subtrahend' don't sound very suggestive of what the parameter represents. Is there a better name we can use perhaps?
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.
I struggled finding a better name, minuend means "from which you subtract" and subtrahend "how much you subtract". These are the most concise terms I know but I agree that they're quite mathematical and unfriendly
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.
Add a comment in the JS code explaining these.