debian-image-builder-frontend/src/Components/CreateImageWizard/formComponents/Repositories.js
regexowl 9f5a0af826 Wizard: Update the Repositories step
This updates the Repositories and Review step as per [mocks](https://www.sketch.com/s/d7aa6d29-fca0-4283-a846-09cc5fd10612/a/MyEbDz7).

Repositories with the unavailable or invalid status have a popover that allows for further inspection. The time of the last introspection and the counter of failed attempts was added to the popover, together with the "Go to Repositories" button.

On Recreate the payload repositories are checked against "freshly" fetched list of repositories. In case any of the previously checked repositories is no longer available in content sources an Alert is rendered on both Repositories and Review steps. The unavailable repository is checked, but the checkbox is disabled and the information is dashed out. Since the information about the repository is stored in the Repository type, the only information available to be rendered is the baseurl.

Create image button is also disabled when recreating an image with unavailable repositories.
2023-09-11 10:30:04 +02:00

564 lines
17 KiB
JavaScript

import React, { useMemo, useState } from 'react';
import {
useFieldApi,
useFormApi,
} from '@data-driven-forms/react-form-renderer';
import {
Alert,
Button,
Dropdown,
DropdownItem,
DropdownToggle,
DropdownToggleCheckbox,
EmptyState,
EmptyStateBody,
EmptyStateIcon,
EmptyStateVariant,
Pagination,
Panel,
PanelMain,
SearchInput,
Spinner,
Title,
Toolbar,
ToolbarContent,
ToolbarItem,
} from '@patternfly/react-core';
import { ExternalLinkAltIcon } from '@patternfly/react-icons';
import { RepositoryIcon } from '@patternfly/react-icons';
import {
TableComposable,
Tbody,
Td,
Th,
Thead,
Tr,
} from '@patternfly/react-table';
import PropTypes from 'prop-types';
import RepositoriesStatus from './RepositoriesStatus';
import RepositoryUnavailable from './RepositoryUnavailable';
import { useListRepositoriesQuery } from '../../../store/contentSourcesApi';
import { releaseToVersion } from '../../../Utilities/releaseToVersion';
import { useGetEnvironment } from '../../../Utilities/useGetEnvironment';
const BulkSelect = ({
selected,
count,
filteredCount,
perPage,
handleSelectAll,
handleSelectPage,
handleDeselectAll,
isDisabled,
}) => {
const [dropdownIsOpen, setDropdownIsOpen] = useState(false);
const numSelected = selected.length;
const allSelected = count !== 0 ? numSelected === count : undefined;
const anySelected = numSelected > 0;
const someChecked = anySelected ? null : false;
const isChecked = allSelected ? true : someChecked;
const items = [
<DropdownItem
key="none"
onClick={handleDeselectAll}
>{`Select none (0 items)`}</DropdownItem>,
<DropdownItem key="page" onClick={handleSelectPage}>{`Select page (${
perPage > filteredCount ? filteredCount : perPage
} items)`}</DropdownItem>,
<DropdownItem
key="all"
onClick={handleSelectAll}
>{`Select all (${count} items)`}</DropdownItem>,
];
const handleDropdownSelect = () => {};
const toggleDropdown = () => setDropdownIsOpen(!dropdownIsOpen);
return (
<Dropdown
onSelect={handleDropdownSelect}
toggle={
<DropdownToggle
id="stacked-example-toggle"
isDisabled={isDisabled}
splitButtonItems={[
<DropdownToggleCheckbox
id="example-checkbox-1"
key="split-checkbox"
aria-label="Select all"
isChecked={isChecked}
onClick={() => {
anySelected ? handleDeselectAll() : handleSelectAll();
}}
/>,
]}
onToggle={toggleDropdown}
>
{numSelected !== 0 ? `${numSelected} selected` : null}
</DropdownToggle>
}
isOpen={dropdownIsOpen}
dropdownItems={items}
/>
);
};
// Utility function to convert from Content Sources to Image Builder payload repo API schema
const convertSchemaToIBPayloadRepo = (repo) => {
const imageBuilderRepo = {
baseurl: repo.url,
rhsm: false,
check_gpg: false,
};
if (repo.gpg_key) {
imageBuilderRepo.gpgkey = repo.gpg_key;
imageBuilderRepo.check_gpg = true;
imageBuilderRepo.check_repo_gpg = repo.metadata_verification;
}
return imageBuilderRepo;
};
// Utility function to convert from Content Sources to Image Builder custom repo API schema
const convertSchemaToIBCustomRepo = (repo) => {
const imageBuilderRepo = {
id: repo.uuid,
name: repo.name,
baseurl: [repo.url],
check_gpg: false,
};
if (repo.gpg_key) {
imageBuilderRepo.gpgkey = [repo.gpg_key];
imageBuilderRepo.check_gpg = true;
imageBuilderRepo.check_repo_gpg = repo.metadata_verification;
}
return imageBuilderRepo;
};
// Utility function to convert from Image Builder to Content Sources API schema
const convertSchemaToContentSources = (repo) => {
const contentSourcesRepo = {
url: repo.baseurl,
rhsm: false,
};
if (repo.gpgkey) {
contentSourcesRepo.gpg_key = repo.gpgkey;
contentSourcesRepo.metadata_verification = repo.check_repo_gpg;
}
return contentSourcesRepo;
};
const Repositories = (props) => {
const initializeRepositories = (contentSourcesReposList) => {
// Convert list of repositories into an object where key is repo URL
const contentSourcesRepos = contentSourcesReposList.reduce(
(accumulator, currentValue) => {
accumulator[currentValue.url] = currentValue;
return accumulator;
},
{}
);
// Repositories in the form state can be present when 'Recreate image' is used
// to open the wizard that are not necessarily in content sources.
const formStateReposList =
getState()?.values?.['original-payload-repositories'];
const mergeRepositories = (contentSourcesRepos, formStateReposList) => {
const formStateRepos = {};
for (const repo of formStateReposList) {
formStateRepos[repo.baseurl] = convertSchemaToContentSources(repo);
formStateRepos[repo.baseurl].name = '';
}
// In case of duplicate repo urls, the repo from Content Sources overwrites the
// repo from the form state.
const mergedRepos = { ...formStateRepos, ...contentSourcesRepos };
return mergedRepos;
};
const repositories = formStateReposList
? mergeRepositories(contentSourcesRepos, formStateReposList)
: contentSourcesRepos;
return repositories;
};
const { getState, change } = useFormApi();
const { input } = useFieldApi(props);
const [filterValue, setFilterValue] = useState('');
const [perPage, setPerPage] = useState(10);
const [page, setPage] = useState(1);
const [selected, setSelected] = useState(
getState()?.values?.['payload-repositories']
? getState().values['payload-repositories'].map((repo) => repo.baseurl)
: []
);
const release = getState().values?.release;
const version = releaseToVersion(release);
const firstRequest = useListRepositoriesQuery(
{
availableForArch: 'x86_64',
availableForVersion: version,
limit: 100,
offset: 0,
},
// The cached repos may be incorrect, for now refetch on mount to ensure that
// they are accurate when this step loads. Future PR will implement prefetching
// and this can be removed.
{ refetchOnMountOrArgChange: true }
);
const skip =
firstRequest?.data?.meta?.count === undefined ||
firstRequest?.data?.meta?.count <= 100;
// Fetch *all* repositories if there are more than 100 so that typeahead filter works
const followupRequest = useListRepositoriesQuery(
{
availableForArch: 'x86_64',
availableForVersion: version,
limit: firstRequest?.data?.meta?.count,
offset: 0,
},
{
refetchOnMountOrArgChange: true,
skip: skip,
}
);
const { data, isError, isFetching, isLoading, isSuccess, refetch } =
useMemo(() => {
if (firstRequest?.data?.meta?.count > 100) {
return { ...followupRequest };
}
return { ...firstRequest };
}, [firstRequest, followupRequest]);
const repositories = useMemo(() => {
return data ? initializeRepositories(data.data) : {};
}, [firstRequest.data, followupRequest.data]);
const isRepoSelected = (repoURL) => selected.includes(repoURL);
const handlePerPageSelect = (event, newPerPage, newPage) => {
setPerPage(newPerPage);
setPage(newPage);
};
const handleSetPage = (event, newPage) => {
setPage(newPage);
};
// filter displayed selected packages
const handleFilterRepositories = (_, value) => {
setPage(1);
setFilterValue(value);
};
const filteredRepositoryURLs = useMemo(() => {
const filteredRepoURLs = Object.values(repositories)
.filter((repo) =>
repo.name.toLowerCase().includes(filterValue.toLowerCase())
)
.map((repo) => repo.url);
return filteredRepoURLs;
}, [filterValue, repositories]);
const handleClearFilter = () => {
setFilterValue('');
};
const updateFormState = (selectedRepoURLs) => {
// repositories is stored as an object with repoURLs as keys
const selectedRepos = [];
for (const repoURL of selectedRepoURLs) {
selectedRepos.push(repositories[repoURL]);
}
const payloadRepositories = selectedRepos.map((repo) =>
convertSchemaToIBPayloadRepo(repo)
);
const customRepositories = selectedRepos.map((repo) =>
convertSchemaToIBCustomRepo(repo)
);
input.onChange(payloadRepositories);
change('custom-repositories', customRepositories);
};
const updateSelected = (selectedRepos) => {
setSelected(selectedRepos);
updateFormState(selectedRepos);
};
const handleSelect = (repoURL, rowIndex, isSelecting) => {
if (isSelecting === true) {
updateSelected([...selected, repoURL]);
} else if (isSelecting === false) {
updateSelected(
selected.filter((selectedRepoId) => selectedRepoId !== repoURL)
);
}
};
const handleSelectAll = () => {
updateSelected(Object.keys(repositories));
};
const computeStart = () => perPage * (page - 1);
const computeEnd = () => perPage * page;
const handleSelectPage = () => {
const pageRepos = filteredRepositoryURLs.slice(
computeStart(),
computeEnd()
);
// Filter to avoid adding duplicates
const newSelected = [
...pageRepos.filter((repoId) => !selected.includes(repoId)),
];
updateSelected([...selected, ...newSelected]);
};
const handleDeselectAll = () => {
updateSelected([]);
};
return (
(isError && <Error />) ||
(isLoading && <Loading />) ||
(isSuccess && (
<>
{Object.values(repositories).length === 0 ? (
<Empty refetch={refetch} isFetching={isFetching} />
) : (
<>
<Toolbar>
<ToolbarContent>
<ToolbarItem variant="bulk-select">
<BulkSelect
selected={selected}
count={Object.values(repositories).length}
filteredCount={filteredRepositoryURLs.length}
perPage={perPage}
handleSelectAll={handleSelectAll}
handleSelectPage={handleSelectPage}
handleDeselectAll={handleDeselectAll}
isDisabled={isFetching}
/>
</ToolbarItem>
<ToolbarItem variant="search-filter">
<SearchInput
aria-label="Search repositories"
onChange={handleFilterRepositories}
value={filterValue}
onClear={handleClearFilter}
/>
</ToolbarItem>
<ToolbarItem>
<Button
variant="primary"
isInline
onClick={() => refetch()}
isLoading={isFetching}
>
{isFetching ? 'Refreshing' : 'Refresh'}
</Button>
</ToolbarItem>
<ToolbarItem variant="pagination">
<Pagination
itemCount={filteredRepositoryURLs.length}
perPage={perPage}
page={page}
onSetPage={handleSetPage}
widgetId="compact-example"
onPerPageSelect={handlePerPageSelect}
isCompact
/>
</ToolbarItem>
</ToolbarContent>
</Toolbar>
<Panel isScrollable>
<PanelMain>
<RepositoryUnavailable />
<TableComposable
variant="compact"
data-testid="repositories-table"
>
<Thead>
<Tr>
<Th />
<Th width={45}>Name</Th>
<Th width={15}>Architecture</Th>
<Th>Version</Th>
<Th width={10}>Packages</Th>
<Th>Status</Th>
</Tr>
</Thead>
<Tbody>
{filteredRepositoryURLs
.slice()
.sort((a, b) => {
if (repositories[a].name < repositories[b].name) {
return -1;
} else if (
repositories[b].name < repositories[a].name
) {
return 1;
} else {
return 0;
}
})
.slice(computeStart(), computeEnd())
.map((repoURL, rowIndex) => {
const repo = repositories[repoURL];
const repoExists = repo.name ? true : false;
return (
<Tr key={repo.url}>
<Td
select={{
isSelected: isRepoSelected(repo.url),
rowIndex: rowIndex,
onSelect: (event, isSelecting) =>
handleSelect(repo.url, rowIndex, isSelecting),
disable: isFetching || repo.status !== 'Valid',
}}
/>
<Td dataLabel={'Name'}>
{repoExists
? repo.name
: 'Repository with the following url is no longer available:'}
<br />
<Button
component="a"
target="_blank"
variant="link"
icon={<ExternalLinkAltIcon />}
iconPosition="right"
isInline
href={repo.url}
>
{repo.url}
</Button>
</Td>
<Td dataLabel={'Architecture'}>
{repoExists ? repo.distribution_arch : '-'}
</Td>
<Td dataLabel={'Version'}>
{repoExists ? repo.distribution_versions : '-'}
</Td>
<Td dataLabel={'Packages'}>
{repoExists ? repo.package_count : '-'}
</Td>
<Td dataLabel={'Status'}>
<RepositoriesStatus
repoStatus={
repoExists ? repo.status : 'Unavailable'
}
repoUrl={repo.url}
repoIntrospections={
repo.last_introspection_time
}
repoFailCount={repo.failed_introspections_count}
/>
</Td>
</Tr>
);
})}
</Tbody>
</TableComposable>
</PanelMain>
</Panel>
</>
)}
</>
))
);
};
const Error = () => {
return (
<Alert title="Repositories unavailable" variant="danger" isPlain isInline>
Repositories cannot be reached, try again later.
</Alert>
);
};
const Loading = () => {
return (
<EmptyState>
<EmptyStateIcon variant="container" component={Spinner} />
<Title size="lg" headingLevel="h4">
Loading
</Title>
</EmptyState>
);
};
const Empty = ({ isFetching, refetch }) => {
const { isBeta } = useGetEnvironment();
return (
<EmptyState variant={EmptyStateVariant.large} data-testid="empty-state">
<EmptyStateIcon icon={RepositoryIcon} />
<Title headingLevel="h4" size="lg">
No Custom Repositories
</Title>
<EmptyStateBody>
Repositories can be added in the &quot;Repositories&quot; area of the
console. Once added, refresh this page to see them.
</EmptyStateBody>
<Button
variant="primary"
component="a"
target="_blank"
href={isBeta() ? '/preview/settings/content' : '/settings/content'}
className="pf-u-mr-sm"
>
Go to repositories
</Button>
<Button
variant="secondary"
isInline
onClick={() => refetch()}
isLoading={isFetching}
>
{isFetching ? 'Refreshing' : 'Refresh'}
</Button>
</EmptyState>
);
};
BulkSelect.propTypes = {
selected: PropTypes.array,
count: PropTypes.number,
filteredCount: PropTypes.number,
perPage: PropTypes.number,
handleSelectAll: PropTypes.func,
handleSelectPage: PropTypes.func,
handleDeselectAll: PropTypes.func,
isDisabled: PropTypes.bool,
};
Empty.propTypes = {
isFetching: PropTypes.bool,
refetch: PropTypes.func,
};
export default Repositories;