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

feat/535-ga-display-display-warning-if-metadata-is-not-in-the-expected-format #598

Merged
merged 4 commits into from
Apr 2, 2024
Merged

feat/535-ga-display-display-warning-if-metadata-is-not-in-the-expected-format #598

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c91efd0
[#535] check governance actions are valid
Sworzen1 Mar 29, 2024
b0ef654
fix lint
Sworzen1 Mar 29, 2024
7d59e1d
add types
Sworzen1 Mar 29, 2024
53d8882
add to changlog/ fix types
Sworzen1 Mar 29, 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
5 changes: 2 additions & 3 deletions govtool/frontend/src/components/molecules/Breadcrumbs.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { NavLink, To } from "react-router-dom";
import { Box } from "@mui/material";
import Divider from "@mui/material/Divider";

import { useScreenDimension, useTranslation } from "@hooks";
import { useScreenDimension } from "@hooks";
import { Typography } from "@atoms";

type BreadcrumbsProps = {
Expand All @@ -18,7 +18,6 @@ export const Breadcrumbs = ({
elementTwo,
isDataMissing,
}: BreadcrumbsProps) => {
const { t } = useTranslation();
const { isMobile } = useScreenDimension();

return (
Expand Down Expand Up @@ -55,7 +54,7 @@ export const Breadcrumbs = ({
textOverflow: "ellipsis",
}}
>
{isDataMissing ? t("govActions.dataMissing") : elementTwo}
{isDataMissing || elementTwo}
</Typography>
</Box>
);
Expand Down
50 changes: 37 additions & 13 deletions govtool/frontend/src/components/molecules/DataMissingInfoBox.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,42 @@ import { Box, Link } from "@mui/material";

import { Typography } from "@atoms";
import { useTranslation } from "@hooks";
import { openInNewTab } from "@utils";
import { GAMetedataErrors, openInNewTab } from "@utils";

export const DataMissingInfoBox = () => {
export const DataMissingInfoBox = ({
isDataMissing,
isInProgress,
isSubmitted,
}: {
isDataMissing: boolean | GAMetedataErrors;
isInProgress?: boolean;
isSubmitted?: boolean;
}) => {
const { t } = useTranslation();

return (
const gaMetadataErrorMessage = {
[GAMetedataErrors.DATA_MISSING]: t("errors.gAMetadata.message.dataMissing"),
[GAMetedataErrors.INCORRECT_FORMAT]: t(
"errors.gAMetadata.message.incorrectFormat",
),
[GAMetedataErrors.NOT_VERIFIABLE]: t(
"errors.gAMetadata.message.notVerifiable",
),
}[isDataMissing as GAMetedataErrors];
Copy link
Contributor

Choose a reason for hiding this comment

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

I would split this property to be either boolean or enum if that is easy applicable.
If not - leave a TODO to replace that when our minimal metadata validation backend is ready


const gaMetadataErrorDescription = {
[GAMetedataErrors.DATA_MISSING]: t(
"errors.gAMetadata.description.dataMissing",
),
[GAMetedataErrors.INCORRECT_FORMAT]: t(
"errors.gAMetadata.description.incorrectFormat",
),
[GAMetedataErrors.NOT_VERIFIABLE]: t(
"errors.gAMetadata.description.notVerifiable",
),
}[isDataMissing as GAMetedataErrors];

return isDataMissing && !isSubmitted && !isInProgress ? (
<Box
sx={{
mb: 4,
Expand All @@ -22,9 +52,7 @@ export const DataMissingInfoBox = () => {
mb: 0.5,
}}
>
{/* TODO: Text to confirm/change */}
The data that was originally used when this Governance Action was
created has been formatted incorrectly.
{gaMetadataErrorMessage}
</Typography>
<Typography
sx={{
Expand All @@ -33,17 +61,13 @@ export const DataMissingInfoBox = () => {
mb: 0.5,
}}
>
{/* TODO: Text to confirm/change */}
GovTool uses external sources for Governance Action data, and these
sources are maintained by the proposers of the Actions. This error means
that GovTool cannot locate the data on the URL specified when the
Governance Action was originally posted.
{gaMetadataErrorDescription}
</Typography>
<Link
onClick={() =>
// TODO: Add the correct link
openInNewTab(
"https://docs.sanchogov.tools/how-to-use-the-govtool/getting-started/get-a-compatible-wallet"
"https://docs.sanchogov.tools/how-to-use-the-govtool/getting-started/get-a-compatible-wallet",
)
}
sx={{
Expand All @@ -56,5 +80,5 @@ export const DataMissingInfoBox = () => {
{t("learnMore")}
</Link>
</Box>
);
) : null;
};
12 changes: 3 additions & 9 deletions govtool/frontend/src/components/molecules/GovernanceActionCard.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,8 @@ import {
getProposalTypeNoEmptySpaces,
} from "@utils";

const mockedLongText =
"Lorem ipsum dolor sit, amet consectetur adipisicing elit. Sit, distinctio culpa minus eaque illo quidem voluptates quisquam mollitia consequuntur ex, sequi saepe? Ad ex adipisci molestiae sed.";

type ActionTypeProps = Omit<
ActionType,
ActionTypeToDsiplay,
| "yesVotes"
| "noVotes"
| "abstainVotes"
Expand All @@ -32,7 +29,6 @@ type ActionTypeProps = Omit<
| "rationale"
| "motivation"
> & {
isDataMissing: boolean;
onClick?: () => void;
inProgress?: boolean;
};
Expand Down Expand Up @@ -87,14 +83,12 @@ export const GovernanceActionCard: FC<ActionTypeProps> = ({ ...props }) => {
}}
>
<GovernanceActionCardHeader
// TODO: Remove "Fund our project" when title is implemented everywhere
title={title ?? "Fund our project"}
title={title}
isDataMissing={isDataMissing}
/>
<GovernanceActionCardElement
label={t("govActions.abstract")}
// TODO: Remove mock when possible
text={about ?? mockedLongText}
text={about}
textVariant="twoLines"
dataTestId="governance-action-abstract"
isSliderCard
Expand Down
174 changes: 90 additions & 84 deletions govtool/frontend/src/components/molecules/GovernanceActionCardElement.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { Typography, Tooltip, CopyButton, TooltipProps } from "@atoms";

type BaseProps = {
label: string;
text: string;
text?: string;
dataTestId?: string;
isSliderCard?: boolean;
tooltipProps?: Omit<TooltipProps, "children">;
Expand Down Expand Up @@ -33,104 +33,110 @@ export const GovernanceActionCardElement = ({
isCopyButton,
tooltipProps,
marginBottom,
}: GovernanceActionCardElementProps) => (
<Box
data-testid={dataTestId}
mb={marginBottom ?? isSliderCard ? "20px" : "32px"}
>
}: GovernanceActionCardElementProps) => {
if (!text) {
return null;
}
return (
<Box
sx={{
display: "flex",
alignItems: "center",
mb: "4px",
}}
data-testid={dataTestId}
mb={marginBottom ?? isSliderCard ? "20px" : "32px"}
>
<Typography
<Box
sx={{
fontSize: isSliderCard ? 12 : 14,
fontWeight: isSliderCard ? 500 : 600,
lineHeight: isSliderCard ? "16px" : "20px",
color: "neutralGray",
overflow: "hidden",
textOverflow: "ellipsis",
whiteSpace: "nowrap",
display: "flex",
alignItems: "center",
mb: "4px",
}}
>
{label}
</Typography>
{tooltipProps && (
<Tooltip
heading={tooltipProps?.heading}
paragraphOne={tooltipProps?.paragraphOne}
placement="bottom-end"
arrow
{...tooltipProps}
>
<InfoOutlinedIcon
sx={{ ml: 0.7, mb: 0.1, color: "#ADAEAD", fontSize: "small" }}
/>
</Tooltip>
)}
</Box>
<Box display="flex">
{textVariant === "pill" ? (
<Box
<Typography
sx={{
padding: "6px 18px",
fontSize: isSliderCard ? 12 : 14,
fontWeight: isSliderCard ? 500 : 600,
lineHeight: isSliderCard ? "16px" : "20px",
color: "neutralGray",
overflow: "hidden",
bgcolor: "lightBlue",
borderRadius: 100,
textOverflow: "ellipsis",
whiteSpace: "nowrap",
}}
>
<Typography
variant="caption"
{label}
</Typography>
{tooltipProps && (
<Tooltip
heading={tooltipProps?.heading}
paragraphOne={tooltipProps?.paragraphOne}
placement="bottom-end"
arrow
{...tooltipProps}
>
<InfoOutlinedIcon
sx={{ ml: 0.7, mb: 0.1, color: "#ADAEAD", fontSize: "small" }}
/>
</Tooltip>
)}
</Box>
<Box display="flex">
{textVariant === "pill" ? (
<Box
sx={{
padding: "6px 18px",
overflow: "hidden",
textOverflow: "ellipsis",
whiteSpace: "nowrap",
bgcolor: "lightBlue",
borderRadius: 100,
}}
>
{text}
</Typography>
</Box>
) : (
<Box
sx={{
display: "flex",
alignItems: "center",
overflow: "hidden",
}}
>
<Typography
sx={{
fontSize: isSliderCard ? 14 : 16,
fontWeight: 400,
lineHeight: isSliderCard ? "20px" : "24px",
...(textVariant === "oneLine" && { whiteSpace: "nowrap" }),
...((textVariant === "oneLine" || textVariant === "twoLines") && {
<Typography
variant="caption"
sx={{
overflow: "hidden",
textOverflow: "ellipsis",
}),
...(textVariant === "twoLines" && {
display: "-webkit-box",
WebkitBoxOrient: "vertical",
WebkitLineClamp: 2,
whiteSpace: "normal",
}),
...(isCopyButton && {
color: "primaryBlue",
}),
whiteSpace: "nowrap",
}}
>
{text}
</Typography>
</Box>
) : (
<Box
sx={{
display: "flex",
alignItems: "center",
overflow: "hidden",
}}
>
{text}
</Typography>
{isCopyButton && (
<Box ml={1}>
<CopyButton text={text} variant="blueThin" />
</Box>
)}
</Box>
)}
<Typography
sx={{
fontSize: isSliderCard ? 14 : 16,
fontWeight: 400,
lineHeight: isSliderCard ? "20px" : "24px",
...(textVariant === "oneLine" && { whiteSpace: "nowrap" }),
...((textVariant === "oneLine" ||
textVariant === "twoLines") && {
overflow: "hidden",
textOverflow: "ellipsis",
}),
...(textVariant === "twoLines" && {
display: "-webkit-box",
WebkitBoxOrient: "vertical",
WebkitLineClamp: 2,
whiteSpace: "normal",
}),
...(isCopyButton && {
color: "primaryBlue",
}),
}}
>
{text}
</Typography>
{isCopyButton && (
<Box ml={1}>
<CopyButton text={text} variant="blueThin" />
</Box>
)}
</Box>
)}
</Box>
</Box>
</Box>
);
);
};
21 changes: 8 additions & 13 deletions govtool/frontend/src/components/molecules/GovernanceActionCardHeader.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import { Tooltip, Typography } from "@atoms";
import { useTranslation } from "@hooks";

type GovernanceActionCardHeaderProps = {
title: string;
isDataMissing: boolean;
title?: string;
isDataMissing: string | boolean;
};

export const GovernanceActionCardHeader = ({
Expand All @@ -26,22 +26,17 @@ export const GovernanceActionCardHeader = ({
>
<Typography
sx={{
fontSize: 22,
fontWeight: 400,
lineHeight: "28px",
overflow: "hidden",
textOverflow: "ellipsis",
display: "-webkit-box",
WebkitBoxOrient: "vertical",
WebkitLineClamp: 2,
fontSize: 18,
fontWeight: 600,
lineHeight: "24px",
...(isDataMissing && { color: "#9E2323" }),
}}
>
{isDataMissing ? t("govActions.dataMissing") : title}
{isDataMissing || title}
</Typography>
{isDataMissing && (
{isDataMissing && typeof isDataMissing === "string" && (
<Tooltip
heading={t("govActions.dataMissing")}
heading={isDataMissing}
paragraphOne={t("govActions.dataMissingTooltipExplanation")}
placement="bottom-end"
arrow
Expand Down
Loading
Loading