protocols/horizon/effects: Add UnmarshalJSON to SequenceBumped. (#1909)

* Add UnmarshalJSON to SequenceBumped. * Update protocols/horizon/effects/main.go Co-Authored-By: Eric Saunders <[email protected]> * Use json.Number. * split test for sequence number in both formats.
stellar · Nov 13, 2019 · dcf63d4 · dcf63d4
1 parent 4f1a9bf
commit dcf63d4
Show file tree

Hide file tree

Showing 2 changed files with 144 additions and 3 deletions.
diff --git a/clients/horizonclient/effect_request_test.go b/clients/horizonclient/effect_request_test.go
@@ -143,7 +143,7 @@ func TestNextEffectsPage(t *testing.T) {
 	efp, err := client.Effects(effectRequest)
 
 	if assert.NoError(t, err) {
-		assert.Equal(t, len(efp.Embedded.Records), 2)
+		assert.Len(t, efp.Embedded.Records, 2)
 	}
 
 	hmock.On(
@@ -153,7 +153,48 @@ func TestNextEffectsPage(t *testing.T) {
 
 	nextPage, err := client.NextEffectsPage(efp)
 	if assert.NoError(t, err) {
-		assert.Equal(t, len(nextPage.Embedded.Records), 0)
+		assert.Len(t, nextPage.Embedded.Records, 0)
+	}
+}
+
+func TestSequenceBumpedNewSeq(t *testing.T) {
+	hmock := httptest.NewClient()
+	client := &Client{
+		HorizonURL: "https://localhost/",
+		HTTP:       hmock,
+	}
+	effectRequest := EffectRequest{ForAccount: "GCDIZFWLOTBWHTPODXCBH6XNXPFMSQFRVIDRP3JLEKQZN66G7NF3ANOD"}
+	testCases := []struct {
+		desc    string
+		payload string
+	}{
+		{
+			desc:    "new_seq as a string",
+			payload: sequenceBumpedAsStringPage,
+		},
+		{
+			desc:    "new_seq as a number",
+			payload: sequenceBumpedAsNumberPage,
+		},
+	}
+	for _, tc := range testCases {
+		t.Run(tc.desc, func(t *testing.T) {
+			hmock.On(
+				"GET",
+				"https://localhost/accounts/GCDIZFWLOTBWHTPODXCBH6XNXPFMSQFRVIDRP3JLEKQZN66G7NF3ANOD/effects",
+			).ReturnString(200, tc.payload)
+
+			efp, err := client.Effects(effectRequest)
+
+			if assert.NoError(t, err) {
+				assert.Len(t, efp.Embedded.Records, 1)
+			}
+
+			effect, ok := efp.Embedded.Records[0].(effects.SequenceBumped)
+			assert.True(t, ok)
+			assert.Equal(t, int64(300000000000), effect.NewSeq)
+
+		})
 	}
 }
 
@@ -215,11 +256,87 @@ var firstEffectsPage = `{
         "weight": 1,
         "public_key": "GCDIZFWLOTBWHTPODXCBH6XNXPFMSQFRVIDRP3JLEKQZN66G7NF3ANOD",
         "key": ""
-      }
+	  }
     ]
   }
 }`
 
+var sequenceBumpedAsNumberPage = `{
+	"_links": {
+	  "self": {
+		"href": "https://horizon-testnet.stellar.org/accounts/GCDIZFWLOTBWHTPODXCBH6XNXPFMSQFRVIDRP3JLEKQZN66G7NF3ANOD/effects?cursor=&limit=10&order=asc"
+	  },
+	  "next": {
+		"href": "https://horizon-testnet.stellar.org/accounts/GCDIZFWLOTBWHTPODXCBH6XNXPFMSQFRVIDRP3JLEKQZN66G7NF3ANOD/effects?cursor=1557363731492865-3&limit=10&order=asc"
+	  },
+	  "prev": {
+		"href": "https://horizon-testnet.stellar.org/accounts/GCDIZFWLOTBWHTPODXCBH6XNXPFMSQFRVIDRP3JLEKQZN66G7NF3ANOD/effects?cursor=1557363731492865-1&limit=10&order=desc"
+	  }
+	},
+	"_embedded": {
+	  "records": [
+		{
+		  "_links": {
+			"operation": {
+			  "href": "https://horizon-testnet.stellar.org/operations/249108107265"
+			},
+			"succeeds": {
+			  "href": "https://horizon-testnet.stellar.org/effects?order=desc\u0026cursor=249108107265-1"
+			},
+			"precedes": {
+			  "href": "https://horizon-testnet.stellar.org/effects?order=asc\u0026cursor=249108107265-1"
+			}
+		  },
+		  "id": "0000000249108107265-0000000001",
+		  "paging_token": "249108107265-1",
+		  "account": "GCQZP3IU7XU6EJ63JZXKCQOYT2RNXN3HB5CNHENNUEUHSMA4VUJJJSEN",
+		  "type": "sequence_bumped",
+		  "type_i": 43,
+		  "created_at": "2019-06-03T16:36:24Z",
+		  "new_seq": 300000000000
+		}
+	  ]
+	}
+  }`
+
+var sequenceBumpedAsStringPage = `{
+	"_links": {
+	  "self": {
+		"href": "https://horizon-testnet.stellar.org/accounts/GCDIZFWLOTBWHTPODXCBH6XNXPFMSQFRVIDRP3JLEKQZN66G7NF3ANOD/effects?cursor=&limit=10&order=asc"
+	  },
+	  "next": {
+		"href": "https://horizon-testnet.stellar.org/accounts/GCDIZFWLOTBWHTPODXCBH6XNXPFMSQFRVIDRP3JLEKQZN66G7NF3ANOD/effects?cursor=1557363731492865-3&limit=10&order=asc"
+	  },
+	  "prev": {
+		"href": "https://horizon-testnet.stellar.org/accounts/GCDIZFWLOTBWHTPODXCBH6XNXPFMSQFRVIDRP3JLEKQZN66G7NF3ANOD/effects?cursor=1557363731492865-1&limit=10&order=desc"
+	  }
+	},
+	"_embedded": {
+	  "records": [
+		{
+		  "_links": {
+			"operation": {
+			  "href": "https://horizon-testnet.stellar.org/operations/249108107265"
+			},
+			"succeeds": {
+			  "href": "https://horizon-testnet.stellar.org/effects?order=desc\u0026cursor=249108107265-1"
+			},
+			"precedes": {
+			  "href": "https://horizon-testnet.stellar.org/effects?order=asc\u0026cursor=249108107265-1"
+			}
+		  },
+		  "id": "0000000249108107265-0000000001",
+		  "paging_token": "249108107265-1",
+		  "account": "GCQZP3IU7XU6EJ63JZXKCQOYT2RNXN3HB5CNHENNUEUHSMA4VUJJJSEN",
+		  "type": "sequence_bumped",
+		  "type_i": 43,
+		  "created_at": "2019-06-03T16:36:24Z",
+		  "new_seq": "300000000000"
+		}
+	  ]
+	}
+  }`
+
 var emptyEffectsPage = `{
   "_links": {
     "self": {

diff --git a/protocols/horizon/effects/main.go b/protocols/horizon/effects/main.go
@@ -201,6 +201,30 @@ type SequenceBumped struct {
 	NewSeq int64 `json:"new_seq"`
 }
 
+// UnmarshalJSON is the custom unmarshal method for SequenceBumped. It allows
+// parsing of new_seq as a string or an int64.
+func (effect *SequenceBumped) UnmarshalJSON(data []byte) error {
+	var temp struct {
+		NewSeq json.Number `json:"new_seq"`
+	}
+
+	if err := json.Unmarshal(data, &effect.Base); err != nil {
+		return err
+	}
+
+	if err := json.Unmarshal(data, &temp); err != nil {
+		return err
+	}
+
+	newSeq, err := temp.NewSeq.Int64()
+	if err != nil {
+		return err
+	}
+	effect.NewSeq = newSeq
+
+	return nil
+}
+
 type SignerCreated struct {
 	Base
 	Weight    int32  `json:"weight"`