Debian Codegraph @

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