Implement some post endpoints for APIv4 (#5353)

* Implement POST /posts endpoint for APIv4

* Implement GET /channels/{channel_id}/posts endpoint for APIv4

* Implement GET /posts/{post_id} endpoint for APIv4

* Implement GET /posts/{post_id}/thread endpoint for APIv4

* Skip team get if it's a DM channel in handlePostEvents
This commit is contained in:
Joram Wilander
2017-02-13 10:52:50 -05:00
committed by Corey Hulen
parent 260f1111e8
commit e4effd0c15
10 changed files with 491 additions and 12 deletions

View File

@@ -58,7 +58,7 @@ func createPost(c *Context, w http.ResponseWriter, r *http.Request) {
post.CreateAt = 0
}
rp, err := app.CreatePostAsUser(post, c.TeamId)
rp, err := app.CreatePostAsUser(post)
if err != nil {
c.Err = err
return

View File

@@ -140,6 +140,7 @@ func InitApi(full bool) {
InitUser()
InitTeam()
InitChannel()
InitPost()
app.Srv.Router.Handle("/api/v4/{anything:.*}", http.HandlerFunc(Handle404))

View File

@@ -26,6 +26,8 @@ type TestHelper struct {
TeamAdminUser *model.User
BasicTeam *model.Team
BasicChannel *model.Channel
BasicChannel2 *model.Channel
BasicPost *model.Post
SystemAdminClient *model.Client4
SystemAdminUser *model.User
@@ -97,12 +99,16 @@ func (me *TestHelper) InitBasic() *TestHelper {
me.LoginTeamAdmin()
me.BasicTeam = me.CreateTeam()
me.BasicChannel = me.CreatePublicChannel()
me.BasicChannel2 = me.CreatePublicChannel()
me.BasicPost = me.CreatePost()
me.BasicUser = me.CreateUser()
LinkUserToTeam(me.BasicUser, me.BasicTeam)
me.BasicUser2 = me.CreateUser()
LinkUserToTeam(me.BasicUser2, me.BasicTeam)
app.AddUserToChannel(me.BasicUser, me.BasicChannel)
app.AddUserToChannel(me.BasicUser2, me.BasicChannel)
app.AddUserToChannel(me.BasicUser, me.BasicChannel2)
app.AddUserToChannel(me.BasicUser2, me.BasicChannel2)
app.UpdateUserRoles(me.BasicUser.Id, model.ROLE_SYSTEM_USER.Id)
me.LoginBasic()
@@ -188,6 +194,27 @@ func (me *TestHelper) CreateChannelWithClient(client *model.Client4, channelType
return rchannel
}
func (me *TestHelper) CreatePost() *model.Post {
return me.CreatePostWithClient(me.Client, me.BasicChannel)
}
func (me *TestHelper) CreatePostWithClient(client *model.Client4, channel *model.Channel) *model.Post {
id := model.NewId()
post := &model.Post{
ChannelId: channel.Id,
Message: "message_" + id,
}
utils.DisableDebugLogForTest()
rpost, resp := client.CreatePost(post)
if resp.Error != nil {
panic(resp.Error)
}
utils.EnableDebugLogForTest()
return rpost
}
func (me *TestHelper) LoginBasic() {
me.LoginBasicWithClient(me.Client)
}

View File

@@ -331,8 +331,8 @@ func TestGetChannelMembersForUser(t *testing.T) {
members, resp := Client.GetChannelMembersForUser(th.BasicUser.Id, th.BasicTeam.Id, "")
CheckNoError(t, resp)
if len(*members) != 3 {
t.Fatal("should have 3 members on team")
if len(*members) != 4 {
t.Fatal("should have 4 members on team")
}
_, resp = Client.GetChannelMembersForUser("", th.BasicTeam.Id, "")

View File

@@ -375,6 +375,17 @@ func (c *Context) RequireUsername() *Context {
return c
}
func (c *Context) RequirePostId() *Context {
if c.Err != nil {
return c
}
if len(c.Params.PostId) != 26 {
c.SetInvalidUrlParam("post_id")
}
return c
}
func (c *Context) RequireEmail() *Context {
if c.Err != nil {
return c

119
api4/post.go Normal file
View File

@@ -0,0 +1,119 @@
// Copyright (c) 2017 Mattermost, Inc. All Rights Reserved.
// See License.txt for license information.
package api4
import (
"net/http"
l4g "github.com/alecthomas/log4go"
"github.com/mattermost/platform/app"
"github.com/mattermost/platform/model"
"github.com/mattermost/platform/utils"
)
func InitPost() {
l4g.Debug(utils.T("api.post.init.debug"))
BaseRoutes.Posts.Handle("", ApiSessionRequired(createPost)).Methods("POST")
BaseRoutes.Post.Handle("", ApiSessionRequired(getPost)).Methods("GET")
BaseRoutes.Post.Handle("/thread", ApiSessionRequired(getPostThread)).Methods("GET")
BaseRoutes.PostsForChannel.Handle("", ApiSessionRequired(getPostsForChannel)).Methods("GET")
}
func createPost(c *Context, w http.ResponseWriter, r *http.Request) {
post := model.PostFromJson(r.Body)
if post == nil {
c.SetInvalidParam("post")
return
}
post.UserId = c.Session.UserId
if !app.SessionHasPermissionToChannel(c.Session, post.ChannelId, model.PERMISSION_CREATE_POST) {
c.SetPermissionError(model.PERMISSION_CREATE_POST)
return
}
if post.CreateAt != 0 && !app.SessionHasPermissionTo(c.Session, model.PERMISSION_MANAGE_SYSTEM) {
post.CreateAt = 0
}
rp, err := app.CreatePostAsUser(post)
if err != nil {
c.Err = err
return
}
w.Write([]byte(rp.ToJson()))
}
func getPostsForChannel(c *Context, w http.ResponseWriter, r *http.Request) {
c.RequireChannelId()
if c.Err != nil {
return
}
if !app.SessionHasPermissionToChannel(c.Session, c.Params.ChannelId, model.PERMISSION_READ_CHANNEL) {
c.SetPermissionError(model.PERMISSION_READ_CHANNEL)
return
}
etag := app.GetPostsEtag(c.Params.ChannelId)
if HandleEtag(etag, "Get Posts", w, r) {
return
}
if list, err := app.GetPostsPage(c.Params.ChannelId, c.Params.Page, c.Params.PerPage); err != nil {
c.Err = err
return
} else {
w.Header().Set(model.HEADER_ETAG_SERVER, etag)
w.Write([]byte(list.ToJson()))
}
}
func getPost(c *Context, w http.ResponseWriter, r *http.Request) {
c.RequirePostId()
if c.Err != nil {
return
}
if !app.SessionHasPermissionToChannelByPost(c.Session, c.Params.PostId, model.PERMISSION_READ_CHANNEL) {
c.SetPermissionError(model.PERMISSION_READ_CHANNEL)
return
}
if post, err := app.GetSinglePost(c.Params.PostId); err != nil {
c.Err = err
return
} else if HandleEtag(post.Etag(), "Get Post", w, r) {
return
} else {
w.Header().Set(model.HEADER_ETAG_SERVER, post.Etag())
w.Write([]byte(post.ToJson()))
}
}
func getPostThread(c *Context, w http.ResponseWriter, r *http.Request) {
c.RequirePostId()
if c.Err != nil {
return
}
if !app.SessionHasPermissionToChannelByPost(c.Session, c.Params.PostId, model.PERMISSION_READ_CHANNEL) {
c.SetPermissionError(model.PERMISSION_READ_CHANNEL)
return
}
if list, err := app.GetPostThread(c.Params.PostId); err != nil {
c.Err = err
return
} else if HandleEtag(list.Etag(), "Get Post Thread", w, r) {
return
} else {
w.Header().Set(model.HEADER_ETAG_SERVER, list.Etag())
w.Write([]byte(list.ToJson()))
}
}

249
api4/post_test.go Normal file
View File

@@ -0,0 +1,249 @@
// Copyright (c) 2017 Mattermost, Inc. All Rights Reserved.
// See License.txt for license information.
package api4
import (
"net/http"
"strconv"
"testing"
"github.com/mattermost/platform/model"
)
func TestCreatePost(t *testing.T) {
th := Setup().InitBasic().InitSystemAdmin()
defer TearDown()
Client := th.Client
post := &model.Post{ChannelId: th.BasicChannel.Id, Message: "#hashtag a" + model.NewId() + "a"}
rpost, resp := Client.CreatePost(post)
CheckNoError(t, resp)
if rpost.Message != post.Message {
t.Fatal("message didn't match")
}
if rpost.Hashtags != "#hashtag" {
t.Fatal("hashtag didn't match")
}
if len(rpost.FileIds) != 0 {
t.Fatal("shouldn't have files")
}
if rpost.EditAt != 0 {
t.Fatal("newly created post shouldn't have EditAt set")
}
post.RootId = rpost.Id
post.ParentId = rpost.Id
_, resp = Client.CreatePost(post)
CheckNoError(t, resp)
post.RootId = "junk"
_, resp = Client.CreatePost(post)
CheckBadRequestStatus(t, resp)
post.RootId = rpost.Id
post.ParentId = "junk"
_, resp = Client.CreatePost(post)
CheckBadRequestStatus(t, resp)
post2 := &model.Post{ChannelId: th.BasicChannel2.Id, Message: "a" + model.NewId() + "a", CreateAt: 123}
rpost2, resp := Client.CreatePost(post2)
if rpost2.CreateAt == post2.CreateAt {
t.Fatal("create at should not match")
}
post.RootId = rpost2.Id
post.ParentId = rpost2.Id
_, resp = Client.CreatePost(post)
CheckBadRequestStatus(t, resp)
post.RootId = ""
post.ParentId = ""
post.ChannelId = "junk"
_, resp = Client.CreatePost(post)
CheckForbiddenStatus(t, resp)
post.ChannelId = model.NewId()
_, resp = Client.CreatePost(post)
CheckForbiddenStatus(t, resp)
if r, err := Client.DoApiPost("/posts", "garbage"); err == nil {
t.Fatal("should have errored")
} else {
if r.StatusCode != http.StatusBadRequest {
t.Log("actual: " + strconv.Itoa(r.StatusCode))
t.Log("expected: " + strconv.Itoa(http.StatusBadRequest))
t.Fatal("wrong status code")
}
}
Client.Logout()
_, resp = Client.CreatePost(post)
CheckUnauthorizedStatus(t, resp)
post.ChannelId = th.BasicChannel.Id
post.CreateAt = 123
rpost, resp = th.SystemAdminClient.CreatePost(post)
CheckNoError(t, resp)
if rpost.CreateAt != post.CreateAt {
t.Fatal("create at should match")
}
}
func TestGetPostsForChannel(t *testing.T) {
th := Setup().InitBasic().InitSystemAdmin()
defer TearDown()
Client := th.Client
post1 := th.CreatePost()
post2 := th.CreatePost()
post3 := th.CreatePost()
post4 := &model.Post{ChannelId: th.BasicChannel.Id, Message: "a" + model.NewId() + "a", RootId: post1.Id}
post4, _ = Client.CreatePost(post4)
posts, resp := Client.GetPostsForChannel(th.BasicChannel.Id, 0, 60, "")
CheckNoError(t, resp)
if posts.Order[0] != post4.Id {
t.Fatal("wrong order")
}
if posts.Order[1] != post3.Id {
t.Fatal("wrong order")
}
if posts.Order[2] != post2.Id {
t.Fatal("wrong order")
}
if posts.Order[3] != post1.Id {
t.Fatal("wrong order")
}
posts, resp = Client.GetPostsForChannel(th.BasicChannel.Id, 0, 3, resp.Etag)
CheckEtag(t, posts, resp)
posts, resp = Client.GetPostsForChannel(th.BasicChannel.Id, 0, 3, "")
CheckNoError(t, resp)
if len(posts.Order) != 3 {
t.Fatal("wrong number returned")
}
if _, ok := posts.Posts[post4.Id]; !ok {
t.Fatal("missing comment")
}
if _, ok := posts.Posts[post1.Id]; !ok {
t.Fatal("missing root post")
}
posts, resp = Client.GetPostsForChannel(th.BasicChannel.Id, 1, 1, "")
CheckNoError(t, resp)
if posts.Order[0] != post3.Id {
t.Fatal("wrong order")
}
posts, resp = Client.GetPostsForChannel(th.BasicChannel.Id, 10000, 10000, "")
CheckNoError(t, resp)
if len(posts.Order) != 0 {
t.Fatal("should be no posts")
}
_, resp = Client.GetPostsForChannel("", 0, 60, "")
CheckNotFoundStatus(t, resp)
_, resp = Client.GetPostsForChannel("junk", 0, 60, "")
CheckBadRequestStatus(t, resp)
_, resp = Client.GetPostsForChannel(model.NewId(), 0, 60, "")
CheckForbiddenStatus(t, resp)
Client.Logout()
_, resp = Client.GetPostsForChannel(model.NewId(), 0, 60, "")
CheckUnauthorizedStatus(t, resp)
_, resp = th.SystemAdminClient.GetPostsForChannel(th.BasicChannel.Id, 0, 60, "")
CheckNoError(t, resp)
}
func TestGetPost(t *testing.T) {
th := Setup().InitBasic().InitSystemAdmin()
defer TearDown()
Client := th.Client
post, resp := Client.GetPost(th.BasicPost.Id, "")
CheckNoError(t, resp)
if post.Id != th.BasicPost.Id {
t.Fatal("post ids don't match")
}
post, resp = Client.GetPost(th.BasicPost.Id, resp.Etag)
CheckEtag(t, post, resp)
_, resp = Client.GetPost("", "")
CheckNotFoundStatus(t, resp)
_, resp = Client.GetPost("junk", "")
CheckBadRequestStatus(t, resp)
_, resp = Client.GetPost(model.NewId(), "")
CheckForbiddenStatus(t, resp)
Client.Logout()
_, resp = Client.GetPost(model.NewId(), "")
CheckUnauthorizedStatus(t, resp)
post, resp = th.SystemAdminClient.GetPost(th.BasicPost.Id, "")
CheckNoError(t, resp)
}
func TestGetPostThread(t *testing.T) {
th := Setup().InitBasic().InitSystemAdmin()
defer TearDown()
Client := th.Client
post := &model.Post{ChannelId: th.BasicChannel.Id, Message: "a" + model.NewId() + "a", RootId: th.BasicPost.Id}
post, _ = Client.CreatePost(post)
list, resp := Client.GetPostThread(th.BasicPost.Id, "")
CheckNoError(t, resp)
var list2 *model.PostList
list2, resp = Client.GetPostThread(th.BasicPost.Id, resp.Etag)
CheckEtag(t, list2, resp)
if list.Order[0] != th.BasicPost.Id {
t.Fatal("wrong order")
}
if _, ok := list.Posts[th.BasicPost.Id]; !ok {
t.Fatal("should have had post")
}
if _, ok := list.Posts[post.Id]; !ok {
t.Fatal("should have had post")
}
_, resp = Client.GetPostThread("junk", "")
CheckBadRequestStatus(t, resp)
_, resp = Client.GetPostThread(model.NewId(), "")
CheckForbiddenStatus(t, resp)
Client.Logout()
_, resp = Client.GetPostThread(model.NewId(), "")
CheckUnauthorizedStatus(t, resp)
list, resp = th.SystemAdminClient.GetPostThread(th.BasicPost.Id, "")
CheckNoError(t, resp)
}

View File

@@ -15,7 +15,7 @@ import (
"github.com/mattermost/platform/utils"
)
func CreatePostAsUser(post *model.Post, teamId string) (*model.Post, *model.AppError) {
func CreatePostAsUser(post *model.Post) (*model.Post, *model.AppError) {
// Check that channel has not been deleted
var channel *model.Channel
if result := <-Srv.Store.Channel().Get(post.ChannelId, true); result.Err != nil {
@@ -32,7 +32,7 @@ func CreatePostAsUser(post *model.Post, teamId string) (*model.Post, *model.AppE
return nil, err
}
if rp, err := CreatePost(post, teamId, true); err != nil {
if rp, err := CreatePost(post, channel.TeamId, true); err != nil {
if err.Id == "api.post.create_post.root_id.app_error" ||
err.Id == "api.post.create_post.channel_root_id.app_error" ||
err.Id == "api.post.create_post.parent_id.app_error" {
@@ -118,15 +118,23 @@ func CreatePost(post *model.Post, teamId string, triggerWebhooks bool) (*model.P
}
func handlePostEvents(post *model.Post, teamId string, triggerWebhooks bool) *model.AppError {
tchan := Srv.Store.Team().Get(teamId)
var tchan store.StoreChannel
if len(teamId) > 0 {
tchan = Srv.Store.Team().Get(teamId)
}
cchan := Srv.Store.Channel().Get(post.ChannelId, true)
uchan := Srv.Store.User().Get(post.UserId)
var team *model.Team
if result := <-tchan; result.Err != nil {
return result.Err
if tchan != nil {
if result := <-tchan; result.Err != nil {
return result.Err
} else {
team = result.Data.(*model.Team)
}
} else {
team = result.Data.(*model.Team)
// Blank team for DMs
team = &model.Team{}
}
var channel *model.Channel
@@ -306,6 +314,14 @@ func UpdatePost(post *model.Post) (*model.Post, *model.AppError) {
}
}
func GetPostsPage(channelId string, page int, perPage int) (*model.PostList, *model.AppError) {
if result := <-Srv.Store.Post().GetPosts(channelId, page*perPage, perPage, true); result.Err != nil {
return nil, result.Err
} else {
return result.Data.(*model.PostList), nil
}
}
func GetPosts(channelId string, offset int, limit int) (*model.PostList, *model.AppError) {
if result := <-Srv.Store.Post().GetPosts(channelId, offset, limit, true); result.Err != nil {
return nil, result.Err
@@ -456,7 +472,7 @@ func SearchPostsInTeam(terms string, userId string, teamId string, isOrSearch bo
}
func GetFileInfosForPost(postId string) ([]*model.FileInfo, *model.AppError) {
pchan := Srv.Store.Post().Get(postId)
pchan := Srv.Store.Post().GetSingle(postId)
fchan := Srv.Store.FileInfo().GetForPost(postId, true)
var infos []*model.FileInfo
@@ -472,7 +488,7 @@ func GetFileInfosForPost(postId string) ([]*model.FileInfo, *model.AppError) {
if result := <-pchan; result.Err != nil {
return nil, result.Err
} else {
post = result.Data.(*model.PostList).Posts[postId]
post = result.Data.(*model.Post)
}
if len(post.Filenames) > 0 {

View File

@@ -92,6 +92,14 @@ func (c *Client4) GetChannelMemberRoute(channelId, userId string) string {
return fmt.Sprintf(c.GetChannelMembersRoute(channelId)+"/%v", userId)
}
func (c *Client4) GetPostsRoute() string {
return fmt.Sprintf("/posts")
}
func (c *Client4) GetPostRoute(postId string) string {
return fmt.Sprintf(c.GetPostsRoute()+"/%v", postId)
}
func (c *Client4) DoApiGet(url string, etag string) (*http.Response, *AppError) {
return c.DoApiRequest(http.MethodGet, url, "", etag)
}
@@ -468,4 +476,47 @@ func (c *Client4) GetChannelMembersForUser(userId, teamId, etag string) (*Channe
}
// Post Section
// CreatePost creates a post based on the provided post struct.
func (c *Client4) CreatePost(post *Post) (*Post, *Response) {
if r, err := c.DoApiPost(c.GetPostsRoute(), post.ToJson()); err != nil {
return nil, &Response{StatusCode: r.StatusCode, Error: err}
} else {
defer closeBody(r)
return PostFromJson(r.Body), BuildResponse(r)
}
}
// GetPost gets a single post.
func (c *Client4) GetPost(postId string, etag string) (*Post, *Response) {
if r, err := c.DoApiGet(c.GetPostRoute(postId), etag); err != nil {
return nil, &Response{StatusCode: r.StatusCode, Error: err}
} else {
defer closeBody(r)
return PostFromJson(r.Body), BuildResponse(r)
}
}
// GetPostThread gets a post with all the other posts in the same thread.
func (c *Client4) GetPostThread(postId string, etag string) (*PostList, *Response) {
if r, err := c.DoApiGet(c.GetPostRoute(postId)+"/thread", etag); err != nil {
return nil, &Response{StatusCode: r.StatusCode, Error: err}
} else {
defer closeBody(r)
return PostListFromJson(r.Body), BuildResponse(r)
}
}
// GetPostsForChannel gets a page of posts with an array for ordering for a channel.
func (c *Client4) GetPostsForChannel(channelId string, page, perPage int, etag string) (*PostList, *Response) {
query := fmt.Sprintf("?page=%v&per_page=%v", page, perPage)
if r, err := c.DoApiGet(c.GetChannelRoute(channelId)+"/posts"+query, etag); err != nil {
return nil, &Response{StatusCode: r.StatusCode, Error: err}
} else {
defer closeBody(r)
return PostListFromJson(r.Body), BuildResponse(r)
}
}
// Files Section
// to be filled in..

View File

@@ -75,7 +75,12 @@ func (o *PostList) Etag() string {
}
}
return Etag(id, t)
orderId := ""
if len(o.Order) > 0 {
orderId = o.Order[0]
}
return Etag(orderId, id, t)
}
func (o *PostList) IsChannelId(channelId string) bool {