Navigation: Introduce a preferences table to store Navbar preferences (#44914)

* First attempt at creating new navbar_preferences table in db * Apply to every nav item instead of just home * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * Chore: introduce initTestDB options for features * fix unit tests * Add another unit test and some logic for detecting if a preference already exists * tidy up * Only override IsFeatureToggleEnabled if it's defined * Extract setNavPreferences out into it's own function, initialise features correctly * Make the linter happy * Use new structure * user essentials mob! 🔱 * user essentials mob! 🔱 * Split NavbarPreferences from Preferences * user essentials mob! 🔱 * user essentials mob! 🔱 * Fix lint error * Start adding tests * Change internal db structure to be a generic json object * GetJsonData -> GetPreferencesJsonData * Stop using simplejson + add some more unit tests * Update pkg/api/preferences.go Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com> * Updates following review comments * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * Change patch to upsert, add a unit test * remove commented out code * introduce patch user/org preferences methods * Return Navbar preferences in the get call * Fix integration test by instantiating JsonData * Address review comments * Rename HideFromNavbar -> Hide * add swagger:model comment * Add patch to the preferences documentation * Add openapi annotations * Add a short description * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * user essentials mob! 🔱 * Update unit tests * remove unneeded url * remove outdated comment * Update integration tests * update generated swagger Co-authored-by: Alexandra Vargas <alexa1866@gmail.com> Co-authored-by: Hugo Häggmark <hugo.haggmark@gmail.com> Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2022-03-17 12:07:20 +00:00
parent 60af3af92c
commit 586272e5f0
17 changed files with 6474 additions and 16 deletions
@@ -1,9 +1,18 @@
 package models

 import (
+	"bytes"
+	"encoding/json"
 	"time"
 )

+type NavLink struct {
+	Id     string `json:"id,omitempty"`
+	Text   string `json:"text,omitempty"`
+	Url    string `json:"url,omitempty"`
+	Target string `json:"target,omitempty"`
+}
+
 type Preferences struct {
 	Id              int64
 	OrgId           int64
@@ -16,6 +25,32 @@ type Preferences struct {
 	Theme           string
 	Created         time.Time
 	Updated         time.Time
+	JsonData        *PreferencesJsonData
+}
+
+// The following needed for to implement the xorm/database ORM Conversion interface do the
+// conversion when reading/writing to the database, see https://gobook.io/read/gitea.com/xorm/manual-en-US/chapter-02/4.columns.html.
+
+func (j *PreferencesJsonData) FromDB(data []byte) error {
+	dec := json.NewDecoder(bytes.NewBuffer(data))
+	dec.UseNumber()
+	return dec.Decode(j)
+}
+
+func (j *PreferencesJsonData) ToDB() ([]byte, error) {
+	if j == nil {
+		return nil, nil
+	}
+
+	return json.Marshal(j)
+}
+
+type NavbarPreference struct {
+	SavedItems []NavLink `json:"savedItems"`
+}
+
+type PreferencesJsonData struct {
+	Navbar NavbarPreference `json:"navbar"`
 }

 // ---------------------
@@ -43,8 +78,21 @@ type SavePreferencesCommand struct {
 	OrgId  int64
 	TeamId int64

-	HomeDashboardId int64  `json:"homeDashboardId"`
-	Timezone        string `json:"timezone"`
-	WeekStart       string `json:"weekStart"`
-	Theme           string `json:"theme"`
+	HomeDashboardId int64             `json:"homeDashboardId,omitempty"`
+	Timezone        string            `json:"timezone,omitempty"`
+	WeekStart       string            `json:"weekStart,omitempty"`
+	Theme           string            `json:"theme,omitempty"`
+	Navbar          *NavbarPreference `json:"navbar,omitempty"`
+}
+
+type PatchPreferencesCommand struct {
+	UserId int64
+	OrgId  int64
+	TeamId int64
+
+	HomeDashboardId *int64            `json:"homeDashboardId,omitempty"`
+	Timezone        *string           `json:"timezone,omitempty"`
+	WeekStart       *string           `json:"weekStart,omitempty"`
+	Theme           *string           `json:"theme,omitempty"`
+	Navbar          *NavbarPreference `json:"navbar,omitempty"`
 }