2023-02-19 16:12:01 +00:00
// Copyright 2023 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package setting
import (
2023-04-25 15:06:39 +00:00
"fmt"
"os"
"path/filepath"
"strings"
2023-02-19 16:12:01 +00:00
"code.gitea.io/gitea/modules/log"
2023-04-25 15:06:39 +00:00
"code.gitea.io/gitea/modules/util"
2023-02-19 16:12:01 +00:00
ini "gopkg.in/ini.v1"
)
2023-04-25 15:06:39 +00:00
type C onfigSection interface {
Name ( ) string
MapTo ( interface { } ) error
HasKey ( key string ) bool
NewKey ( name , value string ) ( * ini . Key , error )
Key ( key string ) * ini . Key
Keys ( ) [ ] * ini . Key
ChildSections ( ) [ ] * ini . Section
}
2023-02-19 16:12:01 +00:00
// ConfigProvider represents a config provider
type ConfigProvider interface {
2023-04-25 15:06:39 +00:00
Section ( section string ) ConfigSection
NewSection ( name string ) ( ConfigSection , error )
GetSection ( name string ) ( ConfigSection , error )
Save ( ) error
}
Rewrite logger system (#24726)
## ⚠️ Breaking
The `log.<mode>.<logger>` style config has been dropped. If you used it,
please check the new config manual & app.example.ini to make your
instance output logs as expected.
Although many legacy options still work, it's encouraged to upgrade to
the new options.
The SMTP logger is deleted because SMTP is not suitable to collect logs.
If you have manually configured Gitea log options, please confirm the
logger system works as expected after upgrading.
## Description
Close #12082 and maybe more log-related issues, resolve some related
FIXMEs in old code (which seems unfixable before)
Just like rewriting queue #24505 : make code maintainable, clear legacy
bugs, and add the ability to support more writers (eg: JSON, structured
log)
There is a new document (with examples): `logging-config.en-us.md`
This PR is safer than the queue rewriting, because it's just for
logging, it won't break other logic.
## The old problems
The logging system is quite old and difficult to maintain:
* Unclear concepts: Logger, NamedLogger, MultiChannelledLogger,
SubLogger, EventLogger, WriterLogger etc
* Some code is diffuclt to konw whether it is right:
`log.DelNamedLogger("console")` vs `log.DelNamedLogger(log.DEFAULT)` vs
`log.DelLogger("console")`
* The old system heavily depends on ini config system, it's difficult to
create new logger for different purpose, and it's very fragile.
* The "color" trick is difficult to use and read, many colors are
unnecessary, and in the future structured log could help
* It's difficult to add other log formats, eg: JSON format
* The log outputer doesn't have full control of its goroutine, it's
difficult to make outputer have advanced behaviors
* The logs could be lost in some cases: eg: no Fatal error when using
CLI.
* Config options are passed by JSON, which is quite fragile.
* INI package makes the KEY in `[log]` section visible in `[log.sub1]`
and `[log.sub1.subA]`, this behavior is quite fragile and would cause
more unclear problems, and there is no strong requirement to support
`log.<mode>.<logger>` syntax.
## The new design
See `logger.go` for documents.
## Screenshot
<details>
![image](https://github.com/go-gitea/gitea/assets/2114189/4462d713-ba39-41f5-bb08-de912e67e1ff)
![image](https://github.com/go-gitea/gitea/assets/2114189/b188035e-f691-428b-8b2d-ff7b2199b2f9)
![image](https://github.com/go-gitea/gitea/assets/2114189/132e9745-1c3b-4e00-9e0d-15eaea495dee)
</details>
## TODO
* [x] add some new tests
* [x] fix some tests
* [x] test some sub-commands (manually ....)
---------
Co-authored-by: Jason Song <i@wolfogre.com>
Co-authored-by: delvh <dev.lh@web.de>
Co-authored-by: Giteabot <teabot@gitea.io>
2023-05-21 22:35:11 +00:00
// ConfigSectionKey only searches the keys in the given section, but it is O(n).
// ini package has a special behavior: with "[sec] a=1" and an empty "[sec.sub]",
// then in "[sec.sub]", Key()/HasKey() can always see "a=1" because it always tries parent sections.
// It returns nil if the key doesn't exist.
func ConfigSectionKey ( sec ConfigSection , key string ) * ini . Key {
if sec == nil {
return nil
}
for _ , k := range sec . Keys ( ) {
if k . Name ( ) == key {
return k
}
}
return nil
}
func ConfigSectionKeyString ( sec ConfigSection , key string , def ... string ) string {
k := ConfigSectionKey ( sec , key )
if k != nil && k . String ( ) != "" {
return k . String ( )
}
if len ( def ) > 0 {
return def [ 0 ]
}
return ""
}
// ConfigInheritedKey works like ini.Section.Key(), but it always returns a new key instance, it is O(n) because NewKey is O(n)
// and the returned key is safe to be used with "MustXxx", it doesn't change the parent's values.
// Otherwise, ini.Section.Key().MustXxx would pollute the parent section's keys.
// It never returns nil.
func ConfigInheritedKey ( sec ConfigSection , key string ) * ini . Key {
k := sec . Key ( key )
if k != nil && k . String ( ) != "" {
newKey , _ := sec . NewKey ( k . Name ( ) , k . String ( ) )
return newKey
}
newKey , _ := sec . NewKey ( key , "" )
return newKey
}
func ConfigInheritedKeyString ( sec ConfigSection , key string , def ... string ) string {
k := sec . Key ( key )
if k != nil && k . String ( ) != "" {
return k . String ( )
}
if len ( def ) > 0 {
return def [ 0 ]
}
return ""
}
2023-04-25 15:06:39 +00:00
type iniFileConfigProvider struct {
2023-05-04 03:55:35 +00:00
opts * Options
2023-04-25 15:06:39 +00:00
* ini . File
2023-05-04 03:55:35 +00:00
newFile bool // whether the file has not existed previously
2023-04-25 15:06:39 +00:00
}
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 11:49:59 +00:00
// NewConfigProviderFromData this function is only for testing
func NewConfigProviderFromData ( configContent string ) ( ConfigProvider , error ) {
2023-04-25 15:06:39 +00:00
var cfg * ini . File
var err error
if configContent == "" {
cfg = ini . Empty ( )
} else {
cfg , err = ini . Load ( strings . NewReader ( configContent ) )
if err != nil {
return nil , err
}
}
cfg . NameMapper = ini . SnackCase
return & iniFileConfigProvider {
File : cfg ,
newFile : true ,
} , nil
}
2023-05-04 03:55:35 +00:00
type Options struct {
CustomConf string // the ini file path
AllowEmpty bool // whether not finding configuration files is allowed (only true for the tests)
ExtraConfig string
DisableLoadCommonSettings bool
}
2023-04-25 15:06:39 +00:00
// newConfigProviderFromFile load configuration from file.
// NOTE: do not print any log except error.
2023-05-04 03:55:35 +00:00
func newConfigProviderFromFile ( opts * Options ) ( * iniFileConfigProvider , error ) {
2023-04-25 15:06:39 +00:00
cfg := ini . Empty ( )
newFile := true
2023-05-04 03:55:35 +00:00
if opts . CustomConf != "" {
isFile , err := util . IsFile ( opts . CustomConf )
2023-04-25 15:06:39 +00:00
if err != nil {
2023-05-04 03:55:35 +00:00
return nil , fmt . Errorf ( "unable to check if %s is a file. Error: %v" , opts . CustomConf , err )
2023-04-25 15:06:39 +00:00
}
if isFile {
2023-05-04 03:55:35 +00:00
if err := cfg . Append ( opts . CustomConf ) ; err != nil {
return nil , fmt . Errorf ( "failed to load custom conf '%s': %v" , opts . CustomConf , err )
2023-04-25 15:06:39 +00:00
}
newFile = false
}
}
2023-05-04 03:55:35 +00:00
if newFile && ! opts . AllowEmpty {
2023-04-25 15:06:39 +00:00
return nil , fmt . Errorf ( "unable to find configuration file: %q, please ensure you are running in the correct environment or set the correct configuration file with -c" , CustomConf )
}
2023-05-04 03:55:35 +00:00
if opts . ExtraConfig != "" {
if err := cfg . Append ( [ ] byte ( opts . ExtraConfig ) ) ; err != nil {
2023-04-25 15:06:39 +00:00
return nil , fmt . Errorf ( "unable to append more config: %v" , err )
}
}
cfg . NameMapper = ini . SnackCase
return & iniFileConfigProvider {
2023-05-04 03:55:35 +00:00
opts : opts ,
File : cfg ,
newFile : newFile ,
2023-04-25 15:06:39 +00:00
} , nil
}
func ( p * iniFileConfigProvider ) Section ( section string ) ConfigSection {
return p . File . Section ( section )
}
func ( p * iniFileConfigProvider ) NewSection ( name string ) ( ConfigSection , error ) {
return p . File . NewSection ( name )
}
func ( p * iniFileConfigProvider ) GetSection ( name string ) ( ConfigSection , error ) {
return p . File . GetSection ( name )
}
// Save save the content into file
func ( p * iniFileConfigProvider ) Save ( ) error {
2023-05-04 03:55:35 +00:00
if p . opts . CustomConf == "" {
if ! p . opts . AllowEmpty {
2023-04-25 15:06:39 +00:00
return fmt . Errorf ( "custom config path must not be empty" )
}
return nil
}
if p . newFile {
if err := os . MkdirAll ( filepath . Dir ( CustomConf ) , os . ModePerm ) ; err != nil {
return fmt . Errorf ( "failed to create '%s': %v" , CustomConf , err )
}
}
2023-05-04 03:55:35 +00:00
if err := p . SaveTo ( p . opts . CustomConf ) ; err != nil {
return fmt . Errorf ( "failed to save '%s': %v" , p . opts . CustomConf , err )
2023-04-25 15:06:39 +00:00
}
// Change permissions to be more restrictive
fi , err := os . Stat ( CustomConf )
if err != nil {
return fmt . Errorf ( "failed to determine current conf file permissions: %v" , err )
}
if fi . Mode ( ) . Perm ( ) > 0 o600 {
if err = os . Chmod ( CustomConf , 0 o600 ) ; err != nil {
log . Warn ( "Failed changing conf file permissions to -rw-------. Consider changing them manually." )
}
}
return nil
2023-02-19 16:12:01 +00:00
}
// a file is an implementation ConfigProvider and other implementations are possible, i.e. from docker, k8s, …
2023-04-25 15:06:39 +00:00
var _ ConfigProvider = & iniFileConfigProvider { }
2023-02-19 16:12:01 +00:00
func mustMapSetting ( rootCfg ConfigProvider , sectionName string , setting interface { } ) {
if err := rootCfg . Section ( sectionName ) . MapTo ( setting ) ; err != nil {
log . Fatal ( "Failed to map %s settings: %v" , sectionName , err )
}
}
2023-02-20 22:18:26 +00:00
func deprecatedSetting ( rootCfg ConfigProvider , oldSection , oldKey , newSection , newKey , version string ) {
2023-02-19 16:12:01 +00:00
if rootCfg . Section ( oldSection ) . HasKey ( oldKey ) {
2023-02-20 22:18:26 +00:00
log . Error ( "Deprecated fallback `[%s]` `%s` present. Use `[%s]` `%s` instead. This fallback will be/has been removed in %s" , oldSection , oldKey , newSection , newKey , version )
2023-02-19 16:12:01 +00:00
}
}
// deprecatedSettingDB add a hint that the configuration has been moved to database but still kept in app.ini
func deprecatedSettingDB ( rootCfg ConfigProvider , oldSection , oldKey string ) {
if rootCfg . Section ( oldSection ) . HasKey ( oldKey ) {
log . Error ( "Deprecated `[%s]` `%s` present which has been copied to database table sys_setting" , oldSection , oldKey )
}
}