Anthrove/otter-space-sdk
4
0
Fork 0
Code Issues Pull Requests Actions Projects Releases 6 Activity

Compare commits

base: Anthrove:bb64c08185d885a76e8fce88099e0ec4b0d749fe
Branches Tags
Anthrove:main
Anthrove:v4.0.0
Anthrove:v3.1.0
Anthrove:v3.0.1
Anthrove:v3.0.0
Anthrove:v2.3.0
Anthrove:v2.2.0
..
compare: Anthrove:c17b78cc48779d838df8277e54ec6e5ce4517759
Branches Tags
Anthrove:main
Anthrove:v4.0.0
Anthrove:v3.1.0
Anthrove:v3.0.1
Anthrove:v3.0.0
Anthrove:v2.3.0
Anthrove:v2.2.0

2 Commits
bb64c08185 ... c17b78cc48

Author SHA1 Message Date
SoXX
c17b78cc48 refactor(logging): Refactor error handling in CreateTag, CreateTagInBatch, and DeleteTag functions
Some checks failed
Gitea Build Check / Build (push) Failing after 29s
Details 
Improve error handling in the CreateTag, CreateTagInBatch, and DeleteTag functions by utilizing a new utility function. Simplify logging and error management, ensuring more consistent error responses throughout these operations.
 2024-08-11 22:34:53 +02:00
SoXX
4707ea3f00 feat(error): Add error handling utility function 
Implement the HandleError function in the new error.go file to streamline error logging and tracing. Include necessary imports for context, logrus, and OpenTelemetry tracing.
 2024-08-11 22:34:28 +02:00
2 changed files with 43 additions and 42 deletions
Show Stats Expand all files Collapse all files

13
internal/utils/error.go Normal file
View File

@ -0,0 +1,13 @@
package utils
import (
"context"
log "github.com/sirupsen/logrus"
"go.opentelemetry.io/otel/trace"
)
func HandleError(ctx context.Context, span trace.Span, logger *log.Logger, fields log.Fields, error error) error {
logger.WithContext(ctx).WithFields(fields).Error(error)
span.RecordError(error)
return error
}

72
pkg/database/tag.go
View File

@ -3,6 +3,7 @@ package database
import (
"context"
"errors"
"git.anthrove.art/Anthrove/otter-space-sdk/v2/internal/utils"
otterError "git.anthrove.art/Anthrove/otter-space-sdk/v2/pkg/error"
"git.anthrove.art/Anthrove/otter-space-sdk/v2/pkg/models"
log "github.com/sirupsen/logrus"
@ -22,9 +23,7 @@ func CreateTag(ctx context.Context, tagName models.TagName, tagType models.TagTy
span.AddEvent("Starting tag creation")
if client == nil {
logger.WithContext(ctx).Error(otterError.DatabaseIsNotConnected)
span.RecordError(&otterError.Database{Reason: otterError.DatabaseIsNotConnected})
return models.Tag{}, &otterError.Database{Reason: otterError.DatabaseIsNotConnected}
return models.Tag{}, utils.HandleError(ctx, span, logger, nil, &otterError.Database{Reason: otterError.DatabaseIsNotConnected})
}
tag := models.Tag{
@ -41,24 +40,18 @@ func CreateTag(ctx context.Context, tagName models.TagName, tagType models.TagTy
if result.Error != nil {
if errors.Is(result.Error, gorm.ErrDuplicatedKey) {
logger.WithContext(ctx).WithFields(log.Fields{
loggerFields := log.Fields{
"name": tagName,
"type": tagType,
}).Error(otterError.DuplicateKey)
span.RecordError(&otterError.Database{Reason: otterError.DuplicateKey})
return models.Tag{}, &otterError.Database{Reason: otterError.DuplicateKey}
}
return models.Tag{}, utils.HandleError(ctx, span, logger, loggerFields, &otterError.Database{Reason: otterError.DuplicateKey})
}
logger.WithContext(ctx).WithFields(log.Fields{
loggerFields := log.Fields{
"name": tagName,
"type": tagType,
}).Error(result.Error)
span.RecordError(result.Error)
return models.Tag{}, result.Error
}
return models.Tag{}, utils.HandleError(ctx, span, logger, loggerFields, result.Error)
}
logger.WithContext(ctx).WithFields(log.Fields{
@ -81,21 +74,15 @@ func CreateTagInBatch(ctx context.Context, tags []models.Tag, batchSize int) err
span.AddEvent("Starting batch tag creation")
if client == nil {
logger.WithContext(ctx).Error(otterError.DatabaseIsNotConnected)
span.RecordError(&otterError.Database{Reason: otterError.DatabaseIsNotConnected})
return &otterError.Database{Reason: otterError.DatabaseIsNotConnected}
return utils.HandleError(ctx, span, logger, nil, &otterError.Database{Reason: otterError.DatabaseIsNotConnected})
}
if tags == nil || len(tags) == 0 {
logger.WithContext(ctx).Error(otterError.TagListIsEmpty)
span.RecordError(&otterError.EntityValidationFailed{Reason: otterError.TagListIsEmpty})
return &otterError.EntityValidationFailed{Reason: otterError.TagListIsEmpty}
return utils.HandleError(ctx, span, logger, nil, &otterError.EntityValidationFailed{Reason: otterError.TagListIsEmpty})
}
if batchSize == 0 {
logger.WithContext(ctx).Error(otterError.BatchSizeIsEmpty)
span.RecordError(&otterError.EntityValidationFailed{Reason: otterError.BatchSizeIsEmpty})
return &otterError.EntityValidationFailed{Reason: otterError.BatchSizeIsEmpty}
return utils.HandleError(ctx, span, logger, nil, &otterError.EntityValidationFailed{Reason: otterError.BatchSizeIsEmpty})
}
logger.WithContext(ctx).WithFields(log.Fields{
@ -105,17 +92,16 @@ func CreateTagInBatch(ctx context.Context, tags []models.Tag, batchSize int) err
result := client.WithContext(ctx).CreateInBatches(&tags, batchSize)
if result.Error != nil {
if errors.Is(result.Error, gorm.ErrDuplicatedKey) {
logger.WithContext(ctx).WithFields(log.Fields{
loggerFields := log.Fields{
"tag_length": len(tags),
}).Error(otterError.DuplicateKey)
span.RecordError(&otterError.Database{Reason: otterError.DuplicateKey})
return &otterError.Database{Reason: otterError.DuplicateKey}
}
logger.WithContext(ctx).WithFields(log.Fields{
return utils.HandleError(ctx, span, logger, loggerFields, &otterError.Database{Reason: otterError.DuplicateKey})
}
loggerFields := log.Fields{
"tag_length": len(tags),
}).Error(result.Error)
span.RecordError(result.Error)
return result.Error
}
return utils.HandleError(ctx, span, logger, loggerFields, result.Error)
}
logger.WithContext(ctx).WithFields(log.Fields{
@ -139,15 +125,11 @@ func DeleteTag(ctx context.Context, tagName models.TagName) error {
var tag models.Tag
if client == nil {
logger.WithContext(ctx).Error(otterError.DatabaseIsNotConnected)
span.RecordError(&otterError.Database{Reason: otterError.DatabaseIsNotConnected})
return &otterError.Database{Reason: otterError.DatabaseIsNotConnected}
return utils.HandleError(ctx, span, logger, nil, &otterError.Database{Reason: otterError.DatabaseIsNotConnected})
}
if len(tagName) == 0 {
logger.WithContext(ctx).Error(otterError.TagNameIsEmpty)
span.RecordError(&otterError.EntityValidationFailed{Reason: otterError.TagNameIsEmpty})
return &otterError.EntityValidationFailed{Reason: otterError.TagNameIsEmpty}
return utils.HandleError(ctx, span, logger, nil, &otterError.Database{Reason: otterError.TagNameIsEmpty})
}
logger.WithContext(ctx).WithFields(log.Fields{
@ -157,11 +139,17 @@ func DeleteTag(ctx context.Context, tagName models.TagName) error {
result := client.WithContext(ctx).Delete(&tag, tagName)
if result.Error != nil {
if errors.Is(result.Error, gorm.ErrRecordNotFound) {
span.RecordError(&otterError.Database{Reason: otterError.NoDataFound})
return &otterError.Database{Reason: otterError.NoDataFound}
loggerFields := log.Fields{
"tag_name": tagName,
}
span.RecordError(result.Error)
return result.Error
return utils.HandleError(ctx, span, logger, loggerFields, &otterError.Database{Reason: otterError.NoDataFound})
}
loggerFields := log.Fields{
"tag_name": tagName,
}
return utils.HandleError(ctx, span, logger, loggerFields, result.Error)
}
logger.WithContext(ctx).WithFields(log.Fields{