oss/miniflux-v2
oss/miniflux-v2
1
0
Fork 0
mirror of https://github.com/miniflux/v2.git synced 2025-09-15 18:57:04 +00:00
Code Wiki Activity

Refactor Batch Builder and prevent accidental and excessive refreshes from the web ui

Browse source
This commit is contained in:
Frédéric Guillot 2023-10-20 15:12:02 -07:00
parent 95ee1c423b
commit 4cc99881d8
32 changed files with 251 additions and 176 deletions
Download patch file Download diff file Expand all files Collapse all files

46
internal/ui/category_refresh.go
View file

@ -6,10 +6,13 @@ package ui // import "miniflux.app/v2/internal/ui"
import (
"log/slog"
"net/http"
"time"
"miniflux.app/v2/internal/http/request"
"miniflux.app/v2/internal/http/response/html"
"miniflux.app/v2/internal/http/route"
"miniflux.app/v2/internal/locale"
"miniflux.app/v2/internal/ui/session"
)
func (h *handler) refreshCategoryEntriesPage(w http.ResponseWriter, r *http.Request) {
@ -25,21 +28,38 @@ func (h *handler) refreshCategoryFeedsPage(w http.ResponseWriter, r *http.Reques
func (h *handler) refreshCategory(w http.ResponseWriter, r *http.Request) int64 {
userID := request.UserID(r)
categoryID := request.RouteInt64Param(r, "categoryID")
printer := locale.NewPrinter(request.UserLanguage(r))
sess := session.New(h.store, request.SessionID(r))
jobs, err := h.store.NewCategoryBatch(userID, categoryID, h.store.CountFeeds(userID))
if err != nil {
html.ServerError(w, r, err)
return 0
// Avoid accidental and excessive refreshes.
if time.Now().UTC().Unix()-request.LastForceRefresh(r) < 1800 {
sess.NewFlashErrorMessage(printer.Printf("alert.too_many_feeds_refresh"))
} else {
// We allow the end-user to force refresh all its feeds in this category
// without taking into consideration the number of errors.
batchBuilder := h.store.NewBatchBuilder()
batchBuilder.WithoutDisabledFeeds()
batchBuilder.WithUserID(userID)
batchBuilder.WithCategoryID(categoryID)
jobs, err := batchBuilder.FetchJobs()
if err != nil {
html.ServerError(w, r, err)
return 0
}
slog.Info(
"Triggered a manual refresh of all feeds for a given category from the web ui",
slog.Int64("user_id", userID),
slog.Int64("category_id", categoryID),
slog.Int("nb_jobs", len(jobs)),
)
go h.pool.Push(jobs)
sess.SetLastForceRefresh()
sess.NewFlashMessage(printer.Printf("alert.background_feed_refresh"))
}
slog.Info(
"Triggered a manual refresh of all feeds for a given category from the web ui",
slog.Int64("user_id", userID),
slog.Int64("category_id", categoryID),
slog.Int("nb_jobs", len(jobs)),
)
go h.pool.Push(jobs)
return categoryID
}

60
internal/ui/feed_refresh.go
View file

@ -6,13 +6,14 @@ package ui // import "miniflux.app/v2/internal/ui"
import (
"log/slog"
"net/http"
"time"
"miniflux.app/v2/internal/http/request"
"miniflux.app/v2/internal/http/response/html"
"miniflux.app/v2/internal/http/route"
"miniflux.app/v2/internal/locale"
feedHandler "miniflux.app/v2/internal/reader/handler"
"miniflux.app/v2/internal/ui/session"
"miniflux.app/v2/internal/ui/view"
)
func (h *handler) refreshFeed(w http.ResponseWriter, r *http.Request) {
@ -32,33 +33,36 @@ func (h *handler) refreshFeed(w http.ResponseWriter, r *http.Request) {
func (h *handler) refreshAllFeeds(w http.ResponseWriter, r *http.Request) {
userID := request.UserID(r)
user, err := h.store.UserByID(userID)
if err != nil {
html.ServerError(w, r, err)
return
}
jobs, err := h.store.NewUserBatch(userID, h.store.CountFeeds(userID))
if err != nil {
html.ServerError(w, r, err)
return
}
slog.Info(
"Triggered a manual refresh of all feeds from the web ui",
slog.Int64("user_id", userID),
slog.Int("nb_jobs", len(jobs)),
)
go h.pool.Push(jobs)
printer := locale.NewPrinter(request.UserLanguage(r))
sess := session.New(h.store, request.SessionID(r))
view := view.New(h.tpl, r, sess)
view.Set("menu", "feeds")
view.Set("user", user)
view.Set("countUnread", h.store.CountUnreadEntries(user.ID))
view.Set("countErrorFeeds", h.store.CountUserFeedsWithErrors(user.ID))
html.OK(w, r, view.Render("feed_background_refresh"))
// Avoid accidental and excessive refreshes.
if time.Now().UTC().Unix()-request.LastForceRefresh(r) < 1800 {
sess.NewFlashErrorMessage(printer.Printf("alert.too_many_feeds_refresh"))
} else {
// We allow the end-user to force refresh all its feeds
// without taking into consideration the number of errors.
batchBuilder := h.store.NewBatchBuilder()
batchBuilder.WithoutDisabledFeeds()
batchBuilder.WithUserID(userID)
jobs, err := batchBuilder.FetchJobs()
if err != nil {
html.ServerError(w, r, err)
return
}
slog.Info(
"Triggered a manual refresh of all feeds from the web ui",
slog.Int64("user_id", userID),
slog.Int("nb_jobs", len(jobs)),
)
go h.pool.Push(jobs)
sess.SetLastForceRefresh()
sess.NewFlashMessage(printer.Printf("alert.background_feed_refresh"))
}
html.Redirect(w, r, route.Path(h.router, "feeds"))
}

2
internal/ui/middleware.go
View file

@ -119,6 +119,8 @@ func (m *middleware) handleAppSession(next http.Handler) http.Handler {
ctx = context.WithValue(ctx, request.UserLanguageContextKey, session.Data.Language)
ctx = context.WithValue(ctx, request.UserThemeContextKey, session.Data.Theme)
ctx = context.WithValue(ctx, request.PocketRequestTokenContextKey, session.Data.PocketRequestToken)
ctx = context.WithValue(ctx, request.LastForceRefreshContextKey, session.Data.LastForceRefresh)
next.ServeHTTP(w, r.WithContext(ctx))
})
}

16
internal/ui/session/session.go
View file

@ -4,6 +4,8 @@
package session // import "miniflux.app/v2/internal/ui/session"
import (
"time"
"miniflux.app/v2/internal/storage"
)
@ -13,6 +15,15 @@ type Session struct {
sessionID string
}
// New returns a new session handler.
func New(store *storage.Storage, sessionID string) *Session {
return &Session{store, sessionID}
}
func (s *Session) SetLastForceRefresh() {
s.store.UpdateAppSessionField(s.sessionID, "last_force_refresh", time.Now().UTC().Unix())
}
func (s *Session) SetOAuth2State(state string) {
s.store.UpdateAppSessionField(s.sessionID, "oauth2_state", state)
}
@ -61,8 +72,3 @@ func (s *Session) SetTheme(theme string) {
func (s *Session) SetPocketRequestToken(requestToken string) {
s.store.UpdateAppSessionField(s.sessionID, "pocket_request_token", requestToken)
}
// New returns a new session handler.
func New(store *storage.Storage, sessionID string) *Session {
return &Session{store, sessionID}
}