feat: dir index html listing #86
Conversation
…-some-gateway-conformance-tests-that-were-disabled-in-httpsgithubcomipfshelia-verified-fetchpull81
This reverts commit 492da12.
There was a problem hiding this comment.
Concern
Hm.. with all the CSS and SVG images that take hundreds of kilobytes, and reproducing look and feel for boxo/gateway, this feels like an overkill for this library, and more something that should live in separate package imported by upstream projects like https://github.com/ipfs/service-worker-gateway
Most of users of verified-fetch will use it programmatically to access files, they won't enumerate directories, and if they do, they would prefer deterministic JSON rather than a difficult to parse HTML. Dir listing is something specific to project built on top of this library.
Note that the same approach applies to DAG-CBOR – we are not generating user-friendly HTML in verified-fetch.
Some ideas
I vaguely remember discussing this in the past (apologies, forgot with whom) and the idea was for verified-fetch due its web dev nature to default (if no Accept is passed) to returning more useful JSON representation of UnixFS defined in https://ipld.io/specs/codecs/dag-pb/spec/#logical-format (initial idea was to make it the same DAG-JSON as ipfs dag get QmdC5Hav9zdn2iS75reafXBq1PH4EnqUmoxwoxkS5QtuME so the DX/UX of switching from kubo RPC to verified-fetch is cushioned).
If verified-fetch library returned dir listings as JSON, dir support does not introduce size/dependency overhead for users who only interact with files, and then SW/HTTP gateway could be converting JSON dir listings to user-friendly HTML, and we would not have to maintain any UI elements in this repository.
If we want, a very basic unstyled HTML responses (<ul>) could be produced by verified-fetch, but only if request was done with text/html in Accept.
There was a problem hiding this comment.
If we do return json, do we have tests for that in gateway conformance? otherwise, I think we should probably optimize for gateway conformance passing now (for feature parity) and improve this lib as gateway conformance has more of a targeted focus for use by verified-fetch
There was a problem hiding this comment.
No tests for that, its a technical debt I want to pay some day.
Your approach is ok, but if you see a test that makes no sense (overly specific to Kubo) then feel free to skip and fill issue in https://github.com/ipfs/gateway-conformance + ping me to expedite a new release.
btw: i think right now gateway-conformance expects HTML to be always supported, which is a bug imo. Thats fine for now, but in the future we will make conformance tests send explicit Accept header with text/html (like we already do in for DAG-JSON)
|
we need to create a wrapper module.. simile to how we do |
Title
feat: dir index html listing
Description
Initial implementation of the directory index html listing.
Demo
verified-fetch.index-dir-html.demo.mp4
Notes & open questions
We don't want a templating engine, so code is going to be a bit verbose, but I plan to clean it up before removing this PR from draft.
Change checklist