Files
hearth/package/gitea/source/models/activities/user_heatmap_test.go
T
2026-06-06 22:10:18 +00:00

260 lines
9.3 KiB
Go

// Copyright 2018 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package activities_test
import (
"crypto/sha1"
"fmt"
"testing"
"time"
activities_model "code.gitea.io/gitea/models/activities"
"code.gitea.io/gitea/models/db"
"code.gitea.io/gitea/models/organization"
repo_model "code.gitea.io/gitea/models/repo"
"code.gitea.io/gitea/models/unittest"
user_model "code.gitea.io/gitea/models/user"
"code.gitea.io/gitea/modules/json"
"code.gitea.io/gitea/modules/structs"
"code.gitea.io/gitea/modules/timeutil"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestGetUserHeatmapDataByUser(t *testing.T) {
require.NoError(t, unittest.PrepareTestDatabase())
require.NoError(t, db.TruncateBeans(t.Context(), &activities_model.HeatmapContribution{}))
require.NoError(t, user_model.SetIncludePrivateContributions(t.Context(), 2, false))
// Mock time
timeutil.MockSet(time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC))
defer timeutil.MockUnset()
insertHeatmapContribution(t, 2, 1, "user2-public-author-date", 1603009800)
insertHeatmapContribution(t, 2, 1, "user2-public-same-bucket", 1603009850)
insertHeatmapContribution(t, 2, 2, "user2-private-hidden", 1603010700)
insertHeatmapContribution(t, 2, 4, "user2-hidden-owner-hidden", 1603010700)
insertHeatmapContribution(t, 2, 1, "user2-future-hidden", timeutil.TimeStampNow()+900)
insertHeatmapContribution(t, 2, 999999, "user2-deleted-repo-hidden", 1603011600)
insertHeatmapContribution(t, 3, 1, "other-author-ignored", 1603010700)
setUserVisibility(t, 5, structs.VisibleTypePrivate)
testCases := []struct {
desc string
userID int64
doerID int64
CountResult int
JSONResult string
}{
{
"self sees public author-date contributions only",
2, 2, 2, `[{"timestamp":1603009800,"contributions":2}]`,
},
{
"admin sees public author-date contributions only",
2, 1, 2, `[{"timestamp":1603009800,"contributions":2}]`,
},
{
"other user sees public author-date contributions only",
2, 3, 2, `[{"timestamp":1603009800,"contributions":2}]`,
},
{
"anonymous sees public author-date contributions only",
2, 0, 2, `[{"timestamp":1603009800,"contributions":2}]`,
},
{
"different author is not counted for target user",
3, 3, 0, `[]`,
},
}
for _, tc := range testCases {
t.Run(tc.desc, func(t *testing.T) {
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: tc.userID})
var doer *user_model.User
if tc.doerID != 0 {
doer = unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: tc.doerID})
}
heatmap, err := activities_model.GetUserHeatmapDataByUser(t.Context(), user, doer)
require.NoError(t, err)
assert.Equal(t, tc.CountResult, countHeatmapContributions(heatmap), "testcase '%s'", tc.desc)
// Test JSON rendering
jsonData, err := json.Marshal(heatmap)
require.NoError(t, err)
assert.JSONEq(t, tc.JSONResult, string(jsonData))
})
}
}
func TestGetUserHeatmapDataByUserUsesCurrentRepoVisibility(t *testing.T) {
require.NoError(t, unittest.PrepareTestDatabase())
require.NoError(t, db.TruncateBeans(t.Context(), &activities_model.HeatmapContribution{}))
require.NoError(t, user_model.SetIncludePrivateContributions(t.Context(), 2, false))
timeutil.MockSet(time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC))
defer timeutil.MockUnset()
insertHeatmapContribution(t, 2, 1, "user2-visibility-flip", 1603009800)
target := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
heatmap, err := activities_model.GetUserHeatmapDataByUser(t.Context(), target, nil)
require.NoError(t, err)
assertHeatmapJSON(t, heatmap, `[{
"timestamp": 1603009800,
"contributions": 1
}]`)
setRepoPrivate(t, 1, true)
heatmap, err = activities_model.GetUserHeatmapDataByUser(t.Context(), target, nil)
require.NoError(t, err)
assert.Empty(t, heatmap)
require.NoError(t, user_model.SetIncludePrivateContributions(t.Context(), 2, true))
heatmap, err = activities_model.GetUserHeatmapDataByUser(t.Context(), target, nil)
require.NoError(t, err)
assertHeatmapJSON(t, heatmap, `[{
"timestamp": 1603009800,
"contributions": 1
}]`)
}
func TestGetUserHeatmapDataByOrgTeam(t *testing.T) {
require.NoError(t, unittest.PrepareTestDatabase())
require.NoError(t, db.TruncateBeans(t.Context(), &activities_model.HeatmapContribution{}))
require.NoError(t, user_model.SetIncludePrivateContributions(t.Context(), 3, false))
timeutil.MockSet(time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC))
defer timeutil.MockUnset()
insertHeatmapContribution(t, 2, 32, "org-team-public", 1603009800)
insertHeatmapContribution(t, 2, 3, "org-team-private-hidden", 1603010700)
insertHeatmapContribution(t, 2, 1, "non-org-repo-ignored", 1603011600)
org := unittest.AssertExistsAndLoadBean(t, &organization.Organization{ID: 3})
team := unittest.AssertExistsAndLoadBean(t, &organization.Team{ID: 7})
doer := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
heatmap, err := activities_model.GetUserHeatmapDataByOrgTeam(t.Context(), org, team, doer)
require.NoError(t, err)
assert.Equal(t, 1, countHeatmapContributions(heatmap))
jsonData, err := json.Marshal(heatmap)
require.NoError(t, err)
assert.JSONEq(t, `[{"timestamp":1603009800,"contributions":1}]`, string(jsonData))
}
func TestUserHeatmapPrivateContributionsOptIn(t *testing.T) {
require.NoError(t, unittest.PrepareTestDatabase())
require.NoError(t, db.TruncateBeans(t.Context(), &activities_model.HeatmapContribution{}))
require.NoError(t, user_model.SetIncludePrivateContributions(t.Context(), 16, false))
timeutil.MockSet(time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC))
defer timeutil.MockUnset()
insertHeatmapContribution(t, 16, 21, "user16-public", 1603009800)
insertHeatmapContribution(t, 16, 22, "user16-private-one", 1603009850)
insertHeatmapContribution(t, 16, 22, "user16-private-two", 1603010700)
target := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 16})
admin := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 1})
authenticated := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 3})
collaborator := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 15})
for _, doer := range []*user_model.User{nil, target, admin, authenticated, collaborator} {
heatmap, err := activities_model.GetUserHeatmapDataByUser(t.Context(), target, doer)
require.NoError(t, err)
assert.Equal(t, 1, countHeatmapContributions(heatmap), "private contributions should be hidden by default from %s", heatmapDoerName(doer))
}
require.NoError(t, user_model.SetIncludePrivateContributions(t.Context(), 16, true))
heatmap, err := activities_model.GetUserHeatmapDataByUser(t.Context(), target, nil)
require.NoError(t, err)
assertHeatmapJSON(t, heatmap, `[{"timestamp":1603009800,"contributions":2},{"timestamp":1603010700,"contributions":1}]`)
target.KeepActivityPrivate = true
_, err = db.GetEngine(t.Context()).ID(target.ID).Cols("keep_activity_private").Update(target)
require.NoError(t, err)
heatmap, err = activities_model.GetUserHeatmapDataByUser(t.Context(), target, nil)
require.NoError(t, err)
assert.Empty(t, heatmap)
heatmap, err = activities_model.GetUserHeatmapDataByUser(t.Context(), target, authenticated)
require.NoError(t, err)
assert.Empty(t, heatmap)
heatmap, err = activities_model.GetUserHeatmapDataByUser(t.Context(), target, target)
require.NoError(t, err)
assert.Equal(t, 3, countHeatmapContributions(heatmap))
heatmap, err = activities_model.GetUserHeatmapDataByUser(t.Context(), target, admin)
require.NoError(t, err)
assert.Equal(t, 3, countHeatmapContributions(heatmap))
}
func insertHeatmapContribution(t *testing.T, userID, repoID int64, commitSHA string, authorUnix timeutil.TimeStamp) {
t.Helper()
require.NoError(t, activities_model.UpsertHeatmapContribution(t.Context(), &activities_model.HeatmapContribution{
UserID: userID,
RepoID: repoID,
CommitSHA: fmt.Sprintf("%040x", sha1.Sum([]byte(commitSHA))),
AuthorEmail: fmt.Sprintf("user%d@example.com", userID),
AuthorUnix: authorUnix,
}))
}
func setRepoPrivate(t *testing.T, repoID int64, isPrivate bool) {
t.Helper()
repo := &repo_model.Repository{ID: repoID, IsPrivate: isPrivate}
_, err := db.GetEngine(t.Context()).ID(repoID).Cols("is_private").Update(repo)
require.NoError(t, err)
}
func setUserVisibility(t *testing.T, userID int64, visibility structs.VisibleType) {
t.Helper()
user := &user_model.User{ID: userID, Visibility: visibility}
_, err := db.GetEngine(t.Context()).ID(userID).Cols("visibility").Update(user)
require.NoError(t, err)
}
func assertHeatmapJSON(t *testing.T, heatmap []*activities_model.UserHeatmapData, expected string) {
t.Helper()
jsonData, err := json.Marshal(heatmap)
require.NoError(t, err)
assert.JSONEq(t, expected, string(jsonData))
var decoded []map[string]any
require.NoError(t, json.Unmarshal(jsonData, &decoded))
for _, entry := range decoded {
assert.ElementsMatch(t, []string{"timestamp", "contributions"}, mapKeys(entry))
}
}
func mapKeys[K comparable, V any](m map[K]V) []K {
keys := make([]K, 0, len(m))
for key := range m {
keys = append(keys, key)
}
return keys
}
func countHeatmapContributions(heatmap []*activities_model.UserHeatmapData) int {
var contributions int
for _, hm := range heatmap {
contributions += int(hm.Contributions)
}
return contributions
}
func heatmapDoerName(doer *user_model.User) string {
if doer == nil {
return "anonymous"
}
return doer.Name
}