mirror of
				https://github.com/go-gitea/gitea.git
				synced 2025-10-25 01:24:13 +02:00 
			
		
		
		
	A lot of our code is repeatedly testing if individual errors are specific types of Not Exist errors. This is repetitative and unnecesary. `Unwrap() error` provides a common way of labelling an error as a NotExist error and we can/should use this. This PR has chosen to use the common `io/fs` errors e.g. `fs.ErrNotExist` for our errors. This is in some ways not completely correct as these are not filesystem errors but it seems like a reasonable thing to do and would allow us to simplify a lot of our code to `errors.Is(err, fs.ErrNotExist)` instead of `package.IsErr...NotExist(err)` I am open to suggestions to use a different base error - perhaps `models/db.ErrNotExist` if that would be felt to be better. Signed-off-by: Andrew Thornton <art27@cantab.net> Co-authored-by: delvh <dev.lh@web.de>
		
			
				
	
	
		
			99 lines
		
	
	
		
			3.0 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			99 lines
		
	
	
		
			3.0 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
| // Copyright 2022 Gitea. All rights reserved.
 | |
| // Use of this source code is governed by a MIT-style
 | |
| // license that can be found in the LICENSE file.
 | |
| 
 | |
| package pull
 | |
| 
 | |
| import (
 | |
| 	"context"
 | |
| 	"fmt"
 | |
| 
 | |
| 	"code.gitea.io/gitea/models/db"
 | |
| 	repo_model "code.gitea.io/gitea/models/repo"
 | |
| 	user_model "code.gitea.io/gitea/models/user"
 | |
| 	"code.gitea.io/gitea/modules/timeutil"
 | |
| )
 | |
| 
 | |
| // AutoMerge represents a pull request scheduled for merging when checks succeed
 | |
| type AutoMerge struct {
 | |
| 	ID          int64                 `xorm:"pk autoincr"`
 | |
| 	PullID      int64                 `xorm:"UNIQUE"`
 | |
| 	DoerID      int64                 `xorm:"NOT NULL"`
 | |
| 	Doer        *user_model.User      `xorm:"-"`
 | |
| 	MergeStyle  repo_model.MergeStyle `xorm:"varchar(30)"`
 | |
| 	Message     string                `xorm:"LONGTEXT"`
 | |
| 	CreatedUnix timeutil.TimeStamp    `xorm:"created"`
 | |
| }
 | |
| 
 | |
| // TableName return database table name for xorm
 | |
| func (AutoMerge) TableName() string {
 | |
| 	return "pull_auto_merge"
 | |
| }
 | |
| 
 | |
| func init() {
 | |
| 	db.RegisterModel(new(AutoMerge))
 | |
| }
 | |
| 
 | |
| // ErrAlreadyScheduledToAutoMerge represents a "PullRequestHasMerged"-error
 | |
| type ErrAlreadyScheduledToAutoMerge struct {
 | |
| 	PullID int64
 | |
| }
 | |
| 
 | |
| func (err ErrAlreadyScheduledToAutoMerge) Error() string {
 | |
| 	return fmt.Sprintf("pull request is already scheduled to auto merge when checks succeed [pull_id: %d]", err.PullID)
 | |
| }
 | |
| 
 | |
| // IsErrAlreadyScheduledToAutoMerge checks if an error is a ErrAlreadyScheduledToAutoMerge.
 | |
| func IsErrAlreadyScheduledToAutoMerge(err error) bool {
 | |
| 	_, ok := err.(ErrAlreadyScheduledToAutoMerge)
 | |
| 	return ok
 | |
| }
 | |
| 
 | |
| // ScheduleAutoMerge schedules a pull request to be merged when all checks succeed
 | |
| func ScheduleAutoMerge(ctx context.Context, doer *user_model.User, pullID int64, style repo_model.MergeStyle, message string) error {
 | |
| 	// Check if we already have a merge scheduled for that pull request
 | |
| 	if exists, _, err := GetScheduledMergeByPullID(ctx, pullID); err != nil {
 | |
| 		return err
 | |
| 	} else if exists {
 | |
| 		return ErrAlreadyScheduledToAutoMerge{PullID: pullID}
 | |
| 	}
 | |
| 
 | |
| 	_, err := db.GetEngine(ctx).Insert(&AutoMerge{
 | |
| 		DoerID:     doer.ID,
 | |
| 		PullID:     pullID,
 | |
| 		MergeStyle: style,
 | |
| 		Message:    message,
 | |
| 	})
 | |
| 	return err
 | |
| }
 | |
| 
 | |
| // GetScheduledMergeByPullID gets a scheduled pull request merge by pull request id
 | |
| func GetScheduledMergeByPullID(ctx context.Context, pullID int64) (bool, *AutoMerge, error) {
 | |
| 	scheduledPRM := &AutoMerge{}
 | |
| 	exists, err := db.GetEngine(ctx).Where("pull_id = ?", pullID).Get(scheduledPRM)
 | |
| 	if err != nil || !exists {
 | |
| 		return false, nil, err
 | |
| 	}
 | |
| 
 | |
| 	doer, err := user_model.GetUserByIDCtx(ctx, scheduledPRM.DoerID)
 | |
| 	if err != nil {
 | |
| 		return false, nil, err
 | |
| 	}
 | |
| 
 | |
| 	scheduledPRM.Doer = doer
 | |
| 	return true, scheduledPRM, nil
 | |
| }
 | |
| 
 | |
| // DeleteScheduledAutoMerge delete a scheduled pull request
 | |
| func DeleteScheduledAutoMerge(ctx context.Context, pullID int64) error {
 | |
| 	exist, scheduledPRM, err := GetScheduledMergeByPullID(ctx, pullID)
 | |
| 	if err != nil {
 | |
| 		return err
 | |
| 	} else if !exist {
 | |
| 		return db.ErrNotExist{Resource: "auto_merge", ID: pullID}
 | |
| 	}
 | |
| 
 | |
| 	_, err = db.GetEngine(ctx).ID(scheduledPRM.ID).Delete(&AutoMerge{})
 | |
| 	return err
 | |
| }
 |