Quick Jump feature broken on some of our hackage documentation

[leonschoorl]

Something is wrong with the haddock files on hackage for clash-prelude-1.8.2.

When viewing the hackage page for clash-prelude-1.8.2 and trying to use the Quick Jump feature, by pressing the s key, you get taken to the bottom of the page, and the search box looks different from normal.
Searching does work, but all links are broken, for example sample links to: https://hackage.haskell.org/package/clash-prelude-1.8.2/#v:sample

One version early clash-prelude-1.8.1 does function normally.

Looking at the browser console, I can see a 403 error when attempting to load https://hackage.haskell.org/package/clash-prelude-1.8.2/docs/quick-jump.css
And a message(view its source):

Quick Jump hash is not correct: Accepted Quick Jump hashes are listed in the hackage-server source code.

Both versions are listed as "Docs uploaded by user".
So apparently after clash-prelude-1.8.1 we started uploading "illegal" quick-jump.css files to hackage.

Interestingly clash-lib-1.8.2 is correct, but both clash-lib-1.8.2/candidate and clash-lib-1.9.0/candidate are also broken.

By manually patching the css file via the developer tools, I've verified that is broke css file is the cause of the observed behaviour.
But I was very surprised to see a css file affect a link target like this.

[leonschoorl]

Both clash-prelude-1.8.1 and clash-prelude-1.8.2 say in their footer:

Produced by Haddock version 2.24.2

[DigitalBrains1]

Please note the doc for 1.8.2 is manually generated and uploaded by me using cabal-install 3.12.1.0, after we accidentally initially used cabal-install 3.14.1.0 upon release of 1.8.2, which broke our tweaks to the Haddock.

The new 1.9.0 candidates are also generated with cabal-install 3.12.1.0.

The correct 1.8.1, though, was generated with cabal-install 3.2.0.0.

Maybe the cause lies somewhere there, as all of these are generated with GHC 8.10.7 (which determines the Haddock version used), so that hasn't changed. And if you don't know that I did that manual update, you'd be looking at the wrong data while comparing circumstances.

[leonschoorl]

I think I've got it mostly figured out.

For files uploaded after 2025-2-1 hackage requires the quick-jump.css file to have a specific hash.

This hash matches what is being generated by haddock >= 2.25.
But we're still using haddock 2.24.2(which comes with ghc-8.10.7), it doesn't have this patch, and hence its css file has a different hash.

Although the timeline doesn't quite match up, as it says "Uploaded 2025-01-04T02:08:43Z" on the clash-prelude-1.8.2 page.
I just assumes it now hits the hash check because the there is a revision made after 2025-2-1.

Whatever the exact reason, updating our CI infra config to use a newer GHC should fix this issue 🤞
Even just bumping it to ghc-9.0.x should be enough as far as this issue is concerned, as that comes with haddock-2.25.1.

[DigitalBrains1]

Nice work debugging!

Although the timeline doesn't quite match up, as it says "Uploaded 2025-01-04T02:08:43Z" on the clash-prelude-1.8.2 page.

That's just when version 1.8.2 was uploaded to Hackage; it doesn't mean that's the most recent thing to happen on 1.8.2. It doesn't count revisions or documentation changes. It matches with the initial revision.

I don't see a way to see when the documentation was most recently uploaded. But it wasn't before 15 February, I know that for sure. I think it was March.