Solves #1029 - Adds paging to recent packages and recent revisions #1055

LeviButcher · 2022-04-12T02:42:13Z

Implements #1029

Everything Included:

Paging support via queryParams (page, pageSize) on recent packages and recent revision (html, rss)
Extract HTML and RSS responses from RecentPackagesFeature to HTMLFeature
Uses same paging functionality as the browse/search page but without JS (I also updated it to remove Next/Prev if there isn't one)

Possible Issues:

I'm not for sure if I handled the cache correctly in the RecentPackagesFeature
I have it paging over all the data, I could change it to only page over the last 48 hours worth if desired
Some of the support functions I made are not necessarily safe (Usage of head) but I accounted for errors as much as possible

Let me know of any improvements I can make. 👍

ysangkok · 2022-04-13T14:55:55Z

datafiles/static/browse.js

@@ -303,7 +303,8 @@ const createPaginator = () => {
    pag.appendChild(createPageLink(maxPage));
  }
  const isNowOnLastPage = state.page === maxPage;
-  pag.appendChild(createPrevNext(state.page + 1, isNowOnLastPage, "Next"));
+
+  if(!isNowOnLastPage) pag.appendChild(createPrevNext(state.page + 1, "Next"));


I think there is value in showing a disabled button, since it will result in a more consistent layout when viewing different pages. What is the motivation for changing this?

I wanted browse.js to match the backend rendering of the paginator used on the recent page. On the backend it was less cumbersome to remove Next or Prev from the HTML conditionally then it was to toggle a disabled attribute since in the XHTML library there was no function for adding no attributes.

I wanted to do something like this: a ! [href "URL", if hasNext then NoAttr else emptyAttr "disabled"] << "Next"

That best way I could do it was to either to add a empty class or do disabled=True/False. Which browser defaults consider any presence of the disabled attribute whether True or False as disabled.

I can easily return the behavior though. 💯

I added back in showing the disabled buttons with the most recent commit.

ysangkok · 2022-04-13T14:56:20Z

datafiles/static/hackage.css

@@ -1085,11 +1084,12 @@ a.deprecated[href]:visited {
  background: linear-gradient(to bottom, #585858 0%, #111 100%);
 }

-.paginator span {
-  padding: 0 1em;
+.paginator a[href][disabled] { 


If disabled buttons are no longer shown, this style sheet is unnecessary.

ysangkok · 2022-04-13T15:01:50Z

src/Distribution/Server/Pages/Recent.hs

@@ -120,32 +196,30 @@ recentRevisionsURL :: URL
 recentRevisionsURL = "/packages/recent/revisions.html"


-recentFeed :: Users -> URI -> UTCTime -> [PkgInfo] -> RSS
-recentFeed users hostURI now pkgs = RSS
+recentFeed :: PaginatedConfiguration -> Users -> URI -> UTCTime -> [PkgInfo] -> RSS


I don't know if this is too much work, but there is a standard for paginated feeds. Seems to me like there is no way for the feed reader to show the next page using the current iteration of this PR, is that correct?

Yup. Text-RSS doesn't have a way to pass multiple Links at the top level or give those links a "rel" attribute. I'd be more then willing to improve Text-RSS but that won't be quick.

gbaz · 2022-04-15T15:34:57Z

@ysangkok I'll of course take a closer look before acting on this, but want to know if from your standpoint you think the issues you raised have been sufficiently addressed?

ysangkok · 2022-04-17T16:18:53Z

The paginator doesn't seem to work the same on the recent packages list, which I think it should. For example, I have one package in my index, and the browse page looks like:

Meanwhile, the recent packages listing looks like:

I don't think the ellipsis should be there. (I don't really care about the pluralization)

LeviButcher · 2022-04-17T19:59:10Z

I've fixed the paginator issue @ysangkok described. 👍

ysangkok · 2022-04-19T13:37:21Z

A maximum page size like e.g. 200 should be enforced. Otherwise, it is really easy to overload the server. Especially since the parameter is received as a query string parameter, and therefore the overloading could be triggered simply by a link.

LeviButcher · 2022-04-20T03:28:30Z

Implemented page size restriction. @ysangkok

Do you think the RecentPackages returning all packages is a performance issue? It does use the same caching as before although I wasn't for sure if I refactored it correctly. I can restrict it to only the past 48 worth or some x amount although that will restrict how many pages are possible.

ysangkok · 2022-04-23T13:14:56Z

I think we should restrict that as well, because it seems malicious if somebody is e.g. requesting page 50 of RecentPackages. If a legitimate user needs to do that, they're probably really trying to achieve something that would be better addressed by a new feature.

* delete unused GitHub Action; fix CI badge * Fix #1076: separate validators from UI and doctest them (#1077) * Cachix caching for nix-shell GitHub Action (#1081) * Add uploaded_at field in package api (#1080) * package page: Include virtual-modules in module tree (#1085) * Allow hashable-1.4 and text-2.0 (#1089) * Divide sitemap into parts * Add sitemap link for subdirectories * Fix `non-canonical-return` warnings * Bump CI to GHC 9.2.3 and restrict to master branch * Check authorisation (#1111) * Dynamically add css piece * Fix #1105: change order of markdown parsers to allow pipes in lists * Fix #1128, fix #1130 by adding bounds to Cabal-syntax and haddock-library * Bump CI to 9.2.4 and some deps * Force .txt and .text to have UTF-8 MIME charset (#1133) * Upgrade to haddock-library-1.11.0 (#1126) * attempt to speed up GitHub Action for Nix Shell * work with cabal 3.8 * Updated accepted licenses (#1092) * Add dependabot for github workflows * Bump cachix/cachix-action from 10 to 12 * Bump actions/checkout from 2.4.0 to 3.1.0 * Bump cachix/install-nix-action from 17 to 18 * Build with Cabal-3.8 and GHC 9.4 (#1141) * Haskell CI: bump to Ubuntu-22.04, GHC 9.2.5 and 9.4.4 * Allow mtl-2.3 and transformers-0.6 (#1150) * Disable test (#1124) * allow disable tests on client side * add deprecated version warning (#1123) * List maintainers on package page (#1098) * List maintainers on package page * Vendor snowball package (#1116) * Add searchbox metadata (#1115) * Add captcha for user registration (#1099) * remove filtering 00-index for cabal version < 2.0 hack (#1152) * Add lastVersion in listings (#749) (#1140) * rm icu dep instructions, add libgd * Add test log display (#1100) * Add test log * Reverse Dependencies indexed on PackageName (#1082) * Rebased Reverse Dependencies * Add "Quick Jump" to candidate package page (#1122) * Solves #1029 - Adds paging to recent packages and recent revisions (#1055) * support for `prefers-color-scheme` (#1008) * 2x brightness for captions and links in dark color scheme * table dark color scheme * prefers-color-scheme for links, footer, and table-of-contents * paginator css for `prefers-color-scheme` * Maintainer notifications * cleanup partial functions for revdeps, elim use of MonadThrow, MonadCatch * fix tests enablement link Co-authored-by: Peter Becich <[email protected]> Co-authored-by: Andreas Abel <[email protected]> Co-authored-by: Hécate Moonlight <[email protected]> Co-authored-by: Matthew Pickering <[email protected]> Co-authored-by: ˌbodʲɪˈɡrʲim <[email protected]> Co-authored-by: Alias Qli <[email protected]> Co-authored-by: Ondřej Kubánek <[email protected]> Co-authored-by: Gautier DI FOLCO <[email protected]> Co-authored-by: Janus Troelsen <[email protected]> Co-authored-by: Levi Butcher <[email protected]>

ysangkok reviewed Apr 13, 2022

View reviewed changes

LeviButcher force-pushed the recent-paging branch from c46f183 to 5d309ec Compare April 13, 2022 19:52

LeviButcher force-pushed the recent-paging branch from 99b7e97 to 2e0de96 Compare April 17, 2022 19:57

LeviButcher added 8 commits April 19, 2022 23:19

Initial implementation of paging on recent packages

f9c64d7

Backend implementation of paginator for recent uploads

a0d36d1

Extracted HTML and RSS from RecentPackag Feature

4bdc5af

Remove divison by zero in query params

aeaee80

Isolate paginator css and update browse.js

62b164b

Show Next/Prev when disabled and CSS improvements

d02a706

Fix showing ellipsis on small paging results

6cb18b2

Restrict pageSize for recent packages and revisions

231a70c

LeviButcher force-pushed the recent-paging branch from 7792d95 to 231a70c Compare April 20, 2022 03:19

Merge branch 'master' into recent-paging

09fae19

gbaz merged commit 2f9a4ee into haskell:master Jan 2, 2023

gbaz mentioned this pull request Jan 6, 2023

master -> central server jan 2023 #1158

Merged

LeviButcher deleted the recent-paging branch January 13, 2023 20:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Solves #1029 - Adds paging to recent packages and recent revisions #1055

Solves #1029 - Adds paging to recent packages and recent revisions #1055

LeviButcher commented Apr 12, 2022

ysangkok Apr 13, 2022

LeviButcher Apr 13, 2022

LeviButcher Apr 13, 2022

ysangkok Apr 13, 2022

ysangkok Apr 13, 2022

LeviButcher Apr 13, 2022

gbaz commented Apr 15, 2022

ysangkok commented Apr 17, 2022

LeviButcher commented Apr 17, 2022

ysangkok commented Apr 19, 2022

LeviButcher commented Apr 20, 2022

ysangkok commented Apr 23, 2022 •

edited

Loading

Solves #1029 - Adds paging to recent packages and recent revisions #1055

Solves #1029 - Adds paging to recent packages and recent revisions #1055

Conversation

LeviButcher commented Apr 12, 2022

ysangkok Apr 13, 2022

Choose a reason for hiding this comment

LeviButcher Apr 13, 2022

Choose a reason for hiding this comment

LeviButcher Apr 13, 2022

Choose a reason for hiding this comment

ysangkok Apr 13, 2022

Choose a reason for hiding this comment

ysangkok Apr 13, 2022

Choose a reason for hiding this comment

LeviButcher Apr 13, 2022

Choose a reason for hiding this comment

gbaz commented Apr 15, 2022

ysangkok commented Apr 17, 2022

LeviButcher commented Apr 17, 2022

ysangkok commented Apr 19, 2022

LeviButcher commented Apr 20, 2022

ysangkok commented Apr 23, 2022 • edited Loading

ysangkok commented Apr 23, 2022 •

edited

Loading