mirror of https://github.com/go-gitea/gitea
[API] Add notification endpoint (#9488)
* [API] Add notification endpoints
* add func GetNotifications(opts FindNotificationOptions)
* add func (n *Notification) APIFormat()
* add func (nl NotificationList) APIFormat()
* add func (n *Notification) APIURL()
* add func (nl NotificationList) APIFormat()
* add LoadAttributes functions (loadRepo, loadIssue, loadComment, loadUser)
* add func (c *Comment) APIURL()
* add func (issue *Issue) GetLastComment()
* add endpoint GET /notifications
* add endpoint PUT /notifications
* add endpoint GET /repos/{owner}/{repo}/notifications
* add endpoint PUT /repos/{owner}/{repo}/notifications
* add endpoint GET /notifications/threads/{id}
* add endpoint PATCH /notifications/threads/{id}
* Add TEST
* code format
* code format
pull/9186/head
6543
5 years ago
committed by
zeripath
parent
ee9ce0cfa9
commit
6baa5d7588
@ -0,0 +1,106 @@ |
||||
// Copyright 2020 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 integrations |
||||
|
||||
import ( |
||||
"fmt" |
||||
"net/http" |
||||
"testing" |
||||
|
||||
"code.gitea.io/gitea/models" |
||||
api "code.gitea.io/gitea/modules/structs" |
||||
|
||||
"github.com/stretchr/testify/assert" |
||||
) |
||||
|
||||
func TestAPINotification(t *testing.T) { |
||||
defer prepareTestEnv(t)() |
||||
|
||||
user2 := models.AssertExistsAndLoadBean(t, &models.User{ID: 2}).(*models.User) |
||||
repo1 := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 1}).(*models.Repository) |
||||
thread5 := models.AssertExistsAndLoadBean(t, &models.Notification{ID: 5}).(*models.Notification) |
||||
assert.NoError(t, thread5.LoadAttributes()) |
||||
session := loginUser(t, user2.Name) |
||||
token := getTokenForLoggedInUser(t, session) |
||||
|
||||
// -- GET /notifications --
|
||||
// test filter
|
||||
since := "2000-01-01T00%3A50%3A01%2B00%3A00" //946687801
|
||||
req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications?since=%s&token=%s", since, token)) |
||||
resp := session.MakeRequest(t, req, http.StatusOK) |
||||
var apiNL []api.NotificationThread |
||||
DecodeJSON(t, resp, &apiNL) |
||||
|
||||
assert.Len(t, apiNL, 1) |
||||
assert.EqualValues(t, 5, apiNL[0].ID) |
||||
|
||||
// test filter
|
||||
before := "2000-01-01T01%3A06%3A59%2B00%3A00" //946688819
|
||||
|
||||
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications?all=%s&before=%s&token=%s", "true", before, token)) |
||||
resp = session.MakeRequest(t, req, http.StatusOK) |
||||
DecodeJSON(t, resp, &apiNL) |
||||
|
||||
assert.Len(t, apiNL, 3) |
||||
assert.EqualValues(t, 4, apiNL[0].ID) |
||||
assert.EqualValues(t, true, apiNL[0].Unread) |
||||
assert.EqualValues(t, false, apiNL[0].Pinned) |
||||
assert.EqualValues(t, 3, apiNL[1].ID) |
||||
assert.EqualValues(t, false, apiNL[1].Unread) |
||||
assert.EqualValues(t, true, apiNL[1].Pinned) |
||||
assert.EqualValues(t, 2, apiNL[2].ID) |
||||
assert.EqualValues(t, false, apiNL[2].Unread) |
||||
assert.EqualValues(t, false, apiNL[2].Pinned) |
||||
|
||||
// -- GET /repos/{owner}/{repo}/notifications --
|
||||
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/%s/%s/notifications?token=%s", user2.Name, repo1.Name, token)) |
||||
resp = session.MakeRequest(t, req, http.StatusOK) |
||||
DecodeJSON(t, resp, &apiNL) |
||||
|
||||
assert.Len(t, apiNL, 1) |
||||
assert.EqualValues(t, 4, apiNL[0].ID) |
||||
|
||||
// -- GET /notifications/threads/{id} --
|
||||
// get forbidden
|
||||
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications/threads/%d?token=%s", 1, token)) |
||||
resp = session.MakeRequest(t, req, http.StatusForbidden) |
||||
|
||||
// get own
|
||||
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications/threads/%d?token=%s", thread5.ID, token)) |
||||
resp = session.MakeRequest(t, req, http.StatusOK) |
||||
var apiN api.NotificationThread |
||||
DecodeJSON(t, resp, &apiN) |
||||
|
||||
assert.EqualValues(t, 5, apiN.ID) |
||||
assert.EqualValues(t, false, apiN.Pinned) |
||||
assert.EqualValues(t, true, apiN.Unread) |
||||
assert.EqualValues(t, "issue4", apiN.Subject.Title) |
||||
assert.EqualValues(t, "Issue", apiN.Subject.Type) |
||||
assert.EqualValues(t, thread5.Issue.APIURL(), apiN.Subject.URL) |
||||
assert.EqualValues(t, thread5.Repository.HTMLURL(), apiN.Repository.HTMLURL) |
||||
|
||||
// -- mark notifications as read --
|
||||
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications?token=%s", token)) |
||||
resp = session.MakeRequest(t, req, http.StatusOK) |
||||
DecodeJSON(t, resp, &apiNL) |
||||
assert.Len(t, apiNL, 2) |
||||
|
||||
lastReadAt := "2000-01-01T00%3A50%3A01%2B00%3A00" //946687801 <- only Notification 4 is in this filter ...
|
||||
req = NewRequest(t, "PUT", fmt.Sprintf("/api/v1/repos/%s/%s/notifications?last_read_at=%s&token=%s", user2.Name, repo1.Name, lastReadAt, token)) |
||||
resp = session.MakeRequest(t, req, http.StatusResetContent) |
||||
|
||||
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications?token=%s", token)) |
||||
resp = session.MakeRequest(t, req, http.StatusOK) |
||||
DecodeJSON(t, resp, &apiNL) |
||||
assert.Len(t, apiNL, 1) |
||||
|
||||
// -- PATCH /notifications/threads/{id} --
|
||||
req = NewRequest(t, "PATCH", fmt.Sprintf("/api/v1/notifications/threads/%d?token=%s", thread5.ID, token)) |
||||
resp = session.MakeRequest(t, req, http.StatusResetContent) |
||||
|
||||
assert.Equal(t, models.NotificationStatusUnread, thread5.Status) |
||||
thread5 = models.AssertExistsAndLoadBean(t, &models.Notification{ID: 5}).(*models.Notification) |
||||
assert.Equal(t, models.NotificationStatusRead, thread5.Status) |
||||
} |
||||
@ -0,0 +1,28 @@ |
||||
// Copyright 2019 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 structs |
||||
|
||||
import ( |
||||
"time" |
||||
) |
||||
|
||||
// NotificationThread expose Notification on API
|
||||
type NotificationThread struct { |
||||
ID int64 `json:"id"` |
||||
Repository *Repository `json:"repository"` |
||||
Subject *NotificationSubject `json:"subject"` |
||||
Unread bool `json:"unread"` |
||||
Pinned bool `json:"pinned"` |
||||
UpdatedAt time.Time `json:"updated_at"` |
||||
URL string `json:"url"` |
||||
} |
||||
|
||||
// NotificationSubject contains the notification subject (Issue/Pull/Commit)
|
||||
type NotificationSubject struct { |
||||
Title string `json:"title"` |
||||
URL string `json:"url"` |
||||
LatestCommentURL string `json:"latest_comment_url"` |
||||
Type string `json:"type" binding:"In(Issue,Pull,Commit)"` |
||||
} |
||||
@ -0,0 +1,151 @@ |
||||
// Copyright 2020 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 notify |
||||
|
||||
import ( |
||||
"net/http" |
||||
"strings" |
||||
"time" |
||||
|
||||
"code.gitea.io/gitea/models" |
||||
"code.gitea.io/gitea/modules/context" |
||||
"code.gitea.io/gitea/routers/api/v1/utils" |
||||
) |
||||
|
||||
// ListRepoNotifications list users's notification threads on a specific repo
|
||||
func ListRepoNotifications(ctx *context.APIContext) { |
||||
// swagger:operation GET /repos/{owner}/{repo}/notifications notification notifyGetRepoList
|
||||
// ---
|
||||
// summary: List users's notification threads on a specific repo
|
||||
// consumes:
|
||||
// - application/json
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: owner
|
||||
// in: path
|
||||
// description: owner of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: repo
|
||||
// in: path
|
||||
// description: name of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: all
|
||||
// in: query
|
||||
// description: If true, show notifications marked as read. Default value is false
|
||||
// type: string
|
||||
// required: false
|
||||
// - name: since
|
||||
// in: query
|
||||
// description: Only show notifications updated after the given time. This is a timestamp in RFC 3339 format
|
||||
// type: string
|
||||
// format: date-time
|
||||
// required: false
|
||||
// - name: before
|
||||
// in: query
|
||||
// description: Only show notifications updated before the given time. This is a timestamp in RFC 3339 format
|
||||
// type: string
|
||||
// format: date-time
|
||||
// required: false
|
||||
// responses:
|
||||
// "200":
|
||||
// "$ref": "#/responses/NotificationThreadList"
|
||||
|
||||
before, since, err := utils.GetQueryBeforeSince(ctx) |
||||
if err != nil { |
||||
ctx.InternalServerError(err) |
||||
return |
||||
} |
||||
opts := models.FindNotificationOptions{ |
||||
UserID: ctx.User.ID, |
||||
RepoID: ctx.Repo.Repository.ID, |
||||
UpdatedBeforeUnix: before, |
||||
UpdatedAfterUnix: since, |
||||
} |
||||
qAll := strings.Trim(ctx.Query("all"), " ") |
||||
if qAll != "true" { |
||||
opts.Status = models.NotificationStatusUnread |
||||
} |
||||
nl, err := models.GetNotifications(opts) |
||||
if err != nil { |
||||
ctx.InternalServerError(err) |
||||
return |
||||
} |
||||
err = nl.LoadAttributes() |
||||
if err != nil { |
||||
ctx.InternalServerError(err) |
||||
return |
||||
} |
||||
|
||||
ctx.JSON(http.StatusOK, nl.APIFormat()) |
||||
} |
||||
|
||||
// ReadRepoNotifications mark notification threads as read on a specific repo
|
||||
func ReadRepoNotifications(ctx *context.APIContext) { |
||||
// swagger:operation PUT /repos/{owner}/{repo}/notifications notification notifyReadRepoList
|
||||
// ---
|
||||
// summary: Mark notification threads as read on a specific repo
|
||||
// consumes:
|
||||
// - application/json
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: owner
|
||||
// in: path
|
||||
// description: owner of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: repo
|
||||
// in: path
|
||||
// description: name of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: last_read_at
|
||||
// in: query
|
||||
// description: Describes the last point that notifications were checked. Anything updated since this time will not be updated.
|
||||
// type: string
|
||||
// format: date-time
|
||||
// required: false
|
||||
// responses:
|
||||
// "205":
|
||||
// "$ref": "#/responses/empty"
|
||||
|
||||
lastRead := int64(0) |
||||
qLastRead := strings.Trim(ctx.Query("last_read_at"), " ") |
||||
if len(qLastRead) > 0 { |
||||
tmpLastRead, err := time.Parse(time.RFC3339, qLastRead) |
||||
if err != nil { |
||||
ctx.InternalServerError(err) |
||||
return |
||||
} |
||||
if !tmpLastRead.IsZero() { |
||||
lastRead = tmpLastRead.Unix() |
||||
} |
||||
} |
||||
opts := models.FindNotificationOptions{ |
||||
UserID: ctx.User.ID, |
||||
RepoID: ctx.Repo.Repository.ID, |
||||
UpdatedBeforeUnix: lastRead, |
||||
Status: models.NotificationStatusUnread, |
||||
} |
||||
nl, err := models.GetNotifications(opts) |
||||
if err != nil { |
||||
ctx.InternalServerError(err) |
||||
return |
||||
} |
||||
|
||||
for _, n := range nl { |
||||
err := models.SetNotificationStatus(n.ID, ctx.User, models.NotificationStatusRead) |
||||
if err != nil { |
||||
ctx.InternalServerError(err) |
||||
return |
||||
} |
||||
ctx.Status(http.StatusResetContent) |
||||
} |
||||
|
||||
ctx.Status(http.StatusResetContent) |
||||
} |
||||
@ -0,0 +1,101 @@ |
||||
// Copyright 2020 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 notify |
||||
|
||||
import ( |
||||
"fmt" |
||||
"net/http" |
||||
|
||||
"code.gitea.io/gitea/models" |
||||
"code.gitea.io/gitea/modules/context" |
||||
) |
||||
|
||||
// GetThread get notification by ID
|
||||
func GetThread(ctx *context.APIContext) { |
||||
// swagger:operation GET /notifications/threads/{id} notification notifyGetThread
|
||||
// ---
|
||||
// summary: Get notification thread by ID
|
||||
// consumes:
|
||||
// - application/json
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: id
|
||||
// in: path
|
||||
// description: id of notification thread
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
// "200":
|
||||
// "$ref": "#/responses/NotificationThread"
|
||||
// "403":
|
||||
// "$ref": "#/responses/forbidden"
|
||||
// "404":
|
||||
// "$ref": "#/responses/notFound"
|
||||
|
||||
n := getThread(ctx) |
||||
if n == nil { |
||||
return |
||||
} |
||||
if err := n.LoadAttributes(); err != nil { |
||||
ctx.InternalServerError(err) |
||||
return |
||||
} |
||||
|
||||
ctx.JSON(http.StatusOK, n.APIFormat()) |
||||
} |
||||
|
||||
// ReadThread mark notification as read by ID
|
||||
func ReadThread(ctx *context.APIContext) { |
||||
// swagger:operation PATCH /notifications/threads/{id} notification notifyReadThread
|
||||
// ---
|
||||
// summary: Mark notification thread as read by ID
|
||||
// consumes:
|
||||
// - application/json
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: id
|
||||
// in: path
|
||||
// description: id of notification thread
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
// "205":
|
||||
// "$ref": "#/responses/empty"
|
||||
// "403":
|
||||
// "$ref": "#/responses/forbidden"
|
||||
// "404":
|
||||
// "$ref": "#/responses/notFound"
|
||||
|
||||
n := getThread(ctx) |
||||
if n == nil { |
||||
return |
||||
} |
||||
|
||||
err := models.SetNotificationStatus(n.ID, ctx.User, models.NotificationStatusRead) |
||||
if err != nil { |
||||
ctx.InternalServerError(err) |
||||
return |
||||
} |
||||
ctx.Status(http.StatusResetContent) |
||||
} |
||||
|
||||
func getThread(ctx *context.APIContext) *models.Notification { |
||||
n, err := models.GetNotificationByID(ctx.ParamsInt64(":id")) |
||||
if err != nil { |
||||
if models.IsErrNotExist(err) { |
||||
ctx.Error(http.StatusNotFound, "GetNotificationByID", err) |
||||
} else { |
||||
ctx.InternalServerError(err) |
||||
} |
||||
return nil |
||||
} |
||||
if n.UserID != ctx.User.ID && !ctx.User.IsAdmin { |
||||
ctx.Error(http.StatusForbidden, "GetNotificationByID", fmt.Errorf("only user itself and admin are allowed to read/change this thread %d", n.ID)) |
||||
return nil |
||||
} |
||||
return n |
||||
} |
||||
@ -0,0 +1,129 @@ |
||||
// Copyright 2020 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 notify |
||||
|
||||
import ( |
||||
"net/http" |
||||
"strings" |
||||
"time" |
||||
|
||||
"code.gitea.io/gitea/models" |
||||
"code.gitea.io/gitea/modules/context" |
||||
"code.gitea.io/gitea/routers/api/v1/utils" |
||||
) |
||||
|
||||
// ListNotifications list users's notification threads
|
||||
func ListNotifications(ctx *context.APIContext) { |
||||
// swagger:operation GET /notifications notification notifyGetList
|
||||
// ---
|
||||
// summary: List users's notification threads
|
||||
// consumes:
|
||||
// - application/json
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: all
|
||||
// in: query
|
||||
// description: If true, show notifications marked as read. Default value is false
|
||||
// type: string
|
||||
// required: false
|
||||
// - name: since
|
||||
// in: query
|
||||
// description: Only show notifications updated after the given time. This is a timestamp in RFC 3339 format
|
||||
// type: string
|
||||
// format: date-time
|
||||
// required: false
|
||||
// - name: before
|
||||
// in: query
|
||||
// description: Only show notifications updated before the given time. This is a timestamp in RFC 3339 format
|
||||
// type: string
|
||||
// format: date-time
|
||||
// required: false
|
||||
// responses:
|
||||
// "200":
|
||||
// "$ref": "#/responses/NotificationThreadList"
|
||||
|
||||
before, since, err := utils.GetQueryBeforeSince(ctx) |
||||
if err != nil { |
||||
ctx.InternalServerError(err) |
||||
return |
||||
} |
||||
opts := models.FindNotificationOptions{ |
||||
UserID: ctx.User.ID, |
||||
UpdatedBeforeUnix: before, |
||||
UpdatedAfterUnix: since, |
||||
} |
||||
qAll := strings.Trim(ctx.Query("all"), " ") |
||||
if qAll != "true" { |
||||
opts.Status = models.NotificationStatusUnread |
||||
} |
||||
nl, err := models.GetNotifications(opts) |
||||
if err != nil { |
||||
ctx.InternalServerError(err) |
||||
return |
||||
} |
||||
err = nl.LoadAttributes() |
||||
if err != nil { |
||||
ctx.InternalServerError(err) |
||||
return |
||||
} |
||||
|
||||
ctx.JSON(http.StatusOK, nl.APIFormat()) |
||||
} |
||||
|
||||
// ReadNotifications mark notification threads as read
|
||||
func ReadNotifications(ctx *context.APIContext) { |
||||
// swagger:operation PUT /notifications notification notifyReadList
|
||||
// ---
|
||||
// summary: Mark notification threads as read
|
||||
// consumes:
|
||||
// - application/json
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: last_read_at
|
||||
// in: query
|
||||
// description: Describes the last point that notifications were checked. Anything updated since this time will not be updated.
|
||||
// type: string
|
||||
// format: date-time
|
||||
// required: false
|
||||
// responses:
|
||||
// "205":
|
||||
// "$ref": "#/responses/empty"
|
||||
|
||||
lastRead := int64(0) |
||||
qLastRead := strings.Trim(ctx.Query("last_read_at"), " ") |
||||
if len(qLastRead) > 0 { |
||||
tmpLastRead, err := time.Parse(time.RFC3339, qLastRead) |
||||
if err != nil { |
||||
ctx.InternalServerError(err) |
||||
return |
||||
} |
||||
if !tmpLastRead.IsZero() { |
||||
lastRead = tmpLastRead.Unix() |
||||
} |
||||
} |
||||
opts := models.FindNotificationOptions{ |
||||
UserID: ctx.User.ID, |
||||
UpdatedBeforeUnix: lastRead, |
||||
Status: models.NotificationStatusUnread, |
||||
} |
||||
nl, err := models.GetNotifications(opts) |
||||
if err != nil { |
||||
ctx.InternalServerError(err) |
||||
return |
||||
} |
||||
|
||||
for _, n := range nl { |
||||
err := models.SetNotificationStatus(n.ID, ctx.User, models.NotificationStatusRead) |
||||
if err != nil { |
||||
ctx.InternalServerError(err) |
||||
return |
||||
} |
||||
ctx.Status(http.StatusResetContent) |
||||
} |
||||
|
||||
ctx.Status(http.StatusResetContent) |
||||
} |
||||
@ -0,0 +1,23 @@ |
||||
// Copyright 2019 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 swagger |
||||
|
||||
import ( |
||||
api "code.gitea.io/gitea/modules/structs" |
||||
) |
||||
|
||||
// NotificationThread
|
||||
// swagger:response NotificationThread
|
||||
type swaggerNotificationThread struct { |
||||
// in:body
|
||||
Body api.NotificationThread `json:"body"` |
||||
} |
||||
|
||||
// NotificationThreadList
|
||||
// swagger:response NotificationThreadList
|
||||
type swaggerNotificationThreadList struct { |
||||
// in:body
|
||||
Body []api.NotificationThread `json:"body"` |
||||
} |
||||
Loading…
Reference in new issue