[DDW-796] Implement catalyst state snapshot phase #2771

lucas-barros · 2021-12-03T13:14:56Z

This PR adds the catalyst fund snapshot, voting and tallying phase and the logic to change the text based on the fund phase.

This includes tasks:
DDW-796
DDW-801
DDW-802
DDW-845

To force switch between phases during tests:
window.daedalus.stores.voting._checkFundPhase(new Date('Feb 28, 2022, 11:00 UTC'))
*change the date accordingly

Phases

Snapshot: Jan 6, 2022, 11:00 UTC
Voting: Jan 13, 2022, 11:00 UTC - Jan 27, 2022, 11:00 UTC
Tallying: Jan 27, 2022, 11:01 UTC - Feb 2, 2022
Results: Feb 3, 2022

Todos

Todo

Screenshots

Screenshot

Snapshot

Voting

Tallying

Results

Testing Checklist

Slack QA thread
Test

Test Scenarios

Scenario 1 - Validate voting screen on ETI phase

Given that Daedalus is synced
And it has at least one Shelley wallet
And the registration to vote in fund N is open
When I validate the voting screen
Then I can see I can register to vote for fund N
And the date of the snapshot for fund N is displayed
And the ending date and link to results for fund N-1 are displayed

Scenario 2 - Validate voting screen on Snapshot phase

Given that Daedalus is synced
And it has at least one Shelley wallet
And the user no longer can register to vote for Fund N
And the voting date for fund N hasn't arrived yet
When I validate the voting screen
Then I can see I can register to vote for fund N+1
And the date of the snapshot and the voting date for fund N are displayed

Scenario 3 - Validate voting screen on Voting phase

Given that Daedalus is synced
And it has at least one Shelley wallet
And the voting is enabled for fund N
When I validate the voting screen
Then I can see I can register to vote for fund N+1
And the starting and ending dates for the voting on fund N are displayed
And there is a call to action to vote on fund N

Scenario 4 - Validate voting screen on Tallying phase

Given that Daedalus is synced
And it has at least one Shelley wallet
And the voting has closed for fund N
When I validate the voting screen
Then I can see I can register to vote for fund N+1
And the ending date for the voting on fund N is displayed
And a message indicated the tallying is in progress
And the date when the results will be available is displayed

Review Checklist

Basics

Code Quality

Important parts of the code are properly commented and documented
Code is properly typed with flow
React components are split-up enough to avoid unnecessary re-renderings
Any code that only works in main process is neatly separated from components

Testing

New feature/change is covered by acceptance tests
New feature/change is manually tested and approved by QA team
All existing acceptance tests are still up-to-date
New feature/change is covered by Daedalus Testing scenario
All existing Daedalus Testing scenarios are still up-to-date

After Review

Merge the PR
Delete the source branch
Move the ticket to done column on the YouTrack board
Update Slack QA thread by marking it with a green checkmark

lucas-barros · 2021-12-03T13:20:01Z

.gitignore

@@ -86,6 +86,10 @@ mainnet-genesis-dryrun-with-stakeholders.json

 # nix-build results
 result*
+!result*.js


result* was ignoring any files that start with result (ResultsPhase.js).
The following file globs are excluding js/ts files

lucas-barros · 2021-12-03T13:22:02Z

source/renderer/app/components/voting/VotingUnavailable.js

@@ -1,132 +1,30 @@
 // @flow


Since the voting registration is always open now, the voting closed logic was removed.

lucas-barros · 2021-12-06T14:13:42Z

source/renderer/app/config/votingConfig.js

-export const VOTING_REGISTRATION_NEW_START_DATE = new Date(
-  'Nov 11, 2021, 11:00 UTC'
-);
+export const VOTING_PHASE_CHECK_INTERVAL = 60000; // 60 seconds | unit: milliseconds


Increased the check interval to 60 seconds to be able to force different phases for tests. We can change back to 3 seconds after QA review.

3 seconds? I would even do this every 10 mins?

It used to be 3 seconds for voting registration end check. I increased so QA would have a longer interval to test, but I agree 3 seconds is too short of interval for this

lucas-barros · 2021-12-06T14:16:04Z

source/renderer/app/stores/VotingStore.js

+      [FundPhases.RESULTS]: (date: Date) => date >= VOTING_RESULTS_DATE,
+    };
+    this.fundPhase =
+      Object.keys(FundPhases)


I had to use this:
Object.keys(FundPhases).map((phase) => FundPhases[phase])
Instead of:
Object.values(FundPhases)
Due to flow not inferring the type correctly

facebook/flow#2221

I had solved it with a switch case maybe, but your solution is also OK.

dkijania · 2021-12-06T14:37:58Z

Hey, I wonder what is the reasoning behind hard-coding below dates instead of read them from catalyst backend:

export const VOTING_SNAPSHOT_DATE = new Date('Jan 6, 2022, 11:00 UTC');
export const VOTING_CAST_START_DATE = new Date('Jan 13, 2022, 11:00 UTC');
export const VOTING_CAST_END_DATE = new Date('Jan 27, 2022, 11:00 UTC');
export const VOTING_NEW_SNAPSHOT_DATE = new Date('Apr 7, 2022, 11:00 UTC');

I think all above dates can be easily retrieved from Catalyst servicing station. The only problem I see is with VOTING_RESULTS_DATE.

lucas-barros · 2021-12-06T16:09:42Z

Hey, I wonder what is the reasoning behind hard-coding below dates instead of read them from catalyst backend:
export const VOTING_SNAPSHOT_DATE = new Date('Jan 6, 2022, 11:00 UTC');
export const VOTING_CAST_START_DATE = new Date('Jan 13, 2022, 11:00 UTC');
export const VOTING_CAST_END_DATE = new Date('Jan 27, 2022, 11:00 UTC');
export const VOTING_NEW_SNAPSHOT_DATE = new Date('Apr 7, 2022, 11:00 UTC');
I think all above dates can be easily retrieved from Catalyst servicing station. The only problem I see is with VOTING_RESULTS_DATE.

Hi @dkijania, I'm not aware of catalyst backend. Could you point me to some documentation?

alexander-rukin

visually looks good

source/renderer/app/components/voting/VotingUnavailable.js

source/renderer/app/components/voting/voting-info/VotingInfo.scss

renanvalentin · 2021-12-06T18:40:08Z

@lucas-barros great work! I added a few suggestions in case you find them useful. It would also be interesting to add a few ui or unit tests in case you have time.

lucas-barros · 2021-12-06T18:46:15Z

@lucas-barros great work! I added a few suggestions in case you find them useful. It would also be interesting to add a few ui or unit tests in case you have time.

@renanvalentin I will, thanks!

ManusMcCole

Looks good to me. Good work @lucas-barros 👍

miorsufianiohk

LGTM. Great work @lucas-barros 👍

This reverts commit 3140b65.

This reverts commit 454c7e1.

danielmain

Clean and elegant implemented, nothing to complain. Great job!

lucas-barros added ⏳release-vNext feature WIP labels Dec 3, 2021

lucas-barros commented Dec 3, 2021

View reviewed changes

lucas-barros force-pushed the feature/ddw-796-Implement-catalyst-state-snapshot-phase branch from 7b894a8 to ad76db3 Compare December 3, 2021 19:32

lucas-barros commented Dec 6, 2021

View reviewed changes

lucas-barros removed the WIP label Dec 6, 2021

lucas-barros requested review from a team and alexander-rukin December 6, 2021 14:19

alexander-rukin approved these changes Dec 6, 2021

View reviewed changes

renanvalentin reviewed Dec 6, 2021

View reviewed changes

source/renderer/app/components/voting/VotingUnavailable.js Outdated Show resolved Hide resolved

source/renderer/app/components/voting/voting-info/VotingInfo.scss Outdated Show resolved Hide resolved

ManusMcCole approved these changes Dec 7, 2021

View reviewed changes

miorsufianiohk assigned miorsufianiohk and unassigned miorsufianiohk Dec 7, 2021

miorsufianiohk self-requested a review December 7, 2021 14:59

miorsufianiohk approved these changes Dec 8, 2021

View reviewed changes

Lucas Araujo added 6 commits December 8, 2021 11:42

[DDW-796] Refactor and voting phases

145c774

[DDW-796] Remove closed voting logic

d770712

[DDW-796] Exclude js/ts files from nix-build glob

cd26d6a

[DDW-796] Fund phase logic

0376de6

[DDW-796] Fund phase components

6d12ff3

[DDW-796] Fix lint issues

8883376

Lucas Araujo and others added 16 commits December 8, 2021 11:42

[DDW-796] Fix flow issues

c39e24f

[DDW-796] Style fix

1a72281

[DDW-796] Add observer

1432543

[DDW-796] Remove unused

dc9e1c7

[DDW-796] Lazy validation

81192f5

[DDW-796] Update text

bcaf138

[DDW-858] Fix eslint warnings

b065f49

[DDW-796] Add jp translations

b30e1fc

[DDW-796] Enable voting in all env for testing only

454c7e1

[DDW-796] Add function for external link

754d5e4

[DDW-796] Review changes

919aa78

[DDW-796] VotingStore unit test

3d6948f

[DDW-796] Update story

a9bf930

[DDW-796] Test only

b9e4c8c

Revert "[DDW-796] Test only"

ad1734a

This reverts commit 3140b65.

Revert "[DDW-796] Enable voting in all env for testing only"

8303429

This reverts commit 454c7e1.

lucas-barros force-pushed the feature/ddw-796-Implement-catalyst-state-snapshot-phase branch from 3140b65 to 8303429 Compare December 8, 2021 14:49

renanvalentin approved these changes Dec 8, 2021

View reviewed changes

danielmain approved these changes Dec 8, 2021

View reviewed changes

danielmain merged commit f7c80d3 into develop Dec 8, 2021

iohk-bors bot deleted the feature/ddw-796-Implement-catalyst-state-snapshot-phase branch December 8, 2021 17:27

nikolaglumac mentioned this pull request Dec 14, 2021

Merge release/4.6.0 into master #2785

Merged

danielmain assigned danielmain and lucas-barros and unassigned danielmain Dec 14, 2021

danielmain added release-4.6.0 Daedalus Mainnet and removed ⏳release-vNext labels Dec 14, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DDW-796] Implement catalyst state snapshot phase #2771

[DDW-796] Implement catalyst state snapshot phase #2771

lucas-barros commented Dec 3, 2021 •

edited by gabriela-ponce

Loading

lucas-barros Dec 3, 2021 •

edited

Loading

lucas-barros Dec 3, 2021

lucas-barros Dec 6, 2021

danielmain Dec 8, 2021

lucas-barros Dec 8, 2021

lucas-barros Dec 6, 2021 •

edited

Loading

danielmain Dec 8, 2021

dkijania commented Dec 6, 2021 •

edited

Loading

lucas-barros commented Dec 6, 2021

alexander-rukin left a comment

renanvalentin commented Dec 6, 2021

lucas-barros commented Dec 6, 2021

ManusMcCole left a comment

miorsufianiohk left a comment

danielmain left a comment

[DDW-796] Implement catalyst state snapshot phase #2771

[DDW-796] Implement catalyst state snapshot phase #2771

Conversation

lucas-barros commented Dec 3, 2021 • edited by gabriela-ponce Loading

Todos

Screenshots

Testing Checklist

Test Scenarios

Review Checklist

Basics

Code Quality

Testing

After Review

lucas-barros Dec 3, 2021 • edited Loading

Choose a reason for hiding this comment

lucas-barros Dec 3, 2021

Choose a reason for hiding this comment

lucas-barros Dec 6, 2021

Choose a reason for hiding this comment

danielmain Dec 8, 2021

Choose a reason for hiding this comment

lucas-barros Dec 8, 2021

Choose a reason for hiding this comment

lucas-barros Dec 6, 2021 • edited Loading

Choose a reason for hiding this comment

danielmain Dec 8, 2021

Choose a reason for hiding this comment

dkijania commented Dec 6, 2021 • edited Loading

lucas-barros commented Dec 6, 2021

alexander-rukin left a comment

Choose a reason for hiding this comment

renanvalentin commented Dec 6, 2021

lucas-barros commented Dec 6, 2021

ManusMcCole left a comment

Choose a reason for hiding this comment

miorsufianiohk left a comment

Choose a reason for hiding this comment

danielmain left a comment

Choose a reason for hiding this comment

lucas-barros commented Dec 3, 2021 •

edited by gabriela-ponce

Loading

lucas-barros Dec 3, 2021 •

edited

Loading

lucas-barros Dec 6, 2021 •

edited

Loading

dkijania commented Dec 6, 2021 •

edited

Loading