Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(boards2): pagination #3586

Open
wants to merge 2 commits into
base: devx/feature/boardsv2
Choose a base branch
from

Conversation

x1unix
Copy link
Contributor

@x1unix x1unix commented Jan 23, 2025

Implement pagination for boards, threads and replies.

Closes #3200

CC @jeronimoalbi @salmad3

@github-actions github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label Jan 23, 2025
@Gno2D2
Copy link
Collaborator

Gno2D2 commented Jan 23, 2025

🛠 PR Checks Summary

🔴 Maintainers must be able to edit this pull request (more info)
🔴 Pending initial approval by a review team member (and label matches review triage state)

Manual Checks (for Reviewers):
  • IGNORE the bot requirements for this PR (force green CI check) (checked by @jeronimoalbi)
  • The pull request description provides enough details (checked by @jeronimoalbi)
Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🔴 Maintainers must be able to edit this pull request (more info)
🔴 Pending initial approval by a review team member (and label matches review triage state)

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. Follow the Contributor Checklist to ensure your PR is ready for review.
    • Add new tests, or document why they are unnecessary.
    • Provide clear examples/screenshots, if necessary.
    • Update documentation, if required.
    • Ensure no breaking changes, or include BREAKING CHANGE notes.
    • Link related issues/PRs, where applicable.
☑️ Reviewer Actions:
  1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.
📚 Resources:
Debug
Automated Checks
Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 The pull request was created from a fork (head branch repo: gnostudio/gno)

Then

🔴 Requirement not satisfied
└── 🔴 Maintainer can modify this pull request

Pending initial approval by a review team member (and label matches review triage state)

If

🟢 Condition met
└── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🔴 Requirement not satisfied
└── 🔴 If
    ├── 🔴 Condition
    │   └── 🔴 Or
    │       ├── 🔴 At least 1 user(s) of the organization approved the pull request
    │       └── 🔴 This pull request is a draft
    └── 🔴 Else
        └── 🔴 And
            ├── 🟢 This label is applied to pull request: review/triage-pending
            └── 🔴 On no pull request

Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

  • Any user with comment edit permission
The pull request description provides enough details

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 Not (🔴 Pull request author is a member of the team: core-contributors)
    └── 🟢 Not (🔴 Pull request author is user: dependabot[bot])

Can be checked by

  • team core-contributors

Comment on lines +34 to +49
func mustGetPagination(req *mux.Request, pageSize int) *PaginationOpts {
p := pager.Pager{
PageQueryParam: "page",
DefaultPageSize: pageSize,
}

pageNumber, _, err := p.ParseQuery(req.RawPath)
if err != nil {
panic(err)
}

return &PaginationOpts{
Pager: p,
PageNumber: pageNumber,
}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
func mustGetPagination(req *mux.Request, pageSize int) *PaginationOpts {
p := pager.Pager{
PageQueryParam: "page",
DefaultPageSize: pageSize,
}
pageNumber, _, err := p.ParseQuery(req.RawPath)
if err != nil {
panic(err)
}
return &PaginationOpts{
Pager: p,
PageNumber: pageNumber,
}
}
func mustGetPagination(rawPath string, pageSize int) *PaginationOpts {
p := pager.Pager{
PageQueryParam: "page",
DefaultPageSize: pageSize,
}
pageNumber, _, err := p.ParseQuery(rawPath)
if err != nil {
panic(err)
}
return &PaginationOpts{
Pager: p,
PageNumber: pageNumber,
}
}

@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Jan 23, 2025
res.Write("These are all the boards of this realm:\n\n")
gBoardsByID.Iterate("", "", func(_ string, value interface{}) bool {
p := mustGetPagination(req, boardsPageSize)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
p := mustGetPagination(req, boardsPageSize)
p := mustGetPagination(req.RawPath, boardsPageSize)

}

board := v.(*Board)
p := mustGetPagination(req, threadsPageSize)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
p := mustGetPagination(req, threadsPageSize)
p := mustGetPagination(req.RawPath, threadsPageSize)

@@ -63,7 +77,8 @@ func renderThread(res *mux.ResponseWriter, req *mux.Request) {
} else if thread.IsHidden() {
res.Write("Thread with ID: " + rawID + " has been flagged as inappropriate")
} else {
res.Write(thread.Render("", 5))
p := mustGetPagination(req, repliesPageSize)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
p := mustGetPagination(req, repliesPageSize)
p := mustGetPagination(req.RawPath, repliesPageSize)

Comment on lines +10 to +11
Pager pager.Pager
PageNumber int
Copy link
Member

@jeronimoalbi jeronimoalbi Jan 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should Pager and PageNumber be public? What do you think about making them private?

Also PageNumber could be removed I think, because is available as Pager.PageNumber.

// Render renders a board into Markdown.
//
// Pager is used for pagination if it's not nil.
func (board *Board) Render(p *PaginationOpts) string {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe, it might be possible to use a struct instead of a pointer everywhere when using PaginationOpts as argument:

Suggested change
func (board *Board) Render(p *PaginationOpts) string {
func (board *Board) Render(p PaginationOpts) string {

@jeronimoalbi jeronimoalbi removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Jan 23, 2025
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧾 package/realm Tag used for new Realms or Packages. review/triage-pending PRs opened by external contributors that are waiting for the 1st review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants