Merge pull request #692 from florkbr/add-active-workspace-support

RHCLOUD-35156: Add support to chrome service for active workspace on user obj

cmd/migrate/migrate.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"fmt"
+
 	"github.com/RedHatInsights/chrome-service-backend/rest/database"
 	"github.com/RedHatInsights/chrome-service-backend/rest/models"
 	"github.com/joho/godotenv"
@@ -16,6 +17,7 @@ func main() {
 
 	var bundleRes *gorm.DB
 	var visitedRes *gorm.DB
+	var activeWorkspaceRes *gorm.DB
 	tx := database.DB.Begin().Session(&gorm.Session{
 		Logger: logger.Default.LogMode(logger.Info),
 	})
@@ -123,10 +125,18 @@ func main() {
 
 	fmt.Println("Seed default value to last visited pages")
 	visitedRes = tx.Model(&models.UserIdentity{}).Where("last_visited_pages IS NULL").Update("last_visited_pages", []byte(`[]`))
-	if bundleRes.Error != nil {
-		fmt.Println("Unable to migrate database!", bundleRes.Error.Error())
+	if visitedRes.Error != nil {
+		fmt.Println("Unable to migrate database!", visitedRes.Error.Error())
 		tx.Rollback()
-		panic(bundleRes.Error)
+		panic(visitedRes.Error)
+	}
+
+	fmt.Println("Seed default value to active workspace")
+	activeWorkspaceRes = tx.Model(&models.UserIdentity{}).Where("active_workspace IS NULL").Update("active_workspace", "default")
+	if activeWorkspaceRes.Error != nil {
+		fmt.Println("Unable to migrate database!", activeWorkspaceRes.Error.Error())
+		tx.Rollback()
+		panic(activeWorkspaceRes.Error)
 	}
 
 	err := tx.Commit().Error
@@ -144,5 +154,10 @@ func main() {
 	if visitedRes.RowsAffected > 0 {
 		logrus.Infof("Migrated %d user identity visited rows", visitedRes.RowsAffected)
 	}
+
+	if activeWorkspaceRes.RowsAffected > 0 {
+		logrus.Infof("Migrated %d user identity visited rows", activeWorkspaceRes.RowsAffected)
+	}
+
 	logrus.Info("Migration complete")
 }

docs/user-identity.md

@@ -0,0 +1,6 @@
+# User routes
+
+Store user specific information such as active workspace, favorited pages, visited bundles, UI preview enablement, and more
+
+# Active Workspace
+TODO

rest/models/UserIdentity.go

@@ -29,6 +29,7 @@ type UserIdentity struct {
 	DashboardTemplates []DashboardTemplate               `json:"dashboardTemplates,omitempty"`
 	UIPreview          bool                              `json:"uiPreview"`
 	UIPreviewSeen      bool                              `json:"uiPreviewSeen"`
+	ActiveWorkspace    string                            `json:"activeWorkspace"`
 }
 
 type UserIdentityResponse struct {
@@ -43,4 +44,5 @@ type UserIdentityResponse struct {
 	VisitedBundles   datatypes.JSON `json:"visitedBundles,omitempty" gorm:"type: JSONB"`
 	UIPreview        bool           `json:"uiPreview"`
 	UIPreviewSeen    bool           `json:"uiPreviewSeen"`
+	ActiveWorkspace  string         `json:"activeWorkspace"`
 }

rest/routes/identity.go

@@ -52,6 +52,7 @@ func GetUserIdentity(w http.ResponseWriter, r *http.Request) {
 		VisitedBundles:   updatedUser.VisitedBundles,
 		UIPreview:        updatedUser.UIPreview,
 		UIPreviewSeen:    updatedUser.UIPreviewSeen,
+		ActiveWorkspace:  updatedUser.ActiveWorkspace,
 	}
 
 	resp := util.EntityResponse[models.UserIdentityResponse]{
@@ -155,11 +156,37 @@ func MarkPreviewSeen(w http.ResponseWriter, r *http.Request) {
 	json.NewEncoder(w).Encode(resp)
 }
 
+type UpdateActiveWorkspacePayload struct {
+	ActiveWorkspace string `json:"activeWorkspace"`
+}
+
+func UpdateActiveWorkspace(w http.ResponseWriter, r *http.Request) {
+	user := r.Context().Value(util.USER_CTX_KEY).(models.UserIdentity)
+	var request UpdateActiveWorkspacePayload
+	err := json.NewDecoder(r.Body).Decode(&request)
+	if err != nil {
+		handleIdentityError(err, w)
+		return
+	}
+	err = service.UpdateActiveWorkspace(&user, request.ActiveWorkspace)
+	if err != nil {
+		handleIdentityError(err, w)
+		return
+	}
+
+	resp := util.EntityResponse[models.UserIdentity]{
+		Data: user,
+	}
+
+	json.NewEncoder(w).Encode(resp)
+}
+
 func MakeUserIdentityRoutes(sub chi.Router) {
 	sub.Get("/", GetUserIdentity)
 	sub.Get("/intercom", GetIntercomHash)
 	sub.Post("/update-ui-preview", UpdateUserPreview)
 	sub.Post("/mark-preview-seen", MarkPreviewSeen)
+	sub.Post("/update-active-workspace", UpdateActiveWorkspace)
 	sub.Route("/visited-bundles", func(r chi.Router) {
 		r.Post("/", AddVisitedBundle)
 		r.Get("/", GetVisitedBundles)

rest/service/identity.go

@@ -115,6 +115,7 @@ func CreateIdentity(userId string, skipCache bool) (models.UserIdentity, error)
 		FavoritePages:    []models.FavoritePage{},
 		SelfReport:       models.SelfReport{},
 		VisitedBundles:   nil,
+		ActiveWorkspace:  "default",
 	}
 	err := json.Unmarshal([]byte(`{}`), &identity.VisitedBundles)
 	if err != nil {
@@ -193,3 +194,15 @@ func UpdateUserPreview(identity *models.UserIdentity, preview bool) error {
 func MarkPreviewSeen(identity *models.UserIdentity) error {
 	return database.DB.Model(identity).Updates(models.UserIdentity{UIPreviewSeen: true}).Error
 }
+
+func UpdateActiveWorkspace(identity *models.UserIdentity, workspace string) error {
+	identity.ActiveWorkspace = workspace
+	err := database.DB.Model(identity).Update("active_workspace", workspace).Error
+
+	// set the cache after successful DB operation
+	if err == nil {
+		util.UsersCache.Set(identity.AccountId, *identity)
+	}
+
+	return err
+}