refactor cbor V1 / V2 codecs, return a V1 encoder in the NewCborCodec()

format/codecs/cbor_tags_test.go

@@ -18,7 +18,7 @@ import (
 	"github.com/eluv-io/common-go/util/maputil"
 )
 
-var cborCodec = codecs.NewCborCodec()
+var cborCodec = codecs.NewCborV2Codec()
 
 func TestIDTag(t *testing.T) {
 	factory := format.NewFactory()

format/codecs/codecs.go

@@ -33,8 +33,10 @@ var (
 	JsonMultiCodec   = NewMultiCodec(JsonCodec, JsonMultiCodecPath)
 	CborV1MultiCodec = NewMultiCodec(CborV1Codec, CborV1MultiCodecPath)
 	CborV2MultiCodec = NewMultiCodec(CborV2Codec, CborV2MultiCodecPath)
-	// CborMuxCodec is the codec producing versioned V2 format and supports decoding un-versioned V1 format.
-	CborMuxCodec = NewMuxCodec(CborV2MultiCodec, CborV1MultiCodec.DisableVersions())
+	// CborV1MuxCodec is the codec producing un-versioned V1 format and supports decoding versioned V2 format.
+	CborV1MuxCodec = NewMuxCodec(CborV1MultiCodec.DisableVersions(), CborV2MultiCodec)
+	// CborV2MuxCodec is the codec producing versioned V2 format and supports decoding un-versioned V1 format.
+	CborV2MuxCodec = NewMuxCodec(CborV2MultiCodec, CborV1MultiCodec.DisableVersions())
 )
 
 // NewGobCodec creates a new streaming MultiCodec using the encoding/gob format.
@@ -47,9 +49,16 @@ func NewJsonCodec() MultiCodec {
 	return JsonMultiCodec
 }
 
-// NewCborCodec creates a new streaming MultiCodec using the CBOR format.
+// NewCborCodec returns a MultiCodec using the CBOR format. It encodes/decodes un-versioned V1 format and supports
+// decoding versioned V2 format.
 func NewCborCodec() MultiCodec {
-	return CborMuxCodec
+	return CborV1MuxCodec
+}
+
+// NewCborV2Codec returns a MultiCodec using the CBOR format. It encodes/decodes versioned V2 format and supports
+// decoding un-versioned V1 format.
+func NewCborV2Codec() MultiCodec {
+	return CborV2MuxCodec
 }
 
 // MdsImexCodec returns the codec for metadata store exports / imports.
@@ -60,13 +69,13 @@ func MdsImexCodec() MultiCodec {
 // CborEncode encodes the given value as CBOR and writes it to the writer without MultiCodec support (i.e. no MultiCodec
 // header is written).
 func CborEncode(w io.Writer, v interface{}) error {
-	return CborV2Codec.Encoder(w).Encode(v)
+	return NewCborCodec().Encoder(w).Encode(v)
 }
 
 // CborDecode decodes cbor-encoded data from the provided reader into the given data structure. The data is not expected
 // to have a MultiCodec header.
 func CborDecode(r io.Reader, v interface{}) error {
-	return CborV2Codec.Decoder(r).Decode(v)
+	return NewCborCodec().Decoder(r).Decode(v)
 }
 
 func makeGobCodec() Codec {

format/codecs/codecs_test.go

@@ -13,19 +13,19 @@ func TestGobCodec(t *testing.T) {
 }
 
 func TestCborCodec(t *testing.T) {
-	runCodecTest(t, NewCborCodec())
-	runCodecTestInterface(t, NewCborCodec())
+	runCodecTest(t, NewCborV2Codec())
+	runCodecTestInterface(t, NewCborV2Codec())
 }
 
-// TestCborV1Codec encodes data with CborV1MultiCodec and decodes it with CborMuxCodec.
+// TestCborV1Codec encodes data with CborV1MultiCodec and decodes it with CborV2MuxCodec.
 func TestCborV1Codec(t *testing.T) {
 	{
 		buf, data := encode(t, CborV1MultiCodec)
-		decode(CborMuxCodec, buf, data, t)
+		decode(CborV2MuxCodec, buf, data, t)
 	}
 	{
 		buf, data := encode(t, CborV1MultiCodec)
-		decodeInterface(CborMuxCodec, buf, data, t)
+		decodeInterface(CborV2MuxCodec, buf, data, t)
 	}
 }
 

format/codecs/multi.go

@@ -32,7 +32,7 @@ type MultiCodec interface {
 	// the version during decoding.
 	//
 	// This feature is needed in order to support mux codecs where encoding uses versions, but where legacy data was
-	// encoded without versions. See CborMuxCodec and TestVersionedMux.
+	// encoded without versions. See CborV2MuxCodec and TestVersionedMux.
 	DisableVersions() MultiCodec
 }
 

format/codecs/multi_test.go

@@ -18,7 +18,7 @@ func TestMultiCodecs(t *testing.T) {
 		codecs.JsonMultiCodec,
 		codecs.CborV1MultiCodec,
 		codecs.CborV2MultiCodec,
-		codecs.CborMuxCodec,
+		codecs.CborV2MuxCodec,
 	}
 
 	tests := []struct {

format/codecs/mux_test.go

@@ -67,9 +67,9 @@ type testStructV2 struct {
 //   - An initial data structure is encoded with the cbor V1 codec.
 //   - Then the codec is upgraded to V2 for improved performance and versioning is added for future-proofing.
 //   - Then the data structure changes and now gets encoded in a new format (as a CBOR array instead of a map).
-//   - Finally, all three versions of the encoded data are decoded with the same CborMuxCodec.
+//   - Finally, all three versions of the encoded data are decoded with the same CborV2MuxCodec.
 //
-// In order to make decoding of the initial encoded data work, the CborMuxCodec disables versions on the legacy
+// In order to make decoding of the initial encoded data work, the CborV2MuxCodec disables versions on the legacy
 // CborV1MultiCodec, since that data was encoded without version information.
 func TestVersionedMux(t *testing.T) {
 	hsh := hash.MustParse("hq__2w1SR2eY9LChsaY5f3EE2G4RhroKnmL7dsyB7Wm2qvbRG5UF9GoPVgFvD1nFqe9Pt4hF7")
@@ -90,14 +90,14 @@ func TestVersionedMux(t *testing.T) {
 	require.NoError(t, codecs.CborV1MultiCodec.Encoder(bufCbor).Encode(dataV1))
 
 	bufCborV2DataV1 := new(bytes.Buffer)
-	require.NoError(t, codecs.CborMuxCodec.VersionedEncoder(bufCborV2DataV1).EncodeVersioned(1, dataV1))
+	require.NoError(t, codecs.CborV2MuxCodec.VersionedEncoder(bufCborV2DataV1).EncodeVersioned(1, dataV1))
 
 	bufCborV2DataV2 := new(bytes.Buffer)
-	require.NoError(t, codecs.CborMuxCodec.VersionedEncoder(bufCborV2DataV2).EncodeVersioned(2, dataV2))
+	require.NoError(t, codecs.CborV2MuxCodec.VersionedEncoder(bufCborV2DataV2).EncodeVersioned(2, dataV2))
 
 	for i, buf := range []*bytes.Buffer{bufCbor, bufCborV2DataV1, bufCborV2DataV2} {
 		fmt.Println(buf.String())
-		obj, version, err := codecs.CborMuxCodec.VersionedDecoder(buf).DecodeVersioned(
+		obj, version, err := codecs.CborV2MuxCodec.VersionedDecoder(buf).DecodeVersioned(
 			func(version uint, codec string) interface{} {
 				if codec == codecs.CborV1MultiCodec.Header().Path() {
 					return &testStruct{}

format/link/blob_test.go

@@ -104,7 +104,7 @@ func TestBlobLinkCborMarshaling(t *testing.T) {
 	data := []byte("###blob bytes###")
 	lnk := link.NewBlobBuilder().Data(data).EncryptionScheme(encryption.None).MustBuild()
 
-	codec := codecs.NewCborCodec()
+	codec := codecs.NewCborV2Codec()
 
 	{
 		lnkBuf := &bytes.Buffer{}
@@ -170,7 +170,7 @@ func xTestDecodeSlice(t *testing.T) {
 
 	watch := timeutil.StartWatch()
 	log.Info("start")
-	//err = codecutil.MapDecode(data, &target)
+	// err = codecutil.MapDecode(data, &target)
 	err = mapstructure.Decode(data, &target)
 	log.Info("end", "duration", watch.Duration())
 

format/link/link_test.go

@@ -454,7 +454,7 @@ func testJSON(t *testing.T, lnk *link.Link, expJson string) {
 }
 
 func testCBOR(t *testing.T, lnk *link.Link) {
-	codec := codecs.NewCborCodec()
+	codec := codecs.NewCborV2Codec()
 
 	buf := &bytes.Buffer{}
 	err := codec.Encoder(buf).Encode(lnk)
@@ -498,7 +498,7 @@ func testWrappedCBOR(t *testing.T, tc testCase) {
 	s := Wrapper{
 		Link: *tc.lnk,
 	}
-	codec := codecs.NewCborCodec()
+	codec := codecs.NewCborV2Codec()
 
 	buf := &bytes.Buffer{}
 	err := codec.Encoder(buf).Encode(s)
@@ -528,7 +528,7 @@ func replaceHashes(s string) string {
 }
 
 func cbor(t *testing.T, src interface{}) interface{} {
-	codec := codecs.NewCborCodec()
+	codec := codecs.NewCborV2Codec()
 	buf := &bytes.Buffer{}
 	err := codec.Encoder(buf).Encode(src)
 	require.NoError(t, err)

format/token/token_test.go

@@ -95,9 +95,9 @@ func TestNil(t *testing.T) {
 	require.True(t, tokWrapper.Token.IsNil())
 
 	buf := bytes.NewBuffer(nil)
-	err = codecs.CborMuxCodec.Encoder(buf).Encode(tokWrapper)
+	err = codecs.CborV2MuxCodec.Encoder(buf).Encode(tokWrapper)
 	require.NoError(t, err)
-	err = codecs.CborMuxCodec.Decoder(buf).Decode(&tokWrapper)
+	err = codecs.CborV2MuxCodec.Decoder(buf).Decode(&tokWrapper)
 	require.NoError(t, err)
 	require.True(t, tokWrapper.Token.IsNil())
 }

format/unmarshal_regression_test.go

@@ -10,7 +10,6 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/eluv-io/common-go/format"
 	"github.com/eluv-io/common-go/format/codecs"
 	"github.com/eluv-io/common-go/format/encryption"
 	"github.com/eluv-io/common-go/format/hash"
@@ -175,7 +174,7 @@ var dataV1 = &DataStructV1{
 
 var (
 	blobData  = []byte("some blob data")
-	cborCodec = format.NewFactory().NewMetadataCodec()
+	cborCodec = codecs.NewCborV2Codec()
 )
 
 func marshal(t require.TestingT, data interface{}) ([]byte, []byte) {