From 4ce5c37df5b69b09c6759ef751eb39a8bc839094 Mon Sep 17 00:00:00 2001 From: tobi <31960611+tsmethurst@users.noreply.github.com> Date: Tue, 18 Jun 2024 18:18:35 +0200 Subject: [PATCH] [bugfix] rename `include_types[]` to `types[]` (#3023) --- .../api/client/notifications/notifications.go | 4 ++-- .../client/notifications/notificationsget.go | 2 +- .../notifications/notificationsget_test.go | 18 +++++++++--------- internal/db/bundb/notification.go | 6 +++--- internal/db/notification.go | 4 ++-- internal/processing/timeline/notification.go | 4 ++-- 6 files changed, 19 insertions(+), 19 deletions(-) diff --git a/internal/api/client/notifications/notifications.go b/internal/api/client/notifications/notifications.go index ab015427e..cb1edf3ff 100644 --- a/internal/api/client/notifications/notifications.go +++ b/internal/api/client/notifications/notifications.go @@ -34,8 +34,8 @@ const ( BasePathWithID = BasePath + "/:" + IDKey BasePathWithClear = BasePath + "/clear" - // IncludeTypesKey names an array param specifying notification types to include. - IncludeTypesKey = "include_types[]" + // TypesKey names an array param specifying notification types to include. + TypesKey = "types[]" // ExcludeTypesKey names an array param specifying notification types to exclude. ExcludeTypesKey = "exclude_types[]" MaxIDKey = "max_id" diff --git a/internal/api/client/notifications/notificationsget.go b/internal/api/client/notifications/notificationsget.go index 533932d11..f7bcf1994 100644 --- a/internal/api/client/notifications/notificationsget.go +++ b/internal/api/client/notifications/notificationsget.go @@ -171,7 +171,7 @@ func (m *Module) NotificationsGETHandler(c *gin.Context) { c.Query(SinceIDKey), c.Query(MinIDKey), limit, - c.QueryArray(IncludeTypesKey), + c.QueryArray(TypesKey), c.QueryArray(ExcludeTypesKey), ) if errWithCode != nil { diff --git a/internal/api/client/notifications/notificationsget_test.go b/internal/api/client/notifications/notificationsget_test.go index 118303cae..97d0e854b 100644 --- a/internal/api/client/notifications/notificationsget_test.go +++ b/internal/api/client/notifications/notificationsget_test.go @@ -45,7 +45,7 @@ func (suite *NotificationsTestSuite) getNotifications( maxID string, minID string, limit int, - includeTypes []string, + types []string, excludeTypes []string, expectedHTTPStatus int, expectedBody string, @@ -71,8 +71,8 @@ func (suite *NotificationsTestSuite) getNotifications( if limit != 0 { query.Set(notifications.LimitKey, strconv.Itoa(limit)) } - if len(includeTypes) > 0 { - query[notifications.IncludeTypesKey] = includeTypes + if len(types) > 0 { + query[notifications.TypesKey] = types } if len(excludeTypes) > 0 { query[notifications.ExcludeTypesKey] = excludeTypes @@ -123,7 +123,7 @@ func (suite *NotificationsTestSuite) TestGetNotificationsSingle() { maxID := "" minID := "" limit := 10 - includeTypes := []string(nil) + types := []string(nil) excludeTypes := []string(nil) expectedHTTPStatus := http.StatusOK expectedBody := "" @@ -135,7 +135,7 @@ func (suite *NotificationsTestSuite) TestGetNotificationsSingle() { maxID, minID, limit, - includeTypes, + types, excludeTypes, expectedHTTPStatus, expectedBody, @@ -181,7 +181,7 @@ func (suite *NotificationsTestSuite) TestGetNotificationsExcludeOneType() { maxID := "" minID := "" limit := 10 - includeTypes := []string(nil) + types := []string(nil) excludeTypes := []string{"follow_request"} expectedHTTPStatus := http.StatusOK expectedBody := "" @@ -193,7 +193,7 @@ func (suite *NotificationsTestSuite) TestGetNotificationsExcludeOneType() { maxID, minID, limit, - includeTypes, + types, excludeTypes, expectedHTTPStatus, expectedBody, @@ -220,7 +220,7 @@ func (suite *NotificationsTestSuite) TestGetNotificationsIncludeOneType() { maxID := "" minID := "" limit := 10 - includeTypes := []string{"favourite"} + types := []string{"favourite"} excludeTypes := []string(nil) expectedHTTPStatus := http.StatusOK expectedBody := "" @@ -232,7 +232,7 @@ func (suite *NotificationsTestSuite) TestGetNotificationsIncludeOneType() { maxID, minID, limit, - includeTypes, + types, excludeTypes, expectedHTTPStatus, expectedBody, diff --git a/internal/db/bundb/notification.go b/internal/db/bundb/notification.go index af147ab08..d5a96dd2d 100644 --- a/internal/db/bundb/notification.go +++ b/internal/db/bundb/notification.go @@ -200,7 +200,7 @@ func (n *notificationDB) GetAccountNotifications( sinceID string, minID string, limit int, - includeTypes []string, + types []string, excludeTypes []string, ) ([]*gtsmodel.Notification, error) { // Ensure reasonable @@ -238,9 +238,9 @@ func (n *notificationDB) GetAccountNotifications( frontToBack = false // page up } - if len(includeTypes) > 0 { + if len(types) > 0 { // Include only requested notification types. - q = q.Where("? IN (?)", bun.Ident("notification.notification_type"), bun.In(includeTypes)) + q = q.Where("? IN (?)", bun.Ident("notification.notification_type"), bun.In(types)) } if len(excludeTypes) > 0 { diff --git a/internal/db/notification.go b/internal/db/notification.go index 2e8f5ed1f..deb58835a 100644 --- a/internal/db/notification.go +++ b/internal/db/notification.go @@ -28,8 +28,8 @@ type Notification interface { // GetAccountNotifications returns a slice of notifications that pertain to the given accountID. // // Returned notifications will be ordered ID descending (ie., highest/newest to lowest/oldest). - // If includeTypes is empty, *all* notification types will be included. - GetAccountNotifications(ctx context.Context, accountID string, maxID string, sinceID string, minID string, limit int, includeTypes []string, excludeTypes []string) ([]*gtsmodel.Notification, error) + // If types is empty, *all* notification types will be included. + GetAccountNotifications(ctx context.Context, accountID string, maxID string, sinceID string, minID string, limit int, types []string, excludeTypes []string) ([]*gtsmodel.Notification, error) // GetNotificationByID returns one notification according to its id. GetNotificationByID(ctx context.Context, id string) (*gtsmodel.Notification, error) diff --git a/internal/processing/timeline/notification.go b/internal/processing/timeline/notification.go index 697649444..0db4080b9 100644 --- a/internal/processing/timeline/notification.go +++ b/internal/processing/timeline/notification.go @@ -41,7 +41,7 @@ func (p *Processor) NotificationsGet( sinceID string, minID string, limit int, - includeTypes []string, + types []string, excludeTypes []string, ) (*apimodel.PageableResponse, gtserror.WithCode) { notifs, err := p.state.DB.GetAccountNotifications( @@ -51,7 +51,7 @@ func (p *Processor) NotificationsGet( sinceID, minID, limit, - includeTypes, + types, excludeTypes, ) if err != nil && !errors.Is(err, db.ErrNoEntries) {