Debian Codegraph @

install/freeipa-webui/src/pages/HBACServiceGroups/HBACServiceGroups.tsx

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