qor5 · molon · Aug 2, 2024 · Jul 21, 2024 · Jul 21, 2024 · Jul 21, 2024
diff --git a/activity/README.md b/activity/README.md
@@ -5,7 +5,9 @@
 - Firstly, you should create an activity instance in your project.
 
   ```go
-  activity := activity.New(db, currentUserFunc)
+  ab := activity.New(db, currentUserFunc).
+                TablePrefix("cms_"). // if needed
+                AutoMigrate() // if needed
   ```
 
   - db (Required): The database where activity_logs is stored.
@@ -14,28 +16,28 @@
 - Register activity into presets
 
   ```go
-  activityBuilder.Install(presetsBuilder)
+  ab.Install(presetsBuilder)
   ```
 
 - Register normal model or a `presets.ModelBuilder` into activity
 
   ```go
-  activity.RegisterModel(normalModel) // It need you to record the activity log manually
-  activity.RegisterModel(presetModel) // It will record the activity log automatically when you create, update or delete the model data via preset admin
+  ab.RegisterModel(normalModel) // It need you to record the activity log manually
+  ab.RegisterModel(presetModel) // It will record the activity log automatically when you create, update or delete the model data via preset admin
   ```
 
 - Skip recording activity log for preset model if you don't want to record the activity log automatically
 
   ```go
-  activity.RegisterModel(presetModel).SkipCreate().SkipUpdate().SkipDelete()
+  ab.RegisterModel(presetModel).SkipCreate().SkipUpdate().SkipDelete()
   ```
 
 - Configure more options for the `presets.ModelBuilder` to record more custom information
 
   ```go
-  activity.RegisterModel(presetModel).AddKeys("ID", "Version") // will record value of the ID and Version field as the keyword of a model table
-  activity.RegisterModel(presetModel).AddIgnoredFields("UpdateAt") // will ignore the UpdateAt field when recording activity log for update operation
-  activity.RegisterModel(presetModel).AddTypeHanders(
+  ab.RegisterModel(presetModel).AddKeys("ID", "Version") // will record value of the ID and Version field as the keyword of a model table
+  ab.RegisterModel(presetModel).AddIgnoredFields("UpdateAt") // will ignore the UpdateAt field when recording activity log for update operation
+  ab.RegisterModel(presetModel).AddTypeHanders(
     time.Time{},
     func(old, new any, prefixField string) []Diff {
   		oldString := old.(time.Time).Format(time.RFC3339)
@@ -55,15 +57,15 @@
   - When a struct type only have one `activity.ModelBuilder`, you can use `activity` to record the log directly.
 
     ```go
-      activity.OnEdit(ctx, old, new)
-      activity.OnCreate(ctx, obj)
+      ab.OnEdit(ctx, old, new)
+      ab.OnCreate(ctx, obj)
     ```
 
   - When a struct type have multiple `activity.ModelBuilder`, you need to get the corresponding `activity.ModelBuilder` and then use it to record the log.
 
     ```go
-      activity.MustGetModelBuilder(presetModel1).OnEdit(ctx, old, new)
-      activity.MustGetModelBuilder(presetModel2).OnCreate(ctx, obj)
+      ab.MustGetModelBuilder(presetModel1).OnEdit(ctx, old, new)
+      ab.MustGetModelBuilder(presetModel2).OnCreate(ctx, obj)
     ```
 
 - Add ListFieldNotes to Listing Builder

diff --git a/activity/admin.go b/activity/admin.go
@@ -147,7 +147,7 @@
 	lb.Field("ModelLabel").Label(Messages_en_US.ModelLabel).ComponentFunc(
 		func(obj any, field *presets.FieldContext, ctx *web.EventContext) h.HTMLComponent {
 			if obj.(*ActivityLog).ModelLabel == "" {
-				return h.Td(h.Text("-"))
+				return h.Td(h.Text(NopModelLabel))
 			}
 			return h.Td(h.Div().Attr("v-pre", true).Text(obj.(*ActivityLog).ModelLabel))
 		},
@@ -301,7 +301,7 @@
 								h.Tr(h.Td(h.Text(msgr.ModelName)), h.Td().Attr("v-pre", true).Text(
 									i18n.T(ctx.R, presets.ModelsI18nModuleKey, obj.(*ActivityLog).ModelName),
 								)),
-								h.Tr(h.Td(h.Text(msgr.ModelLabel)), h.Td().Attr("v-pre", true).Text(cmp.Or(log.ModelLabel, "-"))),
+								h.Tr(h.Td(h.Text(msgr.ModelLabel)), h.Td().Attr("v-pre", true).Text(cmp.Or(log.ModelLabel, NopModelLabel))),
 								h.Tr(h.Td(h.Text(msgr.ModelKeys)), h.Td().Attr("v-pre", true).Text(log.ModelKeys)),
 								h.Iff(log.ModelLink != "", func() h.HTMLComponent {
 									return h.Tr(h.Td(h.Text(msgr.ModelLink)), h.Td(

diff --git a/activity/builder.go b/activity/builder.go
@@ -78,7 +78,7 @@
 	if prefix == "" {
 		ab.db = ab.dbPrimitive
 	} else {
-		ab.db = ab.dbPrimitive.Scopes(scopeWithTablePrefix(prefix)).Session(&gorm.Session{})
+		ab.db = ab.dbPrimitive.Scopes(ScopeWithTablePrefix(prefix)).Session(&gorm.Session{})
 	}
 	return ab
 }
@@ -161,7 +161,7 @@
 
 func AutoMigrate(db *gorm.DB, tablePrefix string) error {
 	if tablePrefix != "" {
-		db = db.Scopes(scopeWithTablePrefix(tablePrefix)).Session(&gorm.Session{})
+		db = db.Scopes(ScopeWithTablePrefix(tablePrefix)).Session(&gorm.Session{})
 	}
 	dst := []any{&ActivityLog{}, &ActivityUser{}}
 	for _, v := range dst {
@@ -241,7 +241,7 @@
 		if ok {
 			return bare, nil
 		}
-		return nil, errors.Errorf("multiple model builders found for %v", v)
+		return nil, errors.Errorf("multiple preset model builders found for %v", v)
 	}
 	return ambs[0], nil
 }

diff --git a/activity/builder_test.go b/activity/builder_test.go
@@ -9,7 +9,6 @@ import (
 	"github.com/qor5/admin/v3/presets"
 	"github.com/qor5/admin/v3/presets/gorm2op"
 	"github.com/qor5/web/v3"
-	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"github.com/theplant/testenv"
 	"gorm.io/gorm"
@@ -343,10 +342,12 @@ func TestMutliModelBuilder(t *testing.T) {
 	// add edit record
 	data1.Title = "test1-1"
 	data1.Description = "Description1-1"
-	old, _ := FetchOld(db, data1)
-	db.Save(data1)
-	_, err := builder.OnEdit(ctx, old, data1)
-	assert.NoError(t, err)
+
+	old, err := FetchOld(db, data1)
+	require.NoError(t, err)
+	require.NoError(t, db.Save(data1).Error)
+	_, err = builder.OnEdit(ctx, old, data1)
+	require.NoError(t, err)
 
 	data2.Title = "test2-1"
 	data2.Description = "Description2-1"

diff --git a/activity/messages.go b/activity/messages.go
@@ -69,6 +69,8 @@ type Messages struct {
 
 	ActivityLogs string
 	ActivityLog  string
+
+	FilterTabsHasUnreadNotes string
 }
 
 func (msgr *Messages) LastEditedAt(desc string) string {
@@ -157,6 +159,8 @@ var Messages_en_US = &Messages{
 
 	ActivityLogs: "Activity Logs",
 	ActivityLog:  "Activity Log",
+
+	FilterTabsHasUnreadNotes: "Has Unread Notes",
 }
 
 var Messages_zh_CN = &Messages{
@@ -223,6 +227,8 @@ var Messages_zh_CN = &Messages{
 
 	ActivityLogs: "操作日志",
 	ActivityLog:  "操作日志",
+
+	FilterTabsHasUnreadNotes: "未读备注",
 }
 
 var Messages_ja_JP = &Messages{
@@ -289,4 +295,6 @@ var Messages_ja_JP = &Messages{
 
 	ActivityLogs: "アクティビティ履歴",
 	ActivityLog:  "アクティビティ履歴",
+
+	FilterTabsHasUnreadNotes: "未読ノート",
 }
diff --git a/activity/model_builder.go b/activity/model_builder.go
@@ -25,6 +25,8 @@ const (
 	FieldTimeline       string = "__ActivityTimeline__"
 	ListFieldNotes      string = "__ActivityNotes__"
 	ListFieldLabelNotes string = "Notes"
+
+	NopModelLabel = "-"
 )
 
 const (
@@ -52,7 +54,7 @@ type ModelBuilder struct {
 type ctxKeyUnreadCounts struct{}
 
 func NotifiLastViewedAtUpdated(modelName string) string {
-	return fmt.Sprintf("activity_NotifModelsCreated_%s", modelName)
+	return fmt.Sprintf("activity_NotifiLastViewedAtUpdated_%s", modelName)
 }
 
 type PayloadLastViewedAtUpdated struct {
@@ -472,7 +474,7 @@ func (mb *ModelBuilder) create(
 		Action:     action,
 		ModelName:  modelName,
 		ModelKeys:  modelKeys,
-		ModelLabel: "-",
+		ModelLabel: "",
 		ModelLink:  modelLink,
 	}
 	if mb.presetModel != nil {

diff --git a/activity/note.go b/activity/note.go
@@ -3,17 +3,23 @@
 import (
 	"context"
 	"fmt"
+	"net/url"
 	"strings"
 	"time"
 
 	"github.com/pkg/errors"
+	"github.com/qor5/admin/v3/presets"
+	"github.com/qor5/web/v3"
+	"github.com/qor5/x/v3/i18n"
+	vx "github.com/qor5/x/v3/ui/vuetifyx"
 	"github.com/samber/lo"
 	"gorm.io/gorm"
 )
 
 type NoteCount struct {
 	ModelName        string
 	ModelKeys        string
+	ModelLabel       string
 	UnreadNotesCount int64
 	TotalNotesCount  int64
 }
@@ -56,7 +62,7 @@
 
 	raw := fmt.Sprintf(`
 	WITH NoteRecords AS (
-		SELECT model_name, model_keys, created_at, user_id
+		SELECT model_name, model_keys, model_label, created_at, user_id
 		FROM %s
 		WHERE action = ? AND deleted_at IS NULL
 			%s
@@ -71,6 +77,7 @@
 	SELECT
 		n.model_name,
 		n.model_keys,
+		MAX(n.model_label) AS model_label,
 		COUNT(CASE WHEN n.user_id <> ? AND (lva.last_viewed_at IS NULL OR n.created_at > lva.last_viewed_at) THEN 1 END) AS unread_notes_count,
 		COUNT(*) AS total_notes_count
 	FROM NoteRecords n
@@ -166,7 +173,7 @@
 		)
 
 	    SELECT
-%s
+		%s
 	    FROM NoteRecords n
 	    LEFT JOIN LastViewedAts lva
 	        ON n.model_name = lva.model_name
@@ -202,3 +209,31 @@
 	}
 	return sqlConditionHasUnreadNotes(amb.ab.db, amb.ab.tablePrefix, user.ID, ParseModelName(amb.ref), amb.keyColumns, ModelKeysSeparator, columnPrefix)
 }
+
+const KeyHasUnreadNotes = "hasUnreadNotes"
+
+func (amb *ModelBuilder) NewHasUnreadNotesFilterItem(ctx context.Context, columnPrefix string) (*vx.FilterItem, error) {
+	hasUnreadNotesCondition, err := amb.SQLConditionHasUnreadNotes(ctx, columnPrefix)
+	if err != nil {
+		return nil, err
+	}
+	return &vx.FilterItem{
+		Key:          KeyHasUnreadNotes,
+		Invisible:    true,
+		SQLCondition: hasUnreadNotesCondition,
+	}, nil
+}
+
+func (amb *ModelBuilder) NewHasUnreadNotesFilterTab(ctx context.Context) (*presets.FilterTab, error) {
+	evCtx := web.MustGetEventContext(ctx)
+	msgr := i18n.MustGetModuleMessages(evCtx.R, I18nActivityKey, Messages_en_US).(*Messages)
+	return &presets.FilterTab{
+		Label: msgr.FilterTabsHasUnreadNotes,
+		ID:    KeyHasUnreadNotes,
+		Query: url.Values{KeyHasUnreadNotes: []string{"1"}},
+	}, nil
+}
+
+func GetHasUnreadNotesHref(listingHref string) string {
+	return fmt.Sprintf("/%s?active_filter_tab=%s&f_%s=1", listingHref, KeyHasUnreadNotes, KeyHasUnreadNotes)
+}
diff --git a/activity/util.go b/activity/util.go
@@ -114,10 +114,10 @@
 
 const dbKeyTablePrefix = "__table_prefix__"
 
-// scopeWithTablePrefix set table prefix
+// ScopeWithTablePrefix set table prefix
 // 1. Only scenarios where a Model is provided are supported
 // 2. Previously Table(...) will be overwritten
-func scopeWithTablePrefix(tablePrefix string) func(db *gorm.DB) *gorm.DB {
+func ScopeWithTablePrefix(tablePrefix string) func(db *gorm.DB) *gorm.DB {
 	return func(db *gorm.DB) *gorm.DB {
 		if v, ok := db.Get(dbKeyTablePrefix); ok {
 			if v.(string) != tablePrefix {
@@ -157,7 +157,7 @@
 	return label
 }
 
-func FetchOldWithSlug(db *gorm.DB, ref any, slug string) (any, bool) {
+func FetchOldWithSlug(db *gorm.DB, ref any, slug string) (any, error) {
 	if slug == "" {
 		return FetchOld(db, ref)
 	}
@@ -176,28 +176,27 @@
 		db = db.Where("id = ?", slug)
 	}
 
-	if db.First(old).Error != nil {
-		return nil, false
+	if err := db.First(old).Error; err != nil {
+		return nil, errors.Wrap(err, "fetch old with slug")
 	}
 
-	return old, true
+	return old, nil
 }
 
-func FetchOld(db *gorm.DB, ref any) (any, bool) {
+func FetchOld(db *gorm.DB, ref any) (any, error) {
 	var (
 		rtRef = reflect.Indirect(reflect.ValueOf(ref))
 		old   = reflect.New(rtRef.Type()).Interface()
 		sqls  []string
 		vars  []any
 	)
 
-	stmt := &gorm.Statement{DB: db}
-	if err := stmt.Parse(ref); err != nil {
-		return nil, false
+	s, err := ParseSchemaWithDB(db, ref)
+	if err != nil {
+		return nil, err
 	}
-
-	for _, dbName := range stmt.Schema.DBNames {
-		if field := stmt.Schema.LookUpField(dbName); field != nil && field.PrimaryKey {
+	for _, dbName := range s.DBNames {
+		if field := s.LookUpField(dbName); field != nil && field.PrimaryKey {
 			if value, isZero := field.ValueOf(db.Statement.Context, rtRef); !isZero {
 				sqls = append(sqls, fmt.Sprintf("%v = ?", dbName))
 				vars = append(vars, value)
@@ -206,12 +205,12 @@
 	}
 
 	if len(sqls) == 0 || len(vars) == 0 || len(sqls) != len(vars) {
-		return nil, false
+		return nil, errors.New("no primary key found")
 	}
 
-	if db.Where(strings.Join(sqls, " AND "), vars...).First(old).Error != nil {
-		return nil, false
+	if err := db.Where(strings.Join(sqls, " AND "), vars...).First(old).Error; err != nil {
+		return nil, errors.Wrap(err, "fetch old")
 	}
 
-	return old, true
+	return old, nil
 }