Move the sanitization and validation of CPA values to the model (#30653)
* Move the sanitization and validation of CPA values to the model * Fix CI * Use proper IDs instead of strings --------- Co-authored-by: Miguel de la Cruz <miguel@ctrlz.es> Co-authored-by: Mattermost Build <build@mattermost.com>
Этот коммит содержится в:
Miguel de la Cruz
коммит произвёл
GitHub
GitHub
родитель
c7165c5ff2
Коммит
0c8e30da4d
@@ -5,9 +5,7 @@ package api4
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"strings"
|
||||
|
||||
"github.com/mattermost/mattermost/server/public/model"
|
||||
@@ -202,76 +200,6 @@ func getCPAGroup(c *Context, w http.ResponseWriter, r *http.Request) {
|
||||
}
|
||||
}
|
||||
|
||||
func sanitizePropertyValue(cpaField *model.CPAField, rawValue json.RawMessage) (json.RawMessage, error) {
|
||||
fieldType := cpaField.Type
|
||||
|
||||
// build a list of existing options so we can check later if the values exist
|
||||
optionsMap := map[string]struct{}{}
|
||||
for _, v := range cpaField.Attrs.Options {
|
||||
optionsMap[v.ID] = struct{}{}
|
||||
}
|
||||
|
||||
switch fieldType {
|
||||
case model.PropertyFieldTypeText, model.PropertyFieldTypeDate, model.PropertyFieldTypeSelect, model.PropertyFieldTypeUser:
|
||||
var value string
|
||||
if err := json.Unmarshal(rawValue, &value); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
value = strings.TrimSpace(value)
|
||||
|
||||
if fieldType == model.PropertyFieldTypeText {
|
||||
if cpaField.Attrs.ValueType == model.CustomProfileAttributesValueTypeEmail && !model.IsValidEmail(value) {
|
||||
return nil, fmt.Errorf("invalid email")
|
||||
}
|
||||
|
||||
if cpaField.Attrs.ValueType == model.CustomProfileAttributesValueTypeURL {
|
||||
_, err := url.Parse(value)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("invalid url: %w", err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if fieldType == model.PropertyFieldTypeSelect && value != "" {
|
||||
if _, ok := optionsMap[value]; !ok {
|
||||
return nil, fmt.Errorf("option \"%s\" does not exist", value)
|
||||
}
|
||||
}
|
||||
|
||||
if fieldType == model.PropertyFieldTypeUser && value != "" && !model.IsValidId(value) {
|
||||
return nil, fmt.Errorf("invalid user id")
|
||||
}
|
||||
return json.Marshal(value)
|
||||
|
||||
case model.PropertyFieldTypeMultiselect, model.PropertyFieldTypeMultiuser:
|
||||
var values []string
|
||||
if err := json.Unmarshal(rawValue, &values); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
filteredValues := make([]string, 0, len(values))
|
||||
for _, v := range values {
|
||||
trimmed := strings.TrimSpace(v)
|
||||
if trimmed == "" {
|
||||
continue
|
||||
}
|
||||
if fieldType == model.PropertyFieldTypeMultiselect {
|
||||
if _, ok := optionsMap[v]; !ok {
|
||||
return nil, fmt.Errorf("option \"%s\" does not exist", v)
|
||||
}
|
||||
}
|
||||
|
||||
if fieldType == model.PropertyFieldTypeMultiuser && !model.IsValidId(trimmed) {
|
||||
return nil, fmt.Errorf("invalid user id: %s", trimmed)
|
||||
}
|
||||
filteredValues = append(filteredValues, trimmed)
|
||||
}
|
||||
return json.Marshal(filteredValues)
|
||||
|
||||
default:
|
||||
return nil, fmt.Errorf("unknown field type: %s", fieldType)
|
||||
}
|
||||
}
|
||||
|
||||
func patchCPAValues(c *Context, w http.ResponseWriter, r *http.Request) {
|
||||
if !model.MinimumEnterpriseLicense(c.App.Channels().License()) {
|
||||
c.Err = model.NewAppError("Api4.patchCPAValues", "api.custom_profile_attributes.license_error", nil, "", http.StatusForbidden)
|
||||
@@ -296,39 +224,9 @@ func patchCPAValues(c *Context, w http.ResponseWriter, r *http.Request) {
|
||||
defer c.LogAuditRec(auditRec)
|
||||
audit.AddEventParameter(auditRec, "user_id", userID)
|
||||
|
||||
// Get all fields at once and build a map for quick lookup
|
||||
allFields, appErr := c.App.ListCPAFields()
|
||||
if appErr != nil {
|
||||
c.Err = appErr
|
||||
return
|
||||
}
|
||||
|
||||
fieldMap := make(map[string]*model.PropertyField)
|
||||
for _, field := range allFields {
|
||||
fieldMap[field.ID] = field
|
||||
}
|
||||
|
||||
results := make(map[string]json.RawMessage, len(updates))
|
||||
for fieldID, rawValue := range updates {
|
||||
field, ok := fieldMap[fieldID]
|
||||
if !ok {
|
||||
c.Err = model.NewAppError("Api4.patchCPAValues", "api.custom_profile_attributes.field_not_found", nil, "", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
|
||||
cpaField, err := model.NewCPAFieldFromPropertyField(field)
|
||||
if err != nil {
|
||||
c.Err = model.NewAppError("Api4.patchCPAValues", "api.custom_profile_attributes.field_conversion_error", nil, "", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
|
||||
sanitizedValue, err := sanitizePropertyValue(cpaField, rawValue)
|
||||
if err != nil {
|
||||
c.SetInvalidParam(fmt.Sprintf("value for field %s: %v", fieldID, err))
|
||||
return
|
||||
}
|
||||
|
||||
patchedValue, appErr := c.App.PatchCPAValue(userID, fieldID, sanitizedValue)
|
||||
patchedValue, appErr := c.App.PatchCPAValue(userID, fieldID, rawValue)
|
||||
if appErr != nil {
|
||||
c.Err = appErr
|
||||
return
|
||||
|
||||
@@ -335,12 +335,15 @@ func TestListCPAValues(t *testing.T) {
|
||||
})
|
||||
|
||||
t.Run("should handle array values correctly", func(t *testing.T) {
|
||||
optionID1 := model.NewId()
|
||||
optionID2 := model.NewId()
|
||||
arrayField, err := model.NewCPAFieldFromPropertyField(&model.PropertyField{
|
||||
Name: model.NewId(),
|
||||
Type: model.PropertyFieldTypeMultiselect,
|
||||
Attrs: model.StringInterface{
|
||||
"options": []map[string]any{
|
||||
{"id": model.NewId(), "name": "option1"},
|
||||
{"id": optionID1, "name": "option1"},
|
||||
{"id": optionID2, "name": "option2"},
|
||||
},
|
||||
},
|
||||
})
|
||||
@@ -350,7 +353,7 @@ func TestListCPAValues(t *testing.T) {
|
||||
require.Nil(t, appErr)
|
||||
require.NotNil(t, createdArrayField)
|
||||
|
||||
_, appErr = th.App.PatchCPAValue(th.BasicUser.Id, createdArrayField.ID, json.RawMessage(`["option1", "option2", "option3"]`))
|
||||
_, appErr = th.App.PatchCPAValue(th.BasicUser.Id, createdArrayField.ID, json.RawMessage(fmt.Sprintf(`["%s", "%s"]`, optionID1, optionID2)))
|
||||
require.Nil(t, appErr)
|
||||
|
||||
values, resp, err := th.Client.ListCPAValues(context.Background(), th.BasicUser.Id)
|
||||
@@ -360,7 +363,7 @@ func TestListCPAValues(t *testing.T) {
|
||||
|
||||
var arrayValues []string
|
||||
require.NoError(t, json.Unmarshal(values[createdArrayField.ID], &arrayValues))
|
||||
require.Equal(t, []string{"option1", "option2", "option3"}, arrayValues)
|
||||
require.ElementsMatch(t, []string{optionID1, optionID2}, arrayValues)
|
||||
})
|
||||
|
||||
t.Run("non team member should NOT be able to list values", func(t *testing.T) {
|
||||
@@ -374,188 +377,6 @@ func TestListCPAValues(t *testing.T) {
|
||||
})
|
||||
}
|
||||
|
||||
func TestSanitizePropertyValue(t *testing.T) {
|
||||
t.Run("text field type", func(t *testing.T) {
|
||||
t.Run("valid text", func(t *testing.T) {
|
||||
result, err := sanitizePropertyValue(&model.CPAField{PropertyField: model.PropertyField{Type: model.PropertyFieldTypeText}}, json.RawMessage(`"hello world"`))
|
||||
require.NoError(t, err)
|
||||
var value string
|
||||
require.NoError(t, json.Unmarshal(result, &value))
|
||||
require.Equal(t, "hello world", value)
|
||||
})
|
||||
|
||||
t.Run("empty text should be allowed", func(t *testing.T) {
|
||||
result, err := sanitizePropertyValue(&model.CPAField{PropertyField: model.PropertyField{Type: model.PropertyFieldTypeText}}, json.RawMessage(`""`))
|
||||
require.NoError(t, err)
|
||||
var value string
|
||||
require.NoError(t, json.Unmarshal(result, &value))
|
||||
require.Empty(t, value)
|
||||
})
|
||||
|
||||
t.Run("invalid JSON", func(t *testing.T) {
|
||||
_, err := sanitizePropertyValue(&model.CPAField{PropertyField: model.PropertyField{Type: model.PropertyFieldTypeText}}, json.RawMessage(`invalid`))
|
||||
require.Error(t, err)
|
||||
})
|
||||
|
||||
t.Run("wrong type", func(t *testing.T) {
|
||||
_, err := sanitizePropertyValue(&model.CPAField{PropertyField: model.PropertyField{Type: model.PropertyFieldTypeText}}, json.RawMessage(`123`))
|
||||
require.Error(t, err)
|
||||
require.Contains(t, err.Error(), "json: cannot unmarshal number into Go value of type string")
|
||||
})
|
||||
})
|
||||
|
||||
t.Run("date field type", func(t *testing.T) {
|
||||
t.Run("valid date", func(t *testing.T) {
|
||||
result, err := sanitizePropertyValue(&model.CPAField{PropertyField: model.PropertyField{Type: model.PropertyFieldTypeDate}}, json.RawMessage(`"2023-01-01"`))
|
||||
require.NoError(t, err)
|
||||
var value string
|
||||
require.NoError(t, json.Unmarshal(result, &value))
|
||||
require.Equal(t, "2023-01-01", value)
|
||||
})
|
||||
|
||||
t.Run("empty date should be allowed", func(t *testing.T) {
|
||||
result, err := sanitizePropertyValue(&model.CPAField{PropertyField: model.PropertyField{Type: model.PropertyFieldTypeDate}}, json.RawMessage(`""`))
|
||||
require.NoError(t, err)
|
||||
var value string
|
||||
require.NoError(t, json.Unmarshal(result, &value))
|
||||
require.Empty(t, value)
|
||||
})
|
||||
})
|
||||
|
||||
t.Run("select field type", func(t *testing.T) {
|
||||
t.Run("valid option", func(t *testing.T) {
|
||||
result, err := sanitizePropertyValue(&model.CPAField{PropertyField: model.PropertyField{Type: model.PropertyFieldTypeSelect}, Attrs: model.CPAAttrs{
|
||||
Options: model.PropertyOptions[*model.CustomProfileAttributesSelectOption]{
|
||||
{ID: "option1"},
|
||||
},
|
||||
}}, json.RawMessage(`"option1"`))
|
||||
require.NoError(t, err)
|
||||
var value string
|
||||
require.NoError(t, json.Unmarshal(result, &value))
|
||||
require.Equal(t, "option1", value)
|
||||
})
|
||||
|
||||
t.Run("invalid option", func(t *testing.T) {
|
||||
_, err := sanitizePropertyValue(&model.CPAField{PropertyField: model.PropertyField{Type: model.PropertyFieldTypeSelect}}, json.RawMessage(`"option1"`))
|
||||
require.Error(t, err)
|
||||
})
|
||||
|
||||
t.Run("empty option should be allowed", func(t *testing.T) {
|
||||
result, err := sanitizePropertyValue(&model.CPAField{PropertyField: model.PropertyField{Type: model.PropertyFieldTypeSelect}}, json.RawMessage(`""`))
|
||||
require.NoError(t, err)
|
||||
var value string
|
||||
require.NoError(t, json.Unmarshal(result, &value))
|
||||
require.Empty(t, value)
|
||||
})
|
||||
})
|
||||
|
||||
t.Run("user field type", func(t *testing.T) {
|
||||
t.Run("valid user ID", func(t *testing.T) {
|
||||
validID := model.NewId()
|
||||
result, err := sanitizePropertyValue(&model.CPAField{PropertyField: model.PropertyField{Type: model.PropertyFieldTypeUser}}, json.RawMessage(fmt.Sprintf(`"%s"`, validID)))
|
||||
require.NoError(t, err)
|
||||
var value string
|
||||
require.NoError(t, json.Unmarshal(result, &value))
|
||||
require.Equal(t, validID, value)
|
||||
})
|
||||
|
||||
t.Run("empty user ID should be allowed", func(t *testing.T) {
|
||||
_, err := sanitizePropertyValue(&model.CPAField{PropertyField: model.PropertyField{Type: model.PropertyFieldTypeUser}}, json.RawMessage(`""`))
|
||||
require.NoError(t, err)
|
||||
})
|
||||
|
||||
t.Run("invalid user ID format", func(t *testing.T) {
|
||||
_, err := sanitizePropertyValue(&model.CPAField{PropertyField: model.PropertyField{Type: model.PropertyFieldTypeUser}}, json.RawMessage(`"invalid-id"`))
|
||||
require.Error(t, err)
|
||||
require.Equal(t, "invalid user id", err.Error())
|
||||
})
|
||||
})
|
||||
|
||||
t.Run("multiselect field type", func(t *testing.T) {
|
||||
t.Run("valid options", func(t *testing.T) {
|
||||
result, err := sanitizePropertyValue(&model.CPAField{
|
||||
PropertyField: model.PropertyField{Type: model.PropertyFieldTypeMultiselect},
|
||||
Attrs: model.CPAAttrs{
|
||||
Options: model.PropertyOptions[*model.CustomProfileAttributesSelectOption]{
|
||||
{ID: "option1"},
|
||||
{ID: "option2"},
|
||||
{ID: "option3"},
|
||||
},
|
||||
},
|
||||
}, json.RawMessage(`["option1", "option2"]`))
|
||||
require.NoError(t, err)
|
||||
var values []string
|
||||
require.NoError(t, json.Unmarshal(result, &values))
|
||||
require.Equal(t, []string{"option1", "option2"}, values)
|
||||
})
|
||||
|
||||
t.Run("empty array", func(t *testing.T) {
|
||||
_, err := sanitizePropertyValue(&model.CPAField{
|
||||
PropertyField: model.PropertyField{Type: model.PropertyFieldTypeMultiselect},
|
||||
Attrs: model.CPAAttrs{
|
||||
Options: model.PropertyOptions[*model.CustomProfileAttributesSelectOption]{
|
||||
{ID: "option1"},
|
||||
{ID: "option2"},
|
||||
{ID: "option3"},
|
||||
},
|
||||
},
|
||||
}, json.RawMessage(`[]`))
|
||||
require.NoError(t, err)
|
||||
})
|
||||
|
||||
t.Run("array with empty values should filter them out", func(t *testing.T) {
|
||||
result, err := sanitizePropertyValue(&model.CPAField{
|
||||
PropertyField: model.PropertyField{Type: model.PropertyFieldTypeMultiselect},
|
||||
Attrs: model.CPAAttrs{
|
||||
Options: model.PropertyOptions[*model.CustomProfileAttributesSelectOption]{
|
||||
{ID: "option1"},
|
||||
{ID: "option2"},
|
||||
{ID: "option3"},
|
||||
},
|
||||
},
|
||||
}, json.RawMessage(`["option1", "", "option2", " ", "option3"]`))
|
||||
require.NoError(t, err)
|
||||
var values []string
|
||||
require.NoError(t, json.Unmarshal(result, &values))
|
||||
require.Equal(t, []string{"option1", "option2", "option3"}, values)
|
||||
})
|
||||
})
|
||||
|
||||
t.Run("multiuser field type", func(t *testing.T) {
|
||||
t.Run("valid user IDs", func(t *testing.T) {
|
||||
validID1 := model.NewId()
|
||||
validID2 := model.NewId()
|
||||
result, err := sanitizePropertyValue(&model.CPAField{PropertyField: model.PropertyField{Type: model.PropertyFieldTypeMultiuser}}, json.RawMessage(fmt.Sprintf(`["%s", "%s"]`, validID1, validID2)))
|
||||
require.NoError(t, err)
|
||||
var values []string
|
||||
require.NoError(t, json.Unmarshal(result, &values))
|
||||
require.Equal(t, []string{validID1, validID2}, values)
|
||||
})
|
||||
|
||||
t.Run("empty array", func(t *testing.T) {
|
||||
_, err := sanitizePropertyValue(&model.CPAField{PropertyField: model.PropertyField{Type: model.PropertyFieldTypeMultiuser}}, json.RawMessage(`[]`))
|
||||
require.NoError(t, err)
|
||||
})
|
||||
|
||||
t.Run("array with empty strings should be filtered out", func(t *testing.T) {
|
||||
validID1 := model.NewId()
|
||||
validID2 := model.NewId()
|
||||
result, err := sanitizePropertyValue(&model.CPAField{PropertyField: model.PropertyField{Type: model.PropertyFieldTypeMultiuser}}, json.RawMessage(fmt.Sprintf(`["%s", "", " ", "%s"]`, validID1, validID2)))
|
||||
require.NoError(t, err)
|
||||
var values []string
|
||||
require.NoError(t, json.Unmarshal(result, &values))
|
||||
require.Equal(t, []string{validID1, validID2}, values)
|
||||
})
|
||||
|
||||
t.Run("array with invalid ID should return error", func(t *testing.T) {
|
||||
validID1 := model.NewId()
|
||||
_, err := sanitizePropertyValue(&model.CPAField{PropertyField: model.PropertyField{Type: model.PropertyFieldTypeMultiuser}}, json.RawMessage(fmt.Sprintf(`["%s", "invalid-id"]`, validID1)))
|
||||
require.Error(t, err)
|
||||
require.Equal(t, "invalid user id: invalid-id", err.Error())
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
func TestPatchCPAValues(t *testing.T) {
|
||||
os.Setenv("MM_FEATUREFLAGS_CUSTOMPROFILEATTRIBUTES", "true")
|
||||
defer os.Unsetenv("MM_FEATUREFLAGS_CUSTOMPROFILEATTRIBUTES")
|
||||
|
||||
Ссылка в новой задаче
Block a user