SuperSeriousBusiness
/
GoToSocial
mirror of https://github.com/superseriousbusiness/gotosocial
1
1
Fork 0
Code Issues Projects Releases Wiki Activity

[bugfix] Clamp admin report limit <1 to 100 (#1583) 

* [bugfix] Clamp report limit <1 to 100

* add + update tests
This commit is contained in:
tobi 2023-03-03 14:01:11 +01:00 committed by GitHub
parent 29f8c51ab8
commit 88eefd0aeb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 34 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/swagger.yaml
View File

@ -3763,7 +3763,7 @@ paths:
name: min_id
type: string
- default: 20
description: Number of reports to return. If less than 1, will be clamped to 1. If more than 100, will be clamped to 100.
description: Number of reports to return. If more than 100 or less than 1, will be clamped to 100.
in: query
name: limit
type: integer

7
internal/api/client/admin/reportsget.go
View File

@ -97,8 +97,7 @@ import (
// type: integer
// description: >-
// Number of reports to return.
// If less than 1, will be clamped to 1.
// If more than 100, will be clamped to 100.
// If more than 100 or less than 1, will be clamped to 100.
// default: 20
// in: query
//
@ -163,9 +162,7 @@ func (m *Module) ReportsGETHandler(c *gin.Context) {
}
// normalize
if i <= 0 {
i = 1
} else if i >= 100 {
if i < 1 || i > 100 {
i = 100
}
limit = i

36
internal/api/client/admin/reportsget_test.go
View File

@ -124,7 +124,7 @@ func (suite *ReportsGetTestSuite) getReports(
return resp, result.Header.Get("Link"), nil
}
func (suite *ReportsGetTestSuite) TestReportsGet1() {
func (suite *ReportsGetTestSuite) TestReportsGetAll() {
testAccount := suite.testAccounts["admin_account"]
testToken := suite.testTokens["admin_account"]
testUser := suite.testUsers["admin_account"]
@ -515,7 +515,7 @@ func (suite *ReportsGetTestSuite) TestReportsGet1() {
suite.Equal(`<http://localhost:8080/api/v1/admin/reports?limit=20&max_id=01GP3AWY4CRDVRNZKW0TEAMB5R>; rel="next", <http://localhost:8080/api/v1/admin/reports?limit=20&min_id=01GP3DFY9XQ1TJMZT5BGAZPXX7>; rel="prev"`, link)
}
func (suite *ReportsGetTestSuite) TestReportsGet2() {
func (suite *ReportsGetTestSuite) TestReportsGetCreatedByAccount() {
testAccount := suite.testAccounts["admin_account"]
testToken := suite.testTokens["admin_account"]
testUser := suite.testUsers["admin_account"]
@ -716,7 +716,7 @@ func (suite *ReportsGetTestSuite) TestReportsGet2() {
suite.Equal(`<http://localhost:8080/api/v1/admin/reports?limit=20&max_id=01GP3AWY4CRDVRNZKW0TEAMB5R&account_id=01F8MH5NBDF2MV7CTC4Q5128HF>; rel="next", <http://localhost:8080/api/v1/admin/reports?limit=20&min_id=01GP3AWY4CRDVRNZKW0TEAMB5R&account_id=01F8MH5NBDF2MV7CTC4Q5128HF>; rel="prev"`, link)
}
func (suite *ReportsGetTestSuite) TestReportsGet3() {
func (suite *ReportsGetTestSuite) TestReportsGetTargetAccount() {
testAccount := suite.testAccounts["admin_account"]
testToken := suite.testTokens["admin_account"]
testUser := suite.testUsers["admin_account"]
@ -917,7 +917,7 @@ func (suite *ReportsGetTestSuite) TestReportsGet3() {
suite.Equal(`<http://localhost:8080/api/v1/admin/reports?limit=20&max_id=01GP3AWY4CRDVRNZKW0TEAMB5R&target_account_id=01F8MH5ZK5VRH73AKHQM6Y9VNX>; rel="next", <http://localhost:8080/api/v1/admin/reports?limit=20&min_id=01GP3AWY4CRDVRNZKW0TEAMB5R&target_account_id=01F8MH5ZK5VRH73AKHQM6Y9VNX>; rel="prev"`, link)
}
func (suite *ReportsGetTestSuite) TestReportsGet4() {
func (suite *ReportsGetTestSuite) TestReportsGetResolvedTargetAccount() {
testAccount := suite.testAccounts["admin_account"]
testToken := suite.testTokens["admin_account"]
testUser := suite.testUsers["admin_account"]
@ -935,7 +935,7 @@ func (suite *ReportsGetTestSuite) TestReportsGet4() {
suite.Empty(link)
}
func (suite *ReportsGetTestSuite) TestReportsGet6() {
func (suite *ReportsGetTestSuite) TestReportsGetNotAdmin() {
testAccount := suite.testAccounts["local_account_1"]
testToken := suite.testTokens["local_account_1"]
testUser := suite.testUsers["local_account_1"]
@ -945,6 +945,32 @@ func (suite *ReportsGetTestSuite) TestReportsGet6() {
suite.Empty(reports)
}
func (suite *ReportsGetTestSuite) TestReportsGetZeroLimit() {
testAccount := suite.testAccounts["admin_account"]
testToken := suite.testTokens["admin_account"]
testUser := suite.testUsers["admin_account"]
reports, link, err := suite.getReports(testAccount, testToken, testUser, http.StatusOK, "", nil, "", "", "", "", "", 0)
suite.NoError(err)
suite.Len(reports, 2)
// Limit in Link header should be set to 100
suite.Equal(`<http://localhost:8080/api/v1/admin/reports?limit=100&max_id=01GP3AWY4CRDVRNZKW0TEAMB5R>; rel="next", <http://localhost:8080/api/v1/admin/reports?limit=100&min_id=01GP3DFY9XQ1TJMZT5BGAZPXX7>; rel="prev"`, link)
}
func (suite *ReportsGetTestSuite) TestReportsGetHighLimit() {
testAccount := suite.testAccounts["admin_account"]
testToken := suite.testTokens["admin_account"]
testUser := suite.testUsers["admin_account"]
reports, link, err := suite.getReports(testAccount, testToken, testUser, http.StatusOK, "", nil, "", "", "", "", "", 2000)
suite.NoError(err)
suite.Len(reports, 2)
// Limit in Link header should be set to 100
suite.Equal(`<http://localhost:8080/api/v1/admin/reports?limit=100&max_id=01GP3AWY4CRDVRNZKW0TEAMB5R>; rel="next", <http://localhost:8080/api/v1/admin/reports?limit=100&min_id=01GP3DFY9XQ1TJMZT5BGAZPXX7>; rel="prev"`, link)
}
func TestReportsGetTestSuite(t *testing.T) {
suite.Run(t, &ReportsGetTestSuite{})
}