Config: Refactor version packages (#1887)

* Config: Move config versions to separate pacakges

* Config: Move version tests to blackbox texts

* Config: Protect registerVersion from overflow

* Config: Protect against version already registered

config/versions/v5/v5.go

@@ -0,0 +1,54 @@
+package v5
+
+import (
+	"context"
+	"errors"
+	"strconv"
+
+	"github.com/buger/jsonparser"
+)
+
+// Version implements ConfigVersion
+type Version struct{}
+
+// UpgradeConfig handles upgrading config for OrderManager:
+// * Sets OrderManager config to defaults if it doesn't exist or enabled is null
+// * Sets respectOrderHistoryLimits to true if it doesn't exist or is null
+// * Sets futuresTrackingSeekDuration to positive if it's negative
+func (*Version) UpgradeConfig(_ context.Context, e []byte) ([]byte, error) {
+	_, valueType, _, err := jsonparser.Get(e, "orderManager", "enabled")
+	switch {
+	case errors.Is(err, jsonparser.KeyPathNotFoundError), valueType == jsonparser.Null:
+		return jsonparser.Set(e, DefaultOrderbookConfig, "orderManager")
+	case err != nil:
+		return e, err
+	}
+
+	_, valueType, _, err = jsonparser.Get(e, "orderManager", "respectOrderHistoryLimits")
+	if errors.Is(err, jsonparser.KeyPathNotFoundError) || valueType == jsonparser.Null {
+		if e, err = jsonparser.Set(e, []byte(`true`), "orderManager", "respectOrderHistoryLimits"); err != nil {
+			return e, err
+		}
+	}
+
+	if i, err := jsonparser.GetInt(e, "orderManager", "futuresTrackingSeekDuration"); err != nil {
+		if e, err = jsonparser.Set(e, []byte(DefaultFuturesTrackingSeekDuration), "orderManager", "futuresTrackingSeekDuration"); err != nil {
+			return e, err
+		}
+	} else if i < 0 {
+		if e, err = jsonparser.Set(e, []byte(strconv.FormatInt(-i, 10)), "orderManager", "futuresTrackingSeekDuration"); err != nil {
+			return e, err
+		}
+	}
+	return e, nil
+}
+
+// DowngradeConfig just reverses the futuresTrackingSeekDuration to negative, and leaves everything else alone
+func (*Version) DowngradeConfig(_ context.Context, e []byte) ([]byte, error) {
+	if i, err := jsonparser.GetInt(e, "orderManager", "futuresTrackingSeekDuration"); err == nil && i > 0 {
+		if e, err = jsonparser.Set(e, []byte(strconv.FormatInt(-i, 10)), "orderManager", "futuresTrackingSeekDuration"); err != nil {
+			return e, err
+		}
+	}
+	return e, nil
+}

config/versions/v5/v5_test.go

@@ -0,0 +1,66 @@
+package v5_test
+
+import (
+	"bytes"
+	"context"
+	"encoding/json" //nolint:depguard // Direct use of golang json for Compact func
+	"strings"
+	"testing"
+
+	"github.com/buger/jsonparser"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	v5 "github.com/thrasher-corp/gocryptotrader/config/versions/v5"
+)
+
+func TestUpgradeConfig(t *testing.T) {
+	t.Parallel()
+
+	expDef := `{"orderManager":{"enabled":true,"verbose":false,"activelyTrackFuturesPositions":true,"futuresTrackingSeekDuration":31536000000000000,"cancelOrdersOnShutdown":false,"respectOrderHistoryLimits":true}}`
+	expUser1 := `{"orderManager":{"enabled":false,"verbose":true,"activelyTrackFuturesPositions":false,"futuresTrackingSeekDuration":47000,"cancelOrdersOnShutdown":true,"respectOrderHistoryLimits":true}}`
+	expUser2 := strings.Replace(expUser1, `mits":true`, `mits":false`, 1)
+
+	tests := []struct {
+		name string
+		in   string
+		out  string
+		err  error
+	}{
+		{name: "Bad input should error", err: jsonparser.KeyPathNotFoundError},
+		{name: "Missing orderManager should use the defaults", in: "{}", out: expDef},
+		{name: "Enabled null should use defaults", in: strings.Replace(expDef, "true", "null", 1), out: expDef},
+		{name: "RespectOrderHistoryLimits should be added if missing", in: strings.Replace(expUser1, `,"respectOrderHistoryLimits":true`, "", 1), out: expUser1},
+		{name: "RespectOrderHistoryLimits null should default true", in: strings.Replace(expUser1, `mits":true`, `mits":null`, 1), out: expUser1},
+		{name: "FutureTracking should be reversed", in: strings.Replace(expUser1, "47", "-47", 1), out: expUser1},
+		{name: "Configured orderManager should be left alone", in: expUser2, out: expUser2},
+	}
+
+	for _, tt := range tests {
+		_ = t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+			out, err := new(v5.Version).UpgradeConfig(context.Background(), []byte(tt.in))
+			if tt.err != nil {
+				require.ErrorIs(t, err, tt.err)
+				return
+			}
+			require.NoError(t, err)
+			b := new(bytes.Buffer)
+			require.NoError(t, json.Compact(b, out), "json.Compact must not error")
+			require.Equal(t, tt.out, b.String())
+		})
+	}
+}
+
+func TestDowngradeConfig(t *testing.T) {
+	t.Parallel()
+
+	in := `{"orderManager":{"enabled":false,"verbose":true,"activelyTrackFuturesPositions":false,"futuresTrackingSeekDuration":-47000,"cancelOrdersOnShutdown":true,"respectOrderHistoryLimits":true}}`
+	exp := `{"orderManager":{"enabled":false,"verbose":true,"activelyTrackFuturesPositions":false,"futuresTrackingSeekDuration":-47000,"cancelOrdersOnShutdown":true,"respectOrderHistoryLimits":true}}`
+	out, err := new(v5.Version).DowngradeConfig(context.Background(), []byte(in))
+	require.NoError(t, err)
+	assert.Equal(t, exp, string(out), "DowngradeConfig should just reverse the futuresTrackingSeekDuration")
+
+	out, err = new(v5.Version).DowngradeConfig(context.Background(), []byte(exp))
+	require.NoError(t, err)
+	assert.Equal(t, exp, string(out), "DowngradeConfig should leave an already negative futuresTrackingSeekDuration alone")
+}