Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Return status code 200 for JSONRPC errors in the factomd api #897

Merged
merged 1 commit into from
Oct 21, 2019
Merged

Return status code 200 for JSONRPC errors in the factomd api #897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion wsapi/debugapi.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ func HandleDebug(writer http.ResponseWriter, request *http.Request) {
state, err := GetState(request)
if err != nil {
wsDebugLog.Errorf("failed to extract port from request: %s", err)
writer.WriteHeader(http.StatusBadRequest)
writer.WriteHeader(http.StatusOK)
return
}

Expand Down
2 changes: 1 addition & 1 deletion wsapi/wsapi.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ func returnV1Msg(writer http.ResponseWriter, msg string, success bool) {
}

func handleV1Error(writer http.ResponseWriter, err *primitives.JSONError) {
writer.WriteHeader(http.StatusBadRequest)
writer.WriteHeader(http.StatusOK)
return
}

Expand Down
2 changes: 1 addition & 1 deletion wsapi/wsapiV1.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ func checkHttpPasswordOkV1(writer http.ResponseWriter, request *http.Request) bo
}
} else {
wsLog.Errorf("failed to get state from request: %s", err)
writer.WriteHeader(http.StatusBadRequest)
writer.WriteHeader(http.StatusOK)
return false
}
return true
Expand Down
41 changes: 22 additions & 19 deletions wsapi/wsapiV1_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,12 @@ func TestHandleGetRaw(t *testing.T) {
url := fmt.Sprintf("/v1/get-raw-data/%s", v.Hash1)

rawDataResponse := new(RawDataResponse)
v1RequestGet(t, url, http.StatusOK, rawDataResponse)
v1RequestGet(t, url, false, rawDataResponse)

assert.True(t, strings.Contains(rawDataResponse.Data, v.Raw), "Looking for %v \nGetRaw %v/%v from Hash1 failed - %v", v.Hash1, i, len(toTest), rawDataResponse.Data)

url = fmt.Sprintf("/v1/get-raw-data/%s", v.Hash2)
v1RequestGet(t, url, http.StatusOK, rawDataResponse)
v1RequestGet(t, url, false, rawDataResponse)

assert.True(t, strings.Contains(rawDataResponse.Data, v.Raw), "Looking for %v \nGetRaw %v/%v from Hash2 failed - %v", v.Hash2, i, len(toTest), rawDataResponse.Data)
}
Expand All @@ -113,7 +113,7 @@ func TestHandleDirectoryBlock(t *testing.T) {
url := fmt.Sprintf("/v1/directory-block-by-keymr/%s", hash)

dBlock := new(DBlock)
v1RequestGet(t, url, http.StatusOK, dBlock)
v1RequestGet(t, url, false, dBlock)

result, err := dBlock.JSONString()

Expand Down Expand Up @@ -150,13 +150,13 @@ func TestHandleEntryBlock(t *testing.T) {

eBlock := new(EBlock)
url := fmt.Sprintf("/v1/entry-block-by-keymr/%s", hash)
v1RequestGet(t, url, http.StatusOK, eBlock)
v1RequestGet(t, url, false, eBlock)

assert.Equal(t, "df3ade9eec4b08d5379cc64270c30ea7315d8a8a1a69efe2b98a60ecdd69e604", eBlock.Header.ChainID, "Wrong ChainID in eBlock - %v", eBlock)
assert.Equal(t, int64(b.(*entryBlock.EBlock).GetHeader().GetDBHeight()), eBlock.Header.DBHeight, "DBHeight is wrong - %v vs %v", eBlock.Header.DBHeight, b.(*entryBlock.EBlock).GetHeader().GetDBHeight())

url = fmt.Sprintf("/v1/entry-block-by-keymr/%s", hash2)
v1RequestGet(t, url, http.StatusOK, eBlock)
v1RequestGet(t, url, false, eBlock)

assert.Equal(t, "df3ade9eec4b08d5379cc64270c30ea7315d8a8a1a69efe2b98a60ecdd69e604", eBlock.Header.ChainID, "Wrong ChainID in eBlock - %v", eBlock)
assert.Equal(t, int64(b.(*entryBlock.EBlock).GetHeader().GetDBHeight()), eBlock.Header.DBHeight, "DBHeight is wrong - %v vs %v", eBlock.Header.DBHeight, b.(*entryBlock.EBlock).GetHeader().GetDBHeight())
Expand All @@ -172,7 +172,7 @@ func TestHandleEntryBlockInvalidHash(t *testing.T) {

url := "/v1/entry-block-by-keymr/invalid-hash"

v1RequestGet(t, url, http.StatusBadRequest, nil)
v1RequestGet(t, url, true, nil)
}

func TestHandleGetFee(t *testing.T) {
Expand All @@ -183,7 +183,7 @@ func TestHandleGetFee(t *testing.T) {

type x struct{ Fee int64 }
fee := new(x)
v1RequestGet(t, url, http.StatusOK, fee)
v1RequestGet(t, url, false, fee)

if fee.Fee < 1 {
t.Errorf("%v", fee)
Expand Down Expand Up @@ -211,17 +211,17 @@ func TestDBlockList(t *testing.T) {
for _, l := range list {
url := fmt.Sprintf("/v1/directory-block-by-keymr/%s", l)
// expect a NewBlockNotFoundError
v1RequestGet(t, url, http.StatusBadRequest, dBlock)
v1RequestGet(t, url, true, dBlock)
}

hash := "000000000000000000000000000000000000000000000000000000000000000d"

head := new(CHead)
url := fmt.Sprintf("/v1/chain-head/%s", hash)
v1RequestGet(t, url, http.StatusOK, head)
v1RequestGet(t, url, false, head)

url = fmt.Sprintf("/v1/directory-block-by-keymr/%s", head.ChainHead)
v1RequestGet(t, url, http.StatusOK, dBlock)
v1RequestGet(t, url, false, dBlock)
}

func TestBlockIteration(t *testing.T) {
Expand All @@ -233,7 +233,7 @@ func TestBlockIteration(t *testing.T) {

head := new(CHead)
url := fmt.Sprintf("/v1/chain-head/%s", hash)
v1RequestGet(t, url, http.StatusOK, head)
v1RequestGet(t, url, false, head)

prev := head.ChainHead
fetched := 0
Expand All @@ -244,7 +244,7 @@ func TestBlockIteration(t *testing.T) {

block := new(DBlock)
url := fmt.Sprintf("/v1/directory-block-by-keymr/%s", prev)
v1RequestGet(t, url, http.StatusOK, block)
v1RequestGet(t, url, false, block)

prev = block.Header.PrevBlockKeyMR
fetched++
Expand All @@ -262,7 +262,7 @@ func TestHandleGetReceipt(t *testing.T) {

receipt := new(ReceiptResponse)
url := fmt.Sprintf("/v1/get-receipt/%s", hash)
v1RequestGet(t, url, http.StatusOK, receipt)
v1RequestGet(t, url, false, receipt)

assert.NotNil(t, receipt.Receipt, "Receipt not found!")

Expand All @@ -283,7 +283,7 @@ func TestHandleGetUnanchoredReceipt(t *testing.T) {

receipt := new(ReceiptResponse)
url := fmt.Sprintf("/v1/get-receipt/%s", hash)
v1RequestGet(t, url, http.StatusOK, receipt)
v1RequestGet(t, url, false, receipt)

err := receipt.Receipt.Validate()
assert.Nil(t, err, "failed to validate receipt - %v", receipt)
Expand All @@ -301,7 +301,7 @@ func TestHandleFactoidBalanceUnknownAddress(t *testing.T) {
factoidBalanceResponse := new(FactoidBalanceResponse)
url := "/v1/factoid-balance/f1ba8879fcf63b596b60ccc4c69c7f6848475ac037fc63b080ba2d9502fe66a4"

v1RequestGet(t, url, http.StatusOK, factoidBalanceResponse)
v1RequestGet(t, url, false, factoidBalanceResponse)

assert.Equal(t, int64(0), factoidBalanceResponse.Balance, "%v", factoidBalanceResponse)
}
Expand All @@ -317,7 +317,7 @@ func TestHandleProperties(t *testing.T) {

properties := new(V1Properties)
url := "/v1/properties/"
v1RequestGet(t, url, http.StatusOK, properties)
v1RequestGet(t, url, false, properties)

assert.Equal(t, properties.Factomd_Version, state.GetFactomdVersion())
assert.Equal(t, "0.0.0.0", properties.Protocol_Version)
Expand All @@ -329,7 +329,7 @@ func TestHandleHeights(t *testing.T) {

heightsResponse := new(HeightsResponse)
url := "/v1/heights/"
v1RequestGet(t, url, http.StatusOK, heightsResponse)
v1RequestGet(t, url, false, heightsResponse)

assert.Equal(t, int64(state.GetTrueLeaderHeight()), heightsResponse.LeaderHeight)
assert.Equal(t, int64(state.GetHighestSavedBlk()), heightsResponse.DirectoryBlockHeight)
Expand All @@ -340,15 +340,18 @@ func TestHandleHeights(t *testing.T) {
assert.Equal(t, int64(state.GetEntryBlockDBHeightComplete()), heightsResponse.EntryBlockDBHeightComplete)
}

func v1RequestGet(t *testing.T, url string, expectedCode int, result interface{}) {
func v1RequestGet(t *testing.T, url string, expectederror bool, result interface{}) {
response, err := http.Get(fmt.Sprintf("http://localhost:8088/%s", url))
assert.Nil(t, err, "response: %v", response)
defer response.Body.Close()

body, err := ioutil.ReadAll(response.Body)

assert.Nil(t, err, "body: \t%v", string(body))
assert.Equal(t, expectedCode, response.StatusCode, "body: \t%v", string(body))

if expectederror {
result = new(primitives.JSONError)
}

if len(body) != 0 {
err := json.Unmarshal(body, result)
Expand Down
4 changes: 2 additions & 2 deletions wsapi/wsapiV2.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ func HandleV2(writer http.ResponseWriter, request *http.Request) {
state, err := GetState(request)
if err != nil {
wsLog.Errorf("failed to extract port from request: %s", err)
writer.WriteHeader(http.StatusBadRequest)
writer.WriteHeader(http.StatusOK)
return
}

Expand Down Expand Up @@ -481,7 +481,7 @@ func HandleV2Error(writer http.ResponseWriter, j *primitives.JSON2Request, jErr
}
resp.Error = jErr

writer.WriteHeader(http.StatusBadRequest)
writer.WriteHeader(http.StatusOK)
_, err := writer.Write([]byte(resp.String()))
if err != nil {
wsLog.Errorf("failed to write error response: %v", err)
Expand Down