716fcfcf72
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>
75 lines
1.6 KiB
Go
75 lines
1.6 KiB
Go
// Copyright 2021 The Gitea Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package db
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"code.gitea.io/gitea/modules/util"
|
|
)
|
|
|
|
// ErrCancelled represents an error due to context cancellation
|
|
type ErrCancelled struct {
|
|
Message string
|
|
}
|
|
|
|
// IsErrCancelled checks if an error is a ErrCancelled.
|
|
func IsErrCancelled(err error) bool {
|
|
_, ok := err.(ErrCancelled)
|
|
return ok
|
|
}
|
|
|
|
func (err ErrCancelled) Error() string {
|
|
return "Cancelled: " + err.Message
|
|
}
|
|
|
|
// ErrCancelledf returns an ErrCancelled for the provided format and args
|
|
func ErrCancelledf(format string, args ...interface{}) error {
|
|
return ErrCancelled{
|
|
fmt.Sprintf(format, args...),
|
|
}
|
|
}
|
|
|
|
// ErrSSHDisabled represents an "SSH disabled" error.
|
|
type ErrSSHDisabled struct{}
|
|
|
|
// IsErrSSHDisabled checks if an error is a ErrSSHDisabled.
|
|
func IsErrSSHDisabled(err error) bool {
|
|
_, ok := err.(ErrSSHDisabled)
|
|
return ok
|
|
}
|
|
|
|
func (err ErrSSHDisabled) Error() string {
|
|
return "SSH is disabled"
|
|
}
|
|
|
|
// ErrNotExist represents a non-exist error.
|
|
type ErrNotExist struct {
|
|
Resource string
|
|
ID int64
|
|
}
|
|
|
|
// IsErrNotExist checks if an error is an ErrNotExist
|
|
func IsErrNotExist(err error) bool {
|
|
_, ok := err.(ErrNotExist)
|
|
return ok
|
|
}
|
|
|
|
func (err ErrNotExist) Error() string {
|
|
name := "record"
|
|
if err.Resource != "" {
|
|
name = err.Resource
|
|
}
|
|
|
|
if err.ID != 0 {
|
|
return fmt.Sprintf("%s does not exist [id: %d]", name, err.ID)
|
|
}
|
|
return fmt.Sprintf("%s does not exist", name)
|
|
}
|
|
|
|
// Unwrap unwraps this as a ErrNotExist err
|
|
func (err ErrNotExist) Unwrap() error {
|
|
return util.ErrNotExist
|
|
}
|