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.

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: add support for governance actions outcomes #2614

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions govtool/frontend/.env.example
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ VITE_GTM_ID=""
VITE_IS_DEV=true
VITE_USERSNAP_SPACE_API_KEY=""
VITE_IS_PROPOSAL_DISCUSSION_FORUM_ENABLED='true'
VITE_IS_GOVERNANCE_OUTCOMES_PILLAR_ENABLED=true
VITE_PDF_API_URL=""
VITE_IPFS_GATEWAY=""
VITE_IPFS_PROJECT_ID=""
1 change: 1 addition & 0 deletions govtool/frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"@emotion/styled": "^11.11.0",
"@emurgo/cardano-serialization-lib-asmjs": "^12.1.1",
"@hookform/resolvers": "^3.3.1",
"@intersect.mbo/govtool-outcomes-pillar-ui": "^1.0.0-beta.1",
"@intersect.mbo/intersectmbo.org-icons-set": "^1.0.8",
"@intersect.mbo/pdf-ui": "^0.5.5",
"@mui/icons-material": "^5.14.3",
Expand Down
20 changes: 18 additions & 2 deletions govtool/frontend/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { useCallback, useEffect } from "react";
import { Route, Routes, useNavigate } from "react-router-dom";

import { Modal, ScrollToTop } from "@atoms";
import { PATHS, PDF_PATHS } from "@consts";
import { PATHS, PDF_PATHS, OUTCOMES_PATHS, USER_PATHS } from "@consts";
import { useCardano, useFeatureFlag, useModal } from "@context";
import { useWalletConnectionListener } from "@hooks";
import {
Expand Down Expand Up @@ -39,9 +39,13 @@ import {
import { PublicRoute } from "./pages/PublicRoute";
import { TopBanners } from "./components/organisms/TopBanners";
import { DashboardHome } from "./pages/DashboardHome";
import { GovernanceActionOutComesPillar } from "./pages/GovernanceActionOutComes";

export default () => {
const { isProposalDiscussionForumEnabled } = useFeatureFlag();
const {
isProposalDiscussionForumEnabled,
isGovernanceOutcomesPillarEnabled,
} = useFeatureFlag();
const { enable, isEnabled } = useCardano();
const navigate = useNavigate();
const { modal, openModal, modals } = useModal();
Expand Down Expand Up @@ -111,6 +115,18 @@ export default () => {
element={<ProposalDiscussionPillar />}
/>
)}
{isGovernanceOutcomesPillarEnabled && (
<>
<Route
path={`${OUTCOMES_PATHS.governanceActionsOutcomes}/*`}
element={<GovernanceActionOutComesPillar />}
/>
<Route
path={USER_PATHS.governanceActionsVotedByMe}
element={<GovernanceActionOutComesPillar />}
/>
</>
)}
<Route
path={PATHS.dashboardGovernanceActions}
element={<DashboardGovernanceActions />}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export const DashboardDrawerMobile = ({
isDrawerOpen,
setIsDrawerOpen,
}: DashboardDrawerMobileProps) => {
const { isProposalDiscussionForumEnabled } = useFeatureFlag();
const { isProposalDiscussionForumEnabled, isGovernanceOutcomesPillarEnabled } = useFeatureFlag();
const { screenWidth } = useScreenDimension();
const { voter } = useGetVoterInfo();

Expand Down Expand Up @@ -75,26 +75,60 @@ export const DashboardDrawerMobile = ({
</Box>
<Grid container direction="column" rowGap={4} mt={6}>
{CONNECTED_NAV_ITEMS.map((navItem) => {
if (
!isProposalDiscussionForumEnabled &&
navItem.dataTestId === "proposal-discussion-link"
) {
return null;
}

return (
<Grid item>
<Link
{...navItem}
size="big"
onClick={() => {
// TODO: Refine if it is needed to remove this eslint-disable
// eslint-disable-next-line no-unused-expressions
navItem.newTabLink && openInNewTab(navItem.newTabLink);
if (navItem.newTabLink) {
openInNewTab(navItem.newTabLink);
}
setIsDrawerOpen(false);
}}
isConnectWallet
/>
{navItem.childNavItems && (
<Grid
container
direction="column"
rowGap={4}
mt={3}
pl={3}
>
{navItem.childNavItems.map((childItem) => {
if (
!isProposalDiscussionForumEnabled &&
childItem.dataTestId === "proposal-discussion-link"
) {
return null;
}

if (
!isGovernanceOutcomesPillarEnabled &&
(childItem.dataTestId === "governance-actions-voted-by-me-link" ||
childItem.dataTestId === "governance-actions-outcomes-link")
) {
return null;
}

return (
<Link
key={childItem.label}
{...childItem}
size="big"
onClick={() => {
if (childItem.newTabLink) {
openInNewTab(childItem.newTabLink);
}
setIsDrawerOpen(false);
}}
isConnectWallet
/>
);
})}
</Grid>
)}
</Grid>
);
})}
Expand Down
50 changes: 42 additions & 8 deletions govtool/frontend/src/components/organisms/Drawer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { WalletInfoCard, DRepInfoCard } from "@molecules";
import { openInNewTab } from "@utils";

export const Drawer = () => {
const { isProposalDiscussionForumEnabled } = useFeatureFlag();
const { isProposalDiscussionForumEnabled, isGovernanceOutcomesPillarEnabled } = useFeatureFlag();
const { voter } = useGetVoterInfo();

return (
Expand Down Expand Up @@ -47,13 +47,6 @@ export const Drawer = () => {
rowGap={2}
>
{CONNECTED_NAV_ITEMS.map((navItem) => {
if (
!isProposalDiscussionForumEnabled &&
navItem.dataTestId === "proposal-discussion-link"
) {
return null;
}

return (
<Grid item key={navItem.label}>
<DrawerLink
Expand All @@ -64,6 +57,47 @@ export const Drawer = () => {
: undefined
}
/>
{navItem.childNavItems && (
<Grid
columns={1}
container
display="flex"
flex={1}
flexDirection="column"
mt={2}
pl={3}
rowGap={2}
>
{navItem.childNavItems.map((childItem) => {
if (
!isProposalDiscussionForumEnabled &&
childItem.dataTestId === "proposal-discussion-link"
) {
return null;
}

if (
!isGovernanceOutcomesPillarEnabled &&
(childItem.dataTestId === "governance-actions-voted-by-me-link" ||
childItem.dataTestId === "governance-actions-outcomes-link")
) {
return null;
}

return (
<DrawerLink
key={childItem.label}
{...childItem}
onClick={
childItem.newTabLink
? () => openInNewTab(childItem.newTabLink!)
: undefined
}
/>
);
})}
</Grid>
)}
</Grid>
);
})}
Expand Down
73 changes: 50 additions & 23 deletions govtool/frontend/src/consts/navItems.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { theme } from "@/theme";

import { ICONS } from "./icons";
import { LINKS } from "./links";
import { PATHS, PDF_PATHS } from "./paths";
import { PATHS, PDF_PATHS, OUTCOMES_PATHS, USER_PATHS } from "./paths";

export const NAV_ITEMS = [
{
Expand Down Expand Up @@ -59,6 +59,7 @@ export const CONNECTED_NAV_ITEMS = [
navTo: PATHS.dashboardDRepDirectory,
activeIcon: ICONS.dRepDirectoryActiveIcon,
icon: ICONS.dRepDirectoryIcon,
newTabLink: null,
},
{
dataTestId: "governance-actions-link",
Expand All @@ -67,28 +68,54 @@ export const CONNECTED_NAV_ITEMS = [
activeIcon: ICONS.governanceActionsActiveIcon,
icon: ICONS.governanceActionsIcon,
newTabLink: null,
},
{
dataTestId: "proposal-discussion-link",
label: i18n.t("proposalDiscussion.title"),
navTo: PDF_PATHS.proposalDiscussion,
activeIcon: (
<IconAcademicCap
width="20"
height="20"
viewBox="0 0 24 24"
fill={theme.palette.accentOrange}
/>
),
icon: (
<IconAcademicCap
width="20"
height="20"
viewBox="0 0 24 24"
fill={theme.palette.lightOrange}
/>
),
newTabLink: null,
childNavItems: [
{
dataTestId: "proposal-discussion-link",
label: i18n.t("proposalDiscussion.title"),
navTo: PDF_PATHS.proposalDiscussion,
activeIcon: (
<IconAcademicCap
width="20"
height="20"
viewBox="0 0 24 24"
fill={theme.palette.accentOrange}
/>
),
icon: (
<IconAcademicCap
width="20"
height="20"
viewBox="0 0 24 24"
fill={theme.palette.lightOrange}
/>
),
newTabLink: null,
},
{
dataTestId: "governance-actions-live-voting-link",
label: i18n.t("govActions.liveVoting.title"),
navTo: OUTCOMES_PATHS.governanceActionsLiveVoting,
activeIcon: ICONS.governanceActionsActiveIcon,
icon: ICONS.governanceActionsIcon,
newTabLink: null,
},
{
dataTestId: "governance-actions-outcomes-link",
label: i18n.t("govActions.outcomes.title"),
navTo: OUTCOMES_PATHS.governanceActionsOutcomes,
activeIcon: ICONS.governanceActionsActiveIcon,
icon: ICONS.governanceActionsIcon,
newTabLink: null,
},
{
dataTestId: "governance-actions-voted-by-me-link",
label: i18n.t("govActions.votedByMe.title"),
navTo: USER_PATHS.governanceActionsVotedByMe,
activeIcon: ICONS.governanceActionsActiveIcon,
icon: ICONS.governanceActionsIcon,
newTabLink: null,
},
],
},
{
dataTestId: "guides-link",
Expand Down
10 changes: 10 additions & 0 deletions govtool/frontend/src/consts/paths.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,13 @@ export const PDF_PATHS = {
proposalDiscussionProposal: "/proposal_discussion/:id",
proposalDiscussionPropose: "/proposal_discussion/propose",
};

export const USER_PATHS = {
governanceActionsVotedByMe: "/my/votes_and_favorites",
};

export const OUTCOMES_PATHS = {
governanceActionsOutcomes: "/outcomes",
governanceActionOutcomes: "/outcomes/governance_actions/:id",
governanceActionsLiveVoting: "/connected/governance_actions",
};
6 changes: 6 additions & 0 deletions govtool/frontend/src/context/featureFlag.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import { useAppContext } from "./appContext";
*/
type FeatureFlagContextType = {
isProposalDiscussionForumEnabled: boolean;
isGovernanceOutcomesPillarEnabled: boolean;
isVotingOnGovernanceActionEnabled: (
governanceActionType: GovernanceActionType,
) => boolean;
Expand All @@ -33,6 +34,7 @@ type FeatureFlagContextType = {

const FeatureFlagContext = createContext<FeatureFlagContextType>({
isProposalDiscussionForumEnabled: false,
isGovernanceOutcomesPillarEnabled: false,
isVotingOnGovernanceActionEnabled: () => false,
areDRepVoteTotalsDisplayed: () => false,
areSPOVoteTotalsDisplayed: () => false,
Expand Down Expand Up @@ -129,6 +131,10 @@ const FeatureFlagProvider = ({ children }: PropsWithChildren) => {
import.meta.env.VITE_IS_PROPOSAL_DISCUSSION_FORUM_ENABLED === "true" ||
import.meta.env.VITE_IS_PROPOSAL_DISCUSSION_FORUM_ENABLED === true ||
false,
isGovernanceOutcomesPillarEnabled:
import.meta.env.VITE_IS_GOVERNANCE_OUTCOMES_PILLAR_ENABLED === "true" ||
import.meta.env.VITE_IS_GOVERNANCE_OUTCOMES_PILLAR_ENABLED === true ||
false,
isVotingOnGovernanceActionEnabled,
areDRepVoteTotalsDisplayed,
areSPOVoteTotalsDisplayed,
Expand Down
12 changes: 12 additions & 0 deletions govtool/frontend/src/i18n/locales/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,18 @@
"title": "Info Action",
"label": "Info Action"
}
},
"liveVoting": {
"title": "Live Voting",
"label": "Live Voting"
},
"outcomes": {
"title": "Outcomes",
"label": "Outcomes"
},
"votedByMe": {
"title": "Voted by me",
"label": "Voted by me"
}
},
"hero": {
Expand Down
16 changes: 11 additions & 5 deletions govtool/frontend/src/pages/Dashboard.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,18 @@ export const Dashboard = () => {

const getPageTitle = (path: string) => {
if (path === PATHS.dashboard) return t("dashboard.title");
return (
Object.values(CONNECTED_NAV_ITEMS).find(({ navTo }) =>
pathname.startsWith(navTo),
)?.label ?? ""
);
return findNavItem(CONNECTED_NAV_ITEMS, path) ?? "";
};

const findNavItem = (items: NavItem[], targetPath: string): string | null => (
items.reduce<string | null>((result, item) => (
result ?? (
targetPath === item.navTo
? item.label
: (item.childNavItems ? findNavItem(item.childNavItems, targetPath) : null)
)
), null)
);

useEffect(() => {
if (divRef.current && pathname !== PATHS.dashboardGovernanceActions) {
Expand Down
Loading