Fix: Proposal status and filters for multisig #250

josemarinas · 2023-07-10T12:44:04Z

Description

The subgraph sets potentiallyExecutable = true for any multisig proposal where minApproval is 1. So the filters turn up wrong on such cases on this line https://github.com/aragon/sdk/blob/develop/modules/client/src/client-common/utils.ts#L80 (for multisig with minApproval = 1, the defeated condition will be wrong) Also for "Succeeded" in multisig, if the proposal goes past the proposal end date, it should be considered as "Defeated".

An example DAO to check this https://staging-app.aragon.org/#/daos/polygon/0x517b7b401bb0b2c9af9663d0bf7b3688b8cb4fa2/governance

Task ID: OS-561

Type of change

Bug fix (non-breaking change which fixes an issue)

Checklist:

I have selected the correct base branch.
I have performed a self-review of my own code.
I have commented my code, particularly in hard-to-understand areas.
I have made corresponding changes to the documentation.
My changes generate no new warnings.
Any dependent changes have been merged and published in downstream modules.
I ran all tests with success and extended them when possible.
I have updated the CHANGELOG.md file in the root folder of the package after the [UPCOMING] title and before the latest version.
I have tested my code on the test network.

brickpop · 2023-07-12T11:25:42Z

modules/client/src/client-common/utils.ts

+  if (
+    (proposal.potentiallyExecutable || proposal.earlyExecutable) &&
+    endDate >= now
+  ) {
    return ProposalStatus.SUCCEEDED;
  }
  if (endDate >= now) {


But now, this means that a passed proposal that was not executed will be considered as DEFEATED, which is not correct. Why would an executable proposal be displayed as defeated?

If the plugin won't allow it to be executed after expired, then we would need another state

I dont think so, if is potentially executable and the date expired it will appear as succeeded. Maybe I should give it a go with the tests ant test more edge cases but i think tthe change is ok

Well, the execution of an executable proposal that already ended would not enter any of the "if" clauses. It would keep trying until the end of the function, when it would simply return DEFEATED

modules/client/src/client-common/utils.ts

brickpop · 2023-07-17T16:07:04Z

modules/client/src/client-common/utils.ts

      break;
    case ProposalStatus.EXECUTED:
      where = { executed: true };
      break;
    case ProposalStatus.SUCCEEDED:
-      where = { potentiallyExecutable: true, endDate_lt: now };
+      where = { potentiallyExecutable: true };


What if the proposal is potentially executable but the date expired? Isn't this condition tied to any other variable? executed, executable, endDate ?

I mean the end date only shows you when you can and cant vote, there is not such thing as expired. If now is greater then endDate and potentiallyExecutable is true, congrats, your proposal passed :)

brickpop · 2023-07-17T16:08:30Z

modules/client/src/client-common/utils.ts

@@ -48,7 +48,10 @@ export function computeProposalStatus(
  if (startDate >= now) {
    return ProposalStatus.PENDING;
  }


Should there be any check for the special case of minApprovals = 1 ?

Nope, i don't think so, the thing was that minApprovals = 1 triggered the potentiallyExecutable = true

But without a check doesn't this mean that we will get succeeded by default for those proposals where minApprovals = 1 without anyone actually having voted? Perhaps we could add a check to see if there exists at least 1 vote when potentiallyExecutable = true?

sonarcloud · 2023-07-20T10:22:35Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

Fabricevladimir

Thanks, Jose. One thing I fear is that it might be quite difficult to set these statuses and generate the filters without knowing the type of proposal since the current two types are similar yet also behave slightly differently

Fabricevladimir · 2023-07-20T10:42:05Z

modules/client/src/client-common/utils.ts

@@ -48,7 +48,10 @@ export function computeProposalStatus(
  if (startDate >= now) {
    return ProposalStatus.PENDING;
  }


But without a check doesn't this mean that we will get succeeded by default for those proposals where minApprovals = 1 without anyone actually having voted? Perhaps we could add a check to see if there exists at least 1 vote when potentiallyExecutable = true?

Fabricevladimir · 2023-07-20T10:59:39Z

modules/client/src/client-common/utils.ts

@@ -77,7 +80,6 @@ export function computeProposalStatusFilter(
      break;
    case ProposalStatus.DEFEATED:


This doesn't quite work for the TokenVoting proposals. While the Multisig proposal is expired regardless of whether the approval threshold is met when the endDate has passed, this is not the case with the TokenVoting Proposal; we need to know whether it is potentiallyExecutable.

yep then we are not going to be able to fix it.

Either we wait for the split where each plugin has its own compute status function or we create a compute status filter function for the multisig

Fabricevladimir · 2023-07-20T11:03:59Z

modules/client/src/client-common/utils.ts

@@ -64,7 +67,7 @@ export function computeProposalStatusFilter(
  const now = Math.round(new Date().getTime() / 1000).toString();
  switch (status) {
    case ProposalStatus.PENDING:
-      where = { startDate_gte: now };
+      where = { startDate_gte: now, potentiallyExecutable: false, executed: false };


Hmm this means we won't get any pending Multisig proposals with minApproval = 1, since by default potentiallyExecutable is set to true for those.

True, good catch

josemarinas · 2023-07-20T11:49:42Z

Closing this one and starting a new one to split the computeProposalStatus and computeProposalStatusFilter for each plugin

josemarinas changed the title ~~Fix: Proposal status and filter for multisig~~ Fix: Proposal status and filters for multisig Jul 10, 2023

josemarinas added 2 commits July 12, 2023 11:27

add fixes for statuses

db408b3

fix tests and update changelog

dbc9905

josemarinas force-pushed the fix/OS-561-fix-statuses-and-filters branch from 470f658 to dbc9905 Compare July 12, 2023 09:29

fix tests

340534c

brickpop reviewed Jul 12, 2023

View reviewed changes

fix filters

82705e0

brickpop reviewed Jul 17, 2023

View reviewed changes

fix tests

049a362

josemarinas requested review from brickpop, Fabricevladimir and RakeshUP July 20, 2023 08:24

update status fucntion

f02486b

Fabricevladimir reviewed Jul 20, 2023

View reviewed changes

josemarinas closed this Jul 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Proposal status and filters for multisig #250

Fix: Proposal status and filters for multisig #250

josemarinas commented Jul 10, 2023 •

edited by jira bot

Loading

brickpop Jul 12, 2023

josemarinas Jul 12, 2023

brickpop Jul 12, 2023

brickpop Jul 17, 2023

josemarinas Jul 19, 2023

brickpop Jul 17, 2023

josemarinas Jul 19, 2023

Fabricevladimir Jul 20, 2023

sonarcloud bot commented Jul 20, 2023

Fabricevladimir left a comment

Fabricevladimir Jul 20, 2023

Fabricevladimir Jul 20, 2023

josemarinas Jul 20, 2023

Fabricevladimir Jul 20, 2023

josemarinas Jul 20, 2023

josemarinas commented Jul 20, 2023

		@@ -77,7 +80,6 @@ export function computeProposalStatusFilter(
		break;
		case ProposalStatus.DEFEATED:

Fix: Proposal status and filters for multisig #250

Fix: Proposal status and filters for multisig #250

Conversation

josemarinas commented Jul 10, 2023 • edited by jira bot Loading

Description

Type of change

Checklist:

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

sonarcloud bot commented Jul 20, 2023

Fabricevladimir left a 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

josemarinas commented Jul 20, 2023

josemarinas commented Jul 10, 2023 •

edited by jira bot

Loading