feat(serveStatic): add precompressed option

[inetol]

Closes #3363

Allows to serve all compatible pre-compressed files transparently to the client, otherwise fallback to serve the original file.

In case there are several files with various encodings (e.g., .gz and .br), it has priority to use brotli, then zstd and finally gzip.

The author should do the following, if applicable

• Add tests
• Run tests
• bun run format:fix && bun run lint:fix to format the code
• Add TSDoc/JSDoc to document the code

[yusukebe]

Hi @inetol

Thank you for the PR. It's interesting. But, is there any specification of precompressed? Is this used in general? Honestly, I didn't know there was a rule of precompressed.

[inetol]

AFAIK, it looks more like a helper to me, nginx and Caddyserver have a dedicated directive to this but at no time it is said that it is part of a spec, so its implementation may differ.

In cases where for some reason it is not possible to compress a file at the time of the request (because its too large, because the server is not compatible or for other reasons) this may be a solution.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.78%. Comparing base (3500404) to head (2e04502).
Report is 8 commits behind head on next.

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #3366      +/-   ##
==========================================
+ Coverage   95.77%   95.78%   +0.01%     
==========================================
  Files         152      152              
  Lines        9187     9211      +24     
  Branches     2818     2681     -137     
==========================================
+ Hits         8799     8823      +24     
  Misses        388      388              

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

[yusukebe]

@inetol

Thank you for your explanation.

I think this is a nice feature, but I'd like to know others' thoughts on whether we should accept it.

@ryuapp @nakasyou @usualoma and others, What do you feel about this feature?

[ryuapp]

I haven't checked the detailed implementation, but I think it's a good feature for Hono, which prioritizes performance.

As far as I searched, Fastify, Koa, and SvelteKit have similar features. It would be worth implementing.
https://github.com/fastify/fastify-static?tab=readme-ov-file#precompressed
https://github.com/koajs/static?tab=readme-ov-file#options
https://kit.svelte.dev/docs/adapter-static#options-precompress

[MathurAditya724]

Someone from the community has created this PR for the node server serveStatic - honojs/node-server#195. IMO, this is a much clearer and more flexible approach to resolving this issue.

[yusukebe]

LGTM!

[yusukebe]

@ryuapp @MathurAditya724 Thanks for your comment.

Looks good! I'll merge this into the next branch which I'll create for the next minor release, v4.6.0, later.

@inetol Thank you for your contribution!