opensource/mattermost
3
0
Fork 0
mirror of https://github.com/mattermost/mattermost.git synced 2026-09-24 16:05:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

refactor: Improve custom profile attributes field handling and validation

Browse Source
This commit is contained in:
Julien Tant
2025-02-25 10:52:45 -07:00
committed by Julien Tant (aider)
parent aee06af59c
commit 783e64472c
2 changed files with 67 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
server/channels/app/custom_profile_attributes.go
+23 -37
View File
@@ -77,7 +77,7 @@ func (a *App) ListCPAFields() ([]*model.PropertyField, *model.AppError) {
return fields, nil
}
func (a *App) CreateCPAField(field *model.PropertyField) (*model.PropertyField, *model.AppError) {
func (a *App) CreateCPAField(field *model.CPAField) (*model.PropertyField, *model.AppError) {
groupID, err := a.cpaGroupID()
if err != nil {
return nil, model.NewAppError("CreateCPAField", "app.custom_profile_attributes.cpa_group_id.app_error", nil, "", http.StatusInternalServerError).Wrap(err)
@@ -97,7 +97,7 @@ func (a *App) CreateCPAField(field *model.PropertyField) (*model.PropertyField,
}
field.GroupID = groupID
newField, err := a.Srv().propertyService.CreatePropertyField(field)
newField, err := a.Srv().propertyService.CreatePropertyField(field.ToPropertyField())
if err != nil {
var appErr *model.AppError
switch {
@@ -126,11 +126,16 @@ func (a *App) PatchCPAField(fieldID string, patch *model.PropertyFieldPatch) (*m
patch.TargetType = nil
existingField.Patch(patch)
if appErr := validateCustomProfileAttributesField(existingField); appErr != nil {
cpaField, err := model.NewCPAFieldFromPropertyField(existingField)
if err != nil {
return nil, model.NewAppError("UpdateCPAField", "app.custom_profile_attributes.property_field_conversion.app_error", nil, "", http.StatusInternalServerError).Wrap(err)
}
if appErr := validateCustomProfileAttributesField(cpaField); appErr != nil {
return nil, appErr
}
patchedField, err := a.Srv().propertyService.UpdatePropertyField(existingField)
patchedField, err := a.Srv().propertyService.UpdatePropertyField(cpaField.ToPropertyField())
if err != nil {
var nfErr *store.ErrNotFound
switch {
@@ -269,51 +274,32 @@ func (a *App) PatchCPAValues(userID string, fieldValueMap map[string]json.RawMes
return updatedValues, nil
}
func validateCustomProfileAttributesField(field *model.PropertyField) *model.AppError {
if field.Attrs == nil {
field.Attrs = model.StringInterface{}
}
func validateCustomProfileAttributesField(field *model.CPAField) *model.AppError {
switch field.Type {
case model.PropertyFieldTypeText:
if valueType, ok := field.Attrs[model.CustomProfileAttributesPropertyAttrsValueType]; ok {
valueTypeStr, ok := valueType.(string)
if !ok {
return model.NewAppError("ValidateCPAField", "app.custom_profile_attributes.not_string_value_type.app_error", nil, "", http.StatusUnprocessableEntity)
if valueType := strings.TrimSpace(field.Attrs.ValueType); valueType != "" {
if !model.IsKnownCustomProfilteAttributesValueType(valueType) {
return model.NewAppError("ValidateCPAField", "app.custom_profile_attributes.unknown_value_type.app_error", map[string]any{"ValueType": valueType}, "", http.StatusUnprocessableEntity)
}
valueTypeStr = strings.TrimSpace(valueTypeStr)
if !model.IsKnownCustomProfilteAttributesValueType(valueTypeStr) {
return model.NewAppError("ValidateCPAField", "app.custom_profile_attributes.unknown_value_type.app_error", map[string]any{"ValueType": valueTypeStr}, "", http.StatusUnprocessableEntity)
}
field.Attrs[model.CustomProfileAttributesPropertyAttrsValueType] = valueTypeStr
field.Attrs.ValueType = valueType
}
case model.PropertyFieldTypeSelect, model.PropertyFieldTypeMultiselect:
if options, ok := field.Attrs[model.PropertyFieldAttributeOptions]; ok {
finalOptions, err := model.NewPropertyOptionsFromFieldAttrs[*model.CustomProfileAttributesSelectOption](options)
if err != nil {
return model.NewAppError("ValidateCPAField", "app.custom_profile_attributes.invalid_options.app_error", nil, "", http.StatusUnprocessableEntity).Wrap(err)
}
if err := finalOptions.IsValid(); err != nil {
return model.NewAppError("ValidateCPAField", "app.custom_profile_attributes.invalid_options.app_error", nil, "", http.StatusUnprocessableEntity).Wrap(err)
}
field.Attrs[model.PropertyFieldAttributeOptions] = finalOptions
options := field.Attrs.Options
if err := options.IsValid(); err != nil {
return model.NewAppError("ValidateCPAField", "app.custom_profile_attributes.invalid_options.app_error", nil, "", http.StatusUnprocessableEntity).Wrap(err)
}
field.Attrs.Options = options
}
visibility := model.CustomProfileAttributesVisibilityDefault
if visibilityAttr, ok := field.Attrs[model.CustomProfileAttributesPropertyAttrsVisibility]; ok {
if visibilityStr, ok := visibilityAttr.(string); ok {
visibilityStr = strings.TrimSpace(visibilityStr)
if !model.IsKnownCustomProfilteAttributesVisibility(visibilityStr) {
return model.NewAppError("ValidateCPAField", "app.custom_profile_attributes.unknown_visibility.app_error", map[string]any{"Visibility": visibilityStr}, "", http.StatusUnprocessableEntity)
}
visibility = visibilityStr
if visibilityAttr := strings.TrimSpace(field.Attrs.Visibility); visibilityAttr != "" {
if !model.IsKnownCustomProfilteAttributesVisibility(visibilityAttr) {
return model.NewAppError("ValidateCPAField", "app.custom_profile_attributes.unknown_visibility.app_error", map[string]any{"Visibility": visibilityAttr}, "", http.StatusUnprocessableEntity)
}
visibility = visibilityAttr
}
field.Attrs[model.CustomProfileAttributesPropertyAttrsVisibility] = visibility
field.Attrs.Visibility = visibility
return nil
}
server/public/model/custom_profile_attributes.go
+44
View File
@@ -4,6 +4,7 @@
package model
import (
"encoding/json"
"errors"
)
@@ -99,3 +100,46 @@ func (c CustomProfileAttributesSelectOption) IsValid() error {
return nil
}
type CPAField struct {
PropertyField
Attrs CPAAttrs
}
type CPAAttrs struct {
Visibility string `json:"visibility"`
SortOrder string `json:"sort_order"`
Options PropertyOptions[*CustomProfileAttributesSelectOption] `json:"options"`
ValueType string `json:"value_type"`
}
func (c *CPAField) ToPropertyField() *PropertyField {
pf := c.PropertyField
pf.Attrs = StringInterface{
CustomProfileAttributesPropertyAttrsVisibility: c.Attrs.Visibility,
CustomProfileAttributesPropertyAttrsSortOrder: c.Attrs.SortOrder,
CustomProfileAttributesPropertyAttrsValueType: c.Attrs.ValueType,
PropertyFieldAttributeOptions: c.Attrs.Options,
}
return &pf
}
func NewCPAFieldFromPropertyField(pf *PropertyField) (*CPAField, error) {
attrsJSON, err := json.Marshal(pf.Attrs)
if err != nil {
return nil, err
}
var attrs CPAAttrs
err = json.Unmarshal(attrsJSON, &attrs)
if err != nil {
return nil, err
}
return &CPAField{
PropertyField: *pf,
Attrs: attrs,
}, nil
}