Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Respond with updated notifications in API #17064

Merged
merged 4 commits into from
Sep 17, 2021
Merged

Respond with updated notifications in API #17064

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
db3d8ca
notifications api: return updated notifications in response
noerw Sep 15, 2021
626f8e9
make generate-swagger
noerw Sep 15, 2021
c0f8398
openapi fix
noerw Sep 16, 2021
511ba0f
Merge branch 'main' into better-notifications-api-responses
zeripath Sep 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions models/notification.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -772,20 +772,20 @@ func setRepoNotificationStatusReadIfUnread(e Engine, userID, repoID int64) error
}

// SetNotificationStatus change the notification status
func SetNotificationStatus(notificationID int64, user *User, status NotificationStatus) error {
func SetNotificationStatus(notificationID int64, user *User, status NotificationStatus) (*Notification, error) {
notification, err := getNotificationByID(x, notificationID)
if err != nil {
return err
return notification, err
}

if notification.UserID != user.ID {
return fmt.Errorf("Can't change notification of another user: %d, %d", notification.UserID, user.ID)
return nil, fmt.Errorf("Can't change notification of another user: %d, %d", notification.UserID, user.ID)
}

notification.Status = status

_, err = x.ID(notificationID).Update(notification)
return err
return notification, err
}

// GetNotificationByID return notification by ID
Expand Down
9 changes: 6 additions & 3 deletions models/notification_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,15 @@ func TestSetNotificationStatus(t *testing.T) {
user := AssertExistsAndLoadBean(t, &User{ID: 2}).(*User)
notf := AssertExistsAndLoadBean(t,
&Notification{UserID: user.ID, Status: NotificationStatusRead}).(*Notification)
assert.NoError(t, SetNotificationStatus(notf.ID, user, NotificationStatusPinned))
_, err := SetNotificationStatus(notf.ID, user, NotificationStatusPinned)
assert.NoError(t, err)
AssertExistsAndLoadBean(t,
&Notification{ID: notf.ID, Status: NotificationStatusPinned})

assert.Error(t, SetNotificationStatus(1, user, NotificationStatusRead))
assert.Error(t, SetNotificationStatus(NonexistentID, user, NotificationStatusRead))
_, err = SetNotificationStatus(1, user, NotificationStatusRead)
assert.Error(t, err)
_, err = SetNotificationStatus(NonexistentID, user, NotificationStatusRead)
assert.Error(t, err)
}

func TestUpdateNotificationStatuses(t *testing.T) {
Expand Down
13 changes: 8 additions & 5 deletions routers/api/v1/notify/repo.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
"code.gitea.io/gitea/modules/context"
"code.gitea.io/gitea/modules/convert"
"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/structs"
)

func statusStringToNotificationStatus(status string) models.NotificationStatus {
Expand Down Expand Up @@ -176,7 +177,7 @@ func ReadRepoNotifications(ctx *context.APIContext) {
// required: false
// responses:
// "205":
// "$ref": "#/responses/empty"
// "$ref": "#/responses/NotificationThreadList"

lastRead := int64(0)
qLastRead := ctx.FormTrim("last_read_at")
Expand Down Expand Up @@ -213,14 +214,16 @@ func ReadRepoNotifications(ctx *context.APIContext) {
targetStatus = models.NotificationStatusRead
}

changed := make([]*structs.NotificationThread, len(nl))

for _, n := range nl {
err := models.SetNotificationStatus(n.ID, ctx.User, targetStatus)
notif, err := models.SetNotificationStatus(n.ID, ctx.User, targetStatus)
if err != nil {
ctx.InternalServerError(err)
return
}
ctx.Status(http.StatusResetContent)
_ = notif.LoadAttributes()
changed = append(changed, convert.ToNotificationThread(notif))
}

ctx.Status(http.StatusResetContent)
ctx.JSON(http.StatusResetContent, changed)
}
10 changes: 7 additions & 3 deletions routers/api/v1/notify/threads.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ func ReadThread(ctx *context.APIContext) {
// required: false
// responses:
// "205":
// "$ref": "#/responses/empty"
// "$ref": "#/responses/NotificationThread"
// "403":
// "$ref": "#/responses/forbidden"
// "404":
Expand All @@ -87,12 +87,16 @@ func ReadThread(ctx *context.APIContext) {
targetStatus = models.NotificationStatusRead
}

err := models.SetNotificationStatus(n.ID, ctx.User, targetStatus)
notif, err := models.SetNotificationStatus(n.ID, ctx.User, targetStatus)
if err != nil {
ctx.InternalServerError(err)
return
}
ctx.Status(http.StatusResetContent)
if err = notif.LoadAttributes(); err != nil {
ctx.InternalServerError(err)
return
}
ctx.JSON(http.StatusResetContent, convert.ToNotificationThread(notif))
}

func getThread(ctx *context.APIContext) *models.Notification {
Expand Down
12 changes: 8 additions & 4 deletions routers/api/v1/notify/user.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (
"code.gitea.io/gitea/models"
"code.gitea.io/gitea/modules/context"
"code.gitea.io/gitea/modules/convert"
"code.gitea.io/gitea/modules/structs"
)

// ListNotifications list users's notification threads
Expand Down Expand Up @@ -125,7 +126,7 @@ func ReadNotifications(ctx *context.APIContext) {
// required: false
// responses:
// "205":
// "$ref": "#/responses/empty"
// "$ref": "#/responses/NotificationThreadList"

lastRead := int64(0)
qLastRead := ctx.FormTrim("last_read_at")
Expand Down Expand Up @@ -158,14 +159,17 @@ func ReadNotifications(ctx *context.APIContext) {
targetStatus = models.NotificationStatusRead
}

changed := make([]*structs.NotificationThread, 0, len(nl))

for _, n := range nl {
err := models.SetNotificationStatus(n.ID, ctx.User, targetStatus)
notif, err := models.SetNotificationStatus(n.ID, ctx.User, targetStatus)
if err != nil {
ctx.InternalServerError(err)
return
}
ctx.Status(http.StatusResetContent)
_ = notif.LoadAttributes()
changed = append(changed, convert.ToNotificationThread(notif))
}

ctx.Status(http.StatusResetContent)
ctx.JSON(http.StatusResetContent, changed)
}
2 changes: 1 addition & 1 deletion routers/web/user/notification.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ func NotificationStatusPost(c *context.Context) {
return
}

if err := models.SetNotificationStatus(notificationID, c.User, status); err != nil {
if _, err := models.SetNotificationStatus(notificationID, c.User, status); err != nil {
c.ServerError("SetNotificationStatus", err)
return
}
Expand Down
6 changes: 3 additions & 3 deletions templates/swagger/v1_json.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -739,7 +739,7 @@
],
"responses": {
"205": {
"$ref": "#/responses/empty"
"$ref": "#/responses/NotificationThreadList"
}
}
}
Expand Down Expand Up @@ -822,7 +822,7 @@
],
"responses": {
"205": {
"$ref": "#/responses/empty"
"$ref": "#/responses/NotificationThread"
},
"403": {
"$ref": "#/responses/forbidden"
Expand Down Expand Up @@ -7058,7 +7058,7 @@
],
"responses": {
"205": {
"$ref": "#/responses/empty"
"$ref": "#/responses/NotificationThreadList"
}
}
}
Expand Down