Adding polling comments & Removing votes from ballot #272

rafinskipg · 2021-12-09T16:24:04Z

Link to Shortcut ticket:

https://app.shortcut.com/dux-makerdao/story/44/adding-comments-to-polling
https://app.shortcut.com/dux-makerdao/story/810/allow-removing-poll-votes-from-ballot

What does this PR do?

Adds polling comments.

Creates two buttons to sign the message + post the transaction
Creates API endpoints for polling comments
Refactors comments into it's own module
Display polling comments + cross data with vote history
Adds sharing button on the comment list (disabled for now)
Allow to remove votes from ballot
Fix a bug where the total deposited on the chief was not updated
Allows to post comments on executives on other networks different than mainnet

Steps for testing:

Go to a poll:

put some comment and submit your ballot
check all the executive comments

Screenshots (if relevant):

Any additional helpful information?:

To connect to the DB locally you will need the environment variables for mongoDb, kindly ask for them

Add a GIF:

![image](https://user-images.githubusercontent.com/1152768/145597696-65365a85-42d0-45ae-89ee-fc3228a0083d.png)

shortcut-integration · 2021-12-09T16:24:07Z

This pull request has been linked to Shortcut Story #44: Adding comments to Polling.

vercel · 2021-12-09T16:24:09Z

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/dux-core-unit/governance-portal-v2/H61upSaR3AAVzUxYF63MQ8e6XWRX
✅ Preview: https://governance-portal-v2-git-feature-sc-44addi-dc100e-dux-core-unit.vercel.app

codecov · 2021-12-10T15:23:18Z

Codecov Report

Merging #272 (84857b7) into develop (fba92b9) will decrease coverage by 0.36%.
The diff coverage is 1.47%.

@@             Coverage Diff             @@
##           develop     #272      +/-   ##
===========================================
- Coverage    32.89%   32.52%   -0.37%     
===========================================
  Files           59       61       +2     
  Lines         1523     1534      +11     
  Branches       510      510              
===========================================
- Hits           501      499       -2     
- Misses        1015     1028      +13     
  Partials         7        7

Impacted Files	Coverage Δ
lib/maker/index.ts	`30.64% <0.00%> (ø)`
pages/api/address/[address]/index.ts	`0.00% <0.00%> (ø)`
pages/api/address/[address]/stats.ts	`0.00% <ø> (ø)`
pages/api/comments/executive/[address].ts	`0.00% <0.00%> (ø)`
pages/api/comments/executive/add/[address].ts	`0.00% <0.00%> (ø)`
pages/api/comments/polling/[poll-id].ts	`0.00% <0.00%> (ø)`
pages/api/comments/polling/add.ts	`0.00% <0.00%> (ø)`
pages/api/polling/[slug].ts	`0.00% <ø> (ø)`
pages/api/polling/all-polls.ts	`0.00% <ø> (ø)`
pages/api/polling/tally/[poll-id].ts	`0.00% <ø> (ø)`
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fba92b9...84857b7. Read the comment docs.

…omments API call, include correct address balance , fix executive contract deposit refresh UI

…to feature/sc-44/adding-comments-to-polling

rafinskipg · 2021-12-14T18:16:05Z

modules/address/api/getAddressInfo.ts

@@ -0,0 +1,48 @@
+import { SupportedNetworks } from 'lib/constants';


refactored this from the api and moved here

rafinskipg · 2021-12-14T18:20:43Z

modules/delegates/components/DelegateAvatarName.tsx

@@ -0,0 +1,47 @@
+import { Delegate } from '../types';


Refactored the delegate avatar + name into a component for reusing between comments and delegate cards

rafinskipg · 2021-12-14T18:21:06Z

modules/executive/components/VoteModal/DefaultView.tsx

@@ -0,0 +1,350 @@
+import { useBreakpointIndex } from '@theme-ui/match-media';


extracted from the gigantic vote modal + added some logic for signing the message

rafinskipg · 2021-12-14T18:21:34Z

modules/executive/components/VoteModal/index.tsx

@@ -0,0 +1,100 @@
+import { useState } from 'react';


Moved from the previous voteModal file, most of the logic is the same, i removed one useMemo and just rendered normally

rafinskipg · 2021-12-14T18:21:54Z

modules/executive/components/VoteModal/DefaultView.tsx

+  const { mutate: mutateComments } = useExecutiveComments(proposal.address);
+
+  const [comment, setComment] = useState('');
+  const [signedMessage, setSignedMessage] = useState('');


this is new

rafinskipg · 2021-12-14T18:22:19Z

modules/executive/components/VoteModal/DefaultView.tsx

+  }, []);
+
+  const [hatChecked, setHatChecked] = useState(true);
+  const { data: currentSlate, mutate: mutateVotedProposals } = useVotedProposals();


brought the currentSlate from the hook instead of nesting it 3 levels from the previous parent props

rafinskipg · 2021-12-14T18:22:57Z

modules/mkr/components/Withdraw.tsx

@@ -115,6 +115,8 @@ const ModalContent = ({ address, voteProxy, close, ...props }) => {

            const txId = await track(freeTxCreator, 'Withdrawing MKR', {
              mined: txId => {
+                // Mutate locked amount
+                mutateLocked();


This is to mutate and refresh the total locked MKR in the contract, was not working before

rafinskipg · 2021-12-14T18:23:28Z

modules/polling/components/ChoiceSummary.tsx

+          <Button
+            onClick={() => {
+              removeFromBallot(poll.pollId);
+            }}


New remove from ballot functionality

rafinskipg · 2021-12-14T18:24:23Z

modules/polling/components/PollOverviewCard.tsx

@@ -156,6 +165,8 @@ export default function PollOverviewCard({ poll, reviewPage, showVoting, ...prop
            )}
          </Flex>
        </Box>
+
+        {children && <Box>{children}</Box>}
      </Box>


Children used to add the comment form

rafinskipg · 2021-12-14T18:24:47Z

modules/polling/components/SubmitBallotButtons.tsx

@@ -0,0 +1,59 @@
+import useBallotStore from '../stores/ballotStore';


These buttons sign and submit the ballot if there are multiple comments

adamgoth · 2021-12-15T09:23:58Z

lib/maker/index.ts

@@ -130,7 +130,7 @@ function isTestnet(): boolean {
  return getNetwork() === SupportedNetworks.TESTNET || !!config.TESTNET;
 }

-async function personalSign(message) {
+async function personalSign(message: string): Promise<any> {


Safety first 👷‍♂️

modules/address/components/AddressDetail.tsx

modules/comments/api/getExecutiveComments.ts

adamgoth

Looks good! Left some minor comments.

I was able to confirm two possible bugs.

Updating my poll vote with a new comment doesn't reflect the latest comment. It showed the previous one.
The comment is getting saved to the DB before the transaction is mined. I cancelled the tx before it was mined but the comment still got saved.

modules/polling/stores/ballotStore.ts

adamgoth · 2021-12-15T09:59:55Z

modules/polling/stores/ballotStore.ts

+              body: JSON.stringify(commentsRequest)
+            })
+              .then(() => {
+                console.log('comment successfully added');


I don't think this log is necessary for production

pages/polling/review.tsx

…to feature/sc-44/adding-comments-to-polling

…mment per address. Show polling comment option

Adding polling comments

adbfca4

rafinskipg added the WIP label Dec 9, 2021

rafinskipg mentioned this pull request Dec 10, 2021

Release v0.2.6 - Mrs. Featherby Ringed Teal - (Callonetta leucophrys) #273

Merged

Multistep sign comments

84b9f4f

vercel bot deployed to Preview December 10, 2021 15:13 View deployment

rafinskipg added 2 commits December 13, 2021 13:11

Working on removing ballot

36ca7cb

merged with develop

b0829a4

rafinskipg changed the title ~~Adding polling comments~~ Adding polling comments & Removing votes from ballot Dec 13, 2021

Prettier

ae07ae8

vercel bot had a problem deploying to Preview December 13, 2021 13:14 Failure

Link to the commenter page

90b6676

vercel bot deployed to Preview December 13, 2021 15:31 View deployment

Refactor comments into it's own module, bring address data from the c…

f8a1d71

…omments API call, include correct address balance , fix executive contract deposit refresh UI

vercel bot had a problem deploying to Preview December 14, 2021 15:26 Failure

rafinskipg added 2 commits December 14, 2021 16:46

fix build

06f16b5

Merge branch 'develop' of github.com:makerdao/governance-portal-v2 in…

e81ff7c

…to feature/sc-44/adding-comments-to-polling

vercel bot deployed to Preview December 14, 2021 15:47 View deployment

Refactor vote modal

b243b2c

vercel bot deployed to Preview December 14, 2021 17:05 View deployment

Default view fixes

24c5109

vercel bot deployed to Preview December 14, 2021 17:31 View deployment

rafinskipg added 2 commits December 14, 2021 19:03

small fixes

61b4d03

prettier

288a4e3

vercel bot deployed to Preview December 14, 2021 18:04 View deployment

fix tests

824f7e2

vercel bot deployed to Preview December 14, 2021 18:12 View deployment

rafinskipg commented Dec 14, 2021

View reviewed changes

rafinskipg marked this pull request as ready for review December 14, 2021 18:25

rafinskipg requested review from adamgoth and tyler17 December 14, 2021 18:25

adamgoth reviewed Dec 15, 2021

View reviewed changes

rafinskipg added 3 commits December 15, 2021 11:40

Merge branch 'develop' of github.com:makerdao/governance-portal-v2 in…

0fd6812

…to feature/sc-44/adding-comments-to-polling

Document poll tally api

81f7e4c

updated swaggers

39c4feb

vercel bot deployed to Preview December 15, 2021 11:48 View deployment

Add transaction hash to comment

dad9d75

vercel bot deployed to Preview December 15, 2021 12:03 View deployment

prettier

98f59fb

vercel bot deployed to Preview December 15, 2021 12:10 View deployment

rafinskipg added 3 commits December 15, 2021 16:20

Reuse same comment box with limit at 250 characters and limit to 1 co…

274db2a

…mment per address. Show polling comment option

comment count on executives

2c54d92

comments on polls

82a1fba

vercel bot had a problem deploying to Preview December 15, 2021 16:01 Failure

fix build

84857b7

vercel bot deployed to Preview December 15, 2021 16:15 View deployment

rafinskipg merged commit c5e911a into develop Dec 15, 2021

rafinskipg deleted the feature/sc-44/adding-comments-to-polling branch December 15, 2021 16:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding polling comments & Removing votes from ballot #272

Adding polling comments & Removing votes from ballot #272

rafinskipg commented Dec 9, 2021 •

edited

Loading

shortcut-integration bot commented Dec 9, 2021

vercel bot commented Dec 9, 2021 •

edited

Loading

codecov bot commented Dec 10, 2021 •

edited

Loading

rafinskipg Dec 14, 2021

rafinskipg Dec 14, 2021

rafinskipg Dec 14, 2021

rafinskipg Dec 14, 2021

rafinskipg Dec 14, 2021

rafinskipg Dec 14, 2021

rafinskipg Dec 14, 2021

rafinskipg Dec 14, 2021

rafinskipg Dec 14, 2021

rafinskipg Dec 14, 2021

adamgoth Dec 15, 2021

adamgoth left a comment

adamgoth Dec 15, 2021

		@@ -0,0 +1,48 @@
		import { SupportedNetworks } from 'lib/constants';

		@@ -0,0 +1,350 @@
		import { useBreakpointIndex } from '@theme-ui/match-media';

		@@ -0,0 +1,59 @@
		import useBallotStore from '../stores/ballotStore';

Adding polling comments & Removing votes from ballot #272

Adding polling comments & Removing votes from ballot #272

Conversation

rafinskipg commented Dec 9, 2021 • edited Loading

Link to Shortcut ticket:

What does this PR do?

Steps for testing:

Screenshots (if relevant):

Any additional helpful information?:

Add a GIF:

shortcut-integration bot commented Dec 9, 2021

vercel bot commented Dec 9, 2021 • edited Loading

codecov bot commented Dec 10, 2021 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamgoth left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rafinskipg commented Dec 9, 2021 •

edited

Loading

vercel bot commented Dec 9, 2021 •

edited

Loading

codecov bot commented Dec 10, 2021 •

edited

Loading