forgejo/modules/packages
Jason Song a627b885c7
Support compression for Actions logs (#31761)
Support compression for Actions logs to save storage space and
bandwidth. Inspired by
https://github.com/go-gitea/gitea/issues/24256#issuecomment-1521153015

The biggest challenge is that the compression format should support
[seekable](https://github.com/facebook/zstd/blob/dev/contrib/seekable_format/zstd_seekable_compression_format.md).
So when users are viewing a part of the log lines, Gitea doesn't need to
download the whole compressed file and decompress it.

That means gzip cannot help here. And I did research, there aren't too
many choices, like bgzip and xz, but I think zstd is the most popular
one. It has an implementation in Golang with
[zstd](https://github.com/klauspost/compress/tree/master/zstd) and
[zstd-seekable-format-go](https://github.com/SaveTheRbtz/zstd-seekable-format-go),
and what is better is that it has good compatibility: a seekable format
zstd file can be read by a regular zstd reader.

This PR introduces a new package `zstd` to combine and wrap the two
packages, to provide a unified and easy-to-use API.

And a new setting `LOG_COMPRESSION` is added to the config, although I
don't see any reason why not to use compression, I think's it's a good
idea to keep the default with `none` to be consistent with old versions.

`LOG_COMPRESSION` takes effect for only new log files, it adds `.zst` as
an extension to the file name, so Gitea can determine if it needs
decompression according to the file name when reading. Old files will
keep the format since it's not worth converting them, as they will be
cleared after #31735.

<img width="541" alt="image"
src="https://github.com/user-attachments/assets/e9598764-a4e0-4b68-8c2b-f769265183c9">

(cherry picked from commit 33cc5837a655ad544b936d4d040ca36d74092588)

Conflicts:
	assets/go-licenses.json
	go.mod
	go.sum
  resolved with make tidy
2024-08-13 06:51:49 +02:00
..
alpine Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
arch feat: support grouping by any path for arch package (#4903) 2024-08-11 10:35:11 +00:00
cargo Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
chef Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
composer Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
conan Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
conda Support compression for Actions logs (#31761) 2024-08-13 06:51:49 +02:00
container Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
cran Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
debian Support compression for Actions logs (#31761) 2024-08-13 06:51:49 +02:00
goproxy Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
helm Replace interface{} with any (#25686) 2023-07-04 18:36:08 +00:00
maven Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
npm Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
nuget Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
pub Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
pypi Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
rpm Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
rubygems Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
swift Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
vagrant Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
content_store.go Add direct serving of package content (#25543) 2023-07-03 15:33:28 +02:00
hashed_buffer.go Close all hashed buffers (#27787) 2023-10-25 21:24:24 +02:00
hashed_buffer_test.go Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
multi_hasher.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
multi_hasher_test.go Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00