[API] Add pagination to ListBranches (#14524)

* make PaginateUserSlice generic -> PaginateSlice

* Add pagination to ListBranches

* add skip, limit to Repository.GetBranches()

* Move routers/api/v1/utils/utils PaginateSlice -> modules/util/paginate.go

* repo_module.GetBranches paginate

* fix & rename & more logging

* better description

Co-authored-by: zeripath <art27@cantab.net>
Co-authored-by: a1012112796 <1012112796@qq.com>

2 files changed, 81 insertions, 0 deletions

diff --git a/modules/util/paginate.go b/modules/util/paginate.go
new file mode 100644
index 0000000000..2baa71664e
--- /dev/null
+++ b/modules/util/paginate.go
@@ -0,0 +1,34 @@
+// Copyright 2021 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package util
+
+import "reflect"
+
+// PaginateSlice cut a slice as per pagination options
+// if page = 0 it do not paginate
+func PaginateSlice(list interface{}, page, pageSize int) interface{} {
+	if page <= 0 || pageSize <= 0 {
+		return list
+	}
+	if reflect.TypeOf(list).Kind() != reflect.Slice {
+		return list
+	}
+
+	listValue := reflect.ValueOf(list)
+
+	page--
+
+	if page*pageSize >= listValue.Len() {
+		return listValue.Slice(listValue.Len(), listValue.Len()).Interface()
+	}
+
+	listValue = listValue.Slice(page*pageSize, listValue.Len())
+
+	if listValue.Len() > pageSize {
+		return listValue.Slice(0, pageSize).Interface()
+	}
+
+	return listValue.Interface()
+}
diff --git a/modules/util/paginate_test.go b/modules/util/paginate_test.go
new file mode 100644
index 0000000000..d962e04c16
--- /dev/null
+++ b/modules/util/paginate_test.go
@@ -0,0 +1,47 @@
+// Copyright 2021 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package util
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestPaginateSlice(t *testing.T) {
+	stringSlice := []string{"a", "b", "c", "d", "e"}
+	result, ok := PaginateSlice(stringSlice, 1, 2).([]string)
+	assert.True(t, ok)
+	assert.EqualValues(t, []string{"a", "b"}, result)
+
+	result, ok = PaginateSlice(stringSlice, 100, 2).([]string)
+	assert.True(t, ok)
+	assert.EqualValues(t, []string{}, result)
+
+	result, ok = PaginateSlice(stringSlice, 3, 2).([]string)
+	assert.True(t, ok)
+	assert.EqualValues(t, []string{"e"}, result)
+
+	result, ok = PaginateSlice(stringSlice, 1, 0).([]string)
+	assert.True(t, ok)
+	assert.EqualValues(t, []string{"a", "b", "c", "d", "e"}, result)
+
+	result, ok = PaginateSlice(stringSlice, 1, -1).([]string)
+	assert.True(t, ok)
+	assert.EqualValues(t, []string{"a", "b", "c", "d", "e"}, result)
+
+	type Test struct {
+		Val int
+	}
+
+	var testVar = []*Test{{Val: 2}, {Val: 3}, {Val: 4}}
+	testVar, ok = PaginateSlice(testVar, 1, 50).([]*Test)
+	assert.True(t, ok)
+	assert.EqualValues(t, []*Test{{Val: 2}, {Val: 3}, {Val: 4}}, testVar)
+
+	testVar, ok = PaginateSlice(testVar, 2, 2).([]*Test)
+	assert.True(t, ok)
+	assert.EqualValues(t, []*Test{{Val: 4}}, testVar)
+}