mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-11-01 13:01:15 +00:00
70a7d6a0de
- It was noticed [in the Forgejo matrix channel](https://matrix.to/#/!qjPHwFPdxhpLkXMkyP:matrix.org/$vk78UR0eFCwQMDMTZ7-DWjMVB_LIAwHW6SkjhEcGkQQ?via=matrix.org) that the generation of the Forgejo project contributor stats was taking quite a while on codeberg.org. This was continued with the fact that a few moments later it was once again generating them again; it seemed like they weren't being cached while they were. - The problem was that the cache TTL is hardcoded to ten minutes and not to the configured TTL. This patch changes that by using the configured TLL for the contributor cache, as this is a computationally heavy operation and should be cached for as long as possible for a good user experience. This doesn't impact the accuracy of this feature because the commit ID of the default branch is used as a cache key. - Also changed in this patch, is that errors aren't cached and are instead being logged, this is more helpful to the administrator. For the user essentially nothing changed on this side, the contributor stats just looks like it's loading indefinitely. - Realistically, testing this isn't possible, as the cache library Forgejo currently uses doesn't expose the TTL or expiration time of a key. Manually testing this behavior is quite lengthy, as one of the steps would need to be "wait for ten minutes" and describe how you can notice the data was cached or was just generated, and because you could use different types of cache, it will be quite hard to write down how you could check the TTL of a key for a particular cache (I'm not even sure it's even possible for some).
101 lines
3.9 KiB
Go
101 lines
3.9 KiB
Go
// Copyright 2024 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package repository
|
|
|
|
import (
|
|
"slices"
|
|
"testing"
|
|
"time"
|
|
|
|
"code.gitea.io/gitea/models/db"
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
|
"code.gitea.io/gitea/models/unittest"
|
|
"code.gitea.io/gitea/modules/json"
|
|
"code.gitea.io/gitea/modules/log"
|
|
"code.gitea.io/gitea/modules/test"
|
|
|
|
"gitea.com/go-chi/cache"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestRepository_ContributorsGraph(t *testing.T) {
|
|
assert.NoError(t, unittest.PrepareTestDatabase())
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 2})
|
|
assert.NoError(t, repo.LoadOwner(db.DefaultContext))
|
|
mockCache, err := cache.NewCacher(cache.Options{
|
|
Adapter: "memory",
|
|
Interval: 24 * 60,
|
|
})
|
|
assert.NoError(t, err)
|
|
|
|
lc, cleanup := test.NewLogChecker(log.DEFAULT, log.INFO)
|
|
lc.StopMark(`getExtendedCommitStats[repo="user2/repo2" revision="404ref"]: object does not exist [id: 404ref, rel_path: ]`)
|
|
defer cleanup()
|
|
|
|
generateContributorStats(nil, mockCache, "key", repo, "404ref")
|
|
assert.False(t, mockCache.IsExist("key"))
|
|
_, stopped := lc.Check(100 * time.Millisecond)
|
|
assert.True(t, stopped)
|
|
|
|
generateContributorStats(nil, mockCache, "key2", repo, "master")
|
|
dataString, isData := mockCache.Get("key2").(string)
|
|
assert.True(t, isData)
|
|
// Verify that JSON is actually stored in the cache.
|
|
assert.EqualValues(t, `{"ethantkoenig@gmail.com":{"name":"Ethan Koenig","login":"","avatar_link":"https://secure.gravatar.com/avatar/b42fb195faa8c61b8d88abfefe30e9e3?d=identicon","home_link":"","total_commits":1,"weeks":{"1511654400000":{"week":1511654400000,"additions":3,"deletions":0,"commits":1}}},"jimmy.praet@telenet.be":{"name":"Jimmy Praet","login":"","avatar_link":"https://secure.gravatar.com/avatar/93c49b7c89eb156971d11161c9b52795?d=identicon","home_link":"","total_commits":1,"weeks":{"1624752000000":{"week":1624752000000,"additions":2,"deletions":0,"commits":1}}},"jon@allspice.io":{"name":"Jon","login":"","avatar_link":"https://secure.gravatar.com/avatar/00388ce725e6886f3e07c3733007289b?d=identicon","home_link":"","total_commits":1,"weeks":{"1607817600000":{"week":1607817600000,"additions":10,"deletions":0,"commits":1}}},"total":{"name":"Total","login":"","avatar_link":"","home_link":"","total_commits":3,"weeks":{"1511654400000":{"week":1511654400000,"additions":3,"deletions":0,"commits":1},"1607817600000":{"week":1607817600000,"additions":10,"deletions":0,"commits":1},"1624752000000":{"week":1624752000000,"additions":2,"deletions":0,"commits":1}}}}`, dataString)
|
|
|
|
var data map[string]*ContributorData
|
|
assert.NoError(t, json.Unmarshal([]byte(dataString), &data))
|
|
|
|
var keys []string
|
|
for k := range data {
|
|
keys = append(keys, k)
|
|
}
|
|
slices.Sort(keys)
|
|
assert.EqualValues(t, []string{
|
|
"ethantkoenig@gmail.com",
|
|
"jimmy.praet@telenet.be",
|
|
"jon@allspice.io",
|
|
"total", // generated summary
|
|
}, keys)
|
|
|
|
assert.EqualValues(t, &ContributorData{
|
|
Name: "Ethan Koenig",
|
|
AvatarLink: "https://secure.gravatar.com/avatar/b42fb195faa8c61b8d88abfefe30e9e3?d=identicon",
|
|
TotalCommits: 1,
|
|
Weeks: map[int64]*WeekData{
|
|
1511654400000: {
|
|
Week: 1511654400000, // sunday 2017-11-26
|
|
Additions: 3,
|
|
Deletions: 0,
|
|
Commits: 1,
|
|
},
|
|
},
|
|
}, data["ethantkoenig@gmail.com"])
|
|
assert.EqualValues(t, &ContributorData{
|
|
Name: "Total",
|
|
AvatarLink: "",
|
|
TotalCommits: 3,
|
|
Weeks: map[int64]*WeekData{
|
|
1511654400000: {
|
|
Week: 1511654400000, // sunday 2017-11-26 (2017-11-26 20:31:18 -0800)
|
|
Additions: 3,
|
|
Deletions: 0,
|
|
Commits: 1,
|
|
},
|
|
1607817600000: {
|
|
Week: 1607817600000, // sunday 2020-12-13 (2020-12-15 15:23:11 -0500)
|
|
Additions: 10,
|
|
Deletions: 0,
|
|
Commits: 1,
|
|
},
|
|
1624752000000: {
|
|
Week: 1624752000000, // sunday 2021-06-27 (2021-06-29 21:54:09 +0200)
|
|
Additions: 2,
|
|
Deletions: 0,
|
|
Commits: 1,
|
|
},
|
|
},
|
|
}, data["total"])
|
|
}
|