MM-43077 Allow inline JSON in config.json for advanced logging config (#23324)

* add AdvancedLoggingJSON to LogSettings and deprecate AdvancedLoggingConfig
* allow embedded JSON in config for advanced logging.
Этот коммит содержится в:
Doug Lauder
2023-05-15 10:37:48 -04:00
коммит произвёл GitHub
родитель 156d1429de
Коммит e4075dae18
11 изменённых файлов: 324 добавлений и 74 удалений

Просмотреть файл

@@ -6,6 +6,7 @@ package utils
import (
"bytes"
"encoding/json"
"strings"
"github.com/pkg/errors"
)
@@ -54,3 +55,32 @@ func NewHumanizedJSONError(err error, data []byte, offset int64) *HumanizedJSONE
Err: errors.Wrapf(err, "parsing error at line %d, character %d", line, character),
}
}
func IsEmptyJSON(j json.RawMessage) bool {
if len(j) == 0 || bytes.Equal(j, []byte("{}")) || bytes.Equal(j, []byte("\"\"")) || bytes.Equal(j, []byte("[]")) {
return true
}
return false
}
func StringPtrToJSON(ptr *string) json.RawMessage {
if ptr == nil || len(*ptr) == 0 {
return []byte("{}")
}
s := *ptr
if strings.HasPrefix(s, "{") && strings.HasSuffix(s, "}") {
return []byte(s)
}
if strings.HasPrefix(s, "[") && strings.HasSuffix(s, "]") {
return []byte(s)
}
if strings.HasPrefix(s, "\"") && strings.HasSuffix(s, "\"") {
return []byte(s)
}
// This must be a bare string which will need quotes to make a valid JSON document.
return []byte("\"" + s + "\"")
}

Просмотреть файл

@@ -11,6 +11,7 @@ import (
"github.com/pkg/errors"
"github.com/stretchr/testify/assert"
"github.com/mattermost/mattermost-server/server/public/model"
"github.com/mattermost/mattermost-server/server/public/utils"
)
@@ -233,3 +234,119 @@ func TestNewHumanizedJSONError(t *testing.T) {
})
}
}
func TestIsJSONEmpty(t *testing.T) {
t.Parallel()
testCases := []struct {
Description string
Data []byte
Empty bool
}{
{
"nil []byte is empty",
nil,
true,
},
{
"Zero length slice is empty",
[]byte(""),
true,
},
{
"braces are empty",
[]byte("{}"),
true,
},
{
"square brackets are empty",
[]byte("[]"),
true,
},
{
"empty string is empty",
[]byte("\"\""),
true,
},
{
"map is not empty",
[]byte("{\"foo\":7}"),
false,
},
{
"array is not empty",
[]byte("[1,2,3]"),
false,
},
{
"string is not empty",
[]byte("\"hello\""),
false,
},
}
for _, testCase := range testCases {
testCase := testCase
t.Run(testCase.Description, func(t *testing.T) {
empty := utils.IsEmptyJSON(testCase.Data)
assert.Equal(t, testCase.Empty, empty)
if !testCase.Empty {
// don't really need to test the JSON unmarshaller but this is included
// to ensure the test cases stay valid.
var v interface{}
err := json.Unmarshal(testCase.Data, &v)
assert.NoError(t, err)
}
})
}
}
func TestStringPtrToJSON(t *testing.T) {
t.Parallel()
testCases := []struct {
Description string
Ptr *string
Expect json.RawMessage
}{
{
"nil string ptr",
nil,
[]byte("{}"),
},
{
"Zero length string",
model.NewString(""),
[]byte("{}"),
},
{
"JSON map",
model.NewString("{\"foo\":7}"),
[]byte("{\"foo\":7}"),
},
{
"JSON array",
model.NewString("[1,2,3]"),
[]byte("[1,2,3]"),
},
{
"JSON string",
model.NewString("\"hello\""),
[]byte("\"hello\""),
},
{
"bare string",
model.NewString("hello"),
[]byte("\"hello\""),
},
}
for _, testCase := range testCases {
testCase := testCase
t.Run(testCase.Description, func(t *testing.T) {
j := utils.StringPtrToJSON(testCase.Ptr)
assert.Equal(t, testCase.Expect, j)
})
}
}