feat: add p/avl/pager #2584

moul · 2024-07-14T11:43:50Z

add p/demo/avl/pager
update r/demo/users

Hey reviewers, in addition to what you wanted to review, I'm specifically curious if you have any better API/usage ideas.

Example: https://github.com/gnolang/gno/pull/2584/files#diff-8d5cbbe072737a7f288f74adcaaace11cacc3d31264e6a001515fcae824394e2R33

Related with #447, #599, #868

Signed-off-by: moul <94029+moul@users.noreply.github.com>

codecov · 2024-09-24T19:13:24Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.99%. Comparing base (538ebff) to head (fbc75c8).
Report is 6 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2584      +/-   ##
==========================================
- Coverage   63.33%   62.99%   -0.35%     
==========================================
  Files         548      548              
  Lines       78646    81238    +2592     
==========================================
+ Hits        49809    51173    +1364     
- Misses      25476    26627    +1151     
- Partials     3361     3438      +77

Flag	Coverage Δ
contribs/gnodev	`61.11% <ø> (ø)`
contribs/gnofaucet	`14.82% <ø> (ø)`
gno.land	`67.18% <ø> (ø)`
gnovm	`67.88% <ø> (ø)`
misc/genstd	`79.72% <ø> (ø)`
tm2	`62.39% <ø> (-0.03%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: moul <94029+moul@users.noreply.github.com>

jefft0 · 2024-10-01T10:06:10Z

I tried the pagination with the following:

git clone https://github.com/moul/gno --branch dev/moul/pagination
cd gno
make install

Edit examples/gno.land/r/demo/users/users.gno. On line 331 in NewPager(&name2User, 50), change 50 to 5.

gnodev

In a browser, go to http://127.0.0.1:8888/r/demo/users . It shows:

    archives
    demo
    gno
    gnoland
    gnolang 1 | 2

When I click "2", it doesn't change.

jefft0 · 2024-10-01T10:31:11Z

examples/gno.land/r/demo/users/users.gno

 	return doc
 }
+
+func splitPathAndQuery(fullPath string) (string, string) {
+	parts := strings.SplitN(fullPath, "?", 2)


When I click on page "2", the URL becomes "http://127.0.0.1:8888/r/demo/users?page=2". But I don't think that the query string with the "?" is passed to Render.

Right, they are not being passed:
https://gno.land/r/g1hy6zry03hg5d8le9s2w4fxme6236hkgd928dun/echorender:foo/bar?baz=bar

Created #2876 in case is helpful

examples/gno.land/p/demo/avl/pager/pager.gno

ajnavarro · 2024-10-03T16:31:29Z

examples/gno.land/p/demo/avl/pager/pager.gno

+	items := []Item{}
+	p.Tree.ReverseIterateByOffset(startIndex, endIndex-startIndex, func(key string, value interface{}) bool {
+		items = append(items, Item{Key: key, Value: value})
+		return false


offtopic: a bit misleading. Normally, if you want to continue, you return true, but it is what it is. Example from standard library: https://pkg.go.dev/sync#Map.Range

ajnavarro · 2024-10-03T16:32:24Z

examples/gno.land/p/demo/avl/pager/pager.gno

+	return &Page{
+		Items:      items,
+		PageNumber: pageNumber,
+		PageSize:   pageSize,
+		TotalItems: totalItems,
+		TotalPages: totalPages,
+		HasPrev:    pageNumber > 1,
+		HasNext:    pageNumber < totalPages,
+		Pager:      p,
+	}


here, you can add items to previously created page instance.

done 79ffd7d

Co-authored-by: Antonio Navarro Perez <antnavper@gmail.com>

Signed-off-by: moul <94029+moul@users.noreply.github.com>

ltzmaxwell · 2024-10-05T17:06:52Z

examples/gno.land/p/demo/avl/pager/pager.gno

+	pageNumber := 1
+	pageSize := p.DefaultPageSize
+
+	if p.PageQueryParam != "" {


nit: given the current situation, this parameter will not be empty, so the check can be omitted.

It can be made empty. The question is whether we let the if condition so that the subsequent line doesn't produce something strange, or if we switch to a panic because it's nonsensical to use a pager without a way to change the query string.

ltzmaxwell · 2024-10-05T17:07:06Z

examples/gno.land/p/demo/avl/pager/pager.gno

+	return pageNumber, pageSize, nil
+}
+
+func min(a, b int) int {


seems not used in any place

3754a70 (#2584)

Signed-off-by: moul <94029+moul@users.noreply.github.com>

leohhhn

Didn't try all of the functionality; just the stuff I needed for HOF.

It seems that the pagination is not working as @jefft0 & @jeronimoalbi noticed Could we fix this?

Other than that, I found it a bit difficult to get around with the API until I saw an actual usage example (r/demo/users).

Another consideration is that we could maybe create a ReversePager, similar to how you have Iterate & ReverseIterate for the AVL. Or maybe it could be a flag for NewPager()

leohhhn · 2024-10-08T11:08:33Z

examples/gno.land/p/demo/avl/pager/pager.gno

+}
+
+// UI generates the Markdown UI for the page selector.
+func (p *Page) Selector() string {


Suggested change

func (p *Page) Selector() string {

func (p *Page) Picker() string {

I think this is a more intuitive name

Oh yes, Picker sounds better. @alexiscolin, do you have an opinion on the name of this part, "1 2 3 4 5"?

leohhhn · 2024-10-08T13:05:23Z

examples/gno.land/r/demo/users/users.gno

+func renderHome(path string) string {
 	doc := ""
-	name2User.Iterate("", "", func(key string, value interface{}) bool {
-		user := value.(*users.User)
+
+	page := pager.NewPager(&name2User, 50).MustGetPageByPath(path)
+
+	for _, item := range page.Items {
+		user := item.Value.(*users.User)
 		doc += " * [" + user.Name + "](/r/demo/users:" + user.Name + ")\n"
-		return false
-	})
+	}
+
+	doc += page.Selector()
 	return doc
 }


This doesn't work actually; if you try to make a pager with page size, say, 4, to check to pagination funcntionality, you get this;

but then clicking on 2, or 3 doesn't take you anywhere, just changes the link, as @jefft0 said. A click on 3 takes you here: /r/demo/users?page=3

So, this won't be fixed until we figure out what to do with the links here #2876

Yes, to have a working example, we depend on the other PR.

One option is to merge without using it everywhere, which means some contracts won't function fully for now. This is probably acceptable since we expect the other PR to be merged. We might consider disabling it on r/demo/users if people find the top-level listing too important on gnodev and portal loop (I don't share this opinion).

Alternatively, we need to ensure that someone works on #2876. This could be a core team member if the current contributor doesn't have time to finish.

examples/gno.land/r/demo/users/users.gno

Co-authored-by: Leon Hudak <33522493+leohhhn@users.noreply.github.com>

moul · 2024-10-08T14:18:02Z

Other than that, I found it a bit difficult to get around with the API until I saw an actual usage example (r/demo/users).

Thank you, @leohhhn, for your feedback. Do you have any suggestions on how to improve this part?

leohhhn · 2024-10-08T17:31:46Z

examples/gno.land/p/demo/avl/pager/pager.gno

+	// page number provided is outside the range of total pages
+	if pageNumber > totalPages {
+		page.PageNumber = pageNumber
+		page.HasPrev = pageNumber > 0


Suggested change

page.HasPrev = pageNumber > 0

page.HasPrev = true

pageNumber > 0 will always be true in this if, because totalPages cannot be less than 0

right, but actually i'm considering if in this case it should maybe be totalPages > 0.

### Description This PR introduces a change for _gnoweb_ to also pass the URL query string as part of the render path. Passing the URL query string is required to support arguments when rendering realms, which is the case of the AVL pager implementation in #2584 that uses "page" and "size". The PR changes the behavior of realm rendering calls by adding URL query arguments as suffix of the `path` argument, so URLs like `https://gno.land/r/demo/foo:bar?baz=42` would call `Render(path)` with "bar?baz=42" as value of `path`. It also changes how special _gnoweb_ arguments like `help` of `func` are specified which now must be done by using the `$` character, for example: - `https://gno.land/r/demo/foo$help&func=Bar&name=Baz` - `https://gno.land/r/demo/foo:example$tz=Europe/Paris` - `https://gno.land/r/demo/foo:example?value=42$tz=Europe/Paris` Note that `__func` is now `func`, without the underscore prefix. ### Possible Issues The change could potentially affect realm or package implementations that rely on the render path in cases where the `?` is not expected, for example when parsing or splitting it. Because of that there might be changes required to handle the case where a caller sends query string arguments. Realms and packages should be able to handle render paths which could look like `render/path?arg=1&arg=N`. Links that still use `?`, `help` and `__func` won't work as expected, they must be changed to use `$` instead of `?`, and `func` instead of `__func`. Packages `gno.land/p/moul/txlink` and `gno.land/p/moul/helplink` has to be refactored to properly generate links. --------- Co-authored-by: Leon Hudak <33522493+leohhhn@users.noreply.github.com> Co-authored-by: leohhhn <hudakleon@gmail.com> Co-authored-by: Manfred Touron <94029+moul@users.noreply.github.com>

leohhhn · 2024-11-06T12:56:50Z

@moul

Can you check the tests & formatting and we can merge this?

Signed-off-by: moul <94029+moul@users.noreply.github.com>

moul · 2024-11-06T18:32:31Z

should be good

## Description Depends on #2584 for `avlpager` Introduces the `r/demo/hof` realm. The Hall of Fame is an exhibition that holds items. Users can add their realms to the Hall of Fame by importing the Hall of Fame realm and calling `hof.Register()` from their `init` function. The realm is moderated and the registrations be paused at will. ![Screenshot 2024-10-07 at 20 09 43](https://github.com/user-attachments/assets/9beeefc6-d22a-4e81-aa2d-e336d0e6edf8) <details><summary>Contributors' checklist...</summary> - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [x] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [x] Added references to related issues and PRs - [x] Provided any useful hints for running manual tests - [x] Added new benchmarks to [generated graphs](https://gnoland.github.io/benchmarks), if any. More info [here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md). </details> --------- Signed-off-by: moul <94029+moul@users.noreply.github.com> Co-authored-by: moul <94029+moul@users.noreply.github.com> Co-authored-by: Antonio Navarro Perez <antnavper@gmail.com>

moul added 10 commits July 14, 2024 07:59

feat: add p/avl/pager

ac0d79e

Signed-off-by: moul <94029+moul@users.noreply.github.com>

chore: fixup

a17edb2

Signed-off-by: moul <94029+moul@users.noreply.github.com>

chore: fixup

1a44f35

Signed-off-by: moul <94029+moul@users.noreply.github.com>

chore: fixup

291b92f

Signed-off-by: moul <94029+moul@users.noreply.github.com>

chore: fixup

6038562

Signed-off-by: moul <94029+moul@users.noreply.github.com>

chore: fixup

23db6aa

Signed-off-by: moul <94029+moul@users.noreply.github.com>

chore: fixup

fa7286b

Signed-off-by: moul <94029+moul@users.noreply.github.com>

chore: fixup

c0d435d

Signed-off-by: moul <94029+moul@users.noreply.github.com>

chore: fixup

1cff9f1

Signed-off-by: moul <94029+moul@users.noreply.github.com>

Merge remote-tracking branch 'origin/master' into dev/moul/pagination

04d62c7

moul self-assigned this Jul 14, 2024

moul changed the title ~~dev/moul/pagination~~ feat: add p/avl/pager Jul 14, 2024

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

moul marked this pull request as ready for review July 14, 2024 11:44

moul requested review from a team and jaekwon as code owners July 14, 2024 11:44

moul requested review from ajnavarro and removed request for a team July 14, 2024 11:44

chore: fixup

b2294ac

Signed-off-by: moul <94029+moul@users.noreply.github.com>

moul mentioned this pull request Jul 14, 2024

feat: r/gov/dao v2 #2581

Merged

7 tasks

chore: fixup

2a1093e

Signed-off-by: moul <94029+moul@users.noreply.github.com>

moul mentioned this pull request Jul 14, 2024

integrate p/demo/avl/pager with existing examples #2586

Open

moul added 2 commits July 14, 2024 15:21

Update pager_test.gno

903fb48

chore: fixup

f1adda0

Signed-off-by: moul <94029+moul@users.noreply.github.com>

moul marked this pull request as draft July 14, 2024 20:52

Kouteki mentioned this pull request Jul 22, 2024

Minutes: Core Staff Weekly Syncs [every Monday] gnolang/meetings#36

Open

Merge branch 'master' into dev/moul/pagination

7d44835

chore: fixup

c8e4e1f

Signed-off-by: moul <94029+moul@users.noreply.github.com>

jefft0 reviewed Oct 1, 2024

View reviewed changes

moul mentioned this pull request Oct 1, 2024

feat: change gnoweb to add URL query string to render path #2876

Merged

Merge branch 'master' into dev/moul/pagination

943df0c

ajnavarro reviewed Oct 3, 2024

View reviewed changes

examples/gno.land/p/demo/avl/pager/pager.gno Outdated Show resolved Hide resolved

ajnavarro reviewed Oct 3, 2024

View reviewed changes

moul and others added 3 commits October 5, 2024 12:51

Update examples/gno.land/p/demo/avl/pager/pager.gno

1c10732

Co-authored-by: Antonio Navarro Perez <antnavper@gmail.com>

chore: fixup

79ffd7d

Signed-off-by: moul <94029+moul@users.noreply.github.com>

Merge branch 'master' into dev/moul/pagination

adf95c0

ltzmaxwell reviewed Oct 5, 2024

View reviewed changes

chore: fixup

3754a70

Signed-off-by: moul <94029+moul@users.noreply.github.com>

leohhhn reviewed Oct 8, 2024

View reviewed changes

Update examples/gno.land/r/demo/users/users.gno

b9b7209

Co-authored-by: Leon Hudak <33522493+leohhhn@users.noreply.github.com>

leohhhn reviewed Oct 8, 2024

View reviewed changes

This was referenced Oct 11, 2024

feat(paginate): re-open PR with #883's work #1090

Closed

fix: Pager added, improves p/demo/ui improvements #2675

Open

leohhhn mentioned this pull request Oct 16, 2024

feat(examples): hall of fame #2842

Merged

7 tasks

moul mentioned this pull request Oct 24, 2024

Dogfood r/boards on portal loop #3018

Open

leohhhn mentioned this pull request Oct 30, 2024

docs: add pagination pattern to Effective Gno #3044

Open

Merge branch 'master' into dev/moul/pagination

e39e037

chore: fixup

fbc75c8

Signed-off-by: moul <94029+moul@users.noreply.github.com>

moul merged commit 81a88a2 into gnolang:master Nov 6, 2024
134 checks passed

moul deleted the dev/moul/pagination branch November 6, 2024 19:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add p/avl/pager #2584

feat: add p/avl/pager #2584

moul commented Jul 14, 2024 •

edited

Loading

codecov bot commented Sep 24, 2024 •

edited

Loading

jefft0 commented Oct 1, 2024

jefft0 Oct 1, 2024

jeronimoalbi Oct 1, 2024

jeronimoalbi Oct 1, 2024

ajnavarro Oct 3, 2024 •

edited

Loading

ajnavarro Oct 3, 2024

moul Oct 5, 2024

ltzmaxwell Oct 5, 2024 •

edited

Loading

moul Oct 5, 2024

ltzmaxwell Oct 5, 2024

moul Oct 5, 2024

leohhhn left a comment •

edited

Loading

leohhhn Oct 8, 2024

moul Oct 8, 2024

leohhhn Oct 8, 2024

leohhhn Oct 8, 2024

moul Oct 8, 2024

moul commented Oct 8, 2024

leohhhn Oct 8, 2024 •

edited

Loading

moul Oct 9, 2024

leohhhn commented Nov 6, 2024

moul commented Nov 6, 2024

	func (p *Page) Selector() string {
	func (p *Page) Picker() string {

feat: add p/avl/pager #2584

feat: add p/avl/pager #2584

Conversation

moul commented Jul 14, 2024 • edited Loading

codecov bot commented Sep 24, 2024 • edited Loading

Codecov Report

jefft0 commented Oct 1, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ajnavarro Oct 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ltzmaxwell Oct 5, 2024 • edited Loading

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

leohhhn left a comment • edited Loading

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 commented Oct 8, 2024

leohhhn Oct 8, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leohhhn commented Nov 6, 2024

moul commented Nov 6, 2024

moul commented Jul 14, 2024 •

edited

Loading

codecov bot commented Sep 24, 2024 •

edited

Loading

ajnavarro Oct 3, 2024 •

edited

Loading

ltzmaxwell Oct 5, 2024 •

edited

Loading

leohhhn left a comment •

edited

Loading

leohhhn Oct 8, 2024 •

edited

Loading