refactor: `r/demo/users` #3166

leohhhn · 2024-11-20T11:26:05Z

Description

Addresses: #2827

This PR refactors the current r/demo/users & r/sys/users system in accordance to the issue mentioned above. Below is the high-level overview of the new system.

It also makes a small change to the p/demo/releases lib.

`r/gnoland/users/v1`

Fully replaces r/demo/users
Is the main entry point for users looking to register a name, create an alias (rename themselves), or delete their username
Implements allowed username pattern checks as per the issue r/sys/users Mainnet v1 (mvp) & v2 #2827
Is pausable by GovDAO, contains no other administration functionality
Contains a nice UI/render for users (please suggest improvements) - see bottom
Uses r/demo/profile for displaying extra information about a user (to be moved to r/nt/profiles or r/gnoland/profiles)

`r/sys/users`

Namespace check moved to r/sys/names
Contains the address/name <> user stores, to which only whitelisted realms can write
Contains resolver functions & other useful getters
Is callable only by whitelisted realms, such as r/gnoland/users/v1, etc.
Whitelist is fully managed by GovDAO (after chore: remove govdao dependency in r/gov/dao/bridge #3523 was resolved)

`r/sys/names`

Namespace checking functionality moved here (from r/sys/users), added tests, as discussed with @moul
Verify function now only upgradeable with a GovDAO prop instead of previously being ownable
Verify functionality is now not pausable and on by default, as per discussions with @moul. This means Portal Loop will need to be patched upon merging this PR, as many txs will fail due to not having proper namespace permissions. The namespace verify functionality is off by default, but should be enabled in genesis via r/sys/names.Enable(). The Portal Loop will indeed need to be patched if we enable this functionality.

`Keeper` & genesis params

Updated the VM keeper to call r/sys/names for the namespace check instead of r/sys/users
Updated params to load r/sys/names, which the keeper will call

`r/gnoland/users/v1`

`r/gnoland/users`

Currently this is the "releases" page for the user registration systems (example data):

Contributors' checklist...

Added new tests, or not needed, or not feasible
Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
Updated the official documentation or not needed
No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
Added references to related issues and PRs
Provided any useful hints for running manual tests

codecov · 2024-11-21T05:45:57Z

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

# Conflicts: # examples/gno.land/r/demo/users/users.gno # examples/gno.land/r/demo/users/z_10_filetest.gno # examples/gno.land/r/demo/users/z_11_filetest.gno # examples/gno.land/r/demo/users/z_11b_filetest.gno # examples/gno.land/r/demo/users/z_2_filetest.gno # examples/gno.land/r/demo/users/z_3_filetest.gno # examples/gno.land/r/demo/users/z_4_filetest.gno # examples/gno.land/r/demo/users/z_5_filetest.gno # examples/gno.land/r/demo/users/z_6_filetest.gno # examples/gno.land/r/demo/users/z_7_filetest.gno # examples/gno.land/r/demo/users/z_7b_filetest.gno # examples/gno.land/r/demo/users/z_8_filetest.gno # examples/gno.land/r/demo/users/z_9_filetest.gno # examples/gno.land/r/sys/users/verify.gno

moul · 2025-02-12T12:41:55Z

examples/gno.land/r/sys/users/users.gno

+	u := *(data.(*UserData))
+	if u.deleted {
+		return nil


Suggested change

u := *(data.(*UserData))

if u.deleted {

return nil

var u *UserData

*u = *(data.(*UserData))

if u.deleted {

return nil

should be better (please, verify in a test)

a5a84af -> not good; should be a copy; did you try my snippet above?

Fixed it: a5b8f43

examples/gno.land/r/sys/users/store.gno

moul · 2025-02-12T12:59:18Z

examples/gno.land/r/gnoland/users/v1/render.gno

+	out += md.H2("User list")
+
+	p := pager.NewPager(users.GetReadOnlyNameStore(), 20, false)
+	page := p.MustGetPageByPath(path)
+	for _, item := range page.Items {
+		if item.Value == nil {
+			continue
+		}
+
+		data := item.Value.(*users.UserData)
+
+		// Skip previous names
+		if item.Key != data.Name() {
+			continue
+		}
+
+		out += ufmt.Sprintf("- User [%s](/r/gnoland/users/v1:%s)\n", md.Bold(item.Key), item.Key)
+	}


Even though I'm glad you're using this pattern that I was proud of (thank you, @leohhhn), I believe this realm will quickly become unusable because it will contain:

aaa000

aaa001

aaa002

etc.

It makes more sense to either print statistics or eventually set up an efficient ring buffer for the last N entries (we don't have a good data structure yet, so let's create a p/ for this :p). In the meantime, just store the last created *UserData entry.

moul

I finally went over with this review; it looks good; ping me when you've addressed the last feedback 👍

moul · 2025-02-13T06:56:50Z

examples/gno.land/r/gnoland/users/v1/preregister.gno

@@ -30,7 +30,7 @@ func init() {
 	// add pre-registered users
 	for _, res := range preRegisteredUsers {
 		if err := users.RegisterUser(res.Name, res.Address); err != nil {
-			panic(err)


_ users.RegisterUser(... seems better than a if { continue }; or maybe keep the if and emit/log something.

moul · 2025-02-13T07:44:03Z

examples/gno.land/r/gnoland/users/v1/preregister.gno

@@ -3,14 +3,9 @@ package users
 import (
 	"std"

-	"gno.land/p/demo/users"
+	"gno.land/r/sys/users"


Suggested change

"gno.land/r/sys/users"

susers "gno.land/r/sys/users"

update user rendering

38c2b9a

github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label Nov 20, 2024

github-actions bot assigned leohhhn Nov 20, 2024

leohhhn and others added 2 commits November 20, 2024 21:20

save

4970a59

Merge branch 'master' into refac/users

833576b

register

2c4f497

zivkovicmilos self-requested a review November 21, 2024 06:03

leohhhn and others added 8 commits November 21, 2024 17:54

Merge branch 'master' into refac/users

6f9b787

add gnoland/users, expand sys/users

74d6ae7

add resolving

487775b

pausable to sys/users

25c3fa1

update regex & add godoc

d06515e

update regex & add godoc

905bc10

save

970b3f0

save

0ad5292

leohhhn changed the title ~~refactor: r/demo/users~~ refactor: r/demo/users Nov 21, 2024

leohhhn and others added 7 commits November 22, 2024 00:51

fix err name

3d72544

Merge branch 'master' into refac/users

2f68087

Merge branch 'master' into refac/users

114de1b

add paginated fetch

a3ed4e6

add list by prefix

b7cc608

fix imports

3e58017

add admin tests

69cfe1c

github-actions bot added 📦 🤖 gnovm Issues or PRs gnovm related 📦 🌐 tendermint v2 Issues or PRs tm2 related 📦 ⛰️ gno.land Issues or PRs gno.land package related labels Nov 25, 2024

leohhhn force-pushed the refac/users branch from e70920e to 69cfe1c Compare November 26, 2024 11:04

leohhhn added 2 commits November 26, 2024 12:05

fix

46fcc93

moul reviewed Feb 12, 2025

View reviewed changes

examples/gno.land/r/sys/users/store.gno Outdated Show resolved Hide resolved

moul reviewed Feb 12, 2025

View reviewed changes

examples/gno.land/r/sys/users/store.gno Outdated Show resolved Hide resolved

moul reviewed Feb 12, 2025

View reviewed changes

leohhhn added 8 commits February 12, 2025 14:17

add rotree test

a5a84af

rm names event

a15dd2c

rm names verified upgradeability

6778955

update tests

c6524df

rename executors

76e4e23

rm panic

94a449b

rename import

85cee3b

update event names

f50a9d6

moul requested changes Feb 12, 2025

View reviewed changes

leohhhn added 9 commits February 12, 2025 15:45

govdao executors, tests

f662b84

rm unused

ca4b2a9

rm connect

17d082d

rename package

2a692e5

users renderlink

25af5b4

add cmt

6479e4d

fix prop

45da2de

fix errs

793755c

fix cmt

e25a388

moul reviewed Feb 13, 2025

View reviewed changes

leohhhn mentioned this pull request Feb 13, 2025

added some of the blog links in the gno naming page #3743

Draft

leohhhn added 5 commits February 13, 2025 19:27

prereg

849e536

fix makesafefn

a5b8f43

add test

b8adc98

cmt

b2161b3

add test

0d6e5dc

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: `r/demo/users` #3166

refactor: `r/demo/users` #3166

leohhhn commented Nov 20, 2024 •

edited

Loading

codecov bot commented Nov 21, 2024

moul Feb 12, 2025

leohhhn Feb 12, 2025

moul Feb 13, 2025

leohhhn Feb 13, 2025

moul Feb 12, 2025

moul Feb 13, 2025

moul left a comment

moul Feb 13, 2025

leohhhn Feb 13, 2025

moul Feb 13, 2025

leohhhn Feb 13, 2025

refactor: r/demo/users #3166

Are you sure you want to change the base?

refactor: r/demo/users #3166

Conversation

leohhhn commented Nov 20, 2024 • edited Loading

Description

r/gnoland/users/v1

r/sys/users

r/sys/names

Keeper & genesis params

r/gnoland/users/v1

r/gnoland/users

codecov bot commented Nov 21, 2024

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

moul 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

refactor: `r/demo/users` #3166

refactor: `r/demo/users` #3166

leohhhn commented Nov 20, 2024 •

edited

Loading

`r/gnoland/users/v1`

`r/sys/users`

`r/sys/names`

`Keeper` & genesis params

`r/gnoland/users/v1`

`r/gnoland/users`