err on malformed json config (#1138)

onflow · Jul 24, 2023 · 0bdaa79 · 0bdaa79
1 parent 20f62a8
commit 0bdaa79
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 7 deletions.
diff --git a/flowkit/config/loader.go b/flowkit/config/loader.go
@@ -113,7 +113,11 @@ func (l *Loader) loadConfig(confPath string) (*Config, error) {
 		return nil, err
 	}
 
-	preProcessed := l.preprocess(raw)
+	preProcessed, err := l.preprocess(raw)
+	if err != nil {
+		return nil, fmt.Errorf("failed to preprocess config: %w", err)
+	}
+
 	configParser := l.configParsers.FindForFormat(filepath.Ext(confPath))
 	if configParser == nil {
 		return nil, fmt.Errorf("parser not found for config: %s", confPath)
@@ -170,7 +174,7 @@ func (l *Loader) Load(paths []string) (*Config, error) {
 }
 
 // preprocess does all manipulations to the raw configuration format happens here.
-func (l *Loader) preprocess(raw []byte) []byte {
+func (l *Loader) preprocess(raw []byte) ([]byte, error) {
 	return processorRun(raw)
 }
 

diff --git a/flowkit/config/loader_test.go b/flowkit/config/loader_test.go
@@ -166,6 +166,40 @@ func Test_MissingConfiguration(t *testing.T) {
 	assert.EqualError(t, err, "missing configuration")
 }
 
+func Test_ConfigurationMalformedJSON(t *testing.T) {
+	b := []byte(`{
+		"emulators": {
+			"default": {
+				"port": 3569,
+				"serviceAccount": "emulator-account",
+			}
+		},
+		"contracts": {},
+		"networks": {
+			"emulator": "127.0.0.1:3569"
+		},
+		"accounts": {
+			"emulator-account": {
+				"address": "f8d6e0586b0a20c7",
+				"key": "21c5dfdeb0ff03a7a73ef39788563b62c89adea67bbb21ab95e5f710bd1d40b7"
+			}
+		},
+		"deployments": {}
+	}`)
+
+	mockFS := afero.NewMemMapFs()
+	err := afero.WriteFile(mockFS, "flow.json", b, 0644)
+
+	assert.NoError(t, err)
+
+	composer := config.NewLoader(afero.Afero{Fs: mockFS})
+	composer.AddConfigParser(json.NewParser())
+
+	conf, err := composer.Load(config.DefaultPaths())
+	assert.EqualError(t, err, "failed to preprocess config: failed to parse config JSON: invalid character '}' looking for beginning of object key string")
+	assert.Nil(t, conf)
+}
+
 func Test_ConfigurationWrongFormat(t *testing.T) {
 	b := []byte(`{
 		"deployments": {

diff --git a/flowkit/config/processor.go b/flowkit/config/processor.go
@@ -20,10 +20,11 @@ package config
 
 import (
 	"encoding/json"
+	"fmt"
 )
 
 // processorRun all pre-processors.
-func processorRun(raw []byte) []byte {
+func processorRun(raw []byte) ([]byte, error) {
 	type config struct {
 		Accounts    map[string]map[string]any `json:"accounts,omitempty"`
 		Contracts   any                       `json:"contracts,omitempty"`
@@ -33,8 +34,15 @@ func processorRun(raw []byte) []byte {
 	}
 
 	var conf config
-	_ = json.Unmarshal(raw, &conf)
+	err := json.Unmarshal(raw, &conf)
+	if err != nil {
+		return nil, fmt.Errorf("failed to parse config JSON: %w", err)
+	}
+
+	raw, err = json.Marshal(conf)
+	if err != nil {
+		return nil, fmt.Errorf("failed to marshal config: %w", err)
+	}
 
-	raw, _ = json.Marshal(conf)
-	return raw
+	return raw, nil
 }
diff --git a/flowkit/config/processor_test.go b/flowkit/config/processor_test.go
@@ -22,6 +22,7 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func Test_PrivateConfigFileAccounts(t *testing.T) {
@@ -45,6 +46,9 @@ func Test_PrivateConfigFileAccounts(t *testing.T) {
 		}
 	}`)
 
+	processorRunRes, err := processorRun(b)
+	require.NoError(t, err)
+
 	assert.JSONEq(t, `{
 		"emulators": {
 			"default": {
@@ -63,5 +67,5 @@ func Test_PrivateConfigFileAccounts(t *testing.T) {
 					"key": "11c5dfdeb0ff03a7a73ef39788563b62c89adea67bbb21ab95e5f710bd1d40b7"
 				}
 			}
-		}`, string(processorRun(b)))
+		}`, string(processorRunRes))
 }