feat: Add ability to display peer id

api/http/errors.go

@@ -12,6 +12,7 @@ package http
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"net/http"
 	"os"
@@ -20,13 +21,20 @@ import (
 
 var env = os.Getenv("DEFRA_ENV")
 
-type errorResponse struct {
-	Errors []errorItem `json:"errors"`
+var (
+	errNoListener = errors.New("cannot serve with no listener")
+	errSchema     = errors.New("base must start with the http or https scheme")
+)
+
+// ErrorResponse is the GQL top level object holding error items for the response payload.
+type ErrorResponse struct {
+	Errors []ErrorItem `json:"errors"`
 }
 
-type errorItem struct {
-	Message    string      `json:"message"`
-	Extensions *extensions `json:"extensions,omitempty"`
+// ErrorItem hold an error message and extensions that might be pertinent to the request
+type ErrorItem struct {
+	Message    string     `json:"message"`
+	Extensions extensions `json:"extensions,omitempty"`
 }
 
 type extensions struct {
@@ -43,11 +51,11 @@ func handleErr(ctx context.Context, rw http.ResponseWriter, err error, status in
 	sendJSON(
 		ctx,
 		rw,
-		errorResponse{
-			Errors: []errorItem{
+		ErrorResponse{
+			Errors: []ErrorItem{
 				{
 					Message: err.Error(),
-					Extensions: &extensions{
+					Extensions: extensions{
 						Status:    status,
 						HTTPError: http.StatusText(status),
 						Stack:     formatError(err),

api/http/errors_test.go

@@ -54,7 +54,7 @@ func TestHandleErrOnBadRequest(t *testing.T) {
 
 	resp := rec.Result()
 
-	errResponse := errorResponse{}
+	errResponse := ErrorResponse{}
 	err = json.NewDecoder(resp.Body).Decode(&errResponse)
 	if err != nil {
 		t.Fatal(err)
@@ -87,7 +87,7 @@ func TestHandleErrOnInternalServerError(t *testing.T) {
 
 	resp := rec.Result()
 
-	errResponse := errorResponse{}
+	errResponse := ErrorResponse{}
 	err = json.NewDecoder(resp.Body).Decode(&errResponse)
 	if err != nil {
 		t.Fatal(err)
@@ -119,7 +119,7 @@ func TestHandleErrOnNotFound(t *testing.T) {
 
 	resp := rec.Result()
 
-	errResponse := errorResponse{}
+	errResponse := ErrorResponse{}
 	err = json.NewDecoder(resp.Body).Decode(&errResponse)
 	if err != nil {
 		t.Fatal(err)
@@ -152,7 +152,7 @@ func TestHandleErrOnDefault(t *testing.T) {
 
 	resp := rec.Result()
 
-	errResponse := errorResponse{}
+	errResponse := ErrorResponse{}
 	err = json.NewDecoder(resp.Body).Decode(&errResponse)
 	if err != nil {
 		t.Fatal(err)

api/http/handler.go

@@ -32,15 +32,18 @@ type handler struct {
 
 type ctxDB struct{}
 
-type dataResponse struct {
+type ctxPeerID struct{}
+
+// DataResponse is the GQL top level object holding data for the response payload.
+type DataResponse struct {
 	Data interface{} `json:"data"`
 }
 
-// simpleDataResponse is a helper function that returns a dataResponse struct.
+// simpleDataResponse is a helper function that returns a DataResponse struct.
 // Odd arguments are the keys and must be strings otherwise they are ignored.
 // Even arguments are the values associated with the previous key.
 // Odd arguments are also ignored if there are no following arguments.
-func simpleDataResponse(args ...interface{}) dataResponse {
+func simpleDataResponse(args ...interface{}) DataResponse {
 	data := make(map[string]interface{})
 
 	for i := 0; i < len(args); i += 2 {
@@ -55,7 +58,7 @@ func simpleDataResponse(args ...interface{}) dataResponse {
 		}
 	}
 
-	return dataResponse{
+	return DataResponse{
 		Data: data,
 	}
 }
@@ -71,6 +74,9 @@ func newHandler(db client.DB, opts serverOptions) *handler {
 func (h *handler) handle(f http.HandlerFunc) http.HandlerFunc {
 	return func(rw http.ResponseWriter, req *http.Request) {
 		ctx := context.WithValue(req.Context(), ctxDB{}, h.db)
+		if h.options.peerID != "" {
+			ctx = context.WithValue(ctx, ctxPeerID{}, h.options.peerID)
+		}
 		f(rw, req.WithContext(ctx))
 	}
 }

api/http/handlerfuncs.go

@@ -237,3 +237,20 @@ func getBlockHandler(rw http.ResponseWriter, req *http.Request) {
 		http.StatusOK,
 	)
 }
+
+func peerIDHandler(rw http.ResponseWriter, req *http.Request) {
+	peerID, ok := req.Context().Value(ctxPeerID{}).(string)
+	if !ok || peerID == "" {
+		handleErr(req.Context(), rw, errors.New("no peer ID available. P2P might be disabled"), http.StatusNotFound)
+		return
+	}
+
+	sendJSON(
+		req.Context(),
+		rw,
+		simpleDataResponse(
+			"peerID", peerID,
+		),
+		http.StatusOK,
+	)
+}