Debian Codegraph @

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

raw
1 import React from "react";
2 // PatternFly
3 import {
4 Button,
5 Flex,
6 FlexItem,
7 PageSection,
8 PaginationVariant,
9 SelectOptionProps,
10 ToolbarItemVariant,
11 } from "@patternfly/react-core";
12 // PatternFly table
13 import {
14 InnerScrollContainer,
15 OuterScrollContainer,
16 } from "@patternfly/react-table";
17 // Data types
18 import { AutomemberEntry } from "src/utils/datatypes/globalDataTypes";
19 // Redux
20 import { useAppDispatch, useAppSelector } from "src/store/hooks";
21 // Layouts
22 import TitleLayout from "src/components/layouts/TitleLayout";
23 import HelpTextWithIconLayout from "src/components/layouts/HelpTextWithIconLayout";
24 import SecondaryButton from "src/components/layouts/SecondaryButton";
25 import ToolbarLayout, {
26 ToolbarItem,
27 } from "src/components/layouts/ToolbarLayout";
28 import SearchInputLayout from "src/components/layouts/SearchInputLayout";
29 // Tables
30 import MainTable from "./AutomemRulesTable";
31 // Components
32 import PaginationLayout from "../../components/layouts/PaginationLayout";
33 import BulkSelectorPrep from "src/components/BulkSelectorPrep";
34 import TypeAheadSelect from "src/components/TypeAheadSelect";
35 import useApiError from "src/hooks/useApiError";
36 import GlobalErrors from "src/components/errors/GlobalErrors";
37 // RPC
38 import { GenericPayload } from "src/services/rpc";
39 import {
40 useSearchUserGroupRulesEntriesMutation,
41 ChangeDefaultPayload,
42 useChangeDefaultGroupMutation,
43 } from "src/services/rpcAutomember";
44 // Hooks
45 import { addAlert } from "src/store/Global/alerts-slice";
46 import useUpdateRoute from "src/hooks/useUpdateRoute";
47 import useListPageSearchParams from "src/hooks/useListPageSearchParams";
48 import { useUserGroupsRulesData } from "src/hooks/useUserGroupsRules";
49 // Utils
50 import {
51 API_VERSION_BACKUP,
52 isAutomemberUserGroupSelectable,
53 } from "src/utils/utils";
54 // Errors
55 import { FetchBaseQueryError } from "@reduxjs/toolkit/query";
56 import { SerializedError } from "@reduxjs/toolkit";
57 // Modals
58 import AddRule from "src/components/modals/Automember/AddRule";
59 import DeleteRule from "src/components/modals/Automember/DeleteRule";
60 import ConfirmationModal from "src/components/modals/ConfirmationModal";
61
62 // Automembership user group rules
63 const AutoMemUserRules = () => {
64 const dispatch = useAppDispatch();
65
66 // Update current route data to Redux and highlight the current page in the Nav bar
67 const { browserTitle } = useUpdateRoute({
68 pathname: "user-group-rules",
69 });
70
71 // Set the page title to be shown in the browser tab
72 React.useEffect(() => {
73 document.title = browserTitle;
74 }, [browserTitle]);
75
76 // Retrieve API version from environment data
77 const apiVersion = useAppSelector(
78 (state) => state.global.environment.api_version
79 ) as string;
80
81 const NO_SELECTION = "No default group selected";
82
83 const [userGroups, setUserGroups] = React.useState<string[]>([]);
84 const [automemberRules, setAutomemberRules] = React.useState<
85 AutomemberEntry[]
86 >([]);
87 const [defaultGroup, setDefaultGroup] = React.useState<string>(NO_SELECTION);
88 const [previousDefaultGroup, setPreviousDefaultGroup] =
89 React.useState<string>(NO_SELECTION);
90 const [errors, setErrors] = React.useState<
91 Array<FetchBaseQueryError | SerializedError>
92 >([]);
93 // Options for the default user group selector
94 const [userGroupsOptions, setUserGroupsOptions] = React.useState<
95 SelectOptionProps[]
96 >([]);
97 // Available elements ready to add
98 const [groupsAvailableToAdd, setGroupsAvailableToAdd] = React.useState<
99 string[]
100 >([]);
101
102 // Handle API calls errors
103 const globalErrors = useApiError([]);
104
105 // URL parameters: page number, page size, search value
106 const { page, setPage, perPage, setPerPage, searchValue, setSearchValue } =
107 useListPageSearchParams();
108
109 const [totalCount, setTotalCount] = React.useState<number>(0);
110 const [searchDisabled, setSearchIsDisabled] = React.useState<boolean>(false);
111
112 // Page indexes
113 const firstIdx = (page - 1) * perPage;
114 const lastIdx = page * perPage;
115
116 // API calls via custom hook
117 const userGroupRulesData = useUserGroupsRulesData();
118 const [changeDefaultGroup] = useChangeDefaultGroupMutation();
119
120 // Show table rows
121 const [showTableRows, setShowTableRows] = React.useState(
122 !userGroupRulesData.isLoading
123 );
124
125 // Update table rows when the data is loaded
126 React.useEffect(() => {
127 if (showTableRows !== !userGroupRulesData.isLoading) {
128 setShowTableRows(!userGroupRulesData.isLoading);
129 }
130 }, [userGroupRulesData.isLoading]);
131
132 // Main API call
133 React.useEffect(() => {
134 if (userGroupRulesData.isFetching) {
135 setShowTableRows(false);
136 } else {
137 if (userGroupRulesData.errors && userGroupRulesData.errors.length > 0) {
138 setErrors(userGroupRulesData.errors || []);
139 } else {
140 const fullAutomemberIds: AutomemberEntry[] =
141 userGroupRulesData.automembersIds;
142 const totalAutomembersCount = fullAutomemberIds.length;
143 // Paginate data based on first and last indexes
144 const shownPaginatedRulesList: AutomemberEntry[] = [];
145 if (userGroupRulesData.automembersIds.length > 0) {
146 const pagAutomemberIds = fullAutomemberIds.slice(firstIdx, lastIdx);
147 shownPaginatedRulesList.push(...pagAutomemberIds);
148 }
149 // Update lists
150 setUserGroups(userGroupRulesData.userGroups);
151 setAutomemberRules(shownPaginatedRulesList);
152 // If no default group is set, set it as 'No selection'
153 if (userGroupRulesData.defaultGroup === "") {
154 setDefaultGroup(NO_SELECTION);
155 setPreviousDefaultGroup(NO_SELECTION);
156 } else {
157 setDefaultGroup(userGroupRulesData.defaultGroup);
158 setPreviousDefaultGroup(userGroupRulesData.defaultGroup);
159 }
160
161 // Set available user groups to add (userGroupRulesData.userGroups and fullAutomemberIds)
162 const allAutomemberIds = fullAutomemberIds.map(
163 (item) => item.automemberRule
164 );
165 const availableItems = userGroupRulesData.userGroups.filter(
166 (item) => !allAutomemberIds.includes(item)
167 );
168 setGroupsAvailableToAdd(availableItems);
169
170 // Set table count
171 setTotalCount(totalAutomembersCount);
172 // Show table elements
173 setShowTableRows(true);
174 }
175 }
176 }, [
177 userGroupRulesData.userGroups,
178 userGroupRulesData.automembersIds,
179 userGroupRulesData.defaultGroup,
180 ]);
181
182 // Parse user groups to be shown in the default user group selector
183 React.useEffect(() => {
184 if (userGroups.length > 0) {
185 // Add empty entry as an option
186 const groupsToSelector = [
187 {
188 "data-cy": "typeahead-select-no-selection",
189 value: NO_SELECTION,
190 children: NO_SELECTION,
191 },
192 ];
193
194 // Add the rest of the data from usergroups
195 const tempGroupsToSelector = userGroups.map((group) => ({
196 "data-cy": "typeahead-select-" + group,
197 value: group,
198 children: group,
199 }));
200 groupsToSelector.push(...tempGroupsToSelector);
201 setUserGroupsOptions(groupsToSelector);
202 }
203 }, [userGroups]);
204
205 // On select default group
206 const onSelectDefaultGroup = (group: string) => {
207 const payload: ChangeDefaultPayload = {
208 defaultGroup: group,
209 type: "group",
210 };
211 changeDefaultGroup(payload).then((result) => {
212 if ("data" in result) {
213 setDefaultGroup(group);
214 setPreviousDefaultGroup(group);
215 dispatch(
216 addAlert({
217 name: "default-group-success",
218 title: "Default group updated",
219 variant: "success",
220 })
221 );
222 onCloseConfirmationModal();
223 } else {
224 dispatch(
225 addAlert({
226 name: "default-group-failure",
227 title: "Default group not updated",
228 variant: "danger",
229 })
230 );
231 }
232 });
233 };
234
235 // If some entries' status has been updated, unselect selected rows
236 const [isDisableEnableOp, setIsDisableEnableOp] = React.useState(false);
237
238 const updateIsDisableEnableOp = (value: boolean) => {
239 setIsDisableEnableOp(value);
240 };
241
242 // Elements selected (per page)
243 // - This will help to calculate the remaining elements on a specific page (bulk selector)
244 const [selectedPerPage, setSelectedPerPage] = React.useState<number>(0);
245
246 const updateSelectedPerPage = (selected: number) => {
247 setSelectedPerPage(selected);
248 };
249
250 // Pagination
251 const updatePage = (newPage: number) => {
252 setPage(newPage);
253 };
254
255 const updatePerPage = (newSetPerPage: number) => {
256 setPerPage(newSetPerPage);
257 };
258
259 // Automembers displayed on the first page
260 const updateShownAutomembersList = (
261 newShownAutomembersList: AutomemberEntry[]
262 ) => {
263 setAutomemberRules(newShownAutomembersList);
264 };
265
266 // Update search input valie
267 const updateSearchValue = (value: string) => {
268 setSearchValue(value);
269 };
270
271 const [selectedAutomembers, setSelectedAutomembers] = React.useState<
272 AutomemberEntry[]
273 >([]);
274
275 const clearSelectedRules = () => {
276 const emptyList: AutomemberEntry[] = [];
277 setSelectedAutomembers(emptyList);
278 };
279
280 // Refresh button handling
281 const refreshData = () => {
282 setShowTableRows(false);
283 setTotalCount(0);
284 clearSelectedRules();
285 userGroupRulesData.refetch();
286 };
287
288 const [retrieveAutomembers] = useSearchUserGroupRulesEntriesMutation({});
289
290 // Issue a search using a specific search value
291 const submitSearchValue = () => {
292 setShowTableRows(false);
293 setSearchIsDisabled(true);
294 setTotalCount(0);
295 retrieveAutomembers({
296 searchValue: searchValue,
297 sizeLimit: 0,
298 apiVersion: apiVersion || API_VERSION_BACKUP,
299 startIdx: firstIdx,
300 stopIdx: lastIdx,
301 } as GenericPayload).then((result) => {
302 if ("data" in result) {
303 const automembersListResult = result.data;
304 setTotalCount((result.data ?? []).length);
305 setAutomemberRules(automembersListResult ?? []);
306 // Show table elements
307 setShowTableRows(true);
308 setSearchIsDisabled(false);
309 }
310 });
311 };
312
313 // Always refetch data when the component is loaded.
314 // This ensures the data is always up-to-date.
315 React.useEffect(() => {
316 userGroupRulesData.refetch();
317 }, [page, perPage]);
318
319 // 'Delete' button state
320 const [isDeleteButtonDisabled, setIsDeleteButtonDisabled] =
321 React.useState<boolean>(true);
322
323 const updateIsDeleteButtonDisabled = (value: boolean) => {
324 setIsDeleteButtonDisabled(value);
325 };
326
327 const [isDeletion, setIsDeletion] = React.useState(false);
328 const updateIsDeletion = (value: boolean) => {
329 setIsDeletion(value);
330 };
331
332 // Table-related shared functionality
333 // - Selectable checkboxes on table
334 const selectableAutomembersTable = automemberRules.filter(
335 isAutomemberUserGroupSelectable
336 ); // elements per Table
337
338 const updateSelectedAutomembers = (
339 automembers: AutomemberEntry[],
340 isSelected: boolean
341 ) => {
342 let newSelectedAutomembers: AutomemberEntry[] = [];
343 if (isSelected) {
344 newSelectedAutomembers = JSON.parse(JSON.stringify(selectedAutomembers));
345 for (let i = 0; i < automembers.length; i++) {
346 if (
347 selectedAutomembers.find(
348 (selectedRule) =>
349 selectedRule.automemberRule === automembers[i].automemberRule
350 )
351 ) {
352 // Already in the list
353 continue;
354 }
355 // Add rule to list
356 newSelectedAutomembers.push(automembers[i]);
357 }
358 } else {
359 // Remove rule
360 for (let i = 0; i < selectedAutomembers.length; i++) {
361 let found = false;
362 for (let ii = 0; ii < automembers.length; ii++) {
363 if (
364 selectedAutomembers[i].automemberRule ===
365 automembers[ii].automemberRule
366 ) {
367 found = true;
368 break;
369 }
370 }
371 if (!found) {
372 // Keep this valid selected entry
373 newSelectedAutomembers.push(selectedAutomembers[i]);
374 }
375 }
376 }
377 setSelectedAutomembers(newSelectedAutomembers);
378 setIsDeleteButtonDisabled(newSelectedAutomembers.length === 0);
379 };
380
381 // - Helper method to set the selected entries from the table
382 const setAutomembersSelected = (
383 automember: AutomemberEntry,
384 isSelecting = true
385 ) => {
386 if (isAutomemberUserGroupSelectable(automember)) {
387 updateSelectedAutomembers([automember], isSelecting);
388 }
389 };
390
391 // Data wrappers
392 // TODO: Better separation of concerts
393 // - 'PaginationLayout'
394 const paginationData = {
395 page,
396 perPage,
397 updatePage,
398 updatePerPage,
399 updateSelectedPerPage,
400 updateShownElementsList: updateShownAutomembersList,
401 totalCount,
402 };
403
404 // - 'BulkSelectorPrep'
405 const automembersBulkSelectorData = {
406 selected: selectedAutomembers,
407 updateSelected: updateSelectedAutomembers,
408 selectableTable: selectableAutomembersTable,
409 nameAttr: "automemberRule",
410 };
411
412 const buttonsData = {
413 updateIsDeleteButtonDisabled,
414 updateIsDisableEnableOp,
415 };
416
417 const selectedPerPageData = {
418 selectedPerPage,
419 updateSelectedPerPage,
420 };
421
422 // SearchInputLayout
423 const searchValueData = {
424 searchValue,
425 updateSearchValue,
426 submitSearchValue,
427 };
428
429 // 'Table'
430 const automembersTableData = {
431 isElementSelectable: isAutomemberUserGroupSelectable,
432 selectedElements: selectedAutomembers,
433 selectableElementsTable: selectableAutomembersTable,
434 setElementsSelected: setAutomembersSelected,
435 clearSelectedElements: clearSelectedRules,
436 };
437
438 const automembersTableButtonsData = {
439 updateIsDeleteButtonDisabled,
440 isDeletion,
441 updateIsDeletion,
442 isDisableEnableOp,
443 updateIsDisableEnableOp,
444 };
445
446 // Modals functionality
447 const [showAddModal, setShowAddModal] = React.useState(false);
448 const [showDeleteModal, setShowDeleteModal] = React.useState(false);
449 const [showChangeConfirmationModal, setShowChangeConfirmationModal] =
450 React.useState(false);
451
452 const onOpenAddModal = () => {
453 setShowAddModal(true);
454 };
455
456 const onCloseAddModal = () => {
457 setShowAddModal(false);
458 };
459
460 const onAddModalToggle = () => {
461 setShowAddModal(!showAddModal);
462 };
463
464 const onOpenDeleteModal = () => {
465 setShowDeleteModal(true);
466 };
467
468 const onToggleDeleteModal = () => {
469 setShowDeleteModal(!showDeleteModal);
470 };
471
472 const onCloseConfirmationModal = () => {
473 setShowChangeConfirmationModal(false);
474 };
475
476 const onOpenConfirmationModal = () => {
477 setShowChangeConfirmationModal(true);
478 };
479
480 const onShowDefaultGroupOnModal = (group: string) => {
481 setDefaultGroup(group);
482 onOpenConfirmationModal();
483 };
484
485 const onCancelDefaultGroup = () => {
486 setDefaultGroup(previousDefaultGroup);
487 onCloseConfirmationModal();
488 };
489
490 // 'Delete automember rules data
491 const deleteButtonsData = {
492 updateIsDeleteButtonDisabled,
493 updateIsDeletion,
494 };
495
496 const selectedData = {
497 selectedItems: selectedAutomembers,
498 clearSelected: clearSelectedRules,
499 };
500
501 // List of Toolbar items
502 const toolbarItems: ToolbarItem[] = [
503 {
504 key: 0,
505 element: (
506 <BulkSelectorPrep
507 list={automemberRules}
508 shownElementsList={automemberRules}
509 elementData={automembersBulkSelectorData}
510 buttonsData={buttonsData}
511 selectedPerPageData={selectedPerPageData}
512 />
513 ),
514 },
515 {
516 key: 1,
517 element: (
518 <SearchInputLayout
519 dataCy={"search"}
520 name="search"
521 ariaLabel="Search rules"
522 placeholder="Search"
523 searchValueData={searchValueData}
524 isDisabled={searchDisabled}
525 />
526 ),
527 toolbarItemVariant: ToolbarItemVariant.label,
528 toolbarItemGap: { default: "gapMd" },
529 },
530 {
531 key: 2,
532 element: (
533 <TypeAheadSelect
534 id="user-group"
535 options={userGroupsOptions}
536 selected={defaultGroup}
537 placeholder="Default user group"
538 onSelectedChange={onShowDefaultGroupOnModal}
539 dataCy={"auto-member-user-rules-typeahead-select"}
540 />
541 ),
542 },
543 {
544 key: 3,
545 toolbarItemVariant: ToolbarItemVariant.separator,
546 },
547 {
548 key: 4,
549 element: (
550 <SecondaryButton
551 dataCy={"auto-member-user-rules-button-refresh"}
552 onClickHandler={refreshData}
553 isDisabled={!showTableRows}
554 >
555 Refresh
556 </SecondaryButton>
557 ),
558 },
559 {
560 key: 5,
561 element: (
562 <SecondaryButton
563 dataCy={"auto-member-user-rules-button-delete"}
564 isDisabled={isDeleteButtonDisabled || !showTableRows}
565 onClickHandler={onOpenDeleteModal}
566 >
567 Delete
568 </SecondaryButton>
569 ),
570 },
571 {
572 key: 6,
573 element: (
574 <SecondaryButton
575 dataCy={"auto-member-user-rules-button-add"}
576 isDisabled={!showTableRows}
577 onClickHandler={onOpenAddModal}
578 >
579 Add
580 </SecondaryButton>
581 ),
582 },
583 {
584 key: 7,
585 toolbarItemVariant: ToolbarItemVariant.separator,
586 },
587 {
588 key: 8,
589 element: <HelpTextWithIconLayout textContent="Help" />,
590 },
591 {
592 key: 9,
593 element: (
594 <PaginationLayout
595 list={automemberRules}
596 paginationData={paginationData}
597 widgetId="pagination-options-menu-top"
598 isCompact={true}
599 />
600 ),
601 toolbarItemAlignment: { default: "alignEnd" },
602 },
603 ];
604
605 return (
606 <div>
607 <PageSection hasBodyWrapper={false}>
608 <TitleLayout
609 id="Automember user groups title"
610 headingLevel="h1"
611 text="User group rules"
612 />
613 </PageSection>
614 <PageSection hasBodyWrapper={false} isFilled={false}>
615 <Flex direction={{ default: "column" }}>
616 <FlexItem>
617 <ToolbarLayout toolbarItems={toolbarItems} />
618 </FlexItem>
619 <FlexItem style={{ flex: "0 0 auto" }}>
620 <OuterScrollContainer>
621 <InnerScrollContainer
622 style={{ height: "55vh", overflow: "auto" }}
623 >
624 {errors !== undefined && errors.length > 0 ? (
625 <GlobalErrors errors={globalErrors.getAll()} />
626 ) : (
627 <MainTable
628 shownElementsList={automemberRules}
629 showTableRows={showTableRows}
630 elementsData={automembersTableData}
631 buttonsData={automembersTableButtonsData}
632 paginationData={selectedPerPageData}
633 searchValue={searchValue}
634 automemberType="user-group"
635 />
636 )}
637 </InnerScrollContainer>
638 </OuterScrollContainer>
639 </FlexItem>
640 <FlexItem style={{ flex: "0 0 auto", position: "sticky", bottom: 0 }}>
641 <PaginationLayout
642 list={automemberRules}
643 paginationData={paginationData}
644 variant={PaginationVariant.bottom}
645 widgetId="pagination-options-menu-bottom"
646 />
647 </FlexItem>
648 </Flex>
649 </PageSection>
650 <AddRule
651 show={showAddModal}
652 handleModalToggle={onAddModalToggle}
653 onOpenAddModal={onOpenAddModal}
654 onCloseAddModal={onCloseAddModal}
655 onRefresh={refreshData}
656 groupsAvailableToAdd={groupsAvailableToAdd}
657 ruleType="group"
658 />
659 <DeleteRule
660 show={showDeleteModal}
661 handleModalToggle={onToggleDeleteModal}
662 onRefresh={refreshData}
663 buttonsData={deleteButtonsData}
664 selectedData={selectedData}
665 ruleType="group"
666 />
667 <ConfirmationModal
668 dataCy={"auto-member-default-user-rules-modal"}
669 title="Default user group"
670 isOpen={showChangeConfirmationModal}
671 onClose={onCloseConfirmationModal}
672 actions={[
673 <Button
674 data-cy="modal-button-ok"
675 variant="primary"
676 key="change-default"
677 onClick={() => {
678 onSelectDefaultGroup(defaultGroup);
679 }}
680 >
681 OK
682 </Button>,
683 <SecondaryButton
684 dataCy="modal-button-cancel"
685 key="cancel"
686 onClickHandler={onCancelDefaultGroup}
687 >
688 Cancel
689 </SecondaryButton>,
690 ]}
691 messageText="Are you sure you want to change default group?"
692 messageObj={defaultGroup}
693 />
694 </div>
695 );
696 };
697
698 export default AutoMemUserRules;