Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: doc prop issues #1513

Merged
merged 5 commits into from
Dec 10, 2024
Merged

fix: doc prop issues #1513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f5caf21
fix: showing doc prop btn when col desc
AdiGajbhiye Nov 27, 2024
13cee5b
fix: styling
AdiGajbhiye Nov 27, 2024
a1572ac
fix: no cll text
AdiGajbhiye Nov 27, 2024
d8ce150
feat: added saved sucessfully message
AdiGajbhiye Nov 27, 2024
9f114f0
Merge branch 'master' into fix-doc-prop-issues
anandgupta42 Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
147 changes: 82 additions & 65 deletions ...ules/documentationEditor/components/documentationPropagation/DocumentationPropagation.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ export const DocumentationPropagationButton = ({
const [allColumns, setAllColumns] = useState<DocsItem[]>([]);
const [currColumns, setCurrColumns] = useState<DocsItem[]>([]);
const [isLoading, setIsLoading] = useState(false);
const [isSaved, setIsSaved] = useState(false);
const [tableMetadata, setTableMetadata] = useState<TableMetadata[]>([]);
const [testsMetadata, setTestsMetadata] = useState<Record<string, unknown>>(
{},
Expand All @@ -72,6 +73,7 @@ export const DocumentationPropagationButton = ({
setAllColumns([]);
setCurrColumns(startColumn);
setTableMetadata([]);
setIsSaved(false);
}, [currentDocsData?.uniqueId, name]);

const loadMoreDownstreamModels = async () => {
Expand Down Expand Up @@ -165,6 +167,7 @@ export const DocumentationPropagationButton = ({
}

await executeRequestInSync("saveDocumentationBulk", { models: req });
setIsSaved(true);
};

const setAllColumnsValue = (value: boolean) => {
Expand All @@ -183,6 +186,10 @@ export const DocumentationPropagationButton = ({
return null;
}

if (!currColumnDescription) {
return null;
}

return (
<Drawer
buttonProps={{ color: "primary", title: "Propagate documentation" }}
Expand All @@ -193,81 +200,91 @@ export const DocumentationPropagationButton = ({
>
<Stack direction="column" className="gap-0 mb-2">
<div className={styles.itemRow}>
<div className="fw-semibold">Model:</div>
<div>Model:</div>
<div>{currentDocsData?.name}</div>
</div>
<div className={styles.itemRow}>
<div className="fw-semibold">Column:</div>
<div>Column:</div>
<div>{name}</div>
</div>
{currColumnDescription && (
<div className={styles.itemRow}>
<div className="fw-semibold">Description:</div>
<div className={styles.colDesc}>
<div>Description:</div>
<div>{currColumnDescription}</div>
</div>
)}
</Stack>
<Stack className="mb-2">
<Button color="primary" onClick={() => setAllColumnsValue(true)}>
Select All
</Button>
<Button color="primary" onClick={() => setAllColumnsValue(false)}>
Unselect All
</Button>
</Stack>
<Stack direction="column" className="gap-md">
{allColumns.map((item) => {
const key = item.model + "/" + item.column;
return (
<Stack key={key} className={styles.itemCard}>
<Input
type="checkbox"
checked={selectedColumns[key]}
onChange={() =>
setSelectedColumns((prev) => ({
...prev,
[key]: !prev[key],
}))
}
/>
<Stack direction="column" className="gap-0 w-100">
<div className={styles.itemRow}>
<div>Model:</div>
<div>{item.model.split(".").pop()}</div>
</div>
<div className={styles.itemRow}>
<div>Column:</div>
<div>{item.column}</div>
</div>
<div className={styles.itemRow}>
<div>Description:</div>
<div>{item.description}</div>
</div>
</Stack>
</Stack>
);
})}
{currColumns.length > 0 && (
<Button
color="primary"
outline
onClick={loadMoreDownstreamModels}
disabled={isLoading}
>
Load 3 more downstream levels
</Button>
)}
<Button
color="primary"
disabled={
Object.values(selectedColumns).filter((v) => Boolean(v)).length ===
0
}
onClick={() => propagateDocumentation()}
>
Propagate documentation to selected models
</Button>
</Stack>
{!isLoading && allColumns.length === 0 ? (
<div className="mt-4">
No downstream column level lineage detected to propagate the
documentation
</div>
) : (
<>
<Stack className="mb-2">
<Button color="primary" onClick={() => setAllColumnsValue(true)}>
Select All
</Button>
<Button color="primary" onClick={() => setAllColumnsValue(false)}>
Unselect All
</Button>
</Stack>
<Stack direction="column" className="gap-md">
{allColumns.map((item) => {
const key = item.model + "/" + item.column;
return (
<Stack key={key} className={styles.itemCard}>
<Input
type="checkbox"
checked={selectedColumns[key]}
onChange={() =>
setSelectedColumns((prev) => ({
...prev,
[key]: !prev[key],
}))
}
/>
<Stack direction="column" className="gap-0 w-100">
<div className={styles.itemRow}>
<div>Model:</div>
<div>{item.model.split(".").pop()}</div>
</div>
<div className={styles.itemRow}>
<div>Column:</div>
<div>{item.column}</div>
</div>
<div className={styles.itemRow}>
<div>Description:</div>
<div>{item.description}</div>
</div>
</Stack>
</Stack>
);
})}
{currColumns.length > 0 && (
<Button
color="primary"
outline
onClick={loadMoreDownstreamModels}
disabled={isLoading}
>
Load 3 more downstream levels
</Button>
)}
<Button
color="primary"
disabled={
Object.values(selectedColumns).filter((v) => Boolean(v))
.length === 0
}
onClick={() => propagateDocumentation()}
>
Propagate documentation to selected models
</Button>
{isSaved && <div>Saved documentation successfully</div>}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider resetting isSaved to false after displaying the success message to ensure correct UI behavior if the component is reused.

</Stack>
</>
)}
</Drawer>
);
};
13 changes: 12 additions & 1 deletion ...ls/src/modules/documentationEditor/components/documentationPropagation/styles.module.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,18 @@
grid-template-columns: 1fr 3fr;

:nth-child(1) {
font-weight: 500;
font-weight: 600;
}

:nth-child(2) {
line-break: anywhere;
color: var(--text-grey2-color);
}
}

.colDesc {
:nth-child(1) {
font-weight: 600;
}

:nth-child(2) {
Expand Down
Loading