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
@@ -37,7 +37,8 @@ const (
 	// are negative to ensure that the default items are placed above
 	// any items with default weight.

-	WeightHome = (iota - 20) * 100
+	WeightSavedItems = (iota - 20) * 100
+	WeightHome
 	WeightCreate
 	WeightDashboard
 	WeightExplore
@@ -1,10 +1,13 @@
 package dtos

+import "github.com/grafana/grafana/pkg/models"
+
 type Prefs struct {
-	Theme           string `json:"theme"`
-	HomeDashboardID int64  `json:"homeDashboardId"`
-	Timezone        string `json:"timezone"`
-	WeekStart       string `json:"weekStart"`
+	Theme           string                  `json:"theme"`
+	HomeDashboardID int64                   `json:"homeDashboardId"`
+	Timezone        string                  `json:"timezone"`
+	WeekStart       string                  `json:"weekStart"`
+	Navbar          models.NavbarPreference `json:"navbar,omitempty"`
 }

 // swagger:model
@@ -15,6 +18,20 @@ type UpdatePrefsCmd struct {
 	// Default:0
 	HomeDashboardID int64 `json:"homeDashboardId"`
 	// Enum: utc,browser
-	Timezone  string `json:"timezone"`
-	WeekStart string `json:"weekStart"`
+	Timezone  string                   `json:"timezone"`
+	WeekStart string                   `json:"weekStart"`
+	Navbar    *models.NavbarPreference `json:"navbar,omitempty"`
+}
+
+// swagger:model
+type PatchPrefsCmd struct {
+	// Enum: light,dark
+	Theme *string `json:"theme,omitempty"`
+	// The numerical :id of a favorited dashboard
+	// Default:0
+	HomeDashboardID *int64 `json:"homeDashboardId,omitempty"`
+	// Enum: utc,browser
+	Timezone  *string                  `json:"timezone,omitempty"`
+	WeekStart *string                  `json:"weekStart,omitempty"`
+	Navbar    *models.NavbarPreference `json:"navbar,omitempty"`
 }