forgejo/models/actions
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
..
artifact.go
forgejo.go feat(cli): allow updates to runners' secrets 2024-07-22 11:55:43 +02:00
forgejo_test.go Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
main_test.go fix(actions): prevent deleted records' UUID from colliding with new records (#3830) 2024-05-19 10:46:15 +00:00
run.go badges: Relax the default workflow badge conditions 2024-05-20 11:20:11 +02:00
run_job.go
run_job_list.go Add container.FilterSlice function (gitea#30339) 2024-04-16 11:49:44 +02:00
run_list.go Add container.FilterSlice function (gitea#30339) 2024-04-16 11:49:44 +02:00
runner.go Clarify Actions resources ownership (#31724) 2024-08-04 18:24:10 +02:00
runner_list.go Refactor more filterslice (gitea#30370) 2024-04-16 11:51:00 +02:00
runner_test.go Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
runner_token.go Clarify Actions resources ownership (#31724) 2024-08-04 18:24:10 +02:00
runner_token_test.go Add testifylint to lint checks (#4535) 2024-07-30 19:41:10 +00:00
schedule.go Use UTC as default timezone when schedule Actions cron tasks (#31742) 2024-08-04 18:24:10 +02:00
schedule_list.go Add container.FilterSlice function (gitea#30339) 2024-04-16 11:49:44 +02:00
schedule_spec.go Use UTC as default timezone when schedule Actions cron tasks (#31742) 2024-08-04 18:24:10 +02:00
schedule_spec_list.go [BUG] Add early-return to loading items from SpecList 2024-07-20 01:27:11 +02:00
schedule_spec_test.go Use UTC as default timezone when schedule Actions cron tasks (#31742) 2024-08-04 18:24:10 +02:00
status.go
task.go Support compression for Actions logs (#31761) 2024-08-13 06:51:49 +02:00
task_list.go Drop IDOrderDesc for listing Actions task and always order by id DESC (#31150) 2024-06-02 16:26:54 +02:00
task_output.go
task_step.go
tasks_version.go Add codespell support and fix a good number of typos with its help (#3270) 2024-05-09 13:49:37 +00:00
utils.go
utils_test.go
variable.go Clarify Actions resources ownership (#31724) 2024-08-04 18:24:10 +02:00