forgejo-federation/modules/util
wxiaoguang 6f9c278559
Rewrite queue (#24505)
# ⚠️ Breaking

Many deprecated queue config options are removed (actually, they should
have been removed in 1.18/1.19).

If you see the fatal message when starting Gitea: "Please update your
app.ini to remove deprecated config options", please follow the error
messages to remove these options from your app.ini.

Example:

```
2023/05/06 19:39:22 [E] Removed queue option: `[indexer].ISSUE_INDEXER_QUEUE_TYPE`. Use new options in `[queue.issue_indexer]`
2023/05/06 19:39:22 [E] Removed queue option: `[indexer].UPDATE_BUFFER_LEN`. Use new options in `[queue.issue_indexer]`
2023/05/06 19:39:22 [F] Please update your app.ini to remove deprecated config options
```

Many options in `[queue]` are are dropped, including:
`WRAP_IF_NECESSARY`, `MAX_ATTEMPTS`, `TIMEOUT`, `WORKERS`,
`BLOCK_TIMEOUT`, `BOOST_TIMEOUT`, `BOOST_WORKERS`, they can be removed
from app.ini.

# The problem

The old queue package has some legacy problems:

* complexity: I doubt few people could tell how it works.
* maintainability: Too many channels and mutex/cond are mixed together,
too many different structs/interfaces depends each other.
* stability: due to the complexity & maintainability, sometimes there
are strange bugs and difficult to debug, and some code doesn't have test
(indeed some code is difficult to test because a lot of things are mixed
together).
* general applicability: although it is called "queue", its behavior is
not a well-known queue.
* scalability: it doesn't seem easy to make it work with a cluster
without breaking its behaviors.

It came from some very old code to "avoid breaking", however, its
technical debt is too heavy now. It's a good time to introduce a better
"queue" package.

# The new queue package

It keeps using old config and concept as much as possible.

* It only contains two major kinds of concepts:
    * The "base queue": channel, levelqueue, redis
* They have the same abstraction, the same interface, and they are
tested by the same testing code.
* The "WokerPoolQueue", it uses the "base queue" to provide "worker
pool" function, calls the "handler" to process the data in the base
queue.
* The new code doesn't do "PushBack"
* Think about a queue with many workers, the "PushBack" can't guarantee
the order for re-queued unhandled items, so in new code it just does
"normal push"
* The new code doesn't do "pause/resume"
* The "pause/resume" was designed to handle some handler's failure: eg:
document indexer (elasticsearch) is down
* If a queue is paused for long time, either the producers blocks or the
new items are dropped.
* The new code doesn't do such "pause/resume" trick, it's not a common
queue's behavior and it doesn't help much.
* If there are unhandled items, the "push" function just blocks for a
few seconds and then re-queue them and retry.
* The new code doesn't do "worker booster"
* Gitea's queue's handlers are light functions, the cost is only the
go-routine, so it doesn't make sense to "boost" them.
* The new code only use "max worker number" to limit the concurrent
workers.
* The new "Push" never blocks forever
* Instead of creating more and more blocking goroutines, return an error
is more friendly to the server and to the end user.

There are more details in code comments: eg: the "Flush" problem, the
strange "code.index" hanging problem, the "immediate" queue problem.

Almost ready for review.

TODO:

* [x] add some necessary comments during review
* [x] add some more tests if necessary
* [x] update documents and config options
* [x] test max worker / active worker
* [x] re-run the CI tasks to see whether any test is flaky
* [x] improve the `handleOldLengthConfiguration` to provide more
friendly messages
* [x] fine tune default config values (eg: length?)

## Code coverage:

![image](https://user-images.githubusercontent.com/2114189/236620635-55576955-f95d-4810-b12f-879026a3afdf.png)
2023-05-08 19:49:59 +08:00
..
filebuffer Add Debian package registry (#24426) 2023-05-02 12:31:35 -04:00
error.go Use ErrInvalidArgument in packages (#22268) 2022-12-31 12:49:37 +01:00
file_unix.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
file_unix_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
file_windows.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
io.go Improve checkIfPRContentChanged (#22611) 2023-01-28 15:54:40 +00:00
keypair.go Add Chef package registry (#22554) 2023-02-06 09:49:21 +08:00
keypair_test.go Use minio/sha256-simd for accelerated SHA256 (#23052) 2023-02-22 14:21:46 -05:00
legacy.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
legacy_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
pack.go Add support for incoming emails (#22056) 2023-01-14 23:57:10 +08:00
pack_test.go Add support for incoming emails (#22056) 2023-01-14 23:57:10 +08:00
paginate.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
paginate_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
path.go Use a general approach to access custom/static/builtin assets (#24022) 2023-04-12 18:16:45 +08:00
path_test.go Use a general approach to access custom/static/builtin assets (#24022) 2023-04-12 18:16:45 +08:00
remove.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
sanitize.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
sanitize_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
sec_to_time.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
sec_to_time_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
shellquote.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
shellquote_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
slice.go Improve utils of slices (#22379) 2023-01-11 13:31:16 +08:00
slice_test.go Use more specific test methods (#24265) 2023-04-22 17:56:27 -04:00
string.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
string_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
timer.go Rewrite queue (#24505) 2023-05-08 19:49:59 +08:00
timer_test.go Use a general approach to access custom/static/builtin assets (#24022) 2023-04-12 18:16:45 +08:00
truncate.go Introduce GiteaLocaleNumber custom element to handle number localization on pages. (#23861) 2023-04-03 12:58:09 -04:00
truncate_test.go Use more specific test methods (#24265) 2023-04-22 17:56:27 -04:00
url.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
util.go Merge template functions "dict/Dict/mergeinto" (#23932) 2023-04-07 09:39:08 -05:00
util_test.go Introduce GiteaLocaleNumber custom element to handle number localization on pages. (#23861) 2023-04-03 12:58:09 -04:00