2020-02-11 04:34:17 -05:00
|
|
|
// Copyright 2020 The Gitea Authors. All rights reserved.
|
2022-11-27 13:20:29 -05:00
|
|
|
// SPDX-License-Identifier: MIT
|
2020-02-11 04:34:17 -05:00
|
|
|
|
|
|
|
|
package stats
|
|
|
|
|
|
|
|
|
|
import (
|
2022-03-27 03:05:01 -04:00
|
|
|
"context"
|
2020-02-11 04:34:17 -05:00
|
|
|
"testing"
|
|
|
|
|
"time"
|
|
|
|
|
|
2022-05-20 10:08:52 -04:00
|
|
|
"code.gitea.io/gitea/models/db"
|
2021-12-09 20:27:50 -05:00
|
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
2021-11-12 09:36:47 -05:00
|
|
|
"code.gitea.io/gitea/models/unittest"
|
2022-03-27 03:05:01 -04:00
|
|
|
"code.gitea.io/gitea/modules/queue"
|
2020-02-11 04:34:17 -05:00
|
|
|
"code.gitea.io/gitea/modules/setting"
|
|
|
|
|
|
2021-12-15 00:39:34 -05:00
|
|
|
_ "code.gitea.io/gitea/models"
|
2023-09-08 00:51:15 -04:00
|
|
|
_ "code.gitea.io/gitea/models/actions"
|
|
|
|
|
_ "code.gitea.io/gitea/models/activities"
|
2021-12-15 00:39:34 -05:00
|
|
|
|
2020-02-11 04:34:17 -05:00
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
func TestMain(m *testing.M) {
|
2023-09-27 21:38:53 -04:00
|
|
|
unittest.MainTest(m)
|
2020-02-11 04:34:17 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestRepoStatsIndex(t *testing.T) {
|
2021-11-12 09:36:47 -05:00
|
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
2023-05-10 00:57:06 -04:00
|
|
|
setting.CfgProvider, _ = setting.NewConfigProviderFromData("")
|
2020-02-11 04:34:17 -05:00
|
|
|
|
2023-02-19 11:12:01 -05:00
|
|
|
setting.LoadQueueSettings()
|
2020-02-11 04:34:17 -05:00
|
|
|
|
|
|
|
|
err := Init()
|
|
|
|
|
assert.NoError(t, err)
|
|
|
|
|
|
2022-12-02 21:48:26 -05:00
|
|
|
repo, err := repo_model.GetRepositoryByID(db.DefaultContext, 1)
|
2020-02-11 04:34:17 -05:00
|
|
|
assert.NoError(t, err)
|
2022-03-27 03:05:01 -04:00
|
|
|
|
|
|
|
|
err = UpdateRepoIndexer(repo)
|
|
|
|
|
assert.NoError(t, err)
|
|
|
|
|
|
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:
2023-05-08 07:49:59 -04:00
|
|
|
assert.NoError(t, queue.GetManager().FlushAll(context.Background(), 5*time.Second))
|
2022-03-27 03:05:01 -04:00
|
|
|
|
2022-05-20 10:08:52 -04:00
|
|
|
status, err := repo_model.GetIndexerStatus(db.DefaultContext, repo, repo_model.RepoIndexerTypeStats)
|
2020-05-30 03:46:15 -04:00
|
|
|
assert.NoError(t, err)
|
|
|
|
|
assert.Equal(t, "65f1bf27bc3bf70f64657658635e66094edbcb4d", status.CommitSha)
|
2023-10-11 00:24:07 -04:00
|
|
|
langs, err := repo_model.GetTopLanguageStats(db.DefaultContext, repo, 5)
|
2020-02-11 04:34:17 -05:00
|
|
|
assert.NoError(t, err)
|
2020-05-30 18:58:55 -04:00
|
|
|
assert.Empty(t, langs)
|
2020-02-11 04:34:17 -05:00
|
|
|
}
|