2017-04-25 03:24:51 -04:00
APP_NAME = Gitea: Git with a cup of tea
RUN_MODE = prod
[database]
DB_TYPE = mysql
2017-09-13 09:03:20 +03:00
HOST = {{ TEST_MYSQL_HOST }}
NAME = {{ TEST_MYSQL_DBNAME }}
USER = {{ TEST_MYSQL_USERNAME }}
PASSWD = {{ TEST_MYSQL_PASSWORD }}
2017-04-25 03:24:51 -04:00
SSL_MODE = disable
2017-09-16 13:16:21 -07:00
[indexer]
2022-06-24 15:04:30 -04:00
REPO_INDEXER_ENABLED = true
2022-09-02 15:18:23 -04:00
REPO_INDEXER_PATH = tests/ {{ TEST_TYPE }} /gitea- {{ TEST_TYPE }} -mysql/indexers/repos.bleve
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 19:49:59 +08:00
ISSUE_INDEXER_TYPE = elasticsearch
ISSUE_INDEXER_CONN_STR = http://elastic:changeme@elasticsearch:9200
2022-06-24 15:04:30 -04:00
[queue.issue_indexer]
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 19:49:59 +08:00
TYPE = level
2022-09-02 15:18:23 -04:00
DATADIR = tests/ {{ TEST_TYPE }} /gitea- {{ TEST_TYPE }} -mysql/indexers/issues.queue
2017-09-16 13:16:21 -07:00
2021-09-03 11:20:57 +01:00
[queue]
TYPE = immediate
2020-09-07 23:05:08 +08:00
[queue.code_indexer]
TYPE = immediate
2020-09-11 22:14:48 +08:00
[queue.push_update]
TYPE = immediate
2017-04-25 03:24:51 -04:00
[repository]
2022-09-02 15:18:23 -04:00
ROOT = {{ REPO_TEST_DIR }} tests/ {{ TEST_TYPE }} /gitea- {{ TEST_TYPE }} -mysql/gitea-repositories
2017-09-12 07:51:12 +02:00
[repository.local]
2022-09-02 15:18:23 -04:00
LOCAL_COPY_PATH = tests/ {{ TEST_TYPE }} /gitea- {{ TEST_TYPE }} -mysql/tmp/local-repo
2021-05-01 11:54:55 +02:00
[repository.upload]
2022-09-02 15:18:23 -04:00
TEMP_PATH = tests/ {{ TEST_TYPE }} /gitea- {{ TEST_TYPE }} -mysql/tmp/uploads
2017-04-25 03:24:51 -04:00
2019-10-16 14:42:42 +01:00
[repository.signing]
SIGNING_KEY = none
2017-04-25 03:24:51 -04:00
[server]
SSH_DOMAIN = localhost
2017-09-12 07:51:12 +02:00
HTTP_PORT = 3001
ROOT_URL = http://localhost:3001/
2017-04-25 03:24:51 -04:00
DISABLE_SSH = false
2018-01-16 12:07:47 +01:00
SSH_LISTEN_HOST = localhost
SSH_PORT = 2201
2022-09-02 15:18:23 -04:00
APP_DATA_PATH = tests/ {{ TEST_TYPE }} /gitea- {{ TEST_TYPE }} -mysql/data
2020-09-08 23:45:10 +08:00
BUILTIN_SSH_SERVER_USER = git
2018-01-16 12:07:47 +01:00
START_SSH_SERVER = true
2020-09-08 23:45:10 +08:00
OFFLINE_MODE = false
2017-11-28 21:58:37 +01:00
LFS_START_SERVER = true
2018-01-16 12:07:47 +01:00
LFS_JWT_SECRET = Tv_MjmZuHqpIY6GFl12ebgkRAMt4RlWt0v4EHKSXO0w
2022-06-05 09:16:14 +02:00
SSH_TRUSTED_USER_CA_KEYS = ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCb4DC1dMFnJ6pXWo7GMxTchtzmJHYzfN6sZ9FAPFR4ijMLfGki+olvOMO5Fql1/yGnGfbELQa1S6y4shSvj/5K+zUFScmEXYf3Gcr87RqilLkyk16RS+cHNB1u87xTHbETaa3nyCJeGQRpd4IQ4NKob745mwDZ7jQBH8AZEng50Oh8y8fi8skBBBzaYp1ilgvzG740L7uex6fHV62myq0SXeCa+oJUjq326FU8y+Vsa32H8A3e7tOgXZPdt2TVNltx2S9H2WO8RMi7LfaSwARNfy1zu+bfR50r6ef8Yx5YKCMz4wWb1SHU1GS800mjOjlInLQORYRNMlSwR1+vLlVDciOqFapDSbj+YOVOawR0R1aqlSKpZkt33DuOBPx9qe6CVnIi7Z+Px/KqM+OLCzlLY/RS+LbxQpDWcfTVRiP+S5qRTcE3M3UioN/e0BE/1+MpX90IGpvVkA63ILYbKEa4bM3ASL7ChTCr6xN5XT+GpVJveFKK1cfNx9ExHI4rzYE=
2020-11-01 04:51:48 +08:00
2017-04-25 03:24:51 -04:00
[mailer]
2019-02-03 02:06:52 +00:00
ENABLED = true
2023-07-26 15:50:15 +02:00
PROTOCOL = dummy
2022-09-02 15:18:23 -04:00
FROM = mysql- {{ TEST_TYPE }} -test@gitea.io
2017-04-25 03:24:51 -04:00
[service]
2017-05-25 21:38:18 -04:00
REGISTER_EMAIL_CONFIRM = false
2020-12-20 02:31:06 +01:00
REGISTER_MANUAL_CONFIRM = false
2017-05-25 21:38:18 -04:00
DISABLE_REGISTRATION = false
ENABLE_CAPTCHA = false
REQUIRE_SIGNIN_VIEW = false
DEFAULT_KEEP_EMAIL_PRIVATE = false
2017-05-08 22:51:53 +03:00
DEFAULT_ALLOW_CREATE_ORGANIZATION = true
2017-05-25 21:38:18 -04:00
NO_REPLY_ADDRESS = noreply.example.org
2019-02-03 02:06:52 +00:00
ENABLE_NOTIFY_MAIL = true
2017-04-25 03:24:51 -04:00
[picture]
2020-06-03 15:07:02 -04:00
DISABLE_GRAVATAR = false
ENABLE_FEDERATED_AVATAR = false
2020-10-14 21:07:51 +08:00
2017-04-25 03:24:51 -04:00
[session]
2020-06-03 15:07:02 -04:00
PROVIDER = file
2022-09-02 15:18:23 -04:00
PROVIDER_CONFIG = tests/ {{ TEST_TYPE }} /gitea- {{ TEST_TYPE }} -mysql/data/sessions
2017-04-25 03:24:51 -04:00
[log]
2022-09-02 15:18:23 -04:00
MODE = {{ TEST_LOGGER }}
2022-01-29 12:41:44 +00:00
ROOT_PATH = {{ REPO_TEST_DIR }} mysql-log
2021-07-14 15:43:13 +01:00
ENABLE_SSH_LOG = true
2023-08-20 09:05:29 +08:00
logger.xorm.MODE = file
2017-04-25 03:24:51 -04:00
2019-04-07 01:25:14 +01:00
[log.test]
LEVEL = Info
COLORIZE = true
2017-04-25 03:24:51 -04:00
[log.file]
2019-04-07 01:25:14 +01:00
LEVEL = Debug
2017-04-25 03:24:51 -04:00
[security]
2020-10-07 14:24:14 -04:00
DISABLE_GIT_HOOKS = false
2017-05-25 21:38:18 -04:00
INSTALL_LOCK = true
SECRET_KEY = 9pCviYTWSb
2020-10-07 14:24:14 -04:00
INTERNAL_TOKEN = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYmYiOjE0OTU1NTE2MTh9.hhSVGOANkaKk3vfCd2jDOIww4pUk0xtg9JRde5UogyQ
2023-12-22 22:29:51 -05:00
DISABLE_QUERY_AUTH_TOKEN = true
2022-05-08 23:51:50 +08:00
2023-03-10 00:13:17 -06:00
[lfs]
PATH = tests/ {{ TEST_TYPE }} /gitea- {{ TEST_TYPE }} -mysql/data/lfs
2022-05-08 23:51:50 +08:00
[packages]
ENABLED = true
2023-01-14 16:57:10 +01:00
[email.incoming]
2023-02-03 01:39:38 +08:00
; temporarily disabled because the incoming mail tests are flaky due to the IMAP server (during integration tests) couldn't be not ready in time sometimes.
2023-01-31 14:56:22 +01:00
ENABLED = false
2023-01-14 16:57:10 +01:00
HOST = smtpimap
PORT = 993
USERNAME = debug@localdomain.test
PASSWORD = debug
USE_TLS = true
SKIP_TLS_VERIFY = true
REPLY_TO_ADDRESS = incoming+% { token}@localhost
2023-05-19 21:37:57 +08:00
[actions]
ENABLED = true
