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.
2023-05-15 10:37:48 -04:00
--- a/server/public/model/config.go
+++ b/server/public/model/config.go
@@ -22,6 +22,7 @@ import (
 	"github.com/mattermost/ldap"

 	"github.com/mattermost/mattermost-server/server/public/shared/mlog"
+	"github.com/mattermost/mattermost-server/server/public/utils"
 )

 const (
@@ -1238,19 +1239,20 @@ func (s *SqlSettings) SetDefaults(isUpdate bool) {
 }

 type LogSettings struct {
-	EnableConsole          *bool   `access:"environment_logging,write_restrictable,cloud_restrictable"`
-	ConsoleLevel           *string `access:"environment_logging,write_restrictable,cloud_restrictable"`
-	ConsoleJson            *bool   `access:"environment_logging,write_restrictable,cloud_restrictable"`
-	EnableColor            *bool   `access:"environment_logging,write_restrictable,cloud_restrictable"` // telemetry: none
-	EnableFile             *bool   `access:"environment_logging,write_restrictable,cloud_restrictable"`
-	FileLevel              *string `access:"environment_logging,write_restrictable,cloud_restrictable"`
-	FileJson               *bool   `access:"environment_logging,write_restrictable,cloud_restrictable"`
-	FileLocation           *string `access:"environment_logging,write_restrictable,cloud_restrictable"`
-	EnableWebhookDebugging *bool   `access:"environment_logging,write_restrictable,cloud_restrictable"`
-	EnableDiagnostics      *bool   `access:"environment_logging,write_restrictable,cloud_restrictable"` // telemetry: none
-	VerboseDiagnostics     *bool   `access:"environment_logging,write_restrictable,cloud_restrictable"` // telemetry: none
-	EnableSentry           *bool   `access:"environment_logging,write_restrictable,cloud_restrictable"` // telemetry: none
-	AdvancedLoggingConfig  *string `access:"environment_logging,write_restrictable,cloud_restrictable"`
+	EnableConsole          *bool           `access:"environment_logging,write_restrictable,cloud_restrictable"`
+	ConsoleLevel           *string         `access:"environment_logging,write_restrictable,cloud_restrictable"`
+	ConsoleJson            *bool           `access:"environment_logging,write_restrictable,cloud_restrictable"`
+	EnableColor            *bool           `access:"environment_logging,write_restrictable,cloud_restrictable"` // telemetry: none
+	EnableFile             *bool           `access:"environment_logging,write_restrictable,cloud_restrictable"`
+	FileLevel              *string         `access:"environment_logging,write_restrictable,cloud_restrictable"`
+	FileJson               *bool           `access:"environment_logging,write_restrictable,cloud_restrictable"`
+	FileLocation           *string         `access:"environment_logging,write_restrictable,cloud_restrictable"`
+	EnableWebhookDebugging *bool           `access:"environment_logging,write_restrictable,cloud_restrictable"`
+	EnableDiagnostics      *bool           `access:"environment_logging,write_restrictable,cloud_restrictable"` // telemetry: none
+	VerboseDiagnostics     *bool           `access:"environment_logging,write_restrictable,cloud_restrictable"` // telemetry: none
+	EnableSentry           *bool           `access:"environment_logging,write_restrictable,cloud_restrictable"` // telemetry: none
+	AdvancedLoggingJSON    json.RawMessage `access:"environment_logging,write_restrictable,cloud_restrictable"`
+	AdvancedLoggingConfig  *string         `access:"environment_logging,write_restrictable,cloud_restrictable"` // Deprecated: use `AdvancedLoggingJSON`
 }

 func NewLogSettings() *LogSettings {
@@ -1308,20 +1310,40 @@ func (s *LogSettings) SetDefaults() {
 		s.FileJson = NewBool(true)
 	}

-	if s.AdvancedLoggingConfig == nil {
-		s.AdvancedLoggingConfig = NewString("")
+	if utils.IsEmptyJSON(s.AdvancedLoggingJSON) {
+		// copy any non-empty AdvancedLoggingConfig (deprecated) to the new field.
+		if s.AdvancedLoggingConfig != nil && !utils.IsEmptyJSON([]byte(*s.AdvancedLoggingConfig)) {
+			s.AdvancedLoggingJSON = utils.StringPtrToJSON(s.AdvancedLoggingConfig)
+
+		} else {
+			s.AdvancedLoggingJSON = []byte("{}")
+		}
 	}
+	s.AdvancedLoggingConfig = nil
+}
+
+// GetAdvancedLoggingConfig returns the advanced logging config as a []byte.
+// AdvancedLoggingJSON takes precident over the deprecated AdvancedLoggingConfig.
+func (s *LogSettings) GetAdvancedLoggingConfig() []byte {
+	if !utils.IsEmptyJSON(s.AdvancedLoggingJSON) {
+		return s.AdvancedLoggingJSON
+	}
+	if s.AdvancedLoggingConfig != nil && !utils.IsEmptyJSON([]byte(*s.AdvancedLoggingConfig)) {
+		return []byte(*s.AdvancedLoggingConfig)
+	}
+	return []byte("{}")
 }

 type ExperimentalAuditSettings struct {
-	FileEnabled           *bool   `access:"experimental_features,write_restrictable,cloud_restrictable"`
-	FileName              *string `access:"experimental_features,write_restrictable,cloud_restrictable"` // telemetry: none
-	FileMaxSizeMB         *int    `access:"experimental_features,write_restrictable,cloud_restrictable"`
-	FileMaxAgeDays        *int    `access:"experimental_features,write_restrictable,cloud_restrictable"`
-	FileMaxBackups        *int    `access:"experimental_features,write_restrictable,cloud_restrictable"`
-	FileCompress          *bool   `access:"experimental_features,write_restrictable,cloud_restrictable"`
-	FileMaxQueueSize      *int    `access:"experimental_features,write_restrictable,cloud_restrictable"`
-	AdvancedLoggingConfig *string `access:"experimental_features,write_restrictable,cloud_restrictable"`
+	FileEnabled           *bool           `access:"experimental_features,write_restrictable,cloud_restrictable"`
+	FileName              *string         `access:"experimental_features,write_restrictable,cloud_restrictable"` // telemetry: none
+	FileMaxSizeMB         *int            `access:"experimental_features,write_restrictable,cloud_restrictable"`
+	FileMaxAgeDays        *int            `access:"experimental_features,write_restrictable,cloud_restrictable"`
+	FileMaxBackups        *int            `access:"experimental_features,write_restrictable,cloud_restrictable"`
+	FileCompress          *bool           `access:"experimental_features,write_restrictable,cloud_restrictable"`
+	FileMaxQueueSize      *int            `access:"experimental_features,write_restrictable,cloud_restrictable"`
+	AdvancedLoggingJSON   json.RawMessage `access:"experimental_features,write_restrictable,cloud_restrictable"`
+	AdvancedLoggingConfig *string         `access:"experimental_features,write_restrictable,cloud_restrictable"` // Deprecated: use `AdvancedLoggingJSON`
 }

 func (s *ExperimentalAuditSettings) SetDefaults() {
@@ -1353,21 +1375,40 @@ func (s *ExperimentalAuditSettings) SetDefaults() {
 		s.FileMaxQueueSize = NewInt(1000)
 	}

-	if s.AdvancedLoggingConfig == nil {
-		s.AdvancedLoggingConfig = NewString("")
+	if utils.IsEmptyJSON(s.AdvancedLoggingJSON) {
+		// copy any non-empty AdvancedLoggingConfig (deprecated) to the new field.
+		if s.AdvancedLoggingConfig != nil && !utils.IsEmptyJSON([]byte(*s.AdvancedLoggingConfig)) {
+			s.AdvancedLoggingJSON = utils.StringPtrToJSON(s.AdvancedLoggingConfig)
+		} else {
+			s.AdvancedLoggingJSON = []byte("{}")
+		}
 	}
+	s.AdvancedLoggingConfig = nil
+}
+
+// GetAdvancedLoggingConfig returns the advanced logging config as a []byte.
+// AdvancedLoggingJSON takes precident over the deprecated AdvancedLoggingConfig.
+func (s *ExperimentalAuditSettings) GetAdvancedLoggingConfig() []byte {
+	if !utils.IsEmptyJSON(s.AdvancedLoggingJSON) {
+		return s.AdvancedLoggingJSON
+	}
+	if s.AdvancedLoggingConfig != nil && !utils.IsEmptyJSON([]byte(*s.AdvancedLoggingConfig)) {
+		return []byte(*s.AdvancedLoggingConfig)
+	}
+	return []byte("{}")
 }

 type NotificationLogSettings struct {
-	EnableConsole         *bool   `access:"write_restrictable,cloud_restrictable"`
-	ConsoleLevel          *string `access:"write_restrictable,cloud_restrictable"`
-	ConsoleJson           *bool   `access:"write_restrictable,cloud_restrictable"`
-	EnableColor           *bool   `access:"write_restrictable,cloud_restrictable"` // telemetry: none
-	EnableFile            *bool   `access:"write_restrictable,cloud_restrictable"`
-	FileLevel             *string `access:"write_restrictable,cloud_restrictable"`
-	FileJson              *bool   `access:"write_restrictable,cloud_restrictable"`
-	FileLocation          *string `access:"write_restrictable,cloud_restrictable"`
-	AdvancedLoggingConfig *string `access:"write_restrictable,cloud_restrictable"`
+	EnableConsole         *bool           `access:"write_restrictable,cloud_restrictable"`
+	ConsoleLevel          *string         `access:"write_restrictable,cloud_restrictable"`
+	ConsoleJson           *bool           `access:"write_restrictable,cloud_restrictable"`
+	EnableColor           *bool           `access:"write_restrictable,cloud_restrictable"` // telemetry: none
+	EnableFile            *bool           `access:"write_restrictable,cloud_restrictable"`
+	FileLevel             *string         `access:"write_restrictable,cloud_restrictable"`
+	FileJson              *bool           `access:"write_restrictable,cloud_restrictable"`
+	FileLocation          *string         `access:"write_restrictable,cloud_restrictable"`
+	AdvancedLoggingJSON   json.RawMessage `access:"write_restrictable,cloud_restrictable"`
+	AdvancedLoggingConfig *string         `access:"write_restrictable,cloud_restrictable"` // Deprecated: use `AdvancedLoggingJSON`
 }

 func (s *NotificationLogSettings) SetDefaults() {
@@ -1403,9 +1444,27 @@ func (s *NotificationLogSettings) SetDefaults() {
 		s.FileJson = NewBool(true)
 	}

-	if s.AdvancedLoggingConfig == nil {
-		s.AdvancedLoggingConfig = NewString("")
+	if utils.IsEmptyJSON(s.AdvancedLoggingJSON) {
+		// copy any non-empty AdvancedLoggingConfig (deprecated) to the new field.
+		if s.AdvancedLoggingConfig != nil && !utils.IsEmptyJSON([]byte(*s.AdvancedLoggingConfig)) {
+			s.AdvancedLoggingJSON = utils.StringPtrToJSON(s.AdvancedLoggingConfig)
+		} else {
+			s.AdvancedLoggingJSON = []byte("{}")
+		}
 	}
+	s.AdvancedLoggingConfig = nil
+}
+
+// GetAdvancedLoggingConfig returns the advanced logging config as a []byte.
+// AdvancedLoggingJSON takes precident over the deprecated AdvancedLoggingConfig.
+func (s *NotificationLogSettings) GetAdvancedLoggingConfig() []byte {
+	if !utils.IsEmptyJSON(s.AdvancedLoggingJSON) {
+		return s.AdvancedLoggingJSON
+	}
+	if s.AdvancedLoggingConfig != nil && !utils.IsEmptyJSON([]byte(*s.AdvancedLoggingConfig)) {
+		return []byte(*s.AdvancedLoggingConfig)
+	}
+	return []byte("{}")
 }

 type PasswordSettings struct {
--- a/server/public/utils/json.go
+++ b/server/public/utils/json.go
@@ -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 + "\"")
+}
--- a/server/public/utils/json_test.go
+++ b/server/public/utils/json_test.go
@@ -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)
+		})
+	}
+}