2015-10-18 23:30:39 +00:00
// Copyright 2015 The Gogs Authors. All rights reserved.
2019-04-19 12:17:27 +00:00
// Copyright 2019 The Gitea Authors. All rights reserved.
2022-11-27 18:20:29 +00:00
// SPDX-License-Identifier: MIT
2015-10-18 23:30:39 +00:00
2022-06-13 09:37:59 +00:00
package issues
2015-10-18 23:30:39 +00:00
import (
2021-12-10 01:27:50 +00:00
"context"
2015-10-18 23:30:39 +00:00
"fmt"
2019-12-30 23:34:11 +00:00
"io"
2023-06-08 08:56:05 +00:00
"regexp"
2023-02-03 23:11:48 +00:00
"strconv"
2015-10-18 23:30:39 +00:00
"strings"
2021-09-19 11:49:59 +00:00
"code.gitea.io/gitea/models/db"
2022-06-12 15:51:54 +00:00
git_model "code.gitea.io/gitea/models/git"
2023-06-08 08:56:05 +00:00
org_model "code.gitea.io/gitea/models/organization"
2022-05-08 13:46:34 +00:00
pull_model "code.gitea.io/gitea/models/pull"
2021-12-10 01:27:50 +00:00
repo_model "code.gitea.io/gitea/models/repo"
2021-11-24 09:49:20 +00:00
user_model "code.gitea.io/gitea/models/user"
2021-12-02 07:28:08 +00:00
"code.gitea.io/gitea/modules/git"
2016-11-10 16:24:48 +00:00
"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/setting"
2019-08-15 14:46:21 +00:00
"code.gitea.io/gitea/modules/timeutil"
2021-02-18 02:45:49 +00:00
"code.gitea.io/gitea/modules/util"
2022-05-07 17:05:52 +00:00
"xorm.io/builder"
2015-10-18 23:30:39 +00:00
)
2024-07-29 02:21:22 +00:00
var ErrMustCollaborator = util . NewPermissionDeniedErrorf ( "user must be a collaborator" )
2022-06-13 09:37:59 +00:00
// ErrPullRequestNotExist represents a "PullRequestNotExist" kind of error.
type ErrPullRequestNotExist struct {
ID int64
IssueID int64
HeadRepoID int64
BaseRepoID int64
HeadBranch string
BaseBranch string
}
// IsErrPullRequestNotExist checks if an error is a ErrPullRequestNotExist.
func IsErrPullRequestNotExist ( err error ) bool {
_ , ok := err . ( ErrPullRequestNotExist )
return ok
}
func ( err ErrPullRequestNotExist ) Error ( ) string {
return fmt . Sprintf ( "pull request does not exist [id: %d, issue_id: %d, head_repo_id: %d, base_repo_id: %d, head_branch: %s, base_branch: %s]" ,
err . ID , err . IssueID , err . HeadRepoID , err . BaseRepoID , err . HeadBranch , err . BaseBranch )
}
2022-10-18 05:50:37 +00:00
func ( err ErrPullRequestNotExist ) Unwrap ( ) error {
return util . ErrNotExist
}
2022-06-13 09:37:59 +00:00
// ErrPullRequestAlreadyExists represents a "PullRequestAlreadyExists"-error
type ErrPullRequestAlreadyExists struct {
ID int64
IssueID int64
HeadRepoID int64
BaseRepoID int64
HeadBranch string
BaseBranch string
}
// IsErrPullRequestAlreadyExists checks if an error is a ErrPullRequestAlreadyExists.
func IsErrPullRequestAlreadyExists ( err error ) bool {
_ , ok := err . ( ErrPullRequestAlreadyExists )
return ok
}
// Error does pretty-printing :D
func ( err ErrPullRequestAlreadyExists ) Error ( ) string {
return fmt . Sprintf ( "pull request already exists for these targets [id: %d, issue_id: %d, head_repo_id: %d, base_repo_id: %d, head_branch: %s, base_branch: %s]" ,
err . ID , err . IssueID , err . HeadRepoID , err . BaseRepoID , err . HeadBranch , err . BaseBranch )
}
2022-10-18 05:50:37 +00:00
func ( err ErrPullRequestAlreadyExists ) Unwrap ( ) error {
return util . ErrAlreadyExist
}
2022-06-13 09:37:59 +00:00
// ErrPullWasClosed is used close a closed pull request
type ErrPullWasClosed struct {
ID int64
Index int64
}
// IsErrPullWasClosed checks if an error is a ErrErrPullWasClosed.
func IsErrPullWasClosed ( err error ) bool {
_ , ok := err . ( ErrPullWasClosed )
return ok
}
func ( err ErrPullWasClosed ) Error ( ) string {
return fmt . Sprintf ( "Pull request [%d] %d was already closed" , err . ID , err . Index )
}
2016-11-28 15:31:06 +00:00
// PullRequestType defines pull request type
2015-10-18 23:30:39 +00:00
type PullRequestType int
2016-11-28 15:31:06 +00:00
// Enumerate all the pull request types
2015-10-18 23:30:39 +00:00
const (
2016-11-07 15:37:32 +00:00
PullRequestGitea PullRequestType = iota
PullRequestGit
2015-10-18 23:30:39 +00:00
)
2016-11-28 15:31:06 +00:00
// PullRequestStatus defines pull request status
2015-10-18 23:30:39 +00:00
type PullRequestStatus int
2016-11-28 15:31:06 +00:00
// Enumerate all the pull request status
2015-10-18 23:30:39 +00:00
const (
2016-11-07 15:37:32 +00:00
PullRequestStatusConflict PullRequestStatus = iota
PullRequestStatusChecking
PullRequestStatusMergeable
2017-02-05 13:07:44 +00:00
PullRequestStatusManuallyMerged
2020-01-10 00:14:14 +00:00
PullRequestStatusError
2021-03-04 03:41:23 +00:00
PullRequestStatusEmpty
2022-07-13 08:22:51 +00:00
PullRequestStatusAncestor
2015-10-18 23:30:39 +00:00
)
2023-02-03 23:11:48 +00:00
func ( status PullRequestStatus ) String ( ) string {
switch status {
case PullRequestStatusConflict :
return "CONFLICT"
case PullRequestStatusChecking :
return "CHECKING"
case PullRequestStatusMergeable :
return "MERGEABLE"
case PullRequestStatusManuallyMerged :
return "MANUALLY_MERGED"
case PullRequestStatusError :
return "ERROR"
case PullRequestStatusEmpty :
return "EMPTY"
case PullRequestStatusAncestor :
return "ANCESTOR"
default :
return strconv . Itoa ( int ( status ) )
}
}
2021-07-28 09:42:56 +00:00
// PullRequestFlow the flow of pull request
type PullRequestFlow int
const (
// PullRequestFlowGithub github flow from head branch to base branch
PullRequestFlowGithub PullRequestFlow = iota
// PullRequestFlowAGit Agit flow pull request, head branch is not exist
PullRequestFlowAGit
)
2015-10-18 23:30:39 +00:00
// PullRequest represents relation between pull request and repositories.
type PullRequest struct {
2019-02-05 11:54:49 +00:00
ID int64 ` xorm:"pk autoincr" `
Type PullRequestType
Status PullRequestStatus
ConflictedFiles [ ] string ` xorm:"TEXT JSON" `
2020-04-14 13:53:34 +00:00
CommitsAhead int
CommitsBehind int
2015-10-18 23:30:39 +00:00
2020-10-13 18:50:57 +00:00
ChangedProtectedFiles [ ] string ` xorm:"TEXT JSON" `
2024-05-31 12:10:11 +00:00
IssueID int64 ` xorm:"INDEX" `
Issue * Issue ` xorm:"-" `
Index int64
RequestedReviewers [ ] * user_model . User ` xorm:"-" `
2024-08-05 10:59:53 +00:00
RequestedReviewersTeams [ ] * org_model . Team ` xorm:"-" `
2024-05-31 12:10:11 +00:00
isRequestedReviewersLoaded bool ` xorm:"-" `
2015-10-18 23:30:39 +00:00
2022-04-28 15:45:33 +00:00
HeadRepoID int64 ` xorm:"INDEX" `
HeadRepo * repo_model . Repository ` xorm:"-" `
BaseRepoID int64 ` xorm:"INDEX" `
BaseRepo * repo_model . Repository ` xorm:"-" `
HeadBranch string
HeadCommitID string ` xorm:"-" `
BaseBranch string
2024-01-19 16:05:02 +00:00
MergeBase string ` xorm:"VARCHAR(64)" `
2023-01-16 08:00:22 +00:00
AllowMaintainerEdit bool ` xorm:"NOT NULL DEFAULT false" `
2015-10-18 23:30:39 +00:00
2019-08-15 14:46:21 +00:00
HasMerged bool ` xorm:"INDEX" `
2024-01-19 16:05:02 +00:00
MergedCommitID string ` xorm:"VARCHAR(64)" `
2019-08-15 14:46:21 +00:00
MergerID int64 ` xorm:"INDEX" `
2021-11-24 09:49:20 +00:00
Merger * user_model . User ` xorm:"-" `
2019-08-15 14:46:21 +00:00
MergedUnix timeutil . TimeStamp ` xorm:"updated INDEX" `
2020-03-02 22:31:55 +00:00
isHeadRepoLoaded bool ` xorm:"-" `
2021-07-28 09:42:56 +00:00
Flow PullRequestFlow ` xorm:"NOT NULL DEFAULT 0" `
2015-10-18 23:30:39 +00:00
}
2021-09-19 11:49:59 +00:00
func init ( ) {
db . RegisterModel ( new ( PullRequest ) )
}
2022-06-13 09:37:59 +00:00
// DeletePullsByBaseRepoID deletes all pull requests by the base repository ID
func DeletePullsByBaseRepoID ( ctx context . Context , repoID int64 ) error {
2022-05-08 13:46:34 +00:00
deleteCond := builder . Select ( "id" ) . From ( "pull_request" ) . Where ( builder . Eq { "pull_request.base_repo_id" : repoID } )
// Delete scheduled auto merges
2022-05-20 14:08:52 +00:00
if _ , err := db . GetEngine ( ctx ) . In ( "pull_id" , deleteCond ) .
2022-05-08 13:46:34 +00:00
Delete ( & pull_model . AutoMerge { } ) ; err != nil {
return err
}
// Delete review states
2022-05-20 14:08:52 +00:00
if _ , err := db . GetEngine ( ctx ) . In ( "pull_id" , deleteCond ) .
2022-05-08 13:46:34 +00:00
Delete ( & pull_model . ReviewState { } ) ; err != nil {
return err
}
2022-05-20 14:08:52 +00:00
_ , err := db . DeleteByBean ( ctx , & PullRequest { BaseRepoID : repoID } )
2022-05-08 13:46:34 +00:00
return err
}
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
func ( pr * PullRequest ) String ( ) string {
2023-02-03 23:11:48 +00:00
if pr == nil {
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
return "<PullRequest nil>"
2023-02-03 23:11:48 +00:00
}
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
s := new ( strings . Builder )
fmt . Fprintf ( s , "<PullRequest [%d]" , pr . ID )
2023-02-03 23:11:48 +00:00
if pr . BaseRepo != nil {
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
fmt . Fprintf ( s , "%s#%d[%s..." , pr . BaseRepo . FullName ( ) , pr . Index , pr . BaseBranch )
2023-02-03 23:11:48 +00:00
} else {
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
fmt . Fprintf ( s , "Repo[%d]#%d[%s..." , pr . BaseRepoID , pr . Index , pr . BaseBranch )
2023-02-03 23:11:48 +00:00
}
if pr . HeadRepoID == pr . BaseRepoID {
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
fmt . Fprintf ( s , "%s]" , pr . HeadBranch )
2023-02-03 23:11:48 +00:00
} else if pr . HeadRepo != nil {
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
fmt . Fprintf ( s , "%s:%s]" , pr . HeadRepo . FullName ( ) , pr . HeadBranch )
2023-02-03 23:11:48 +00:00
} else {
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
fmt . Fprintf ( s , "Repo[%d]:%s]" , pr . HeadRepoID , pr . HeadBranch )
2023-02-03 23:11:48 +00:00
}
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
s . WriteByte ( '>' )
return s . String ( )
2023-02-03 23:11:48 +00:00
}
2019-10-18 11:13:31 +00:00
// MustHeadUserName returns the HeadRepo's username if failed return blank
2022-11-19 08:12:33 +00:00
func ( pr * PullRequest ) MustHeadUserName ( ctx context . Context ) string {
if err := pr . LoadHeadRepo ( ctx ) ; err != nil {
2021-12-10 01:27:50 +00:00
if ! repo_model . IsErrRepoNotExist ( err ) {
2020-01-25 02:48:22 +00:00
log . Error ( "LoadHeadRepo: %v" , err )
} else {
log . Warn ( "LoadHeadRepo %d but repository does not exist: %v" , pr . HeadRepoID , err )
}
2019-10-18 11:13:31 +00:00
return ""
}
2020-03-02 22:31:55 +00:00
if pr . HeadRepo == nil {
return ""
}
2020-01-12 09:36:21 +00:00
return pr . HeadRepo . OwnerName
2019-10-18 11:13:31 +00:00
}
2022-11-19 08:12:33 +00:00
// LoadAttributes loads pull request attributes from database
2016-08-14 10:32:24 +00:00
// Note: don't try to get Issue because will end up recursive querying.
2022-11-19 08:12:33 +00:00
func ( pr * PullRequest ) LoadAttributes ( ctx context . Context ) ( err error ) {
2016-08-14 10:32:24 +00:00
if pr . HasMerged && pr . Merger == nil {
2022-12-03 02:48:26 +00:00
pr . Merger , err = user_model . GetUserByID ( ctx , pr . MergerID )
2021-11-24 09:49:20 +00:00
if user_model . IsErrUserNotExist ( err ) {
2023-10-20 14:43:08 +00:00
pr . MergerID = user_model . GhostUserID
2021-11-24 09:49:20 +00:00
pr . Merger = user_model . NewGhostUser ( )
2016-08-14 10:32:24 +00:00
} else if err != nil {
2022-10-24 19:29:17 +00:00
return fmt . Errorf ( "getUserByID [%d]: %w" , pr . MergerID , err )
2016-08-14 10:32:24 +00:00
}
}
return nil
}
2024-09-24 04:14:57 +00:00
func ( pr * PullRequest ) IsAgitFlow ( ) bool {
return pr . Flow == PullRequestFlowAGit
}
2023-02-03 23:11:48 +00:00
// LoadHeadRepo loads the head repository, pr.HeadRepo will remain nil if it does not exist
// and thus ErrRepoNotExist will never be returned
2022-11-19 08:12:33 +00:00
func ( pr * PullRequest ) LoadHeadRepo ( ctx context . Context ) ( err error ) {
2020-03-02 22:31:55 +00:00
if ! pr . isHeadRepoLoaded && pr . HeadRepo == nil && pr . HeadRepoID > 0 {
if pr . HeadRepoID == pr . BaseRepoID {
if pr . BaseRepo != nil {
pr . HeadRepo = pr . BaseRepo
return nil
} else if pr . Issue != nil && pr . Issue . Repo != nil {
pr . HeadRepo = pr . Issue . Repo
return nil
}
2019-10-18 11:13:31 +00:00
}
2020-03-02 22:31:55 +00:00
2022-12-03 02:48:26 +00:00
pr . HeadRepo , err = repo_model . GetRepositoryByID ( ctx , pr . HeadRepoID )
2021-12-10 01:27:50 +00:00
if err != nil && ! repo_model . IsErrRepoNotExist ( err ) { // Head repo maybe deleted, but it should still work
2023-02-03 23:11:48 +00:00
return fmt . Errorf ( "pr[%d].LoadHeadRepo[%d]: %w" , pr . ID , pr . HeadRepoID , err )
2019-09-18 05:39:45 +00:00
}
2020-03-02 22:31:55 +00:00
pr . isHeadRepoLoaded = true
2019-09-18 05:39:45 +00:00
}
return nil
}
2023-05-25 02:06:27 +00:00
// LoadRequestedReviewers loads the requested reviewers.
func ( pr * PullRequest ) LoadRequestedReviewers ( ctx context . Context ) error {
2024-05-31 12:10:11 +00:00
if pr . isRequestedReviewersLoaded || len ( pr . RequestedReviewers ) > 0 {
2023-05-25 02:06:27 +00:00
return nil
}
2023-09-25 13:17:37 +00:00
reviews , err := GetReviewsByIssueID ( ctx , pr . Issue . ID )
2023-05-25 02:06:27 +00:00
if err != nil {
return err
}
2023-07-20 07:18:52 +00:00
if err = reviews . LoadReviewers ( ctx ) ; err != nil {
return err
2023-05-25 02:06:27 +00:00
}
2024-05-31 12:10:11 +00:00
pr . isRequestedReviewersLoaded = true
2023-07-20 07:18:52 +00:00
for _ , review := range reviews {
2024-08-05 10:59:53 +00:00
if review . ReviewerID != 0 {
pr . RequestedReviewers = append ( pr . RequestedReviewers , review . Reviewer )
}
}
return nil
}
// LoadRequestedReviewersTeams loads the requested reviewers teams.
func ( pr * PullRequest ) LoadRequestedReviewersTeams ( ctx context . Context ) error {
reviews , err := GetReviewsByIssueID ( ctx , pr . Issue . ID )
if err != nil {
return err
}
if err = reviews . LoadReviewersTeams ( ctx ) ; err != nil {
return err
}
for _ , review := range reviews {
if review . ReviewerTeamID != 0 {
pr . RequestedReviewersTeams = append ( pr . RequestedReviewersTeams , review . ReviewerTeam )
}
2023-07-20 07:18:52 +00:00
}
2023-05-25 02:06:27 +00:00
return nil
}
2023-02-03 23:11:48 +00:00
// LoadBaseRepo loads the target repository. ErrRepoNotExist may be returned.
2022-11-19 08:12:33 +00:00
func ( pr * PullRequest ) LoadBaseRepo ( ctx context . Context ) ( err error ) {
2020-03-02 22:31:55 +00:00
if pr . BaseRepo != nil {
return nil
}
if pr . HeadRepoID == pr . BaseRepoID && pr . HeadRepo != nil {
pr . BaseRepo = pr . HeadRepo
return nil
}
if pr . Issue != nil && pr . Issue . Repo != nil {
pr . BaseRepo = pr . Issue . Repo
return nil
}
2022-12-03 02:48:26 +00:00
pr . BaseRepo , err = repo_model . GetRepositoryByID ( ctx , pr . BaseRepoID )
2020-03-02 22:31:55 +00:00
if err != nil {
2023-02-03 23:11:48 +00:00
return fmt . Errorf ( "pr[%d].LoadBaseRepo[%d]: %w" , pr . ID , pr . BaseRepoID , err )
2019-10-18 11:13:31 +00:00
}
return nil
}
2016-11-28 15:31:06 +00:00
// LoadIssue loads issue information from database
2022-11-19 08:12:33 +00:00
func ( pr * PullRequest ) LoadIssue ( ctx context . Context ) ( err error ) {
2016-08-16 17:19:09 +00:00
if pr . Issue != nil {
return nil
}
2022-06-13 09:37:59 +00:00
pr . Issue , err = GetIssueByID ( ctx , pr . IssueID )
2019-11-21 17:08:42 +00:00
if err == nil {
pr . Issue . PullRequest = pr
}
2016-08-14 10:32:24 +00:00
return err
}
2020-03-06 03:44:06 +00:00
// ReviewCount represents a count of Reviews
type ReviewCount struct {
IssueID int64
Type ReviewType
Count int64
}
// GetApprovalCounts returns the approval counts by type
// FIXME: Only returns official counts due to double counting of non-official counts
2022-05-20 14:08:52 +00:00
func ( pr * PullRequest ) GetApprovalCounts ( ctx context . Context ) ( [ ] * ReviewCount , error ) {
2020-03-06 03:44:06 +00:00
rCounts := make ( [ ] * ReviewCount , 0 , 6 )
2022-05-20 14:08:52 +00:00
sess := db . GetEngine ( ctx ) . Where ( "issue_id = ?" , pr . IssueID )
2021-02-11 17:32:25 +00:00
return rCounts , sess . Select ( "issue_id, type, count(id) as `count`" ) . Where ( "official = ? AND dismissed = ?" , true , false ) . GroupBy ( "issue_id, type" ) . Table ( "review" ) . Find ( & rCounts )
2020-03-06 03:44:06 +00:00
}
2019-12-30 23:34:11 +00:00
// GetApprovers returns the approvers of the pull request
2023-10-11 04:24:07 +00:00
func ( pr * PullRequest ) GetApprovers ( ctx context . Context ) string {
2019-12-30 23:34:11 +00:00
stringBuilder := strings . Builder { }
2023-10-11 04:24:07 +00:00
if err := pr . getReviewedByLines ( ctx , & stringBuilder ) ; err != nil {
2019-12-30 23:34:11 +00:00
log . Error ( "Unable to getReviewedByLines: Error: %v" , err )
return ""
}
return stringBuilder . String ( )
}
2023-10-11 04:24:07 +00:00
func ( pr * PullRequest ) getReviewedByLines ( ctx context . Context , writer io . Writer ) error {
2019-12-30 23:34:11 +00:00
maxReviewers := setting . Repository . PullRequest . DefaultMergeMessageMaxApprovers
if maxReviewers == 0 {
return nil
}
2023-10-11 04:24:07 +00:00
ctx , committer , err := db . TxContext ( ctx )
2021-11-21 15:41:00 +00:00
if err != nil {
2019-12-30 23:34:11 +00:00
return err
}
2021-11-21 15:41:00 +00:00
defer committer . Close ( )
2019-12-30 23:34:11 +00:00
// Note: This doesn't page as we only expect a very limited number of reviews
2023-06-09 14:34:49 +00:00
reviews , err := FindLatestReviews ( ctx , FindReviewOptions {
2024-10-01 01:58:55 +00:00
Types : [ ] ReviewType { ReviewTypeApprove } ,
2019-12-30 23:34:11 +00:00
IssueID : pr . IssueID ,
OfficialOnly : setting . Repository . PullRequest . DefaultMergeMessageOfficialApproversOnly ,
} )
if err != nil {
log . Error ( "Unable to FindReviews for PR ID %d: %v" , pr . ID , err )
return err
}
reviewersWritten := 0
for _ , review := range reviews {
if maxReviewers > 0 && reviewersWritten > maxReviewers {
break
}
2022-11-19 08:12:33 +00:00
if err := review . LoadReviewer ( ctx ) ; err != nil && ! user_model . IsErrUserNotExist ( err ) {
2019-12-30 23:34:11 +00:00
log . Error ( "Unable to LoadReviewer[%d] for PR ID %d : %v" , review . ReviewerID , pr . ID , err )
return err
} else if review . Reviewer == nil {
continue
}
if _ , err := writer . Write ( [ ] byte ( "Reviewed-by: " ) ) ; err != nil {
return err
}
if _ , err := writer . Write ( [ ] byte ( review . Reviewer . NewGitSig ( ) . String ( ) ) ) ; err != nil {
return err
}
if _ , err := writer . Write ( [ ] byte { '\n' } ) ; err != nil {
return err
}
reviewersWritten ++
}
2021-11-21 15:41:00 +00:00
return committer . Commit ( )
2019-12-30 23:34:11 +00:00
}
2018-01-19 06:18:51 +00:00
// GetGitRefName returns git ref for hidden pull request branch
func ( pr * PullRequest ) GetGitRefName ( ) string {
2021-12-02 19:36:50 +00:00
return fmt . Sprintf ( "%s%d/head" , git . PullPrefix , pr . Index )
2018-01-19 06:18:51 +00:00
}
2023-05-08 06:39:32 +00:00
func ( pr * PullRequest ) GetGitHeadBranchRefName ( ) string {
return fmt . Sprintf ( "%s%s" , git . BranchPrefix , pr . HeadBranch )
}
2024-05-26 04:08:13 +00:00
// GetReviewCommentsCount returns the number of review comments made on the diff of a PR review (not including comments on commits or issues in a PR)
func ( pr * PullRequest ) GetReviewCommentsCount ( ctx context . Context ) int {
opts := FindCommentsOptions {
Type : CommentTypeReview ,
IssueID : pr . IssueID ,
}
conds := opts . ToConds ( )
count , err := db . GetEngine ( ctx ) . Where ( conds ) . Count ( new ( Comment ) )
if err != nil {
return 0
}
return int ( count )
}
2015-10-24 07:36:47 +00:00
// IsChecking returns true if this pull request is still checking conflict.
func ( pr * PullRequest ) IsChecking ( ) bool {
2016-11-07 15:37:32 +00:00
return pr . Status == PullRequestStatusChecking
2015-10-24 07:36:47 +00:00
}
2015-10-18 23:30:39 +00:00
// CanAutoMerge returns true if this pull request can be merged automatically.
func ( pr * PullRequest ) CanAutoMerge ( ) bool {
2016-11-07 15:37:32 +00:00
return pr . Status == PullRequestStatusMergeable
2015-10-18 23:30:39 +00:00
}
2021-03-04 03:41:23 +00:00
// IsEmpty returns true if this pull request is empty.
func ( pr * PullRequest ) IsEmpty ( ) bool {
return pr . Status == PullRequestStatusEmpty
}
2022-07-13 08:22:51 +00:00
// IsAncestor returns true if the Head Commit of this PR is an ancestor of the Base Commit
func ( pr * PullRequest ) IsAncestor ( ) bool {
return pr . Status == PullRequestStatusAncestor
}
Implement actions (#21937)
Close #13539.
Co-authored by: @lunny @appleboy @fuxiaohei and others.
Related projects:
- https://gitea.com/gitea/actions-proto-def
- https://gitea.com/gitea/actions-proto-go
- https://gitea.com/gitea/act
- https://gitea.com/gitea/act_runner
### Summary
The target of this PR is to bring a basic implementation of "Actions",
an internal CI/CD system of Gitea. That means even though it has been
merged, the state of the feature is **EXPERIMENTAL**, and please note
that:
- It is disabled by default;
- It shouldn't be used in a production environment currently;
- It shouldn't be used in a public Gitea instance currently;
- Breaking changes may be made before it's stable.
**Please comment on #13539 if you have any different product design
ideas**, all decisions reached there will be adopted here. But in this
PR, we don't talk about **naming, feature-creep or alternatives**.
### ⚠️ Breaking
`gitea-actions` will become a reserved user name. If a user with the
name already exists in the database, it is recommended to rename it.
### Some important reviews
- What is `DEFAULT_ACTIONS_URL` in `app.ini` for?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1055954954
- Why the api for runners is not under the normal `/api/v1` prefix?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1061173592
- Why DBFS?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1061301178
- Why ignore events triggered by `gitea-actions` bot?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1063254103
- Why there's no permission control for actions?
- https://github.com/go-gitea/gitea/pull/21937#discussion_r1090229868
### What it looks like
<details>
#### Manage runners
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205870657-c72f590e-2e08-4cd4-be7f-2e0abb299bbf.png">
#### List runs
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205872794-50fde990-2b45-48c1-a178-908e4ec5b627.png">
#### View logs
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205872501-9b7b9000-9542-4991-8f55-18ccdada77c3.png">
</details>
### How to try it
<details>
#### 1. Start Gitea
Clone this branch and [install from
source](https://docs.gitea.io/en-us/install-from-source).
Add additional configurations in `app.ini` to enable Actions:
```ini
[actions]
ENABLED = true
```
Start it.
If all is well, you'll see the management page of runners:
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205877365-8e30a780-9b10-4154-b3e8-ee6c3cb35a59.png">
#### 2. Start runner
Clone the [act_runner](https://gitea.com/gitea/act_runner), and follow
the
[README](https://gitea.com/gitea/act_runner/src/branch/main/README.md)
to start it.
If all is well, you'll see a new runner has been added:
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205878000-216f5937-e696-470d-b66c-8473987d91c3.png">
#### 3. Enable actions for a repo
Create a new repo or open an existing one, check the `Actions` checkbox
in settings and submit.
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205879705-53e09208-73c0-4b3e-a123-2dcf9aba4b9c.png">
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205879383-23f3d08f-1a85-41dd-a8b3-54e2ee6453e8.png">
If all is well, you'll see a new tab "Actions":
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205881648-a8072d8c-5803-4d76-b8a8-9b2fb49516c1.png">
#### 4. Upload workflow files
Upload some workflow files to `.gitea/workflows/xxx.yaml`, you can
follow the [quickstart](https://docs.github.com/en/actions/quickstart)
of GitHub Actions. Yes, Gitea Actions is compatible with GitHub Actions
in most cases, you can use the same demo:
```yaml
name: GitHub Actions Demo
run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
on: [push]
jobs:
Explore-GitHub-Actions:
runs-on: ubuntu-latest
steps:
- run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
- run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
- run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
- name: Check out repository code
uses: actions/checkout@v3
- run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
- run: echo "🖥️ The workflow is now ready to test your code on the runner."
- name: List files in the repository
run: |
ls ${{ github.workspace }}
- run: echo "🍏 This job's status is ${{ job.status }}."
```
If all is well, you'll see a new run in `Actions` tab:
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205884473-79a874bc-171b-4aaf-acd5-0241a45c3b53.png">
#### 5. Check the logs of jobs
Click a run and you'll see the logs:
<img width="1792" alt="image"
src="https://user-images.githubusercontent.com/9418365/205884800-994b0374-67f7-48ff-be9a-4c53f3141547.png">
#### 6. Go on
You can try more examples in [the
documents](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions)
of GitHub Actions, then you might find a lot of bugs.
Come on, PRs are welcome.
</details>
See also: [Feature Preview: Gitea
Actions](https://blog.gitea.io/2022/12/feature-preview-gitea-actions/)
---------
Co-authored-by: a1012112796 <1012112796@qq.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: delvh <dev.lh@web.de>
Co-authored-by: ChristopherHX <christopher.homberger@web.de>
Co-authored-by: John Olheiser <john.olheiser@gmail.com>
2023-01-31 01:45:19 +00:00
// IsFromFork return true if this PR is from a fork.
func ( pr * PullRequest ) IsFromFork ( ) bool {
return pr . HeadRepoID != pr . BaseRepoID
}
2019-06-22 17:35:34 +00:00
// SetMerged sets a pull request to merged and closes the corresponding issue
2022-05-03 19:46:28 +00:00
func ( pr * PullRequest ) SetMerged ( ctx context . Context ) ( bool , error ) {
2017-02-05 13:07:44 +00:00
if pr . HasMerged {
2020-02-09 23:09:31 +00:00
return false , fmt . Errorf ( "PullRequest[%d] already merged" , pr . Index )
2017-02-05 13:07:44 +00:00
}
2017-12-11 04:37:04 +00:00
if pr . MergedCommitID == "" || pr . MergedUnix == 0 || pr . Merger == nil {
2020-02-09 23:09:31 +00:00
return false , fmt . Errorf ( "Unable to merge PullRequest[%d], some required fields are empty" , pr . Index )
2017-02-05 13:07:44 +00:00
}
pr . HasMerged = true
2021-11-19 13:39:57 +00:00
sess := db . GetEngine ( ctx )
2017-02-05 13:07:44 +00:00
2020-02-09 23:09:31 +00:00
if _ , err := sess . Exec ( "UPDATE `issue` SET `repo_id` = `repo_id` WHERE `id` = ?" , pr . IssueID ) ; err != nil {
return false , err
2017-02-05 13:07:44 +00:00
}
2020-02-09 23:09:31 +00:00
if _ , err := sess . Exec ( "UPDATE `pull_request` SET `issue_id` = `issue_id` WHERE `id` = ?" , pr . ID ) ; err != nil {
return false , err
2017-02-27 00:42:55 +00:00
}
2020-02-09 23:09:31 +00:00
pr . Issue = nil
2022-11-19 08:12:33 +00:00
if err := pr . LoadIssue ( ctx ) ; err != nil {
2020-02-09 23:09:31 +00:00
return false , err
2017-02-05 13:07:44 +00:00
}
2022-05-20 14:08:52 +00:00
if tmpPr , err := GetPullRequestByID ( ctx , pr . ID ) ; err != nil {
2020-02-09 23:09:31 +00:00
return false , err
} else if tmpPr . HasMerged {
if pr . Issue . IsClosed {
return false , nil
}
return false , fmt . Errorf ( "PullRequest[%d] already merged but it's associated issue [%d] is not closed" , pr . Index , pr . IssueID )
} else if pr . Issue . IsClosed {
return false , fmt . Errorf ( "PullRequest[%d] already closed" , pr . Index )
2017-02-05 13:07:44 +00:00
}
2020-02-09 23:09:31 +00:00
2022-04-08 09:11:15 +00:00
if err := pr . Issue . LoadRepo ( ctx ) ; err != nil {
2020-02-09 23:09:31 +00:00
return false , err
2017-02-05 13:07:44 +00:00
}
2023-02-18 12:11:03 +00:00
if err := pr . Issue . Repo . LoadOwner ( ctx ) ; err != nil {
2020-02-09 23:09:31 +00:00
return false , err
2017-02-05 13:07:44 +00:00
}
2020-02-09 23:09:31 +00:00
2022-03-29 14:57:33 +00:00
if _ , err := changeIssueStatus ( ctx , pr . Issue , pr . Merger , true , true ) ; err != nil {
2022-10-24 19:29:17 +00:00
return false , fmt . Errorf ( "Issue.changeStatus: %w" , err )
2020-02-09 23:09:31 +00:00
}
2022-03-29 16:42:34 +00:00
// reset the conflicted files as there cannot be any if we're merged
pr . ConflictedFiles = [ ] string { }
2021-04-10 08:27:29 +00:00
// We need to save all of the data used to compute this merge as it may have already been changed by TestPatch. FIXME: need to set some state to prevent TestPatch from running whilst we are merging.
2022-03-29 16:42:34 +00:00
if _ , err := sess . Where ( "id = ?" , pr . ID ) . Cols ( "has_merged, status, merge_base, merged_commit_id, merger_id, merged_unix, conflicted_files" ) . Update ( pr ) ; err != nil {
2022-10-24 19:29:17 +00:00
return false , fmt . Errorf ( "Failed to update pr[%d]: %w" , pr . ID , err )
2020-02-09 23:09:31 +00:00
}
return true , nil
2017-02-05 13:07:44 +00:00
}
2015-10-18 23:30:39 +00:00
// NewPullRequest creates new pull request with labels for repository.
2023-08-10 02:39:21 +00:00
func NewPullRequest ( ctx context . Context , repo * repo_model . Repository , issue * Issue , labelIDs [ ] int64 , uuids [ ] string , pr * PullRequest ) ( err error ) {
ctx , committer , err := db . TxContext ( ctx )
2021-11-19 13:39:57 +00:00
if err != nil {
2015-10-18 23:30:39 +00:00
return err
}
2021-11-19 13:39:57 +00:00
defer committer . Close ( )
2015-10-18 23:30:39 +00:00
2022-10-16 10:44:16 +00:00
idx , err := db . GetNextResourceIndex ( ctx , "issue_index" , repo . ID )
if err != nil {
2022-10-24 19:29:17 +00:00
return fmt . Errorf ( "generate pull request index failed: %w" , err )
2022-10-16 10:44:16 +00:00
}
issue . Index = idx
2024-11-14 07:19:14 +00:00
issue . Title , _ = util . SplitStringAtByteN ( issue . Title , 255 )
2022-10-16 10:44:16 +00:00
2022-06-13 09:37:59 +00:00
if err = NewIssueWithIndex ( ctx , issue . Poster , NewIssueOptions {
2016-08-16 01:40:32 +00:00
Repo : repo ,
2021-06-14 02:22:55 +00:00
Issue : issue ,
2017-03-01 01:08:45 +00:00
LabelIDs : labelIDs ,
2016-08-16 01:40:32 +00:00
Attachments : uuids ,
IsPull : true ,
} ) ; err != nil {
2022-06-13 09:37:59 +00:00
if repo_model . IsErrUserDoesNotHaveAccessToRepo ( err ) || IsErrNewIssueInsert ( err ) {
2018-05-09 16:29:04 +00:00
return err
}
2022-10-24 19:29:17 +00:00
return fmt . Errorf ( "newIssue: %w" , err )
2015-10-18 23:30:39 +00:00
}
2021-06-14 02:22:55 +00:00
pr . Index = issue . Index
2015-10-24 07:36:47 +00:00
pr . BaseRepo = repo
2021-06-14 02:22:55 +00:00
pr . IssueID = issue . ID
2021-11-19 13:39:57 +00:00
if err = db . Insert ( ctx , pr ) ; err != nil {
2022-10-24 19:29:17 +00:00
return fmt . Errorf ( "insert pull repo: %w" , err )
2015-10-18 23:30:39 +00:00
}
2021-11-19 13:39:57 +00:00
if err = committer . Commit ( ) ; err != nil {
2022-10-24 19:29:17 +00:00
return fmt . Errorf ( "Commit: %w" , err )
2016-07-15 16:36:39 +00:00
}
return nil
2015-10-18 23:30:39 +00:00
}
2024-07-29 02:21:22 +00:00
// ErrUserMustCollaborator represents an error that the user must be a collaborator to a given repo.
type ErrUserMustCollaborator struct {
UserID int64
RepoName string
}
2017-01-05 00:50:34 +00:00
// GetUnmergedPullRequest returns a pull request that is open and has not been merged
2015-10-18 23:30:39 +00:00
// by given head/base and repo/branch.
2022-11-19 08:12:33 +00:00
func GetUnmergedPullRequest ( ctx context . Context , headRepoID , baseRepoID int64 , headBranch , baseBranch string , flow PullRequestFlow ) ( * PullRequest , error ) {
2015-10-18 23:30:39 +00:00
pr := new ( PullRequest )
2022-11-19 08:12:33 +00:00
has , err := db . GetEngine ( ctx ) .
2021-07-28 09:42:56 +00:00
Where ( "head_repo_id=? AND head_branch=? AND base_repo_id=? AND base_branch=? AND has_merged=? AND flow = ? AND issue.is_closed=?" ,
headRepoID , headBranch , baseRepoID , baseBranch , false , flow , false ) .
2016-11-10 15:16:32 +00:00
Join ( "INNER" , "issue" , "issue.id=pull_request.issue_id" ) .
Get ( pr )
2015-10-18 23:30:39 +00:00
if err != nil {
return nil , err
} else if ! has {
return nil , ErrPullRequestNotExist { 0 , 0 , headRepoID , baseRepoID , headBranch , baseBranch }
}
return pr , nil
}
2019-06-27 14:15:30 +00:00
// GetLatestPullRequestByHeadInfo returns the latest pull request (regardless of its status)
// by given head information (repo and branch).
2023-10-11 04:24:07 +00:00
func GetLatestPullRequestByHeadInfo ( ctx context . Context , repoID int64 , branch string ) ( * PullRequest , error ) {
2019-06-27 14:15:30 +00:00
pr := new ( PullRequest )
2023-10-11 04:24:07 +00:00
has , err := db . GetEngine ( ctx ) .
2021-07-28 09:42:56 +00:00
Where ( "head_repo_id = ? AND head_branch = ? AND flow = ?" , repoID , branch , PullRequestFlowGithub ) .
2019-06-27 14:15:30 +00:00
OrderBy ( "id DESC" ) .
Get ( pr )
if ! has {
return nil , err
}
return pr , err
}
2016-12-02 11:10:39 +00:00
// GetPullRequestByIndex returns a pull request by the given index
2022-05-20 14:08:52 +00:00
func GetPullRequestByIndex ( ctx context . Context , repoID , index int64 ) ( * PullRequest , error ) {
2021-10-05 14:41:48 +00:00
if index < 1 {
return nil , ErrPullRequestNotExist { }
}
2016-12-02 11:10:39 +00:00
pr := & PullRequest {
BaseRepoID : repoID ,
Index : index ,
}
2022-04-28 11:48:48 +00:00
has , err := db . GetEngine ( ctx ) . Get ( pr )
2016-12-02 11:10:39 +00:00
if err != nil {
return nil , err
} else if ! has {
2017-01-01 18:15:09 +00:00
return nil , ErrPullRequestNotExist { 0 , 0 , 0 , repoID , "" , "" }
2016-12-02 11:10:39 +00:00
}
2022-11-19 08:12:33 +00:00
if err = pr . LoadAttributes ( ctx ) ; err != nil {
2016-12-05 11:17:39 +00:00
return nil , err
}
2022-11-19 08:12:33 +00:00
if err = pr . LoadIssue ( ctx ) ; err != nil {
2016-12-05 11:17:39 +00:00
return nil , err
}
2016-12-02 11:10:39 +00:00
return pr , nil
}
2022-05-20 14:08:52 +00:00
// GetPullRequestByID returns a pull request by given ID.
func GetPullRequestByID ( ctx context . Context , id int64 ) ( * PullRequest , error ) {
2015-10-24 07:36:47 +00:00
pr := new ( PullRequest )
2022-05-20 14:08:52 +00:00
has , err := db . GetEngine ( ctx ) . ID ( id ) . Get ( pr )
2015-10-24 07:36:47 +00:00
if err != nil {
return nil , err
} else if ! has {
return nil , ErrPullRequestNotExist { id , 0 , 0 , 0 , "" , "" }
}
2022-11-19 08:12:33 +00:00
return pr , pr . LoadAttributes ( ctx )
2016-08-14 10:32:24 +00:00
}
2020-01-23 17:28:15 +00:00
// GetPullRequestByIssueIDWithNoAttributes returns pull request with no attributes loaded by given issue ID.
2023-10-11 04:24:07 +00:00
func GetPullRequestByIssueIDWithNoAttributes ( ctx context . Context , issueID int64 ) ( * PullRequest , error ) {
2020-01-23 17:28:15 +00:00
var pr PullRequest
2023-10-11 04:24:07 +00:00
has , err := db . GetEngine ( ctx ) . Where ( "issue_id = ?" , issueID ) . Get ( & pr )
2020-01-23 17:28:15 +00:00
if err != nil {
return nil , err
}
if ! has {
return nil , ErrPullRequestNotExist { 0 , issueID , 0 , 0 , "" , "" }
}
return & pr , nil
}
2022-05-20 14:08:52 +00:00
// GetPullRequestByIssueID returns pull request by given issue ID.
func GetPullRequestByIssueID ( ctx context . Context , issueID int64 ) ( * PullRequest , error ) {
2023-12-07 07:27:36 +00:00
pr , exist , err := db . Get [ PullRequest ] ( ctx , builder . Eq { "issue_id" : issueID } )
2015-10-18 23:30:39 +00:00
if err != nil {
return nil , err
2023-12-07 07:27:36 +00:00
} else if ! exist {
2015-10-22 18:47:24 +00:00
return nil , ErrPullRequestNotExist { 0 , issueID , 0 , 0 , "" , "" }
2015-10-18 23:30:39 +00:00
}
2022-11-19 08:12:33 +00:00
return pr , pr . LoadAttributes ( ctx )
2016-08-14 10:32:24 +00:00
}
2024-10-22 00:41:05 +00:00
// GetPullRequestByBaseHeadInfo returns the pull request by given base and head
2024-02-26 02:39:01 +00:00
func GetPullRequestByBaseHeadInfo ( ctx context . Context , baseID , headID int64 , base , head string ) ( * PullRequest , error ) {
pr := & PullRequest { }
sess := db . GetEngine ( ctx ) .
Join ( "INNER" , "issue" , "issue.id = pull_request.issue_id" ) .
Where ( "base_repo_id = ? AND base_branch = ? AND head_repo_id = ? AND head_branch = ?" , baseID , base , headID , head )
has , err := sess . Get ( pr )
if err != nil {
return nil , err
}
if ! has {
return nil , ErrPullRequestNotExist {
HeadRepoID : headID ,
BaseRepoID : baseID ,
HeadBranch : head ,
BaseBranch : base ,
}
}
if err = pr . LoadAttributes ( ctx ) ; err != nil {
return nil , err
}
if err = pr . LoadIssue ( ctx ) ; err != nil {
return nil , err
}
return pr , nil
}
2021-07-28 09:42:56 +00:00
// GetAllUnmergedAgitPullRequestByPoster get all unmerged agit flow pull request
// By poster id.
2023-03-14 07:45:21 +00:00
func GetAllUnmergedAgitPullRequestByPoster ( ctx context . Context , uid int64 ) ( [ ] * PullRequest , error ) {
2021-07-28 09:42:56 +00:00
pulls := make ( [ ] * PullRequest , 0 , 10 )
2023-03-14 07:45:21 +00:00
err := db . GetEngine ( ctx ) .
2021-07-28 09:42:56 +00:00
Where ( "has_merged=? AND flow = ? AND issue.is_closed=? AND issue.poster_id=?" ,
false , PullRequestFlowAGit , false , uid ) .
Join ( "INNER" , "issue" , "issue.id=pull_request.issue_id" ) .
Find ( & pulls )
return pulls , err
}
2015-10-24 07:36:47 +00:00
// Update updates all fields of pull request.
2023-10-11 04:24:07 +00:00
func ( pr * PullRequest ) Update ( ctx context . Context ) error {
_ , err := db . GetEngine ( ctx ) . ID ( pr . ID ) . AllCols ( ) . Update ( pr )
2015-10-24 07:36:47 +00:00
return err
}
2016-11-28 15:31:06 +00:00
// UpdateCols updates specific fields of pull request.
2023-10-11 04:24:07 +00:00
func ( pr * PullRequest ) UpdateCols ( ctx context . Context , cols ... string ) error {
_ , err := db . GetEngine ( ctx ) . ID ( pr . ID ) . Cols ( cols ... ) . Update ( pr )
2015-10-24 07:36:47 +00:00
return err
2020-02-09 23:09:31 +00:00
}
// UpdateColsIfNotMerged updates specific fields of a pull request if it has not been merged
2022-11-19 08:12:33 +00:00
func ( pr * PullRequest ) UpdateColsIfNotMerged ( ctx context . Context , cols ... string ) error {
_ , err := db . GetEngine ( ctx ) . Where ( "id = ? AND has_merged = ?" , pr . ID , false ) . Cols ( cols ... ) . Update ( pr )
2020-02-09 23:09:31 +00:00
return err
2015-10-24 07:36:47 +00:00
}
2018-08-13 19:04:39 +00:00
// IsWorkInProgress determine if the Pull Request is a Work In Progress by its title
2022-11-19 08:12:33 +00:00
// Issue must be set before this method can be called.
2023-10-11 04:24:07 +00:00
func ( pr * PullRequest ) IsWorkInProgress ( ctx context . Context ) bool {
if err := pr . LoadIssue ( ctx ) ; err != nil {
2019-04-02 07:48:31 +00:00
log . Error ( "LoadIssue: %v" , err )
2018-08-13 19:04:39 +00:00
return false
}
2021-06-23 04:14:22 +00:00
return HasWorkInProgressPrefix ( pr . Issue . Title )
}
2018-08-13 19:04:39 +00:00
2021-06-23 04:14:22 +00:00
// HasWorkInProgressPrefix determines if the given PR title has a Work In Progress prefix
func HasWorkInProgressPrefix ( title string ) bool {
2018-08-13 19:04:39 +00:00
for _ , prefix := range setting . Repository . PullRequest . WorkInProgressPrefixes {
Make WIP prefixes case insensitive, e.g. allow `Draft` as a WIP prefix (#19780)
The issue was that only the actual title was converted to uppercase, but
not the prefix as specified in `WORK_IN_PROGRESS_PREFIXES`. As a result,
the following did not work:
WORK_IN_PROGRESS_PREFIXES=Draft:,[Draft],WIP:,[WIP]
One possible workaround was:
WORK_IN_PROGRESS_PREFIXES=DRAFT:,[DRAFT],WIP:,[WIP]
Then indeed one could use `Draft` (as well as `DRAFT`) in the title.
However, the link `Start the title with DRAFT: to prevent the pull request
from being merged accidentally.` showed the suggestion in uppercase; so
it is not possible to show it as `Draft`. This PR fixes it, and allows
to use `Draft` in `WORK_IN_PROGRESS_PREFIXES`.
Fixes #19779.
Co-authored-by: zeripath <art27@cantab.net>
2022-05-26 09:19:24 +00:00
if strings . HasPrefix ( strings . ToUpper ( title ) , strings . ToUpper ( prefix ) ) {
2018-08-13 19:04:39 +00:00
return true
}
}
return false
}
2019-02-05 11:54:49 +00:00
// IsFilesConflicted determines if the Pull Request has changes conflicting with the target branch.
func ( pr * PullRequest ) IsFilesConflicted ( ) bool {
return len ( pr . ConflictedFiles ) > 0
}
2018-08-13 19:04:39 +00:00
// GetWorkInProgressPrefix returns the prefix used to mark the pull request as a work in progress.
// It returns an empty string when none were found
2022-11-19 08:12:33 +00:00
func ( pr * PullRequest ) GetWorkInProgressPrefix ( ctx context . Context ) string {
if err := pr . LoadIssue ( ctx ) ; err != nil {
2019-04-02 07:48:31 +00:00
log . Error ( "LoadIssue: %v" , err )
2018-08-13 19:04:39 +00:00
return ""
}
for _ , prefix := range setting . Repository . PullRequest . WorkInProgressPrefixes {
Make WIP prefixes case insensitive, e.g. allow `Draft` as a WIP prefix (#19780)
The issue was that only the actual title was converted to uppercase, but
not the prefix as specified in `WORK_IN_PROGRESS_PREFIXES`. As a result,
the following did not work:
WORK_IN_PROGRESS_PREFIXES=Draft:,[Draft],WIP:,[WIP]
One possible workaround was:
WORK_IN_PROGRESS_PREFIXES=DRAFT:,[DRAFT],WIP:,[WIP]
Then indeed one could use `Draft` (as well as `DRAFT`) in the title.
However, the link `Start the title with DRAFT: to prevent the pull request
from being merged accidentally.` showed the suggestion in uppercase; so
it is not possible to show it as `Draft`. This PR fixes it, and allows
to use `Draft` in `WORK_IN_PROGRESS_PREFIXES`.
Fixes #19779.
Co-authored-by: zeripath <art27@cantab.net>
2022-05-26 09:19:24 +00:00
if strings . HasPrefix ( strings . ToUpper ( pr . Issue . Title ) , strings . ToUpper ( prefix ) ) {
2018-08-13 19:04:39 +00:00
return pr . Issue . Title [ 0 : len ( prefix ) ]
}
}
return ""
}
2019-12-16 06:20:25 +00:00
2020-04-14 13:53:34 +00:00
// UpdateCommitDivergence update Divergence of a pull request
2022-05-20 14:08:52 +00:00
func ( pr * PullRequest ) UpdateCommitDivergence ( ctx context . Context , ahead , behind int ) error {
2020-04-14 13:53:34 +00:00
if pr . ID == 0 {
return fmt . Errorf ( "pull ID is 0" )
}
pr . CommitsAhead = ahead
pr . CommitsBehind = behind
2022-05-20 14:08:52 +00:00
_ , err := db . GetEngine ( ctx ) . ID ( pr . ID ) . Cols ( "commits_ahead" , "commits_behind" ) . Update ( pr )
2020-04-14 13:53:34 +00:00
return err
}
2020-01-17 06:03:40 +00:00
// IsSameRepo returns true if base repo and head repo is the same
func ( pr * PullRequest ) IsSameRepo ( ) bool {
return pr . BaseRepoID == pr . HeadRepoID
}
2021-02-18 02:45:49 +00:00
2023-02-06 18:09:18 +00:00
// GetBaseBranchLink returns the relative URL of the base branch
2023-10-11 04:24:07 +00:00
func ( pr * PullRequest ) GetBaseBranchLink ( ctx context . Context ) string {
if err := pr . LoadBaseRepo ( ctx ) ; err != nil {
2021-02-18 02:45:49 +00:00
log . Error ( "LoadBaseRepo: %v" , err )
return ""
}
if pr . BaseRepo == nil {
return ""
}
2023-02-06 18:09:18 +00:00
return pr . BaseRepo . Link ( ) + "/src/branch/" + util . PathEscapeSegments ( pr . BaseBranch )
2021-02-18 02:45:49 +00:00
}
2023-02-06 18:09:18 +00:00
// GetHeadBranchLink returns the relative URL of the head branch
2023-10-11 04:24:07 +00:00
func ( pr * PullRequest ) GetHeadBranchLink ( ctx context . Context ) string {
2021-07-28 09:42:56 +00:00
if pr . Flow == PullRequestFlowAGit {
return ""
}
2023-10-11 04:24:07 +00:00
if err := pr . LoadHeadRepo ( ctx ) ; err != nil {
2021-02-18 02:45:49 +00:00
log . Error ( "LoadHeadRepo: %v" , err )
return ""
}
if pr . HeadRepo == nil {
return ""
}
2023-02-06 18:09:18 +00:00
return pr . HeadRepo . Link ( ) + "/src/branch/" + util . PathEscapeSegments ( pr . HeadBranch )
2021-02-18 02:45:49 +00:00
}
2022-04-21 21:55:45 +00:00
2022-04-28 15:45:33 +00:00
// UpdateAllowEdits update if PR can be edited from maintainers
func UpdateAllowEdits ( ctx context . Context , pr * PullRequest ) error {
if _ , err := db . GetEngine ( ctx ) . ID ( pr . ID ) . Cols ( "allow_maintainer_edit" ) . Update ( pr ) ; err != nil {
return err
}
return nil
}
2022-04-21 21:55:45 +00:00
// Mergeable returns if the pullrequest is mergeable.
2023-10-11 04:24:07 +00:00
func ( pr * PullRequest ) Mergeable ( ctx context . Context ) bool {
2024-04-27 08:03:49 +00:00
// If a pull request isn't mergeable if it's:
2022-04-21 21:55:45 +00:00
// - Being conflict checked.
// - Has a conflict.
// - Received a error while being conflict checked.
// - Is a work-in-progress pull request.
return pr . Status != PullRequestStatusChecking && pr . Status != PullRequestStatusConflict &&
2023-10-11 04:24:07 +00:00
pr . Status != PullRequestStatusError && ! pr . IsWorkInProgress ( ctx )
2022-04-21 21:55:45 +00:00
}
2022-06-13 09:37:59 +00:00
// HasEnoughApprovals returns true if pr has enough granted approvals.
func HasEnoughApprovals ( ctx context . Context , protectBranch * git_model . ProtectedBranch , pr * PullRequest ) bool {
if protectBranch . RequiredApprovals == 0 {
return true
}
return GetGrantedApprovalsCount ( ctx , protectBranch , pr ) >= protectBranch . RequiredApprovals
}
// GetGrantedApprovalsCount returns the number of granted approvals for pr. A granted approval must be authored by a user in an approval whitelist.
func GetGrantedApprovalsCount ( ctx context . Context , protectBranch * git_model . ProtectedBranch , pr * PullRequest ) int64 {
sess := db . GetEngine ( ctx ) . Where ( "issue_id = ?" , pr . IssueID ) .
And ( "type = ?" , ReviewTypeApprove ) .
And ( "official = ?" , true ) .
And ( "dismissed = ?" , false )
2024-01-15 07:20:01 +00:00
if protectBranch . IgnoreStaleApprovals {
2022-06-13 09:37:59 +00:00
sess = sess . And ( "stale = ?" , false )
}
approvals , err := sess . Count ( new ( Review ) )
if err != nil {
log . Error ( "GetGrantedApprovalsCount: %v" , err )
return 0
}
return approvals
}
// MergeBlockedByRejectedReview returns true if merge is blocked by rejected reviews
func MergeBlockedByRejectedReview ( ctx context . Context , protectBranch * git_model . ProtectedBranch , pr * PullRequest ) bool {
if ! protectBranch . BlockOnRejectedReviews {
return false
}
rejectExist , err := db . GetEngine ( ctx ) . Where ( "issue_id = ?" , pr . IssueID ) .
And ( "type = ?" , ReviewTypeReject ) .
And ( "official = ?" , true ) .
And ( "dismissed = ?" , false ) .
Exist ( new ( Review ) )
if err != nil {
log . Error ( "MergeBlockedByRejectedReview: %v" , err )
return true
}
return rejectExist
}
// MergeBlockedByOfficialReviewRequests block merge because of some review request to official reviewer
// of from official review
func MergeBlockedByOfficialReviewRequests ( ctx context . Context , protectBranch * git_model . ProtectedBranch , pr * PullRequest ) bool {
if ! protectBranch . BlockOnOfficialReviewRequests {
return false
}
has , err := db . GetEngine ( ctx ) . Where ( "issue_id = ?" , pr . IssueID ) .
And ( "type = ?" , ReviewTypeRequest ) .
And ( "official = ?" , true ) .
Exist ( new ( Review ) )
if err != nil {
log . Error ( "MergeBlockedByOfficialReviewRequests: %v" , err )
return true
}
return has
}
// MergeBlockedByOutdatedBranch returns true if merge is blocked by an outdated head branch
func MergeBlockedByOutdatedBranch ( protectBranch * git_model . ProtectedBranch , pr * PullRequest ) bool {
return protectBranch . BlockOnOutdatedBranch && pr . CommitsBehind > 0
}
2023-06-08 08:56:05 +00:00
// GetCodeOwnersFromContent returns the code owners configuration
// Return empty slice if files missing
// Return warning messages on parsing errors
// We're trying to do the best we can when parsing a file.
// Invalid lines are skipped. Non-existent users and teams too.
func GetCodeOwnersFromContent ( ctx context . Context , data string ) ( [ ] * CodeOwnerRule , [ ] string ) {
if len ( data ) == 0 {
return nil , nil
}
rules := make ( [ ] * CodeOwnerRule , 0 )
lines := strings . Split ( data , "\n" )
warnings := make ( [ ] string , 0 )
for i , line := range lines {
tokens := TokenizeCodeOwnersLine ( line )
if len ( tokens ) == 0 {
continue
} else if len ( tokens ) < 2 {
warnings = append ( warnings , fmt . Sprintf ( "Line: %d: incorrect format" , i + 1 ) )
continue
}
rule , wr := ParseCodeOwnersLine ( ctx , tokens )
for _ , w := range wr {
warnings = append ( warnings , fmt . Sprintf ( "Line: %d: %s" , i + 1 , w ) )
}
if rule == nil {
continue
}
rules = append ( rules , rule )
}
return rules , warnings
}
type CodeOwnerRule struct {
Rule * regexp . Regexp
Negative bool
Users [ ] * user_model . User
Teams [ ] * org_model . Team
}
func ParseCodeOwnersLine ( ctx context . Context , tokens [ ] string ) ( * CodeOwnerRule , [ ] string ) {
var err error
rule := & CodeOwnerRule {
Users : make ( [ ] * user_model . User , 0 ) ,
Teams : make ( [ ] * org_model . Team , 0 ) ,
Negative : strings . HasPrefix ( tokens [ 0 ] , "!" ) ,
}
warnings := make ( [ ] string , 0 )
rule . Rule , err = regexp . Compile ( fmt . Sprintf ( "^%s$" , strings . TrimPrefix ( tokens [ 0 ] , "!" ) ) )
if err != nil {
warnings = append ( warnings , fmt . Sprintf ( "incorrect codeowner regexp: %s" , err ) )
return nil , warnings
}
for _ , user := range tokens [ 1 : ] {
user = strings . TrimPrefix ( user , "@" )
// Only @org/team can contain slashes
if strings . Contains ( user , "/" ) {
s := strings . Split ( user , "/" )
if len ( s ) != 2 {
warnings = append ( warnings , fmt . Sprintf ( "incorrect codeowner group: %s" , user ) )
continue
}
orgName := s [ 0 ]
teamName := s [ 1 ]
org , err := org_model . GetOrgByName ( ctx , orgName )
if err != nil {
warnings = append ( warnings , fmt . Sprintf ( "incorrect codeowner organization: %s" , user ) )
continue
}
2023-10-03 10:30:41 +00:00
teams , err := org . LoadTeams ( ctx )
2023-06-08 08:56:05 +00:00
if err != nil {
warnings = append ( warnings , fmt . Sprintf ( "incorrect codeowner team: %s" , user ) )
continue
}
for _ , team := range teams {
if team . Name == teamName {
rule . Teams = append ( rule . Teams , team )
}
}
} else {
u , err := user_model . GetUserByName ( ctx , user )
if err != nil {
warnings = append ( warnings , fmt . Sprintf ( "incorrect codeowner user: %s" , user ) )
continue
}
rule . Users = append ( rule . Users , u )
}
}
if ( len ( rule . Users ) == 0 ) && ( len ( rule . Teams ) == 0 ) {
warnings = append ( warnings , "no users/groups matched" )
return nil , warnings
}
return rule , warnings
}
func TokenizeCodeOwnersLine ( line string ) [ ] string {
if len ( line ) == 0 {
return nil
}
line = strings . TrimSpace ( line )
line = strings . ReplaceAll ( line , "\t" , " " )
tokens := make ( [ ] string , 0 )
escape := false
token := ""
for _ , char := range line {
if escape {
token += string ( char )
escape = false
} else if string ( char ) == "\\" {
escape = true
} else if string ( char ) == "#" {
break
} else if string ( char ) == " " {
if len ( token ) > 0 {
tokens = append ( tokens , token )
token = ""
}
} else {
token += string ( char )
}
}
if len ( token ) > 0 {
tokens = append ( tokens , token )
}
return tokens
}
2023-09-08 21:09:23 +00:00
// InsertPullRequests inserted pull requests
func InsertPullRequests ( ctx context . Context , prs ... * PullRequest ) error {
ctx , committer , err := db . TxContext ( ctx )
if err != nil {
return err
}
defer committer . Close ( )
sess := db . GetEngine ( ctx )
for _ , pr := range prs {
if err := insertIssue ( ctx , pr . Issue ) ; err != nil {
return err
}
pr . IssueID = pr . Issue . ID
if _ , err := sess . NoAutoTime ( ) . Insert ( pr ) ; err != nil {
return err
}
}
return committer . Commit ( )
}
2024-02-24 08:18:39 +00:00
// GetPullRequestByMergedCommit returns a merged pull request by the given commit
func GetPullRequestByMergedCommit ( ctx context . Context , repoID int64 , sha string ) ( * PullRequest , error ) {
pr := new ( PullRequest )
has , err := db . GetEngine ( ctx ) . Where ( "base_repo_id = ? AND merged_commit_id = ?" , repoID , sha ) . Get ( pr )
if err != nil {
return nil , err
} else if ! has {
return nil , ErrPullRequestNotExist { 0 , 0 , 0 , repoID , "" , "" }
}
if err = pr . LoadAttributes ( ctx ) ; err != nil {
return nil , err
}
if err = pr . LoadIssue ( ctx ) ; err != nil {
return nil , err
}
return pr , nil
}