MM-17912: Allow searching for files through plugin API (#13647)
* constants and options for getting files * Method to get files with options * Add i18n strings for en * Add API methods for getting files with options * gofmt -s file * explicitly set create at in tests * use greater than nanosecond time difference for tests * use gte instead of gt for getting files by created time * use created at time as default sort order for getting file infos * use explicit inline strings instead of format strings * join tables only when required * use if as secondary sort, and update tests * update field docs to reflect previous changes * make page and perPage get options as required * add json struct tags to GetFileOptions * bump minimum server versioni * remove sorting by username and channelname * use bool for sort order type * use FileInfo prefix instead of just File * clearer comments * use zero-based page numbering * test filtering by user and channel * remove unnecessary whitespace * use int instead of uint for page and perPage arguments Co-authored-by: mattermod <mattermod@users.noreply.github.com>
Этот коммит содержится в:
Ashish Bhate
коммит произвёл
GitHub
GitHub
родитель
ed52acd89c
Коммит
3fc5287f6b
@@ -5,6 +5,7 @@ package sqlstore
|
||||
|
||||
import (
|
||||
"database/sql"
|
||||
"fmt"
|
||||
"net/http"
|
||||
|
||||
sq "github.com/Masterminds/squirrel"
|
||||
@@ -95,6 +96,75 @@ func (fs SqlFileInfoStore) Get(id string) (*model.FileInfo, *model.AppError) {
|
||||
return info, nil
|
||||
}
|
||||
|
||||
func (fs SqlFileInfoStore) GetWithOptions(page, perPage int, opt *model.GetFileInfosOptions) ([]*model.FileInfo, *model.AppError) {
|
||||
if perPage < 0 || page < 0 {
|
||||
return nil, model.NewAppError("SqlFileInfoStore.GetWithOptions",
|
||||
"store.sql_file_info.get_with_options.app_error", nil, fmt.Sprintf("page=%d and perPage=%d must be non-negative", page, perPage), http.StatusBadRequest)
|
||||
}
|
||||
if perPage == 0 {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
if opt == nil {
|
||||
opt = &model.GetFileInfosOptions{}
|
||||
}
|
||||
|
||||
query := fs.getQueryBuilder().
|
||||
Select("FileInfo.*").
|
||||
From("FileInfo")
|
||||
|
||||
if len(opt.ChannelIds) > 0 {
|
||||
query = query.Join("Posts ON FileInfo.PostId = Posts.Id").
|
||||
Where(sq.Eq{"Posts.ChannelId": opt.ChannelIds})
|
||||
}
|
||||
|
||||
if len(opt.UserIds) > 0 {
|
||||
query = query.Where(sq.Eq{"FileInfo.CreatorId": opt.UserIds})
|
||||
}
|
||||
|
||||
if opt.Since > 0 {
|
||||
query = query.Where(sq.GtOrEq{"FileInfo.CreateAt": opt.Since})
|
||||
}
|
||||
|
||||
if !opt.IncludeDeleted {
|
||||
query = query.Where("FileInfo.DeleteAt = 0")
|
||||
}
|
||||
|
||||
if opt.SortBy == "" {
|
||||
opt.SortBy = model.FILEINFO_SORT_BY_CREATED
|
||||
}
|
||||
sortDirection := "ASC"
|
||||
if opt.SortDescending {
|
||||
sortDirection = "DESC"
|
||||
}
|
||||
|
||||
switch opt.SortBy {
|
||||
case model.FILEINFO_SORT_BY_CREATED:
|
||||
query = query.OrderBy("FileInfo.CreateAt " + sortDirection)
|
||||
case model.FILEINFO_SORT_BY_SIZE:
|
||||
query = query.OrderBy("FileInfo.Size " + sortDirection)
|
||||
default:
|
||||
return nil, model.NewAppError("SqlFileInfoStore.GetWithOptions",
|
||||
"store.sql_file_info.get_with_options.app_error", nil, "invalid sort option", http.StatusBadRequest)
|
||||
}
|
||||
|
||||
query = query.OrderBy("FileInfo.Id ASC") // secondary sort for sort stability
|
||||
|
||||
query = query.Limit(uint64(perPage)).Offset(uint64(perPage * page))
|
||||
|
||||
queryString, args, err := query.ToSql()
|
||||
if err != nil {
|
||||
return nil, model.NewAppError("SqlFileInfoStore.GetWithOptions",
|
||||
"store.sql.build_query.app_error", nil, err.Error(), http.StatusInternalServerError)
|
||||
}
|
||||
var infos []*model.FileInfo
|
||||
if _, err := fs.GetReplica().Select(&infos, queryString, args...); err != nil {
|
||||
return nil, model.NewAppError("SqlFileInfoStore.GetWithOptions",
|
||||
"store.sql_file_info.get_with_options.app_error", nil, err.Error(), http.StatusInternalServerError)
|
||||
}
|
||||
return infos, nil
|
||||
}
|
||||
|
||||
func (fs SqlFileInfoStore) GetByPath(path string) (*model.FileInfo, *model.AppError) {
|
||||
info := &model.FileInfo{}
|
||||
|
||||
|
||||
@@ -494,6 +494,7 @@ type FileInfoStore interface {
|
||||
GetByPath(path string) (*model.FileInfo, *model.AppError)
|
||||
GetForPost(postId string, readFromMaster, includeDeleted, allowFromCache bool) ([]*model.FileInfo, *model.AppError)
|
||||
GetForUser(userId string) ([]*model.FileInfo, *model.AppError)
|
||||
GetWithOptions(page, perPage int, opt *model.GetFileInfosOptions) ([]*model.FileInfo, *model.AppError)
|
||||
InvalidateFileInfosForPostCache(postId string)
|
||||
AttachToPost(fileId string, postId string, creatorId string) *model.AppError
|
||||
DeleteForPost(postId string) (string, *model.AppError)
|
||||
|
||||
@@ -7,6 +7,7 @@ import (
|
||||
"fmt"
|
||||
"sort"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/mattermost/mattermost-server/v5/model"
|
||||
"github.com/mattermost/mattermost-server/v5/store"
|
||||
@@ -20,6 +21,7 @@ func TestFileInfoStore(t *testing.T, ss store.Store) {
|
||||
t.Run("FileInfoSaveGetByPath", func(t *testing.T) { testFileInfoSaveGetByPath(t, ss) })
|
||||
t.Run("FileInfoGetForPost", func(t *testing.T) { testFileInfoGetForPost(t, ss) })
|
||||
t.Run("FileInfoGetForUser", func(t *testing.T) { testFileInfoGetForUser(t, ss) })
|
||||
t.Run("FileInfoGetWithOptions", func(t *testing.T) { testFileInfoGetWithOptions(t, ss) })
|
||||
t.Run("FileInfoAttachToPost", func(t *testing.T) { testFileInfoAttachToPost(t, ss) })
|
||||
t.Run("FileInfoDeleteForPost", func(t *testing.T) { testFileInfoDeleteForPost(t, ss) })
|
||||
t.Run("FileInfoPermanentDelete", func(t *testing.T) { testFileInfoPermanentDelete(t, ss) })
|
||||
@@ -256,6 +258,143 @@ func testFileInfoGetForUser(t *testing.T, ss store.Store) {
|
||||
assert.Len(t, userPosts, 1)
|
||||
}
|
||||
|
||||
func testFileInfoGetWithOptions(t *testing.T, ss store.Store) {
|
||||
makePost := func(chId string, user string) model.Post {
|
||||
post := model.Post{}
|
||||
post.ChannelId = chId
|
||||
post.UserId = user
|
||||
_, err := ss.Post().Save(&post)
|
||||
require.Nil(t, err)
|
||||
return post
|
||||
}
|
||||
|
||||
makeFile := func(post model.Post, user string, createAt int64, idPrefix string) model.FileInfo {
|
||||
id := model.NewId()
|
||||
id = idPrefix + id[1:] // hacky way to get sortable Ids to confirm secondary Id sort works
|
||||
fileInfo := model.FileInfo{
|
||||
Id: id,
|
||||
CreatorId: user,
|
||||
Path: "file.txt",
|
||||
CreateAt: createAt,
|
||||
}
|
||||
if post.Id != "" {
|
||||
fileInfo.PostId = post.Id
|
||||
}
|
||||
_, err := ss.FileInfo().Save(&fileInfo)
|
||||
require.Nil(t, err)
|
||||
return fileInfo
|
||||
}
|
||||
|
||||
userId1 := model.NewId()
|
||||
userId2 := model.NewId()
|
||||
|
||||
channelId1 := model.NewId()
|
||||
channelId2 := model.NewId()
|
||||
channelId3 := model.NewId()
|
||||
|
||||
post1_1 := makePost(channelId1, userId1) // post 1 by user 1
|
||||
post1_2 := makePost(channelId3, userId1) // post 2 by user 1
|
||||
post2_1 := makePost(channelId2, userId2)
|
||||
post2_2 := makePost(channelId3, userId2)
|
||||
|
||||
epoch := time.Date(2020, 1, 1, 1, 1, 1, 1, time.UTC)
|
||||
file1_1 := makeFile(post1_1, userId1, epoch.AddDate(0, 0, 1).Unix(), "a") // file 1 by user 1
|
||||
file1_2 := makeFile(post1_2, userId1, epoch.AddDate(0, 0, 2).Unix(), "b") // file 2 by user 1
|
||||
file1_3 := makeFile(model.Post{}, userId1, epoch.AddDate(0, 0, 3).Unix(), "c") // file that is not attached to a post
|
||||
file2_1 := makeFile(post2_1, userId2, epoch.AddDate(0, 0, 4).Unix(), "d") // file 2 by user 1
|
||||
file2_2 := makeFile(post2_2, userId2, epoch.AddDate(0, 0, 5).Unix(), "e")
|
||||
|
||||
// delete a file
|
||||
_, err := ss.FileInfo().DeleteForPost(file2_2.PostId)
|
||||
require.Nil(t, err)
|
||||
|
||||
testCases := []struct {
|
||||
Name string
|
||||
Page, PerPage int
|
||||
Opt *model.GetFileInfosOptions
|
||||
ExpectedFileIds []string
|
||||
}{
|
||||
{
|
||||
Name: "Get files with nil option",
|
||||
Page: 0,
|
||||
PerPage: 10,
|
||||
Opt: nil,
|
||||
ExpectedFileIds: []string{file1_1.Id, file1_2.Id, file1_3.Id, file2_1.Id},
|
||||
},
|
||||
{
|
||||
Name: "Get files including deleted",
|
||||
Page: 0,
|
||||
PerPage: 10,
|
||||
Opt: &model.GetFileInfosOptions{IncludeDeleted: true},
|
||||
ExpectedFileIds: []string{file1_1.Id, file1_2.Id, file1_3.Id, file2_1.Id, file2_2.Id},
|
||||
},
|
||||
{
|
||||
Name: "Get files including deleted filtered by channel",
|
||||
Page: 0,
|
||||
PerPage: 10,
|
||||
Opt: &model.GetFileInfosOptions{
|
||||
IncludeDeleted: true,
|
||||
ChannelIds: []string{channelId3},
|
||||
},
|
||||
ExpectedFileIds: []string{file1_2.Id, file2_2.Id},
|
||||
},
|
||||
{
|
||||
Name: "Get files including deleted filtered by channel and user",
|
||||
Page: 0,
|
||||
PerPage: 10,
|
||||
Opt: &model.GetFileInfosOptions{
|
||||
IncludeDeleted: true,
|
||||
UserIds: []string{userId1},
|
||||
ChannelIds: []string{channelId3},
|
||||
},
|
||||
ExpectedFileIds: []string{file1_2.Id},
|
||||
},
|
||||
{
|
||||
Name: "Get files including deleted sorted by created at",
|
||||
Page: 0,
|
||||
PerPage: 10,
|
||||
Opt: &model.GetFileInfosOptions{
|
||||
IncludeDeleted: true,
|
||||
SortBy: model.FILEINFO_SORT_BY_CREATED,
|
||||
},
|
||||
ExpectedFileIds: []string{file1_1.Id, file1_2.Id, file1_3.Id, file2_1.Id, file2_2.Id},
|
||||
},
|
||||
{
|
||||
Name: "Get files filtered by user ordered by created at descending",
|
||||
Page: 0,
|
||||
PerPage: 10,
|
||||
Opt: &model.GetFileInfosOptions{
|
||||
UserIds: []string{userId1},
|
||||
SortBy: model.FILEINFO_SORT_BY_CREATED,
|
||||
SortDescending: true,
|
||||
},
|
||||
ExpectedFileIds: []string{file1_3.Id, file1_2.Id, file1_1.Id},
|
||||
},
|
||||
{
|
||||
Name: "Get all files including deleted ordered by created descending 2nd page of 3 per page ",
|
||||
Page: 1,
|
||||
PerPage: 3,
|
||||
Opt: &model.GetFileInfosOptions{
|
||||
IncludeDeleted: true,
|
||||
SortBy: model.FILEINFO_SORT_BY_CREATED,
|
||||
SortDescending: true,
|
||||
},
|
||||
ExpectedFileIds: []string{file1_2.Id, file1_1.Id},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.Name, func(t *testing.T) {
|
||||
fileInfos, err := ss.FileInfo().GetWithOptions(tc.Page, tc.PerPage, tc.Opt)
|
||||
require.Nil(t, err)
|
||||
require.Len(t, fileInfos, len(tc.ExpectedFileIds))
|
||||
for i := range tc.ExpectedFileIds {
|
||||
assert.Equal(t, tc.ExpectedFileIds[i], fileInfos[i].Id)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
type byFileInfoId []*model.FileInfo
|
||||
|
||||
func (a byFileInfoId) Len() int { return len(a) }
|
||||
|
||||
@@ -158,6 +158,31 @@ func (_m *FileInfoStore) GetForUser(userId string) ([]*model.FileInfo, *model.Ap
|
||||
return r0, r1
|
||||
}
|
||||
|
||||
// GetWithOptions provides a mock function with given fields: page, perPage, opt
|
||||
func (_m *FileInfoStore) GetWithOptions(page int, perPage int, opt *model.GetFileInfosOptions) ([]*model.FileInfo, *model.AppError) {
|
||||
ret := _m.Called(page, perPage, opt)
|
||||
|
||||
var r0 []*model.FileInfo
|
||||
if rf, ok := ret.Get(0).(func(int, int, *model.GetFileInfosOptions) []*model.FileInfo); ok {
|
||||
r0 = rf(page, perPage, opt)
|
||||
} else {
|
||||
if ret.Get(0) != nil {
|
||||
r0 = ret.Get(0).([]*model.FileInfo)
|
||||
}
|
||||
}
|
||||
|
||||
var r1 *model.AppError
|
||||
if rf, ok := ret.Get(1).(func(int, int, *model.GetFileInfosOptions) *model.AppError); ok {
|
||||
r1 = rf(page, perPage, opt)
|
||||
} else {
|
||||
if ret.Get(1) != nil {
|
||||
r1 = ret.Get(1).(*model.AppError)
|
||||
}
|
||||
}
|
||||
|
||||
return r0, r1
|
||||
}
|
||||
|
||||
// InvalidateFileInfosForPostCache provides a mock function with given fields: postId
|
||||
func (_m *FileInfoStore) InvalidateFileInfosForPostCache(postId string) {
|
||||
_m.Called(postId)
|
||||
|
||||
Ссылка в новой задаче
Block a user