Internal Audit of Groups UI

[ryanchristo]

Summary

We are currently working towards an MVP for the groups UI (#29).

We should perform an internal audit of the codebase to identify issues that may need to be completed as part of the MVP (and is not already being tracked) as well as issues that we can resolve as part of future iterations.

Note: At least two engineers should perform the audit.

Checklist

• Test application meets acceptance criteria defined within Groups MVP #29
• Review code architecture and identify any improvements that could be made
• Review designs and identify any interfaces that need to be implemented or updated
• Review dependencies and dependency versions and identify any updates that should be made
• Review the codebase and identify any todos that are not yet being tracked in issues

[ryanchristo]

Hey team! Please add your planning poker estimate with Zenhub @blushi @wgwz

[blushi]

@ryanchristo probably best to make sure we have every MVP issues closed before looking it this?

[ryanchristo]

@ryanchristo probably best to make sure we have every MVP issues closed before looking it this?

Yea, makes sense. Probably ok to start if we are wrapping up one or two but other issues first sounds good to me.

[ryanchristo]

My notes from audit and testing:

• Test application meets acceptance criteria defined within Groups MVP #29
  • Anyone can create a group with the group UI
    • as long as they have a keplr wallet, with or without a ledger device
  • Every group (whether created through UI or CLI) can be viewed by a member
    • all groups are visible to everyone, only groups that the user is a member of are displayed on the home page
  • If user is admin, they can manage group & group policies
    • the admin of a group can update the group metadata, create a group policy if no policy exists (a group was created using the CLI), and add and update members of a group
    • one thing that is not possible is updating the admin of a group, and therefore switching from a user admin to a policy admin, but this is now being tracked in Add ability to update group admin #115
  • Text, Staking, Send, Group admin msgs, proposals can be made through the UI
    • group proposals with no messages, send messages, staking messages, and group admin messages can be submitted using the UI (not including the update admin message Add update group admin and update group policy admin messages to interfaces #57)
  • Every proposal type (made via UI or CLI) can be viewed, voted on, & executed
    • proposals submitted within and without the UI are viewable with messages being displayed as JSON in the event the UI does not support it, not a high-priority but noting we do have some unfinished work for displaying the new group update messages Add support for viewing proposal messages that update a group #111
    • proposals can be voted upon but a user should be able to update their vote, which is possible with the group module even though it is prevented in the UI Update vote before voting period ends #120
    • proposals can be successfully executed although it would be nice to have some better error prevention such as pre-determining if a message will fail, which was originally proposed and further discussed in Popup warning if user does not have enough funds to execute the proposal #56
• Review code architecture and identify any improvements that could be made
  • Code is well-organized. No immediate improvements necessary. The architecture is also well-suited to scale.
• Review designs and identify any interfaces that need to be implemented or updated
  • There are a lot of minor inconsistencies and some unfinished work. I requested that Erika export the designs so that we have a "final" copy to share within this repository for reference but RND is not planning to put any more design effort into the UI in the immediate future. Clean up Figma files for community #109
• Review dependencies and dependency versions and identify any updates that should be made
  • Two issues to track regarding dependencies
    1. One being @regen-network/api, which must be v1.0.0-alpha5, which includes manual fixes to generated typescript code that allows for the application to compile with amino signing working. More information about this can be found in Remove amino converter workaround #105.
    2. The second issue is a dependency mismatch issue pointed out by @wgwz below, which is between graphql-request and react-query, react-query preventing us from using the latest version Update graphql to latest version once supported in react-query #123
• Review the codebase and identify any todos that are not yet being tracked in issues
  • Opened the following issues
    • Remove proposal status and vote option enum workarounds #124
    • Fix react router error handling and set up logging  #125
    • Handle IPFS metadata outside the shape defined by the app #126
    • Show available amounts for staking messages #127
    • Fix api utils test and improve test coverage #128
  • Opened the following pull request to update todos
    • chore: clean up todos throughout repo #129

Items that should be completed before launching:

• Add support for viewing historical proposals #63

Items that would be nice to have before or soon after launching:

• Add ability to update group admin #115
• Add update group admin and update group policy admin messages to interfaces #57
• Add support for viewing historical votes #121
• Show banner when accessing site from mobile #12
• Listen for network switch and reload data #84

[blushi]

My audit: https://hackmd.io/@3CueavWvQ0WoQqDc-lJ3gg/BJOIAtkj3

[wgwz]

As part of adding a graphql client, we have a small dependency which for some reason required being pinned 1 major version behind the latest. I don't think this is a major issue but a good thing to track for the future health of the groups-ui repo.

See this comment: #112 (comment)

Basically, with the combination of react-query + graphql-request, react-query asks us to use graphql-request v5x rather than v6x.

I think a good task for that at this stage could be simply to open an issue with react-query to specify what the plans are for supporting graphql-request v6x (investigate upgrade process for graphql-request).

[ryanchristo]

Opened #123 for tracking the graphql request version issue.

[blushi]

Should we close this now or is there something remaining?

[ryanchristo]

Completed. Thanks!