mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-23 15:53:07 -05:00
3bdfb7a7aa
When searching for repository topics, either via the API, or via Explore, paging did not work correctly, because it only applied when the `page` parameter was non-zero. Paging should have applied when the page size is greater than zero, which is what this patch does. As a result, both the API, and the Explore endpoint will return paged results (30 by default). As such, when managing topics on the frontend, the offered completions will also be limited to a pageful of results, based on what the user has already typed. This drastically reduces the amount of traffic, and also the number of the topics to choose from, and thus, the rendering time too. The topics will be returned by popularity, with most used topics first. A single page will contain `[api].DEFAULT_PAGING_NUM` (30 by default) items that match the query. That's plenty to choose from. Fixes #132. Signed-off-by: Gergely Nagy <forgejo@gergo.csillger.hu> (cherry picked from commit64d4ff41db) (cherry picked from commit06b808fa2c) (cherry picked from commit9205c9266a) (cherry picked from commit47863d4f72)
194 lines
7.3 KiB
Go
194 lines
7.3 KiB
Go
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// Copyright 2024 The Forgejo Authors c/o Codeberg e.V.. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package integration
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"net/url"
|
|
"testing"
|
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
|
"code.gitea.io/gitea/models/unittest"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/tests"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestAPITopicSearchPaging(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
var topics struct {
|
|
TopicNames []*api.TopicResponse `json:"topics"`
|
|
}
|
|
|
|
// Add 20 unique topics to user2/repo2, and 20 unique ones to user2/repo3
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
|
token2 := getUserToken(t, user2.Name, auth_model.AccessTokenScopeWriteRepository)
|
|
repo2 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
|
|
repo3 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 2})
|
|
for i := 0; i < 20; i++ {
|
|
req := NewRequestf(t, "PUT", "/api/v1/repos/%s/%s/topics/paging-topic-%d", user2.Name, repo2.Name, i).
|
|
AddTokenAuth(token2)
|
|
MakeRequest(t, req, http.StatusNoContent)
|
|
req = NewRequestf(t, "PUT", "/api/v1/repos/%s/%s/topics/paging-topic-%d", user2.Name, repo3.Name, i+30).
|
|
AddTokenAuth(token2)
|
|
MakeRequest(t, req, http.StatusNoContent)
|
|
}
|
|
|
|
res := MakeRequest(t, NewRequest(t, "GET", "/api/v1/topics/search"), http.StatusOK)
|
|
DecodeJSON(t, res, &topics)
|
|
assert.Len(t, topics.TopicNames, 30)
|
|
|
|
res = MakeRequest(t, NewRequest(t, "GET", "/api/v1/topics/search?page=2"), http.StatusOK)
|
|
DecodeJSON(t, res, &topics)
|
|
assert.Greater(t, len(topics.TopicNames), 0)
|
|
}
|
|
|
|
func TestAPITopicSearch(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
searchURL, _ := url.Parse("/api/v1/topics/search")
|
|
var topics struct {
|
|
TopicNames []*api.TopicResponse `json:"topics"`
|
|
}
|
|
|
|
query := url.Values{"page": []string{"1"}, "limit": []string{"4"}}
|
|
|
|
searchURL.RawQuery = query.Encode()
|
|
res := MakeRequest(t, NewRequest(t, "GET", searchURL.String()), http.StatusOK)
|
|
DecodeJSON(t, res, &topics)
|
|
assert.Len(t, topics.TopicNames, 4)
|
|
assert.EqualValues(t, "6", res.Header().Get("x-total-count"))
|
|
|
|
query.Add("q", "topic")
|
|
searchURL.RawQuery = query.Encode()
|
|
res = MakeRequest(t, NewRequest(t, "GET", searchURL.String()), http.StatusOK)
|
|
DecodeJSON(t, res, &topics)
|
|
assert.Len(t, topics.TopicNames, 2)
|
|
|
|
query.Set("q", "database")
|
|
searchURL.RawQuery = query.Encode()
|
|
res = MakeRequest(t, NewRequest(t, "GET", searchURL.String()), http.StatusOK)
|
|
DecodeJSON(t, res, &topics)
|
|
if assert.Len(t, topics.TopicNames, 1) {
|
|
assert.EqualValues(t, 2, topics.TopicNames[0].ID)
|
|
assert.EqualValues(t, "database", topics.TopicNames[0].Name)
|
|
assert.EqualValues(t, 1, topics.TopicNames[0].RepoCount)
|
|
}
|
|
}
|
|
|
|
func TestAPIRepoTopic(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2}) // owner of repo2
|
|
org3 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 3}) // owner of repo3
|
|
user4 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 4}) // write access to repo 3
|
|
repo2 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 2})
|
|
repo3 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 3})
|
|
|
|
// Get user2's token
|
|
token2 := getUserToken(t, user2.Name, auth_model.AccessTokenScopeWriteRepository)
|
|
|
|
// Test read topics using login
|
|
req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/%s/%s/topics", user2.Name, repo2.Name)).
|
|
AddTokenAuth(token2)
|
|
res := MakeRequest(t, req, http.StatusOK)
|
|
var topics *api.TopicName
|
|
DecodeJSON(t, res, &topics)
|
|
assert.ElementsMatch(t, []string{"topicname1", "topicname2"}, topics.TopicNames)
|
|
|
|
// Test delete a topic
|
|
req = NewRequestf(t, "DELETE", "/api/v1/repos/%s/%s/topics/%s", user2.Name, repo2.Name, "Topicname1").
|
|
AddTokenAuth(token2)
|
|
MakeRequest(t, req, http.StatusNoContent)
|
|
|
|
// Test add an existing topic
|
|
req = NewRequestf(t, "PUT", "/api/v1/repos/%s/%s/topics/%s", user2.Name, repo2.Name, "Golang").
|
|
AddTokenAuth(token2)
|
|
MakeRequest(t, req, http.StatusNoContent)
|
|
|
|
// Test add a topic
|
|
req = NewRequestf(t, "PUT", "/api/v1/repos/%s/%s/topics/%s", user2.Name, repo2.Name, "topicName3").
|
|
AddTokenAuth(token2)
|
|
MakeRequest(t, req, http.StatusNoContent)
|
|
|
|
url := fmt.Sprintf("/api/v1/repos/%s/%s/topics", user2.Name, repo2.Name)
|
|
|
|
// Test read topics using token
|
|
req = NewRequest(t, "GET", url).
|
|
AddTokenAuth(token2)
|
|
res = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, res, &topics)
|
|
assert.ElementsMatch(t, []string{"topicname2", "golang", "topicname3"}, topics.TopicNames)
|
|
|
|
// Test replace topics
|
|
newTopics := []string{" windows ", " ", "MAC "}
|
|
req = NewRequestWithJSON(t, "PUT", url, &api.RepoTopicOptions{
|
|
Topics: newTopics,
|
|
}).AddTokenAuth(token2)
|
|
MakeRequest(t, req, http.StatusNoContent)
|
|
req = NewRequest(t, "GET", url).
|
|
AddTokenAuth(token2)
|
|
res = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, res, &topics)
|
|
assert.ElementsMatch(t, []string{"windows", "mac"}, topics.TopicNames)
|
|
|
|
// Test replace topics with something invalid
|
|
newTopics = []string{"topicname1", "topicname2", "topicname!"}
|
|
req = NewRequestWithJSON(t, "PUT", url, &api.RepoTopicOptions{
|
|
Topics: newTopics,
|
|
}).AddTokenAuth(token2)
|
|
MakeRequest(t, req, http.StatusUnprocessableEntity)
|
|
req = NewRequest(t, "GET", url).
|
|
AddTokenAuth(token2)
|
|
res = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, res, &topics)
|
|
assert.ElementsMatch(t, []string{"windows", "mac"}, topics.TopicNames)
|
|
|
|
// Test with some topics multiple times, less than 25 unique
|
|
newTopics = []string{"t1", "t2", "t1", "t3", "t4", "t5", "t6", "t7", "t8", "t9", "t10", "t11", "t12", "t13", "t14", "t15", "t16", "17", "t18", "t19", "t20", "t21", "t22", "t23", "t24", "t25"}
|
|
req = NewRequestWithJSON(t, "PUT", url, &api.RepoTopicOptions{
|
|
Topics: newTopics,
|
|
}).AddTokenAuth(token2)
|
|
MakeRequest(t, req, http.StatusNoContent)
|
|
req = NewRequest(t, "GET", url).
|
|
AddTokenAuth(token2)
|
|
res = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, res, &topics)
|
|
assert.Len(t, topics.TopicNames, 25)
|
|
|
|
// Test writing more topics than allowed
|
|
newTopics = append(newTopics, "t26")
|
|
req = NewRequestWithJSON(t, "PUT", url, &api.RepoTopicOptions{
|
|
Topics: newTopics,
|
|
}).AddTokenAuth(token2)
|
|
MakeRequest(t, req, http.StatusUnprocessableEntity)
|
|
|
|
// Test add a topic when there is already maximum
|
|
req = NewRequestf(t, "PUT", "/api/v1/repos/%s/%s/topics/%s", user2.Name, repo2.Name, "t26").
|
|
AddTokenAuth(token2)
|
|
MakeRequest(t, req, http.StatusUnprocessableEntity)
|
|
|
|
// Test delete a topic that repo doesn't have
|
|
req = NewRequestf(t, "DELETE", "/api/v1/repos/%s/%s/topics/%s", user2.Name, repo2.Name, "Topicname1").
|
|
AddTokenAuth(token2)
|
|
MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
// Get user4's token
|
|
token4 := getUserToken(t, user4.Name, auth_model.AccessTokenScopeWriteRepository)
|
|
|
|
// Test read topics with write access
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/%s/%s/topics", org3.Name, repo3.Name)).
|
|
AddTokenAuth(token4)
|
|
res = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, res, &topics)
|
|
assert.Empty(t, topics.TopicNames)
|
|
|
|
// Test add a topic to repo with write access (requires repo admin access)
|
|
req = NewRequestf(t, "PUT", "/api/v1/repos/%s/%s/topics/%s", org3.Name, repo3.Name, "topicName").
|
|
AddTokenAuth(token4)
|
|
MakeRequest(t, req, http.StatusForbidden)
|
|
}
|