Brijesh619 commented on code in PR #708:
URL: https://github.com/apache/atlas/pull/708#discussion_r3736976198
##########
dashboard/src/views/Administrator/Audits/AuditResults.tsx:
##########
@@ -15,227 +15,730 @@
* limitations under the License.
*/
-import { Grid, Link, List, ListItem, ListItemText, Typography } from
"@mui/material";
-import { auditAction, category } from "@utils/Enum";
+import { Grid, Link, List, ListItem, ListItemText, Typography, Box, Drawer,
IconButton, Stack, Tooltip, TextField, InputAdornment, CircularProgress,
Pagination, PaginationItem, Skeleton } from "@mui/material";
+import KeyboardDoubleArrowLeftIcon from
"@mui/icons-material/KeyboardDoubleArrowLeft";
+import KeyboardDoubleArrowRightIcon from
"@mui/icons-material/KeyboardDoubleArrowRight";
+import ContentCopyIcon from "@mui/icons-material/ContentCopy";
+import SearchIcon from "@mui/icons-material/Search";
+import { auditAction, category, AuditOperation, PurgeActiveView } from
"@utils/Enum";
import { isEmpty, jsonParse } from "@utils/Utils";
+import { useVirtualization } from "@hooks/useVirtualization";
import CustomModal from "@components/Modal";
import TypeDefAuditDetailModal from "@components/TypeDefAuditDetailModal";
-import { useState } from "react";
-import { Item } from "@utils/Muiutils";
+import { useRef, useState, useEffect } from "react";
import AuditsTab from "@views/DetailPage/EntityDetailTabs/AuditsTab";
import ImportExportAudits from "./ImportExportAudits";
+import { LightTooltip } from "@components/muiComponents";
+import { fetchApi } from "@api/apiMethods/fetchApi";
+import "./AuditResults.scss";
+interface AuditEntry {
+ guid: string;
+ operation: string;
+ params?: string;
+ result?: string;
+ runId?: string;
+ [key: string]: unknown;
+}
-const AuditResults = ({ componentProps, row }: any) => {
+interface AuditResultsProps {
+ componentProps?: {
+ auditData?: AuditEntry[];
+ };
+ row: {
+ original: {
+ guid: string;
+ runId?: string;
+ [key: string]: unknown;
+ };
+ };
+}
+
+const AuditResults = ({ componentProps, row }: AuditResultsProps) => {
const { auditData } = componentProps || {};
const [openModal, setOpenModal] = useState<boolean>(false);
const [openPurgeModal, setOpenPurgeModal] = useState<boolean>(false);
- const [currentResultObj, setCurrentObj] = useState<any>({});
- const [currentPurgeResultObj, setCurrentPurgeResultObj] = useState<any>("");
+ const [currentResultObj, setCurrentObj] = useState<Record<string, unknown> |
undefined>();
+ // Stores the guid of the clicked purged entity
+ const [currentPurgeResultObj, setCurrentPurgeResultObj] = useState<string |
undefined>();
+ const [activePurgeView, setActivePurgeView] =
useState<PurgeActiveView>(PurgeActiveView.NONE);
+ const [drawerSearchText, setDrawerSearchText] = useState<string>('');
+ const [drawerPage, setDrawerPage] = useState<number>(1);
+ const [drawerPageSize, setDrawerPageSize] = useState<number>(25);
+ const [drawerPageSizeInput, setDrawerPageSizeInput] = useState<string>('25');
+ const [scrollTop, setScrollTop] = useState<number>(0);
+ const [copiedRunId, setCopiedRunId] = useState<boolean>(false);
+ const [purgedApiGuids, setPurgedApiGuids] = useState<string[]>([]);
+ const [loadingPurgedApi, setLoadingPurgedApi] = useState<boolean>(false);
+ const [purgedTotalCount, setPurgedTotalCount] = useState<number>(0);
+ const [summaryData, setSummaryData] = useState<Record<string, unknown> |
null>(null);
+ const [loadingSummary, setLoadingSummary] = useState<boolean>(false);
+ const drawerScrollTimerRef = useRef<ReturnType<typeof setTimeout> |
null>(null);
Review Comment:
Removed purgedTotalCount, drawerScrollTimerRef, and all associated unused
props from both the main component state and the drawer interface since they
were no longer needed
##########
dashboard/src/views/Administrator/Audits/AuditResults.tsx:
##########
@@ -15,227 +15,730 @@
* limitations under the License.
*/
-import { Grid, Link, List, ListItem, ListItemText, Typography } from
"@mui/material";
-import { auditAction, category } from "@utils/Enum";
+import { Grid, Link, List, ListItem, ListItemText, Typography, Box, Drawer,
IconButton, Stack, Tooltip, TextField, InputAdornment, CircularProgress,
Pagination, PaginationItem, Skeleton } from "@mui/material";
+import KeyboardDoubleArrowLeftIcon from
"@mui/icons-material/KeyboardDoubleArrowLeft";
+import KeyboardDoubleArrowRightIcon from
"@mui/icons-material/KeyboardDoubleArrowRight";
+import ContentCopyIcon from "@mui/icons-material/ContentCopy";
+import SearchIcon from "@mui/icons-material/Search";
+import { auditAction, category, AuditOperation, PurgeActiveView } from
"@utils/Enum";
import { isEmpty, jsonParse } from "@utils/Utils";
+import { useVirtualization } from "@hooks/useVirtualization";
import CustomModal from "@components/Modal";
import TypeDefAuditDetailModal from "@components/TypeDefAuditDetailModal";
-import { useState } from "react";
-import { Item } from "@utils/Muiutils";
+import { useRef, useState, useEffect } from "react";
import AuditsTab from "@views/DetailPage/EntityDetailTabs/AuditsTab";
import ImportExportAudits from "./ImportExportAudits";
+import { LightTooltip } from "@components/muiComponents";
+import { fetchApi } from "@api/apiMethods/fetchApi";
+import "./AuditResults.scss";
+interface AuditEntry {
+ guid: string;
+ operation: string;
+ params?: string;
+ result?: string;
+ runId?: string;
+ [key: string]: unknown;
+}
-const AuditResults = ({ componentProps, row }: any) => {
+interface AuditResultsProps {
+ componentProps?: {
+ auditData?: AuditEntry[];
+ };
+ row: {
+ original: {
+ guid: string;
+ runId?: string;
+ [key: string]: unknown;
+ };
+ };
+}
+
+const AuditResults = ({ componentProps, row }: AuditResultsProps) => {
const { auditData } = componentProps || {};
const [openModal, setOpenModal] = useState<boolean>(false);
const [openPurgeModal, setOpenPurgeModal] = useState<boolean>(false);
- const [currentResultObj, setCurrentObj] = useState<any>({});
- const [currentPurgeResultObj, setCurrentPurgeResultObj] = useState<any>("");
+ const [currentResultObj, setCurrentObj] = useState<Record<string, unknown> |
undefined>();
+ // Stores the guid of the clicked purged entity
+ const [currentPurgeResultObj, setCurrentPurgeResultObj] = useState<string |
undefined>();
+ const [activePurgeView, setActivePurgeView] =
useState<PurgeActiveView>(PurgeActiveView.NONE);
+ const [drawerSearchText, setDrawerSearchText] = useState<string>('');
+ const [drawerPage, setDrawerPage] = useState<number>(1);
+ const [drawerPageSize, setDrawerPageSize] = useState<number>(25);
+ const [drawerPageSizeInput, setDrawerPageSizeInput] = useState<string>('25');
+ const [scrollTop, setScrollTop] = useState<number>(0);
+ const [copiedRunId, setCopiedRunId] = useState<boolean>(false);
+ const [purgedApiGuids, setPurgedApiGuids] = useState<string[]>([]);
+ const [loadingPurgedApi, setLoadingPurgedApi] = useState<boolean>(false);
+ const [purgedTotalCount, setPurgedTotalCount] = useState<number>(0);
+ const [summaryData, setSummaryData] = useState<Record<string, unknown> |
null>(null);
+ const [loadingSummary, setLoadingSummary] = useState<boolean>(false);
+ const drawerScrollTimerRef = useRef<ReturnType<typeof setTimeout> |
null>(null);
+
+
const handleCloseModal = () => {
setOpenModal(false);
};
const handleClosePurgeModal = () => {
setOpenPurgeModal(false);
};
- const auditObj = !isEmpty(auditData)
- ? auditData.find((obj: { guid: string }) => obj.guid == row.original.guid)
- : {};
- const { operation, params, result } = auditObj;
+ const auditObj: AuditEntry | undefined = !isEmpty(auditData)
+ ? (auditData as AuditEntry[]).find((obj) => obj.guid === row.original.guid)
+ : undefined;
+
+ const operation = auditObj?.operation ?? '';
+ const params = auditObj?.params;
+ const result = auditObj?.result;
+
+ let isPurgeOperation = operation === AuditOperation.PURGE || operation ===
AuditOperation.AUTO_PURGE;
+ const summaryGuid = auditObj?.guid ?? row.original.guid;
+
+ useEffect(() => {
+ if (isPurgeOperation && summaryGuid) {
+ setLoadingSummary(true);
+ fetchApi(`/api/atlas/admin/audit/${summaryGuid}/summary`, {
+ method: "GET",
+ headers: { 'Accept': 'application/json', 'Content-Type':
'application/json' }
+ })
+ .then(res => {
+ if (res.data && typeof res.data === 'object') {
+ setSummaryData(res.data);
+ }
+ })
+ .catch(err => {
+ console.error("Failed to fetch purge summary", err);
+ })
+ .finally(() => {
+ setLoadingSummary(false);
+ });
+ }
+ }, [isPurgeOperation, summaryGuid]);
+
+ let summary: Record<string, unknown> = summaryData || {};
+ let requestedEntitiesList: string[] = [];
+ let legacyPurgedList: string[] = [];
+
+ if (isPurgeOperation) {
+ if (!summaryData) {
+ try {
+ const parsed = typeof result === "string" ? JSON.parse(result) :
result;
+ if (parsed && typeof parsed === "object" && !Array.isArray(parsed)) {
+ summary = (parsed as Record<string, unknown>).summary
+ ? (parsed as Record<string, unknown>).summary as Record<string,
unknown>
+ : parsed as Record<string, unknown>;
+ } else if (Array.isArray(parsed)) {
+ legacyPurgedList = (parsed as unknown[]).map((item) =>
+ typeof item === "string" ? item : (item as { guid?: string }).guid
|| String(item)
+ );
+ }
+ } catch (_e) {
+ if (typeof result === "string" && !result.startsWith("{")) {
+ legacyPurgedList = result.replace(/^\[|\]$/g, "").split(",").map(s
=> s.trim()).filter(Boolean);
+ }
+ }
+ } else {
+ if (typeof result === "string" && !result.startsWith("{")) {
+ legacyPurgedList = result.replace(/^\[|\]$/g, "").split(",").map(s =>
s.trim()).filter(Boolean);
+ }
+ }
+
+ if (params) {
+ try {
+ const parsedParams = JSON.parse(params);
+ if (Array.isArray(parsedParams)) {
+ requestedEntitiesList = parsedParams as string[];
+ } else if (typeof params === "string") {
+ requestedEntitiesList = params.replace(/^\[|\]$/g,
"").split(",").map(s => s.trim()).filter(Boolean);
+ }
+ } catch (_e) {
+ requestedEntitiesList = typeof params === "string"
+ ? params.replace(/^\[|\]$/g, "").split(",").map(s =>
s.trim()).filter(Boolean)
+ : [];
+ }
+ }
+ } else {
+ try {
+ summary = jsonParse(result) as Record<string, unknown>;
+ } catch (_e) {
+ summary = {};
+ }
+ }
+
+ const runId = (row.original.runId as string | undefined)
+ ?? (summary?.runId as string | undefined)
+ ?? (auditObj?.runId as string | undefined)
+ ?? 'N/A';
- const resultObj =
- (operation == "PURGE" || operation == "AUTO_PURGE")
- ? result.replace("[", "").replace("]", "").split(",")
- : jsonParse(result);
+ const isSummaryRow = (runId !== 'N/A') && isPurgeOperation;
+
+ const requestedCount = (summary?.requestedCount as number | undefined) ??
requestedEntitiesList.length;
+ const purgedCount = (summary?.purgedCount as number | undefined) ??
legacyPurgedList.length;
+ const purgedDependenciesCount = (summary?.purgedDependenciesCount as number
| undefined) ?? 0;
+ const totalPurgedCount = (purgedCount as number) + (purgedDependenciesCount
as number);
+ const failedCount = (summary?.failedCount as number | undefined) ?? 0;
+ const failedDependenciesCount = (summary?.failedDependenciesCount as number
| undefined) ?? 0;
+ const totalFailedCount = failedCount + failedDependenciesCount;
+ const skippedCount = (summary?.skippedCount as number | undefined) ?? 0;
+ const executionFailed = (summary?.executionFailed as boolean | undefined) ||
(totalFailedCount) > 0;
+
+ // Fetching purged entities from an API is disabled for now.
+ // We simply use the raw `result` string as requested.
+ const fetchPurged = () => {
+ // Disabled. The UI will just use the `result` string.
+ };
+
+ // Handle clicking Total Purged card: opens drawer and fetches first page
+ const handleOpenPurgedDrawer = () => {
+ if (totalPurgedCount === 0) return;
+ setPurgedTotalCount(totalPurgedCount);
+ setActivePurgeView(PurgeActiveView.PURGED);
+ setDrawerPage(1);
+ setScrollTop(0);
+ // As requested, Total Purged simply uses the raw `result` object string
(legacyPurgedList)
+ setPurgedApiGuids(legacyPurgedList);
+ setLoadingPurgedApi(false);
+ };
return (
<>
- {operation != "PURGE" &&
- operation != "AUTO_PURGE" &&
- operation != "IMPORT" &&
- operation != "EXPORT" &&
- !isEmpty(resultObj) ? (
- <Grid container spacing={2}>
- {params.split(",").length > 1 ? (
- <>
- {params.split(",")?.map((param: { param: string }) => {
- return (
- <Grid item md={4}>
- <Item
- sx={{
- height: "100%",
- maxHeight: "300px",
- overflow: "auto",
- }}
- >
- <Typography
- sx={{ padding: "1rem 0 0 1rem", textAlign: "left" }}
- >{`${category[param as any]} ${auditAction[operation]
- }`}</Typography>
-
- <List className="audit-results-list">
- {resultObj[param as any].map(
- (obj: { name: string }) => {
- const { name } = obj;
- return (
- <>
- <ListItem className="audit-results-list-item">
- <Link
- className="audit-results-entityid"
- component="button"
- variant="body2"
- onClick={() => {
- setOpenModal(true);
- setCurrentObj(obj);
- }}
- title={name}
- sx={{
- display: "inline-block",
- maxWidth: "100%",
- textOverflow: "ellipsis",
- overflow: "hidden",
- whiteSpace: "nowrap",
- textAlign: "left",
- verticalAlign: "bottom"
- }}
- >
- {name}
- </Link>
- </ListItem>
- </>
- );
- }
- )}
- </List>
- </Item>
- </Grid>
- );
- })}
- </>
- ) : (
- <>
- <Grid item md={4}>
- <Item
- sx={{
- height: "100%",
- maxHeight: "300px",
- overflow: "auto",
- }}
- >
- <Typography
- sx={{ padding: "1rem 0 0 1rem", textAlign: "left" }}
- >{`${category[params as any]} ${auditAction[operation]
- }`}</Typography>
- <List className="audit-results-list">
- {resultObj[params].map((obj: { name: string }) => {
- const { name } = obj;
- return (
- <>
- <ListItem className="audit-results-list-item">
+ <TypeDefAuditDetailModal
+ open={openModal}
+ onClose={handleCloseModal}
+ detailObject={currentResultObj ?? null}
+ maxWidth="md"
+ />
+
+ <CustomModal
+ open={openPurgeModal}
+ onClose={handleClosePurgeModal}
+ title={`Purged Entity Details: ${currentPurgeResultObj}`}
+ button1Handler={undefined}
+ button2Handler={undefined}
+ maxWidth="md"
+ footer={false}
+ >
+ <AuditsTab auditResultGuid={currentPurgeResultObj} />
+ </CustomModal>
+
+ {operation === "TYPE_DEF_CREATE" ||
+ operation === "TYPE_DEF_UPDATE" ||
+ operation === "TYPE_DEF_DELETE" ? (
+ <List className="audit-results-list">
+ {summary &&
+ Object.keys(summary).map((key: string) => {
+ const rawItems = summary[key];
+ const items: Array<Record<string, unknown> | string> =
Array.isArray(rawItems)
+ ? (rawItems as Array<Record<string, unknown> | string>)
+ : [];
+ return (
+ <div key={key}>
+ <Typography className="audit-list-header">
+ {`${category[key as keyof typeof category] || key}
${auditAction[operation as keyof typeof auditAction] || operation}`}
+ </Typography>
+ {items.map((obj: Record<string, unknown> | string, idx:
number) => {
+ const name = typeof obj === 'object' && obj !== null
+ ? (obj.name as string) || String(obj)
+ : String(obj);
+ return (
+ <ListItem key={name + idx}
className="audit-results-list-item">
+ <ListItemText
+ primary={
<Link
- className="audit-results-entityid"
+ className="audit-results-entityid
audit-list-link"
component="button"
variant="body2"
onClick={() => {
setOpenModal(true);
- setCurrentObj(obj);
+ setCurrentObj(typeof obj === "object" ? obj :
{ name: obj });
}}
title={name}
- sx={{
- display: "inline-block",
- maxWidth: "100%",
- textOverflow: "ellipsis",
- overflow: "hidden",
- whiteSpace: "nowrap",
- textAlign: "left",
- verticalAlign: "bottom"
- }}
>
{name}
</Link>
- </ListItem>
- </>
- );
- })}
- </List>
- </Item>
+ }
+ />
+ </ListItem>
+ );
+ })}
+ </div>
+ );
+ })}
+ </List>
+ ) : operation === "IMPORT" || operation === "EXPORT" ? (
+ <ImportExportAudits auditObj={auditObj} />
+ ) : !isPurgeOperation ? (
+ <Typography>No Results Found</Typography>
+ ) : null}
+
+ {/* Purge Audit View */}
+ {isPurgeOperation ? (
+ <Box className="purge-audit-view">
+ {loadingSummary && Object.keys(summary).length === 0 &&
legacyPurgedList.length === 0 && !result ? (
+ <Box sx={{ p: 2 }}>
+ <Skeleton variant="text" width="40%" height={30} sx={{ mb: 2 }}
/>
+ <Grid container spacing={2}>
+ <Grid item xs={6} sm={3}><Skeleton variant="rectangular"
height={70} sx={{ borderRadius: 1 }} /></Grid>
+ <Grid item xs={6} sm={3}><Skeleton variant="rectangular"
height={70} sx={{ borderRadius: 1 }} /></Grid>
+ <Grid item xs={6} sm={3}><Skeleton variant="rectangular"
height={70} sx={{ borderRadius: 1 }} /></Grid>
+ <Grid item xs={6} sm={3}><Skeleton variant="rectangular"
height={70} sx={{ borderRadius: 1 }} /></Grid>
+ </Grid>
+ </Box>
+ ) : (
+ <Box className="purge-summary-container">
+
+ {/* Run Id Header with Copy Action */}
+ {runId !== 'N/A' && (
+ <Box className="purge-runid-header">
+ <Typography variant="body2" color="textSecondary"
className="runid-text">
+ <strong>Run Id:</strong> {runId}
+ </Typography>
+ <Tooltip title={copiedRunId ? "Copied!" : "Copy Run Id"}>
+ <IconButton
+ size="small"
+ onClick={() => {
+ if (navigator.clipboard) {
+ navigator.clipboard.writeText(runId);
+ } else {
+ const textField = document.createElement('textarea');
+ textField.innerText = runId;
+ document.body.appendChild(textField);
+ textField.select();
+ document.execCommand('copy');
+ textField.remove();
+ }
+ setCopiedRunId(true);
+ setTimeout(() => setCopiedRunId(false), 2000);
+ }}
+ className="purge-runid-copy"
+ >
+ <ContentCopyIcon className={`copy-icon ${copiedRunId ?
"copied" : ""}`} />
+ </IconButton>
+ </Tooltip>
+ </Box>
+ )}
+
+ {/* 4 Cards Grid: Requested, Total Purged, Failed (Display
Only), Skipped (Display Only) */}
+ <Grid container spacing={2}>
+ {/* 1. Clickable Requested Card */}
+ {isSummaryRow && (
+ <Grid item xs={6} sm={3}>
+ <Box
+ onClick={() => {
+ setActivePurgeView(PurgeActiveView.REQUESTED);
+ setDrawerPage(1);
+ setScrollTop(0);
+ }}
+ className="purge-card purge-card-requested"
+ >
+ <Typography variant="caption" color="primary.main"
display="block" className="card-title">
+ Requested
+ </Typography>
+ <Typography variant="h5" color="primary.main"
className="card-count">
+ {requestedCount}
+ </Typography>
+ </Box>
+ </Grid>
+ )}
+
+ {/* 2. Clickable Total Purged Card */}
+ <Grid item xs={isSummaryRow ? 6 : 12} sm={isSummaryRow ? 3 :
4}>
+ <Box
+ onClick={handleOpenPurgedDrawer}
+ className={`purge-card purge-card-purged
${totalPurgedCount > 0 ? "clickable" : ""}`}
+ >
+ <Typography variant="caption" color="success.main"
display="block" className="card-title">
+ PURGED
+ </Typography>
+ <Typography variant="h5" color="success.main"
className="card-count">
+ {totalPurgedCount}
+ </Typography>
+ </Box>
+ </Grid>
+
+ {/* 3 & 4. Display-Only Failed and Skipped Cards */}
+ {isSummaryRow && (
+ <>
+ <Grid item xs={6} sm={3}>
+ <LightTooltip
+ title={
+ totalFailedCount > 0 || executionFailed
+ ? "Some entities failed to purge. Please check
${atlas.log.dir}/purgefailure.log for details."
Review Comment:
Fixed! I have removed the path variables from the dashboard UI and hardcoded
it to purgefailure.log so the string renders cleanly without any literal
template variables showing up. I also applied this exact same full-sentence
format to dashboardv2 so that the tooltip messages are now perfectly consistent
across both dashboards.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
