| 1 |
import React, { useEffect, useState } from "react"; |
| 2 |
// PatternFly |
| 3 |
import { |
| 4 |
Flex, |
| 5 |
FlexItem, |
| 6 |
PageSection, |
| 7 |
PaginationVariant, |
| 8 |
ToolbarItemVariant, |
| 9 |
} from "@patternfly/react-core"; |
| 10 |
// PatternFly table |
| 11 |
import { |
| 12 |
InnerScrollContainer, |
| 13 |
OuterScrollContainer, |
| 14 |
} from "@patternfly/react-table"; |
| 15 |
// Data types |
| 16 |
import { HBACService } from "src/utils/datatypes/globalDataTypes"; |
| 17 |
import { ToolbarItem } from "src/components/layouts/ToolbarLayout"; |
| 18 |
// Redux |
| 19 |
import { useAppSelector, useAppDispatch } from "src/store/hooks"; |
| 20 |
// Layouts |
| 21 |
import TitleLayout from "src/components/layouts/TitleLayout"; |
| 22 |
import HelpTextWithIconLayout from "src/components/layouts/HelpTextWithIconLayout"; |
| 23 |
import SecondaryButton from "src/components/layouts/SecondaryButton"; |
| 24 |
import ToolbarLayout from "src/components/layouts/ToolbarLayout"; |
| 25 |
import SearchInputLayout from "src/components/layouts/SearchInputLayout"; |
| 26 |
// Tables |
| 27 |
import HBACServicesTable from "./HBACServicesTable"; |
| 28 |
// Components |
| 29 |
import PaginationLayout from "../../components/layouts/PaginationLayout"; |
| 30 |
import BulkSelectorPrep from "src/components/BulkSelectorPrep"; |
| 31 |
// Modals |
| 32 |
import AddHBACService from "src/components/modals/HbacModals/AddHBACService"; |
| 33 |
import DeleteHBACService from "src/components/modals/HbacModals/DeleteHBACService"; |
| 34 |
// Hooks |
| 35 |
import { addAlert } from "src/store/Global/alerts-slice"; |
| 36 |
import useUpdateRoute from "src/hooks/useUpdateRoute"; |
| 37 |
// Utils |
| 38 |
import { API_VERSION_BACKUP, isHbacServiceSelectable } from "src/utils/utils"; |
| 39 |
// RPC client |
| 40 |
import { GenericPayload, useSearchEntriesMutation } from "src/services/rpc"; |
| 41 |
import { useGettingHbacServicesQuery } from "src/services/rpcHBACServices"; |
| 42 |
// Errors |
| 43 |
import { FetchBaseQueryError } from "@reduxjs/toolkit/query"; |
| 44 |
import { SerializedError } from "@reduxjs/toolkit"; |
| 45 |
import useApiError from "src/hooks/useApiError"; |
| 46 |
import GlobalErrors from "src/components/errors/GlobalErrors"; |
| 47 |
import ModalErrors from "src/components/errors/ModalErrors"; |
| 48 |
|
| 49 |
const HBACServices = () => { |
| 50 |
const dispatch = useAppDispatch(); |
| 51 |
|
| 52 |
// Update current route data to Redux and highlight the current page in the Nav bar |
| 53 |
const { browserTitle } = useUpdateRoute({ pathname: "hbac-services" }); |
| 54 |
|
| 55 |
// Set the page title to be shown in the browser tab |
| 56 |
React.useEffect(() => { |
| 57 |
document.title = browserTitle; |
| 58 |
}, [browserTitle]); |
| 59 |
|
| 60 |
// Retrieve API version from environment data |
| 61 |
const apiVersion = useAppSelector( |
| 62 |
(state) => state.global.environment.api_version |
| 63 |
) as string; |
| 64 |
|
| 65 |
const [servicesList, setServicesList] = useState<HBACService[]>([]); |
| 66 |
|
| 67 |
// Handle API calls errors |
| 68 |
const globalErrors = useApiError([]); |
| 69 |
const modalErrors = useApiError([]); |
| 70 |
|
| 71 |
// Main states - what user can define / what we could use in page URL |
| 72 |
const [searchValue, setSearchValue] = React.useState(""); |
| 73 |
const [page, setPage] = useState<number>(1); |
| 74 |
const [perPage, setPerPage] = useState<number>(10); |
| 75 |
const [totalCount, setServicesTotalCount] = useState<number>(0); |
| 76 |
const [searchDisabled, setSearchIsDisabled] = useState<boolean>(false); |
| 77 |
|
| 78 |
// Page indexes |
| 79 |
const firstIdx = (page - 1) * perPage; |
| 80 |
const lastIdx = page * perPage; |
| 81 |
|
| 82 |
// Derived states - what we get from API |
| 83 |
const servicesDataResponse = useGettingHbacServicesQuery({ |
| 84 |
searchValue: "", |
| 85 |
sizeLimit: 0, |
| 86 |
apiVersion: apiVersion || API_VERSION_BACKUP, |
| 87 |
startIdx: firstIdx, |
| 88 |
stopIdx: lastIdx, |
| 89 |
} as GenericPayload); |
| 90 |
|
| 91 |
const { |
| 92 |
data: batchResponse, |
| 93 |
isLoading: isBatchLoading, |
| 94 |
error: batchError, |
| 95 |
} = servicesDataResponse; |
| 96 |
|
| 97 |
// Handle data when the API call is finished |
| 98 |
useEffect(() => { |
| 99 |
if (servicesDataResponse.isFetching) { |
| 100 |
setShowTableRows(false); |
| 101 |
// Reset selected users on refresh |
| 102 |
setServicesTotalCount(0); |
| 103 |
globalErrors.clear(); |
| 104 |
return; |
| 105 |
} |
| 106 |
|
| 107 |
// API response: Success |
| 108 |
if ( |
| 109 |
servicesDataResponse.isSuccess && |
| 110 |
servicesDataResponse.data && |
| 111 |
batchResponse !== undefined |
| 112 |
) { |
| 113 |
const servicesListResult = batchResponse.result.results; |
| 114 |
const totalCount = batchResponse.result.totalCount; |
| 115 |
const servicesListSize = batchResponse.result.count; |
| 116 |
const servicesList: HBACService[] = []; |
| 117 |
|
| 118 |
for (let i = 0; i < servicesListSize; i++) { |
| 119 |
servicesList.push(servicesListResult[i].result); |
| 120 |
} |
| 121 |
|
| 122 |
setServicesTotalCount(totalCount); |
| 123 |
// Update the list |
| 124 |
setServicesList(servicesList); |
| 125 |
// Show table elements |
| 126 |
setShowTableRows(true); |
| 127 |
} |
| 128 |
|
| 129 |
// API response: Error |
| 130 |
if ( |
| 131 |
!servicesDataResponse.isLoading && |
| 132 |
servicesDataResponse.isError && |
| 133 |
servicesDataResponse.error !== undefined |
| 134 |
) { |
| 135 |
// This normally happens when the user is not authorized to view the data |
| 136 |
// So instead of adding an error, refresh page |
| 137 |
window.location.reload(); |
| 138 |
} |
| 139 |
}, [servicesDataResponse]); |
| 140 |
|
| 141 |
// Refresh button handling |
| 142 |
const refreshServicesData = () => { |
| 143 |
// Hide table |
| 144 |
setShowTableRows(false); |
| 145 |
|
| 146 |
// Reset selected users on refresh |
| 147 |
setServicesTotalCount(0); |
| 148 |
clearSelectedServices(); |
| 149 |
|
| 150 |
servicesDataResponse.refetch(); |
| 151 |
}; |
| 152 |
|
| 153 |
// Always refetch data when the component is loaded. |
| 154 |
// This ensures the data is always up-to-date. |
| 155 |
React.useEffect(() => { |
| 156 |
servicesDataResponse.refetch(); |
| 157 |
}, [page, perPage]); |
| 158 |
|
| 159 |
// 'Delete' button state |
| 160 |
const [isDeleteButtonDisabled, setIsDeleteButtonDisabled] = |
| 161 |
useState<boolean>(true); |
| 162 |
|
| 163 |
const updateIsDeleteButtonDisabled = (value: boolean) => { |
| 164 |
setIsDeleteButtonDisabled(value); |
| 165 |
}; |
| 166 |
|
| 167 |
// If some entries have been deleted, restore the selectedRules list |
| 168 |
const [isDeletion, setIsDeletion] = useState(false); |
| 169 |
|
| 170 |
const updateIsDeletion = (value: boolean) => { |
| 171 |
setIsDeletion(value); |
| 172 |
}; |
| 173 |
|
| 174 |
// Elements selected (per page) |
| 175 |
// - This will help to calculate the remaining elements on a specific page (bulk selector) |
| 176 |
const [selectedPerPage, setSelectedPerPage] = useState<number>(0); |
| 177 |
|
| 178 |
const updateSelectedPerPage = (selected: number) => { |
| 179 |
setSelectedPerPage(selected); |
| 180 |
}; |
| 181 |
|
| 182 |
// Pagination |
| 183 |
const updatePage = (newPage: number) => { |
| 184 |
setPage(newPage); |
| 185 |
}; |
| 186 |
|
| 187 |
const updatePerPage = (newSetPerPage: number) => { |
| 188 |
setPerPage(newSetPerPage); |
| 189 |
}; |
| 190 |
|
| 191 |
// Services displayed on the first page |
| 192 |
const updateShownServicesList = (newShownServicesList: HBACService[]) => { |
| 193 |
setServicesList(newShownServicesList); |
| 194 |
}; |
| 195 |
|
| 196 |
// Update search input valie |
| 197 |
const updateSearchValue = (value: string) => { |
| 198 |
setSearchValue(value); |
| 199 |
}; |
| 200 |
|
| 201 |
const [selectedServices, setSelectedServices] = useState<HBACService[]>([]); |
| 202 |
|
| 203 |
const clearSelectedServices = () => { |
| 204 |
const emptyList: HBACService[] = []; |
| 205 |
setSelectedServices(emptyList); |
| 206 |
}; |
| 207 |
|
| 208 |
const [retrieveServices] = useSearchEntriesMutation({}); |
| 209 |
|
| 210 |
// Issue a search using a specific search value |
| 211 |
const submitSearchValue = () => { |
| 212 |
setShowTableRows(false); |
| 213 |
setSearchIsDisabled(true); |
| 214 |
setServicesTotalCount(0); |
| 215 |
retrieveServices({ |
| 216 |
searchValue: searchValue, |
| 217 |
sizeLimit: 0, |
| 218 |
apiVersion: apiVersion || API_VERSION_BACKUP, |
| 219 |
startIdx: firstIdx, |
| 220 |
stopIdx: lastIdx, |
| 221 |
entryType: "hbacsvc", |
| 222 |
} as GenericPayload).then((result) => { |
| 223 |
// Manage new response here |
| 224 |
if ("data" in result) { |
| 225 |
const searchError = result.data?.error as |
| 226 |
| FetchBaseQueryError |
| 227 |
| SerializedError; |
| 228 |
|
| 229 |
if (searchError) { |
| 230 |
// Error |
| 231 |
let error: string | undefined = ""; |
| 232 |
if ("error" in searchError) { |
| 233 |
error = searchError.error; |
| 234 |
} else if ("message" in searchError) { |
| 235 |
error = searchError.message; |
| 236 |
} |
| 237 |
dispatch( |
| 238 |
addAlert({ |
| 239 |
name: "submit-search-value-error", |
| 240 |
title: error || "Error when searching for HBAC services", |
| 241 |
variant: "danger", |
| 242 |
}) |
| 243 |
); |
| 244 |
} else { |
| 245 |
// Success |
| 246 |
const servicesListResult = result.data?.result.results || []; |
| 247 |
const servicesListSize = result.data?.result.count || 0; |
| 248 |
const totalCount = result.data?.result.totalCount || 0; |
| 249 |
const servicesList: HBACService[] = []; |
| 250 |
|
| 251 |
for (let i = 0; i < servicesListSize; i++) { |
| 252 |
servicesList.push(servicesListResult[i].result); |
| 253 |
} |
| 254 |
|
| 255 |
setServicesTotalCount(totalCount); |
| 256 |
setServicesList(servicesList); |
| 257 |
// Show table elements |
| 258 |
setShowTableRows(true); |
| 259 |
} |
| 260 |
setSearchIsDisabled(false); |
| 261 |
} |
| 262 |
}); |
| 263 |
}; |
| 264 |
|
| 265 |
// Show table rows |
| 266 |
const [showTableRows, setShowTableRows] = useState(!isBatchLoading); |
| 267 |
|
| 268 |
// Show table rows only when data is fully retrieved |
| 269 |
useEffect(() => { |
| 270 |
if (showTableRows !== !isBatchLoading) { |
| 271 |
setShowTableRows(!isBatchLoading); |
| 272 |
} |
| 273 |
}, [isBatchLoading]); |
| 274 |
|
| 275 |
// Modals functionality |
| 276 |
const [showAddModal, setShowAddModal] = useState(false); |
| 277 |
const [showDeleteModal, setShowDeleteModal] = useState(false); |
| 278 |
|
| 279 |
const onAddClickHandler = () => { |
| 280 |
setShowAddModal(true); |
| 281 |
}; |
| 282 |
|
| 283 |
const onCloseAddModal = () => { |
| 284 |
setShowAddModal(false); |
| 285 |
}; |
| 286 |
|
| 287 |
const onAddModalToggle = () => { |
| 288 |
setShowAddModal(!showAddModal); |
| 289 |
}; |
| 290 |
|
| 291 |
const onDeleteHandler = () => { |
| 292 |
setShowDeleteModal(true); |
| 293 |
}; |
| 294 |
|
| 295 |
const onDeleteModalToggle = () => { |
| 296 |
setShowDeleteModal(!showDeleteModal); |
| 297 |
}; |
| 298 |
|
| 299 |
// Table-related shared functionality |
| 300 |
// - Selectable checkboxes on table |
| 301 |
const selectableServicesTable = servicesList.filter(isHbacServiceSelectable); // elements per Table |
| 302 |
|
| 303 |
const updateSelectedServices = ( |
| 304 |
services: HBACService[], |
| 305 |
isSelected: boolean |
| 306 |
) => { |
| 307 |
let newSelectedServices: HBACService[] = []; |
| 308 |
if (isSelected) { |
| 309 |
newSelectedServices = JSON.parse(JSON.stringify(selectedServices)); |
| 310 |
for (let i = 0; i < services.length; i++) { |
| 311 |
if ( |
| 312 |
selectedServices.find( |
| 313 |
(selectedServices) => selectedServices.cn[0] === services[i].cn[0] |
| 314 |
) |
| 315 |
) { |
| 316 |
// Already in the list |
| 317 |
continue; |
| 318 |
} |
| 319 |
// Add rule to list |
| 320 |
newSelectedServices.push(services[i]); |
| 321 |
} |
| 322 |
} else { |
| 323 |
// Remove entry |
| 324 |
for (let i = 0; i < selectedServices.length; i++) { |
| 325 |
let found = false; |
| 326 |
for (let ii = 0; ii < services.length; ii++) { |
| 327 |
if (selectedServices[i].cn[0] === services[ii].cn[0]) { |
| 328 |
found = true; |
| 329 |
break; |
| 330 |
} |
| 331 |
} |
| 332 |
if (!found) { |
| 333 |
// Keep this valid selected entry |
| 334 |
newSelectedServices.push(selectedServices[i]); |
| 335 |
} |
| 336 |
} |
| 337 |
} |
| 338 |
setSelectedServices(newSelectedServices); |
| 339 |
setIsDeleteButtonDisabled(newSelectedServices.length === 0); |
| 340 |
}; |
| 341 |
|
| 342 |
// - Helper method to set the selected entries from the table |
| 343 |
const setServicesSelected = (service: HBACService, isSelecting = true) => { |
| 344 |
if (isHbacServiceSelectable(service)) { |
| 345 |
updateSelectedServices([service], isSelecting); |
| 346 |
} |
| 347 |
}; |
| 348 |
|
| 349 |
// Data wrappers |
| 350 |
// TODO: Better separation of concerts |
| 351 |
// - 'PaginationLayout' |
| 352 |
const paginationData = { |
| 353 |
page, |
| 354 |
perPage, |
| 355 |
updatePage, |
| 356 |
updatePerPage, |
| 357 |
updateSelectedPerPage, |
| 358 |
updateShownElementsList: updateShownServicesList, |
| 359 |
totalCount, |
| 360 |
}; |
| 361 |
|
| 362 |
// - 'BulkSelectorHBACServicesPrep' |
| 363 |
const rulesBulkSelectorData = { |
| 364 |
selected: selectedServices, |
| 365 |
updateSelected: updateSelectedServices, |
| 366 |
selectableTable: selectableServicesTable, |
| 367 |
nameAttr: "cn", |
| 368 |
}; |
| 369 |
|
| 370 |
const buttonsData = { |
| 371 |
updateIsDeleteButtonDisabled, |
| 372 |
}; |
| 373 |
|
| 374 |
const selectedPerPageData = { |
| 375 |
selectedPerPage, |
| 376 |
updateSelectedPerPage, |
| 377 |
}; |
| 378 |
|
| 379 |
// 'DeleteServices' |
| 380 |
const deleteServicesButtonsData = { |
| 381 |
updateIsDeleteButtonDisabled, |
| 382 |
updateIsDeletion, |
| 383 |
}; |
| 384 |
|
| 385 |
const selectedServicesData = { |
| 386 |
selectedServices, |
| 387 |
clearSelectedServices, |
| 388 |
}; |
| 389 |
|
| 390 |
// 'ServicesTable' |
| 391 |
const servicesTableData = { |
| 392 |
isHbacServiceSelectable, |
| 393 |
selectedServices, |
| 394 |
selectableServicesTable, |
| 395 |
setServicesSelected, |
| 396 |
clearSelectedServices, |
| 397 |
}; |
| 398 |
|
| 399 |
const servicesTableButtonsData = { |
| 400 |
updateIsDeleteButtonDisabled, |
| 401 |
isDeletion, |
| 402 |
updateIsDeletion, |
| 403 |
}; |
| 404 |
|
| 405 |
// SearchInputLayout |
| 406 |
const searchValueData = { |
| 407 |
searchValue, |
| 408 |
updateSearchValue, |
| 409 |
submitSearchValue, |
| 410 |
}; |
| 411 |
|
| 412 |
// List of Toolbar items |
| 413 |
const toolbarItems: ToolbarItem[] = [ |
| 414 |
{ |
| 415 |
key: 0, |
| 416 |
element: ( |
| 417 |
<BulkSelectorPrep |
| 418 |
list={servicesList} |
| 419 |
shownElementsList={servicesList} |
| 420 |
elementData={rulesBulkSelectorData} |
| 421 |
buttonsData={buttonsData} |
| 422 |
selectedPerPageData={selectedPerPageData} |
| 423 |
/> |
| 424 |
), |
| 425 |
}, |
| 426 |
{ |
| 427 |
key: 1, |
| 428 |
element: ( |
| 429 |
<SearchInputLayout |
| 430 |
dataCy="search" |
| 431 |
name="search" |
| 432 |
ariaLabel="Search services" |
| 433 |
placeholder="Search" |
| 434 |
searchValueData={searchValueData} |
| 435 |
isDisabled={searchDisabled} |
| 436 |
/> |
| 437 |
), |
| 438 |
toolbarItemVariant: ToolbarItemVariant.label, |
| 439 |
toolbarItemGap: { default: "gapMd" }, |
| 440 |
}, |
| 441 |
{ |
| 442 |
key: 2, |
| 443 |
toolbarItemVariant: ToolbarItemVariant.separator, |
| 444 |
}, |
| 445 |
{ |
| 446 |
key: 3, |
| 447 |
element: ( |
| 448 |
<SecondaryButton |
| 449 |
onClickHandler={refreshServicesData} |
| 450 |
isDisabled={!showTableRows} |
| 451 |
dataCy="hbac-services-button-refresh" |
| 452 |
> |
| 453 |
Refresh |
| 454 |
</SecondaryButton> |
| 455 |
), |
| 456 |
}, |
| 457 |
{ |
| 458 |
key: 4, |
| 459 |
element: ( |
| 460 |
<SecondaryButton |
| 461 |
isDisabled={isDeleteButtonDisabled || !showTableRows} |
| 462 |
onClickHandler={onDeleteHandler} |
| 463 |
dataCy="hbac-services-button-delete" |
| 464 |
> |
| 465 |
Delete |
| 466 |
</SecondaryButton> |
| 467 |
), |
| 468 |
}, |
| 469 |
{ |
| 470 |
key: 5, |
| 471 |
element: ( |
| 472 |
<SecondaryButton |
| 473 |
onClickHandler={onAddClickHandler} |
| 474 |
isDisabled={!showTableRows} |
| 475 |
dataCy="hbac-services-button-add" |
| 476 |
> |
| 477 |
Add |
| 478 |
</SecondaryButton> |
| 479 |
), |
| 480 |
}, |
| 481 |
{ |
| 482 |
key: 6, |
| 483 |
toolbarItemVariant: ToolbarItemVariant.separator, |
| 484 |
}, |
| 485 |
{ |
| 486 |
key: 7, |
| 487 |
element: <HelpTextWithIconLayout textContent="Help" />, |
| 488 |
}, |
| 489 |
{ |
| 490 |
key: 8, |
| 491 |
element: ( |
| 492 |
<PaginationLayout |
| 493 |
list={servicesList} |
| 494 |
paginationData={paginationData} |
| 495 |
widgetId="pagination-options-menu-top" |
| 496 |
isCompact={true} |
| 497 |
/> |
| 498 |
), |
| 499 |
toolbarItemAlignment: { default: "alignEnd" }, |
| 500 |
}, |
| 501 |
]; |
| 502 |
|
| 503 |
return ( |
| 504 |
<div> |
| 505 |
<PageSection hasBodyWrapper={false}> |
| 506 |
<TitleLayout |
| 507 |
id="hbacservices title" |
| 508 |
headingLevel="h1" |
| 509 |
text="HBAC services" |
| 510 |
/> |
| 511 |
</PageSection> |
| 512 |
<PageSection hasBodyWrapper={false} isFilled={false}> |
| 513 |
<Flex direction={{ default: "column" }}> |
| 514 |
<FlexItem> |
| 515 |
<ToolbarLayout toolbarItems={toolbarItems} /> |
| 516 |
</FlexItem> |
| 517 |
<FlexItem style={{ flex: "0 0 auto" }}> |
| 518 |
<OuterScrollContainer> |
| 519 |
<InnerScrollContainer |
| 520 |
style={{ height: "60vh", overflow: "auto" }} |
| 521 |
> |
| 522 |
{batchError !== undefined && batchError ? ( |
| 523 |
<GlobalErrors errors={globalErrors.getAll()} /> |
| 524 |
) : ( |
| 525 |
<HBACServicesTable |
| 526 |
shownElementsList={servicesList} |
| 527 |
showTableRows={showTableRows} |
| 528 |
servicesData={servicesTableData} |
| 529 |
buttonsData={servicesTableButtonsData} |
| 530 |
paginationData={selectedPerPageData} |
| 531 |
searchValue={searchValue} |
| 532 |
/> |
| 533 |
)} |
| 534 |
</InnerScrollContainer> |
| 535 |
</OuterScrollContainer> |
| 536 |
</FlexItem> |
| 537 |
<FlexItem style={{ flex: "0 0 auto", position: "sticky", bottom: 0 }}> |
| 538 |
<PaginationLayout |
| 539 |
list={servicesList} |
| 540 |
paginationData={paginationData} |
| 541 |
variant={PaginationVariant.bottom} |
| 542 |
widgetId="pagination-options-menu-bottom" |
| 543 |
/> |
| 544 |
</FlexItem> |
| 545 |
</Flex> |
| 546 |
</PageSection> |
| 547 |
<AddHBACService |
| 548 |
show={showAddModal} |
| 549 |
handleModalToggle={onAddModalToggle} |
| 550 |
onOpenAddModal={onAddClickHandler} |
| 551 |
onCloseAddModal={onCloseAddModal} |
| 552 |
onRefresh={refreshServicesData} |
| 553 |
/> |
| 554 |
<DeleteHBACService |
| 555 |
show={showDeleteModal} |
| 556 |
handleModalToggle={onDeleteModalToggle} |
| 557 |
selectedServicesData={selectedServicesData} |
| 558 |
buttonsData={deleteServicesButtonsData} |
| 559 |
onRefresh={refreshServicesData} |
| 560 |
/> |
| 561 |
<ModalErrors |
| 562 |
errors={modalErrors.getAll()} |
| 563 |
dataCy="hbac-services-modal-error" |
| 564 |
/> |
| 565 |
</div> |
| 566 |
); |
| 567 |
}; |
| 568 |
|
| 569 |
export default HBACServices; |