Skip to content

Commit

Permalink
♻️ remove function when exported value returns a static error
Browse files Browse the repository at this point in the history
Signed-off-by: vankichi <kyukawa315@gmail.com>
  • Loading branch information
vankichi committed Nov 29, 2022
1 parent b719a95 commit f834faf
Show file tree
Hide file tree
Showing 25 changed files with 92 additions and 126 deletions.
2 changes: 1 addition & 1 deletion internal/db/nosql/cassandra/cassandra.go
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ func WrapErrorWithKeys(err error, keys ...string) error {
case ErrNotFound:
return errors.ErrCassandraNotFound(keys...)
case ErrUnavailable:
return errors.ErrCassandraUnavailable()
return errors.ErrCassandraUnavailable
case ErrUnsupported:
return err
case ErrTooManyStmts:
Expand Down
2 changes: 1 addition & 1 deletion internal/db/nosql/cassandra/cassandra_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2219,7 +2219,7 @@ func TestWrapErrorWithKeys(t *testing.T) {
err: ErrUnavailable,
},
want: want{
err: errors.ErrCassandraUnavailable(),
err: errors.ErrCassandraUnavailable,
},
},
{
Expand Down
20 changes: 8 additions & 12 deletions internal/errors/cassandra.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,14 @@ var (
return Errorf("consistetncy type %q is not defined", consistency)
}

// NewErrCassandraNotFoundIdentity represents a function to generate an error of cassandra entry not found.
NewErrCassandraNotFoundIdentity = func() error {
return &ErrCassandraNotFoundIdentity{
err: New("cassandra entry not found"),
}
// NewErrCassandraNotFoundIdentity generates an error of cassandra entry not found.
NewErrCassandraNotFoundIdentity = &ErrCassandraNotFoundIdentity{
err: New("cassandra entry not found"),
}

// NewErrCassandraUnavailableIdentity represents a function to generate an error of cassandra unavailable.
NewErrCassandraUnavailableIdentity = func() error {
return &ErrCassandraUnavailableIdentity{
err: New("cassandra unavailable"),
}
// NewErrCassandraUnavailableIdentity generates an error of cassandra unavailable.
NewErrCassandraUnavailableIdentity = &ErrCassandraUnavailableIdentity{
err: New("cassandra unavailable"),
}

// ErrCassandraUnavailable represents NewErrCassandraUnavailableIdentity.
Expand All @@ -44,9 +40,9 @@ var (
ErrCassandraNotFound = func(keys ...string) error {
switch {
case len(keys) == 1:
return Wrapf(NewErrCassandraNotFoundIdentity(), "cassandra key '%s' not found", keys[0])
return Wrapf(NewErrCassandraNotFoundIdentity, "cassandra key '%s' not found", keys[0])
case len(keys) > 1:
return Wrapf(NewErrCassandraNotFoundIdentity(), "cassandra keys '%v' not found", keys)
return Wrapf(NewErrCassandraNotFoundIdentity, "cassandra keys '%v' not found", keys)
default:
return nil
}
Expand Down
6 changes: 3 additions & 3 deletions internal/errors/cassandra_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ func TestNewErrCassandraNotFoundIdentity(t *testing.T) {
checkFunc = defaultCheckFunc
}

got := NewErrCassandraNotFoundIdentity()
got := NewErrCassandraNotFoundIdentity
if err := checkFunc(test.want, got); err != nil {
tt.Errorf("error = %v", err)
}
Expand Down Expand Up @@ -180,7 +180,7 @@ func TestNewErrCassandraUnavailableIdentity(t *testing.T) {
checkFunc = defaultCheckFunc
}

got := NewErrCassandraUnavailableIdentity()
got := NewErrCassandraUnavailableIdentity
if err := checkFunc(test.want, got); err != nil {
tt.Errorf("error = %v", err)
}
Expand Down Expand Up @@ -230,7 +230,7 @@ func TestErrCassandraUnavailable(t *testing.T) {
checkFunc = defaultCheckFunc
}

got := ErrCassandraUnavailable()
got := ErrCassandraUnavailable
if err := checkFunc(test.want, got); err != nil {
tt.Errorf("error = %v", err)
}
Expand Down
12 changes: 4 additions & 8 deletions internal/errors/compressor.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,9 @@ var (
// ErrDecompressFailed returns an error of decompressing failed.
ErrDecompressFailed = New("decompress failed")

// ErrCompressorRegistererIsNotRunning represents a function to generate an error of compressor registerers is not running.
ErrCompressorRegistererIsNotRunning = func() error {
return New("compressor registerers is not running")
}
// ErrCompressorRegistererIsNotRunning generates an error of compressor registerers is not running.
ErrCompressorRegistererIsNotRunning = New("compressor registerers is not running")

// ErrCompressorRegistererChannelIsFull represents a function to generate an error that compressor registerer channel is full.
ErrCompressorRegistererChannelIsFull = func() error {
return New("compressor registerer channel is full")
}
// ErrCompressorRegistererChannelIsFull generates an error that compressor registerer channel is full.
ErrCompressorRegistererChannelIsFull = New("compressor registerer channel is full")
)
4 changes: 2 additions & 2 deletions internal/errors/compressor_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ func TestErrCompressorRegistererIsNotRunning(t *testing.T) {
checkFunc = defaultCheckFunc
}

got := ErrCompressorRegistererIsNotRunning()
got := ErrCompressorRegistererIsNotRunning
if err := checkFunc(test.want, got); err != nil {
tt.Errorf("error = %v", err)
}
Expand Down Expand Up @@ -252,7 +252,7 @@ func TestErrCompressorRegistererChannelIsFull(t *testing.T) {
checkFunc = defaultCheckFunc
}

got := ErrCompressorRegistererChannelIsFull()
got := ErrCompressorRegistererChannelIsFull
if err := checkFunc(test.want, got); err != nil {
tt.Errorf("error = %v", err)
}
Expand Down
4 changes: 1 addition & 3 deletions internal/errors/info.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,5 @@ var (
}

// ErrRuntimeFuncNil represents an error that the runtime function is nil.
ErrRuntimeFuncNil = func() error {
return New("runtime function is nil")
}
ErrRuntimeFuncNil = New("runtime function is nil")
)
2 changes: 1 addition & 1 deletion internal/errors/info_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ func TestErrRuntimeFuncNil(t *testing.T) {
checkFunc = defaultCheckFunc
}

got := ErrRuntimeFuncNil()
got := ErrRuntimeFuncNil
if err := checkFunc(test.want, got); err != nil {
tt.Errorf("error = %v", err)
}
Expand Down
14 changes: 4 additions & 10 deletions internal/errors/io.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,11 @@ package errors

var (
// NewErrContextNotProvided represents a function to generate an error that the context is not provided.
NewErrContextNotProvided = func() error {
return New("context not provided")
}
NewErrContextNotProvided = New("context not provided")

// NewErrReaderNotProvided represents a function to generate an error that the io.Reader is not provided.
NewErrReaderNotProvided = func() error {
return New("io.Reader not provided")
}
NewErrReaderNotProvided = New("io.Reader not provided")

// NewErrWriterNotProvided represents a function to generate an error that the io.Writer is not provided.
NewErrWriterNotProvided = func() error {
return New("io.Writer not provided")
}
// NewErrWriterNotProvided represents an error that the io.Writer is not provided.
NewErrWriterNotProvided = New("io.Writer not provided")
)
6 changes: 3 additions & 3 deletions internal/errors/io_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ func TestNewErrContextNotProvided(t *testing.T) {
checkFunc = defaultCheckFunc
}

got := NewErrContextNotProvided()
got := NewErrContextNotProvided
if err := checkFunc(test.want, got); err != nil {
tt.Errorf("error = %v", err)
}
Expand Down Expand Up @@ -103,7 +103,7 @@ func TestNewErrReaderNotProvided(t *testing.T) {
checkFunc = defaultCheckFunc
}

got := NewErrReaderNotProvided()
got := NewErrReaderNotProvided
if err := checkFunc(test.want, got); err != nil {
tt.Errorf("error = %v", err)
}
Expand Down Expand Up @@ -151,7 +151,7 @@ func TestNewErrWriterNotProvided(t *testing.T) {
checkFunc = defaultCheckFunc
}

got := NewErrWriterNotProvided()
got := NewErrWriterNotProvided
if err := checkFunc(test.want, got); err != nil {
tt.Errorf("error = %v", err)
}
Expand Down
20 changes: 8 additions & 12 deletions internal/errors/mysql.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,9 @@ var (
// ErrMySQLConnectionPingFailed represents an error that the ping failed.
ErrMySQLConnectionPingFailed = New("error MySQL connection ping failed")

// NewErrMySQLNotFoundIdentity represents a function to generate an error that the element is not found.
NewErrMySQLNotFoundIdentity = func() error {
return &ErrMySQLNotFoundIdentity{
err: New("error mysql element not found"),
}
// NewErrMySQLNotFoundIdentity generates an error that the element is not found.
NewErrMySQLNotFoundIdentity = &ErrMySQLNotFoundIdentity{
err: New("error mysql element not found"),
}

// ErrMySQLConnectionClosed represents a function to generate an error that the connection closed.
Expand All @@ -36,19 +34,17 @@ var (

// ErrRequiredElementNotFoundByUUID represents a function to generate an error that the required element is not found.
ErrRequiredElementNotFoundByUUID = func(uuid string) error {
return Wrapf(NewErrMySQLNotFoundIdentity(), "error required element not found, uuid: %s", uuid)
return Wrapf(NewErrMySQLNotFoundIdentity, "error required element not found, uuid: %s", uuid)
}

// NewErrMySQLInvalidArgumentIdentity represents a function to generate an error that the argument is invalid.
NewErrMySQLInvalidArgumentIdentity = func() error {
return &ErrMySQLInvalidArgumentIdentity{
err: New("error mysql invalid argument"),
}
// NewErrMySQLInvalidArgumentIdentity generates an error that the argument is invalid.
NewErrMySQLInvalidArgumentIdentity = &ErrMySQLInvalidArgumentIdentity{
err: New("error mysql invalid argument"),
}

// ErrRequiredMemberNotFilled represents a function to generate an error that the required member is not filled.
ErrRequiredMemberNotFilled = func(member string) error {
return Wrapf(NewErrMySQLInvalidArgumentIdentity(), "error required member not filled (member: %s)", member)
return Wrapf(NewErrMySQLInvalidArgumentIdentity, "error required member not filled (member: %s)", member)
}

// ErrMySQLSessionNil represents a function to generate an error that the MySQL session is nil.
Expand Down
4 changes: 2 additions & 2 deletions internal/errors/mysql_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ func TestNewErrMySQLNotFoundIdentity(t *testing.T) {
checkFunc = defaultCheckFunc
}

got := NewErrMySQLNotFoundIdentity()
got := NewErrMySQLNotFoundIdentity
if err := checkFunc(test.want, got); err != nil {
tt.Errorf("error = %v", err)
}
Expand Down Expand Up @@ -340,7 +340,7 @@ func TestNewErrMySQLInvalidArgumentIdentity(t *testing.T) {
checkFunc = defaultCheckFunc
}

got := NewErrMySQLInvalidArgumentIdentity()
got := NewErrMySQLInvalidArgumentIdentity
if err := checkFunc(test.want, got); err != nil {
tt.Errorf("error = %v", err)
}
Expand Down
6 changes: 2 additions & 4 deletions internal/errors/observability.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@
// Package errors provides error types and function
package errors

// ErrCollectorNotFound represents a function to generate an error that the observability collector is not found.
// ErrCollectorNotFound represents an error that the observability collector is not found.
var (
ErrCollectorNotFound = func() error {
return New("observability.collector not found")
}
ErrCollectorNotFound = New("observability.collector not found")
)
2 changes: 1 addition & 1 deletion internal/errors/observability_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ func TestErrCollectorNotFound(t *testing.T) {
checkFunc = defaultCheckFunc
}

got := ErrCollectorNotFound()
got := ErrCollectorNotFound
if err := checkFunc(test.want, got); err != nil {
tt.Errorf("error = %v", err)
}
Expand Down
10 changes: 4 additions & 6 deletions internal/errors/redis.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,14 @@ var (
return Errorf("kv index and vk prefix must be defferent.\t(kv: %s,\tvk: %s)", kv, vk)
}

// NewErrRedisNotFoundIdentity represents a function to generate an ErrRedisNotFoundIdentity error.
NewErrRedisNotFoundIdentity = func() error {
return &ErrRedisNotFoundIdentity{
err: New("error redis entry not found"),
}
// NewErrRedisNotFoundIdentity generates an ErrRedisNotFoundIdentity error.
NewErrRedisNotFoundIdentity = &ErrRedisNotFoundIdentity{
err: New("error redis entry not found"),
}

// ErrRedisNotFound represents a function to wrap Redis key not found error and err.
ErrRedisNotFound = func(key string) error {
return Wrapf(NewErrRedisNotFoundIdentity(), "error redis key '%s' not found", key)
return Wrapf(NewErrRedisNotFoundIdentity, "error redis key '%s' not found", key)
}

// ErrRedisInvalidOption generates a new error of Redis invalid option.
Expand Down
6 changes: 3 additions & 3 deletions internal/errors/redis_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ func TestNewErrRedisNotFoundIdentity(t *testing.T) {
checkFunc = defaultCheckFunc
}

got := NewErrRedisNotFoundIdentity()
got := NewErrRedisNotFoundIdentity
if err := checkFunc(test.want, got); err != nil {
tt.Errorf("error = %v", err)
}
Expand Down Expand Up @@ -195,14 +195,14 @@ func TestErrRdisNotFound(t *testing.T) {
key: "vdaas",
},
want: want{
want: Wrap(NewErrRedisNotFoundIdentity(), "error redis key 'vdaas' not found"),
want: Wrap(NewErrRedisNotFoundIdentity, "error redis key 'vdaas' not found"),
},
},
{
name: "return an ErrRedisNotFound error when key is empty",
fields: fields{},
want: want{
want: Wrap(NewErrRedisNotFoundIdentity(), "error redis key '' not found"),
want: Wrap(NewErrRedisNotFoundIdentity, "error redis key '' not found"),
},
},
}
Expand Down
10 changes: 4 additions & 6 deletions internal/errors/vald.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,16 @@
package errors

var (
// ErrMetaDataAlreadyExists represents a function to generate an error that vald metadata is already exists.
// ErrMetaDataAlreadyExists represents an error that vald metadata is already exists.
ErrMetaDataAlreadyExists = func(meta string) error {
return Errorf("vald metadata:\t%s\talready exists ", meta)
}

// ErrSameVectorAlreadyExists represents a function to generate an error that vald already has same features vector data.
// ErrSameVectorAlreadyExists represents an error that vald already has same features vector data.
ErrSameVectorAlreadyExists = func(meta string, n, o []float32) error {
return Errorf("vald metadata:\t%s\talready exists reqested: %v, stored: %v", meta, n, o)
}

// ErrMetaDataCannotFetch represents a function to generate an error that vald metadata cannot fetch.
ErrMetaDataCannotFetch = func() error {
return Errorf("vald metadata cannot fetch")
}
// ErrMetaDataCannotFetch represents an error that vald metadata cannot fetch.
ErrMetaDataCannotFetch = Errorf("vald metadata cannot fetch")
)
2 changes: 1 addition & 1 deletion internal/errors/vald_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ func TestErrMetadataCannotFetch(t *testing.T) {
checkFunc = defaultCheckFunc
}

got := ErrMetaDataCannotFetch()
got := ErrMetaDataCannotFetch
if err := checkFunc(test.want, got); err != nil {
tt.Errorf("error = %v", err)
}
Expand Down
24 changes: 8 additions & 16 deletions internal/errors/worker.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,23 +29,15 @@ var (
return Errorf("worker %s is already running", name)
}

// ErrQueueIsNotRunning represents a function to generate the queue is not running error.
ErrQueueIsNotRunning = func() error {
return New("queue is not running")
}
// ErrQueueIsNotRunning represents an error that the queue is not running.
ErrQueueIsNotRunning = New("queue is not running")

// ErrQueueIsAlreadyRunning represents a function to generate the queue is already running error.
ErrQueueIsAlreadyRunning = func() error {
return New("queue is already running")
}
// ErrQueueIsAlreadyRunning represents an error that the queue is already running.
ErrQueueIsAlreadyRunning = New("queue is already running")

// ErrJobFuncIsNil represents a function to generate job function is nil error.
ErrJobFuncIsNil = func() error {
return New("JobFunc is nil")
}
// ErrJobFuncIsNil represents an error that job function is nil.
ErrJobFuncIsNil = New("JobFunc is nil")

// ErrJobFuncNotFound represents a function to generate job function is not found.
ErrJobFuncNotFound = func() error {
return New("JobFunc is not found")
}
// ErrJobFuncNotFound represents an error that job function is not found.
ErrJobFuncNotFound = New("JobFunc is not found")
)
Loading

0 comments on commit f834faf

Please sign in to comment.