ENG-6203: Encode/decode stream token values

serializer.go

@@ -34,6 +34,7 @@ const (
 	typeTagDoc    typeTag = "@doc"
 	typeTagRef    typeTag = "@ref"
 	typeTagSet    typeTag = "@set"
+	typeTagStream typeTag = "@stream"
 	typeTagMod    typeTag = "@mod"
 	typeTagObject typeTag = "@object"
 )
@@ -96,6 +97,8 @@ func (p Page) Unmarshal(into any) error {
 	return decodeInto(p.Data, into)
 }
 
+type Stream string
+
 func mapDecoder(into any) (*mapstructure.Decoder, error) {
 	return mapstructure.NewDecoder(&mapstructure.DecoderConfig{
 		TagName:              "fauna",
@@ -232,6 +235,8 @@ func unboxType(body map[string]any) (any, error) {
 				return unboxRef(v.(map[string]any))
 			case typeTagSet:
 				return unboxSet(v)
+			case typeTagStream:
+				return unboxStream(v)
 			case typeTagDoc:
 				return unboxDoc(v.(map[string]any))
 			case typeTagObject:
@@ -400,6 +405,14 @@ func unboxSet(v any) (any, error) {
 	return nil, fmt.Errorf("invalid set %v", v)
 }
 
+func unboxStream(v any) (any, error) {
+	if token, ok := v.(string); ok {
+		return Stream(token), nil
+	} else {
+		return nil, fmt.Errorf("invalid stream %v", v)
+	}
+}
+
 func unboxTime(v string) (*time.Time, error) {
 	if t, err := time.Parse(timeFormat, v); err != nil {
 		return nil, err
@@ -466,6 +479,9 @@ func encode(v any, hint string) (any, error) {
 	case Page:
 		return encodeFaunaStruct(typeTagSet, vt)
 
+	case Stream:
+		return map[typeTag]any{typeTagStream: vt}, nil
+
 	case time.Time:
 		return encodeTime(vt, hint)
 

serializer_test.go

@@ -49,6 +49,7 @@ type BusinessObj struct {
 	RefField          Ref                     `fauna:"ref_field"`
 	NamedRefField     NamedRef                `fauna:"named_ref_field"`
 	SetField          Page                    `fauna:"set_field"`
+	StreamField       Stream                  `fauna:"stream_field"`
 	ObjField          SubBusinessObj          `fauna:"obj_field"`
 	DocField          DocBusinessObj          `fauna:"doc_field"`
 	NamedDocField     NamedDocBusinessObj     `fauna:"named_doc_field"`
@@ -266,6 +267,11 @@ func TestEncodingFaunaStructs(t *testing.T) {
 		roundTripCheck(t, obj, `{"@set":{"data":["0","1","2"],"after":"foobarbaz"}}`)
 	})
 
+	t.Run("encodes Stream", func(t *testing.T) {
+		stream := Stream("abcd==")
+		roundTripCheck(t, stream, `{"@stream":"abcd=="}`)
+	})
+
 	t.Run("encode NullDoc", func(t *testing.T) {
 		obj := NullDocument{Cause: "Foo", Ref: &Ref{ID: "1234", Coll: &Module{"Foo"}}}
 		roundTripCheck(t, obj, `{"cause": "Foo", "ref": {"@ref":{"id":"1234","coll":{"@mod":"Foo"}}}}`)