refactor(log): consolidate logging models and update related logic for improved clarity and functionality
This commit is contained in:
Chang lue Tsen
@@ -6,74 +6,50 @@ import (
|
||||
"gorm.io/gorm"
|
||||
)
|
||||
|
||||
var _ Model = (*customLogModel)(nil)
|
||||
var _ Model = (*customSystemLogModel)(nil)
|
||||
|
||||
type (
|
||||
Model interface {
|
||||
messageLogModel
|
||||
systemLogModel
|
||||
customSystemLogLogicModel
|
||||
}
|
||||
messageLogModel interface {
|
||||
InsertMessageLog(ctx context.Context, data *MessageLog) error
|
||||
FindOneMessageLog(ctx context.Context, id int64) (*MessageLog, error)
|
||||
UpdateMessageLog(ctx context.Context, data *MessageLog) error
|
||||
DeleteMessageLog(ctx context.Context, id int64) error
|
||||
FindMessageLogList(ctx context.Context, page, size int, filter MessageLogFilterParams) (int64, []*MessageLog, error)
|
||||
systemLogModel interface {
|
||||
Insert(ctx context.Context, data *SystemLog) error
|
||||
FindOne(ctx context.Context, id int64) (*SystemLog, error)
|
||||
Update(ctx context.Context, data *SystemLog) error
|
||||
Delete(ctx context.Context, id int64) error
|
||||
}
|
||||
|
||||
customLogModel struct {
|
||||
customSystemLogModel struct {
|
||||
*defaultLogModel
|
||||
}
|
||||
defaultLogModel struct {
|
||||
Connection *gorm.DB
|
||||
*gorm.DB
|
||||
}
|
||||
)
|
||||
|
||||
func newLogModel(db *gorm.DB) *defaultLogModel {
|
||||
func newSystemLogModel(db *gorm.DB) *defaultLogModel {
|
||||
return &defaultLogModel{
|
||||
Connection: db,
|
||||
DB: db,
|
||||
}
|
||||
}
|
||||
|
||||
func (m *defaultLogModel) InsertMessageLog(ctx context.Context, data *MessageLog) error {
|
||||
return m.Connection.WithContext(ctx).Create(&data).Error
|
||||
func (m *defaultLogModel) Insert(ctx context.Context, data *SystemLog) error {
|
||||
return m.WithContext(ctx).Create(data).Error
|
||||
}
|
||||
|
||||
func (m *defaultLogModel) FindOneMessageLog(ctx context.Context, id int64) (*MessageLog, error) {
|
||||
var resp MessageLog
|
||||
err := m.Connection.WithContext(ctx).Model(&MessageLog{}).Where("`id` = ?", id).First(&resp).Error
|
||||
return &resp, err
|
||||
func (m *defaultLogModel) FindOne(ctx context.Context, id int64) (*SystemLog, error) {
|
||||
var log SystemLog
|
||||
err := m.WithContext(ctx).Where("id = ?", id).First(&log).Error
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &log, nil
|
||||
}
|
||||
|
||||
func (m *defaultLogModel) UpdateMessageLog(ctx context.Context, data *MessageLog) error {
|
||||
return m.Connection.WithContext(ctx).Model(&MessageLog{}).Where("id = ?", data.Id).Updates(data).Error
|
||||
func (m *defaultLogModel) Update(ctx context.Context, data *SystemLog) error {
|
||||
return m.WithContext(ctx).Where("`id` = ?", data.Id).Save(data).Error
|
||||
}
|
||||
|
||||
func (m *defaultLogModel) DeleteMessageLog(ctx context.Context, id int64) error {
|
||||
return m.Connection.WithContext(ctx).Model(&MessageLog{}).Where("id = ?", id).Delete(&MessageLog{}).Error
|
||||
}
|
||||
|
||||
func (m *defaultLogModel) FindMessageLogList(ctx context.Context, page, size int, filter MessageLogFilterParams) (int64, []*MessageLog, error) {
|
||||
var list []*MessageLog
|
||||
var total int64
|
||||
conn := m.Connection.WithContext(ctx).Model(&MessageLog{})
|
||||
if filter.Type != "" {
|
||||
conn = conn.Where("`type` = ?", filter.Type)
|
||||
}
|
||||
if filter.Platform != "" {
|
||||
conn = conn.Where("`platform` = ?", filter.Platform)
|
||||
}
|
||||
if filter.To != "" {
|
||||
conn = conn.Where("`to` LIKE ?", "%"+filter.To+"%")
|
||||
}
|
||||
if filter.Subject != "" {
|
||||
conn = conn.Where("`subject` LIKE ?", "%"+filter.Subject+"%")
|
||||
}
|
||||
if filter.Content != "" {
|
||||
conn = conn.Where("`content` = ?", "%"+filter.Content+"%")
|
||||
}
|
||||
if filter.Status > 0 {
|
||||
conn = conn.Where("`status` = ?", filter.Status)
|
||||
}
|
||||
err := conn.Count(&total).Offset((page - 1) * size).Limit(size).Find(&list).Error
|
||||
return total, list, err
|
||||
func (m *defaultLogModel) Delete(ctx context.Context, id int64) error {
|
||||
return m.WithContext(ctx).Where("`id` = ?", id).Delete(&SystemLog{}).Error
|
||||
}
|
||||
|
||||
+286
-33
@@ -1,45 +1,298 @@
|
||||
package log
|
||||
|
||||
import "time"
|
||||
|
||||
type MessageType int
|
||||
|
||||
const (
|
||||
Email MessageType = iota + 1
|
||||
Mobile
|
||||
import (
|
||||
"encoding/json"
|
||||
"time"
|
||||
)
|
||||
|
||||
func (t MessageType) String() string {
|
||||
switch t {
|
||||
case Email:
|
||||
return "email"
|
||||
case Mobile:
|
||||
return "mobile"
|
||||
}
|
||||
return "unknown"
|
||||
type Type uint8
|
||||
|
||||
const (
|
||||
TypeEmailMessage Type = iota + 1 // Message log
|
||||
TypeMobileMessage // Mobile message log
|
||||
TypeSubscribe // Subscription log
|
||||
TypeSubscribeTraffic // Subscription traffic log
|
||||
TypeServerTraffic // Server traffic log
|
||||
TypeLogin // Login log
|
||||
TypeRegister // Registration log
|
||||
TypeBalance // Balance log
|
||||
TypeCommission // Commission log
|
||||
TypeResetSubscribe // Reset subscription log
|
||||
TypeGift // Gift log
|
||||
)
|
||||
|
||||
// Uint8 converts Type to uint8.
|
||||
func (t Type) Uint8() uint8 {
|
||||
return uint8(t)
|
||||
}
|
||||
|
||||
type MessageLog struct {
|
||||
Id int64 `gorm:"primaryKey"`
|
||||
Type string `gorm:"type:varchar(50);not null;default:'email';comment:Message Type"`
|
||||
Platform string `gorm:"type:varchar(50);not null;default:'smtp';comment:Platform"`
|
||||
To string `gorm:"type:text;not null;comment:To"`
|
||||
Subject string `gorm:"type:varchar(255);not null;default:'';comment:Subject"`
|
||||
Content string `gorm:"type:text;comment:Content"`
|
||||
Status int `gorm:"type:tinyint(1);not null;default:0;comment:Status"`
|
||||
// SystemLog represents a log entry in the system.
|
||||
type SystemLog struct {
|
||||
Id int64 `gorm:"primaryKey;AUTO_INCREMENT"`
|
||||
Type uint8 `gorm:"index:idx_type;type:tinyint(1);not null;default:0;comment:Log Type: 1: Email Message 2: Mobile Message 3: Subscribe 4: Subscribe Traffic 5: Server Traffic 6: Login 7: Register 8: Balance 9: Commission 10: Reset Subscribe 11: Gift"`
|
||||
Date string `gorm:"type:varchar(20);default:null;comment:Log Date"`
|
||||
ObjectID int64 `gorm:"index:idx_object_id;type:bigint(20);not null;default:0;comment:Object ID"`
|
||||
Content string `gorm:"type:text;not null;comment:Log Content"`
|
||||
CreatedAt time.Time `gorm:"<-:create;comment:Create Time"`
|
||||
UpdatedAt time.Time `gorm:"comment:Update Time"`
|
||||
}
|
||||
|
||||
func (m *MessageLog) TableName() string {
|
||||
return "message_log"
|
||||
// TableName returns the name of the table for SystemLogs.
|
||||
func (SystemLog) TableName() string {
|
||||
return "system_logs"
|
||||
}
|
||||
|
||||
type MessageLogFilterParams struct {
|
||||
Type string
|
||||
Platform string
|
||||
To string
|
||||
Subject string
|
||||
Content string
|
||||
Status int
|
||||
// Message represents a message log entry.
|
||||
type Message struct {
|
||||
To string `json:"to"`
|
||||
Subject string `json:"subject,omitempty"`
|
||||
Content map[string]interface{} `json:"content"`
|
||||
Platform string `json:"platform"`
|
||||
Template string `json:"template"`
|
||||
Status uint8 `json:"status"` // 1: Sent, 2: Failed
|
||||
}
|
||||
|
||||
// Marshal implements the json.Marshaler interface for Message.
|
||||
func (m *Message) Marshal() ([]byte, error) {
|
||||
type Alias Message
|
||||
return json.Marshal(&struct {
|
||||
*Alias
|
||||
}{
|
||||
Alias: (*Alias)(m),
|
||||
})
|
||||
}
|
||||
|
||||
// Unmarshal implements the json.Unmarshaler interface for Message.
|
||||
func (m *Message) Unmarshal(data []byte) error {
|
||||
type Alias Message
|
||||
aux := (*Alias)(m)
|
||||
return json.Unmarshal(data, aux)
|
||||
}
|
||||
|
||||
// Traffic represents a subscription traffic log entry.
|
||||
type Traffic struct {
|
||||
Download int64 `json:"download"`
|
||||
Upload int64 `json:"upload"`
|
||||
}
|
||||
|
||||
// Marshal implements the json.Marshaler interface for SubscribeTraffic.
|
||||
func (s *Traffic) Marshal() ([]byte, error) {
|
||||
type Alias Traffic
|
||||
return json.Marshal(&struct {
|
||||
*Alias
|
||||
}{
|
||||
Alias: (*Alias)(s),
|
||||
})
|
||||
}
|
||||
|
||||
// Unmarshal implements the json.Unmarshaler interface for SubscribeTraffic.
|
||||
func (s *Traffic) Unmarshal(data []byte) error {
|
||||
type Alias Traffic
|
||||
aux := (*Alias)(s)
|
||||
return json.Unmarshal(data, aux)
|
||||
}
|
||||
|
||||
// Login represents a login log entry.
|
||||
type Login struct {
|
||||
LoginIP string `json:"login_ip"`
|
||||
UserAgent string `json:"user_agent"`
|
||||
Success bool `json:"success"`
|
||||
LoginTime int64 `json:"login_time"`
|
||||
}
|
||||
|
||||
// Marshal implements the json.Marshaler interface for Login.
|
||||
func (l *Login) Marshal() ([]byte, error) {
|
||||
type Alias Login
|
||||
return json.Marshal(&struct {
|
||||
*Alias
|
||||
}{
|
||||
Alias: (*Alias)(l),
|
||||
})
|
||||
}
|
||||
|
||||
// Unmarshal implements the json.Unmarshaler interface for Login.
|
||||
func (l *Login) Unmarshal(data []byte) error {
|
||||
type Alias Login
|
||||
aux := (*Alias)(l)
|
||||
return json.Unmarshal(data, aux)
|
||||
}
|
||||
|
||||
// Register represents a registration log entry.
|
||||
type Register struct {
|
||||
AuthMethod string `json:"auth_method"`
|
||||
Identifier string `json:"identifier"`
|
||||
RegisterIP string `json:"register_ip"`
|
||||
UserAgent string `json:"user_agent"`
|
||||
RegisterTime int64 `json:"register_time"`
|
||||
}
|
||||
|
||||
// Marshal implements the json.Marshaler interface for Register.
|
||||
func (r *Register) Marshal() ([]byte, error) {
|
||||
type Alias Register
|
||||
return json.Marshal(&struct {
|
||||
*Alias
|
||||
}{
|
||||
Alias: (*Alias)(r),
|
||||
})
|
||||
}
|
||||
|
||||
// Unmarshal implements the json.Unmarshaler interface for Register.
|
||||
|
||||
func (r *Register) Unmarshal(data []byte) error {
|
||||
type Alias Register
|
||||
aux := (*Alias)(r)
|
||||
return json.Unmarshal(data, aux)
|
||||
}
|
||||
|
||||
// Subscribe represents a subscription log entry.
|
||||
type Subscribe struct {
|
||||
Token string `json:"token"`
|
||||
UserAgent string `json:"user_agent"`
|
||||
ClientIP string `json:"client_ip"`
|
||||
SubscribeId int64 `json:"subscribe_id"`
|
||||
}
|
||||
|
||||
// Marshal implements the json.Marshaler interface for Subscribe.
|
||||
func (s *Subscribe) Marshal() ([]byte, error) {
|
||||
type Alias Subscribe
|
||||
return json.Marshal(&struct {
|
||||
*Alias
|
||||
}{
|
||||
Alias: (*Alias)(s),
|
||||
})
|
||||
}
|
||||
|
||||
// Unmarshal implements the json.Unmarshaler interface for Subscribe.
|
||||
func (s *Subscribe) Unmarshal(data []byte) error {
|
||||
type Alias Subscribe
|
||||
aux := (*Alias)(s)
|
||||
return json.Unmarshal(data, aux)
|
||||
}
|
||||
|
||||
const (
|
||||
ResetSubscribeTypeAuto uint8 = 1
|
||||
ResetSubscribeTypeAdvance uint8 = 2
|
||||
ResetSubscribeTypePaid uint8 = 3
|
||||
)
|
||||
|
||||
// ResetSubscribe represents a reset subscription log entry.
|
||||
type ResetSubscribe struct {
|
||||
Type uint8 `json:"type"`
|
||||
OrderNo string `json:"order_no,omitempty"`
|
||||
ResetAt int64 `json:"reset_at"`
|
||||
}
|
||||
|
||||
// Marshal implements the json.Marshaler interface for ResetSubscribe.
|
||||
func (r *ResetSubscribe) Marshal() ([]byte, error) {
|
||||
type Alias ResetSubscribe
|
||||
return json.Marshal(&struct {
|
||||
*Alias
|
||||
}{
|
||||
Alias: (*Alias)(r),
|
||||
})
|
||||
}
|
||||
|
||||
// Unmarshal implements the json.Unmarshaler interface for ResetSubscribe.
|
||||
func (r *ResetSubscribe) Unmarshal(data []byte) error {
|
||||
type Alias ResetSubscribe
|
||||
aux := (*Alias)(r)
|
||||
return json.Unmarshal(data, aux)
|
||||
}
|
||||
|
||||
const (
|
||||
BalanceTypeRecharge uint8 = 1 // Recharge
|
||||
BalanceTypeWithdraw uint8 = 2 // Withdraw
|
||||
BalanceTypePayment uint8 = 3 // Payment
|
||||
BalanceTypeRefund uint8 = 4 // Refund
|
||||
BalanceTypeReward uint8 = 5 // Reward
|
||||
)
|
||||
|
||||
// Balance represents a balance log entry.
|
||||
type Balance struct {
|
||||
Id int64 `json:"id"`
|
||||
Type uint8 `json:"type"`
|
||||
Amount int64 `json:"amount"`
|
||||
OrderId int64 `json:"order_id,omitempty"`
|
||||
Balance int64 `json:"balance"`
|
||||
Timestamp int64 `json:"timestamp"`
|
||||
}
|
||||
|
||||
// Marshal implements the json.Marshaler interface for Balance.
|
||||
func (b *Balance) Marshal() ([]byte, error) {
|
||||
type Alias Balance
|
||||
return json.Marshal(&struct {
|
||||
*Alias
|
||||
}{
|
||||
Alias: (*Alias)(b),
|
||||
})
|
||||
}
|
||||
|
||||
// Unmarshal implements the json.Unmarshaler interface for Balance.
|
||||
func (b *Balance) Unmarshal(data []byte) error {
|
||||
type Alias Balance
|
||||
aux := (*Alias)(b)
|
||||
return json.Unmarshal(data, aux)
|
||||
}
|
||||
|
||||
const (
|
||||
CommissionTypePurchase uint8 = 1 // Purchase
|
||||
CommissionTypeRenewal uint8 = 2 // Renewal
|
||||
CommissionTypeRefund uint8 = 3 // Gift
|
||||
)
|
||||
|
||||
// Commission represents a commission log entry.
|
||||
type Commission struct {
|
||||
Type uint8 `json:"type"`
|
||||
Amount int64 `json:"amount"`
|
||||
OrderNo string `json:"order_no"`
|
||||
CreatedAt int64 `json:"created_at"`
|
||||
}
|
||||
|
||||
// Marshal implements the json.Marshaler interface for Commission.
|
||||
func (c *Commission) Marshal() ([]byte, error) {
|
||||
type Alias Commission
|
||||
return json.Marshal(&struct {
|
||||
*Alias
|
||||
}{
|
||||
Alias: (*Alias)(c),
|
||||
})
|
||||
}
|
||||
|
||||
// Unmarshal implements the json.Unmarshaler interface for Commission.
|
||||
func (c *Commission) Unmarshal(data []byte) error {
|
||||
type Alias Commission
|
||||
aux := (*Alias)(c)
|
||||
return json.Unmarshal(data, aux)
|
||||
}
|
||||
|
||||
const (
|
||||
GiftTypeIncrease uint8 = 1 // Increase
|
||||
GiftTypeReduce uint8 = 2 // Reduce
|
||||
)
|
||||
|
||||
// Gift represents a gift log entry.
|
||||
type Gift struct {
|
||||
Type uint8 `json:"type"`
|
||||
OrderNo string `json:"order_no"`
|
||||
SubscribeId int64 `json:"subscribe_id"`
|
||||
Amount int64 `json:"amount"`
|
||||
Balance int64 `json:"balance"`
|
||||
Remark string `json:"remark,omitempty"`
|
||||
CreatedAt int64 `json:"created_at"`
|
||||
}
|
||||
|
||||
// Marshal implements the json.Marshaler interface for Gift.
|
||||
func (g *Gift) Marshal() ([]byte, error) {
|
||||
type Alias Gift
|
||||
return json.Marshal(&struct {
|
||||
*Alias
|
||||
}{
|
||||
Alias: (*Alias)(g),
|
||||
})
|
||||
}
|
||||
|
||||
// Unmarshal implements the json.Unmarshaler interface for Gift.
|
||||
func (g *Gift) Unmarshal(data []byte) error {
|
||||
type Alias Gift
|
||||
aux := (*Alias)(g)
|
||||
return json.Unmarshal(data, aux)
|
||||
}
|
||||
|
||||
@@ -1,9 +1,57 @@
|
||||
package log
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"gorm.io/gorm"
|
||||
)
|
||||
|
||||
func NewModel(conn *gorm.DB) Model {
|
||||
return newLogModel(conn)
|
||||
func NewModel(db *gorm.DB) Model {
|
||||
return &customSystemLogModel{
|
||||
defaultLogModel: newSystemLogModel(db),
|
||||
}
|
||||
}
|
||||
|
||||
type FilterParams struct {
|
||||
Page int
|
||||
Size int
|
||||
Type uint8
|
||||
Search string
|
||||
ObjectID int64
|
||||
}
|
||||
|
||||
type customSystemLogLogicModel interface {
|
||||
FilterSystemLog(ctx context.Context, filter *FilterParams) ([]*SystemLog, int64, error)
|
||||
}
|
||||
|
||||
func (m *customSystemLogModel) FilterSystemLog(ctx context.Context, filter *FilterParams) ([]*SystemLog, int64, error) {
|
||||
tx := m.WithContext(ctx).Model(&SystemLog{})
|
||||
if filter == nil {
|
||||
filter = &FilterParams{
|
||||
Page: 1,
|
||||
Size: 10,
|
||||
}
|
||||
}
|
||||
|
||||
if filter.Page < 1 {
|
||||
filter.Page = 1
|
||||
}
|
||||
if filter.Size < 1 {
|
||||
filter.Size = 10
|
||||
}
|
||||
|
||||
if filter.Type != 0 {
|
||||
tx = tx.Where("`type` = ?", filter.Type)
|
||||
}
|
||||
if filter.ObjectID != 0 {
|
||||
tx = tx.Where("`object_id` = ?", filter.ObjectID)
|
||||
}
|
||||
if filter.Search != "" {
|
||||
tx = tx.Where("`content` LIKE ?", "%"+filter.Search+"%")
|
||||
}
|
||||
|
||||
var total int64
|
||||
var logs []*SystemLog
|
||||
err := tx.Count(&total).Limit(filter.Size).Offset((filter.Page - 1) * filter.Size).Find(&logs).Error
|
||||
return logs, total, err
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user