refactor: view models (resolve #634)

muety · Apr 1, 2024 · 6149b0f · 6149b0f
1 parent 724265f
commit 6149b0f
Show file tree

Hide file tree

Showing 18 changed files with 6,391 additions and 6,324 deletions.
diff --git a/coverage/coverage.out b/coverage/coverage.out
diff --git a/models/view/common.go b/models/view/common.go
@@ -1,5 +1,10 @@
 package view
 
+import (
+	conf "github.com/muety/wakapi/config"
+	"github.com/muety/wakapi/models"
+)
+
 type BasicViewModel interface {
 	SetError(string)
 	SetSuccess(string)
@@ -10,6 +15,29 @@ type Messages struct {
 	Error   string
 }
 
+type SharedViewModel struct {
+	Messages
+	LeaderboardEnabled bool
+	InvitesEnabled     bool
+}
+
+type SharedLoggedInViewModel struct {
+	SharedViewModel
+	User   *models.User
+	ApiKey string
+}
+
+func NewSharedViewModel(c *conf.Config, messages *Messages) SharedViewModel {
+	vm := SharedViewModel{
+		LeaderboardEnabled: c.App.LeaderboardEnabled,
+		InvitesEnabled:     c.Security.InviteCodes,
+	}
+	if messages != nil {
+		vm.Messages = *messages
+	}
+	return vm
+}
+
 func (m *Messages) SetError(message string) {
 	m.Error = message
 }

diff --git a/models/view/home.go b/models/view/home.go
@@ -6,11 +6,10 @@ type Newsbox struct {
 }
 
 type HomeViewModel struct {
-	Messages
-	TotalHours         int
-	TotalUsers         int
-	LeaderboardEnabled bool
-	Newsbox            *Newsbox
+	SharedViewModel
+	TotalHours int
+	TotalUsers int
+	Newsbox    *Newsbox
 }
 
 func (s *HomeViewModel) WithSuccess(m string) *HomeViewModel {

diff --git a/models/view/imprint.go b/models/view/imprint.go
@@ -1,7 +1,7 @@
 package view
 
 type ImprintViewModel struct {
-	Messages
+	SharedViewModel
 	HtmlText string
 }
 

diff --git a/models/view/leaderboard.go b/models/view/leaderboard.go
@@ -7,17 +7,14 @@ import (
 )
 
 type LeaderboardViewModel struct {
-	Messages
-	User               *models.User
-	By                 string
-	Key                string
-	Items              []*models.LeaderboardItemRanked
-	TopKeys            []string
-	UserLanguages      map[string][]string
-	IntervalLabel      string
-	LeaderboardEnabled bool
-	ApiKey             string
-	PageParams         *utils.PageParams
+	SharedLoggedInViewModel
+	By            string
+	Key           string
+	Items         []*models.LeaderboardItemRanked
+	TopKeys       []string
+	UserLanguages map[string][]string
+	IntervalLabel string
+	PageParams    *utils.PageParams
 }
 
 func (s *LeaderboardViewModel) WithSuccess(m string) *LeaderboardViewModel {

diff --git a/models/view/login.go b/models/view/login.go
@@ -1,7 +1,7 @@
 package view
 
 type LoginViewModel struct {
-	Messages
+	SharedViewModel
 	TotalUsers  int
 	AllowSignup bool
 	InviteCode  string

diff --git a/models/view/projects.go b/models/view/projects.go
@@ -10,13 +10,10 @@ import (
 )
 
 type ProjectsViewModel struct {
-	Messages
-	User               *models.User
-	Projects           []*models.ProjectStats
-	LeaderboardEnabled bool
-	ApiKey             string
-	PageParams         *utils.PageParams
-	maxCount           int64
+	SharedLoggedInViewModel
+	Projects   []*models.ProjectStats
+	PageParams *utils.PageParams
+	maxCount   int64
 }
 
 func (s *ProjectsViewModel) LangIcon(lang string) string {

diff --git a/models/view/settings.go b/models/view/settings.go
@@ -6,8 +6,7 @@ import (
 )
 
 type SettingsViewModel struct {
-	Messages
-	User                *models.User
+	SharedLoggedInViewModel
 	LanguageMappings    []*models.LanguageMapping
 	Aliases             []*SettingsVMCombinedAlias
 	Labels              []*SettingsVMCombinedLabel
@@ -16,9 +15,6 @@ type SettingsViewModel struct {
 	DataRetentionMonths int
 	UserFirstData       time.Time
 	SupportContact      string
-	LeaderboardEnabled  bool
-	ApiKey              string
-	InvitesEnabled      bool
 	InviteLink          string
 }
 

diff --git a/models/view/summary.go b/models/view/summary.go
@@ -7,28 +7,24 @@ import (
 )
 
 type SummaryViewModel struct {
-	Messages
+	SharedLoggedInViewModel
 	*models.Summary
 	*models.SummaryParams
-	User                *models.User
 	AvatarURL           string
 	EditorColors        map[string]string
 	LanguageColors      map[string]string
 	OSColors            map[string]string
-	ApiKey              string
 	RawQuery            string
 	UserFirstData       time.Time
 	DataRetentionMonths int
-	LeaderboardEnabled  bool
-	InvitesEnabled      bool
 }
 
 func (s SummaryViewModel) UserDataExpiring() bool {
 	cfg := conf.Get()
 	return cfg.Subscriptions.Enabled &&
 		cfg.App.DataRetentionMonths > 0 &&
 		!s.UserFirstData.IsZero() &&
-		!s.User.HasActiveSubscription() &&
+		!s.SharedLoggedInViewModel.User.HasActiveSubscription() &&
 		time.Now().AddDate(0, -cfg.App.DataRetentionMonths, 0).After(s.UserFirstData)
 }
 

diff --git a/routes/home.go b/routes/home.go
@@ -82,10 +82,10 @@ func (h *HomeHandler) buildViewModel(r *http.Request, w http.ResponseWriter) *vi
 	}
 
 	vm := &view.HomeViewModel{
-		TotalHours:         totalHours,
-		TotalUsers:         totalUsers,
-		Newsbox:            &newsbox,
-		LeaderboardEnabled: h.config.App.LeaderboardEnabled,
+		SharedViewModel: view.NewSharedViewModel(h.config, nil),
+		TotalHours:      totalHours,
+		TotalUsers:      totalUsers,
+		Newsbox:         &newsbox,
 	}
 	return routeutils.WithSessionMessages(vm, r, w)
 }
diff --git a/routes/imprint.go b/routes/imprint.go
@@ -39,5 +39,7 @@ func (h *ImprintHandler) GetImprint(w http.ResponseWriter, r *http.Request) {
 }
 
 func (h *ImprintHandler) buildViewModel(r *http.Request) *view.ImprintViewModel {
-	return &view.ImprintViewModel{}
+	return &view.ImprintViewModel{
+		SharedViewModel: view.NewSharedViewModel(h.config, nil),
+	}
 }
diff --git a/routes/leaderboard.go b/routes/leaderboard.go
@@ -74,7 +74,9 @@ func (h *LeaderboardHandler) buildViewModel(r *http.Request, w http.ResponseWrit
 		if err != nil {
 			conf.Log().Request(r).Error("error while fetching general leaderboard items - %v", err)
 			return &view.LeaderboardViewModel{
-				Messages: view.Messages{Error: criticalError}, LeaderboardEnabled: true,
+				SharedLoggedInViewModel: view.SharedLoggedInViewModel{
+					SharedViewModel: view.NewSharedViewModel(h.config, &view.Messages{Error: criticalError}),
+				},
 			}
 		}
 
@@ -93,7 +95,9 @@ func (h *LeaderboardHandler) buildViewModel(r *http.Request, w http.ResponseWrit
 			if err != nil {
 				conf.Log().Request(r).Error("error while fetching general leaderboard items - %v", err)
 				return &view.LeaderboardViewModel{
-					Messages: view.Messages{Error: criticalError}, LeaderboardEnabled: true,
+					SharedLoggedInViewModel: view.SharedLoggedInViewModel{
+						SharedViewModel: view.NewSharedViewModel(h.config, &view.Messages{Error: criticalError}),
+					},
 				}
 			}
 
@@ -127,8 +131,9 @@ func (h *LeaderboardHandler) buildViewModel(r *http.Request, w http.ResponseWrit
 			}
 		} else {
 			return &view.LeaderboardViewModel{
-				Messages:           view.Messages{Error: fmt.Sprintf("unsupported aggregation '%s'", byParam)},
-				LeaderboardEnabled: true,
+				SharedLoggedInViewModel: view.SharedLoggedInViewModel{
+					SharedViewModel: view.NewSharedViewModel(h.config, &view.Messages{Error: fmt.Sprintf("unsupported aggregation '%s'", byParam)}),
+				},
 			}
 		}
 	}
@@ -141,16 +146,18 @@ func (h *LeaderboardHandler) buildViewModel(r *http.Request, w http.ResponseWrit
 	leaderboard.FilterEmpty()
 
 	vm := &view.LeaderboardViewModel{
-		User:               user,
-		By:                 byParam,
-		Key:                keyParam,
-		Items:              leaderboard,
-		UserLanguages:      userLanguages,
-		TopKeys:            topKeys,
-		IntervalLabel:      h.leaderboardService.GetDefaultScope().GetHumanReadable(),
-		LeaderboardEnabled: true,
-		ApiKey:             apiKey,
-		PageParams:         pageParams,
+		SharedLoggedInViewModel: view.SharedLoggedInViewModel{
+			SharedViewModel: view.NewSharedViewModel(h.config, nil),
+			User:            user,
+			ApiKey:          apiKey,
+		},
+		By:            byParam,
+		Key:           keyParam,
+		Items:         leaderboard,
+		UserLanguages: userLanguages,
+		TopKeys:       topKeys,
+		IntervalLabel: h.leaderboardService.GetDefaultScope().GetHumanReadable(),
+		PageParams:    pageParams,
 	}
 	return routeutils.WithSessionMessages(vm, r, w)
 }
diff --git a/routes/login.go b/routes/login.go
@@ -356,9 +356,10 @@ func (h *LoginHandler) buildViewModel(r *http.Request, w http.ResponseWriter) *v
 	numUsers, _ := h.userSrvc.Count()
 
 	vm := &view.LoginViewModel{
-		TotalUsers:  int(numUsers),
-		AllowSignup: h.config.IsDev() || h.config.Security.AllowSignup,
-		InviteCode:  r.URL.Query().Get("invite"),
+		SharedViewModel: view.NewSharedViewModel(h.config, nil),
+		TotalUsers:      int(numUsers),
+		AllowSignup:     h.config.IsDev() || h.config.Security.AllowSignup,
+		InviteCode:      r.URL.Query().Get("invite"),
 	}
 	return routeutils.WithSessionMessages(vm, r, w)
 }
diff --git a/routes/projects.go b/routes/projects.go
@@ -67,17 +67,22 @@ func (h *ProjectsHandler) buildViewModel(r *http.Request, w http.ResponseWriter)
 	if err != nil {
 		conf.Log().Request(r).Error("error while fetching project stats for '%s' - %v", user.ID, err)
 		return &view.ProjectsViewModel{
-			Messages:           view.Messages{Error: criticalError},
-			LeaderboardEnabled: h.config.App.LeaderboardEnabled,
+			SharedLoggedInViewModel: view.SharedLoggedInViewModel{
+				SharedViewModel: view.NewSharedViewModel(h.config, &view.Messages{Error: criticalError}),
+				User:            user,
+				ApiKey:          user.ApiKey,
+			},
 		}
 	}
 
 	vm := &view.ProjectsViewModel{
-		User:               user,
-		Projects:           projects,
-		LeaderboardEnabled: h.config.App.LeaderboardEnabled,
-		ApiKey:             user.ApiKey,
-		PageParams:         pageParams,
+		SharedLoggedInViewModel: view.SharedLoggedInViewModel{
+			SharedViewModel: view.NewSharedViewModel(h.config, nil),
+			User:            user,
+			ApiKey:          user.ApiKey,
+		},
+		Projects:   projects,
+		PageParams: pageParams,
 	}
 	return routeutils.WithSessionMessages(vm, r, w)
 }
diff --git a/routes/settings.go b/routes/settings.go
@@ -806,7 +806,13 @@ func (h *SettingsHandler) buildViewModel(r *http.Request, w http.ResponseWriter,
 	aliases, err := h.aliasSrvc.GetByUser(user.ID)
 	if err != nil {
 		conf.Log().Request(r).Error("error while building alias map - %v", err)
-		return &view.SettingsViewModel{Messages: view.Messages{Error: criticalError}, LeaderboardEnabled: h.config.App.LeaderboardEnabled}
+		return &view.SettingsViewModel{
+			SharedLoggedInViewModel: view.SharedLoggedInViewModel{
+				SharedViewModel: view.NewSharedViewModel(h.config, &view.Messages{Error: criticalError}),
+				User:            user,
+				ApiKey:          user.ApiKey,
+			},
+		}
 	}
 	aliasMap := make(map[string][]*models.Alias)
 	for _, a := range aliases {
@@ -835,7 +841,13 @@ func (h *SettingsHandler) buildViewModel(r *http.Request, w http.ResponseWriter,
 	labelMap, err := h.projectLabelSrvc.GetByUserGroupedInverted(user.ID)
 	if err != nil {
 		conf.Log().Request(r).Error("error while building settings project label map - %v", err)
-		return &view.SettingsViewModel{Messages: view.Messages{Error: criticalError}, LeaderboardEnabled: h.config.App.LeaderboardEnabled}
+		return &view.SettingsViewModel{
+			SharedLoggedInViewModel: view.SharedLoggedInViewModel{
+				SharedViewModel: view.NewSharedViewModel(h.config, &view.Messages{Error: criticalError}),
+				User:            user,
+				ApiKey:          user.ApiKey,
+			},
+		}
 	}
 
 	combinedLabels := make([]*view.SettingsVMCombinedLabel, 0)
@@ -857,7 +869,13 @@ func (h *SettingsHandler) buildViewModel(r *http.Request, w http.ResponseWriter,
 	projects, err := routeutils.GetEffectiveProjectsList(user, h.heartbeatSrvc, h.aliasSrvc)
 	if err != nil {
 		conf.Log().Request(r).Error("error while fetching projects - %v", err)
-		return &view.SettingsViewModel{Messages: view.Messages{Error: criticalError}, LeaderboardEnabled: h.config.App.LeaderboardEnabled}
+		return &view.SettingsViewModel{
+			SharedLoggedInViewModel: view.SharedLoggedInViewModel{
+				SharedViewModel: view.NewSharedViewModel(h.config, &view.Messages{Error: criticalError}),
+				User:            user,
+				ApiKey:          user.ApiKey,
+			},
+		}
 	}
 
 	// subscriptions
@@ -878,19 +896,20 @@ func (h *SettingsHandler) buildViewModel(r *http.Request, w http.ResponseWriter,
 	inviteLink := condition.TernaryOperator[bool, string](inviteCode == "", "", fmt.Sprintf("%s/signup?invite=%s", h.config.Server.GetPublicUrl(), inviteCode))
 
 	vm := &view.SettingsViewModel{
-		User:                user,
+		SharedLoggedInViewModel: view.SharedLoggedInViewModel{
+			SharedViewModel: view.NewSharedViewModel(h.config, nil),
+			User:            user,
+			ApiKey:          user.ApiKey,
+		},
 		LanguageMappings:    mappings,
 		Aliases:             combinedAliases,
 		Labels:              combinedLabels,
 		Projects:            projects,
-		ApiKey:              user.ApiKey,
 		UserFirstData:       firstData,
 		SubscriptionPrice:   subscriptionPrice,
 		SupportContact:      h.config.App.SupportContact,
 		DataRetentionMonths: h.config.App.DataRetentionMonths,
-		LeaderboardEnabled:  h.config.App.LeaderboardEnabled,
 		InviteLink:          inviteLink,
-		InvitesEnabled:      h.config.Security.InviteCodes,
 	}
 	return routeutils.WithSessionMessages(vm, r, w)
 }