Debian Codegraph @

install/freeipa-webui/src/pages/StageUsers/StageUsers.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 { User } from "src/utils/datatypes/globalDataTypes";
17 import { ToolbarItem } from "src/components/layouts/ToolbarLayout";
18 // Redux
19 import { useAppSelector, useAppDispatch } from "src/store/hooks";
20 // Hooks
21 import { addAlert } from "src/store/Global/alerts-slice";
22 import useUpdateRoute from "src/hooks/useUpdateRoute";
23 import useListPageSearchParams from "src/hooks/useListPageSearchParams";
24 // Layouts
25 import TitleLayout from "src/components/layouts/TitleLayout";
26 import HelpTextWithIconLayout from "src/components/layouts/HelpTextWithIconLayout";
27 import SecondaryButton from "src/components/layouts/SecondaryButton";
28 import ToolbarLayout from "src/components/layouts/ToolbarLayout";
29 import SearchInputLayout from "src/components/layouts/SearchInputLayout";
30 // Tables
31 import UsersTable from "../../components/tables/UsersTable";
32 // Components
33 import PaginationLayout from "src/components/layouts/PaginationLayout";
34 import BulkSelectorPrep from "src/components/BulkSelectorPrep";
35 import ContextualHelpPanel from "src/components/ContextualHelpPanel/ContextualHelpPanel";
36 // Modals
37 import DeleteUsers from "src/components/modals/UserModals/DeleteUsers";
38 import AddUser from "src/components/modals/UserModals/AddUser";
39 import ActivateStageUsers from "src/components/modals/UserModals/ActivateStageUsers";
40 // Utils
41 import { API_VERSION_BACKUP, isUserSelectable } from "src/utils/utils";
42 // Errors
43 import { FetchBaseQueryError } from "@reduxjs/toolkit/query";
44 import { SerializedError } from "@reduxjs/toolkit";
45 // RPC client
46 import { GenericPayload, useSearchEntriesMutation } from "../../services/rpc";
47 import { useGettingStageUserQuery } from "../../services/rpcUsers";
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 StageUsers = () => {
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: "stage-users" });
57
58 // Set the page title to be shown in the browser tab
59 React.useEffect(() => {
60 document.title = browserTitle;
61 }, [browserTitle]);
62
63 // URL parameters: page number, page size, search value
64 const { page, setPage, perPage, setPerPage, searchValue, setSearchValue } =
65 useListPageSearchParams();
66
67 // Retrieve API version from environment data
68 const apiVersion = useAppSelector(
69 (state) => state.global.environment.api_version
70 ) as string;
71
72 // Active users list
73 const [stageUsersList, setStageUsersList] = useState<User[]>([]);
74
75 // Handle API calls errors
76 const globalErrors = useApiError([]);
77 const modalErrors = useApiError([]);
78
79 // Main states - what user can define / what we could use in page URL
80 const [totalCount, setUsersTotalCount] = useState<number>(0);
81 const [searchDisabled, setSearchIsDisabled] = useState<boolean>(false);
82
83 // Page indexes
84 const firstUserIdx = (page - 1) * perPage;
85 const lastUserIdx = page * perPage;
86
87 // Derived states - what we get from API
88 const userDataResponse = useGettingStageUserQuery({
89 searchValue: searchValue,
90 sizeLimit: 0,
91 apiVersion: apiVersion || API_VERSION_BACKUP,
92 startIdx: firstUserIdx,
93 stopIdx: lastUserIdx,
94 } as GenericPayload);
95
96 const {
97 data: batchResponse,
98 isLoading: isBatchLoading,
99 error: batchError,
100 } = userDataResponse;
101
102 // Handle data when the API call is finished
103 useEffect(() => {
104 if (userDataResponse.isFetching) {
105 setShowTableRows(false);
106 // Reset selected users on refresh
107 setUsersTotalCount(0);
108 globalErrors.clear();
109 return;
110 }
111
112 // API response: Success
113 if (
114 userDataResponse.isSuccess &&
115 userDataResponse.data &&
116 batchResponse !== undefined
117 ) {
118 const usersListResult = batchResponse.result.results;
119 const usersListSize = batchResponse.result.count;
120 const totalCount = batchResponse.result.totalCount;
121 const usersList: User[] = [];
122
123 for (let i = 0; i < usersListSize; i++) {
124 usersList.push(usersListResult[i].result);
125 }
126
127 setUsersTotalCount(totalCount);
128 // Update the list of users
129 setStageUsersList(usersList);
130 // Show table elements
131 setShowTableRows(true);
132 }
133
134 // API response: Error
135 if (
136 !userDataResponse.isLoading &&
137 userDataResponse.isError &&
138 userDataResponse.error !== undefined
139 ) {
140 // This normally happens when the user is not authorized to view the data
141 // So instead of adding an error, refresh page
142 window.location.reload();
143 }
144 }, [userDataResponse]);
145
146 // Refresh button handling
147 const refreshUsersData = () => {
148 // Hide table
149 setShowTableRows(false);
150
151 // Reset selected users on refresh
152 setUsersTotalCount(0);
153 clearSelectedUsers();
154
155 userDataResponse.refetch();
156 };
157
158 // Always refetch data when the component is loaded.
159 // This ensures the data is always up-to-date.
160 React.useEffect(() => {
161 userDataResponse.refetch();
162 }, []);
163
164 // 'Delete' button state
165 const [isDeleteButtonDisabled, setIsDeleteButtonDisabled] =
166 useState<boolean>(true);
167
168 const updateIsDeleteButtonDisabled = (value: boolean) => {
169 setIsDeleteButtonDisabled(value);
170 };
171
172 // If some entries have been deleted, restore the selectedUsers list
173 const [isDeletion, setIsDeletion] = useState(false);
174
175 const updateIsDeletion = (value: boolean) => {
176 setIsDeletion(value);
177 };
178
179 // Elements selected (per page)
180 // - This will help to calculate the remaining elements on a specific page (bulk selector)
181 const [selectedPerPage, setSelectedPerPage] = useState<number>(0);
182
183 const updateSelectedPerPage = (selected: number) => {
184 setSelectedPerPage(selected);
185 };
186
187 // Pagination
188 const updatePage = (newPage: number) => {
189 setPage(newPage);
190 };
191
192 const updatePerPage = (newSetPerPage: number) => {
193 setPerPage(newSetPerPage);
194 };
195
196 // Users displayed on the first page
197 const updateShownUsersList = (newShownUsersList: User[]) => {
198 setStageUsersList(newShownUsersList);
199 };
200
201 // Filter (Input search)
202 const updateSearchValue = (value: string) => {
203 setSearchValue(value);
204 };
205
206 // Issue search with filter
207 const [retrieveUser] = useSearchEntriesMutation({});
208
209 // Issue a search using a specific search value
210 const submitSearchValue = () => {
211 setShowTableRows(false);
212 setUsersTotalCount(0);
213 setSearchIsDisabled(true);
214
215 retrieveUser({
216 searchValue: searchValue,
217 sizeLimit: 0,
218 apiVersion: apiVersion || API_VERSION_BACKUP,
219 startIdx: firstUserIdx,
220 stopIdx: lastUserIdx,
221 entryType: "stage",
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 stage users",
241 variant: "danger",
242 })
243 );
244 } else {
245 // Success
246 const usersListResult = result.data?.result.results || [];
247 const usersListSize = result.data?.result.count || 0;
248 const totalCount = result.data?.result.totalCount || 0;
249 const usersList: User[] = [];
250
251 for (let i = 0; i < usersListSize; i++) {
252 usersList.push(usersListResult[i].result);
253 }
254
255 setStageUsersList(usersList);
256 setUsersTotalCount(totalCount);
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 const [selectedUsers, setSelectedUsers] = useState<User[]>([]);
276
277 const clearSelectedUsers = () => {
278 const emptyList: User[] = [];
279 setSelectedUsers(emptyList);
280 };
281
282 const updateSelectedUsers = (users: User[], isSelected: boolean) => {
283 let newSelectedUsers: User[] = [];
284 if (isSelected) {
285 newSelectedUsers = JSON.parse(JSON.stringify(selectedUsers));
286 for (let i = 0; i < users.length; i++) {
287 if (
288 selectedUsers.find(
289 (selectedUser) => selectedUser.uid[0] === users[i].uid[0]
290 )
291 ) {
292 // Already in the list
293 continue;
294 }
295 // Add user to list
296 newSelectedUsers.push(users[i]);
297 }
298 } else {
299 // Remove user
300 for (let i = 0; i < selectedUsers.length; i++) {
301 let found = false;
302 for (let ii = 0; ii < users.length; ii++) {
303 if (selectedUsers[i].uid[0] === users[ii].uid[0]) {
304 found = true;
305 break;
306 }
307 }
308 if (!found) {
309 // Keep this valid selected entry
310 newSelectedUsers.push(selectedUsers[i]);
311 }
312 }
313 }
314 setSelectedUsers(newSelectedUsers);
315 setIsDeleteButtonDisabled(newSelectedUsers.length === 0);
316 };
317
318 // - Helper method to set the selected users from the table
319 const setUserSelected = (user: User, isSelecting = true) => {
320 if (isUserSelectable(user)) {
321 updateSelectedUsers([user], isSelecting);
322 }
323 };
324
325 // Modals functionality
326 const [showAddModal, setShowAddModal] = useState(false);
327 const [showDeleteModal, setShowDeleteModal] = useState(false);
328 const [showActivateModal, setShowActivateModal] = useState(false);
329 const onAddClickHandler = () => {
330 setShowAddModal(true);
331 };
332 const onCloseAddModal = () => {
333 setShowAddModal(false);
334 };
335 const onAddModalToggle = () => {
336 setShowAddModal(!showAddModal);
337 };
338 const onDeleteHandler = () => {
339 setShowDeleteModal(true);
340 };
341 const onDeleteModalToggle = () => {
342 setShowDeleteModal(!showDeleteModal);
343 };
344 const onActivateHandler = () => {
345 setShowActivateModal(true);
346 };
347 const onActivateModalToggle = () => {
348 setShowActivateModal(!showActivateModal);
349 };
350
351 // Table-related shared functionality
352 // - Selectable checkboxes on table
353 const selectableUsersTable = stageUsersList.filter(isUserSelectable); // elements per Table
354
355 // Data wrappers
356 // - 'PaginationLayout'
357 const paginationData = {
358 page,
359 perPage,
360 updatePage,
361 updatePerPage,
362 updateSelectedPerPage,
363 updateShownElementsList: updateShownUsersList,
364 totalCount,
365 };
366
367 // - 'BulkSelectorPrep'
368 const usersBulkSelectorData = {
369 selected: selectedUsers,
370 updateSelected: updateSelectedUsers,
371 selectableTable: selectableUsersTable,
372 nameAttr: "uid",
373 };
374
375 const buttonsData = {
376 updateIsDeleteButtonDisabled,
377 };
378
379 const selectedPerPageData = {
380 selectedPerPage,
381 updateSelectedPerPage,
382 };
383
384 // 'DeleteUsers'
385 const deleteUsersButtonsData = {
386 updateIsDeleteButtonDisabled,
387 updateIsDeletion,
388 };
389
390 const selectedUsersData = {
391 selectedUsers,
392 clearSelectedUsers,
393 };
394
395 // 'UsersTable'
396 const usersTableData = {
397 isUserSelectable,
398 selectedUsers,
399 selectableUsersTable,
400 setUserSelected,
401 clearSelectedUsers,
402 };
403
404 const usersTableButtonsData = {
405 updateIsDeleteButtonDisabled,
406 isDeletion,
407 updateIsDeletion,
408 };
409
410 // 'SearchInputLayout'
411 const searchValueData = {
412 searchValue,
413 updateSearchValue,
414 submitSearchValue,
415 };
416
417 // Contextual links panel
418 const [isContextualPanelExpanded, setIsContextualPanelExpanded] =
419 React.useState(false);
420
421 const onOpenContextualPanel = () => {
422 setIsContextualPanelExpanded(!isContextualPanelExpanded);
423 };
424
425 const onCloseContextualPanel = () => {
426 setIsContextualPanelExpanded(false);
427 };
428
429 // List of Toolbar items
430 const toolbarItems: ToolbarItem[] = [
431 {
432 key: 0,
433 element: (
434 <BulkSelectorPrep
435 list={stageUsersList}
436 shownElementsList={stageUsersList}
437 elementData={usersBulkSelectorData}
438 buttonsData={buttonsData}
439 selectedPerPageData={selectedPerPageData}
440 />
441 ),
442 },
443 {
444 key: 1,
445 element: (
446 <SearchInputLayout
447 dataCy="search"
448 name="search"
449 ariaLabel="Search user"
450 placeholder="Search"
451 searchValueData={searchValueData}
452 isDisabled={searchDisabled}
453 />
454 ),
455 toolbarItemVariant: ToolbarItemVariant.label,
456 toolbarItemGap: { default: "gapMd" },
457 },
458 {
459 key: 2,
460 toolbarItemVariant: ToolbarItemVariant.separator,
461 },
462 {
463 key: 3,
464 element: (
465 <SecondaryButton
466 onClickHandler={refreshUsersData}
467 isDisabled={!showTableRows}
468 dataCy="stage-users-button-refresh"
469 >
470 Refresh
471 </SecondaryButton>
472 ),
473 },
474 {
475 key: 4,
476 element: (
477 <SecondaryButton
478 isDisabled={isDeleteButtonDisabled || !showTableRows}
479 onClickHandler={onDeleteHandler}
480 dataCy="stage-users-button-delete"
481 >
482 Delete
483 </SecondaryButton>
484 ),
485 },
486 {
487 key: 5,
488 element: (
489 <SecondaryButton
490 onClickHandler={onAddClickHandler}
491 isDisabled={!showTableRows}
492 dataCy="stage-users-button-add"
493 >
494 Add
495 </SecondaryButton>
496 ),
497 },
498 {
499 key: 6,
500 element: (
501 <SecondaryButton
502 isDisabled={!showTableRows || selectedUsers.length === 0}
503 onClickHandler={onActivateHandler}
504 dataCy="stage-users-button-activate"
505 >
506 Activate
507 </SecondaryButton>
508 ),
509 },
510 {
511 key: 7,
512 toolbarItemVariant: ToolbarItemVariant.separator,
513 },
514 {
515 key: 8,
516 element: (
517 <HelpTextWithIconLayout
518 textContent="Help"
519 onClick={onOpenContextualPanel}
520 />
521 ),
522 },
523 {
524 key: 9,
525 element: (
526 <PaginationLayout
527 list={stageUsersList}
528 paginationData={paginationData}
529 widgetId="pagination-options-menu-top"
530 isCompact={true}
531 />
532 ),
533 toolbarItemAlignment: { default: "alignEnd" },
534 },
535 ];
536
537 // Render 'Stage users'
538 return (
539 <ContextualHelpPanel
540 fromPage="stage-users"
541 isExpanded={isContextualPanelExpanded}
542 onClose={onCloseContextualPanel}
543 >
544 <div>
545 <PageSection hasBodyWrapper={false}>
546 <TitleLayout
547 id="stage users title"
548 headingLevel="h1"
549 text="Stage users"
550 />
551 </PageSection>
552 <PageSection hasBodyWrapper={false} isFilled={false}>
553 <Flex direction={{ default: "column" }}>
554 <FlexItem>
555 <ToolbarLayout toolbarItems={toolbarItems} />
556 </FlexItem>
557 <FlexItem style={{ flex: "0 0 auto" }}>
558 <OuterScrollContainer>
559 <InnerScrollContainer
560 style={{ height: "60vh", overflow: "auto" }}
561 >
562 {batchError !== undefined && batchError ? (
563 <GlobalErrors errors={globalErrors.getAll()} />
564 ) : (
565 <UsersTable
566 shownElementsList={stageUsersList}
567 from="stage-users"
568 showTableRows={showTableRows}
569 usersData={usersTableData}
570 buttonsData={usersTableButtonsData}
571 paginationData={selectedPerPageData}
572 searchValue={searchValue}
573 />
574 )}
575 </InnerScrollContainer>
576 </OuterScrollContainer>
577 </FlexItem>
578 <FlexItem
579 style={{ flex: "0 0 auto", position: "sticky", bottom: 0 }}
580 >
581 <PaginationLayout
582 list={stageUsersList}
583 paginationData={paginationData}
584 variant={PaginationVariant.bottom}
585 widgetId="pagination-options-menu-bottom"
586 />
587 </FlexItem>
588 </Flex>
589 </PageSection>
590 <ModalErrors
591 errors={modalErrors.getAll()}
592 dataCy="stage-users-modal-error"
593 />
594 <AddUser
595 show={showAddModal}
596 from="stage-users"
597 setShowTableRows={setShowTableRows}
598 handleModalToggle={onAddModalToggle}
599 onOpenAddModal={onAddClickHandler}
600 onCloseAddModal={onCloseAddModal}
601 onRefresh={refreshUsersData}
602 />
603 <DeleteUsers
604 show={showDeleteModal}
605 from="stage-users"
606 handleModalToggle={onDeleteModalToggle}
607 selectedUsersData={selectedUsersData}
608 buttonsData={deleteUsersButtonsData}
609 onRefresh={refreshUsersData}
610 />
611 <ActivateStageUsers
612 show={showActivateModal}
613 handleModalToggle={onActivateModalToggle}
614 selectedUsers={selectedUsers}
615 onSuccess={refreshUsersData}
616 />
617 </div>
618 </ContextualHelpPanel>
619 );
620 };
621
622 export default StageUsers;